From 4d259c0058fddd6c5f3a93aaeb10a142ccdbd682 Mon Sep 17 00:00:00 2001 From: MaxKey Date: Wed, 8 Mar 2023 14:15:44 +0800 Subject: [PATCH] cas springboot demo --- .gitignore | 2 + integrations/cas-springboot-demo/LICENSE | 201 ++++++++++++++++++ integrations/cas-springboot-demo/README.md | 74 +++++++ integrations/cas-springboot-demo/pom.xml | 61 ++++++ .../cas/demo/CasClientDemoApplication.java | 15 ++ .../cas/demo/contorller/TestController.java | 61 ++++++ .../src/main/resources/application.yaml | 11 + 7 files changed, 425 insertions(+) create mode 100644 integrations/cas-springboot-demo/LICENSE create mode 100644 integrations/cas-springboot-demo/README.md create mode 100644 integrations/cas-springboot-demo/pom.xml create mode 100644 integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/CasClientDemoApplication.java create mode 100644 integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/contorller/TestController.java create mode 100644 integrations/cas-springboot-demo/src/main/resources/application.yaml diff --git a/.gitignore b/.gitignore index 91ec68600..e61e2ddf0 100644 --- a/.gitignore +++ b/.gitignore @@ -38,6 +38,8 @@ setEnvVars.bat */META-INF/MANIFEST.MF **/.gitignore +**/target/* + /.gradle/ /.gradle/* .vscode/settings.json diff --git a/integrations/cas-springboot-demo/LICENSE b/integrations/cas-springboot-demo/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/integrations/cas-springboot-demo/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/integrations/cas-springboot-demo/README.md b/integrations/cas-springboot-demo/README.md new file mode 100644 index 000000000..c653593be --- /dev/null +++ b/integrations/cas-springboot-demo/README.md @@ -0,0 +1,74 @@ +# cas-client-boot-demo使用 + +源代码地址 https://gitee.com/dromara/MaxKey/tree/main/integrations/cas-springboot-demo + +感谢 xiazhenyou 提供Demo。 + +# cas-client-boot-demo +基于spring boot配置cas客户端 +demo分别写了三个请求:拦截请求 test1/index,test1/index1 以及不拦截请求test1/index2, +## 第一步，引入cas 客户端所需包 + + net.unicon.cas + cas-client-autoconfig-support + 2.3.0-GA + +## 第二部，配置spring boot 配置文件 +``` +server: + port: 8989 +cas: + # cas服务端地址 + server-url-prefix: http://sso.maxkey.top/sign/authz/cas/ + # cas服务端登陆地址 + server-login-url: http://sso.maxkey.top/sign/authz/cas/login + # 客户端访问地址 + client-host-url: http://localhost:8989/ + # 认证方式，默认cas + validation-type: cas + # 客户端需要拦截的URL地址 + authentication-url-patterns: + - /test1/index + - /test1/index1 +``` +扩展配置项 +```` +cas.authentication-url-patterns +cas.validation-url-patterns +cas.request-wrapper-url-patterns +cas.assertion-thread-local-url-patterns +cas.gateway +cas.use-session +cas.redirect-after-validation +cas.allowed-proxy-chains +cas.proxy-callback-url +cas.proxy-receptor-url +cas.accept-any-proxy +server.context-parameters.renew +```` +## 第三部 在application启动类上加上 @EnableCasClient 注解 +```java +@SpringBootApplication +@EnableCasClient +public class CasClientDemoApplication { + + public static void main(String[] args) { + SpringApplication.run(DemoApplication.class, args); + } + +} +``` +## 第四步 在代码中获取登录用户信息 +``` java + @GetMapping("test1/index1") + public String index1(HttpServletRequest request){ + String token =request.getParameter("token"); + System.out.println("token : "+token); + Assertion assertion = (Assertion) request.getSession().getAttribute(AbstractCasFilter.CONST_CAS_ASSERTION); + + String username= assertion.getPrincipal().getName(); + System.out.println(username); + + return "test index cas拦截正常,登录账号:"+username; + } +``` diff --git a/integrations/cas-springboot-demo/pom.xml b/integrations/cas-springboot-demo/pom.xml new file mode 100644 index 000000000..8b8d6117e --- /dev/null +++ b/integrations/cas-springboot-demo/pom.xml @@ -0,0 +1,61 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 2.3.1.RELEASE + + + net.maxsso + cas-springboot-demo + 1.0 + cas-springboot-demo + CAS Client Demo project for Spring Boot + + + 1.8 + + + + + org.springframework.boot + spring-boot-starter-web + + + + + + + + + + net.unicon.cas + cas-client-autoconfig-support + 2.3.0-GA + + + + org.springframework.boot + spring-boot-starter-test + test + + + org.junit.vintage + junit-vintage-engine + + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/CasClientDemoApplication.java b/integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/CasClientDemoApplication.java new file mode 100644 index 000000000..1140300b8 --- /dev/null +++ b/integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/CasClientDemoApplication.java @@ -0,0 +1,15 @@ +package net.maxsso.cas.demo; + +import net.unicon.cas.client.configuration.EnableCasClient; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +@EnableCasClient +public class CasClientDemoApplication { + + public static void main(String[] args) { + SpringApplication.run(CasClientDemoApplication.class, args); + } + +} diff --git a/integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/contorller/TestController.java b/integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/contorller/TestController.java new file mode 100644 index 000000000..6e59c6bcc --- /dev/null +++ b/integrations/cas-springboot-demo/src/main/java/net/maxsso/cas/demo/contorller/TestController.java @@ -0,0 +1,61 @@ +package net.maxsso.cas.demo.contorller; + +import org.jasig.cas.client.util.AbstractCasFilter; +import org.jasig.cas.client.validation.Assertion; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +import javax.servlet.http.HttpServletRequest; + +/** + * @ClassName TestController + * @Description 测试 + * @menu 测试 + * @Author xiazhenyou + * @Date 2020/7/22 9:45 + * @Version 1.0 + **/ +@RestController +public class TestController { + + @GetMapping("test1/index") + public String index(HttpServletRequest request){ + String token =request.getParameter("token"); + System.out.println("token : "+token); + Assertion assertion = (Assertion) request.getSession().getAttribute(AbstractCasFilter.CONST_CAS_ASSERTION); + + String username= assertion.getPrincipal().getName(); + System.out.println(username); + + return "test1 index cas拦截正常,登录账号:"+username; + } + + @GetMapping("test1/index1") + public String index1(HttpServletRequest request){ + String token =request.getParameter("token"); + System.out.println("token : "+token); + Assertion assertion = (Assertion) request.getSession().getAttribute(AbstractCasFilter.CONST_CAS_ASSERTION); + + String username= assertion.getPrincipal().getName(); + System.out.println(username); + + return "test index cas拦截正常,登录账号:"+username; + } + + /** + * 不走cas认证，无法获取登录信息 + * @param request + * @return + */ + @GetMapping("test1/index2") + public String index2(HttpServletRequest request){ +// String token =request.getParameter("token"); +// System.out.println("token : "+token); +// Assertion assertion = (Assertion) request.getSession().getAttribute(AbstractCasFilter.CONST_CAS_ASSERTION); +// +// String username= assertion.getPrincipal().getName(); +// System.out.println(username); + + return "cas 未拦截"; + } +} diff --git a/integrations/cas-springboot-demo/src/main/resources/application.yaml b/integrations/cas-springboot-demo/src/main/resources/application.yaml new file mode 100644 index 000000000..361060adc --- /dev/null +++ b/integrations/cas-springboot-demo/src/main/resources/application.yaml @@ -0,0 +1,11 @@ +server: + port: 8989 +cas: + server-url-prefix: http://sso.maxkey.top/sign/authz/cas/ + server-login-url: http://sso.maxkey.top/sign/authz/cas/login + client-host-url: http://127.0.0.1:8989/ + validation-type: cas +# 拦截的URL地址 + authentication-url-patterns: + - /test1/index + - /test1/index1 \ No newline at end of file