com.clouway.oauth2.jwt.Jwt Maven / Gradle / Ivy

Go to download
package com.clouway.oauth2.jwt;

import com.google.common.base.MoreObjects;

import java.util.Map;

/**
 * Jwt stands for JSON Web Token and is the entry point of the JWT package.
 *
 * @author Miroslav Genov ([email protected])
 */
public final class Jwt {

  /**
   * JSON object represented by the JOSE Header describe the cryptographic operations applied to the JWT
   * and optionally, additional properties of the JWT.
   *
   * @author Miroslav Genov ([email protected])
   * @see Jose Header
   */
  public static class Header {

    public final String alg;

    @SuppressWarnings("unused")
    public Header() {
      this(null);
    }

    public Header(String alg) {
      this.alg = alg;
    }
  }

  /**
   * ClaimSet contains information about JWT signature including the permissions being requested (scopes), the target of
   * the token, the issuer, the time token was issued and lifetime of the token.
   *
   * @author Miroslav Genov ([email protected])
   * @see Registered Claim Names
   */
  public static final class ClaimSet {
    /**
     * Email address of the client_id of the application making access token request.
     */
    public final String iss;
    /**
     * Space delimited list of permissions of application requests
     */
    public final String scope;

    /**
     * Descriptor of the intended target of the assertion (Optional)
     */
    public final String aud;

    /**
     * The expiration time of assertion
     */
    public final Long exp;

    /**
     * The time assertion was issued
     */
    public final Long iat;

    /**
     * Token Type (Optional)
     */
    public final String typ;

    /**
     * Email for which the application is requested delegated access (Optional)
     */
    public final String sub;

    /**
     * Prn is an old name of sub. Keep setting it to be compatible with legacy OAuth2 clients
     */
    public final String prn;

    public final String certId;

    public final Map customClaims;

    public static final class Builder {
      private String iss;
      private String scope;
      private String aud;
      private Long exp;
      private Long iat;
      private String typ;
      private String sub;
      private String prn;
      private String certId;
      private Map customClaims;

      private Builder() {
      }

      public ClaimSet build() {
        return new ClaimSet(this);
      }

      public Builder iss(String iss) {
        this.iss = iss;
        return this;
      }

      public Builder scope(String scope) {
        this.scope = scope;
        return this;
      }

      public Builder aud(String aud) {
        this.aud = aud;
        return this;
      }

      public Builder exp(Long exp) {
        this.exp = exp;
        return this;
      }

      public Builder iat(Long iat) {
        this.iat = iat;
        return this;
      }

      public Builder typ(String typ) {
        this.typ = typ;
        return this;
      }

      public Builder sub(String sub) {
        this.sub = sub;
        return this;
      }

      public Builder prn(String prn) {
        this.prn = prn;
        return this;
      }

      public Builder certId(String certId) {
        this.certId = certId;
        return this;
      }

      public Builder customClaims(Map customClaims) {
        this.customClaims = customClaims;
        return this;
      }
    }

    public static Builder newClaimSet() {
      return new Builder();
    }

    @SuppressWarnings("unused")
    ClaimSet() {
      this(null, null, null, null, null, null, null, null, null);
    }

    public ClaimSet(String iss, String scope, String aud, Long exp, Long iat, String typ, String sub, String certId, Map customClaims) {
      this.iss = iss;
      this.scope = scope;
      this.aud = aud;
      this.exp = exp;
      this.iat = iat;
      this.typ = typ;
      this.sub = sub;
      this.prn = sub;
      this.certId = certId;
      this.customClaims = customClaims;
    }

    @Override
    public String toString() {
      return MoreObjects.toStringHelper(this).add("iss", iss).add("scope", scope).add("aud", aud).add("exp", exp)
              .add("iat", iat).add("typ", typ).add("certificate_id", certId).add("custom_claims", customClaims).toString();
    }

    private ClaimSet(Builder builder) {
      this.iss = builder.iss;
      this.scope = builder.scope;
      this.aud = builder.aud;
      this.exp = builder.exp;
      this.iat = builder.iat;
      this.typ = builder.typ;
      this.sub = builder.sub;
      this.prn = builder.prn;
      this.certId = builder.certId;
      this.customClaims = builder.customClaims;
    }
  }
}