├── .github └── workflows │ └── ci.yml ├── .gitignore ├── LICENSE ├── NOTICE ├── README.md ├── jakartaee-pac4j ├── pom.xml └── src │ └── main │ └── java │ └── org │ └── pac4j │ └── jee │ ├── filter │ ├── CallbackFilter.java │ ├── LogoutFilter.java │ └── SecurityFilter.java │ └── util │ ├── FilterHelper.java │ ├── HttpServletResponseProducer.java │ ├── Pac4JHttpServletRequestWrapper.java │ └── Pac4jProducer.java ├── javaee-pac4j ├── pom.xml └── src │ └── main │ └── java │ └── org │ └── pac4j │ └── jee │ ├── filter │ ├── CallbackFilter.java │ ├── LogoutFilter.java │ └── SecurityFilter.java │ └── util │ ├── FilterHelper.java │ ├── HttpServletResponseProducer.java │ ├── Pac4JHttpServletRequestWrapper.java │ └── Pac4jProducer.java ├── lombok.config ├── pom.xml ├── renovate.json └── spotbugs-exclude.xml /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Java CI 2 | 3 | env: 4 | JDK_CURRENT: 17 5 | DISTRIBUTION: zulu 6 | 7 | on: 8 | push: 9 | branches: 10 | - master 11 | pull_request: 12 | branches: 13 | - master 14 | 15 | permissions: 16 | contents: read 17 | 18 | jobs: 19 | build: 20 | runs-on: ubuntu-latest 21 | steps: 22 | - uses: actions/checkout@v4 23 | - name: Set up JDK 24 | uses: actions/setup-java@v4 25 | with: 26 | java-version: ${{ env.JDK_CURRENT }} 27 | distribution: ${{ env.DISTRIBUTION }} 28 | - name: Cache Maven dependencies 29 | uses: actions/cache@v4 30 | with: 31 | path: ~/.m2 32 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} 33 | restore-keys: ${{ runner.os }}-m2 34 | - name: Build with Maven 35 | run: mvn -B clean install 36 | 37 | deploy: 38 | if: startsWith(github.ref, 'refs/heads/') 39 | runs-on: ubuntu-latest 40 | needs: [build] 41 | steps: 42 | - uses: actions/checkout@v4 43 | - name: Set up JDK 44 | uses: actions/setup-java@v4 45 | with: 46 | java-version: ${{ env.JDK_CURRENT }} 47 | distribution: ${{ env.DISTRIBUTION }} 48 | server-id: central-portal-snapshots 49 | server-username: MAVEN_USERNAME 50 | server-password: MAVEN_PASSWORD 51 | - name: Deploy to Sonatype 52 | run: mvn -B -DskipTests deploy 53 | env: 54 | MAVEN_USERNAME: ${{ secrets.SONATYPE_USER }} 55 | MAVEN_PASSWORD: ${{ secrets.SONATYPE_PWD }} 56 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .classpath 2 | .project 3 | .settings/ 4 | target/ 5 | test-output/ 6 | bin/ 7 | .idea 8 | *.iml 9 | .pmd 10 | .pmdruleset.xml 11 | .DS_Store -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | j2e-pac4j 2 | Copyright 2013 - 2016 pac4j organization 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this software except in compliance with the License. 6 | You may obtain a copy of the License at: 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 |

