chore: Rename certificate information to be more versatile to use

This commit is contained in:
Magnus Leßmann (@MarkL4YG) 2024-11-23 20:52:15 +01:00
parent f1135c54fa
commit fc4ea17cf3
7 changed files with 93 additions and 90 deletions

View file

@ -1,11 +1,11 @@
package de.mlessmann.certassist.openssl; package de.mlessmann.certassist.models;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
@Data @Data
@Builder @Builder
public class CertificateRequest { public class CertificateInfo {
private RequestType type; private RequestType type;
private String trustingAuthority; private String trustingAuthority;
@ -16,9 +16,9 @@ public class CertificateRequest {
@Builder.Default @Builder.Default
private int requestedValidityDays = 365; private int requestedValidityDays = 365;
private CertificateSubject subject; private CertificateInfoSubject subject;
private CertificateSubject issuer; private CertificateInfoSubject issuer;
private CertificateRequestExtension extension; private CertificateInfoExtension extension;
public enum RequestType { public enum RequestType {
ROOT_AUTHORITY, ROOT_AUTHORITY,
@ -26,21 +26,19 @@ public class CertificateRequest {
NORMAL_CERTIFICATE, NORMAL_CERTIFICATE,
} }
public static class CertificateRequestBuilder { public static class CertificateInfoBuilder {
public CertificateRequestBuilder subject(CertificateSubject.CertificateSubjectBuilder builder) { public CertificateInfoBuilder subject(CertificateInfoSubject.CertificateInfoSubjectBuilder builder) {
this.subject = builder.build(); this.subject = builder.build();
return this; return this;
} }
public CertificateRequestBuilder issuer(CertificateSubject.CertificateSubjectBuilder builder) { public CertificateInfoBuilder issuer(CertificateInfoSubject.CertificateInfoSubjectBuilder builder) {
this.issuer = builder.build(); this.issuer = builder.build();
return this; return this;
} }
public CertificateRequestBuilder extension( public CertificateInfoBuilder extension(CertificateInfoExtension.CertificateInfoExtensionBuilder builder) {
CertificateRequestExtension.CertificateRequestExtensionBuilder builder
) {
this.extension = builder.build(); this.extension = builder.build();
return this; return this;
} }

View file

@ -1,4 +1,4 @@
package de.mlessmann.certassist.openssl; package de.mlessmann.certassist.models;
import java.util.List; import java.util.List;
import java.util.Objects; import java.util.Objects;
@ -8,15 +8,15 @@ import lombok.Getter;
@Getter @Getter
@Builder @Builder
public class CertificateRequestExtension { public class CertificateInfoExtension {
private List<String> alternativeNames; private List<String> alternativeDnsNames;
public static class CertificateRequestExtensionBuilder { public static class CertificateInfoExtensionBuilder {
public CertificateRequestExtensionBuilder alternativeNames(String... altNames) { public CertificateInfoExtensionBuilder alternativeDnsNames(String... altNames) {
Objects.requireNonNull(altNames, "Alternative names must not be null (but can be empty)"); Objects.requireNonNull(altNames, "Alternative names must not be null (but can be empty)");
this.alternativeNames = this.alternativeDnsNames =
Stream Stream
.of(altNames) .of(altNames)
.filter(Objects::nonNull) .filter(Objects::nonNull)

View file

@ -1,11 +1,11 @@
package de.mlessmann.certassist.openssl; package de.mlessmann.certassist.models;
import lombok.Builder; import lombok.Builder;
import lombok.Getter; import lombok.Getter;
@Getter @Getter
@Builder @Builder
public class CertificateSubject { public class CertificateInfoSubject {
private String commonName; private String commonName;
private String emailAddress; private String emailAddress;
@ -15,5 +15,7 @@ public class CertificateSubject {
private String state; private String state;
private String locality; private String locality;
public static class CertificateSubjectBuilder {} public static class CertificateInfoSubjectBuilder {
// Class only exists to allow the builder to be statically imported.
}
} }

View file

@ -1,15 +1,26 @@
package de.mlessmann.certassist.openssl; package de.mlessmann.certassist.openssl;
import static de.mlessmann.certassist.Constants.CERTASSIST_TMP_PREFIX;
import static java.util.concurrent.TimeUnit.*;
import static org.slf4j.LoggerFactory.getLogger;
import de.mlessmann.certassist.DeleteRecursiveFileVisitor; import de.mlessmann.certassist.DeleteRecursiveFileVisitor;
import de.mlessmann.certassist.except.CommandLineOperationException; import de.mlessmann.certassist.except.CommandLineOperationException;
import de.mlessmann.certassist.except.UnresolvableCLIDependency; import de.mlessmann.certassist.except.UnresolvableCLIDependency;
import de.mlessmann.certassist.openssl.CertificateRequest.RequestType; import de.mlessmann.certassist.models.CertificateInfo;
import de.mlessmann.certassist.openssl.CertificateSubject.CertificateSubjectBuilder; import de.mlessmann.certassist.models.CertificateInfo.RequestType;
import de.mlessmann.certassist.models.CertificateInfoExtension;
import de.mlessmann.certassist.models.CertificateInfoSubject;
import de.mlessmann.certassist.models.CertificateInfoSubject.CertificateInfoSubjectBuilder;
import de.mlessmann.certassist.service.ExecutableResolver; import de.mlessmann.certassist.service.ExecutableResolver;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.springframework.lang.NonNull;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
import org.zeroturnaround.exec.ProcessExecutor;
import org.zeroturnaround.exec.ProcessResult;
import org.zeroturnaround.exec.StartedProcess;
import org.zeroturnaround.exec.stream.slf4j.Slf4jStream;
import java.io.IOException; import java.io.IOException;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.nio.file.Files; import java.nio.file.Files;
@ -25,17 +36,10 @@ import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Matcher; import java.util.regex.Matcher;
import java.util.regex.Pattern; import java.util.regex.Pattern;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j; import static de.mlessmann.certassist.Constants.CERTASSIST_TMP_PREFIX;
import org.apache.commons.lang3.StringUtils; import static java.util.concurrent.TimeUnit.*;
import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger;
import org.springframework.lang.NonNull;
import org.springframework.stereotype.Service;
import org.springframework.util.CollectionUtils;
import org.zeroturnaround.exec.ProcessExecutor;
import org.zeroturnaround.exec.ProcessResult;
import org.zeroturnaround.exec.StartedProcess;
import org.zeroturnaround.exec.stream.slf4j.Slf4jStream;
@Service @Service
@RequiredArgsConstructor @RequiredArgsConstructor
@ -65,7 +69,7 @@ public class OpenSSLService {
private final CertificatePasswordProvider passwordProvider; private final CertificatePasswordProvider passwordProvider;
private final CertificateProvider certificateProvider; private final CertificateProvider certificateProvider;
private static String buildSubjectArg(CertificateRequest request) { private static String buildSubjectArg(CertificateInfo request) {
String certSubject = OPENSSL_CERT_SUBJECT_TEMPLATE String certSubject = OPENSSL_CERT_SUBJECT_TEMPLATE
.replace("ISO-COUNTRY", request.getSubject().getCountry()) .replace("ISO-COUNTRY", request.getSubject().getCountry())
.replace("STATE", request.getSubject().getState()) .replace("STATE", request.getSubject().getState())
@ -103,7 +107,7 @@ public class OpenSSLService {
} }
@NonNull @NonNull
public OpenSSLCertificateResult createCertificate(CertificateRequest request) throws CommandLineOperationException { public OpenSSLCertificateResult createCertificate(CertificateInfo request) throws CommandLineOperationException {
Path tmpDir; Path tmpDir;
try { try {
tmpDir = Files.createTempDirectory(CERTASSIST_TMP_PREFIX); tmpDir = Files.createTempDirectory(CERTASSIST_TMP_PREFIX);
@ -150,7 +154,7 @@ public class OpenSSLService {
} }
} }
private Path createKeyfile(CertificateRequest request, Path outFile, String filePassword) private Path createKeyfile(CertificateInfo request, Path outFile, String filePassword)
throws CommandLineOperationException { throws CommandLineOperationException {
Path keyFile = outFile.toAbsolutePath(); Path keyFile = outFile.toAbsolutePath();
log.debug("Writing new certificate key to {}", keyFile); log.debug("Writing new certificate key to {}", keyFile);
@ -182,7 +186,7 @@ public class OpenSSLService {
return keyFile; return keyFile;
} }
private Path createCertificate(CertificateRequest request, Path keyFile, Path outFile, String keyPassphrase) private Path createCertificate(CertificateInfo request, Path keyFile, Path outFile, String keyPassphrase)
throws CommandLineOperationException { throws CommandLineOperationException {
log.debug("Writing new certificate file {}", outFile); log.debug("Writing new certificate file {}", outFile);
@ -222,7 +226,7 @@ public class OpenSSLService {
return outFile; return outFile;
} }
private Path createSigningRequest(CertificateRequest request, Path keyFile, Path outFile, String certPassword) private Path createSigningRequest(CertificateInfo request, Path keyFile, Path outFile, String certPassword)
throws CommandLineOperationException { throws CommandLineOperationException {
log.atDebug().log("Writing new certificate signing request file {}", outFile); log.atDebug().log("Writing new certificate signing request file {}", outFile);
@ -363,7 +367,7 @@ public class OpenSSLService {
} }
private Path signCertificate( private Path signCertificate(
CertificateRequest request, CertificateInfo request,
Path caCert, Path caCert,
Path caKey, Path caKey,
String caKeyPassphrase, String caKeyPassphrase,
@ -377,7 +381,7 @@ public class OpenSSLService {
String extContent = CSR_EXT_TEMPLATE; String extContent = CSR_EXT_TEMPLATE;
List<String> altNames = Optional List<String> altNames = Optional
.ofNullable(request.getExtension()) .ofNullable(request.getExtension())
.map(CertificateRequestExtension::getAlternativeNames) .map(CertificateInfoExtension::getAlternativeDnsNames)
.orElse(List.of()); .orElse(List.of());
if (!altNames.isEmpty()) { if (!altNames.isEmpty()) {
AtomicInteger counter = new AtomicInteger(1); AtomicInteger counter = new AtomicInteger(1);
@ -489,7 +493,7 @@ public class OpenSSLService {
} }
} }
public CertificateRequest getCertificateInfo(Path path) throws CommandLineOperationException { public CertificateInfo getCertificateInfo(Path path) throws CommandLineOperationException {
StartedProcess infoProc = null; StartedProcess infoProc = null;
try { try {
infoProc = infoProc =
@ -563,14 +567,14 @@ public class OpenSSLService {
} }
} }
private CertificateRequest getCertificateInfo(String[] lines) { private CertificateInfo getCertificateInfo(String[] lines) {
var builder = CertificateRequest.builder(); var builder = CertificateInfo.builder();
boolean hasIssuer = false; boolean hasIssuer = false;
for (int i = 0; i < lines.length; i++) { for (int i = 0; i < lines.length; i++) {
String line = lines[i]; String line = lines[i];
if (line.startsWith("subject=")) { if (line.startsWith("subject=")) {
CertificateSubjectBuilder subjectBuilder = CertificateSubject.builder(); var subjectBuilder = CertificateInfoSubject.builder();
line = lines[++i]; line = lines[++i];
while (line.startsWith(" ")) { while (line.startsWith(" ")) {
@ -580,7 +584,7 @@ public class OpenSSLService {
builder = builder.subject(subjectBuilder); builder = builder.subject(subjectBuilder);
} else if (line.startsWith("issuer=")) { } else if (line.startsWith("issuer=")) {
hasIssuer = true; hasIssuer = true;
CertificateSubjectBuilder issuerBuilder = CertificateSubject.builder(); var issuerBuilder = CertificateInfoSubject.builder();
line = lines[++i]; line = lines[++i];
while (line.startsWith(" ")) { while (line.startsWith(" ")) {
@ -591,7 +595,7 @@ public class OpenSSLService {
builder = builder.issuer(issuerBuilder); builder = builder.issuer(issuerBuilder);
} else if (line.startsWith("X509v3 Subject Alternative Name")) { } else if (line.startsWith("X509v3 Subject Alternative Name")) {
String[] altNames = lines[++i].split(","); String[] altNames = lines[++i].split(",");
builder = builder.extension(CertificateRequestExtension.builder().alternativeNames(altNames)); builder = builder.extension(CertificateInfoExtension.builder().alternativeDnsNames(altNames));
} }
} }
@ -599,7 +603,7 @@ public class OpenSSLService {
return builder.build(); return builder.build();
} }
private CertificateSubjectBuilder readSubjectInfo(String line, CertificateSubjectBuilder builder) { private CertificateInfoSubjectBuilder readSubjectInfo(String line, CertificateInfoSubjectBuilder builder) {
String[] parts = line.split("=", 2); String[] parts = line.split("=", 2);
if (parts.length != 2) { if (parts.length != 2) {
return builder; return builder;

View file

@ -1,9 +1,7 @@
package de.mlessmann.certassist.service; package de.mlessmann.certassist.service;
import de.mlessmann.certassist.except.CommandLineOperationException; import de.mlessmann.certassist.except.CommandLineOperationException;
import de.mlessmann.certassist.models.Certificate; import de.mlessmann.certassist.models.*;
import de.mlessmann.certassist.models.CertificateExtension;
import de.mlessmann.certassist.models.CertificateType;
import de.mlessmann.certassist.openssl.*; import de.mlessmann.certassist.openssl.*;
import de.mlessmann.certassist.repositories.CertificateRepository; import de.mlessmann.certassist.repositories.CertificateRepository;
import java.io.IOException; import java.io.IOException;
@ -22,12 +20,10 @@ public class CertificateCreationService {
private final OpenSSLService openSSLService; private final OpenSSLService openSSLService;
private final PassphraseService passphraseService; private final PassphraseService passphraseService;
public Certificate createCertificate(final CertificateRequest certificateRequest) { public Certificate createCertificate(final CertificateInfo certificateInfo) {
final Certificate certificate = createEntityFromRequest(certificateRequest); final Certificate certificate = createEntityFromRequest(certificateInfo);
try ( try (OpenSSLCertificateResult certificateCreatorResult = openSSLService.createCertificate(certificateInfo);) {
OpenSSLCertificateResult certificateCreatorResult = openSSLService.createCertificate(certificateRequest);
) {
certificate.setPrivateKey(Files.readAllBytes(certificateCreatorResult.certificateKeyPath())); certificate.setPrivateKey(Files.readAllBytes(certificateCreatorResult.certificateKeyPath()));
certificate.setCert(Files.readAllBytes(certificateCreatorResult.certificatePath())); certificate.setCert(Files.readAllBytes(certificateCreatorResult.certificatePath()));
} catch (CommandLineOperationException | IOException e) { } catch (CommandLineOperationException | IOException e) {
@ -38,26 +34,26 @@ public class CertificateCreationService {
return certificate; return certificate;
} }
private Certificate createEntityFromRequest(CertificateRequest certificateRequest) { private Certificate createEntityFromRequest(CertificateInfo certificateInfo) {
final Certificate certificate = new Certificate(); final Certificate certificate = new Certificate();
certificate.setType(mapCertificateRequestType(certificateRequest.getType())); certificate.setType(mapCertificateRequestType(certificateInfo.getType()));
certificate.setSubjectCommonName(certificateRequest.getSubject().getCommonName()); certificate.setSubjectCommonName(certificateInfo.getSubject().getCommonName());
certificate.setTrustingAuthority(certificateRequest.getTrustingAuthority()); certificate.setTrustingAuthority(certificateInfo.getTrustingAuthority());
certificate.setRequestedKeyLength(certificateRequest.getRequestedKeyLength()); certificate.setRequestedKeyLength(certificateInfo.getRequestedKeyLength());
certificate.setRequestedValidityDays(certificateRequest.getRequestedValidityDays()); certificate.setRequestedValidityDays(certificateInfo.getRequestedValidityDays());
final CertificateSubject certificateSubject = certificateRequest.getSubject(); final CertificateInfoSubject subjectInfo = certificateInfo.getSubject();
certificate.setSubjectEmailAddress(certificateSubject.getEmailAddress()); certificate.setSubjectEmailAddress(subjectInfo.getEmailAddress());
certificate.setSubjectOrganization(certificateSubject.getOrganization()); certificate.setSubjectOrganization(subjectInfo.getOrganization());
certificate.setSubjectOrganizationalUnit(certificateSubject.getOrganizationalUnit()); certificate.setSubjectOrganizationalUnit(subjectInfo.getOrganizationalUnit());
certificate.setSubjectCountry(certificateSubject.getCountry()); certificate.setSubjectCountry(subjectInfo.getCountry());
certificate.setSubjectState(certificateSubject.getState()); certificate.setSubjectState(subjectInfo.getState());
certificate.setSubjectLocality(certificateSubject.getLocality()); certificate.setSubjectLocality(subjectInfo.getLocality());
final CertificateRequestExtension extension = certificateRequest.getExtension(); final CertificateInfoExtension extension = certificateInfo.getExtension();
if (extension != null) { if (extension != null) {
final CertificateExtension certificateExtension = new CertificateExtension(); final CertificateExtension certificateExtension = new CertificateExtension();
certificateExtension.setIdentifier("alternativeNames"); certificateExtension.setIdentifier("alternativeNames");
certificateExtension.setValue(String.join(",", extension.getAlternativeNames())); certificateExtension.setValue(String.join(",", extension.getAlternativeDnsNames()));
certificate.setCertificateExtension(List.of(certificateExtension)); certificate.setCertificateExtension(List.of(certificateExtension));
} }
return certificate; return certificate;
@ -79,7 +75,7 @@ public class CertificateCreationService {
} }
} }
private CertificateType mapCertificateRequestType(CertificateRequest.RequestType requestType) { private CertificateType mapCertificateRequestType(CertificateInfo.RequestType requestType) {
return switch (requestType) { return switch (requestType) {
case ROOT_AUTHORITY -> CertificateType.ROOT_CA; case ROOT_AUTHORITY -> CertificateType.ROOT_CA;
case STANDALONE_CERTIFICATE -> CertificateType.STANDALONE_CERT; case STANDALONE_CERTIFICATE -> CertificateType.STANDALONE_CERT;

View file

@ -2,9 +2,9 @@ package de.mlessmann.certassist;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import de.mlessmann.certassist.openssl.CertificateRequest; import de.mlessmann.certassist.models.CertificateInfo;
import de.mlessmann.certassist.openssl.CertificateRequestExtension; import de.mlessmann.certassist.models.CertificateInfoExtension;
import de.mlessmann.certassist.openssl.CertificateSubject; import de.mlessmann.certassist.models.CertificateInfoSubject;
import de.mlessmann.certassist.service.CertificateCreationService; import de.mlessmann.certassist.service.CertificateCreationService;
import java.nio.file.Path; import java.nio.file.Path;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
@ -19,11 +19,11 @@ public class CertificateServiceTest {
@Test @Test
void testCanCreateCertificate() { void testCanCreateCertificate() {
var request = CertificateRequest var request = CertificateInfo
.builder() .builder()
.type(CertificateRequest.RequestType.STANDALONE_CERTIFICATE) .type(CertificateInfo.RequestType.STANDALONE_CERTIFICATE)
.subject( .subject(
CertificateSubject CertificateInfoSubject
.builder() .builder()
.commonName("cert.creation") .commonName("cert.creation")
.country("DE") .country("DE")
@ -31,7 +31,7 @@ public class CertificateServiceTest {
.locality("HH") .locality("HH")
.organization("Crazy-Cats") .organization("Crazy-Cats")
) )
.extension(CertificateRequestExtension.builder().alternativeNames("test2.home", "test3.home")) .extension(CertificateInfoExtension.builder().alternativeDnsNames("test2.home", "test3.home"))
.build(); .build();
var cert = certificateService.createCertificate(request); var cert = certificateService.createCertificate(request);
assertThat(cert).isNotNull(); assertThat(cert).isNotNull();

View file

@ -3,8 +3,11 @@ package de.mlessmann.certassist;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.*; import static org.mockito.Mockito.*;
import de.mlessmann.certassist.models.CertificateInfo;
import de.mlessmann.certassist.models.CertificateInfo.RequestType;
import de.mlessmann.certassist.models.CertificateInfoExtension;
import de.mlessmann.certassist.models.CertificateInfoSubject;
import de.mlessmann.certassist.openssl.*; import de.mlessmann.certassist.openssl.*;
import de.mlessmann.certassist.openssl.CertificateRequest.RequestType;
import de.mlessmann.certassist.service.ExecutableResolver; import de.mlessmann.certassist.service.ExecutableResolver;
import java.nio.file.Path; import java.nio.file.Path;
import java.util.Objects; import java.util.Objects;
@ -38,11 +41,11 @@ class TestOpenSSLService {
ExecutableResolver executableResolver = new ExecutableResolver(); ExecutableResolver executableResolver = new ExecutableResolver();
var certificateCreator = new OpenSSLService(executableResolver, passwordProvider, certificateProvider); var certificateCreator = new OpenSSLService(executableResolver, passwordProvider, certificateProvider);
CertificateRequest certRequest = CertificateRequest CertificateInfo certRequest = CertificateInfo
.builder() .builder()
.type(RequestType.STANDALONE_CERTIFICATE) .type(RequestType.STANDALONE_CERTIFICATE)
.subject( .subject(
CertificateSubject CertificateInfoSubject
.builder() .builder()
.commonName("test.home") .commonName("test.home")
.country("DE") .country("DE")
@ -50,7 +53,7 @@ class TestOpenSSLService {
.locality("HH") .locality("HH")
.organization("Crazy-Cats") .organization("Crazy-Cats")
) )
.extension(CertificateRequestExtension.builder().alternativeNames("test2.home", "test3.home")) .extension(CertificateInfoExtension.builder().alternativeDnsNames("test2.home", "test3.home"))
.build(); .build();
try (var cert = certificateCreator.createCertificate(certRequest)) { try (var cert = certificateCreator.createCertificate(certRequest)) {
@ -61,12 +64,12 @@ class TestOpenSSLService {
.withFailMessage(ERR_NOT_ENCRYPTED) .withFailMessage(ERR_NOT_ENCRYPTED)
.isTrue(); .isTrue();
CertificateRequest childRequest = CertificateRequest CertificateInfo childRequest = CertificateInfo
.builder() .builder()
.type(RequestType.NORMAL_CERTIFICATE) .type(RequestType.NORMAL_CERTIFICATE)
.trustingAuthority(cert.fingerprint()) .trustingAuthority(cert.fingerprint())
.subject( .subject(
CertificateSubject CertificateInfoSubject
.builder() .builder()
.commonName("test.local") .commonName("test.local")
.country("DE") .country("DE")
@ -74,7 +77,7 @@ class TestOpenSSLService {
.locality("HH") .locality("HH")
.organization("Crazy-Cats") .organization("Crazy-Cats")
) )
.extension(CertificateRequestExtension.builder().alternativeNames("test2.local", "test3.local")) .extension(CertificateInfoExtension.builder().alternativeDnsNames("test2.local", "test3.local"))
.build(); .build();
var spiedCert = spy(cert); var spiedCert = spy(cert);
@ -116,6 +119,6 @@ class TestOpenSSLService {
assertThat(request.getSubject().getState()).isEqualTo("SH"); assertThat(request.getSubject().getState()).isEqualTo("SH");
assertThat(request.getSubject().getLocality()).isEqualTo("HH"); assertThat(request.getSubject().getLocality()).isEqualTo("HH");
assertThat(request.getSubject().getOrganization()).isEqualTo("Crazy-Cats"); assertThat(request.getSubject().getOrganization()).isEqualTo("Crazy-Cats");
assertThat(request.getExtension().getAlternativeNames()).containsExactly("test2.local", "test3.local"); assertThat(request.getExtension().getAlternativeDnsNames()).containsExactly("test2.local", "test3.local");
} }
} }