手把手教Apereo CAS5.2.3服务端Server的开发环境

素颜马尾好姑娘i 2022-05-28 04:19 231阅读 0赞

hugeo的CAS系列：[https://blog.csdn.net/u010588262/article/category/7548325][https_blog.csdn.net_u010588262_article_category_7548325]  
DEMO下载：[https://download.csdn.net/download/u010588262/10327539][https_download.csdn.net_download_u010588262_10327539]

搞了有三天，搭建环境真不容易，坑很多，官网英文文档看着费劲也不详细，网上教程也不详细，只能自己摸索了，现在到了造福大众的时候了

# 下载 #

在这里把zip文件下载下来：（我下载的时候版本是5.2.3）  
[https://github.com/apereo/cas-overlay-template][https_github.com_apereo_cas-overlay-template]

# 编译 #

解压zip，命令行进去，执行`mvn clean package`  
结束之后会出现 ***target*** 文件夹，里面有war包啥的，把war包解压，比如我们把解压后的文件夹命名为 ***cas\_war*** 吧，后文提到 ***cas\_war*** 就代表是这个文件夹

# 本地配置tomcat通过https访问 #

***注意以下所有命令除了文件路径最好都跟我的保持一致，比如alias，就用tomcat不要换别的，省的小白出问题***  
命令行里cd进入%JAVA\_HOME%/bin目录，配置了环境变量就不用了

#### 1.执行： ####

`keytool -genkeypair -alias "tomcat" -keyalg "RSA" -keystore "E:\projects\hugeo\cas\tomcat.keystore"`  
按照以下输入：

密钥库口令:123456（这个密码非常重要）
    名字与姓氏:www.hugeo.com（域名很重要，建议自己编个域名，在host文件里写好映射，host的使用百度吧）
    组织单位名称:anything（随便填）
    组织名称:anything（随便填）
    城市:anything（随便填）
    省市自治区:anything（随便填）
    国家地区代码:anything（随便填）

现在E:\\projects\\hugeo\\cas\\tomcat.keystore这个文件生成了

#### 2.继续执行： ####

`keytool -export -file E:\projects\hugeo\cas\cas.crt -keystore E:\projects\hugeo\cas\tomcat.keystore -alias tomcat`  
用刚刚的tomcat.keystore文件生成了cas.crt文件

#### 3.导入授权文件到jdk并设置密码： ####

`keytool -import -file E:\projects\hugeo\cas\cas.crt -alias tomcat -keystore E:\programFiles\Java\jre1.8.0_131\lib\security\cacerts -storepass 123456`  
**注意-storepass 123456是设置此步骤的密码的，第一次执行命令设置之后以后再执行这个命令就不要带这个参数了，然后输入密码的时候输第一次设置的密码，这个密码和生成keystore的密码可以不一样，设置成一样的比较方便防止搞混**

要删除也很容易：  
`keytool -delete -alias tomcat -keystore E:\programFiles\Java\jre1.8.0_131\lib\security\cacerts`

(如果导入的时候没有设置别名就再导入一次，会显示别名)

#### 5.修改tomcat的配置文件server.xml ####

删掉：

添加：

#### 6.把crt文件导入浏览器，我用的是chrome ####

![这里写图片描述][70]  
![这里写图片描述][70 1]  
把第二步生成的crt文件导进去进行了

#### 7. 检查配置 ####

把 ***cas\_war*** 放到tomcat的webapp下面改名为cas，启动tomcat，浏览器访问[https://www.hugeo.com:8443/cas/login][https_www.hugeo.com_8443_cas_login]，如果提示签名不正确之类的就点击高级/详细信息，继续访问。

#### 8.注意 ####

大部分情况下本地开发是不需要ssl访问的，所以建议给cas单独弄个tomcat，反正一个tomcat也就十几兆，我本地开发其他项目时用tomcat8，cas使用的是tomcat9，版本其实也没太大关系，好像是高于tomcat8的版本就可以了

# 建项目 #

用idea新建一个spring boot项目，什么插件都不需要  
pom.xml是从第一步下载的zip里的pom文件改造的，最好大概看一下理解一下，需要修改的地方自己改：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.hugeo</groupId>
        <artifactId>cas</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>war</packaging>
    
        <name>cas</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
    
            <cas.version>5.2.3</cas.version>
            <app.server>-tomcat</app.server>
    
            <mainClassName>org.springframework.boot.loader.WarLauncher</mainClassName>
            <isExecutable>false</isExecutable>
            <manifestFileToUse>
                ${project.build.directory}/war/work/org.apereo.cas/cas-server-webapp${app.server}/META-INF/MANIFEST.MF
            </manifestFileToUse>
    
            <maven.compiler.source>1.8</maven.compiler.source>
            <maven.compiler.target>1.8</maven.compiler.target>
            <springboot.version>2.0.0.RELEASE</springboot.version>
        </properties>
    
        <repositories>
            <repository>
                <id>sonatype-releases</id>
                <url>http://oss.sonatype.org/content/repositories/releases/</url>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
                <releases>
                    <enabled>true</enabled>
                </releases>
            </repository>
            <repository>
                <id>sonatype-snapshots</id>
                <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
                <releases>
                    <enabled>false</enabled>
                </releases>
            </repository>
            <repository>
                <id>shibboleth-releases</id>
                <url>https://build.shibboleth.net/nexus/content/repositories/releases</url>
            </repository>
        </repositories>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>${springboot.version}</version>
                    <configuration>
                        <mainClass>${mainClassName}</mainClass>
                        <addResources>true</addResources>
                        <executable>${isExecutable}</executable>
                        <layout>WAR</layout>
                    </configuration>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-war-plugin</artifactId>
                    <version>2.6</version>
                    <configuration>
                        <warName>cas</warName>
                        <failOnMissingWebXml>false</failOnMissingWebXml>
                        <recompressZippedFiles>false</recompressZippedFiles>
                        <archive>
                            <compress>false</compress>
                            <manifestFile>${manifestFileToUse}</manifestFile>
                        </archive>
                        <overlays>
                            <overlay>
                                <groupId>org.apereo.cas</groupId>
                                <artifactId>cas-server-webapp${app.server}</artifactId>
                            </overlay>
                        </overlays>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.3</version>
                </plugin>
            </plugins>
            <finalName>cas</finalName>
        </build>
    
        <dependencies>
            
            <dependency>
                <groupId>org.apereo.cas</groupId>
                <artifactId>cas-server-webapp${app.server}</artifactId>
                <version>${cas.version}</version>
                <type>war</type>
                <scope>runtime</scope>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.44</version>
            </dependency>
        </dependencies>
    
    </project>

搞了很久的还有一个原因是以前没有接触过maven的overlay用法，这个功能就是引入一个war包（不知道jar包可不可以，没试），然后打包的时候，框架会在这个war包的基础上把自己写的类啊，配置文件啊什么加进去，如果原来已经有了就覆盖，了解这个之后就觉得这个用法挺好的，保持了项目的简洁性，实现无侵入性改造。  
我理解的这两个地方是配合使用的：  
![这里写图片描述][70 2]

dependency的war包用于覆盖，overlay用于配置哪些文件不打包到最终war包里，类似这种用法：  
![这里写图片描述][70 3]  
不过我也没试过，猜测的

这样虽然可以打包了，但是依赖的war包里的类并不能编译，想写一个类继承war包里的一个类搞不定，引用不到，scope改成compile也是一样，有博客提到用下面这种糟糕的方式：

<dependency>
        <groupId>org.apereo.cas</groupId>
        <artifactId>cas-server-webapp${app.server}</artifactId>  
        <version>${cas.version}</version>  
        <type>jar</type>
        <classifier>classes</classifier>
        <scope>provided</scope>
      </dependency>

相当于是把war包里需要的jar都下载下来的意思，下载了半年都没下好，很浪费时间空间，因为需要的jar包在咱们的 ***css\_war/WEB\_INF/lib*** 下面都有了啊，所以就不搞这些虚的了，直接在 Project Structure->Modules->Dependencies把 ***css\_war/WEB\_INF/lib*** 引入进来，scope选provided。

webapp目录需要自己创建，如果不用在里面加什么自定义文件的话不创建也可以  
目前为止项目结构：  
![这里写图片描述][70 4]

application.properties和META-INF文件夹从 ***css\_war*** 里面拷贝出来，后面自己定制化会涉及到修改这两个文件

配置调试注意：  
1. tomcat选择配置了ssl的那个  
2. url自己写一下，跟下面的https端口一样  
3. jdk至少1.8  
4. http port不要填，否则启动会报错  
5. contextpath配置一下  
![这里写图片描述][70 5]  
![这里写图片描述][70 6]  
第一次启动应该会出现：  
![这里写图片描述][70 7]  
选accept就行了

大功告成了  
![这里写图片描述][70 8]

目前为止项目应该可以启动了，后续会继续写：  
1. 怎么从数据库验证用户名和密码，默认的用户名和密码是写死在application.properties最后一行的`cas.authn.accept.users=casuser::Mellon`，也就是用户名casuser，密码Mellon。  
2. 客户端的配置  
3. 服务端开启restful验证

[https_blog.csdn.net_u010588262_article_category_7548325]: https://blog.csdn.net/u010588262/article/category/7548325
[https_download.csdn.net_download_u010588262_10327539]: https://download.csdn.net/download/u010588262/10327539
[https_github.com_apereo_cas-overlay-template]: https://github.com/apereo/cas-overlay-template
[70]: /images/20220528/de0f0017fc8c420c8b23498fd290f6f6.png
[70 1]: /images/20220528/f8b1d80447634c4286fd5b0d85854e1f.png
[https_www.hugeo.com_8443_cas_login]: https://www.hugeo.com:8443/cas/login
[70 2]: /images/20220528/6754e92d137f41f8aff4508acd0adb55.png
[70 3]: /images/20220528/1ab8c9574c52482a89fb6539d29ae6d7.png
[70 4]: /images/20220528/94c3dd36ceb048d1a227684c5ed4c062.png
[70 5]: /images/20220528/e4234c71074846b680486b3ab7dc571b.png
[70 6]: /images/20220528/28912b93940c4a03b35bc2150fb3c044.png
[70 7]: /images/20220528/ace9ea947ec5410690249462851bf3e1.png
[70 8]: /images/20220528/f1c8f23138e14585a323e6f2f34c6c4e.png