org.elastos.did.jwt.JwtParser Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of didsdk Show documentation
Show all versions of didsdk Show documentation
Elastos decentralized identity library
The newest version!
/*
* Copyright (c) 2019 Elastos Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.elastos.did.jwt;
import static com.google.common.base.Preconditions.checkArgument;
/**
* A parser for reading JWT strings.
*/
public class JwtParser {
private io.jsonwebtoken.JwtParser impl;
/**
* Construct a JwtParser instance from an internal implementation object.
*
* @param impl an io.jsonwebtoken.JwtParser object
*/
protected JwtParser(io.jsonwebtoken.JwtParser impl) {
this.impl = impl;
}
/**
* Returns {@code true} if the specified JWT compact string represents a
* signed JWT (aka a 'JWS'), {@code false} otherwise.
*
* Note that if you are reasonably sure that the token is signed, it is more
* efficient to attempt to parse the token (and catching exceptions if
* necessary) instead of calling this method first before parsing.
*
* @param jwt the compact serialized JWT to check
* @return {@code true} if the specified JWT compact string represents a
* signed JWT (aka a 'JWS'), {@code false} otherwise.
*/
public boolean isSigned(String jwt) {
return impl.isSigned(jwt);
}
/**
* Parses the specified compact serialized JWT string based on the builder's
* current configuration state and returns the resulting JWT or JWS
* instance.
*
* This method returns a JWT or JWS based on the parsed string.
*
* @param jwt the compact serialized JWT to parse
* @return the specified compact serialized JWT string based on the
* builder's current configuration state.
* @throws MalformedJwtException if the specified JWT was incorrectly
* constructed (and therefore invalid).
* Invalid JWTs should not be trusted and
* should be discarded.
* @throws JwsSignatureException if a JWS signature was discovered, but
* could not be verified. JWTs that fail
* signature validation should not be
* trusted and should be discarded.
* @throws ExpiredJwtException if the specified JWT is a Claims JWT and
* the Claims has an expiration time before
* the time this method is invoked.
* @throws IllegalArgumentException if the specified string is {@code null}
* or empty or only whitespace.
* @see #parsePlaintextJwt(String)
* @see #parseClaimsJwt(String)
* @see #parsePlaintextJws(String)
* @see #parseClaimsJws(String)
*/
public Jwt parse(String jwt) throws ExpiredJwtException,
MalformedJwtException, JwsSignatureException {
checkArgument(jwt != null && !jwt.isEmpty(), "Invalid jwt");
try {
return new Jwt(impl.parse(jwt));
} catch (io.jsonwebtoken.ExpiredJwtException e) {
throw new ExpiredJwtException(e);
} catch (io.jsonwebtoken.MalformedJwtException e) {
throw new MalformedJwtException(e);
} catch (@SuppressWarnings("deprecation") io.jsonwebtoken.SignatureException e) {
throw new JwsSignatureException(e);
}
}
/**
* Parses the specified compact serialized JWT string based on the builder's
* current configuration state and returns the resulting unsigned plaintext
* JWT instance.
*
* This is a convenience method that is usable if you are confident that the
* compact string argument reflects an unsigned plaintext JWT. An unsigned
* plaintext JWT has a String (non-JSON) body payload and it is not
* cryptographically signed.
*
* If the compact string presented does not reflect an unsigned plaintext
* JWT with non-JSON string body, an {@link UnsupportedJwtException} will be
* thrown.
*
* @param plaintextJwt a compact serialized unsigned plaintext JWT string.
* @return the {@link Jwt Jwt} instance that reflects the specified compact
* JWT string.
* @throws UnsupportedJwtException if the {@code plaintextJwt} argument
* does not represent an unsigned plaintext
* JWT
* @throws MalformedJwtException if the {@code plaintextJwt} string is
* not a valid JWT
* @throws JwsSignatureException if the {@code plaintextJwt} string is
* actually a JWS and signature validation
* fails
* @throws IllegalArgumentException if the {@code plaintextJwt} string is
* {@code null} or empty or only whitespace
* @see #parseClaimsJwt(String)
* @see #parsePlaintextJws(String)
* @see #parseClaimsJws(String)
* @see #parse(String)
* @since 0.2
*/
public Jwt parsePlaintextJwt(String plaintextJwt)
throws UnsupportedJwtException, MalformedJwtException,
JwsSignatureException {
checkArgument(plaintextJwt != null && !plaintextJwt.isEmpty(), "Invalid plaintextJwt");
try {
return new Jwt(impl.parsePlaintextJwt(plaintextJwt));
} catch (io.jsonwebtoken.UnsupportedJwtException e) {
throw new UnsupportedJwtException(e);
} catch (io.jsonwebtoken.MalformedJwtException e) {
throw new MalformedJwtException(e);
} catch (@SuppressWarnings("deprecation") io.jsonwebtoken.SignatureException e) {
throw new JwsSignatureException(e);
}
}
/**
* Parses the specified compact serialized JWT string based on the builder's
* current configuration state and returns the resulting unsigned plaintext
* JWT instance.
*
* This is a convenience method that is usable if you are confident that the
* compact string argument reflects an unsigned Claims JWT. An unsigned
* Claims JWT has a {@link Claims} body and it is not cryptographically
* signed.
*
* If the compact string presented does not reflect an unsigned Claims
* JWT, an {@link UnsupportedJwtException} will be thrown.
*
* @param claimsJwt a compact serialized unsigned Claims JWT string.
* @return the {@link Jwt Jwt} instance that reflects the specified compact
* JWT string.
* @throws UnsupportedJwtException if the {@code claimsJwt} argument does
* not represent an unsigned Claims JWT
* @throws MalformedJwtException if the {@code claimsJwt} string is not a
* valid JWT
* @throws JwsSignatureException if the {@code claimsJwt} string is
* actually a JWS and signature validation
* fails
* @throws ExpiredJwtException if the specified JWT is a Claims JWT and
* the Claims has an expiration time before
* the time this method is invoked.
* @throws IllegalArgumentException if the {@code claimsJwt} string is
* {@code null} or empty or only whitespace
* @see #parsePlaintextJwt(String)
* @see #parsePlaintextJws(String)
* @see #parseClaimsJws(String)
* @see #parse(String)
*/
public Jwt parseClaimsJwt(String claimsJwt)
throws ExpiredJwtException, UnsupportedJwtException,
MalformedJwtException, JwsSignatureException {
checkArgument(claimsJwt != null && !claimsJwt.isEmpty(), "Invalid claimsJwt");
try {
return new Jwt(impl.parseClaimsJwt(claimsJwt));
} catch (io.jsonwebtoken.ExpiredJwtException e) {
throw new ExpiredJwtException(e);
} catch (io.jsonwebtoken.UnsupportedJwtException e) {
throw new UnsupportedJwtException(e);
} catch (io.jsonwebtoken.MalformedJwtException e) {
throw new MalformedJwtException(e);
} catch (@SuppressWarnings("deprecation") io.jsonwebtoken.SignatureException e) {
throw new JwsSignatureException(e);
}
}
/**
* Parses the specified compact serialized JWS string based on the builder's
* current configuration state and returns the resulting plaintext JWS
* instance.
*
* This is a convenience method that is usable if you are confident that the
* compact string argument reflects a plaintext JWS. A plaintext JWS is a
* JWT with a String (non-JSON) body (payload) that has been
* cryptographically signed.
*
* If the compact string presented does not reflect a plaintext JWS, an
* {@link UnsupportedJwtException} will be thrown.
*
* @param plaintextJws a compact serialized JWS string.
* @return the {@link Jws Jws} instance that reflects the specified compact
* JWS string.
* @throws UnsupportedJwtException if the {@code plaintextJws} argument
* does not represent an plaintext JWS
* @throws MalformedJwtException if the {@code plaintextJws} string is
* not a valid JWS
* @throws JwsSignatureException if the {@code plaintextJws} JWS
* signature validation fails
* @throws IllegalArgumentException if the {@code plaintextJws} string is
* {@code null} or empty or only whitespace
* @see #parsePlaintextJwt(String)
* @see #parseClaimsJwt(String)
* @see #parseClaimsJws(String)
* @see #parse(String)
*/
public Jws parsePlaintextJws(String plaintextJws)
throws UnsupportedJwtException, MalformedJwtException,
JwsSignatureException {
checkArgument(plaintextJws != null && !plaintextJws.isEmpty(), "Invalid plaintextJws");
try {
return new Jws(impl.parsePlaintextJws(plaintextJws));
} catch (io.jsonwebtoken.UnsupportedJwtException e) {
throw new UnsupportedJwtException(e);
} catch (io.jsonwebtoken.MalformedJwtException e) {
throw new MalformedJwtException(e);
} catch (@SuppressWarnings("deprecation") io.jsonwebtoken.SignatureException e) {
throw new JwsSignatureException(e);
}
}
/**
* Parses the specified compact serialized JWS string based on the builder's
* current configuration state and returns the resulting Claims JWS
* instance.
*
* This is a convenience method that is usable if you are confident that the
* compact string argument reflects a Claims JWS. A Claims JWS is a JWT with
* a {@link Claims} body that has been cryptographically signed.
*
* If the compact string presented does not reflect a Claims JWS, an
* {@link UnsupportedJwtException} will be thrown.
*
* @param claimsJws a compact serialized Claims JWS string.
* @return the {@link Jws Jws} instance that reflects the specified compact
* Claims JWS string.
* @throws UnsupportedJwtException if the {@code claimsJws} argument does
* not represent an Claims JWS
* @throws MalformedJwtException if the {@code claimsJws} string is not a
* valid JWS
* @throws JwsSignatureException if the {@code claimsJws} JWS signature
* validation fails
* @throws ExpiredJwtException if the specified JWT is a Claims JWT and
* the Claims has an expiration time before
* the time this method is invoked.
* @throws IllegalArgumentException if the {@code claimsJws} string is
* {@code null} or empty or only whitespace
* @see #parsePlaintextJwt(String)
* @see #parseClaimsJwt(String)
* @see #parsePlaintextJws(String)
* @see #parse(String)
*/
public Jws parseClaimsJws(String claimsJws)
throws ExpiredJwtException, UnsupportedJwtException,
MalformedJwtException, JwsSignatureException {
checkArgument(claimsJws != null && !claimsJws.isEmpty(), "Invalid claimsJws");
try {
return new Jws(impl.parseClaimsJws(claimsJws));
} catch (io.jsonwebtoken.ExpiredJwtException e) {
throw new ExpiredJwtException(e);
} catch (io.jsonwebtoken.UnsupportedJwtException e) {
throw new UnsupportedJwtException(e);
} catch (io.jsonwebtoken.MalformedJwtException e) {
throw new MalformedJwtException(e);
} catch (@SuppressWarnings("deprecation") io.jsonwebtoken.SignatureException e) {
throw new JwsSignatureException(e);
}
}
}