Skip to main content

How to configure SSL certificate in spring boot?

Let us learn how to generate & configure the ssl certificates in spring boot applications.

how to configure ssl certificate in spring boot

Step 1. Getting the certificate 

We can purchase the SSL certificate from the following SSL providers  

  • Godaddy
  • DigiCert
  • GeoTrust
  • GlobalSign
  • Comodo SSL
  • RapidSSL
  • SSL.com

OR, for testing purposes, we can generate a self-signed certificate

Before getting started, let us know the format of the SSL certificates:

  • PKCS12: Public Key Cryptographic Standards is a password-protected format that can contain multiple certificates and keys; it's an industry-wide used format.
  • JKS: Java KeyStore is similar to PKCS12; it's a proprietary format and is limited to the Java environment.

To know more about how SSL works please go to this link.

We can use either keytool or OpenSSL tools to generate the certificates from the command line. Keytool is shipped with Java Runtime Environment, and OpenSSL can be downloaded from here.

For our demonstration, let's use keytool.

keytool -genkey -alias localhost -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore localhost.p12 -validity 365 -ext san=dns:localhost

This command will generate a key using the RSA cryptography algorithm. Arguments of the keytool program are stated below:

    • -genkey: generates a key
    • -alias localhost: defines the name of the key, here we have named 'localhost', which uniquely identifies your domain name
    • -storetype PKCS12: this defines the format of the key that is stored as 'PKCS12'
    • -keyalg RSA: used to specify the algorithm to be used is 'RSA'
    • -keysize 2048: used to define the size of the key as '2048' bit
    • -keystore localhost.p12: specifies the name of the file that stores the key is 'localhost.p12'
    • -validity 365: it is used to set the expiration date of the key will be '365' days from now
    • -ext san=dns:localhost: includes an X.509 extension for Subject Alternate Name (SAN)- a SAN is required so the certificated will be trusted by browsers on localhost

Note: The keytool program is available in JDK's bin directory, so you need to navigate to JDK_HOME\bin

generating ssl certificate command image

Step 2. Add the generated certificate file in your project

Copy and paste the generated key <localhost.p12>   into the resource folder of the project structure as shown below.  

how to configure ssl in spring boot project project structure

Step 3. Setting up the SSL configurations in application properties

Add the necessary SSL configuration to the application.properties file.

httpPort = 8080
server.port=8443
server.ssl.key-store: classpath:localhost.p12
server.ssl.key-store-password: abcd123
server.ssl.keyStoreType: pkcs12
server.ssl.keyAlias: localhost

Step 4. Add the connectors configurations

Add connectors configurations and port redirection from default port to secured port.

@Configuration
public class ConnectorConfig {

    @Value("${server.port}")
    int httpsPort;
    @Value("${httpPort}")
    int httpPort;
    /**
     * This method is used to get Servlet Container
     * @return ServletWebServerFactory
     */
    @Bean
    public ServletWebServerFactory 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(redirectConnector());
        return tomcat;
    }
    /**
     * This method is used to get redirect Connector
     * @return Connector
     */
    private Connector redirectConnector() {

        Connector connector = new Connector(TomcatServletWebServerFactory.DEFAULT_PROTOCOL);
        connector.setScheme("http");
        connector.setPort(httpPort);
        connector.setSecure(false);
        connector.setRedirectPort(httpsPort);
        return connector;
    }
}

Step 5. Output screens

https port security risk exception

redirecting to https port in spring boot

Thanks for reading this article. I hope you understood well.

Popular posts from this blog

Understanding - Spring Initializr

