be.atbash.ee.security.octopus.nimbus.jose.HeaderParameterNames Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of octopus-jwt-support Show documentation
Atbash Octopus JWT Support
The newest version!
/*
 * Copyright 2017-2022 Rudy De Busscher (https://www.atbash.be)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package be.atbash.ee.security.octopus.nimbus.jose;

import be.atbash.util.PublicAPI;

/**
 * The JOSE identifiers to use when creating JWEs, JWKs, etc...
 *
 * @author Nathaniel Hart
 * @version 2021-06-15
 * @see JSON Object Signing and Encryption (JOSE)
 */
@PublicAPI
public final class HeaderParameterNames {

    private HeaderParameterNames() {
    }


    ////////////////////////////////////////////////////////////////////////////////
    // RFC 7516 (JWE) Header Parameters
    ////////////////////////////////////////////////////////////////////////////////


    /**
     * @see RFC 7516 "alg" (Algorithm) Header Parameter
     */
    public static final String ALGORITHM = "alg";


    /**
     * @see RFC 7516 "enc" (Encryption Algorithm) Header Parameter
     */
    public static final String ENCRYPTION_ALGORITHM = "enc";


    /**
     * @see RFC 7516 "zip" (Compression Algorithm) Header Parameter
     */
    public static final String COMPRESSION_ALGORITHM = "zip";


    /**
     * @see RFC 7516 "jku" (JWK Set URL) Header Parameter
     */
    public static final String JWK_SET_URL = "jku";


    /**
     * @see RFC 7516 "jwk" (JSON Web Key) Header Parameter
     */
    public static final String JSON_WEB_KEY = "jwk";


    /**
     * @see RFC 7516 "kid" (Key ID) Header Parameter
     */
    public static final String KEY_ID = "kid";


    /**
     * @see RFC 7516 "x5u" (X.509 URL) Header Parameter
     */
    public static final String X_509_URL = "x5u";


    /**
     * @see RFC 7516 "x5c" (X.509 Certificate Chain) Header Parameter
     */
    public static final String X_509_CERT_CHAIN = "x5c";


    /**
     * @see RFC 7516 "x5t" (X.509 Certificate SHA-1 Thumbprint) Header Parameter
     */
    public static final String X_509_CERT_SHA_1_THUMBPRINT = "x5t";


    /**
     * @see RFC 7516 "x5t#S256" (X.509 Certificate SHA-256 Thumbprint) Header
     * Parameter
     */
    public static final String X_509_CERT_SHA_256_THUMBPRINT = "x5t#S256";


    /**
     * @see RFC 7516 "typ" (Type) Header Parameter
     */
    public static final String TYPE = "typ";


    /**
     * @see RFC 7516 "cty" (Content Type) Header Parameter
     */
    public static final String CONTENT_TYPE = "cty";


    /**
     * @see RFC 7516 "crit" (Critical) Header Parameter
     */
    public static final String CRITICAL = "crit";


    ////////////////////////////////////////////////////////////////////////////////
    // RFC 7518 (JWA) Header Parameters
    ////////////////////////////////////////////////////////////////////////////////


    /**
     * @see RFC 7518 "epk" (Ephemeral Public Key) Header Parameter
     */
    public static final String EPHEMERAL_PUBLIC_KEY = "epk";


    /**
     * @see RFC 7518 "apu" (Agreement PartyUInfo) Header Parameter
     */
    public static final String AGREEMENT_PARTY_U_INFO = "apu";


    /**
     * @see RFC 7518 "apv" (Agreement PartyVInfo) Header Parameter
     */
    public static final String AGREEMENT_PARTY_V_INFO = "apv";


    /**
     * @see RFC 7518 "iv" (Initialization Vector) Header Parameter
     */
    public static final String INITIALIZATION_VECTOR = "iv";


    /**
     * @see RFC 7518 "tag" (Authentication Tag) Header Parameter
     */
    public static final String AUTHENTICATION_TAG = "tag";


    /**
     * @see RFC 7518 "p2s" (PBES2 Salt Input) Header Parameter
     */
    public static final String PBES2_SALT_INPUT = "p2s";


    /**
     * @see RFC 7518 "p2c" (PBES2 Count) Header Parameter
     */
    public static final String PBES2_COUNT = "p2c";


    ////////////////////////////////////////////////////////////////////////////////
    // RFC 7797 (JWS Unencoded Payload Option) Header Parameters
    ////////////////////////////////////////////////////////////////////////////////


    /**
     * @see RFC 7797 "b64" (base64url-encode payload) Header Parameter
     */
    public static final String BASE64_URL_ENCODE_PAYLOAD = "b64";
}