DGNum/Stirling-PDF
15
0
Fork 0
Code Issues 4 Pull requests 1 Projects Releases Packages Wiki Activity

feat: add java keystore certificate option for pdf signing

Browse source
This commit is contained in:
sbplat 2024-01-03 21:51:30 -05:00
parent d96a3db60a
commit 97f581ad6d
4 changed files with 121 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/main/java/stirling/software/SPDF/controller/api/security/CertSignController.java
View file

@ -81,6 +81,7 @@ public class CertSignController {
MultipartFile privateKeyFile = request.getPrivateKeyFile(); MultipartFile privateKeyFile = request.getPrivateKeyFile();
MultipartFile certFile = request.getCertFile(); MultipartFile certFile = request.getCertFile();
MultipartFile p12File = request.getP12File(); MultipartFile p12File = request.getP12File();
MultipartFile jksfile = request.getJksFile();
String password = request.getPassword(); String password = request.getPassword();
Boolean showSignature = request.isShowSignature(); Boolean showSignature = request.isShowSignature();
String reason = request.getReason(); String reason = request.getReason();
@ -95,10 +96,6 @@ public class CertSignController {
KeyStore ks = null; KeyStore ks = null;
switch (certType) { switch (certType) {
case "PKCS12":
ks = KeyStore.getInstance("PKCS12");
ks.load(p12File.getInputStream(), password.toCharArray());
break;
case "PEM": case "PEM":
ks = KeyStore.getInstance("JKS"); ks = KeyStore.getInstance("JKS");
ks.load(null); ks.load(null);
@ -107,6 +104,14 @@ public class CertSignController {
ks.setKeyEntry( ks.setKeyEntry(
"alias", privateKey, password.toCharArray(), new Certificate[] {cert}); "alias", privateKey, password.toCharArray(), new Certificate[] {cert});
break; break;
case "PKCS12":
ks = KeyStore.getInstance("PKCS12");
ks.load(p12File.getInputStream(), password.toCharArray());
break;
case "JKS":
ks = KeyStore.getInstance("JKS");
ks.load(jksfile.getInputStream(), password.toCharArray());
break;
default: default:
throw new IllegalArgumentException("Invalid cert type: " + certType); throw new IllegalArgumentException("Invalid cert type: " + certType);
} }

5
src/main/java/stirling/software/SPDF/model/api/security/SignPDFWithCertRequest.java
View file

@ -14,7 +14,7 @@ public class SignPDFWithCertRequest extends PDFFile {
@Schema( @Schema(
description = "The type of the digital certificate", description = "The type of the digital certificate",
allowableValues = {"PKCS12", "PEM"}) allowableValues = {"PEM", "PKCS12", "JKS"})
private String certType; private String certType;
@Schema( @Schema(
@ -28,6 +28,9 @@ public class SignPDFWithCertRequest extends PDFFile {
@Schema(description = "The PKCS12 keystore file (required for PKCS12 type certificates)") @Schema(description = "The PKCS12 keystore file (required for PKCS12 type certificates)")
private MultipartFile p12File; private MultipartFile p12File;
@Schema(description = "The JKS keystore file (Java Key Store)")
private MultipartFile jksFile;
@Schema(description = "The password for the keystore or the private key") @Schema(description = "The password for the keystore or the private key")
private String password; private String password;

2
src/main/resources/messages_en_US.properties
View file

@ -546,9 +546,11 @@ scalePages.submit=Submit
certSign.title=Certificate Signing certSign.title=Certificate Signing
certSign.header=Sign a PDF with your certificate (Work in progress) certSign.header=Sign a PDF with your certificate (Work in progress)
certSign.selectPDF=Select a PDF File for Signing: certSign.selectPDF=Select a PDF File for Signing:
certSign.jksNote=Note: If your certificate type is not listed below, please convert it to a Java Keystore (.jks) file using the keytool command line tool. Then, choose the .jks file option below.
certSign.selectKey=Select Your Private Key File (PKCS#8 format, could be .pem or .der): certSign.selectKey=Select Your Private Key File (PKCS#8 format, could be .pem or .der):
certSign.selectCert=Select Your Certificate File (X.509 format, could be .pem or .der): certSign.selectCert=Select Your Certificate File (X.509 format, could be .pem or .der):
certSign.selectP12=Select Your PKCS#12 Keystore File (.p12 or .pfx) (Optional, If provided, it should contain your private key and certificate): certSign.selectP12=Select Your PKCS#12 Keystore File (.p12 or .pfx) (Optional, If provided, it should contain your private key and certificate):
certSign.selectJKS=Select Your Java Keystore File (.jks or .keystore):
certSign.certType=Certificate Type certSign.certType=Certificate Type
certSign.password=Enter Your Keystore or Private Key Password (If Any): certSign.password=Enter Your Keystore or Private Key Password (If Any):
certSign.showSig=Show Signature certSign.showSig=Show Signature

144
src/main/resources/templates/security/cert-sign.html
View file

@ -1,10 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<html th:lang="${#locale.toString()}" <html th:lang="${#locale.toString()}" th:lang-direction="#{language.direction}" xmlns:th="http://www.thymeleaf.org">
th:lang-direction="#{language.direction}" <th:block th:insert="~{fragments/common :: head(title=#{certSign.title}, header=#{certSign.header})}"></th:block>
xmlns:th="http://www.thymeleaf.org">
<th:block
th:insert="~{fragments/common :: head(title=#{certSign.title}, header=#{certSign.header})}"></th:block>
<body> <body>
<div id="page-container"> <div id="page-container">
@ -15,114 +11,63 @@
<div class="row justify-content-center"> <div class="row justify-content-center">
<div class="col-md-6"> <div class="col-md-6">
<h2 th:text="#{certSign.header}"></h2> <h2 th:text="#{certSign.header}"></h2>
<form action="api/v1/security/cert-sign" method="post" enctype="multipart/form-data">
<form action="api/v1/security/cert-sign" method="post"
enctype="multipart/form-data">
<div class="mb-3"> <div class="mb-3">
<label th:text="#{certSign.selectPDF}"></label> <label th:text="#{certSign.selectPDF}"></label>
<div <div th:replace="~{fragments/common :: fileSelector(name='fileInput', multiple=false, accept='application/pdf')}"></div>
th:replace="~{fragments/common :: fileSelector(name='fileInput', multiple=false, accept='application/pdf')}"></div> </div>
<!-- Tell users to use keytool to generate JKS for other formats -->
<div class="mb-3">
<label th:text="#{certSign.jksNote}"></label>
</div> </div>
<div class="mb-3"> <div class="mb-3">
<label for="certType" th:text="#{certSign.certType}"></label> <select <label for="certType" th:text="#{certSign.certType}"></label> <select class="form-control" id="certType" name="certType">
class="form-control" id="certType" name="certType">
<option value="" th:text="#{selectFillter}"></option> <option value="" th:text="#{selectFillter}"></option>
<option value="PKCS12">PKCS12</option>
<option value="PEM">PEM</option> <option value="PEM">PEM</option>
<option value="PKCS12">PKCS12</option>
<option value="JKS">JKS</option>
</select> </select>
</div> </div>
<div class="mb-3" id="p12Group" style="display: none;">
<label th:text="#{certSign.selectP12}"></label>
<div
th:replace="~{fragments/common :: fileSelector(name='p12File', notRequired=true, multiple=false, accept='.p12,.pfx')}"></div>
</div>
<div id="pemGroup" style="display: none;"> <div id="pemGroup" style="display: none;">
<div class="mb-3"> <div class="mb-3">
<label th:text="#{certSign.selectKey}"></label> <label th:text="#{certSign.selectKey}"></label>
<div <div th:replace="~{fragments/common :: fileSelector(name='privateKeyFile', multiple=false, notRequired=true, accept='.pem,.der')}"></div>
th:replace="~{fragments/common :: fileSelector(name='privateKeyFile', multiple=false, notRequired=true, accept='.pem,.der')}"></div>
</div> </div>
<div class="mb-3"> <div class="mb-3">
<label th:text="#{certSign.selectCert}"></label> <label th:text="#{certSign.selectCert}"></label>
<div <div th:replace="~{fragments/common :: fileSelector(name='certFile', multiple=false, notRequired=true, accept='.pem,.der')}"></div>
th:replace="~{fragments/common :: fileSelector(name='certFile', multiple=false, notRequired=true, accept='.pem,.der')}"></div>
</div> </div>
</div> </div>
<div class="mb-3" id="p12Group" style="display: none;">
<label th:text="#{certSign.selectP12}"></label>
<div th:replace="~{fragments/common :: fileSelector(name='p12File', notRequired=true, multiple=false, accept='.p12,.pfx')}"></div>
</div>
<div class="mb-3" id="jksGroup" style="display: none;">
<label th:text="#{certSign.selectJKS}"></label>
<div th:replace="~{fragments/common :: fileSelector(name='jksFile', notRequired=true, multiple=false, accept='.jks,.keystore')}"></div>
</div>
<div class="mb-3"> <div class="mb-3">
<label th:text="#{certSign.password}"></label> <input <label th:text="#{certSign.password}"></label> <input type="password" class="form-control" id="password" name="password">
type="password" class="form-control" id="password"
name="password">
</div> </div>
<div class="mb-3"> <div class="mb-3">
<label><input type="checkbox" id="showSignature" <label><input type="checkbox" id="showSignature" name="showSignature" th:text="#{certSign.showSig}"></label>
name="showSignature" th:text="#{certSign.showSig}"></label>
</div> </div>
<div id="signatureDetails" style="display: none;"> <div id="signatureDetails" style="display: none;">
<div class="mb-3"> <div class="mb-3">
<label for="reason" th:text="#{certSign.reason}"></label> <input type="text" <label for="reason" th:text="#{certSign.reason}"></label> <input type="text" class="form-control" id="reason" name="reason">
class="form-control" id="reason" name="reason">
</div> </div>
<div class="mb-3"> <div class="mb-3">
<label for="location" th:text="#{certSign.location}"></label> <input type="text" <label for="location" th:text="#{certSign.location}"></label> <input type="text" class="form-control" id="location" name="location">
class="form-control" id="location" name="location">
</div> </div>
<div class="mb-3"> <div class="mb-3">
<label for="name" th:text="#{certSign.name}"></label> <input type="text" <label for="name" th:text="#{certSign.name}"></label> <input type="text" class="form-control" id="name" name="name">
class="form-control" id="name" name="name">
</div> </div>
<div class="mb-3"> <div class="mb-3">
<label for="pageNumber" th:text="#{pageNum}"></label> <input <label for="pageNumber" th:text="#{pageNum}"></label> <input type="number" class="form-control" id="pageNumber" name="pageNumber" min="1" disabled>
type="number" class="form-control" id="pageNumber"
name="pageNumber" min="1">
</div> </div>
</div> </div>
<script type="text/javascript">
document
.getElementById('certType')
.addEventListener(
'change',
function() {
var p12Group = document
.getElementById('p12Group');
var pemGroup = document
.getElementById('pemGroup');
if (this.value === 'PKCS12') {
p12Group.style.display = 'block';
pemGroup.style.display = 'none';
} else if (this.value === 'PEM') {
p12Group.style.display = 'none';
pemGroup.style.display = 'block';
} else {
p12Group.style.display = 'none';
pemGroup.style.display = 'none';
}
});
document
.getElementById('showSignature')
.addEventListener(
'change',
function() {
var signatureDetails = document
.getElementById('signatureDetails');
if (this.checked) {
signatureDetails.style.display = 'block';
} else {
signatureDetails.style.display = 'none';
}
});
</script>
<div class="mb-3 text-center"> <div class="mb-3 text-center">
<button type="submit" id="submitBtn" class="btn btn-primary" <button type="submit" id="submitBtn" class="btn btn-primary" th:text="#{certSign.submit}"></button>
th:text="#{certSign.submit}"></button>
</div> </div>
</form> </form>
</div> </div>
@ -131,5 +76,38 @@
</div> </div>
<div th:insert="~{fragments/footer.html :: footer}"></div> <div th:insert="~{fragments/footer.html :: footer}"></div>
</div> </div>
<script type="text/javascript">
document
.getElementById('certType')
.addEventListener(
'change',
function() {
var pemGroup = document.getElementById('pemGroup');
var p12Group = document.getElementById('p12Group');
var jksGroup = document.getElementById('jksGroup');
var valueToGroupMap = {
'PEM': pemGroup,
'PKCS12': p12Group,
'JKS': jksGroup
};
for (var key in valueToGroupMap) {
valueToGroupMap[key].style.display = (this.value === key) ? 'block' : 'none';
}
});
document
.getElementById('showSignature')
.addEventListener(
'change',
function() {
var signatureDetails = document.getElementById('signatureDetails');
if (this.checked) {
signatureDetails.style.display = 'block';
} else {
signatureDetails.style.display = 'none';
}
});
</script>
</body> </body>
</html> </html>