CAS 5.1.x 的搭建和使用（二）—— 通過Overlay搭建服務端-其它配置說明

原文地址：http://www.cnblogs.com/flying607/p/7600947.html

這節主要解釋一下上一節剩餘的一些配置是做什麼的，爲了閱讀方便直接在配置文件中寫，四組分隔線中的內容就是

#STEP 3 在TOMCAT8.5中跑一個模板然後將其war包中解壓出來的的application.properties複製出來，放到手動創建的src下的resources裏面

##
# CAS Server Context Configuration
#
server.context-path=/cas
server.port=8443

#STEP 5添加認證服務

①——————————————————————————————————————————分割線—————————————————START—————————————————————————————————————————————————
cas.serviceRegistry.initFromJson=true

這個配置可以從

https://apereo.github.io/cas/5.1.x/installation/Configuration-Properties.html#service-registry

以及

https://apereo.github.io/cas/5.1.x/installation/JSON-Service-Management.html

讀到。

如果不想讀可以參考一下我的理解：

加了這個之後就可以通過

這些放在services目錄的json文件來註冊服務了，
先說一下這裏的“服務”
其實指的就是客戶端，更準確的說就是它的url，如果一個客戶端沒有註冊到CAS的服務列表，
那麼你通過客戶端跳轉到CAS，CAS會拒絕這個跳轉。

war包解壓出來的services裏已經有了兩個json文件，其中HTTPSandIMAPS-100xxxxxx.json中有一段：

"serviceId" : "^(https|imaps|http)://.*",

後邊這部分是個正則表達式，爲了支持http協議的客戶端，我在裏面加了個http，代表所有URL符合這個正則表達式的服務都會被當成已經註冊的服務
①——————————————————————————————————————————分割線———————————————————END———————————————————————————————————————————————

#STEP 4簽發證書，如果是用spring boot之類嵌入式的容器，則需要改這裏的配置，如果是直接部在tomcat中，則需要把tomcat改成https的
#server.ssl.key-store=file:/etc/cas/thekeystore
#server.ssl.key-store-password=changeit
#server.ssl.key-password=changeit
# server.ssl.ciphers=
# server.ssl.client-auth=
# server.ssl.enabled=
# server.ssl.key-alias=
# server.ssl.key-store-provider=
# server.ssl.key-store-type=
# server.ssl.protocol=
# server.ssl.trust-store=
# server.ssl.trust-store-password=
# server.ssl.trust-store-provider=
# server.ssl.trust-store-type=

#server.max-http-header-size=2097152
#server.use-forward-headers=true
#server.connection-timeout=20000
#server.error.include-stacktrace=NEVER

#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

②——————————————————————————————————————————分割線—————————————————START—————————————————————————————————————————————————

spring.thymeleaf.cache=false

這個配置沒有在官網找到說明，是自己摸索出來的，服務端的HTML頁面使用的是thymeleaf編寫（http://www.ultraq.net.nz/thymeleaf/layout）

thymeleaf默認會在啓動的時候就把頁面的靜態內容給放到緩存裏，這給我修改CAS默認登錄頁帶來了很大的麻煩，每次修改一點點頁面內容，刷新是看不到效果的，只得重啓服務，爲了方便開發，

我把這個配置設成false，就是說不要緩存。

如果你也想修改登錄頁這裏給出幾個建議：
1、如果不懂thyeleaf先簡單瞭解一下thymeleaf官網的demo寫法；
2、登錄頁的模板是layout.html，其中有幾個js是從谷歌CDN上下載的，而谷歌我們國內又訪問不了，
這就會導致登錄頁加載非常慢，建議先把這幾個js本地化；
3、登錄頁主要是casLoginView.html和fragments目錄下的loginform.html；
4、layout.html引入了好幾個類似logo.html，footer.html的頁面，這幾個頁面看名字就知道幹什麼的，建議對他們進行修改，改成自己的

②——————————————————————————————————————————分割線—————————————————END—————————————————————————————————————————————————

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
#
#STEP4 註釋掉寫死的用戶 改用jdbc的用戶 START
#cas.authn.accept.users=casuser::Mellon

