CAS之5.2x版本自定义JDBC认证-yellowcong

我就是我 2022-05-29 00:16 318阅读 0赞

> 为啥我以前写过cas的jdbc认证，为毛现在还要写呢，因为之前写的是直接通过打war包的方式，而切哪种方式不推荐，所以重新介绍一下cas的认证。在使用jdbc认证的时候，需要两个重要的步骤：1、配置pom.xml，添加cas对jdbc认证的支持，2、配置application.properties ，设定连接的数据源，以及认证用户的字段等信息。

## 代码地址 ##

https://gitee.com/yellowcong/springboot_cas/tree/master/cas-server-jdbc

## pom.xml配置 ##

我们需要在原来的pom.xml基础上，添加数据库驱动，以及 jdbc的支持

<dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.21</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.apereo.cas</groupId>
        <artifactId>cas-server-support-jdbc</artifactId>
        <version>${cas.version}</version>
    </dependency>

### pom.xml配置的完整文件 ###

下图中，我注释掉了一个插件，我也不是太清楚那个echo插件，是搞神马飞机的，由于下载不下来，报错，头疼，就给注释掉了。

<?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>org.apereo.cas</groupId>
        <artifactId>cas-overlay</artifactId>
        <packaging>war</packaging>
        <version>1.0</version>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>com.rimerosolutions.maven.plugins</groupId>
                    <artifactId>wrapper-maven-plugin</artifactId>
                    <version>0.0.4</version>
                    <configuration>
                        <verifyDownload>true</verifyDownload>
                        <checksumAlgorithm>MD5</checksumAlgorithm>
                    </configuration>
                </plugin>
                <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>system</scope>
                <optional>true</optional>
                <systemPath>${project.basedir}/src/main/webapp/WEB-INF/lib/cas-server-webapp-tomcat-${cas.version}.war</systemPath>
            </dependency>
    
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.21</version>
            </dependency> 
    
            
            <dependency>
                <groupId>org.apereo.cas</groupId>
                <artifactId>cas-server-support-jdbc</artifactId>
                <version>${cas.version}</version>
            </dependency>
        </dependencies>
    
        <properties>
            <cas.version>5.2.2</cas.version>
            <springboot.version>1.5.8.RELEASE</springboot.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>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        </properties>
    
        <repositories>
            <repository>
              <id>aliyunmaven</id>
              <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
            </repository>
    
            <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>
    
        <profiles>
            <profile>
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
                <id>exec</id>
                <properties>
                    <mainClassName>org.apereo.cas.web.CasWebApplication</mainClassName>
                    <isExecutable>true</isExecutable>
                    <manifestFileToUse></manifestFileToUse>
                </properties>
                <build>
                    <plugins>
                        
                    </plugins>
                </build>
            </profile>
    
            <profile>
                <activation>
                    <activeByDefault>false</activeByDefault>
                </activation>
                <id>pgp</id>
                <build>
                    <plugins>
                        <plugin>
                            <groupId>com.github.s4u.plugins</groupId>
                            <artifactId>pgpverify-maven-plugin</artifactId>
                            <version>1.1.0</version>
                            <executions>
                                <execution>
                                    <goals>
                                        <goal>check</goal>
                                    </goals>
                                </execution>
                            </executions>
                            <configuration>
                                <pgpKeyServer>hkp://pool.sks-keyservers.net</pgpKeyServer>
                                <pgpKeysCachePath>${settings.localRepository}/pgpkeys-cache</pgpKeysCachePath>
                                <scope>test</scope>
                                <verifyPomFiles>true</verifyPomFiles>
                                <failNoSignature>false</failNoSignature>
                            </configuration>
                        </plugin>
                    </plugins>
                </build>
            </profile>
        </profiles>
    </project>

## 配置application.properties ##

需要配置查询sql的方式，字段，数据库的名称，密码等信息

