├── .gitignore ├── LICENSE ├── README.md ├── pom.xml └── src └── main ├── java └── com │ └── acm │ └── infra │ └── proxy │ ├── Application.java │ ├── JWTFilter.java │ ├── JWTTokenExtractException.java │ └── JWTVerifierFactory.java └── resources └── application.yaml /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | .idea/ 3 | *.iml 4 | 5 | # Compiled class file 6 | *.class 7 | 8 | # Log file 9 | *.log 10 | 11 | # BlueJ files 12 | *.ctxt 13 | 14 | # Mobile Tools for Java (J2ME) 15 | .mtj.tmp/ 16 | 17 | # Package Files # 18 | *.jar 19 | *.war 20 | *.ear 21 | *.zip 22 | *.tar.gz 23 | *.rar 24 | 25 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 26 | hs_err_pid* 27 | 28 | target/ 29 | pom.xml.tag 30 | pom.xml.releaseBackup 31 | pom.xml.versionsBackup 32 | pom.xml.next 33 | release.properties 34 | dependency-reduced-pom.xml 35 | buildNumber.properties 36 | .mvn/timing.properties 37 | 38 | # Avoid ignoring Maven wrapper jar file (.jar files are usually ignored) 39 | !/.mvn/wrapper/maven-wrapper.jar 40 | -------------------------------------------------------------------------------- /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. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spring-jwt-gateway 2 | A JWT based authentication api gateway based on Spring Cloud Gateway 3 | 4 | This api gateway can be used to provide a central place to authenticate JWT token for all the back-ends services, and if the request is authenticated, this gateway will add 'X-jwt-sub=xxx' in the request http header, then all the backend services can use this customized header to do its own authorization. The 'X-jwt-sub' header value is extracted from the provided JWT token. 5 | 6 | This is still under development until the Spring Cloud Gateway 2.0 officially released. 7 | 8 | Road Map: 9 | - Support JWT RSA256 and HMAC algorithm. Right now only RSA256 is supported to verify JWT token. 10 | - Support to inject more JWT fields (issuer, expire_at) in the header. 11 | - Support official Spring Cloud Gateway 2.0. 12 | - Change the configuration more easy. 13 | - Support Docker. 14 | - Support Rate Limiter. 15 | 16 | Get Started: 17 | - git checkout and run maven install 18 | - modify the application.yaml file example for your needs 19 | - you must provide 2 environment variables: '${jwt.issuer}' and '${jwt.audience}' when launching this app 20 | - then enjoy 21 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.acm.infra 8 | proxy 9 | 0.1 10 | 11 | 12 | 13 | org.apache.maven.plugins 14 | maven-compiler-plugin 15 | 16 | 1.8 17 | 1.8 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | org.springframework.cloud 27 | spring-cloud-gateway 28 | 2.0.0.M9 29 | pom 30 | import 31 | 32 | 33 | 34 | 35 | 36 | 37 | com.auth0 38 | java-jwt 39 | 3.3.0 40 | 41 | 42 | org.springframework.cloud 43 | spring-cloud-starter-gateway 44 | 45 | 46 | com.auth0 47 | jwks-rsa 48 | 0.3.0 49 | 50 | 51 | 52 | 53 | 54 | spring-milestones 55 | Spring Milestones 56 | https://repo.spring.io/libs-milestone 57 | 58 | false 59 | 60 | 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /src/main/java/com/acm/infra/proxy/Application.java: -------------------------------------------------------------------------------- 1 | package com.acm.infra.proxy; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class Application { 8 | 9 | // JWT verification, rate limit, dynamic routing, actuator 10 | public static void main(String[] args) { 11 | SpringApplication.run(Application.class, args); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/acm/infra/proxy/JWTFilter.java: -------------------------------------------------------------------------------- 1 | package com.acm.infra.proxy; 2 | 3 | import com.auth0.jwt.JWTVerifier; 4 | import com.auth0.jwt.exceptions.JWTVerificationException; 5 | import com.auth0.jwt.interfaces.DecodedJWT; 6 | import org.slf4j.Logger; 7 | import org.slf4j.LoggerFactory; 8 | import org.springframework.beans.factory.annotation.Qualifier; 9 | import org.springframework.cloud.gateway.filter.GatewayFilter; 10 | import org.springframework.cloud.gateway.filter.factory.AbstractNameValueGatewayFilterFactory; 11 | import org.springframework.http.HttpStatus; 12 | import org.springframework.http.server.reactive.ServerHttpRequest; 13 | import org.springframework.http.server.reactive.ServerHttpResponse; 14 | import org.springframework.stereotype.Component; 15 | import org.springframework.web.server.ServerWebExchange; 16 | import reactor.core.publisher.Mono; 17 | 18 | import java.util.List; 19 | 20 | @Component 21 | public class JWTFilter extends AbstractNameValueGatewayFilterFactory { 22 | 23 | private static final String WWW_AUTH_HEADER = "WWW-Authenticate"; 24 | private static final String X_JWT_SUB_HEADER = "X-jwt-sub"; 25 | 26 | private static final Logger logger = LoggerFactory.getLogger(JWTFilter.class); 27 | 28 | private final JWTVerifier jwtVerifier; 29 | 30 | public JWTFilter(@Qualifier("jwk") JWTVerifier jwtVerifier) { 31 | this.jwtVerifier = jwtVerifier; 32 | } 33 | 34 | @Override 35 | public GatewayFilter apply(NameValueConfig config) { 36 | return (exchange, chain) -> { 37 | 38 | try { 39 | String token = this.extractJWTToken(exchange.getRequest()); 40 | DecodedJWT decodedJWT = this.jwtVerifier.verify(token); 41 | 42 | ServerHttpRequest request = exchange.getRequest().mutate(). 43 | header(X_JWT_SUB_HEADER, decodedJWT.getSubject()). 44 | build(); 45 | 46 | return chain.filter(exchange.mutate().request(request).build()); 47 | 48 | } catch (JWTVerificationException ex) { 49 | 50 | logger.error(ex.toString()); 51 | return this.onError(exchange, ex.getMessage()); 52 | } 53 | }; 54 | } 55 | 56 | private Mono onError(ServerWebExchange exchange, String err) 57 | { 58 | ServerHttpResponse response = exchange.getResponse(); 59 | response.setStatusCode(HttpStatus.UNAUTHORIZED); 60 | response.getHeaders().add(WWW_AUTH_HEADER, this.formatErrorMsg(err)); 61 | 62 | return response.setComplete(); 63 | } 64 | 65 | private String extractJWTToken(ServerHttpRequest request) 66 | { 67 | if (!request.getHeaders().containsKey("Authorization")) { 68 | throw new JWTTokenExtractException("Authorization header is missing"); 69 | } 70 | 71 | List headers = request.getHeaders().get("Authorization"); 72 | if (headers.isEmpty()) { 73 | throw new JWTTokenExtractException("Authorization header is empty"); 74 | } 75 | 76 | String credential = headers.get(0).trim(); 77 | String[] components = credential.split("\\s"); 78 | 79 | if (components.length != 2) { 80 | throw new JWTTokenExtractException("Malformat Authorization content"); 81 | } 82 | 83 | if (!components[0].equals("Bearer")) { 84 | throw new JWTTokenExtractException("Bearer is needed"); 85 | } 86 | 87 | return components[1].trim(); 88 | } 89 | 90 | private String formatErrorMsg(String msg) 91 | { 92 | return String.format("Bearer realm=\"acm.com\", " + 93 | "error=\"https://tools.ietf.org/html/rfc7519\", " + 94 | "error_description=\"%s\" ", msg); 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /src/main/java/com/acm/infra/proxy/JWTTokenExtractException.java: -------------------------------------------------------------------------------- 1 | package com.acm.infra.proxy; 2 | 3 | import com.auth0.jwt.exceptions.JWTVerificationException; 4 | 5 | public class JWTTokenExtractException extends JWTVerificationException { 6 | 7 | public JWTTokenExtractException(String message) { 8 | super(message); 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /src/main/java/com/acm/infra/proxy/JWTVerifierFactory.java: -------------------------------------------------------------------------------- 1 | package com.acm.infra.proxy; 2 | 3 | import com.auth0.jwk.Jwk; 4 | import com.auth0.jwk.JwkException; 5 | import com.auth0.jwk.UrlJwkProvider; 6 | import com.auth0.jwt.JWT; 7 | import com.auth0.jwt.JWTVerifier; 8 | import com.auth0.jwt.algorithms.Algorithm; 9 | import com.fasterxml.jackson.databind.JsonNode; 10 | import com.fasterxml.jackson.databind.ObjectMapper; 11 | import org.apache.commons.codec.binary.Base64; 12 | import org.springframework.beans.factory.annotation.Qualifier; 13 | import org.springframework.beans.factory.annotation.Value; 14 | import org.springframework.context.annotation.Bean; 15 | import org.springframework.stereotype.Component; 16 | import org.springframework.web.client.RestTemplate; 17 | 18 | import java.io.IOException; 19 | import java.security.KeyFactory; 20 | import java.security.NoSuchAlgorithmException; 21 | import java.security.PublicKey; 22 | import java.security.interfaces.RSAPublicKey; 23 | import java.security.spec.InvalidKeySpecException; 24 | import java.security.spec.X509EncodedKeySpec; 25 | 26 | @Component 27 | public class JWTVerifierFactory { 28 | 29 | @Bean 30 | @Qualifier("jwk") 31 | public JWTVerifier create(@Value("${jwt.issuer}") String issuer, @Value("${jwt.audience}") String audience) 32 | throws JwkException, IOException { 33 | 34 | UrlJwkProvider urlJwkProvider = new UrlJwkProvider(issuer); 35 | RestTemplate restTemplate = new RestTemplate(); 36 | 37 | ObjectMapper objectMapper = new ObjectMapper(); 38 | JsonNode jsonNode = objectMapper.readTree(restTemplate.getForObject(issuer + "/.well-known/jwks.json", String.class)); 39 | String kid = jsonNode.get("keys").get(0).get("kid").asText(); 40 | 41 | Jwk jwk = urlJwkProvider.get(kid); 42 | 43 | return JWT.require(Algorithm.RSA256((RSAPublicKey) jwk.getPublicKey(), null)) 44 | .withIssuer(issuer) 45 | .withAudience(audience) 46 | .build(); 47 | } 48 | 49 | @Bean 50 | @Qualifier("jwt") 51 | public JWTVerifier create(@Value("${jwt.key}") String publicKey) 52 | throws NoSuchAlgorithmException, InvalidKeySpecException { 53 | byte[] publicBytes = Base64.decodeBase64(publicKey); 54 | X509EncodedKeySpec keySpec = new X509EncodedKeySpec(publicBytes); 55 | KeyFactory keyFactory = KeyFactory.getInstance("RSA"); 56 | PublicKey pubKey = keyFactory.generatePublic(keySpec); 57 | 58 | return JWT.require(Algorithm.RSA256((RSAPublicKey) pubKey, null)) 59 | .build(); 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /src/main/resources/application.yaml: -------------------------------------------------------------------------------- 1 | spring: 2 | application: 3 | name: dsp-api-gateway 4 | 5 | spring: 6 | cloud: 7 | gateway: 8 | routes: 9 | 10 | - id: reporting-service 11 | uri: http://localhost:9092 12 | predicates: 13 | - Path=/api/reporting/** 14 | 15 | - id: platform-service 16 | uri: http://localhost:9091 17 | predicates: 18 | - Path=/api/** 19 | filters: 20 | - JWTFilter=RSA256,HS256 21 | - RemoveResponseHeader=X-Powered-By 22 | 23 | server: 24 | port: 5000 --------------------------------------------------------------------------------