Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bug Fix - Resolve exception for system certificates on Mac and Linux #368

Merged
merged 3 commits into from
Aug 4, 2023
Merged

Bug Fix - Resolve exception for system certificates on Mac and Linux #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39b4f6f
Only create truststore if it is not empty
Hakky54 Aug 3, 2023
f83605d
Log invalid certificates and proceed with the flow.
Hakky54 Aug 4, 2023
eb602bd
Follow symbolic links.
Hakky54 Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions sslcontext-kickstart/src/main/java/nl/altindag/ssl/util/CertificateUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
import nl.altindag.ssl.exception.GenericCertificateException;
import nl.altindag.ssl.exception.GenericIOException;
import nl.altindag.ssl.util.internal.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.net.ssl.X509TrustManager;
import javax.security.auth.x500.X500Principal;
Expand Down Expand Up @@ -63,6 +65,8 @@
*/
public final class CertificateUtils {

private static final Logger LOGGER = LoggerFactory.getLogger(CertificateUtils.class);

private static final String CERTIFICATE_TYPE = "X.509";
private static final String P7B_HEADER = "-----BEGIN PKCS7-----";
private static final String P7B_FOOTER = "-----END PKCS7-----";
Expand Down Expand Up @@ -242,20 +246,14 @@ private static List<Certificate> parseCertificate(Matcher certificateMatcher) {
return Collections.unmodifiableList(certificates);
}

/**
* PKIX/RFC 5280 states that duplicate extensions are not allowed. See section 4.2 of it.
* A certificate which contains a duplicate extension is not parseable. Instead of throwing an exception, it will be ignored.
*/
public static List<Certificate> parseDerCertificate(InputStream certificateStream) {
try(BufferedInputStream bufferedCertificateStream = new BufferedInputStream(certificateStream)) {
return CertificateFactory.getInstance(CERTIFICATE_TYPE)
.generateCertificates(bufferedCertificateStream).stream()
.collect(toUnmodifiableList());
} catch (CertificateException | IOException e) {
if (e.getMessage().contains("Duplicate extensions not allowed")) {
return Collections.emptyList();
}
throw new GenericCertificateException("There is no valid certificate present to parse. Please make sure to supply a valid der formatted certificate", e);
LOGGER.debug("There is no valid certificate present to parse. Please make sure to supply a valid der formatted certificate", e);
return Collections.emptyList();
}
}

Expand Down
12 changes: 8 additions & 4 deletions sslcontext-kickstart/src/main/java/nl/altindag/ssl/util/KeyStoreUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,14 +210,18 @@ public static List<KeyStore> loadSystemKeyStores() {
createKeyStoreIfAvailable("KeychainStore", null).ifPresent(keyStores::add);

List<Certificate> systemTrustedCertificates = MacCertificateUtils.getCertificates();
KeyStore systemTrustStore = createTrustStore(systemTrustedCertificates);
keyStores.add(systemTrustStore);
if (!systemTrustedCertificates.isEmpty()) {
KeyStore systemTrustStore = createTrustStore(systemTrustedCertificates);
keyStores.add(systemTrustStore);
}
break;
}
case LINUX: {
List<Certificate> certificates = LinuxCertificateUtils.getCertificates();
KeyStore linuxTrustStore = createTrustStore(certificates);
keyStores.add(linuxTrustStore);
if (!certificates.isEmpty()) {
KeyStore linuxTrustStore = createTrustStore(certificates);
keyStores.add(linuxTrustStore);
}
break;
}
case ANDROID: {
Expand Down
3 changes: 2 additions & 1 deletion sslcontext-kickstart/src/main/java/nl/altindag/ssl/util/LinuxCertificateUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import nl.altindag.ssl.exception.GenericIOException;

import java.io.IOException;
import java.nio.file.FileVisitOption;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
Expand Down Expand Up @@ -64,7 +65,7 @@ static List<Certificate> getCertificates() {
List<Certificate> certs = loadCertificate(path);
certificates.addAll(certs);
} else if (Files.isDirectory(path)) {
try(Stream<Path> files = Files.walk(path, 1)) {
try(Stream<Path> files = Files.walk(path, 1, FileVisitOption.FOLLOW_LINKS)) {
List<Certificate> certs = files
.filter(Files::isRegularFile)
.flatMap(file -> loadCertificate(file).stream())
Expand Down
13 changes: 8 additions & 5 deletions sslcontext-kickstart/src/test/java/nl/altindag/ssl/util/CertificateUtilsShould.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
package nl.altindag.ssl.util;

import nl.altindag.log.LogCaptor;
import nl.altindag.ssl.TestConstants;
import nl.altindag.ssl.exception.GenericCertificateException;
import nl.altindag.ssl.exception.GenericIOException;
Expand Down Expand Up @@ -568,11 +569,13 @@ void throwsGenericIOExceptionWhenCloseOfTheStreamFails() throws IOException {
}

@Test
void throwGenericCertificateExceptionWhenUnsupportedDataIsProvided() throws IOException {
try(ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream("Hello".getBytes())) {
assertThatThrownBy(() -> CertificateUtils.parseDerCertificate(byteArrayInputStream))
.isInstanceOf(GenericCertificateException.class)
.hasMessage("There is no valid certificate present to parse. Please make sure to supply a valid der formatted certificate");
void generateDebugMessageWhenUnsupportedDataIsProvided() throws IOException {
try(LogCaptor logCaptor = LogCaptor.forClass(CertificateUtils.class);
ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream("Hello".getBytes())) {
List<Certificate> certificates = CertificateUtils.parseDerCertificate(byteArrayInputStream);

assertThat(certificates).isEmpty();
assertThat(logCaptor.getDebugLogs()).contains("There is no valid certificate present to parse. Please make sure to supply a valid der formatted certificate");
}
}

Expand Down
4 changes: 2 additions & 2 deletions sslcontext-kickstart/src/test/java/nl/altindag/ssl/util/KeyStoreUtilsShould.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ void loadMacSystemKeyStore() {
KeyStore keychainStore = mock(KeyStore.class);
KeyStore systemTrustStore = mock(KeyStore.class);

try (MockedStatic<MacCertificateUtils> macCertificateUtilsMockedStatic = mockStatic(MacCertificateUtils.class);
try (MockedStatic<MacCertificateUtils> macCertificateUtilsMockedStatic = mockStatic(MacCertificateUtils.class, invocationOnMock -> Collections.singletonList(mock(X509Certificate.class)));
MockedStatic<KeyStoreUtils> keyStoreUtilsMockedStatic = mockStatic(KeyStoreUtils.class, invocation -> {
Method method = invocation.getMethod();
if ("loadSystemKeyStores".equals(method.getName()) && method.getParameterCount() == 0) {
Expand Down Expand Up @@ -283,7 +283,7 @@ void loadLinuxSystemKeyStoreReturns() {

KeyStore systemTrustStore = mock(KeyStore.class);

try (MockedStatic<LinuxCertificateUtils> linuxCertificateUtilsMockedStatic = mockStatic(LinuxCertificateUtils.class);
try (MockedStatic<LinuxCertificateUtils> linuxCertificateUtilsMockedStatic = mockStatic(LinuxCertificateUtils.class, invocationOnMock -> Collections.singletonList(mock(X509Certificate.class)));
MockedStatic<KeyStoreUtils> keyStoreUtilsMockedStatic = mockStatic(KeyStoreUtils.class, invocation -> {
Method method = invocation.getMethod();
if ("loadSystemKeyStores".equals(method.getName()) && method.getParameterCount() == 0) {
Expand Down
4 changes: 4 additions & 0 deletions sslcontext-kickstart/src/test/java/nl/altindag/ssl/util/LinuxCertificateUtilsShould.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,12 +238,16 @@ void getCertificatesReturnsCertificatesWhenFileExistWithinDirectory() {
return true;
} else if ("isRegularFile".equals(methodName) && "/etc/ssl/certs".equals(path)) {
return false;
} else if ("isSymbolicLink".equals(methodName) && "/etc/ssl/certs".equals(path)) {
return false;
} else if ("isDirectory".equals(methodName) && "/etc/ssl/certs".equals(path)) {
return true;
} else if ("walk".equals(methodName)) {
return Stream.of(Paths.get("/etc/ssl/certs/some-certificate.pem"));
} else if ("isRegularFile".equals(methodName) && "/etc/ssl/certs/some-certificate.pem".equals(path)) {
return true;
} else if ("isSymbolicLink".equals(methodName) && "/etc/ssl/certs/some-certificate.pem".equals(path)) {
return true;
} else if ("exists".equals(methodName)) {
return false;
} else {
Expand Down
Loading