Class JwtHeaders

java.lang.Object
io.helidon.security.jwt.JwtHeaders
public class JwtHeaders extends Object
Representation of the header section of a JWT. This can be used to partially parse a token to understand what kind of processing should be done further, whether SignedJwt or EncryptedJwt.
See Also:

  • Method Details

    • builder

      public static JwtHeaders.Builder builder()
      Create a new builder for header claims.
      Returns:
      a new builder

    • parseToken

      public static JwtHeaders parseToken(String token)
      Parse a token to retrieve the JWT header. This method only cares about the first section of the token, and ignores the rest (even if not valid). Text before the first dot is considered to be base64 value of the header JSON.
      Parameters:
      token - token, expected to be JWT (encrypted or signed)
      Returns:
      header parsed from the token
      Throws:
      JwtException - in case the token is not valid

    • headerJsonObject

      public JsonObject headerJsonObject()
      Create a JSON header object.
      Returns:
      JsonObject for header

    • headerClaimValue

      public Optional<JsonValue> headerClaimValue(String claim)
      Get a claim by its name from header.
      Parameters:
      claim - name of a claim
      Returns:
      claim value if present

    • algorithm

      public Optional<String> algorithm()
      Algorithm claim.
      Returns:
      algorithm or empty if claim is not defined

    • encryption

      public Optional<String> encryption()
      Encryption algorithm claim.
      Returns:
      algorithm or empty if not encrypted

    • contentType

      public Optional<String> contentType()
      Content type claim.
      Returns:
      content type or empty if claim is not defined

    • keyId

      public Optional<String> keyId()
      Key id claim.
      Returns:
      key id or empty if claim is not defined

    • type

      public Optional<String> type()
      Type claim.
      Returns:
      type or empty if claim is not defined

    • subject

      public Optional<String> subject()
      Subject claim.
      Returns:
      subject or empty if claim is not defined

    • issuer

      public Optional<String> issuer()
      Issuer claim.
      Returns:
      Issuer or empty if claim is not defined

    • audience

      public Optional<List<String>> audience()
      Audience claim.
      Returns:
      audience or empty optional if claim is not defined; list would be empty if the audience claim is defined as an empty array

    • critical

      public Optional<List<String>> critical()
      Critical claim.
      Returns:
      critical claims or empty optional if not defined; list would be empty if the critical claim is defined as an empty array

    • headerClaimsJson

      public Map<String, JsonValue> headerClaimsJson()
      Return map of all header claims.
      Returns:
      header claims

    • decode

      protected static String decode(String base64, Errors.Collector collector, io.helidon.security.jwt.JwtTokenPart tokenPart)
      Decode a Base64 URL encoded JWT segment.
      Parameters:
      base64 - base64 URL encoded value
      collector - error collector
      tokenPart - decoded token part
      Returns:
      decoded value, or null when decoding fails

    • parseJson

      protected static JsonObject parseJson(String jsonString, Errors.Collector collector, io.helidon.security.jwt.JwtTokenPart tokenPart)
      Parse a decoded JWT segment as a JSON object.
      Parameters:
      jsonString - decoded JSON string
      collector - error collector
      tokenPart - decoded token part
      Returns:
      parsed JSON object, or null when parsing fails