#设置通过jdbc的方式来进行认证操作。
    cas.authn.jdbc.query[0].sql=SELECT * FROM yellowcong_users WHERE user_name = ?   
    #select * from cms_auth_user where user_name=?
    cas.authn.jdbc.query[0].healthQuery=
    cas.authn.jdbc.query[0].isolateInternalQueries=false
    cas.authn.jdbc.query[0].url=jdbc:mysql://127.0.0.1:3306/yellowcong?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=false
    cas.authn.jdbc.query[0].failFast=true
    cas.authn.jdbc.query[0].isolationLevelName=ISOLATION_READ_COMMITTED
    cas.authn.jdbc.query[0].dialect=org.hibernate.dialect.MySQLDialect
    cas.authn.jdbc.query[0].leakThreshold=10
    cas.authn.jdbc.query[0].propagationBehaviorName=PROPAGATION_REQUIRED
    cas.authn.jdbc.query[0].batchSize=1
    cas.authn.jdbc.query[0].user=root
    #cas.authn.jdbc.query[0].ddlAuto=create-drop
    cas.authn.jdbc.query[0].maxAgeDays=180
    cas.authn.jdbc.query[0].password=root
    cas.authn.jdbc.query[0].autocommit=false
    cas.authn.jdbc.query[0].driverClass=com.mysql.jdbc.Driver
    cas.authn.jdbc.query[0].idleTimeout=5000
    # cas.authn.jdbc.query[0].credentialCriteria=
    # cas.authn.jdbc.query[0].name=
    # cas.authn.jdbc.query[0].order=0
    # cas.authn.jdbc.query[0].dataSourceName=
    # cas.authn.jdbc.query[0].dataSourceProxy=false
    #密码字段的信息
    cas.authn.jdbc.query[0].fieldPassword=PASSWORD
    #加密策略
    cas.authn.jdbc.query[0].passwordEncoder.type=NONE

#### 数据表结构 ####

