tags: springboot ,apache, https

一句话概括：现在网站访问基本都需要使用https访问，否则浏览器就会报不安全提示，本文针对springboot+apache前后端分离的项目的https设置与部署进行说明。

1. 引言

当前访问互联网上的应用，基本都使用https了，否则浏览器会提示不安全，存在信息安全风险，还影响用户体验。最近公司需要对当前http访问的项目进行https部署，当前项目是使用前后端分离，后端使用springboot，前端使用apache，本文将对部署过程进行记录，并对https及相关知识做一下梳理，主要包括以下内容：

对https、证书、openssl和keytool进行简要解释，了解相关概念。
使用openssl及keytool自签证书
对springboot项目添加https访问支持
对apache添加https访问支持

2. 了解https、证书、openssl及keytool

2.1 https

2.1.1 什么是https

使用http已经可以完成功能，为什么还需要使用https，原因是使用http传输的内容是明文的，明文的数据传输容易被拦截，造成数据容易被修改，数据内容容易泄露的危险，如何解决这种不安全问题，当然是需要对数据进行加密传输，于是，就有了https。https是Hyper Text Transfer Protocol over Secure Socket Layer的缩写，表示安全的超文本传输协议，它基于SSL/TLS协议对传输的数据进行加密，以保证传输过程中的安全性，所以https协议=SSL/TLS+http协议。

2.1.2 https解决什么问题

一般对于信息安全问题，主要需要解决三大问题：身份明确性，数据保密性，数据完整性，因此，https针对这三个问题的解决方法是（1）使用数字证书识别身份；（2）使用加密技术（对称加密和非对称加密）保证数据保密性；（3）使用数据签名防止数据被篡改；具体这里涉及到对称加密，非对称加密，数字签名，数字证书及SSL/TLS的运行原理等概念，此处不详细展开，可以参考文章《一文看懂HTTPS、证书机构（CA）、证书、数字签名、私钥、公钥》和《SSL/TLS协议运行机制的概述》。

2.2 证书

2.2.1 证书内容

刚才已经说到，https是使用数字证书来识别身份，即确定当前访问的服务器是真的。数字证书由权威的颁发机构（CA）在验证服务器身份后颁发的一种数字证书，内容包含加密后服务器的公钥、权威机构的信息、有效期，证书内容的数字签名（通过Hash函数计算得到证书数字摘要，然后用权威机构私钥加密数字摘要得到数字签名)，签名计算方法以及证书对应的域名。最重要的是服务器的公钥，另外，这里所说的CA可以是商用的，也可以自建来私有使用（只是自建的CA生成的证书浏览器不公认）。

公钥、私钥是非对称加密中的概念：公钥(public key)是对外开放的，私钥(private key)是自己拥有的。公钥加密的数据，只能用私钥解密。私钥加密的数据，只能用公钥解密。

2.2.2 验证证书过程

数字证书是使用数字签名来识别身份。当客户端收到服务器的证书之后，使用CA的公钥对证书本身进行解密得到服务端的公钥和证书的数字签名，数字签名经过CA公钥解密得到证书信息摘要。然后证书签名的方法计算一下当前证书的信息摘要，与收到的信息摘要作对比，如果一样，表示证书一定是服务器下发的，没有被中间人篡改过。详细可参见《数字证书基本知识总结》、《Java 和 HTTP 的那些事（四） HTTPS 和证书》、《一次看懂 Https 证书认证》

2.2.3 证书种类

前面使用到的证书从使用者来看，分别有CA证书，服务端（server）证书和客户端(client)证书。其中，CA证书作为根证书，由它来签发server证书和client证书，也由它的公钥和私钥对server证书和client证书进行识别。server证书的公钥和私钥用于https通信过程数据加解密等操作。一般对于服务器的单向认证，只需要CA证书和服务端证书。

按证书格式分，X.509#DER二进制格式证书，常用后缀.cer .crt；X.509#PEM文本格式证书，常用后缀.pem；有的证书内容是只包含公钥（服务器的公钥），如.crt、.cer、.pem；有的证书既包含公钥又包含私钥（服务器的私钥），如.pfx、.p12

2.3 openssl

openssl 是一套密码库工具，用以支持SSL/TLS 协议的实现，可以用它生成证书，进行数据加解密，计算消息摘要等等。通过它可以进行自签名证书（把自己当作CA机构），实现https访问。本文使用的就是这种方式。一般linux已自带安装，没有安装的需要下载安装。