cas.authn.jdbc.query[0].sql=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/CASTEST?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=123456
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].fieldExpired=
# cas.authn.jdbc.query[0].fieldDisabled=
# cas.authn.jdbc.query[0].principalAttributeList=sn,cn:commonName,givenName

#cas.authn.jdbc.query[0].passwordEncoder.type=DEFAULT

③——————————————————————————————————————————分割線—————————————————START—————————————————————————————————————————————————

#cas.authn.jdbc.query[0].passwordEncoder.type=com.example.CustomPasswordEncoder

#cas.authn.jdbc.query[0].passwordEncoder.characterEncoding=UTF-8

#cas.authn.jdbc.query[0].passwordEncoder.encodingAlgorithm=MD5

#cas.authn.jdbc.query[0].passwordEncoder.secret=
#cas.authn.jdbc.query[0].passwordEncoder.strength=16

這一段可以指定密碼的驗證方式，如果什麼都不做，那麼傳入的密碼什麼樣，數據庫中保存的密碼就得是什麼樣，如果加密方式比較簡單就是MD5之類的，可以直接用上邊的encodingAlgorithm
後邊直接寫個MD5完事。
如果加密方式比較複雜則可以自己實現加密方法，通過實現spring的PasswordEncoder，示例如下，對應上邊type後邊配置的內容

 

③——————————————————————————————————————————分割線—————————————————END—————————————————————————————————————————————————

# cas.authn.jdbc.query[0].principalTransformation.suffix=
# cas.authn.jdbc.query[0].principalTransformation.caseConversion=NONE|UPPERCASE|LOWERCASE
# cas.authn.jdbc.query[0].principalTransformation.prefix=
# STEP4 END


##
# CAS Delegated Authentication
#
#cas.authn.pac4j.bitbucket.clientName=Bitbucket
#cas.authn.pac4j.dropbox.clientName=Dropbox
#cas.authn.pac4j.facebook.clientName=Facebook
#cas.authn.pac4j.foursquare.clientName=Foursquare
#cas.authn.pac4j.github.clientName=Github
#cas.authn.pac4j.google.clientName=Google
#cas.authn.pac4j.linkedIn.clientName=LinkedIn
#cas.authn.pac4j.paypal.clientName=PayPal
#cas.authn.pac4j.twitter.clientName=Twitter
#cas.authn.pac4j.yahoo.clientName=Yahoo
#cas.authn.pac4j.windowsLive.clientName=Windows Live
#cas.authn.pac4j.wordpress.clientName=WordPress

④——————————————————————————————————————————分割線—————————————————START—————————————————————————————————————————————————

#多屬性
cas.authn.attributeRepository.jdbc[0].singleRow=true
cas.authn.attributeRepository.jdbc[0].order=0
cas.authn.attributeRepository.jdbc[0].url=jdbc:mysql://127.0.0.1:3306/CASTEST?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&useSSL=false
cas.authn.attributeRepository.jdbc[0].username=user_name
cas.authn.attributeRepository.jdbc[0].user=root
cas.authn.attributeRepository.jdbc[0].password=123456
cas.authn.attributeRepository.jdbc[0].sql=select * from cms_auth_user where {0}
cas.authn.attributeRepository.jdbc[0].dialect=org.hibernate.dialect.MySQLDialect
cas.authn.attributeRepository.jdbc[0].ddlAuto=none
cas.authn.attributeRepository.jdbc[0].driverClass=com.mysql.jdbc.Driver
cas.authn.attributeRepository.jdbc[0].leakThreshold=10
cas.authn.attributeRepository.jdbc[0].propagationBehaviorName=PROPAGATION_REQUIRED
cas.authn.attributeRepository.jdbc[0].batchSize=1
cas.authn.attributeRepository.jdbc[0].healthQuery=SELECT 1
cas.authn.attributeRepository.jdbc[0].failFast=true

CAS默認返回給客戶端的只有用戶ID，如果想返回更多的內容就要加上這段內容了，上面這個配置會返回cms_auth_user表下的所有字段。
如何獲取這些字段可以在客戶端通過以下代碼：

　　　　AttributePrincipal principal = (AttributePrincipal) request.getUserPrincipal();

　　　　final Map attributes = principal.getAttributes();

更詳細的內容在客戶端章節會給出