The Spring Initializr is ultimately a web application that generates a Spring Boot project structure for you. It can be used from different interfaces. From Web-based interface ( https://start.spring.io or https://start-scs.cfapps.io ) From supported IDE s STS , Eclipse , Netbeans , Intellij Idea . In the case of Eclipse, you need to install a plugin 'STS'. From CLI (Command Line Interface) Web-Based UI  (the same interface is opened in supported IDEs )   Project: Maven or Gradle          This is the selection of the project built tool or Dependency Manager that is used to manage all the dependencies added in the projects and to compile and pack the project in selected packaging ( jar or war ). If you want to know more about the selection of built tool and comparison between Maven and Gradle click the below link. What to choose Maven or Gradle?   Language: This section will is used to select the language in which you are comfortabl...

How to Implement Spring Security in Spring Boot

Security Example in Spring Boot Implementation of Spring Security in the Spring Boot application is the key point to learn for spring boot developers. Because Authentication and Authorization are the backbones of the whole application. Getting started with the Spring Security Series, this is the first part, in this article we are going to focus on the authentication part with minimal registration. The implementation of registration flow with email verification, customizing password encoding, and setting up password strengths and rules will be explored in another separate article for each.  This article will be the base of the spring security series, the other security features will be explained on the basis of this implementation, so be focused and let's understand. The code contains proper naming & brief comments that makes it very comprehensive. If you feel any difficulty or find any issue, please drop a comment below this post The main goal of this article is to impleme...

How to Implement AWS RDS Database IAM Authentication in Spring Boot

Amazon RDS for MySQL allows authentication using AWS Identity and Access Management (IAM) database authentication. With this authentication method, you don't need to use a password when you connect to a DB instance. Instead, you use an authentication token. Let us understand how this works? An authentication token is a unique string of characters that Amazon RDS generates on request. Authentication tokens are generated using AWS Signature Version 4. Each token has a lifetime of 15 minutes. You don't need to store user credentials in the database, because authentication is managed externally using IAM. You can also still use standard database authentication. Since IAM authentication tokens are short-lived access tokens that are valid for 15 minutes. For the RDS database this token works as a database password that is required to establish a connection and does not determine how long the existing connection can last. The default value for connection to be alive without activit...

Custom Pagination with search and filters in Spring Boot

Every spring boot application is made to manage a large set of data. Also, we need to perform a search and filter the data according to need, And also we cannot load all data in one go on a single page so we need pagination too. In this article, we are going to demonstrate custom pagination with search and filter performed through ajax call. Goal: This demonstration is performed on a set of students' data. We have written a method to generate sample data.   Table of Contents 1. Initialize the project with the following dependencies 2. Set the application properties 3. Create the Student entity 4. Enum to denote the class of student 5. Create JPA repository of entity 6. Create the search & filter command object (CO) 7. Create a data transfer object (DTO) of the Entity for returning the response 8. Create a service for implementing the business login 9. Create a controller 10. Create a utility class for date conversions 11. Create the HTML Data Table design 12. ...

How to deploy the Spring Boot application ( jar/war ) on the live server?

There are various methods to deploy the Spring Boot application. In the previous page, we have described how to generate builds (jar/war) by Maven/Gradle. In this article, we will describe the built deployment process. So before we begin deploying spring boot applications that are built in either jar or war, we need to understand what are the differences between them, both can be built using any of the built tools Gradle and Maven. Table of Contents What are the differences between jar and war? How to generate builts jar or war in spring boot? Deploying a JAR (Java Archive) as a standalone application Deploying a WAR (Web Application Archive) into a servlet container What are the differences between jar and war? jar (Java ARchive) war ( Web Application Resource) JAR stands for J ava AR chive. WAR   stands for W eb A pplication R esource, also stated W eb application AR chive. It is used to aggregate many Java class files and associated metadata and reso...

How to upload files in Amazon S3 Bucket using Spring Boot

As stated in the title, we are going to demonstrate that how we can upload and retrieve files from the amazon s3 bucket in spring boot. For this, we must have an account on amazon web services (AWS) . And the next thing you need to have is an IAM user that has programmatic access to the s3 bucket. Follow the steps below to create an IAM user and s3 bucket. Table of Contents 1. Steps to create an IAM user in AWS with S3 bucket full access permission Step 1.1 Login to your AWS account   Step 1.2 Set the user details Step 1.3 Set user permissions Step 1.4 Create a user group and set the access policy Step 1.5 Add user to the group Step 1.6  Set the tags (optional) Step 1.7  Review the user details and permission summary Step 1.8 Download the user credentials 2. See, how to create s3 bucket. Step 2.1 Click on the "Create bucket" button. Step 2.2 Enter the bucket name and select bucket region. Step 2.3 Set file accessibility for bucket items as publi...

Built and Run the example in Spring Boot

In this example, we are using the web-based Spring Initializr interface to generate the package. Here we have added web dependency only to demonstrate the running, building jar/war and understanding build.gradle / pom.xml Step 1:  Open https://start.spring.io to initialize your project with your selected dependencies. Here we are using 'Spring Web', 'Thymeleaf', and 'Spring Boot DevTools' dependencies for the hello world demonstration.  Now, click on the generate button, it will start downloading a demo.zip file. Step 2:  Extract the downloaded zip in step 1. Import this project to your favorite IDE by navigating the extracted folder path and selecting the pom.xml or build.gradle file, you will get pom.xml when your project is a Maven project and build.gradle if your project is a Gradle project. Here we will be using IntelliJ Idea.      Click on OK and follow the instructions with default settings. On successful importing, you will get the main ru...

Maven or Gradle - built tool selection in Spring Boot

  Spring Boot -Selection of built tool Gradle Gradle is an open-source build automation tool that is designed to be flexible enough to build almost any type of software, It is fully open source and similar to Maven and Ant. But Gradle has taken advantage of both Maven and Ant and also it has removed the disadvantages of Maven and Ant and created as a first-class built tool. It uses domain-specific language based on the programming language Groovy , differentiating it from Apache Maven, which uses XML for its project configuration. Gradle allows to create or customize built procedure and we can create an additional task with groovy scripts that can be executed before/after built. It also determines the order of tasks run by using a directed acyclic graph . Several developers created Gradle and first released in 2007, and in 2013, it was adopted by Google as the build system for Android projects. It was designed to support multi-project builds that are expected...

Basic Annotations in Spring Boot

Annotations are the key components. Spring Boot annotations are simple and self-explanatory. There are a large number of annotations are implemented in Spring  Core. But In Spring Boot most of the annotations are enhanced and combined in simpler ones to write fewer lines of code. For example: If you are ever worked with spring core you need to apply @Configuration , @EnableAutoConfiguration and @ComponentScan . Now In Spring Boot, these three are combined into @SpringBootApplication . Here we have listed 32 annotations and explained, in brief, what every beginner should know. If you understand the use and start playing with these annotations no one can stop you to become a master in spring boot. We will provide the detailed example later on so please subscribe to this blog from the footer section by providing an email id: Table of Contents Basic Annotations in Spring Boot 1.@SpringBootApplication 2.@Component 3.@Service 4.@Repository 5.@Controller 6.@RestController ...

Spring Boot Introduction

Spring Boot is the extension of Spring framework including all the features of Spring. Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can just run. Spring Boot is becoming favorite of developers nowadays, because of it’s a rapid production-ready environment which enables the developers to directly focus on the logic instead of struggling with the configuration and set up in very less time. It is mostly used to create Micro-Services. 1. Why Spring Boot is evolved? Spring makes programming Java quicker, easier, and safer for everybody. Spring's focus on speed, simplicity, and productivity has made it the world's most popular Java framework. It's MVC architecture that is a widely used module of spring, used to create scalable web applications.   But the most stumbling block of the spring projects is the configuration that takes a lot of time and concentr...