2.4 keytool

keytool是一个Java数据证书的管理工具，位置是在java安装目录下的bin目录。keytool将密钥（key）和证书（certificates）存在一个称为keystore的文件中。注意keystore不仅可以存储数字证书，还可以存储密钥。存储在 Keystore 文件中的对象有三种类型：Certificate、PrivateKey 和 SecretKey 。Certificate 就是证书，PrivateKey 是非对称加密中的私钥，SecretKey 用于对称加密，是对称加密中的密钥。因此，对于java应用中，可以直接使用keytool即可生成相应的keystore进行https设置。

3. 自签证书

了解了基本概念后，现在开始动手进行https部署。第一步是先进行自签证书，这里使用openssl生成证书，然后使用keytool生成相应的keystore文件。

以下命令操作在linux下完成，做的是服务端单向认证

3.1 证书生成过程

3.1.1 自建CA证书

# 生成根证书私钥
openssl genrsa -des3 -passout pass:111111 -out ca.key 2048

# 签发根证书
openssl req -new -x509 -days 3650 -passin pass:111111 -key ca.key -out ca.crt -subj "/C=CN/ST=GD/L=GZ/O=test/OU=test/CN=${ip或域名}"

说明，上述操作中:

pass:111111 表示ca证书的密码，可以自定义，这样可以避免以交互方式输入密码，密码可以自定义。
参数-subj 中，CN为根证书的域名，请根据实际情况填写。
由于是自签，参数days可以随便填数量。

3.1.2 CA签发服务端证书

# 生成服务器证书私钥
openssl genrsa -des3 -passout pass:111111 -out server.key 2048
# 生成服务器证书请求
openssl req -new \
    -sha256 \
    -key server.key \
	-passin pass:111111 \
    -subj "/C=CN/ST=GD/L=GZ/O=test/OU=test/CN=${ip或域名}" \
    -reqexts SAN \
    -config <(cat /path/to/openssl.cnf \
        <(printf "[SAN]\nsubjectAltName=IP:${ip或域名}")) \
-out server.csr
# 签发服务器证书
openssl ca -in server.csr \
	-days 3650 \
	-passin pass:111111 \
        -md sha256 \
        -keyfile ca.key \
    -cert ca.crt \
    -extensions SAN \
    -config <(cat /path/to/openssl.cnf \
        <(printf "[SAN]\nsubjectAltName=IP:${ip或域名}")) \
-out server.crt	

说明，上述操作中：

参数-subj 中，CN为根证书的域名，请根据实际情况填写。
/path/to/openssl.cnf，请根据实际的openssl.cnf位置修改。
参数[SAN]\nsubjectAltName，若使用IP，则以IP:开头，若是域名，使用DNS:开头。

3.1.3 证书存入keystore文件

# 生成服务器证书转pkcs12
openssl pkcs12 -export -in server.crt -passin pass:111111 -passout pass:111111 -inkey server.key -out server.pkcs12

# pkcs12转keystore 
keytool -importkeystore -v -srckeystore server.pkcs12 -srcstoretype pkcs12 -srcstorepass 111111 -destkeystore server.jks -deststoretype jks -deststorepass 111111 -noprompt

至此，我们已经生成了后面需要使用到的ca.crt，server.key，server.crt，server.jks。

3.2 证书生成注意事项

由于Chrome 58 及以上版本只会使用 subjectAlternativeName 扩展程序（而不是 CN即commonName）来匹配域名和网站证书。因此，在生成证书时需要加上SAN。参考文章《OpenSSL 生成「自签名」证书遇到的 missing_subjectAltName 问题》及《使用 OpenSSL 制作一个包含 SAN（Subject Alternative Name）的证书》
遇到类似“/etc/pki/CA: No such file or directory”错误，解决方法是在当前目录（如果是默认安装的openssl，在/etc/pki/CA）执行下面命令:
```
mkdir -p /etc/pki/CA
cd /etc/pki/CA
touch index.txt
touch serial
echo 01 > serial 
```
遇到类似”update database“错误，则清空index.txt内容再重新执行命令。

4. 后端springboot工程添加https访问

4.1 springboot工程添加ssl配置项