-- 创建用户表
    CREATE TABLE `yellowcong_users` ( `id` int(11) NOT NULL AUTO_INCREMENT, `age` int(11) DEFAULT NULL, `nick_name` varchar(32) DEFAULT NULL, `password` varchar(32) DEFAULT NULL, `user_name` varchar(32) DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;
    
    
    -- 插入数据
    insert into `yellowcong_users`(`id`,`age`,`nick_name`,`password`,`user_name`) values (1,18,'test1','test3','test1'),(2,22,'yellowcong','yellowcong','yellowcong'),(3,24,'test','test','test'),(4,24,'test4','test4','test4'),(5,23,'yellowlu','yellowlu','yellowlu'),(6,25,'yellow','yellow3','yellow3');

### application.properties 完整配置 ###

下面的配置中，设定了ssl，然后配置了数据库的认证的逻辑。其他的都是cas模板里面的，都没有改动。

##
    # CAS Server Context Configuration
    #
    server.context-path=/
    server.port=8443
    
    #SSL配置 开启https
    server.ssl.enabled=true
    server.ssl.key-store=classpath:tomcat.keystore
    server.ssl.key-store-password=yellowcong
    
    server.max-http-header-size=2097152
    server.use-forward-headers=true
    server.connection-timeout=20000
    server.error.include-stacktrace=ALWAYS
    
    server.compression.enabled=true
    server.compression.mime-types=application/javascript,application/json,application/xml,text/html,text/xml,text/plain
    
    server.tomcat.max-http-post-size=2097152
    server.tomcat.basedir=build/tomcat
    server.tomcat.accesslog.enabled=true
    server.tomcat.accesslog.pattern=%t %a "%r" %s (%D ms)
    server.tomcat.accesslog.suffix=.log
    server.tomcat.max-threads=10
    server.tomcat.port-header=X-Forwarded-Port
    server.tomcat.protocol-header=X-Forwarded-Proto
    server.tomcat.protocol-header-https-value=https
    server.tomcat.remote-ip-header=X-FORWARDED-FOR
    server.tomcat.uri-encoding=UTF-8
    
    spring.http.encoding.charset=UTF-8
    spring.http.encoding.enabled=true
    spring.http.encoding.force=true
    
    ##
    # CAS Cloud Bus Configuration
    #
    spring.cloud.bus.enabled=false
    # spring.cloud.bus.refresh.enabled=true
    # spring.cloud.bus.env.enabled=true
    # spring.cloud.bus.destination=CasCloudBus
    # spring.cloud.bus.ack.enabled=true
    
    endpoints.enabled=false
    endpoints.sensitive=true
    
    endpoints.restart.enabled=false
    endpoints.shutdown.enabled=false
    
    management.security.enabled=true
    management.security.roles=ACTUATOR,ADMIN
    management.security.sessions=if_required
    management.context-path=/status
    management.add-application-context-header=false
    
    security.basic.authorize-mode=role
    security.basic.enabled=false
    security.basic.path=/cas/status/** ## # CAS Web Application Session Configuration # server.session.timeout=300 server.session.cookie.http-only=true server.session.tracking-modes=COOKIE ## # CAS Thymeleaf View Configuration # spring.thymeleaf.encoding=UTF-8 spring.thymeleaf.cache=true spring.thymeleaf.mode=HTML ## # CAS Log4j Configuration # # logging.config=file:/etc/cas/log4j2.xml server.context-parameters.isLog4jAutoInitializationDisabled=true ## # CAS AspectJ Configuration # spring.aop.auto=true spring.aop.proxy-target-class=true ## # CAS Authentication Credentials # #cas.authn.accept.users=casuser::Mellon # #设置 cas.authn.jdbc.query[0].sql=SELECT * FROM yellowcong_users WHERE user_name = ? #select * from cms_auth_user where user_name=? cas.authn.jdbc.query[0].healthQuery= cas.authn.jdbc.query[0].isolateInternalQueries=false cas.authn.jdbc.query[0].url=jdbc:mysql://127.0.0.1:3306/yellowcong?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=false cas.authn.jdbc.query[0].failFast=true cas.authn.jdbc.query[0].isolationLevelName=ISOLATION_READ_COMMITTED cas.authn.jdbc.query[0].dialect=org.hibernate.dialect.MySQLDialect cas.authn.jdbc.query[0].leakThreshold=10 cas.authn.jdbc.query[0].propagationBehaviorName=PROPAGATION_REQUIRED cas.authn.jdbc.query[0].batchSize=1 cas.authn.jdbc.query[0].user=root #cas.authn.jdbc.query[0].ddlAuto=create-drop cas.authn.jdbc.query[0].maxAgeDays=180 cas.authn.jdbc.query[0].password=root cas.authn.jdbc.query[0].autocommit=false cas.authn.jdbc.query[0].driverClass=com.mysql.jdbc.Driver cas.authn.jdbc.query[0].idleTimeout=5000 # cas.authn.jdbc.query[0].credentialCriteria= # cas.authn.jdbc.query[0].name= # cas.authn.jdbc.query[0].order=0 # cas.authn.jdbc.query[0].dataSourceName= # cas.authn.jdbc.query[0].dataSourceProxy=false #密码字段的信息 cas.authn.jdbc.query[0].fieldPassword=PASSWORD #加密策略 cas.authn.jdbc.query[0].passwordEncoder.type=NONE

## 实现效果 ##

下面的效果中，可以看到，我使用了数据库中的yellowcong,账户登录后，我退出了这个用户，然后在数据库中，添加了yellowlu用户，然后用yellowlu的这个用户登录成功。

![这里写图片描述][SouthEast]

## 常见问题 ##

### jar包导入问题 ###

这个问题可能是由于国内网络的问题导致的，所以解决的方案有两种：  
1、可以使用阿里云镜像仓库  
2、可以在cas的管网下载需要好的jar或war包后，导入到本地的maven仓库中。

[SouthEast]: /images/20220529/283504f8a71844029b0c239ccd96337b.png