SpringBoot项目如何部署SSL证书 (JKS格式)

最新推荐文章于 2024-08-01 10:57:17 发布
最新推荐文章于 2024-08-01 10:57:17 发布
阅读量6.9k 收藏 40
点赞数 27
文章标签： spring boot ssl 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45688141/article/details/132157819
版权

1、SpringBoot项目如何部署SSL证书 (JKS格式)

1. 获取 SSL 证书和私钥

首先，你需要获取有效的 SSL 证书和私钥。SSL 证书是一种用于加密通信的数字证书，它可以通过购买商业 SSL 证书或使用免费的 Let’s Encrypt 证书获得。请确保你拥有证书文件和与之对应的私钥文件，这通常是以 .pem 和 .key 结尾的文件或者是jks格式的，本文以jks格式的SSL证书为例。

2. 配置 Spring Boot 项目

接下来，我们将配置 Spring Boot 项目以使用 SSL。

2.0 项目环境

spring boot 2.2.2
maven
一个域名（各大域名商有售，阿里、腾讯、华为）
SSL证书（阿里云上有免费的SSL证书，有效期一年）

2.1 将 SSL 证书和私钥文件添加到项目

将之前获取的 SSL 证书和私钥文件拷贝到 Spring Boot 项目中的 src/main/resources 目录下。这样，证书文件会与项目一起打包并在运行时加载。
pPCuks1.png

2.2 配置 application.properties 或 application.yml

在 Spring Boot 项目的配置文件（application.properties 或 application.yml）中添加以下 SSL 相关配置：

server:
  port: 8856
  servlet:
    context-path: /
  ssl:
    enabled: true
    # 保存SSL证书的秘钥库的路径
    key-store: classpath:ssl/xxx.com.jks
    key-store-password: xxx
    # 证书类型
    key-store-type: JKS
#    key-store-protocol: TLS
2.3 编写controller进行测试

添加一个controller，测试是否生效，测试结果如下：
pPCuAqx.png
通过上述访问发现，如果通过http访问会提示访问需要组合TLS，但是如果用户直接通过这种方式访问的话，存在着极差的用户体验。

2.4 编写配置类HTTP转HTPPS

当用户使用http访问的时候，将http协议重定向到https端口
（1）修改配置文件

custom:  # 自定义http启动端口
  http-port: 8857

server:
  port: 8856
  servlet:
    context-path: /
  ssl:
    enabled: true
    #key-alias: alias-key # 别名(可以不进行配置)
    # 保存SSL证书的秘钥库的路径
    key-store: classpath:ssl/xxx.com.jks
    key-store-password: xxx
    # 证书类型
    key-store-type: JKS
#    key-store-protocol: TLS

（2）添加配置类

package org.pp.ssl.config;

import org.apache.catalina.Context;
import org.apache.catalina.connector.Connector;
import org.apache.tomcat.util.descriptor.web.SecurityCollection;
import org.apache.tomcat.util.descriptor.web.SecurityConstraint;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * https配置，将http请求全部转发到https
 * @author P_P
 */
@Configuration
public class HttpsConfig {

    @Value("${custom.http-port: 8857}")
    private Integer httpPort;

    @Value("${server.port}")
    private Integer port;

    @Bean
    public TomcatServletWebServerFactory servletContainer() {
        // 将http请求转换为https请求
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory() {
            @Override
            protected void postProcessContext(Context context) {
                SecurityConstraint constraint = new SecurityConstraint();
                // 默认为NONE
                constraint.setUserConstraint("CONFIDENTIAL");
                SecurityCollection collection = new SecurityCollection();
                // 所有的东西都https
                collection.addPattern("/*");
                constraint.addCollection(collection);
                context.addConstraint(constraint);
            }
        };
        tomcat.addAdditionalTomcatConnectors(httpConnector());
        return tomcat;
    }

    /**
     * 强制将所有的http请求转发到https
     *
     * @return httpConnector
     */
    @Bean
    public Connector httpConnector() {
        Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
        connector.setScheme("http");
        // connector监听的http端口号
        connector.setPort(httpPort);
        connector.setSecure(false);
        // 监听到http的端口号后转向到的https的端口号
        connector.setRedirectPort(port);
        return connector;
    }
}

（3）启动项目
添加配置类之后，启动项目可以看到控制台出现了https端口和http端口
pPCugFU.png
再次访问测试接口，会发现地址栏出现了https
pPCuhl9.png

（4）同时开启http和https
如果不想将http请求都转发到https进行处理，可以同时开启http和https

/**
 * 同时开启http和https
 * @author P_P
 */
