Show / Hide Table of Contents

Class ClientAuthenticator

Authenticate the OpenID client.

Inheritance
System.Object
ClientAuthenticator
Implements
IClientAuthenticator
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ComponentSpace.OpenID.Security
Assembly: ComponentSpace.OpenID.dll
Syntax
public class ClientAuthenticator : IClientAuthenticator

Constructors

ClientAuthenticator(IConfigurationResolver, ICache, IClientSecretVerifier, ITokenSecurity, IHttpContextAccessor, ILoggerFactory)

Initializes a new instance of the ClientAuthenticator class.

Declaration
public ClientAuthenticator(IConfigurationResolver configurationResolver, ICache cache, IClientSecretVerifier clientSecretVerifier, ITokenSecurity tokenSecurity, IHttpContextAccessor httpContextAccessor, ILoggerFactory loggerFactory)
Parameters
Type Name Description
IConfigurationResolver configurationResolver

The configuration resolver.

ICache cache

The cache.

IClientSecretVerifier clientSecretVerifier

The client secret verifier.

ITokenSecurity tokenSecurity

The token security.

Microsoft.AspNetCore.Http.IHttpContextAccessor httpContextAccessor

The HTTP context accessor.

Microsoft.Extensions.Logging.ILoggerFactory loggerFactory

The logger factory.

Methods

AuthenticateClientAsync(ProviderConfiguration, String, String, String, String, String, String[])

Authenticates the client.

Declaration
public virtual async Task<ClientAuthenticationResult> AuthenticateClientAsync(ProviderConfiguration providerConfiguration, string clientID, string clientSecret, string clientAssertionType, string clientAssertion, string validAudience, string[] authSigningAlgValuesSupported)
Parameters
Type Name Description
ProviderConfiguration providerConfiguration

The provider configuration.

System.String clientID

The client ID.

System.String clientSecret

The client secret.

System.String clientAssertionType

The client assertion type.

System.String clientAssertion

The client assertion.

System.String validAudience

The valid audience URL.

System.String[] authSigningAlgValuesSupported

The supported JWS signing algorithms (alg) used to authenticate the client.

Returns
Type Description
Task<ClientAuthenticationResult>

A task that represents the operation and returns the client authentication result.

Exceptions
Type Condition
OpenIDException

Thrown when the client cannot be authenticated.

Implements

IClientAuthenticator
In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2022. All rights reserved.