Search code examples
javaspringspring-bootssltruststore

Client Certificate Authentication with Spring Boot


I need to import a certificate in order to make a http request to an external service in a Spring Boot application.

How do I set up Spring Boot in order to do this?

There's a lot of information out there but I'm finding it all a bit confusing. It seems as though I may just need to create something like a "truststore.jks" keystore and import the correct certificate, and and add some entries to my application.properties.


Solution

  • Start by generating a self-signed certificate using keytoolif you don't already have one

    Open your terminal or cmd

    keytool -genkeypair -alias tomcat -keyalg RSA -keysize 2048 -storetype PKCS12 -keystore keystore.p12 -validity 3650
    

    Answer all the questions. In the first question: what's your first name and last name put localhost.

    If you have already a certificate yourcertificate.crt do this

    keytool -import -alias tomcat -file yourcertificate.crt -keystore keystore.p12 -storepass password
    

    You will get a file called keystore.p12.

    Copy this file to your resources folder

    Add the following lines to your properties file

    # Define a custom port instead of the default 8080
    server.port=8443
    
    # Tell Spring Security (if used) to require requests over HTTPS
    security.require-ssl=true
    
    # The format used for the keystore 
    server.ssl.key-store-type=PKCS12
    # The path to the keystore containing the certificate
    server.ssl.key-store=classpath:keystore.p12
    # The password used to generate the certificate
    server.ssl.key-store-password= {your password here}
    # The alias mapped to the certificate
    server.ssl.key-alias=tomcat
    

    Create a Config class as follows

    @Configuration
    public class ConnectorConfig {
    
        @Bean
        public TomcatServletWebServerFactory servletContainer() {
            TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory() {
                @Override
                protected void postProcessContext(Context context) {
                    SecurityConstraint securityConstraint = new SecurityConstraint();
                    securityConstraint.setUserConstraint("CONFIDENTIAL");
                    SecurityCollection collection = new SecurityCollection();
                    collection.addPattern("/*");
                    securityConstraint.addCollection(collection);
                    context.addConstraint(securityConstraint);
                }
            };
            tomcat.addAdditionalTomcatConnectors(getHttpConnector());
            return tomcat;
        }
    
        private Connector getHttpConnector() {
            Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
            connector.setScheme("http");
            connector.setPort(8080);
            connector.setSecure(false);
            connector.setRedirectPort(8443);
            return connector;
        }
    }
    

    Now your application is accessible with https://localhost:8443

    Now you can access your third service that asks you for ssl authentication