import org.apache.catalina.connector.Connector;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class HttpsConfig {
    @Value("${custom.http-port: 8857}")
    private Integer httpPort;

    @Bean
    public TomcatServletWebServerFactory servletContainer() {
        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
        tomcat.addAdditionalTomcatConnectors(httpConnector());
        return tomcat;
    }

    @Bean
    public Connector httpConnector() {
        Connector connector = new Connector("org.apache.coyote.http11.Http11NioProtocol");
        connector.setPort(httpPort);
        return connector;
    }
}

这样访问8857（http协议）的端口就不会进行转发了
pPCuqYD.png

3、spring boot配置ssl证书，异常：Invalid keystore format

3.1环境介绍

springBoot中配置了一个bean，bean加载的时候，会进行jks的加载，jks文件放在src/resources下，然后就报错了，错误如下。

2023-08-03 22:22:27.261:[ERROR] [main:6839] [org.springframework.boot.SpringApplication.reportFailure:826] --> Application run failed 
org.springframework.boot.web.server.WebServerException: Unable to start embedded Tomcat server
	at org.springframework.boot.web.embedded.tomcat.TomcatWebServer.start(TomcatWebServer.java:215)
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.startWebServer(ServletWebServerApplicationContext.java:297)
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.finishRefresh(ServletWebServerApplicationContext.java:163)
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:553)
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:141)
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:747)
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:397)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:315)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1226)
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1215)
	at org.ee.authority.AuthorityApplication.main(AuthorityApplication.java:28)
  Caused by: java.lang.IllegalArgumentException: Invalid keystore format
	at org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:99) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
	at org.apache.tomcat.util.net.AbstractJsseEndpoint.initialiseSsl(AbstractJsseEndpoint.java:71) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
	at org.apache.tomcat.util.net.NioEndpoint.bind(NioEndpoint.java:218) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
	at org.apache.tomcat.util.net.AbstractEndpoint.bindWithCleanup(AbstractEndpoint.java:1142) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
	at org.apache.tomcat.util.net.AbstractEndpoint.start(AbstractEndpoint.java:1228) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
	at org.apache.coyote.AbstractProtocol.start(AbstractProtocol.java:586) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
	at org.apache.catalina.connector.Connector.startInternal(Connector.java:1005) ~[tomcat-embed-core-9.0.29.jar:9.0.29]
Caused by: java.lang.IllegalArgumentException: standardService.connector.startFailed
	at org.apache.catalina.core.StandardService.addConnector(StandardService.java:231)
	at org.springframework.boot.web.embedded.tomcat.TomcatWebServer.addPreviouslyRemovedConnectors(TomcatWebServer.java:278)
	at org.springframework.boot.web.embedded.tomcat.TomcatWebServer.start(TomcatWebServer.java:197)
	... 10 common frames omitted
Caused by: org.apache.catalina.LifecycleException: Protocol handler start failed
	at org.apache.catalina.connector.Connector.startInternal(Connector.java:1008)
	at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:183)
	at org.apache.catalina.core.StandardService.addConnector(StandardService.java:227)
	... 12 common frames omitted
Caused by: java.lang.IllegalArgumentException: Invalid keystore format
	at org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:99)
	at org.apache.tomcat.util.net.AbstractJsseEndpoint.initialiseSsl(AbstractJsseEndpoint.java:71)
	at org.apache.tomcat.util.net.NioEndpoint.bind(NioEndpoint.java:218)
	at org.apache.tomcat.util.net.AbstractEndpoint.bindWithCleanup(AbstractEndpoint.java:1142)
	at org.apache.tomcat.util.net.AbstractEndpoint.start(AbstractEndpoint.java:1228)
	at org.apache.coyote.AbstractProtocol.start(AbstractProtocol.java:586)
	at org.apache.catalina.connector.Connector.startInternal(Connector.java:1005)
	... 14 common frames omitted
Caused by: java.io.IOException: Invalid keystore format
	at sun.security.provider.JavaKeyStore.engineLoad(JavaKeyStore.java:666)
	at sun.security.provider.JavaKeyStore$JKS.engineLoad(JavaKeyStore.java:57)
	at sun.security.provider.KeyStoreDelegator.engineLoad(KeyStoreDelegator.java:224)
	at sun.security.provider.JavaKeyStore$DualFormatJKS.engineLoad(JavaKeyStore.java:71)
	at java.security.KeyStore.load(KeyStore.java:1449)
	at org.apache.tomcat.util.security.KeyStoreUtil.load(KeyStoreUtil.java:69)
	at org.apache.tomcat.util.net.SSLUtilBase.getStore(SSLUtilBase.java:217)
	at org.apache.tomcat.util.net.SSLHostConfigCertificate.getCertificateKeystore(SSLHostConfigCertificate.java:206)
	at org.apache.tomcat.util.net.SSLUtilBase.getKeyManagers(SSLUtilBase.java:283)
	at org.apache.tomcat.util.net.SSLUtilBase.createSSLContext(SSLUtilBase.java:247)
	at org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:97)
	... 20 common frames omitted