4 | 5 | The `jee-pac4j` project is an **easy and powerful security library for JEE web applications and web services** which supports authentication and authorization, but also logout and advanced features like session fixation and CSRF protection. 6 | It's based on the **[pac4j security engine](https://github.com/pac4j/pac4j)**. It's available under the Apache 2 license. 7 | 8 | | jee-pac4j | Module for JavaEE webapp | Module for JakartaEE webapp | JDK | pac4j | Usage of Lombok | Status | 9 | |--------------|--------------------------|-----------------------------|-----|-------|-----------------|------------------| 10 | | version >= 8 | javaee-pac4j | jakartaee-pac4j | 17 | v6 | Yes | Production ready | 11 | | version >= 7 | javaee-pac4j | jakartaee-pac4j | 11 | v5 | No | Production ready | 12 | | version >= 6 | jee-pac4j | | 11 | v5 | No | Production ready | 13 | | version >= 5 | jee-pac4j | | 8 | v4 | No | Production ready | 14 | 15 | [**Main concepts and components:**](https://www.pac4j.org/docs/main-concepts-and-components.html) 16 | 17 | 1) A [**client**](https://www.pac4j.org/docs/clients.html) represents an authentication mechanism. It performs the login process and returns a user profile. An indirect client is for web applications authentication while a direct client is for web services authentication: 18 | 19 | ▸ OAuth - SAML - CAS - OpenID Connect - HTTP - Google App Engine - Kerberos - LDAP - SQL - JWT - MongoDB - CouchDB - IP address - REST API 20 | 21 | 2) An [**authorizer**](https://www.pac4j.org/docs/authorizers.html) is meant to check authorizations on the authenticated user profile(s) or on the current web context: 22 | 23 | ▸ Roles - Anonymous / remember-me / (fully) authenticated - Profile type, attribute - CORS - CSRF - Security headers - IP address, HTTP method 24 | 25 | 3) A [**matcher**](https://www.pac4j.org/docs/matchers.html) defines whether the `SecurityFilter` must be applied and can be used for additional web processing 26 | 27 | 4) The `SecurityFilter` protects an url by checking that the user is authenticated and that the authorizations are valid, according to the clients and authorizers configuration. If the user is not authenticated, it performs authentication for direct clients or starts the login process for indirect clients 28 | 29 | 5) The `CallbackFilter` finishes the login process for an indirect client 30 | 31 | 6) The `LogoutFilter` logs out the user from the application and triggers the logout at the identity provider level 32 | 33 | 7) The `JEEContext` and the `ProfileManager` components can be injected 34 | 35 | 8) The `FilterHelper` handles the filters and their related mappings. 36 | 37 | 38 | ## Usage 39 | 40 | ### 1) [Add the required dependencies](https://github.com/pac4j/jee-pac4j/wiki/Dependencies) 41 | 42 | ### 2) Define: 43 | 44 | ### - the [security configuration](https://github.com/pac4j/jee-pac4j/wiki/Security-configuration) 45 | ### - the [callback configuration](https://github.com/pac4j/jee-pac4j/wiki/Callback-configuration), only for web applications 46 | ### - the [logout configuration](https://github.com/pac4j/jee-pac4j/wiki/Logout-configuration) 47 | 48 | ### 3) [Apply security](https://github.com/pac4j/jee-pac4j/wiki/Apply-security) 49 | 50 | ### 4) [Get the authenticated user profiles](https://github.com/pac4j/jee-pac4j/wiki/Get-the-authenticated-user-profiles) 51 | 52 | 53 | ## Demos 54 | 55 | Two demo webapps: [jee-pac4j-demo](https://github.com/pac4j/jee-pac4j-demo) (a simple JSP/servlets demo) and [jee-pac4j-cdi-demo](https://github.com/pac4j/jee-pac4j-cdi-demo) (a more advanced demo using JSF and CDI) are available for tests and implements many authentication mechanisms: Facebook, Twitter, form, basic auth, CAS, SAML, OpenID Connect, JWT... 56 | 57 | 58 | ## Versions 59 | 60 | The latest released version is the [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.pac4j/jee-pac4j/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/org.pac4j/jee-pac4j), available in the [Maven central repository](https://repo.maven.apache.org/maven2). 61 | The [next version](https://github.com/pac4j/jee-pac4j/wiki/Next-version) is under development. 62 | 63 | See the [release notes](https://github.com/pac4j/jee-pac4j/wiki/Release-Notes). Learn more by browsing the [pac4j documentation](https://www.javadoc.io/doc/org.pac4j/pac4j-core/6.0.1/index.html) and the [jee-pac4j Javadoc](http://www.javadoc.io/doc/org.pac4j/javaee-pac4j/8.0.0). 64 | 65 | See the [migration guide](https://github.com/pac4j/jee-pac4j/wiki/Migration-guide) as well. 66 | 67 | 68 | ## Need help? 69 | 70 | You can use the [mailing lists](https://www.pac4j.org/mailing-lists.html) or the [commercial support](https://www.pac4j.org/commercial-support.html). 71 | -------------------------------------------------------------------------------- /jakartaee-pac4j/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | org.pac4j 7 | jee-pac4j-parent 8 | 8.0.2-SNAPSHOT 9 | 10 | 11 | org.pac4j 12 | jakartaee-pac4j 13 | jar 14 | pac4j implementation for JakartaEE 15 | Security library for JakartaEE based on pac4j 16 | 17 | 18 | 19 | org.pac4j 20 | pac4j-jakartaee 21 | ${pac4j.version} 22 | 23 | 24 | jakarta.platform 25 | jakarta.jakartaee-web-api 26 | 9.1.0 27 | provided 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/filter/CallbackFilter.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.filter; 2 | 3 | import jakarta.servlet.FilterChain; 4 | import jakarta.servlet.FilterConfig; 5 | import jakarta.servlet.ServletException; 6 | import jakarta.servlet.http.HttpServletRequest; 7 | import jakarta.servlet.http.HttpServletResponse; 8 | import lombok.Getter; 9 | import lombok.Setter; 10 | import lombok.val; 11 | import org.pac4j.core.adapter.FrameworkAdapter; 12 | import org.pac4j.core.config.Config; 13 | import org.pac4j.core.util.Pac4jConstants; 14 | import org.pac4j.jee.config.AbstractConfigFilter; 15 | import org.pac4j.jee.context.JEEFrameworkParameters; 16 | 17 | import java.io.IOException; 18 | 19 | /** 20 | *

This filter finishes the login process for an indirect client.

21 | * 22 | * @author Jerome Leleu 23 | * @since 1.0.0 24 | */ 25 | @Getter 26 | @Setter 27 | public class CallbackFilter extends AbstractConfigFilter { 28 | 29 | private String defaultUrl; 30 | 31 | private Boolean renewSession; 32 | 33 | private String defaultClient; 34 | 35 | public CallbackFilter() {} 36 | 37 | public CallbackFilter(final Config config) { 38 | setConfig(config); 39 | } 40 | 41 | public CallbackFilter(final Config config, final String defaultUrl) { 42 | this(config); 43 | this.defaultUrl = defaultUrl; 44 | } 45 | 46 | @Override 47 | public void init(final FilterConfig filterConfig) throws ServletException { 48 | super.init(filterConfig); 49 | 50 | this.defaultUrl = getStringParam(filterConfig, Pac4jConstants.DEFAULT_URL, this.defaultUrl); 51 | this.renewSession = getBooleanParam(filterConfig, Pac4jConstants.RENEW_SESSION, this.renewSession); 52 | this.defaultClient = getStringParam(filterConfig, Pac4jConstants.DEFAULT_CLIENT, this.defaultClient); 53 | } 54 | 55 | @Override 56 | protected void internalFilter(final HttpServletRequest request, final HttpServletResponse response, 57 | final FilterChain chain) throws IOException, ServletException { 58 | 59 | val config = getSharedConfig(); 60 | 61 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 62 | 63 | config.getCallbackLogic().perform(config, defaultUrl, renewSession, defaultClient, new JEEFrameworkParameters(request, response)); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/filter/LogoutFilter.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.filter; 2 | 3 | import jakarta.servlet.FilterChain; 4 | import jakarta.servlet.FilterConfig; 5 | import jakarta.servlet.ServletException; 6 | import jakarta.servlet.http.HttpServletRequest; 7 | import jakarta.servlet.http.HttpServletResponse; 8 | import lombok.Getter; 9 | import lombok.Setter; 10 | import lombok.val; 11 | import org.pac4j.core.adapter.FrameworkAdapter; 12 | import org.pac4j.core.config.Config; 13 | import org.pac4j.core.util.Pac4jConstants; 14 | import org.pac4j.jee.config.AbstractConfigFilter; 15 | import org.pac4j.jee.context.JEEFrameworkParameters; 16 | 17 | import java.io.IOException; 18 | 19 | /** 20 | *

This filter handles the (application + identity provider) logout process.

21 | * 22 | * @author Jerome Leleu 23 | * @since 1.2.0 24 | */ 25 | @Getter 26 | @Setter 27 | public class LogoutFilter extends AbstractConfigFilter { 28 | 29 | private String defaultUrl; 30 | 31 | private String logoutUrlPattern; 32 | 33 | private Boolean localLogout; 34 | 35 | private Boolean destroySession; 36 | 37 | private Boolean centralLogout; 38 | 39 | public LogoutFilter() {} 40 | 41 | public LogoutFilter(final Config config) { 42 | setConfig(config); 43 | } 44 | 45 | public LogoutFilter(final Config config, final String defaultUrl) { 46 | this(config); 47 | this.defaultUrl = defaultUrl; 48 | } 49 | 50 | @Override 51 | public void init(final FilterConfig filterConfig) throws ServletException { 52 | super.init(filterConfig); 53 | 54 | this.defaultUrl = getStringParam(filterConfig, Pac4jConstants.DEFAULT_URL, this.defaultUrl); 55 | this.logoutUrlPattern = getStringParam(filterConfig, Pac4jConstants.LOGOUT_URL_PATTERN, this.logoutUrlPattern); 56 | this.localLogout = getBooleanParam(filterConfig, Pac4jConstants.LOCAL_LOGOUT, this.localLogout); 57 | this.destroySession = getBooleanParam(filterConfig, Pac4jConstants.DESTROY_SESSION, this.destroySession); 58 | this.centralLogout = getBooleanParam(filterConfig, Pac4jConstants.CENTRAL_LOGOUT, this.centralLogout); 59 | } 60 | 61 | @Override 62 | protected void internalFilter(final HttpServletRequest request, final HttpServletResponse response, 63 | final FilterChain chain) throws IOException, ServletException { 64 | 65 | val config = getSharedConfig(); 66 | 67 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 68 | 69 | config.getLogoutLogic().perform(config, defaultUrl, logoutUrlPattern, localLogout, destroySession, centralLogout, new JEEFrameworkParameters(request, response)); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/filter/SecurityFilter.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.filter; 2 | 3 | import jakarta.servlet.FilterChain; 4 | import jakarta.servlet.FilterConfig; 5 | import jakarta.servlet.ServletException; 6 | import jakarta.servlet.http.HttpServletRequest; 7 | import jakarta.servlet.http.HttpServletResponse; 8 | import lombok.Getter; 9 | import lombok.Setter; 10 | import lombok.val; 11 | import org.pac4j.core.adapter.FrameworkAdapter; 12 | import org.pac4j.core.config.Config; 13 | import org.pac4j.core.util.Pac4jConstants; 14 | import org.pac4j.core.util.security.SecurityEndpoint; 15 | import org.pac4j.core.util.security.SecurityEndpointBuilder; 16 | import org.pac4j.jee.config.AbstractConfigFilter; 17 | import org.pac4j.jee.context.JEEFrameworkParameters; 18 | import org.pac4j.jee.util.Pac4JHttpServletRequestWrapper; 19 | 20 | import java.io.IOException; 21 | 22 | /** 23 | *

This filter protects an URL.

24 | * 25 | * @author Jerome Leleu, Michael Remond 26 | * @since 1.0.0 27 | */ 28 | @Getter 29 | @Setter 30 | public class SecurityFilter extends AbstractConfigFilter implements SecurityEndpoint { 31 | 32 | private String clients; 33 | 34 | private String authorizers; 35 | 36 | private String matchers; 37 | 38 | public SecurityFilter() {} 39 | 40 | public SecurityFilter(final Config config) { 41 | setConfig(config); 42 | } 43 | 44 | public SecurityFilter(final Config config, final String clients) { 45 | this(config); 46 | this.clients = clients; 47 | } 48 | 49 | public SecurityFilter(final Config config, final String clients, final String authorizers) { 50 | this(config, clients); 51 | this.authorizers = authorizers; 52 | } 53 | 54 | public SecurityFilter(final Config config, final String clients, final String authorizers, final String matchers) { 55 | this(config, clients, authorizers); 56 | this.matchers = matchers; 57 | } 58 | 59 | public static SecurityFilter build(final Object... parameters) { 60 | final SecurityFilter securityFilter = new SecurityFilter(); 61 | SecurityEndpointBuilder.buildConfig(securityFilter, parameters); 62 | return securityFilter; 63 | } 64 | 65 | @Override 66 | public void init(final FilterConfig filterConfig) throws ServletException { 67 | super.init(filterConfig); 68 | 69 | this.clients = getStringParam(filterConfig, Pac4jConstants.CLIENTS, this.clients); 70 | this.authorizers = getStringParam(filterConfig, Pac4jConstants.AUTHORIZERS, this.authorizers); 71 | this.matchers = getStringParam(filterConfig, Pac4jConstants.MATCHERS, this.matchers); 72 | } 73 | 74 | @Override 75 | protected final void internalFilter(final HttpServletRequest request, final HttpServletResponse response, 76 | final FilterChain filterChain) throws IOException, ServletException { 77 | 78 | val config = getSharedConfig(); 79 | 80 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 81 | 82 | config.getSecurityLogic().perform(config, (ctx, session, profiles) -> { 83 | // if no profiles are loaded, pac4j is not concerned with this request 84 | filterChain.doFilter(profiles.isEmpty() ? request : new Pac4JHttpServletRequestWrapper(request, profiles), response); 85 | return null; 86 | }, clients, authorizers, matchers, new JEEFrameworkParameters(request, response)); 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/util/FilterHelper.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import jakarta.servlet.DispatcherType; 4 | import jakarta.servlet.Filter; 5 | import jakarta.servlet.FilterRegistration; 6 | import jakarta.servlet.ServletContext; 7 | import org.pac4j.core.exception.TechnicalException; 8 | 9 | import java.util.ArrayList; 10 | import java.util.EnumSet; 11 | import java.util.List; 12 | 13 | import static org.pac4j.core.util.CommonHelper.*; 14 | 15 | /** 16 | * Helper to define filter mappings. 17 | * 18 | * @author Jerome Leleu 19 | * @since 3.0.0 20 | */ 21 | public class FilterHelper { 22 | 23 | private final ServletContext servletContext; 24 | 25 | public FilterHelper(final ServletContext servletContext) { 26 | this.servletContext = servletContext; 27 | } 28 | 29 | /** 30 | * Add a filter mapping. 31 | * 32 | * @param name the name fo the filter 33 | * @param filter the filter 34 | * @param parameters the URLs on which it applies and the supported dispatcher types 35 | */ 36 | public void addFilterMapping(final String name, final Filter filter, final Object... parameters) { 37 | assertNotBlank("name", name); 38 | assertNotNull("filter", filter); 39 | assertNotNull("parameters", parameters); 40 | 41 | final List urls = new ArrayList<>(); 42 | final List types = new ArrayList<>(); 43 | for (final Object parameter : parameters) { 44 | if (parameter instanceof String) { 45 | urls.add((String) parameter); 46 | } else if (parameter instanceof DispatcherType) { 47 | types.add((DispatcherType) parameter); 48 | } else { 49 | throw new TechnicalException("Unsupported parameter type: " + parameter); 50 | } 51 | } 52 | if (urls.isEmpty()) { 53 | throw new TechnicalException("No URL mapping defined for filter: " + name); 54 | } 55 | if (types.isEmpty()) { 56 | types.add(DispatcherType.REQUEST); 57 | } 58 | 59 | final FilterRegistration.Dynamic registration = servletContext.addFilter(name, filter); 60 | registration.addMappingForUrlPatterns(EnumSet.copyOf(types), true, urls.toArray(new String[urls.size()])); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/util/HttpServletResponseProducer.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import jakarta.enterprise.context.RequestScoped; 4 | import jakarta.enterprise.inject.Produces; 5 | import jakarta.faces.context.FacesContext; 6 | import jakarta.inject.Named; 7 | import jakarta.servlet.http.HttpServletResponse; 8 | import lombok.extern.slf4j.Slf4j; 9 | 10 | /** 11 | * Produces a servlet response object corresponding to the response for the current request. 12 | * 13 | * @author Phillip Ross 14 | * @since 3.0.0 15 | */ 16 | @Named 17 | @RequestScoped 18 | @Slf4j 19 | public class HttpServletResponseProducer { 20 | 21 | /** 22 | * Factory method which produces an http servlet response. 23 | * 24 | * @return the http servlet response associated with the current servlet request 25 | */ 26 | @Produces 27 | HttpServletResponse getHttpServletResponse() { 28 | LOGGER.trace("Producing an http servlet response..."); 29 | HttpServletResponse httpServletResponse = (HttpServletResponse) FacesContext.getCurrentInstance() 30 | .getExternalContext() 31 | .getResponse(); 32 | LOGGER.trace("Returning an http servlet response. (is null: {})", httpServletResponse == null); 33 | return httpServletResponse; 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/util/Pac4JHttpServletRequestWrapper.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import jakarta.servlet.http.HttpServletRequest; 4 | import jakarta.servlet.http.HttpServletRequestWrapper; 5 | import org.pac4j.core.profile.ProfileHelper; 6 | import org.pac4j.core.profile.UserProfile; 7 | 8 | import java.security.Principal; 9 | import java.util.Collection; 10 | import java.util.Optional; 11 | 12 | /** 13 | * This wraps the {@link HttpServletRequest} to make it pac4j-aware by with respect to user-related methods. 14 | * 15 | * @author Victor Noel 16 | * @since 4.0.0 17 | * 18 | */ 19 | public class Pac4JHttpServletRequestWrapper extends HttpServletRequestWrapper { 20 | 21 | private Collection profiles; 22 | 23 | public Pac4JHttpServletRequestWrapper(final HttpServletRequest request, final Collection profiles) { 24 | super(request); 25 | this.profiles = profiles; 26 | } 27 | 28 | @Override 29 | public String getRemoteUser() { 30 | return getPrincipal().map(p -> p.getName()).orElse(null); 31 | } 32 | 33 | private Optional getProfile() { 34 | return ProfileHelper.flatIntoOneProfile(profiles); 35 | } 36 | 37 | private Optional getPrincipal() { 38 | return getProfile().map(UserProfile::asPrincipal); 39 | } 40 | 41 | @Override 42 | public Principal getUserPrincipal() { 43 | return getPrincipal().orElse(null); 44 | } 45 | 46 | @Override 47 | public boolean isUserInRole(String role) { 48 | return this.profiles.stream().anyMatch(p -> p.getRoles().contains(role)); 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /jakartaee-pac4j/src/main/java/org/pac4j/jee/util/Pac4jProducer.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import jakarta.enterprise.context.RequestScoped; 4 | import jakarta.enterprise.inject.Instance; 5 | import jakarta.enterprise.inject.Produces; 6 | import jakarta.inject.Named; 7 | import jakarta.servlet.http.HttpServletRequest; 8 | import jakarta.servlet.http.HttpServletResponse; 9 | import lombok.extern.slf4j.Slf4j; 10 | import lombok.val; 11 | import org.pac4j.core.adapter.FrameworkAdapter; 12 | import org.pac4j.core.config.Config; 13 | import org.pac4j.core.context.WebContext; 14 | import org.pac4j.core.context.session.SessionStore; 15 | import org.pac4j.core.profile.ProfileManager; 16 | import org.pac4j.jee.context.JEEFrameworkParameters; 17 | 18 | /** 19 | * Produces request-scoped web context and profile manager. 20 | * 21 | * @author Phillip Ross 22 | * @since 3.0.0 23 | */ 24 | @Named 25 | @RequestScoped 26 | @Slf4j 27 | public class Pac4jProducer { 28 | 29 | /** 30 | * Factory method which produces a pac4j web context. 31 | * 32 | * @param instanceConfig the configuration 33 | * @param httpServletRequest the HTTP servlet request 34 | * @param httpServletResponse the HTTP servlet response 35 | * @return a web context associated with the current servlet request 36 | */ 37 | @Produces 38 | WebContext getWebContext(final Instance instanceConfig, 39 | final HttpServletRequest httpServletRequest, 40 | final HttpServletResponse httpServletResponse) { 41 | 42 | if (instanceConfig.isResolvable()) { 43 | val config = instanceConfig.get(); 44 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 45 | 46 | LOGGER.trace("Producing a pac4j web context..."); 47 | val webContext = config.getWebContextFactory().newContext(new JEEFrameworkParameters(httpServletRequest, httpServletResponse)); 48 | LOGGER.trace("Returning a pac4j web context."); 49 | return webContext; 50 | } else { 51 | LOGGER.debug("Unable to produce a web context: no Config available"); 52 | } 53 | 54 | return null; 55 | } 56 | 57 | /** 58 | * Factory method which produces a pac4j session store. 59 | * 60 | * @param instanceConfig the configuration 61 | * @param httpServletRequest the HTTP servlet request 62 | * @param httpServletResponse the HTTP servlet response 63 | * @return a session store associated with the current servlet request 64 | */ 65 | @Produces 66 | SessionStore getSessionStore(final Instance instanceConfig, 67 | final HttpServletRequest httpServletRequest, 68 | final HttpServletResponse httpServletResponse) { 69 | 70 | if (instanceConfig.isResolvable()) { 71 | val config = instanceConfig.get(); 72 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 73 | 74 | LOGGER.trace("Producing a pac4j session store..."); 75 | val sessionStore = config.getSessionStoreFactory().newSessionStore(new JEEFrameworkParameters(httpServletRequest, httpServletResponse)); 76 | LOGGER.trace("Returning a pac4j session store."); 77 | return sessionStore; 78 | } else { 79 | LOGGER.debug("Unable to produce a session store: no Config available"); 80 | } 81 | 82 | return null; 83 | } 84 | 85 | /** 86 | * Factory method which produces a pac4j profile manager. 87 | * 88 | * @param instanceConfig the configuration 89 | * @param webContext the web context to be used for building the profile manager 90 | * @param sessionStore the session store to be used for building the profile manager 91 | * @return a profile manager associated with the current servlet request 92 | */ 93 | @Produces 94 | ProfileManager getProfileManager(final Instance instanceConfig, 95 | final WebContext webContext, 96 | final SessionStore sessionStore) { 97 | 98 | if (instanceConfig.isResolvable()) { 99 | val config = instanceConfig.get(); 100 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 101 | 102 | LOGGER.trace("Producing a pac4j profile manager..."); 103 | val profileManager = config.getProfileManagerFactory().apply(webContext, sessionStore); 104 | LOGGER.trace("Returning a pac4j profile manager."); 105 | return profileManager; 106 | } else { 107 | LOGGER.debug("Unable to produce a profile manager: no Config available"); 108 | } 109 | 110 | return null; 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /javaee-pac4j/pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | org.pac4j 7 | jee-pac4j-parent 8 | 8.0.2-SNAPSHOT 9 | 10 | 11 | org.pac4j 12 | javaee-pac4j 13 | jar 14 | pac4j implementation for JavaEE 15 | Security library for JavaEE based on pac4j 16 | 17 | 18 | 19 | org.pac4j 20 | pac4j-javaee 21 | ${pac4j.version} 22 | 23 | 24 | jakarta.platform 25 | jakarta.jakartaee-web-api 26 | 8.0.0 27 | provided 28 | 29 | 30 | 31 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/filter/CallbackFilter.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.filter; 2 | 3 | import lombok.Getter; 4 | import lombok.Setter; 5 | import lombok.val; 6 | import org.pac4j.core.adapter.FrameworkAdapter; 7 | import org.pac4j.core.config.Config; 8 | import org.pac4j.core.util.Pac4jConstants; 9 | import org.pac4j.jee.config.AbstractConfigFilter; 10 | import org.pac4j.jee.context.JEEFrameworkParameters; 11 | 12 | import javax.servlet.FilterChain; 13 | import javax.servlet.FilterConfig; 14 | import javax.servlet.ServletException; 15 | import javax.servlet.http.HttpServletRequest; 16 | import javax.servlet.http.HttpServletResponse; 17 | import java.io.IOException; 18 | 19 | /** 20 | *

This filter finishes the login process for an indirect client.

21 | * 22 | * @author Jerome Leleu 23 | * @since 1.0.0 24 | */ 25 | @Getter 26 | @Setter 27 | public class CallbackFilter extends AbstractConfigFilter { 28 | 29 | private String defaultUrl; 30 | 31 | private Boolean renewSession; 32 | 33 | private String defaultClient; 34 | 35 | public CallbackFilter() {} 36 | 37 | public CallbackFilter(final Config config) { 38 | setConfig(config); 39 | } 40 | 41 | public CallbackFilter(final Config config, final String defaultUrl) { 42 | this(config); 43 | this.defaultUrl = defaultUrl; 44 | } 45 | 46 | @Override 47 | public void init(final FilterConfig filterConfig) throws ServletException { 48 | super.init(filterConfig); 49 | 50 | this.defaultUrl = getStringParam(filterConfig, Pac4jConstants.DEFAULT_URL, this.defaultUrl); 51 | this.renewSession = getBooleanParam(filterConfig, Pac4jConstants.RENEW_SESSION, this.renewSession); 52 | this.defaultClient = getStringParam(filterConfig, Pac4jConstants.DEFAULT_CLIENT, this.defaultClient); 53 | } 54 | 55 | @Override 56 | protected void internalFilter(final HttpServletRequest request, final HttpServletResponse response, 57 | final FilterChain chain) throws IOException, ServletException { 58 | 59 | val config = getSharedConfig(); 60 | 61 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 62 | 63 | config.getCallbackLogic().perform(config, defaultUrl, renewSession, defaultClient, new JEEFrameworkParameters(request, response)); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/filter/LogoutFilter.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.filter; 2 | 3 | import lombok.Getter; 4 | import lombok.Setter; 5 | import lombok.val; 6 | import org.pac4j.core.adapter.FrameworkAdapter; 7 | import org.pac4j.core.config.Config; 8 | import org.pac4j.core.util.Pac4jConstants; 9 | import org.pac4j.jee.config.AbstractConfigFilter; 10 | import org.pac4j.jee.context.JEEFrameworkParameters; 11 | 12 | import javax.servlet.FilterChain; 13 | import javax.servlet.FilterConfig; 14 | import javax.servlet.ServletException; 15 | import javax.servlet.http.HttpServletRequest; 16 | import javax.servlet.http.HttpServletResponse; 17 | import java.io.IOException; 18 | 19 | /** 20 | *

This filter handles the (application + identity provider) logout process.

21 | * 22 | * @author Jerome Leleu 23 | * @since 1.2.0 24 | */ 25 | @Getter 26 | @Setter 27 | public class LogoutFilter extends AbstractConfigFilter { 28 | 29 | private String defaultUrl; 30 | 31 | private String logoutUrlPattern; 32 | 33 | private Boolean localLogout; 34 | 35 | private Boolean destroySession; 36 | 37 | private Boolean centralLogout; 38 | 39 | public LogoutFilter() {} 40 | 41 | public LogoutFilter(final Config config) { 42 | setConfig(config); 43 | } 44 | 45 | public LogoutFilter(final Config config, final String defaultUrl) { 46 | this(config); 47 | this.defaultUrl = defaultUrl; 48 | } 49 | 50 | @Override 51 | public void init(final FilterConfig filterConfig) throws ServletException { 52 | super.init(filterConfig); 53 | 54 | this.defaultUrl = getStringParam(filterConfig, Pac4jConstants.DEFAULT_URL, this.defaultUrl); 55 | this.logoutUrlPattern = getStringParam(filterConfig, Pac4jConstants.LOGOUT_URL_PATTERN, this.logoutUrlPattern); 56 | this.localLogout = getBooleanParam(filterConfig, Pac4jConstants.LOCAL_LOGOUT, this.localLogout); 57 | this.destroySession = getBooleanParam(filterConfig, Pac4jConstants.DESTROY_SESSION, this.destroySession); 58 | this.centralLogout = getBooleanParam(filterConfig, Pac4jConstants.CENTRAL_LOGOUT, this.centralLogout); 59 | } 60 | 61 | @Override 62 | protected void internalFilter(final HttpServletRequest request, final HttpServletResponse response, 63 | final FilterChain chain) throws IOException, ServletException { 64 | 65 | val config = getSharedConfig(); 66 | 67 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 68 | 69 | config.getLogoutLogic().perform(config, defaultUrl, logoutUrlPattern, localLogout, destroySession, centralLogout, new JEEFrameworkParameters(request, response)); 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/filter/SecurityFilter.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.filter; 2 | 3 | import lombok.Getter; 4 | import lombok.Setter; 5 | import lombok.val; 6 | import org.pac4j.core.adapter.FrameworkAdapter; 7 | import org.pac4j.core.config.Config; 8 | import org.pac4j.core.util.Pac4jConstants; 9 | import org.pac4j.core.util.security.SecurityEndpoint; 10 | import org.pac4j.core.util.security.SecurityEndpointBuilder; 11 | import org.pac4j.jee.config.AbstractConfigFilter; 12 | import org.pac4j.jee.context.JEEFrameworkParameters; 13 | import org.pac4j.jee.util.Pac4JHttpServletRequestWrapper; 14 | 15 | import javax.servlet.FilterChain; 16 | import javax.servlet.FilterConfig; 17 | import javax.servlet.ServletException; 18 | import javax.servlet.http.HttpServletRequest; 19 | import javax.servlet.http.HttpServletResponse; 20 | import java.io.IOException; 21 | 22 | /** 23 | *

This filter protects an URL.

24 | * 25 | * @author Jerome Leleu, Michael Remond 26 | * @since 1.0.0 27 | */ 28 | @Getter 29 | @Setter 30 | public class SecurityFilter extends AbstractConfigFilter implements SecurityEndpoint { 31 | 32 | private String clients; 33 | 34 | private String authorizers; 35 | 36 | private String matchers; 37 | 38 | public SecurityFilter() {} 39 | 40 | public SecurityFilter(final Config config) { 41 | setConfig(config); 42 | } 43 | 44 | public SecurityFilter(final Config config, final String clients) { 45 | this(config); 46 | this.clients = clients; 47 | } 48 | 49 | public SecurityFilter(final Config config, final String clients, final String authorizers) { 50 | this(config, clients); 51 | this.authorizers = authorizers; 52 | } 53 | 54 | public SecurityFilter(final Config config, final String clients, final String authorizers, final String matchers) { 55 | this(config, clients, authorizers); 56 | this.matchers = matchers; 57 | } 58 | 59 | public static SecurityFilter build(final Object... parameters) { 60 | final SecurityFilter securityFilter = new SecurityFilter(); 61 | SecurityEndpointBuilder.buildConfig(securityFilter, parameters); 62 | return securityFilter; 63 | } 64 | 65 | @Override 66 | public void init(final FilterConfig filterConfig) throws ServletException { 67 | super.init(filterConfig); 68 | 69 | this.clients = getStringParam(filterConfig, Pac4jConstants.CLIENTS, this.clients); 70 | this.authorizers = getStringParam(filterConfig, Pac4jConstants.AUTHORIZERS, this.authorizers); 71 | this.matchers = getStringParam(filterConfig, Pac4jConstants.MATCHERS, this.matchers); 72 | } 73 | 74 | @Override 75 | protected final void internalFilter(final HttpServletRequest request, final HttpServletResponse response, 76 | final FilterChain filterChain) throws IOException, ServletException { 77 | 78 | val config = getSharedConfig(); 79 | 80 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 81 | 82 | config.getSecurityLogic().perform(config, (ctx, session, profiles) -> { 83 | // if no profiles are loaded, pac4j is not concerned with this request 84 | filterChain.doFilter(profiles.isEmpty() ? request : new Pac4JHttpServletRequestWrapper(request, profiles), response); 85 | return null; 86 | }, clients, authorizers, matchers, new JEEFrameworkParameters(request, response)); 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/util/FilterHelper.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import org.pac4j.core.exception.TechnicalException; 4 | 5 | import javax.servlet.DispatcherType; 6 | import javax.servlet.Filter; 7 | import javax.servlet.FilterRegistration; 8 | import javax.servlet.ServletContext; 9 | import java.util.ArrayList; 10 | import java.util.EnumSet; 11 | import java.util.List; 12 | 13 | import static org.pac4j.core.util.CommonHelper.*; 14 | 15 | /** 16 | * Helper to define filter mappings. 17 | * 18 | * @author Jerome Leleu 19 | * @since 3.0.0 20 | */ 21 | public class FilterHelper { 22 | 23 | private final ServletContext servletContext; 24 | 25 | public FilterHelper(final ServletContext servletContext) { 26 | this.servletContext = servletContext; 27 | } 28 | 29 | /** 30 | * Add a filter mapping. 31 | * 32 | * @param name the name fo the filter 33 | * @param filter the filter 34 | * @param parameters the URLs on which it applies and the supported dispatcher types 35 | */ 36 | public void addFilterMapping(final String name, final Filter filter, final Object... parameters) { 37 | assertNotBlank("name", name); 38 | assertNotNull("filter", filter); 39 | assertNotNull("parameters", parameters); 40 | 41 | final List urls = new ArrayList<>(); 42 | final List types = new ArrayList<>(); 43 | for (final Object parameter : parameters) { 44 | if (parameter instanceof String) { 45 | urls.add((String) parameter); 46 | } else if (parameter instanceof DispatcherType) { 47 | types.add((DispatcherType) parameter); 48 | } else { 49 | throw new TechnicalException("Unsupported parameter type: " + parameter); 50 | } 51 | } 52 | if (urls.isEmpty()) { 53 | throw new TechnicalException("No URL mapping defined for filter: " + name); 54 | } 55 | if (types.isEmpty()) { 56 | types.add(DispatcherType.REQUEST); 57 | } 58 | 59 | final FilterRegistration.Dynamic registration = servletContext.addFilter(name, filter); 60 | registration.addMappingForUrlPatterns(EnumSet.copyOf(types), true, urls.toArray(new String[urls.size()])); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/util/HttpServletResponseProducer.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | 5 | import javax.enterprise.context.RequestScoped; 6 | import javax.enterprise.inject.Produces; 7 | import javax.faces.context.FacesContext; 8 | import javax.inject.Named; 9 | import javax.servlet.http.HttpServletResponse; 10 | 11 | /** 12 | * Produces a servlet response object corresponding to the response for the current request. 13 | * 14 | * @author Phillip Ross 15 | * @since 3.0.0 16 | */ 17 | @Named 18 | @RequestScoped 19 | @Slf4j 20 | public class HttpServletResponseProducer { 21 | 22 | /** 23 | * Factory method which produces an http servlet response. 24 | * 25 | * @return the http servlet response associated with the current servlet request 26 | */ 27 | @Produces 28 | HttpServletResponse getHttpServletResponse() { 29 | LOGGER.trace("Producing an http servlet response..."); 30 | HttpServletResponse httpServletResponse = (HttpServletResponse) FacesContext.getCurrentInstance() 31 | .getExternalContext() 32 | .getResponse(); 33 | LOGGER.trace("Returning an http servlet response. (is null: {})", httpServletResponse == null); 34 | return httpServletResponse; 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/util/Pac4JHttpServletRequestWrapper.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import org.pac4j.core.profile.ProfileHelper; 4 | import org.pac4j.core.profile.UserProfile; 5 | 6 | import javax.servlet.http.HttpServletRequest; 7 | import javax.servlet.http.HttpServletRequestWrapper; 8 | import java.security.Principal; 9 | import java.util.Collection; 10 | import java.util.Optional; 11 | 12 | /** 13 | * This wraps the {@link HttpServletRequest} to make it pac4j-aware by with respect to user-related methods. 14 | * 15 | * @author Victor Noel 16 | * @since 4.0.0 17 | * 18 | */ 19 | public class Pac4JHttpServletRequestWrapper extends HttpServletRequestWrapper { 20 | 21 | private Collection profiles; 22 | 23 | public Pac4JHttpServletRequestWrapper(final HttpServletRequest request, final Collection profiles) { 24 | super(request); 25 | this.profiles = profiles; 26 | } 27 | 28 | @Override 29 | public String getRemoteUser() { 30 | return getPrincipal().map(p -> p.getName()).orElse(null); 31 | } 32 | 33 | private Optional getProfile() { 34 | return ProfileHelper.flatIntoOneProfile(profiles); 35 | } 36 | 37 | private Optional getPrincipal() { 38 | return getProfile().map(UserProfile::asPrincipal); 39 | } 40 | 41 | @Override 42 | public Principal getUserPrincipal() { 43 | return getPrincipal().orElse(null); 44 | } 45 | 46 | @Override 47 | public boolean isUserInRole(String role) { 48 | return this.profiles.stream().anyMatch(p -> p.getRoles().contains(role)); 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /javaee-pac4j/src/main/java/org/pac4j/jee/util/Pac4jProducer.java: -------------------------------------------------------------------------------- 1 | package org.pac4j.jee.util; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import lombok.val; 5 | import org.pac4j.core.adapter.FrameworkAdapter; 6 | import org.pac4j.core.config.Config; 7 | import org.pac4j.core.context.WebContext; 8 | import org.pac4j.core.context.session.SessionStore; 9 | import org.pac4j.core.profile.ProfileManager; 10 | import org.pac4j.jee.context.JEEFrameworkParameters; 11 | 12 | import javax.enterprise.context.RequestScoped; 13 | import javax.enterprise.inject.Instance; 14 | import javax.enterprise.inject.Produces; 15 | import javax.inject.Named; 16 | import javax.servlet.http.HttpServletRequest; 17 | import javax.servlet.http.HttpServletResponse; 18 | 19 | /** 20 | * Produces request-scoped web context and profile manager. 21 | * 22 | * @author Phillip Ross 23 | * @since 3.0.0 24 | */ 25 | @Named 26 | @RequestScoped 27 | @Slf4j 28 | public class Pac4jProducer { 29 | 30 | /** 31 | * Factory method which produces a pac4j web context. 32 | * 33 | * @param instanceConfig the configuration 34 | * @param httpServletRequest the HTTP servlet request 35 | * @param httpServletResponse the HTTP servlet response 36 | * @return a web context associated with the current servlet request 37 | */ 38 | @Produces 39 | WebContext getWebContext(final Instance instanceConfig, 40 | final HttpServletRequest httpServletRequest, 41 | final HttpServletResponse httpServletResponse) { 42 | 43 | if (instanceConfig.isResolvable()) { 44 | val config = instanceConfig.get(); 45 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 46 | 47 | LOGGER.trace("Producing a pac4j web context..."); 48 | val webContext = config.getWebContextFactory().newContext(new JEEFrameworkParameters(httpServletRequest, httpServletResponse)); 49 | LOGGER.trace("Returning a pac4j web context."); 50 | return webContext; 51 | } else { 52 | LOGGER.debug("Unable to produce a web context: no Config available"); 53 | } 54 | 55 | return null; 56 | } 57 | 58 | /** 59 | * Factory method which produces a pac4j session store. 60 | * 61 | * @param instanceConfig the configuration 62 | * @param httpServletRequest the HTTP servlet request 63 | * @param httpServletResponse the HTTP servlet response 64 | * @return a session store associated with the current servlet request 65 | */ 66 | @Produces 67 | SessionStore getSessionStore(final Instance instanceConfig, 68 | final HttpServletRequest httpServletRequest, 69 | final HttpServletResponse httpServletResponse) { 70 | 71 | if (instanceConfig.isResolvable()) { 72 | val config = instanceConfig.get(); 73 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 74 | 75 | LOGGER.trace("Producing a pac4j session store..."); 76 | val sessionStore = config.getSessionStoreFactory().newSessionStore(new JEEFrameworkParameters(httpServletRequest, httpServletResponse)); 77 | LOGGER.trace("Returning a pac4j session store."); 78 | return sessionStore; 79 | } else { 80 | LOGGER.debug("Unable to produce a session store: no Config available"); 81 | } 82 | 83 | return null; 84 | } 85 | 86 | /** 87 | * Factory method which produces a pac4j profile manager. 88 | * 89 | * @param instanceConfig the configuration 90 | * @param webContext the web context to be used for building the profile manager 91 | * @param sessionStore the session store to be used for building the profile manager 92 | * @return a profile manager associated with the current servlet request 93 | */ 94 | @Produces 95 | ProfileManager getProfileManager(final Instance instanceConfig, 96 | final WebContext webContext, 97 | final SessionStore sessionStore) { 98 | 99 | if (instanceConfig.isResolvable()) { 100 | val config = instanceConfig.get(); 101 | FrameworkAdapter.INSTANCE.applyDefaultSettingsIfUndefined(config); 102 | 103 | LOGGER.trace("Producing a pac4j profile manager..."); 104 | val profileManager = config.getProfileManagerFactory().apply(webContext, sessionStore); 105 | LOGGER.trace("Returning a pac4j profile manager."); 106 | return profileManager; 107 | } else { 108 | LOGGER.debug("Unable to produce a profile manager: no Config available"); 109 | } 110 | 111 | return null; 112 | } 113 | } 114 | -------------------------------------------------------------------------------- /lombok.config: -------------------------------------------------------------------------------- 1 | lombok.log.fieldName = LOGGER 2 | lombok.log.fieldIsStatic=true 3 | 4 | lombok.toString.doNotUseGetters=true 5 | lombok.equalsAndHashCode.doNotUseGetters=true 6 | 7 | lombok.addLombokGeneratedAnnotation = true 8 | 9 | config.stopBubbling=true 10 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | org.pac4j 6 | jee-pac4j-parent 7 | pom 8 | jee-pac4j parent 9 | 8.0.2-SNAPSHOT 10 | JEE pac4j libraries 11 | https://github.com/pac4j/jee-pac4j 12 | 13 | 14 | 15 | Central Portal Snapshots 16 | central-portal-snapshots 17 | https://central.sonatype.com/repository/maven-snapshots/ 18 | 19 | 20 | 21 | 22 | 23 | Central Portal Snapshots 24 | central-portal-snapshots 25 | https://central.sonatype.com/repository/maven-snapshots/ 26 | 27 | false 28 | 29 | 30 | true 31 | 32 | 33 | 34 | 35 | 36 | 37 | The Apache Software License, Version 2.0 38 | http://www.apache.org/licenses/LICENSE-2.0.txt 39 | repo 40 | 41 | 42 | 43 | 44 | https://github.com/pac4j/jee-pac4j.git 45 | scm:git:git@github.com:pac4j/jee-pac4j.git 46 | scm:git:git@github.com:pac4j/jee-pac4j.git 47 | 48 | 49 | 50 | 51 | leleuj 52 | Jerome LELEU 53 | leleuj@gmail.com 54 | 55 | 56 | 57 | 58 | javaee-pac4j 59 | jakartaee-pac4j 60 | 61 | 62 | 63 | 6.1.3 64 | 17 65 | 6.55.0 66 | 67 | 68 | 69 | 70 | org.projectlombok 71 | lombok 72 | 1.18.38 73 | provided 74 | 75 | 76 | 77 | 78 | 79 | 80 | org.sonatype.central 81 | central-publishing-maven-plugin 82 | 0.7.0 83 | true 84 | 85 | central 86 | 87 | 88 | 89 | org.apache.maven.plugins 90 | maven-compiler-plugin 91 | 3.14.0 92 | 93 | ${java.version} 94 | UTF-8 95 | 96 | 97 | 98 | org.apache.maven.plugins 99 | maven-source-plugin 100 | 3.3.1 101 | 102 | 103 | attach-sources 104 | 105 | jar-no-fork 106 | 107 | 108 | 109 | 110 | 111 | org.apache.maven.plugins 112 | maven-javadoc-plugin 113 | 3.11.2 114 | 115 | UTF-8 116 | UTF-8 117 | UTF-8 118 | 119 | 120 | 121 | attach-javadocs 122 | 123 | jar 124 | 125 | 126 | 127 | 128 | 129 | com.github.spotbugs 130 | spotbugs-maven-plugin 131 | 4.9.3.0 132 | 133 | Low 134 | Max 135 | true 136 | ${basedir}/../spotbugs-exclude.xml 137 | true 138 | 139 | 140 | 141 | run-sportbugs 142 | compile 143 | 144 | check 145 | 146 | 147 | 148 | 149 | 150 | org.apache.maven.plugins 151 | maven-pmd-plugin 152 | 3.21.2 153 | 154 | true 155 | true 156 | 157 | 158 | 159 | run-pmd 160 | compile 161 | 162 | check 163 | 164 | 165 | 166 | 167 | 168 | net.sourceforge.pmd 169 | pmd-core 170 | ${pmdVersion} 171 | 172 | 173 | net.sourceforge.pmd 174 | pmd-java 175 | ${pmdVersion} 176 | 177 | 178 | net.sourceforge.pmd 179 | pmd-javascript 180 | ${pmdVersion} 181 | 182 | 183 | net.sourceforge.pmd 184 | pmd-jsp 185 | ${pmdVersion} 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | release-sign-artifacts 195 | 196 | 197 | performRelease 198 | true 199 | 200 | 201 | 202 | 203 | 204 | org.apache.maven.plugins 205 | maven-gpg-plugin 206 | 3.2.7 207 | 208 | 209 | sign-artifacts 210 | verify 211 | 212 | sign 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ "config:base" ] 3 | } 4 | -------------------------------------------------------------------------------- /spotbugs-exclude.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | --------------------------------------------------------------------------------