<?xml version="1.0"?>
|
<doc>
|
<assembly>
|
<name>JWT</name>
|
</assembly>
|
<members>
|
<member name="P:JWT.Algorithms.CertificateAlgorithm`1.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.CertificateAlgorithm`1.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.CertificateAlgorithm`1.Sign(System.Byte[],System.Byte[])">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.CertificateAlgorithm`1.Sign(System.Byte[])">
|
<summary>
|
Signs the provided byte array with the private key.
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.CertificateAlgorithm`1.Verify(System.Byte[],System.Byte[])">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.DelegateAlgorithmFactory">
|
<summary>
|
Implements <see href="IAlgorithmFactory" /> by returning the supplied <see href="IJwtAlgorithm" /> while ignoring parameters.
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.DelegateAlgorithmFactory.#ctor(System.Func{JWT.JwtDecoderContext,JWT.Algorithms.IJwtAlgorithm})">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.DelegateAlgorithmFactory" /> with supplied delegate to an algorithm with a context.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Algorithms.DelegateAlgorithmFactory.#ctor(System.Func{JWT.Algorithms.IJwtAlgorithm})">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.DelegateAlgorithmFactory" /> with supplied delegate to an algorithm.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Algorithms.DelegateAlgorithmFactory.#ctor(JWT.Algorithms.IAlgorithmFactory)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.DelegateAlgorithmFactory" /> with supplied algorithm factory.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Algorithms.DelegateAlgorithmFactory.#ctor(JWT.Algorithms.IJwtAlgorithm)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.DelegateAlgorithmFactory" /> with supplied algorithm.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Algorithms.DelegateAlgorithmFactory.Create(JWT.JwtDecoderContext)">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.ECDSAAlgorithmFactory">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.GenericAlgorithmFactory`1.Create(JWT.JwtDecoderContext)">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.HMACSHA256Algorithm">
|
<summary>
|
HMAC using SHA-256
|
</summary>
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHA256Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHA256Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.HMACSHA384Algorithm">
|
<summary>
|
HMAC using SHA-384
|
</summary>
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHA384Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHA384Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.HMACSHA512Algorithm">
|
<summary>
|
HMAC using SHA-512
|
</summary>
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHA512Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHA512Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHAAlgorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.HMACSHAAlgorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.HMACSHAAlgorithm.Sign(System.Byte[],System.Byte[])">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.HMACSHAAlgorithmFactory">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.IAlgorithmFactory">
|
<summary>
|
Provides IJwtAlgorithms.
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.IAlgorithmFactory.Create(JWT.JwtDecoderContext)">
|
<summary>
|
Creates an AlgorithmFactory using the provided algorithm enum.
|
</summary>
|
<param name="context">The captured context during validation of JWT inside <see cref="T:JWT.JwtDecoder"/></param>
|
</member>
|
<member name="T:JWT.Algorithms.IAsymmetricAlgorithm">
|
<summary>
|
Represents an asymmetric algorithm to generate or validate JWT signature.
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.IAsymmetricAlgorithm.Verify(System.Byte[],System.Byte[])">
|
<summary>
|
Verifies provided byte array with provided signature.
|
</summary>
|
<param name="bytesToSign">The data to verify</param>
|
<param name="signature">The signature to verify with</param>
|
</member>
|
<member name="T:JWT.Algorithms.IJwtAlgorithm">
|
<summary>
|
Represents an algorithm to generate JWT signature.
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.IJwtAlgorithm.Sign(System.Byte[],System.Byte[])">
|
<summary>
|
Signs provided byte array with provided key.
|
</summary>
|
<param name="key">The key used to sign the data</param>
|
<param name="bytesToSign">The data to sign</param>
|
</member>
|
<member name="P:JWT.Algorithms.IJwtAlgorithm.Name">
|
<summary>
|
Gets algorithm name.
|
</summary>
|
</member>
|
<member name="P:JWT.Algorithms.IJwtAlgorithm.HashAlgorithmName">
|
<summary>
|
Gets name of the hashing algorithm (e.g. SHA-256/SHA-384/SHA-512).
|
</summary>
|
</member>
|
<member name="T:JWT.Algorithms.JwtAlgorithmExtensions">
|
<summary>
|
Extension methods for <seealso cref="T:JWT.Algorithms.IJwtAlgorithm" />
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.JwtAlgorithmExtensions.IsAsymmetric(JWT.Algorithms.IJwtAlgorithm)">
|
<summary>
|
Returns whether or not the algorithm is asymmetric.
|
</summary>
|
<param name="alg">The algorithm instance.</param>
|
</member>
|
<member name="T:JWT.Algorithms.JwtAlgorithmFactory">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.JwtAlgorithmFactory.Create(JWT.JwtDecoderContext)">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.JwtAlgorithmName">
|
<summary>
|
Enum representing the various Jwt Hash Algorithms.
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.HS256">
|
<summary>
|
HMAC using SHA-256
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.HS384">
|
<summary>
|
HMAC using SHA-384
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.HS512">
|
<summary>
|
HMAC using SHA-512
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.RS256">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-256
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.RS384">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-384
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.RS512">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-512
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.RS1024">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-1024
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.RS2048">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-2048
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.RS4096">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-4096
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.ES256">
|
<summary>
|
ECDSA using SHA-256
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.ES384">
|
<summary>
|
ECDSA using SHA-384
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.ES512">
|
<summary>
|
ECDSA using SHA-512
|
</summary>
|
</member>
|
<member name="F:JWT.Algorithms.JwtAlgorithmName.None">
|
<summary>
|
Algorithm used when no signing is wanted
|
</summary>
|
</member>
|
<member name="T:JWT.Algorithms.NoneAlgorithm">
|
<summary>
|
Implements the "None" algorithm.
|
</summary>
|
<see href="https://datatracker.ietf.org/doc/html/rfc7519#section-6">RFC-7519</see>
|
</member>
|
<member name="P:JWT.Algorithms.NoneAlgorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.NoneAlgorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.NoneAlgorithm.Sign(System.Byte[],System.Byte[])">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RS1024Algorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-1024
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RS1024Algorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS1024Algorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS1024Algorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS1024Algorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS1024Algorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="P:JWT.Algorithms.RS1024Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.RS1024Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RS2048Algorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-2048
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RS2048Algorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS2048Algorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS2048Algorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS2048Algorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS2048Algorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="P:JWT.Algorithms.RS2048Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.RS2048Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RS256Algorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-256
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RS256Algorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS256Algorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS256Algorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS256Algorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS256Algorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="P:JWT.Algorithms.RS256Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.RS256Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RS384Algorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-384
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RS384Algorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS384Algorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS384Algorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS384Algorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS384Algorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="P:JWT.Algorithms.RS384Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.RS384Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RS4096Algorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-4096
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RS4096Algorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS4096Algorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS4096Algorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS4096Algorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS4096Algorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="P:JWT.Algorithms.RS4096Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.RS4096Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RS512Algorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-512
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RS512Algorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS512Algorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS512Algorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RS512Algorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RS512Algorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="P:JWT.Algorithms.RS512Algorithm.Name">
|
<inheritdoc />
|
</member>
|
<member name="P:JWT.Algorithms.RS512Algorithm.HashAlgorithmName">
|
<inheritdoc />
|
</member>
|
<member name="T:JWT.Algorithms.RSAlgorithm">
|
<summary>
|
RSASSA-PKCS1-v1_5 using SHA-256
|
</summary>
|
</member>
|
<member name="M:JWT.Algorithms.RSAlgorithm.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RSAlgorithm" /> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RSAlgorithm.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RSAlgorithm" /> using the provided public key only.
|
</summary>
|
<remarks>
|
An instance created using this constructor can only be used for verifying the data, not for signing it.
|
</remarks>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RSAlgorithm.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
|
<summary>
|
Creates an instance using the provided certificate.
|
</summary>
|
<param name="cert">The certificate having a public key and an optional private key.</param>
|
</member>
|
<member name="T:JWT.Algorithms.RSAlgorithmFactory">
|
<inheritdoc />
|
</member>
|
<member name="M:JWT.Algorithms.RSAlgorithmFactory.#ctor(System.Func{System.Security.Cryptography.X509Certificates.X509Certificate2})">
|
<summary>
|
Creates an instance of the <see cref="T:JWT.Algorithms.RSAlgorithmFactory" /> class using the provided <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" />.
|
</summary>
|
<param name="certFactory">Func that returns <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> which will be used to instantiate <see cref="T:JWT.Algorithms.RS256Algorithm" /></param>
|
</member>
|
<member name="M:JWT.Algorithms.RSAlgorithmFactory.#ctor(System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RSAlgorithmFactory"/> using the provided public key only.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
</member>
|
<member name="M:JWT.Algorithms.RSAlgorithmFactory.#ctor(System.Security.Cryptography.RSA,System.Security.Cryptography.RSA)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Algorithms.RSAlgorithmFactory"/> using the provided pair of public and private keys.
|
</summary>
|
<param name="publicKey">The public key for verifying the data.</param>
|
<param name="privateKey">The private key for signing the data.</param>
|
</member>
|
<member name="T:JWT.Builder.ClaimName">
|
<summary>
|
All public claims of a JWT specified by IANA, see https://www.iana.org/assignments/jwt/jwt.xhtml
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.EnumExtensions.GetHeaderName(JWT.Builder.HeaderName)">
|
<summary>
|
Gets the string representation of a well-known header name enum
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.EnumExtensions.GetPublicClaimName(JWT.Builder.ClaimName)">
|
<summary>
|
Gets the string representation of a well-known claim name enum
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.EnumExtensions.GetDescription``1(``0)">
|
<summary>
|
Gets the value of the <see cref="T:System.ComponentModel.DescriptionAttribute" /> from the object.
|
</summary>
|
</member>
|
<member name="T:JWT.Builder.HeaderName">
|
<summary>
|
All predefined parameter names specified by RFC 7515, see https://tools.ietf.org/html/rfc7515
|
</summary>
|
</member>
|
<member name="T:JWT.Builder.JwtBuilder">
|
<summary>
|
Encode and decode JWT with Fluent API.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.Create">
|
<summary>
|
Creates a new instance of instance <see cref="T:JWT.Builder.JwtBuilder" />
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.AddHeader(JWT.Builder.HeaderName,System.Object)">
|
<summary>
|
Add header to the JWT.
|
</summary>
|
<param name="name">Well-known header name</param>
|
<param name="value">The value you want give to the header</param>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.AddHeader(System.String,System.Object)">
|
<summary>
|
Add header to the JWT.
|
</summary>
|
<remarks>This adds a non-standard header value.</remarks>
|
<param name="name">Header name</param>
|
<param name="value">The value you want give to the header</param>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.AddClaim(System.String,System.Object)">
|
<summary>
|
Adds claim to the JWT.
|
</summary>
|
<param name="name">Claim name</param>
|
<param name="value">Claim value</param>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithJsonSerializer(JWT.IJsonSerializer)">
|
<summary>
|
Sets JWT serializer.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithJsonSerializer(System.Func{JWT.IJsonSerializer})">
|
<summary>
|
Sets JWT serializer.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithJsonSerializerFactory(JWT.Serializers.IJsonSerializerFactory)">
|
<summary>
|
Sets JWT serializer factory.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithDateTimeProvider(JWT.IDateTimeProvider)">
|
<summary>
|
Sets custom datetime provider.
|
</summary>
|
<remarks>
|
If not set then default <see cref="T:JWT.UtcDateTimeProvider" /> will be used.
|
</remarks>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithEncoder(JWT.IJwtEncoder)">
|
<summary>
|
Sets JWT encoder.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithDecoder(JWT.IJwtDecoder)">
|
<summary>
|
Sets JWT decoder.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithValidator(JWT.IJwtValidator)">
|
<summary>
|
Sets JWT validator.
|
</summary>
|
<remarks>
|
Required to decode with verification.
|
</remarks>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithUrlEncoder(JWT.IBase64UrlEncoder)">
|
<summary>
|
Sets custom URL encoder.
|
</summary>
|
<remarks>
|
If not set then default <see cref="T:JWT.JwtBase64UrlEncoder" /> will be used.
|
</remarks>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithAlgorithmFactory(JWT.Algorithms.IAlgorithmFactory)">
|
<summary>
|
Sets JWT algorithm factory.
|
</summary>
|
<returns>Current builder instance.</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithAlgorithm(JWT.Algorithms.IJwtAlgorithm)">
|
<summary>
|
Sets JWT algorithm.
|
</summary>
|
<returns>Current builder instance.</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithSecret(System.String[])">
|
<summary>
|
Sets secrets.
|
</summary>
|
<remarks>
|
Required to create a new token that uses an symmetric algorithm such as <seealso cref="T:JWT.Algorithms.RS256Algorithm" />
|
</remarks>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithSecret(System.Byte[][])">
|
<summary>
|
Sets secrets.
|
</summary>
|
<remarks>
|
Required to create a new token that uses an symmetric algorithm such as <seealso cref="T:JWT.Algorithms.RS256Algorithm" />
|
</remarks>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.MustVerifySignature">
|
<summary>
|
Instructs to verify the JWT signature.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.DoNotVerifySignature">
|
<summary>
|
Instructs to do not verify the JWT signature.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithVerifySignature(System.Boolean)">
|
<summary>
|
Instructs whether to verify the JWT signature.
|
</summary>
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithValidationParameters(JWT.ValidationParameters)">
|
<summary>
|
Sets the JWT signature validation parameters.
|
</summary>
|
<param name="valParams">Parameters to be used for validation</param>
|
<exception cref="T:System.ArgumentNullException" />
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.WithValidationParameters(System.Action{JWT.ValidationParameters})">
|
<summary>
|
Sets the JWT signature validation parameters.
|
</summary>
|
<param name="action">Delegate to produce parameters to be used for validation</param>
|
<exception cref="T:System.ArgumentNullException" />
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.Encode">
|
<summary>
|
Encodes a token using the supplied dependencies.
|
</summary>
|
<returns>The generated JWT</returns>
|
<exception cref="T:System.InvalidOperationException" />
|
<returns>Current builder instance</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.Decode(System.String)">
|
<summary>
|
Decodes a token using the supplied dependencies.
|
</summary>
|
<param name="token">The JWT</param>
|
<returns>The JSON payload</returns>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.DecodeHeader(System.String)">
|
<summary>
|
Given a JWT, decodes it and return the header.
|
</summary>
|
<param name="token">The JWT</param>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.DecodeHeader``1(System.String)">
|
<summary>
|
Given a JWT, decodes it and return the header.
|
</summary>
|
<param name="token">The JWT</param>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.Decode``1(System.String)">
|
<summary>
|
Decodes a token using the supplied dependencies.
|
</summary>
|
<param name="token">The JWT</param>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.CanEncode">
|
<summary>
|
Checks whether enough dependencies were supplied to encode a new token.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilder.CanDecode">
|
<summary>
|
Checks whether enough dependencies were supplied to decode a token.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilderExtensions.AddClaim(JWT.Builder.JwtBuilder,JWT.Builder.ClaimName,System.Object)">
|
<summary>
|
Adds well-known claim to the JWT.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilderExtensions.AddClaim``1(JWT.Builder.JwtBuilder,JWT.Builder.ClaimName,``0)">
|
<summary>
|
Adds well-known claim to the JWT.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilderExtensions.AddClaim``1(JWT.Builder.JwtBuilder,System.String,``0)">
|
<summary>
|
Adds well-known claim to the JWT.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtBuilderExtensions.AddClaims(JWT.Builder.JwtBuilder,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
|
<summary>
|
Adds several claims to the JWT
|
</summary>
|
</member>
|
<member name="T:JWT.Builder.JwtData">
|
<summary>
|
Represents the Data that will store in a JWT.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtData.#ctor">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.Builder.JwtData" /> with empty Header and Payload.
|
</summary>
|
</member>
|
<member name="M:JWT.Builder.JwtData.#ctor(System.Collections.Generic.IDictionary{System.String,System.Object})">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.Builder.JwtData" />
|
</summary>
|
<param name="payload">Dictionary that contains the payload</param>
|
</member>
|
<member name="M:JWT.Builder.JwtData.#ctor(System.Collections.Generic.IDictionary{System.String,System.Object},System.Collections.Generic.IDictionary{System.String,System.Object})">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.Builder.JwtData" />
|
</summary>
|
<param name="header">Dictionary that contains the headers</param>
|
<param name="payload">Dictionary that contains the payload</param>
|
</member>
|
<member name="M:JWT.Builder.JwtData.#ctor(System.String)">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.Builder.JwtData" />
|
</summary>
|
<param name="token">The JWT token</param>
|
</member>
|
<member name="P:JWT.Builder.JwtData.Header">
|
<summary>
|
The header information as a key-value store of the JWT
|
</summary>
|
</member>
|
<member name="P:JWT.Builder.JwtData.Payload">
|
<summary>
|
The payload of the JWT as a key-value store
|
</summary>
|
</member>
|
<member name="T:JWT.Builder.JwtHeader">
|
<summary>
|
JSON header model with predefined parameter names specified by RFC 7515, see https://tools.ietf.org/html/rfc7515
|
</summary>
|
</member>
|
<member name="T:JWT.Exceptions.InvalidTokenPartsException">
|
<summary>
|
Represents an exception thrown when a token doesn't consist of 3 delimited by dot parts.
|
</summary>
|
</member>
|
<member name="M:JWT.Exceptions.InvalidTokenPartsException.#ctor(System.String)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</summary>
|
<param name="paramName">The name of the parameter that caused the exception</param>
|
</member>
|
<member name="T:JWT.Exceptions.SignatureVerificationException">
|
<summary>
|
Represents an exception thrown when a signature validation fails.
|
</summary>
|
</member>
|
<member name="M:JWT.Exceptions.SignatureVerificationException.#ctor(System.String)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Exceptions.SignatureVerificationException" />
|
</summary>
|
<param name="message">The error message</param>
|
</member>
|
<member name="P:JWT.Exceptions.SignatureVerificationException.Expected">
|
<summary>
|
Expected key.
|
</summary>
|
</member>
|
<member name="P:JWT.Exceptions.SignatureVerificationException.Received">
|
<summary>
|
Received key.
|
</summary>
|
</member>
|
<member name="M:JWT.Exceptions.SignatureVerificationException.GetOrDefault``1(System.String)">
|
<summary>
|
Retrieves the value for the provided key, or default.
|
</summary>
|
<typeparam name="T"></typeparam>
|
<param name="key">The key</param>
|
<returns></returns>
|
</member>
|
<member name="T:JWT.Exceptions.TokenExpiredException">
|
<summary>
|
Represents an exception thrown when when a token is expired.
|
</summary>
|
</member>
|
<member name="M:JWT.Exceptions.TokenExpiredException.#ctor(System.String)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Exceptions.TokenExpiredException" />
|
</summary>
|
<param name="message">The error message</param>
|
</member>
|
<member name="P:JWT.Exceptions.TokenExpiredException.PayloadData">
|
<summary>
|
The payload.
|
</summary>
|
</member>
|
<member name="P:JWT.Exceptions.TokenExpiredException.Expiration">
|
<summary>
|
The expiration DateTime of the token.
|
</summary>
|
</member>
|
<member name="T:JWT.Exceptions.TokenNotYetValidException">
|
<summary>
|
Represents an exception thrown when a token is not yet valid.
|
</summary>
|
</member>
|
<member name="M:JWT.Exceptions.TokenNotYetValidException.#ctor(System.String)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
</summary>
|
<param name="message">The error message</param>
|
</member>
|
<member name="P:JWT.Exceptions.TokenNotYetValidException.PayloadData">
|
<summary>
|
The payload.
|
</summary>
|
</member>
|
<member name="P:JWT.Exceptions.TokenNotYetValidException.NotBefore">
|
<summary>
|
The not before DateTime of the token.
|
</summary>
|
</member>
|
<member name="T:JWT.IBase64UrlEncoder">
|
<summary>
|
Represents a base64 encoder/decoder.
|
</summary>
|
</member>
|
<member name="M:JWT.IBase64UrlEncoder.Encode(System.Byte[])">
|
<summary>
|
Encodes the byte array to a base64 string.
|
</summary>
|
</member>
|
<member name="M:JWT.IBase64UrlEncoder.Decode(System.String)">
|
<summary>
|
Decodes the base64 string to a byte array.
|
</summary>
|
</member>
|
<member name="T:JWT.IDateTimeProvider">
|
<summary>
|
Represents a DateTime provider.
|
</summary>
|
</member>
|
<member name="M:JWT.IDateTimeProvider.GetNow">
|
<summary>
|
Gets the current DateTime.
|
</summary>
|
</member>
|
<member name="T:JWT.IJsonSerializer">
|
<summary>
|
Provides JSON Serialize and Deserialize. Allows custom serializers used.
|
</summary>
|
</member>
|
<member name="M:JWT.IJsonSerializer.Serialize(System.Object)">
|
<summary>
|
Serializes an object to a JSON string.
|
</summary>
|
<param name="obj">The object to serialize.</param>
|
<returns>JSON string</returns>
|
</member>
|
<member name="M:JWT.IJsonSerializer.Deserialize(System.Type,System.String)">
|
<summary>
|
Deserializes a JSON string to an object of specified type.
|
</summary>
|
<param name="type">The type of the object to deserialize to.</param>
|
<param name="json">The JSON string deserialize.</param>
|
<returns>Strongly-typed object.</returns>
|
</member>
|
<member name="T:JWT.JsonSerializerExtensions">
|
<summary>
|
Extension methods for <seealso cref="T:JWT.IJsonSerializer" />
|
</summary>
|
</member>
|
<member name="M:JWT.JsonSerializerExtensions.Deserialize``1(JWT.IJsonSerializer,System.String)">
|
<summary>
|
Deserializes a JSON string to an object of specified type.
|
</summary>
|
<typeparam name="T">The type of the object to deserialize to.</typeparam>
|
<param name="jsonSerializer">The JSON serializer instance.</param>
|
<param name="json">JSON string</param>
|
<returns>Strongly-typed object.</returns>
|
</member>
|
<member name="T:JWT.IJwtDecoder">
|
<summary>
|
Represents a JWT decoder.
|
</summary>
|
</member>
|
<member name="M:JWT.IJwtDecoder.DecodeHeader(System.String)">
|
<summary>
|
Given a JWT, decodes it and return the header.
|
</summary>
|
<param name="token">The JWT</param>
|
</member>
|
<member name="M:JWT.IJwtDecoder.DecodeHeader``1(JWT.JwtParts)">
|
<summary>
|
Given a JWT, decodes it and return the header as an object.
|
</summary>
|
<param name="jwt">The JWT</param>
|
</member>
|
<member name="M:JWT.IJwtDecoder.Decode(JWT.JwtParts,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload.
|
</summary>
|
<param name="jwt">The JWT</param>
|
<param name="verify">Whether to verify the signature (default is true)</param>
|
<returns>A string containing the JSON payload</returns>
|
</member>
|
<member name="M:JWT.IJwtDecoder.Decode(JWT.JwtParts,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload.
|
</summary>
|
<param name="jwt">The JWT</param>
|
<param name="key">The key that were used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is true)</param>
|
<returns>A string containing the JSON payload</returns>
|
</member>
|
<member name="M:JWT.IJwtDecoder.Decode(JWT.JwtParts,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload.
|
</summary>
|
<param name="jwt">The JWT</param>
|
<param name="keys">The keys provided which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is true)</param>
|
<returns>A string containing the JSON payload</returns>
|
</member>
|
<member name="M:JWT.IJwtDecoder.DecodeToObject(System.Type,JWT.JwtParts,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<param name="type">The type to deserialize to.</param>
|
<param name="jwt">The JWT</param>
|
<param name="verify">Whether to verify the signature (default is true)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.IJwtDecoder.DecodeToObject(System.Type,JWT.JwtParts,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<param name="type">The type to deserialize to.</param>
|
<param name="jwt">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is true)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.IJwtDecoder.DecodeToObject(System.Type,JWT.JwtParts,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<param name="type">The type to deserialize to.</param>
|
<param name="jwt">The JWT</param>
|
<param name="keys">The keys which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is true)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="T:JWT.JwtDecoderExtensions">
|
<summary>
|
Extension methods for <seealso cref="T:JWT.IJwtDecoder" />>
|
</summary>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.Decode(JWT.IJwtDecoder,System.String,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>A string containing the JSON payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.Decode(JWT.IJwtDecoder,System.String,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it, and return the payload.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>A string containing the JSON payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.Decode(JWT.IJwtDecoder,System.String,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it, and return the payload.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The keys that were used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>A string containing the JSON payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.Decode(JWT.IJwtDecoder,System.String,System.String,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it, and return the payload as an dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.Decode(JWT.IJwtDecoder,System.String,System.String[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it, and return the payload as an dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The key which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.String,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.String,System.String,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.String,System.String[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The keys provided which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.String,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
<exception cref = "T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.String,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The keys that were used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>A string containing the JSON payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.Type,System.String,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="type">The type to deserialize to.</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
<exception cref = "T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.Type,System.String,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as a dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="type">The type to deserialize to.</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The keys that were used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>A string containing the JSON payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.Type,System.String,System.String,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="type">The type to deserialize to.</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject(JWT.IJwtDecoder,System.Type,System.String,System.String[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an dictionary.
|
</summary>
|
<param name="decoder">The decoder instance</param>
|
<param name="type">The type to deserialize to.</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The key which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,JWT.JwtParts,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to deserialize to.</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="jwt">The JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,JWT.JwtParts,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to deserialize to.</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="jwt">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,JWT.JwtParts,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to deserialize to.</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="jwt">The JWT</param>
|
<param name="keys">The keys which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,System.String)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to return</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,System.String,System.String,System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to return</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,System.String,System.Byte[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to return</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,System.String,System.Byte[][],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to return</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The keys provided which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="M:JWT.JwtDecoderExtensions.DecodeToObject``1(JWT.IJwtDecoder,System.String,System.String[],System.Boolean)">
|
<summary>
|
Given a JWT, decodes it and return the payload as an object.
|
</summary>
|
<typeparam name="T">The type to return</typeparam>
|
<param name="decoder">The decoder instance</param>
|
<param name="token">The JWT</param>
|
<param name="keys">The keys provided which one of them was used to sign the JWT</param>
|
<param name="verify">Whether to verify the signature (default is <c>true</c>)</param>
|
<returns>An object representing the payload</returns>
|
</member>
|
<member name="T:JWT.IJwtEncoder">
|
<summary>
|
Represents a JWT encoder.
|
</summary>
|
</member>
|
<member name="M:JWT.IJwtEncoder.Encode(System.Collections.Generic.IDictionary{System.String,System.Object},System.Object,System.Byte[])">
|
<summary>
|
Creates a JWT given a header, a payload, the signing key, and the algorithm to use.
|
</summary>
|
<param name="extraHeaders">An arbitrary set of extra headers. Will be augmented with the standard "typ" and "alg" headers</param>
|
<param name="payload">An arbitrary payload (must be serializable to JSON)</param>
|
<param name="key">The key bytes used to sign the token</param>
|
<returns>The generated JWT</returns>
|
</member>
|
<member name="T:JWT.JwtEncoderExtensions">
|
<summary>
|
Extension methods for <seealso cref="T:JWT.IJwtEncoder" />
|
</summary>
|
</member>
|
<member name="M:JWT.JwtEncoderExtensions.Encode(JWT.IJwtEncoder,System.Object,System.String)">
|
<summary>
|
Creates a JWT given a payload, the signing key, and the algorithm to use.
|
</summary>
|
<param name="encoder">The encoder instance</param>
|
<param name="payload">An arbitrary payload (must be serializable to JSON)</param>
|
<param name="key">The key used to sign the token</param>
|
<returns>The generated JWT</returns>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.JwtEncoderExtensions.Encode(JWT.IJwtEncoder,System.Object,System.Byte[])">
|
<summary>
|
Creates a JWT given a payload, the signing key, and the algorithm to use.
|
</summary>
|
<param name="encoder">The encoder instance</param>
|
<param name="payload">An arbitrary payload (must be serializable to JSON)</param>
|
<param name="key">The key used to sign the token</param>
|
<returns>The generated JWT</returns>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.JwtEncoderExtensions.Encode(JWT.IJwtEncoder,System.Collections.Generic.IDictionary{System.String,System.Object},System.Object,System.String)">
|
<summary>
|
Creates a JWT given a set of arbitrary extra headers, a payload, the signing key, and the algorithm to use.
|
</summary>
|
<param name="encoder">The encoder instance</param>
|
<param name="extraHeaders">An arbitrary set of extra headers. Will be augmented with the standard "typ" and "alg" headers</param>
|
<param name="payload">An arbitrary payload (must be serializable to JSON)</param>
|
<param name="key">The key bytes used to sign the token</param>
|
<returns>The generated JWT</returns>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="T:JWT.IJwtValidator">
|
<summary>
|
Represents a JWT validator.
|
</summary>
|
</member>
|
<member name="M:JWT.IJwtValidator.Validate(System.String,System.String,System.String[])">
|
<summary>
|
Given the JWT, verifies its signature correctness.
|
</summary>
|
<param name="decodedPayload">>An arbitrary payload (already serialized to JSON)</param>
|
<param name="signature">Decoded body</param>
|
<param name="decodedSignatures">The signatures to validate with</param>
|
</member>
|
<member name="M:JWT.IJwtValidator.Validate(System.String,JWT.Algorithms.IAsymmetricAlgorithm,System.Byte[],System.Byte[])">
|
<summary>
|
Given the JWT, verifies its signature correctness.
|
</summary>
|
<remarks>
|
Used by the asymmetric algorithms only.
|
</remarks>
|
<param name="decodedPayload">>An arbitrary payload (already serialized to JSON)</param>
|
<param name="alg">The asymmetric algorithm to validate with</param>
|
<param name="bytesToSign">The header and payload bytes to validate</param>
|
<param name="decodedSignature">The signature to validate with</param>
|
</member>
|
<member name="M:JWT.IJwtValidator.TryValidate(System.String,System.String,System.String,System.Exception@)">
|
<summary>
|
Given the JWT, verifies its signature correctness without throwing an exception but returning it instead.
|
</summary>
|
<param name="payloadJson">>An arbitrary payload (already serialized to JSON)</param>
|
<param name="signature">Decoded body</param>
|
<param name="decodedSignature">The signature to validate with</param>
|
<param name="ex">The resulting validation exception, if any</param>
|
<returns>Returns <c>true</c> if exception is JWT is valid and exception is null, otherwise false</returns>
|
</member>
|
<member name="M:JWT.IJwtValidator.TryValidate(System.String,System.String,System.String[],System.Exception@)">
|
<summary>
|
Given the JWT, verifies its signature correctness without throwing an exception but returning it instead.
|
</summary>
|
<param name="payloadJson">>An arbitrary payload (already serialized to JSON)</param>
|
<param name="signature">Decoded body</param>
|
<param name="decodedSignature">The signatures to validate with</param>
|
<param name="ex">The resulting validation exception, if any</param>
|
<returns>Returns <c>true</c> if exception is JWT is valid and exception is null, otherwise false</returns>
|
</member>
|
<member name="M:JWT.IJwtValidator.TryValidate(System.String,JWT.Algorithms.IAsymmetricAlgorithm,System.Byte[],System.Byte[],System.Exception@)">
|
<summary>
|
Given the JWT, verifies its signatures correctness without throwing an exception but returning it instead.
|
</summary>
|
<param name="payloadJson">>An arbitrary payload (already serialized to JSON)</param>
|
<param name="alg">The asymmetric algorithm to validate with</param>
|
<param name="bytesToSign">The header and payload bytes to validate</param>
|
<param name="decodedSignature">The decodedSignatures to validate with</param>
|
<param name="ex">Validation exception, if any</param>
|
<returns>True if exception is JWT is valid and exception is null, otherwise false</returns>
|
</member>
|
<member name="T:JWT.JwtBase64UrlEncoder">
|
<summary>
|
base64 encoding/decoding implementation according to the JWT spec
|
</summary>
|
</member>
|
<member name="M:JWT.JwtBase64UrlEncoder.Encode(System.Byte[])">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="M:JWT.JwtBase64UrlEncoder.Decode(System.String)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.FormatException" />
|
</member>
|
<member name="T:JWT.JwtDecoder">
|
<summary>
|
Decodes JWT.
|
</summary>
|
</member>
|
<member name="M:JWT.JwtDecoder.#ctor(JWT.IJsonSerializer,JWT.IBase64UrlEncoder)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtDecoder" />
|
</summary>
|
<remarks>
|
This overload supplies no <see cref="T:JWT.IJwtValidator" /> and no <see cref="T:JWT.Algorithms.IAlgorithmFactory" /> so the resulting decoder cannot be used for signature validation.
|
</remarks>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="urlEncoder">The base64 URL encoder</param>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.#ctor(JWT.IJsonSerializer,JWT.IJwtValidator,JWT.IBase64UrlEncoder,JWT.Algorithms.IAlgorithmFactory)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtDecoder" />
|
</summary>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="jwtValidator">The JWT validator</param>
|
<param name="urlEncoder">The base64 URL encoder</param>
|
<param name="algFactory">The JWT algorithm Factory</param>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.#ctor(JWT.IJsonSerializer,JWT.IJwtValidator,JWT.IBase64UrlEncoder,JWT.Algorithms.IJwtAlgorithm)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtDecoder" />
|
</summary>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="jwtValidator">The JWT validator</param>
|
<param name="urlEncoder">The base64 URL encoder</param>
|
<param name="algorithm">The JWT algorithm</param>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.DecodeHeader(System.String)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
<exception cref="T:System.FormatException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.DecodeHeader``1(JWT.JwtParts)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.FormatException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.Decode(JWT.JwtParts,System.Boolean)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.Decode(JWT.JwtParts,System.Byte[],System.Boolean)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:JWT.Exceptions.InvalidTokenPartsException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.Decode(JWT.JwtParts,System.Byte[][],System.Boolean)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.DecodeToObject(System.Type,JWT.JwtParts,System.Boolean)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.DecodeToObject(System.Type,JWT.JwtParts,System.Byte[],System.Boolean)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.DecodeToObject(System.Type,JWT.JwtParts,System.Byte[][],System.Boolean)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.Validate(System.String[],System.Byte[])">
|
<summary>
|
Prepares data before calling <see cref="T:JWT.IJwtValidator" />
|
</summary>
|
<param name="parts">The array representation of a JWT</param>
|
<param name="key">The key that was used to sign the JWT</param>
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.Validate(System.String[],System.Byte[][])">
|
<summary>
|
Prepares data before calling <see cref="T:JWT.IJwtValidator" />
|
</summary>
|
<param name="parts">The array representation of a JWT</param>
|
<param name="keys">The keys provided which one of them was used to sign the JWT</param>
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtDecoder.Validate(JWT.JwtParts,System.Byte[][])">
|
<summary>
|
Prepares data before calling <see cref="T:JWT.IJwtValidator" />
|
</summary>
|
<param name="jwt">The JWT parts</param>
|
<param name="keys">The keys provided which one of them was used to sign the JWT</param>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
<exception cref="T:System.FormatException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenNotYetValidException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="P:JWT.JwtDecoderContext.Token">
|
<summary>
|
Unmodified JWT.
|
</summary>
|
</member>
|
<member name="P:JWT.JwtDecoderContext.Header">
|
<summary>
|
Deserialized JWT header.
|
</summary>
|
</member>
|
<member name="P:JWT.JwtDecoderContext.Payload">
|
<summary>
|
Decoded JWT payload.
|
</summary>
|
</member>
|
<member name="T:JWT.JwtEncoder">
|
<summary>
|
Encodes Jwt.
|
</summary>
|
</member>
|
<member name="M:JWT.JwtEncoder.#ctor(JWT.Algorithms.IAlgorithmFactory,JWT.IJsonSerializer,JWT.IBase64UrlEncoder)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtEncoder" />
|
</summary>
|
<param name="algFactory">The JWT algorithm factory</param>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="urlEncoder">The base64 URL encoder</param>
|
</member>
|
<member name="M:JWT.JwtEncoder.#ctor(JWT.Algorithms.IJwtAlgorithm,JWT.IJsonSerializer,JWT.IBase64UrlEncoder)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtEncoder" />
|
</summary>
|
<param name="algorithm">The JWT algorithm</param>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="urlEncoder">The base64 URL encoder</param>
|
</member>
|
<member name="M:JWT.JwtEncoder.Encode(System.Collections.Generic.IDictionary{System.String,System.Object},System.Object,System.Byte[])">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="T:JWT.JwtParts">
|
<summary>
|
Represent the parts of a JWT
|
</summary>
|
</member>
|
<member name="M:JWT.JwtParts.#ctor(System.String)">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.JwtParts" /> from the string representation of a JWT
|
</summary>
|
<param name="token">The string representation of a JWT</param>
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="M:JWT.JwtParts.#ctor(System.String[])">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.JwtParts" /> from the array representation of a JWT
|
</summary>
|
<param name="parts">The array representation of a JWT</param>
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentOutOfRangeException" />
|
</member>
|
<member name="P:JWT.JwtParts.Header">
|
<summary>
|
Gets the Header part of a JWT
|
</summary>
|
</member>
|
<member name="P:JWT.JwtParts.Payload">
|
<summary>
|
Gets the Payload part of a JWT
|
</summary>
|
</member>
|
<member name="P:JWT.JwtParts.Signature">
|
<summary>
|
Gets the Signature part of a JWT
|
</summary>
|
</member>
|
<member name="P:JWT.JwtParts.Parts">
|
<summary>
|
Gets the parts of a JWT
|
</summary>
|
</member>
|
<member name="T:JWT.JwtParts.JwtPartsIndex">
|
<summary>
|
Helper enum to get the correct part from the array representation of a JWT parts
|
</summary>
|
</member>
|
<member name="T:JWT.JwtValidator">
|
<summary>
|
Jwt validator.
|
</summary>
|
</member>
|
<member name="M:JWT.JwtValidator.#ctor(JWT.IJsonSerializer,JWT.IDateTimeProvider)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtValidator" />
|
</summary>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="dateTimeProvider">The DateTime provider</param>
|
</member>
|
<member name="M:JWT.JwtValidator.#ctor(JWT.IJsonSerializer,JWT.IDateTimeProvider,JWT.ValidationParameters)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtValidator" /> with time margin
|
</summary>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="dateTimeProvider">The DateTime provider</param>
|
<param name="valParams">Validation parameters that are passed on to <see cref="T:JWT.JwtValidator"/></param>
|
</member>
|
<member name="M:JWT.JwtValidator.#ctor(JWT.IJsonSerializer,JWT.IDateTimeProvider,JWT.ValidationParameters,JWT.IBase64UrlEncoder)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.JwtValidator" /> with time margin
|
</summary>
|
<param name="jsonSerializer">The JSON serializer</param>
|
<param name="dateTimeProvider">The DateTime provider</param>
|
<param name="valParams">Validation parameters that are passed on to <see cref="T:JWT.JwtValidator"/></param>
|
<param name="urlEncoder">The base64 URL Encoder</param>
|
</member>
|
<member name="M:JWT.JwtValidator.Validate(System.String,System.String,System.String[])">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
</member>
|
<member name="M:JWT.JwtValidator.Validate(System.String,JWT.Algorithms.IAsymmetricAlgorithm,System.Byte[],System.Byte[])">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
</member>
|
<member name="M:JWT.JwtValidator.TryValidate(System.String,System.String,System.String,System.Exception@)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
</member>
|
<member name="M:JWT.JwtValidator.TryValidate(System.String,System.String,System.String[],System.Exception@)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
</member>
|
<member name="M:JWT.JwtValidator.TryValidate(System.String,JWT.Algorithms.IAsymmetricAlgorithm,System.Byte[],System.Byte[],System.Exception@)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentException" />
|
</member>
|
<member name="M:JWT.JwtValidator.CompareCryptoWithSignature(System.String,System.String)">
|
<remarks>In the future this method can be opened for extension hence made protected virtual</remarks>
|
</member>
|
<member name="M:JWT.JwtValidator.ValidateExpClaim(System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Double)">
|
<summary>
|
Verifies the 'exp' claim.
|
</summary>
|
<remarks>See https://tools.ietf.org/html/rfc7519#section-4.1.4</remarks>
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
<exception cref="T:JWT.Exceptions.TokenExpiredException" />
|
</member>
|
<member name="M:JWT.JwtValidator.ValidateNbfClaim(System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Double)">
|
<summary>
|
Verifies the 'nbf' claim.
|
</summary>
|
<remarks>See https://tools.ietf.org/html/rfc7519#section-4.1.5</remarks>
|
<exception cref="T:JWT.Exceptions.SignatureVerificationException" />
|
</member>
|
<member name="M:JWT.Serializers.DelegateJsonSerializerFactory.#ctor(JWT.IJsonSerializer)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Serializers.DelegateJsonSerializerFactory" /> with supplied JSON serializer.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Serializers.DelegateJsonSerializerFactory.#ctor(JWT.Serializers.IJsonSerializerFactory)">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Serializers.DelegateJsonSerializerFactory" /> with supplied serializer JSON serializer factory.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Serializers.DelegateJsonSerializerFactory.#ctor(System.Func{JWT.IJsonSerializer})">
|
<summary>
|
Creates an instance of <see cref="T:JWT.Serializers.DelegateJsonSerializerFactory" /> with supplied delegate to a JSON serializer.
|
</summary>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="T:JWT.Serializers.JsonNetSerializer">
|
<summary>
|
JSON serializer using Newtonsoft.Json implementation.
|
</summary>
|
</member>
|
<member name="M:JWT.Serializers.JsonNetSerializer.#ctor">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.Serializers.JsonNetSerializer" />
|
</summary>
|
<remarks>Uses <see cref="M:Newtonsoft.Json.JsonSerializer.CreateDefault" /> as internal serializer</remarks>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Serializers.JsonNetSerializer.#ctor(Newtonsoft.Json.JsonSerializer)">
|
<summary>
|
Creates a new instance of <see cref="T:JWT.Serializers.JsonNetSerializer" />
|
</summary>
|
<param name="serializer">Internal <see cref="T:Newtonsoft.Json.JsonSerializer" /> to use for serialization</param>
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Serializers.JsonNetSerializer.Serialize(System.Object)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentNullException" />
|
</member>
|
<member name="M:JWT.Serializers.JsonNetSerializer.Deserialize(System.Type,System.String)">
|
<inheritdoc />
|
<exception cref="T:System.ArgumentNullException" />
|
<exception cref="T:System.ArgumentException" />
|
</member>
|
<member name="P:JWT.UnixEpoch.Value">
|
<summary>
|
Describes a point in time, defined as the number of seconds that have elapsed since 00:00:00 UTC, Thursday, 1 January 1970, not counting leap seconds.
|
See https://en.wikipedia.org/wiki/Unix_time />
|
</summary>
|
</member>
|
<member name="T:JWT.UtcDateTimeProvider">
|
<summary>
|
Provider for UTC DateTime.
|
</summary>
|
</member>
|
<member name="M:JWT.UtcDateTimeProvider.GetNow">
|
<summary>
|
Retuns the current time (UTC).
|
</summary>
|
<returns></returns>
|
</member>
|
<member name="T:JWT.ValidationParameters">
|
<summary>
|
Contains a set of parameters that are used by a <see cref="T:JWT.JwtValidator" /> when validating a token.
|
</summary>
|
</member>
|
<member name="M:JWT.ValidationParameters.#ctor">
|
<remarks>
|
By default, all peroperties are set to <c>true</c> to ensure validation is enabled.
|
Use <see cref="P:JWT.ValidationParameters.Default"/> if you'd like to set all properties set to <see langword="true" />
|
or use <see cref="P:JWT.ValidationParameters.None"/> if you'd like to set all properties set to <see langword="false" />.
|
</remarks>>
|
</member>
|
<member name="P:JWT.ValidationParameters.ValidateSignature">
|
<summary>
|
Gets or sets whether to validate the validity of the token's signature.
|
</summary>
|
</member>
|
<member name="P:JWT.ValidationParameters.ValidateExpirationTime">
|
<summary>
|
Gets or sets whether to validate the validity of the token's expiration time.
|
</summary>
|
</member>
|
<member name="P:JWT.ValidationParameters.ValidateIssuedTime">
|
<summary>
|
Gets or sets whether to validate the validity of the token's issued time.
|
</summary>
|
</member>
|
<member name="P:JWT.ValidationParameters.TimeMargin">
|
<summary>
|
Gets or sets the time margin in seconds for exp and nbf during token validation.
|
</summary>
|
</member>
|
<member name="P:JWT.ValidationParameters.Default">
|
<summary>
|
Returns a <see cref="T:JWT.ValidationParameters" /> with all properties set to <see langword="true" />.
|
</summary>
|
</member>
|
<member name="P:JWT.ValidationParameters.None">
|
<summary>
|
Returns a <see cref="T:JWT.ValidationParameters" /> with all properties set to <see langword="false" />.
|
</summary>
|
</member>
|
</members>
|
</doc>
|