3.2现象及原因分析

直接用main函数解析jks文件，一点毛病都没有。但是打包后启动Tomact再解析就不行，直接启动单元测试（完整加载bean的形式）也不行。

后来发现，在target文件夹下，jks文件的大小变了。查了资料，大概明白错误的根本原因了：maven编译或者打包的时候，对文件的内容进行了修改（maven编译的时候使用了占位符，替换的时候使文件发生了变化），这就导致了jks文件发生变化。

3.3解决方案

配置MAVEN过滤JKS等格式的文件，在pom的build配置中增加如下过滤配置，将jks过滤掉。（提一句，以下配置中也过滤了xlsx，是因为打包后Excel文件也会坏掉）

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <configuration>
                    <encoding>${project.build.sourceEncoding}</encoding>
                    <useDefaultDelimiters>true</useDefaultDelimiters>
                    <includeEmptyDirs>true</includeEmptyDirs>
                    <!-- 证书文件 -->
                    <nonFilteredFileExtensions>
                        <nonFilteredFileExtension>pem</nonFilteredFileExtension>
                        <nonFilteredFileExtension>pfx</nonFilteredFileExtension>
                        <nonFilteredFileExtension>p12</nonFilteredFileExtension>
                        <nonFilteredFileExtension>key</nonFilteredFileExtension>
                        <nonFilteredFileExtension>xlsx</nonFilteredFileExtension>
                        <nonFilteredFileExtension>jks</nonFilteredFileExtension>
                    </nonFilteredFileExtensions>
                </configuration>
            </plugin>
            <!-- java文档插件 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.0</version>
            </plugin>
        </plugins>
    </build>