java工程使用keystore进行证书管理，先把server.jks放到springboot工程的resource目录下。然后在springboot配置文件application.properties添加以下配置：

# https访问端口
server.port=443
server.ssl.key-store=server.jks
server.ssl.key-alias=server
server.ssl.enabled=true
server.ssl.key-store-password=111111
server.ssl.key-store-type=JKS

4.2 添加内置tomcat的http转发https

如果是使用tomcat部署，其实直接在tomcat的配置文件中进行配置https的connector即可。对于springboot，一般我们通过添加配置文件，以实现对tomcat的配置修改。新建TomcatConfig.java文件，添加以下代码：

@Bean
public TomcatServletWebServerFactory tomcatServletWebServerFactory(Connector connector) {
    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(connector);
    return tomcat;
}

@Bean
public Connector connector(){
    Connector connector=new Connector("org.apache.coyote.http11.Http11NioProtocol");
    connector.setScheme("http");
    //http端口
    connector.setPort(8080);
    connector.setSecure(false);
    // https端口，即server.port
    connector.setRedirectPort(serverPort);
    return connector;
}

说明，此处新建了http的Connector，并把http的访问都转发到https，这样，当用户访问http时直接跳转为https。若需要http和https同时使用，则把setRedirectPort去掉即可。

5. 前端apache添加https访问

5.1 apached.conf添加ssl支持

5.1.1 启用需要的模块

LoadModule rewrite_module modules/mod_rewrite.so
LoadModule ssl_module        modules/mod_ssl.so
LoadModule socache_shmcb_module modules/mod_socache_shmcb.so

5.1.2 引入ssl配置

使用Include引入ssl配置，如下：

 Include conf/extra/httpd-ssl.conf

5.1.3 修改配置Directory

把允许重写设置为All，把AllowOverride None 改为 AllowOverride all

<Directory "/root/path/">
   Options Indexes FollowSymLinks
   AllowOverride all
   Require all granted
</Directory>

5.2 httpd-ssl.conf 添加ssl配置

前端已经引入httpd-ssl.conf文件，因此，需要对此文件进行ssl配置。如下：

# 启用https端口
Listen 443 https
# 启用SSL并设置服务端证书及私钥
SSLEngine on
SSLCertificateFile "/path/to/server.crt"
SSLCertificateKeyFile "/path/to/server.key"

说明，根据实际情况设置证书路径。

5.3 添加http转发https

在网站目录下创建一个.htaccess文件，写入如下规则，把全部80端口的请求都转发到本机的https对应的端口（默认443）：

RewriteEngine On
RewriteCond %{SERVER_PORT} 80     
RewriteRule ^(.*)$ https://%{HTTP_HOST}/$1 [R,L]

5.4 访问后端接口地址添加https地址

前端需要调用后端接口，由于已经改为使用https通信，因此，调用接口需要从原来http地址，改为https访问的端口。上述全部配置完成后，重启apache即可（重启需要输入server.key对应的密码）

6. 客户端添加证书

最后，由于使用的是自签名的证书，浏览器不认识这证书，因此，需要把自签的CA证书添加到浏览器中，才能正常访问。以chrome浏览器为例，设置-》高级》隐私设置和安全性》管理证书》受信息的根证书颁发机构，导入ca.crt。这样，就可以愉快地使用https，不提示安全问题了。

7. 总结

本文通过操作实例进行了对springboot+apache前后端分离项目的https部署，先对https、证书、openssl及keytool进行初步的了解，然后通过openssl和keytool生成证书及keystore，接着对后端springboot及前端的apache分别进行配置。希望可以帮助到同样需要进行https部署的同学。

参考资料

往期文章

关注我的公众号（搜索Mason技术记录），获取更多技术记录：

Mason技术记录

java 16

book 4

SpringBatch 9

docsify 2

github 2

MongoDB 1

troubleshooting 8

monitor 8

jvm 1

jvisualvm 1

jconsole 1

mat 1

btrace 1

arthas 1

ai 1

machinelearning 1

deeplearning 1

springboot 8

swagger 2

doc 3

logback 2

log 2

apache 1

https 1

dynamic-proxy 1

aop 1

life 3

summary 3

multi-datasource 3

minio 2

static-resource-server 1

distributed 1

storage 1

python 3

os 1

path 1

excel 2

openpyxl 1

db 1

mysql 1

springboot+apache前后端分离部署https