JwtHeaderParameterNames.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;

namespace Microsoft.IdentityModel.JsonWebTokens
{
    /// <summary>
    /// Defines JOSE header parameter names. See: <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-5"/>.
    /// </summary>
    public struct JwtHeaderParameterNames
    {
        // Please keep this alphabetical order

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1"/>.
        /// </summary>
        public const string Alg = "alg";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.2"/>.
        /// </summary>
        public const string Apu = "apu";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.3"/>.
        /// </summary>
        public const string Apv = "apv";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.1"/>.
        /// </summary>
        public const string Epk = "epk";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.10"/> and <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-5.2"/>.
        /// </summary>
        public const string Cty = "cty";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.2"/>.
        /// </summary>
        public const string Enc = "enc";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7518#section-4.7.1.1"/>.
        /// </summary>
        public const string IV = "iv";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.2"/>.
        /// </summary>
        public const string Jku = "jku";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.3"/>.
        /// </summary>
        public const string Jwk = "jwk";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.4"/>.
        /// </summary>
        public const string Kid = "kid";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9"/> and <see href="https://datatracker.ietf.org/doc/html/rfc7519#section-5.1"/>.
        /// </summary>
        public const string Typ = "typ";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.6"/>.
        /// </summary>
        public const string X5c = "x5c";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#page-12"/>.
        /// </summary>
        public const string X5t = "x5t";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.5"/>.
        /// </summary>
        public const string X5u = "x5u";

        /// <summary>
        /// See: <see href="https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.3"/>.
        /// </summary>
        public const string Zip = "zip";
    }

    /// <summary>
    /// Parameter names for JsonWebToken header values as UTF8 bytes.
    /// Used by UTF8JsonReader/Writer for performance gains.
    /// </summary>
    internal readonly struct JwtHeaderUtf8Bytes
    {
        // Please keep this alphabetical order

        public static ReadOnlySpan<byte> Alg => "alg"u8;
        public static ReadOnlySpan<byte> Apu => "apu"u8;
        public static ReadOnlySpan<byte> Apv => "apv"u8;
        public static ReadOnlySpan<byte> Cty => "cty"u8;
        public static ReadOnlySpan<byte> Enc => "enc"u8;
        public static ReadOnlySpan<byte> Epk => "epk"u8;
        public static ReadOnlySpan<byte> IV => "iv"u8;
        public static ReadOnlySpan<byte> Jku => "jku"u8;
        public static ReadOnlySpan<byte> Jwk => "jwk"u8;
        public static ReadOnlySpan<byte> Kid => "kid"u8;
        public static ReadOnlySpan<byte> Typ => "typ"u8;
        public static ReadOnlySpan<byte> X5c => "x5c"u8;
        public static ReadOnlySpan<byte> X5t => "x5t"u8;
        public static ReadOnlySpan<byte> X5u => "x5u"u8;
        public static ReadOnlySpan<byte> Zip => "zip"u8;
    }
}