Show / Hide Table of Contents

    Class HmacAuthenticationOptions

    Configuration options for HmacAuthenticationMiddleware. This class cannot be inherited.

    Inheritance
    System.Object
    AuthenticationOptions
    HmacAuthenticationOptions
    Inherited Members
    AuthenticationOptions.RequireSecureConnection
    AuthenticationOptions.HttpNotAuthorizedBody
    Namespace: Cuemon.AspNetCore.Authentication
    Assembly: Cuemon.AspNetCore.Authentication.dll
    Syntax
    public sealed class HmacAuthenticationOptions : AuthenticationOptions

    Constructors

    | Improve this Doc

    HmacAuthenticationOptions()

    Initializes a new instance of the HmacAuthenticationOptions class.

    Declaration
    public HmacAuthenticationOptions()

    Properties

    | Improve this Doc

    Algorithm

    Gets or sets the algorithm of the HMAC Authentication. Default is SHA1.

    Declaration
    public HmacAlgorithmType Algorithm { get; set; }
    Property Value
    Type Description
    HmacAlgorithmType

    The algorithm of the HMAC Authentication.

    | Improve this Doc

    AuthenticationScheme

    Gets the name of the authentication scheme. Default is "HMAC".

    Declaration
    public string AuthenticationScheme { get; set; }
    Property Value
    Type Description
    System.String

    The name of the authentication scheme.

    | Improve this Doc

    Authenticator

    Gets or sets the function delegate that will perform the authentication from the specified publicKey.

    Declaration
    public HmacAuthenticator Authenticator { get; set; }
    Property Value
    Type Description
    HmacAuthenticator

    The function delegate that will perform the authentication.

    | Improve this Doc

    HmacSigner

    Gets or sets the function delegate that will sign a message retrieved by MessageDescriptor.

    Declaration
    public Func<HmacAuthenticationParameters, byte[]> HmacSigner { get; set; }
    Property Value
    Type Description
    System.Func<HmacAuthenticationParameters, System.Byte[]>

    The function delegate that will sign a message.

    | Improve this Doc

    MessageDescriptor

    Gets or sets the function delegate that provides information about the message to be signed.

    Declaration
    public Func<HttpContext, string> MessageDescriptor { get; set; }
    Property Value
    Type Description
    System.Func<Microsoft.AspNetCore.Http.HttpContext, System.String>

    The function delegate that provides information about the message to be signed.

    Extension Methods

    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Action<TimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Action<TimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Byte[], Action<ContentBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, Byte[]>, Action<ContentBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Byte[], Action<ContentTimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Func<T, Byte[]>, Action<ContentTimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, DateTime, Func<T, Byte[]>, Action<ContentTimeBasedOptions>)
    CacheableObjectResultExtensions.ToCacheableObjectResult<T>(T, Func<T, DateTime>, Byte[], Action<ContentTimeBasedOptions>)

    See Also

    AuthenticationOptions
    • Improve this Doc
    • View Source
    Back to top Copyright 2008-2018 Weubphoria. All rights reserved.
    Generated by DocFX