From 019fe714c5307af847f8fdb44714d5d5852f94a1 Mon Sep 17 00:00:00 2001 From: Anthony Stirling <77850077+Frooodle@users.noreply.github.com.> Date: Thu, 4 Sep 2025 23:48:35 +0100 Subject: [PATCH] change files around and wordings --- .../service/ServerCertificateService.java | 66 +++++++++++++++++++ .../ServerCertificateInitializer.java | 2 +- .../api/security/CertSignController.java | 2 +- .../api/ServerCertificateController.java | 2 +- .../service/ServerCertificateService.java | 42 +----------- .../public/locales/en-GB/translation.json | 50 +++++++++++++- .../CertificateFormatSettings.tsx | 15 ++--- .../CertificateTypeSettings.tsx | 9 +-- .../SignatureAppearanceSettings.tsx | 3 - .../tooltips/useCertificateTypeTips.ts | 8 +-- .../components/tooltips/useSignModeTips.ts | 36 ++++++++++ frontend/src/tools/ManageSignatures.tsx | 3 + 12 files changed, 170 insertions(+), 68 deletions(-) create mode 100644 app/common/src/main/java/stirling/software/common/service/ServerCertificateService.java rename app/{core/src/main/java/stirling/software/SPDF => proprietary/src/main/java/stirling/software/proprietary}/service/ServerCertificateService.java (88%) create mode 100644 frontend/src/components/tooltips/useSignModeTips.ts diff --git a/app/common/src/main/java/stirling/software/common/service/ServerCertificateService.java b/app/common/src/main/java/stirling/software/common/service/ServerCertificateService.java new file mode 100644 index 000000000..4e398e8b4 --- /dev/null +++ b/app/common/src/main/java/stirling/software/common/service/ServerCertificateService.java @@ -0,0 +1,66 @@ +package stirling.software.common.service; + +import java.io.InputStream; +import java.security.KeyStore; +import java.security.cert.X509Certificate; +import java.util.Date; + +public interface ServerCertificateService { + + boolean isEnabled(); + + boolean hasServerCertificate(); + + void initializeServerCertificate(); + + KeyStore getServerKeyStore() throws Exception; + + String getServerCertificatePassword(); + + X509Certificate getServerCertificate() throws Exception; + + byte[] getServerCertificatePublicKey() throws Exception; + + void uploadServerCertificate(InputStream p12Stream, String password) throws Exception; + + void deleteServerCertificate() throws Exception; + + ServerCertificateInfo getServerCertificateInfo() throws Exception; + + class ServerCertificateInfo { + private final boolean exists; + private final String subject; + private final String issuer; + private final Date validFrom; + private final Date validTo; + + public ServerCertificateInfo( + boolean exists, String subject, String issuer, Date validFrom, Date validTo) { + this.exists = exists; + this.subject = subject; + this.issuer = issuer; + this.validFrom = validFrom; + this.validTo = validTo; + } + + public boolean isExists() { + return exists; + } + + public String getSubject() { + return subject; + } + + public String getIssuer() { + return issuer; + } + + public Date getValidFrom() { + return validFrom; + } + + public Date getValidTo() { + return validTo; + } + } +} \ No newline at end of file diff --git a/app/core/src/main/java/stirling/software/SPDF/configuration/ServerCertificateInitializer.java b/app/core/src/main/java/stirling/software/SPDF/configuration/ServerCertificateInitializer.java index 4131162ae..f5d558f62 100644 --- a/app/core/src/main/java/stirling/software/SPDF/configuration/ServerCertificateInitializer.java +++ b/app/core/src/main/java/stirling/software/SPDF/configuration/ServerCertificateInitializer.java @@ -7,7 +7,7 @@ import org.springframework.stereotype.Component; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; -import stirling.software.SPDF.service.ServerCertificateService; +import stirling.software.common.service.ServerCertificateService; @Component @RequiredArgsConstructor diff --git a/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java b/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java index 621a73a9b..8a73e872f 100644 --- a/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java +++ b/app/core/src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java @@ -72,7 +72,7 @@ import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import stirling.software.SPDF.model.api.security.SignPDFWithCertRequest; -import stirling.software.SPDF.service.ServerCertificateService; +import stirling.software.common.service.ServerCertificateService; import stirling.software.common.annotations.AutoJobPostMapping; import stirling.software.common.service.CustomPDFDocumentFactory; import stirling.software.common.util.ExceptionUtils; diff --git a/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/ServerCertificateController.java b/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/ServerCertificateController.java index b0fa44878..e85d127a6 100644 --- a/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/ServerCertificateController.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/security/controller/api/ServerCertificateController.java @@ -14,7 +14,7 @@ import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; -import stirling.software.SPDF.service.ServerCertificateService; +import stirling.software.common.service.ServerCertificateService; @RestController @RequestMapping("/api/v1/admin/server-certificate") diff --git a/app/core/src/main/java/stirling/software/SPDF/service/ServerCertificateService.java b/app/proprietary/src/main/java/stirling/software/proprietary/service/ServerCertificateService.java similarity index 88% rename from app/core/src/main/java/stirling/software/SPDF/service/ServerCertificateService.java rename to app/proprietary/src/main/java/stirling/software/proprietary/service/ServerCertificateService.java index 67061b7fd..edc29d331 100644 --- a/app/core/src/main/java/stirling/software/SPDF/service/ServerCertificateService.java +++ b/app/proprietary/src/main/java/stirling/software/proprietary/service/ServerCertificateService.java @@ -1,4 +1,4 @@ -package stirling.software.SPDF.service; +package stirling.software.proprietary.service; import java.io.*; import java.math.BigInteger; @@ -26,7 +26,7 @@ import stirling.software.common.configuration.InstallationPathConfig; @Service @Slf4j -public class ServerCertificateService { +public class ServerCertificateService implements stirling.software.common.service.ServerCertificateService { private static final String KEYSTORE_FILENAME = "server-certificate.p12"; private static final String KEYSTORE_ALIAS = "stirling-pdf-server"; @@ -213,40 +213,4 @@ public class ServerCertificateService { } } - public static class ServerCertificateInfo { - private final boolean exists; - private final String subject; - private final String issuer; - private final Date validFrom; - private final Date validTo; - - public ServerCertificateInfo( - boolean exists, String subject, String issuer, Date validFrom, Date validTo) { - this.exists = exists; - this.subject = subject; - this.issuer = issuer; - this.validFrom = validFrom; - this.validTo = validTo; - } - - public boolean isExists() { - return exists; - } - - public String getSubject() { - return subject; - } - - public String getIssuer() { - return issuer; - } - - public Date getValidFrom() { - return validFrom; - } - - public Date getValidTo() { - return validTo; - } - } -} +} \ No newline at end of file diff --git a/frontend/public/locales/en-GB/translation.json b/frontend/public/locales/en-GB/translation.json index 68be7add0..ad1427bb2 100644 --- a/frontend/public/locales/en-GB/translation.json +++ b/frontend/public/locales/en-GB/translation.json @@ -1439,7 +1439,55 @@ "manageSignatures": { "tags": "sign,certificate,PEM,PKCS12,JKS,server,manual,auto", "title": "Manage Signatures", - "desc": "Sign PDFs with certificates using manual or server-managed keys" + "desc": "Sign PDFs with certificates using manual or server-managed keys", + "signMode": { + "tooltip": { + "header": { + "title": "About PDF Signatures" + }, + "overview": { + "title": "How signatures work", + "text": "Both modes seal the document (any edits are flagged as tampering) and record who/when/how for auditing. Viewer trust depends on the certificate chain." + }, + "manual": { + "title": "Manual - Bring your certificate", + "text": "Use your own certificate files for brand-aligned identity. Can display Trusted when your CA/chain is recognised.", + "use": "Use for: customer-facing, legal, compliance." + }, + "auto": { + "title": "Auto - Zero-setup, instant system seal", + "text": "Signs with a server self-signed certificate. Same tamper-evident seal and audit trail; typically shows Unverified in viewers.", + "use": "Use when: you need speed and consistent internal identity across reviews and records." + }, + "rule": { + "title": "Rule of thumb", + "text": "Need recipient Trusted status? Manual. Need a fast, tamper-evident seal and audit trail with no setup? Auto." + } + } + }, + "certType": { + "tooltip": { + "header": { + "title": "About Certificate Types" + }, + "what": { + "title": "What's a certificate?", + "text": "It's a secure ID for your signature that proves you signed. Unless you're required to sign via certificate, we recommend using another secure method like Type, Draw, or Upload." + }, + "which": { + "title": "Which option should I use?", + "text": "Choose the format that matches your certificate file:", + "bullet1": "PKCS12 (.p12) – one combined file (most common)", + "bullet2": "PFX (.pfx) – Microsoft's version of PKCS12", + "bullet3": "PEM – separate private-key and certificate .pem files", + "bullet4": "JKS – Java .jks keystore for dev / CI-CD workflows" + }, + "convert": { + "title": "Key not listed?", + "text": "Convert your file to a Java keystore (.jks) with keytool, then pick JKS." + } + } + } }, "removeCertSign": { "tags": "authenticate,PEM,P12,official,decrypt", diff --git a/frontend/src/components/tools/manageSignatures/CertificateFormatSettings.tsx b/frontend/src/components/tools/manageSignatures/CertificateFormatSettings.tsx index 2b345acf3..6acbaf2c2 100644 --- a/frontend/src/components/tools/manageSignatures/CertificateFormatSettings.tsx +++ b/frontend/src/components/tools/manageSignatures/CertificateFormatSettings.tsx @@ -24,7 +24,7 @@ const CertificateFormatSettings = ({ parameters, onParameterChange, disabled = f style={{ flex: 1, height: 'auto', minHeight: '40px', fontSize: '11px' }} >
- PKCS#12
(.p12 file) + PKCS12
@@ -49,7 +49,7 @@ const CertificateFormatSettings = ({ parameters, onParameterChange, disabled = f style={{ flex: 1, height: 'auto', minHeight: '40px', fontSize: '11px' }} >
- PEM
(Key + Cert files) + PEM
- - {parameters.certType === 'PKCS12' && "Upload a single .p12 file containing both certificate and private key"} - {parameters.certType === 'PFX' && "Upload a single .pfx file containing both certificate and private key"} - {parameters.certType === 'PEM' && "Upload separate certificate (.pem/.der/.crt/.cer) and private key (.pem/.der/.key) files"} - {parameters.certType === 'JKS' && "Upload a Java KeyStore (.jks) file"} - {!parameters.certType && "Choose the format of your certificate files"} - ); }; diff --git a/frontend/src/components/tools/manageSignatures/CertificateTypeSettings.tsx b/frontend/src/components/tools/manageSignatures/CertificateTypeSettings.tsx index 1f2c7f98e..d594e21f9 100644 --- a/frontend/src/components/tools/manageSignatures/CertificateTypeSettings.tsx +++ b/frontend/src/components/tools/manageSignatures/CertificateTypeSettings.tsx @@ -28,7 +28,7 @@ const CertificateTypeSettings = ({ parameters, onParameterChange, disabled = fal style={{ flex: 1, height: 'auto', minHeight: '40px', fontSize: '11px' }} >
- Manual
(Provide Files) + Manual
- - {parameters.signMode === 'MANUAL' - ? "Upload your own certificate files for signing" - : "Use the server's pre-configured certificate"} - ); }; diff --git a/frontend/src/components/tools/manageSignatures/SignatureAppearanceSettings.tsx b/frontend/src/components/tools/manageSignatures/SignatureAppearanceSettings.tsx index 2741c712d..f59537fd7 100644 --- a/frontend/src/components/tools/manageSignatures/SignatureAppearanceSettings.tsx +++ b/frontend/src/components/tools/manageSignatures/SignatureAppearanceSettings.tsx @@ -15,9 +15,6 @@ const SignatureAppearanceSettings = ({ parameters, onParameterChange, disabled = {/* Signature Visibility */} - - {t('certSign.appearance.title', 'Signature Appearance')} -