七七r
关注
专栏目录
springboot下配置SSL证书HTTPS访问
07-17
springboot下配置SSL证书HTTPS访问，简单快捷通俗易通，
详细SpringBoot框架教程——SpringBoot配置SSL（https）
热门推荐
m0_55070913的博客
08-31 1万+
如果使用了上面的配置就表示springboot应用程序不再在端口8080上支持HTTP连接请求，SpringBoot不能通过配置application.properties来实现既支持HTTP连接又支持HTTPS连接，这是做不到的，如果要同时支持HTTP和HTTPS，则需要以编程方式配置其中的一个，建议使用application.properties文件来配置HTTPS，以编程方式配置HTTP，这是比较容易的方法；1、生成证书，可以使自签名证书（平时测试的时候）或者从SSL证书授权中心购买证书（上线）；..
在Spring Boot应用安装SSL证书操作教程
最新发布
程序员weixin_sodomany的博客
08-01 990
本文介绍如何在Spring Boot应用中配置SSL证书，具体包括下载和上传证书文件，在Spring Boot应用配置证书文件、证书链和证书密码等参数，以及安装证书后结果的验证。关于吊销证书和申请证书的操作，请参见吊销SSL证书和提交证书申请。如果您修改过Spring Boot项目的目录，您需要将证书文件和密码文件拷贝到与配置文件application.properties或application.yml相同的目录下。证书安装完成后，您可通过访问证书的绑定域名验证该证书是否安装成功。
SpringBoot项目 配置ssl证书，实现https协议
jinchunzhao的博客
06-21 7561
一、阿里云购买cas证书、配置证书、下载证书 2.下载证书 3.证书 二、项目打包方式一： jar包 1.下载的证书放在项目根目录下 2.application.properties配置文件中的配置 3.证书放在项目部署的服务器同级目录中 4.启动项目 nohup java -jar dwSmartBuffet-0.0.1-SNAPSHOT.jar &gt...
SpringBoot配置SSL证书
等风来的博客
01-19 5919
SpringBoot项目配置SSL证书
SpringBoot 如何配置 SSL
u013749113的博客
10-08 3268
SSL（安全套接层）是一种用于加密通信的协议。它通过将数据加密传输来保护通信的机密性和完整性。SSL协议通常用于Web浏览器和Web服务器之间的安全通信，以确保用户的敏感数据（如密码、信用卡号等）在传输过程中不被窃取或篡改。
SpringBoot配置SSL证书，开启HTTPS安全访问！！！
qq_43532069的博客
07-03 4569
ssl证书配置开启https安全访问！
springboot项目安装ssl证书
qq_35158778的博客
07-05 630
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录前言一、下载SSL证书1.注册域名2.下载ssl证书二、项目配置1.配置 application.properties 配置文件2. 编写配置类总结 前言 springboot内嵌了tomcat，下面我来给大家演示一下如何给springboot内嵌的toomcat配置SSL证书。 提示：以下是本篇文章正文内容，下面案例可供参考 一、下载SSL证书 这里我使用腾讯云注册域名来演示 1.注册域名 这个大家可以自行百度 2.下载ssl
Ubuntu零基础教学-SpringBoot项目如何生成SSL证书并配置HTTPS协议 | 超级详细，建议收藏
**My Coding Family**
04-01 351
SpringBoot项目如何生成SSL证书并配置HTTPS协议，快进来，我教你...
spring boot 部署ssl证书
W1948730080的博客
05-16 1204
一、注册ssl证书 在阿里云有免费的ssl证书可以申请 值得注意的是ssl证书绑定的域名和服务器需要在同一个账号上 通过后点击下载（以tomcat为例） 解压后 二、压缩.jks文件 使用jdk中的keytool制作 打开dos命令框 进入jdk下的bin文件 输入 keytool -importkeystore -srckeystore <pfx文件的本地位置> -destkey...
SpringBoot部署SSL证书
Dare_Huang的博客
02-23 362
1.阿里云下载证书，放到项目resource目录下 2.修改properties配置文件 ##默认端口为443，可以使用其他端口 server.port=443 ##下载的pfd文件名，路径要写对 server.ssl.key-store=classpath:*.pfx ##证书密码，下载文件中有 server.ssl.key-store-password=证书密码 ##pfx文件适用格式 server.ssl.keyStoreType=PKCS12 完成以上两步，你就完成了Springbo.
Spring Boot 开启https访问（配置SSL证书）
jiey0407的博客
08-02 1349
实际工作中为了提高数据传输的安全性，采用HTTPS通讯，简单来说，HTTPS协议是由SSL+HTTP协议构建的可进行加密传输，相比http协议安全。SSL证书需要到CA机构申请证书，仅为测试可以使用jdk生成自签证书。...
SpringBoot配置https(SSL证书)
qq_40902067的博客
06-23 7866
SpringBoot配置https(SSL证书)
springboot配置ssl证书,支持https
esunny的专栏
11-08 1740
本人uos20，按照网上指导安装openssl.查看openssl版本得到结果： OpenSSL 1.1.1t 7 Feb 2023。
SpringBoot+Vue2前后端项目配置ssl证书
weixin_45974277的博客
07-29 7101
springboot项目配置ssl证书
springboot 腾讯云SSL证书
07-27
Spring Boot是一个用于创建独立的、基于生产级别的Java应用程序的框架。腾讯云提供了SSL证书服务，可以用于保护Spring Boot应用程序的安全通信。 要在Spring Boot应用程序中使用腾讯云SSL证书，你需要进行以下步骤： 1. 在腾讯云控制台购买SSL证书，并获取证书文件和私钥文件的名称。 2. 在Spring Boot的配置文件中添加SSL证书的相关配置。你需要指定证书文件的路径、密码和类型。例如，你可以在配置文件中添加以下配置： ``` server.port=443 server.ssl.key-store=classpath:your_certificate_file.jks server.ssl.key-store-password=your_certificate_password server.ssl.key-store-type=JKS ``` 3. 修改启动类，将HTTP请求重定向到HTTPS。你可以在启动类中添加以下代码： ```java @Configuration public class HttpsRedirectConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/").setViewName("forward:/index.html"); registry.addViewController("/index.html").setViewName("forward:/index.html"); registry.addViewController("/login.html").setViewName("forward:/login.html"); } @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(httpConnector()); return tomcat; } @Bean public Connector httpConnector() { Connector connector = new Connector(TomcatServletWebServerFactory.DEFAULT_PROTOCOL); connector.setScheme("http"); connector.setPort(80); connector.setSecure(false); connector.setRedirectPort(443); return connector; } } ``` 这样，当用户访问HTTP时，会自动重定向到HTTPS。 请注意，以上代码仅供参考，你需要根据你的具体情况进行相应的修改。 综上所述，你可以通过购买腾讯云SSL证书，并在Spring Boot应用程序中配置相关信息，来实现在腾讯云上使用SSL证书保护你的Spring Boot应用程序的安全通信。 #### 引用[.reference_title] - *1* [Spring Boot配置腾讯云SSL证书](https://blog.csdn.net/qq_36023564/article/details/85019640)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down28v1,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* *3* [腾讯云免费ssl证书+springboot配置ssl+nginx配置ssl](https://blog.csdn.net/lmq2582609/article/details/117487472)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down28v1,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值