forked from auth0/java-jwt
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJWTVerifier.java
More file actions
239 lines (208 loc) · 9.1 KB
/
JWTVerifier.java
File metadata and controls
239 lines (208 loc) · 9.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
package com.auth0.jwt;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.lang3.Validate;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.IOException;
import java.nio.charset.Charset;
import java.security.*;
import java.util.Map;
/**
* Handles JWT Verification Operations
*
* Validates claims and signature
*
* See associated library test cases for clear examples on usage
*
*/
public class JWTVerifier {
static {
if (Security.getProvider(BouncyCastleProvider.PROVIDER_NAME) == null) {
Security.addProvider(new BouncyCastleProvider());
}
}
private byte[] secret;
private PublicKey publicKey;
private final String audience;
private final String issuer;
private final Base64 decoder = new Base64(true);
private final ObjectMapper mapper;
public JWTVerifier(final String secret, final String audience, final String issuer) {
this(secret.getBytes(Charset.forName("UTF-8")), audience, issuer);
}
public JWTVerifier(final String secret, final String audience) {
this(secret, audience, null);
}
public JWTVerifier(final String secret) {
this(secret, null, null);
}
public JWTVerifier(final byte[] secret, final String audience) {
this(secret, audience, null);
}
public JWTVerifier(final byte[] secret) {
this(secret, null, null);
}
public JWTVerifier(final byte[] secret, final String audience, final String issuer) {
if (secret == null || secret.length == 0) {
throw new IllegalArgumentException("Secret cannot be null or empty");
}
mapper = new ObjectMapper();
this.secret = secret;
this.audience = audience;
this.issuer = issuer;
}
public JWTVerifier(final PublicKey publicKey, final String audience, final String issuer) {
Validate.notNull(publicKey);
mapper = new ObjectMapper();
this.publicKey = publicKey;
this.audience = audience;
this.issuer = issuer;
}
public JWTVerifier(final PublicKey publicKey, final String audience) {
this(publicKey, audience, null);
}
public JWTVerifier(final PublicKey publicKey) {
this(publicKey, null, null);
}
/**
* Performs JWT validation
*
* @param token token to verify
* @throws SignatureException when signature is invalid
* @throws JWTVerifyException when expiration, issuer or audience are invalid
* @throws JWTAlgorithmException when the algorithm is missing or unsupported
* @throws IllegalStateException when token's structure is invalid or secret / public key does not match algorithm of token
*/
@SuppressWarnings("WeakerAccess")
public Map<String, Object> verify(final String token) throws NoSuchAlgorithmException, InvalidKeyException, IllegalStateException,
IOException, SignatureException, JWTVerifyException {
if (token == null || "".equals(token)) {
throw new IllegalStateException("token not set");
}
final String[] pieces = token.split("\\.");
if (pieces.length != 3) {
throw new IllegalStateException("Wrong number of segments: " + pieces.length);
}
final JsonNode jwtHeader = decodeAndParse(pieces[0]);
final Algorithm algorithm = getAlgorithm(jwtHeader);
final JsonNode jwtPayload = decodeAndParse(pieces[1]);
verifySignature(pieces, algorithm);
verifyExpiration(jwtPayload);
verifyIssuer(jwtPayload);
verifyAudience(jwtPayload);
return mapper.treeToValue(jwtPayload, Map.class);
}
void verifySignature(final String[] pieces, final Algorithm algorithm) throws NoSuchAlgorithmException,
InvalidKeyException, SignatureException, JWTAlgorithmException, IllegalStateException {
Validate.notNull(pieces);
Validate.notNull(algorithm);
if (pieces.length != 3) {
throw new IllegalStateException("Wrong number of segments: " + pieces.length);
}
switch (algorithm) {
case HS256:
case HS384:
case HS512:
verifyHmac(algorithm, pieces, secret);
return;
case RS256:
case RS384:
case RS512:
verifyRs(algorithm, pieces, publicKey);
return;
default:
throw new JWTAlgorithmException("Unsupported signing method");
}
}
private void verifyHmac(final Algorithm algorithm, final String[] pieces, final byte[] secret) throws SignatureException, NoSuchAlgorithmException, InvalidKeyException {
if (secret == null || secret.length == 0) {
throw new IllegalStateException("Secret cannot be null or empty when using algorithm: " + algorithm.getValue());
}
final Mac hmac = Mac.getInstance(algorithm.getValue());
hmac.init(new SecretKeySpec(secret, algorithm.getValue()));
final byte[] sig = hmac.doFinal((pieces[0] + "." + pieces[1]).getBytes());
if (!MessageDigest.isEqual(sig, decoder.decode(pieces[2]))) {
throw new SignatureException("signature verification failed");
}
}
private void verifyRs(final Algorithm algorithm, final String[] pieces, final PublicKey publicKey) throws SignatureException, NoSuchAlgorithmException, InvalidKeyException, JWTAlgorithmException {
if (publicKey == null) {
throw new IllegalStateException("PublicKey cannot be null when using algorithm: " + algorithm.getValue());
}
final byte[] decodedSignatureBytes = new Base64(true).decode(pieces[2]);
final byte[] headerPayloadBytes = (pieces[0] + "." + pieces[1]).getBytes();
final boolean verified = verifySignatureWithPublicKey(this.publicKey, headerPayloadBytes, decodedSignatureBytes, algorithm);
if (!verified) {
throw new SignatureException("signature verification failed");
}
}
private boolean verifySignatureWithPublicKey(final PublicKey publicKey, final byte[] messageBytes, final byte[] signatureBytes, final Algorithm algorithm) throws InvalidKeyException, SignatureException, NoSuchAlgorithmException, JWTAlgorithmException {
Validate.notNull(publicKey);
Validate.notNull(messageBytes);
Validate.notNull(signatureBytes);
Validate.notNull(algorithm);
try {
final Signature signature = Signature.getInstance(algorithm.getValue(), "BC");
signature.initVerify(publicKey);
signature.update(messageBytes);
return signature.verify(signatureBytes);
} catch (NoSuchProviderException e) {
throw new JWTAlgorithmException(e.getMessage(), e.getCause());
}
}
void verifyExpiration(final JsonNode jwtClaims) throws JWTExpiredException {
Validate.notNull(jwtClaims);
final long expiration = jwtClaims.has("exp") ? jwtClaims.get("exp").asLong(0) : 0;
if (expiration != 0 && System.currentTimeMillis() / 1000L >= expiration) {
throw new JWTExpiredException("jwt expired", expiration);
}
}
void verifyIssuer(final JsonNode jwtClaims) throws JWTIssuerException {
Validate.notNull(jwtClaims);
if (this.issuer == null ) {
return;
}
final String issuerFromToken = jwtClaims.has("iss") ? jwtClaims.get("iss").asText() : null;
if (issuerFromToken == null || !issuer.equals(issuerFromToken)) {
throw new JWTIssuerException("jwt issuer invalid", issuerFromToken);
}
}
void verifyAudience(final JsonNode jwtClaims) throws JWTAudienceException {
Validate.notNull(jwtClaims);
if (audience == null) {
return;
}
final JsonNode audNode = jwtClaims.get("aud");
if (audNode == null) {
throw new JWTAudienceException("jwt audience invalid", null);
}
if (audNode.isArray()) {
for (final JsonNode jsonNode : audNode) {
if (audience.equals(jsonNode.textValue())) {
return;
}
}
} else if (audNode.isTextual()) {
if (audience.equals(audNode.textValue())) {
return;
}
}
throw new JWTAudienceException("jwt audience invalid", audNode);
}
Algorithm getAlgorithm(final JsonNode jwtHeader) throws JWTAlgorithmException {
Validate.notNull(jwtHeader);
final String algorithmName = jwtHeader.has("alg") ? jwtHeader.get("alg").asText() : null;
if (jwtHeader.get("alg") == null) {
throw new IllegalStateException("algorithm not set");
}
return Algorithm.findByName(algorithmName);
}
JsonNode decodeAndParse(final String b64String) throws IOException {
Validate.notNull(b64String);
final String jsonString = new String(decoder.decode(b64String), "UTF-8");
return mapper.readValue(jsonString, JsonNode.class);
}
}