操作场景
- 本文档指导您如何为 Spring Boot 配置安装 PFX 格式 SSL 证书。
- 以证书名称 ubn.cn通配符证书,域名test.ubn.cn为例。
- Spring Boot 版本以 3.0.2 为例,当前服务器的操作系统为 CentOS 7,由于操作系统的版本不同,详细操作步骤略有区别。
- 安装 SSL 证书前,请您在 Apache 服务器安全组或防火墙开启 “443” 端口,避免证书安装后无法启用 HTTPS。
- SSL 证书文件上传至服务器windows下可使用ftp,linux下可使用winscp、scp、sftp、ftp等工具连接上传。
前提条件
已准备远程文件拷贝软件,例如 WinSCP(建议从官方网站获取最新版本)。 已准备远程登录工具,例如 PuTTY 或者 Xshell(建议从官方网站获取最新版本)。
操作步骤
1.登录网站控制中心下载证书,可参考帮助文档中,证书下载。
2.解压缩ssl证书压缩包
- 解压后文件夹内容:
文件名称路径 | 作用 | 使用类型 |
---|---|---|
ubn_cn.key | 证书私钥 | iis/apache/nginx通用私钥 |
Apache/ubn_cn.crt | 证书文件 | apache使用 |
IIS/ubn_cn.pfx | 证书文件 | iis使用 |
Nginx/ubn_cn.crt | 证书文件 | nginx、防火墙、cdn、负载均衡、对象存储等通用 |
- 解压后文件示例:
3.将已获取到的iis目录下ubn_cn.pfx证书文件从本地目录拷贝至 Spring Boot项目src/main/resources目录下。
4.远程登录 Spring Boot 服务器,可参考如何上传文件到云服务器
5.编辑 Spring Boot 项目的 application.properties 或application.yml 文件。并根据实际需求从以下方式中选择一种进行操作:
- 方式1 修改 application.properties 文件,添加如下内容:
server.address=test.ubn.cnserver.port = 443server.ssl.key-store = classpath:ubn_cn.pfxserver.ssl.key-store-password = *******server.ssl.keyStoreType = PKCS12
- 方式2
server: address:test.ubn.cn port: 443 ssl: test.ubn.cn key-store-password: ******* key-store-type: PKCS12 key-store: classpath: ubn_cn.pfx
配置文件的主要参数说明如下:
- classpath: 指的是项目的src/main/java和src/main/resources路径。存放在这两个路径下的文件都可以使用classpath 作为路径来引用。
- key-store:证书文件的存放位置。即操作步骤3存放证书文件的路径。
- key-store-password:密码文件密码,指定 keystore 的密码。
若申请证书时未设置私钥密码,请填写iis文件夹中 readme.txt文件内的密码。 key-alias:密钥别名。在控制中心下载的,别名为证书的绑定域名。如:test.ubn.cn
6.重启 Spring Boot 服务。若启动成功,即可使用 https://test.ubn.cn 进行访问。
如果浏览器地址栏显示安全锁标识,则说明证书安装成功。如下图所示: