feat(security): add PFX alias for PKCS12; accept .crt/.cer/.der certs & .key keys; add certificate-signing tests (#4297)

This commit is contained in:
Ludy
2025-09-04 15:30:32 +01:00
committed by GitHub
parent 0d7649bee8
commit 02d096d622
14 changed files with 476 additions and 6 deletions
@@ -0,0 +1,312 @@
package stirling.software.SPDF.controller.api.security;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.core.io.ClassPathResource;
import org.springframework.http.ResponseEntity;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.web.multipart.MultipartFile;
import stirling.software.SPDF.model.api.security.SignPDFWithCertRequest;
import stirling.software.common.service.CustomPDFDocumentFactory;
@ExtendWith(MockitoExtension.class)
class CertSignControllerTest {
@Mock private CustomPDFDocumentFactory pdfDocumentFactory;
@InjectMocks private CertSignController certSignController;
private byte[] pdfBytes;
private byte[] pfxBytes;
private byte[] p12Bytes;
private byte[] jksBytes;
private byte[] pemKeyBytes;
private byte[] pemCertBytes;
private byte[] keyBytes;
private byte[] crtCertBytes;
private byte[] cerCertBytes;
private byte[] derCertBytes;
@BeforeEach
void setUp() throws Exception {
try (PDDocument doc = new PDDocument()) {
doc.addPage(new PDPage());
ByteArrayOutputStream baos = new ByteArrayOutputStream();
doc.save(baos);
pdfBytes = baos.toByteArray();
}
ClassPathResource pfxResource = new ClassPathResource("certs/test-cert.pfx");
try (InputStream is = pfxResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
pfxBytes = baos.toByteArray();
}
ClassPathResource p12Resource = new ClassPathResource("certs/test-cert.p12");
try (InputStream is = p12Resource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
p12Bytes = baos.toByteArray();
}
ClassPathResource jksResource = new ClassPathResource("certs/test-cert.jks");
try (InputStream is = jksResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
jksBytes = baos.toByteArray();
}
ClassPathResource pemKeyResource = new ClassPathResource("certs/test-key.pem");
try (InputStream is = pemKeyResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
pemKeyBytes = baos.toByteArray();
}
ClassPathResource pemCertResource = new ClassPathResource("certs/test-cert.pem");
try (InputStream is = pemCertResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
pemCertBytes = baos.toByteArray();
}
ClassPathResource keyResource = new ClassPathResource("certs/test-key.key");
try (InputStream is = keyResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
keyBytes = baos.toByteArray();
}
ClassPathResource crtResource = new ClassPathResource("certs/test-cert.crt");
try (InputStream is = crtResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
crtCertBytes = baos.toByteArray();
}
ClassPathResource cerResource = new ClassPathResource("certs/test-cert.cer");
try (InputStream is = cerResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
cerCertBytes = baos.toByteArray();
}
ClassPathResource derCertResource = new ClassPathResource("certs/test-cert.der");
try (InputStream is = derCertResource.getInputStream();
ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
is.transferTo(baos);
derCertBytes = baos.toByteArray();
}
when(pdfDocumentFactory.load(any(MultipartFile.class)))
.thenAnswer(
invocation -> {
MultipartFile file = invocation.getArgument(0);
return Loader.loadPDF(file.getBytes());
});
}
@Test
void testSignPdfWithPfx() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile pfxFile =
new MockMultipartFile("p12File", "test-cert.pfx", "application/x-pkcs12", pfxBytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("PFX");
request.setP12File(pfxFile);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
@Test
void testSignPdfWithPkcs12() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile p12File =
new MockMultipartFile("p12File", "test-cert.p12", "application/x-pkcs12", p12Bytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("PKCS12");
request.setP12File(p12File);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
@Test
void testSignPdfWithJks() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile jksFile =
new MockMultipartFile(
"jksFile", "test-cert.jks", "application/octet-stream", jksBytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("JKS");
request.setJksFile(jksFile);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
@Test
void testSignPdfWithPem() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile keyFile =
new MockMultipartFile(
"privateKeyFile", "test-key.pem", "application/x-pem-file", pemKeyBytes);
MockMultipartFile certFile =
new MockMultipartFile(
"certFile", "test-cert.pem", "application/x-pem-file", pemCertBytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("PEM");
request.setPrivateKeyFile(keyFile);
request.setCertFile(certFile);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
@Test
void testSignPdfWithCrt() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile keyFile =
new MockMultipartFile(
"privateKeyFile", "test-key.key", "application/x-pem-file", keyBytes);
MockMultipartFile certFile =
new MockMultipartFile(
"certFile", "test-cert.crt", "application/x-x509-ca-cert", crtCertBytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("PEM");
request.setPrivateKeyFile(keyFile);
request.setCertFile(certFile);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
@Test
void testSignPdfWithCer() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile keyFile =
new MockMultipartFile(
"privateKeyFile", "test-key.key", "application/x-pem-file", keyBytes);
MockMultipartFile certFile =
new MockMultipartFile(
"certFile", "test-cert.cer", "application/x-x509-ca-cert", cerCertBytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("PEM");
request.setPrivateKeyFile(keyFile);
request.setCertFile(certFile);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
@Test
void testSignPdfWithDer() throws Exception {
MockMultipartFile pdfFile =
new MockMultipartFile("fileInput", "test.pdf", "application/pdf", pdfBytes);
MockMultipartFile keyFile =
new MockMultipartFile(
"privateKeyFile", "test-key.key", "application/x-pem-file", keyBytes);
MockMultipartFile certFile =
new MockMultipartFile(
"certFile", "test-cert.der", "application/x-x509-ca-cert", derCertBytes);
SignPDFWithCertRequest request = new SignPDFWithCertRequest();
request.setFileInput(pdfFile);
request.setCertType("PEM");
request.setPrivateKeyFile(keyFile);
request.setCertFile(certFile);
request.setPassword("password");
request.setShowSignature(false);
request.setReason("test");
request.setLocation("test");
request.setName("tester");
request.setPageNumber(1);
request.setShowLogo(false);
ResponseEntity<byte[]> response = certSignController.signPDFWithCert(request);
assertNotNull(response.getBody());
assertTrue(response.getBody().length > 0);
}
}