Microsoft.Bot.Connector.Authentication Namespace

Classes

AdalAuthenticator

An authentication class that implements IAuthenticator, used to authenticate requests against Azure.

AllowedCallersClaimsValidator

Claims validator that adds application level authorization based on a simple list of application Ids that are allowed to call.

AllowedSkillsClaimsValidator

A claims validator that loads an allowed list from a provided list of allowed AppIds and checks that responses are coming from configured skills.

AppCredentials

Base abstraction for AAD credentials for auth and caching.

AuthenticateRequestResult

The result from a call to authenticate a Bot Framework Protocol request.

AuthenticationConfiguration

General configuration settings for authentication.

AuthenticationConstants

Values and Constants used for Authentication and Authrization by the Bot Framework Protocol.

AuthenticatorResult

Represents the result of an authentication process. Includes a security token and its expiration time.

BotFrameworkAuthentication

Represents a Cloud Environment used to authenticate Bot Framework Protocol network calls within this environment.

BotFrameworkAuthenticationFactory

A factory for BotFrameworkAuthentication which encapsulate the environment specific Bot Framework Protocol auth code.

CertificateAppCredentials

CertificateAppCredentials auth implementation and cache.

CertificateAppCredentialsOptions

CertificateAppCredentials Options.

ChannelValidation

Validates JWT tokens sent from Azure.

ClaimsValidator

An interface used to validate identity Claim.

ConnectorFactory

A factory class used to create ConnectorClients with appropriate credentials for the current appId.

EmulatorValidation

Validates and Examines JWT tokens from the Bot Framework Emulator.

EndorsementsRetriever

The endorsements property within each key contains one or more endorsement strings which you can use to verify that the channel ID specified in the channelId property within the Activity object of the incoming request is authentic. More details at: https://docs.microsoft.com/bot-framework/rest-api/bot-framework-rest-connector-authentication.

EndorsementsValidator

Contains helper methods for verifying JWT endorsements.

EnterpriseChannelValidation

Validates JWT tokens from an enterprise channel.

GovernmentAuthenticationConstants

Values and Constants used for Authentication and Authorization by the Bot Framework Protocol to US Government DataCenters.

GovernmentChannelValidation

Valies JWT tokens from a Government channel.

JwtTokenExtractor

A JWT token processing class that gets identity information and performs security token validation.

JwtTokenProviderFactory

A factory that can create OAuth token providers for generating JWT auth tokens.

JwtTokenValidation

Contains helper methods for authenticating incoming HTTP requests.

ManagedIdentityAppCredentials

Managed Service Identity auth implementation.

ManagedIdentityAuthenticator

Abstraction to acquire tokens from a Managed Service Identity.

ManagedIdentityServiceClientCredentialsFactory

A Managed Identity implementation of the ServiceClientCredentialsFactory interface.

MicrosoftAppCredentials

MicrosoftAppCredentials auth implementation and cache.

MicrosoftGovernmentAppCredentials

MicrosoftGovernmentAppCredentials auth implementation.

MsalAppCredentials

An authentication class that implements IAuthenticator, used to acquire tokens for outgoing messages to the channels.

MsalServiceClientCredentialsFactory

Credential factory that uses MSAL to acquire tokens.

OAuthConfiguration

Configuration for OAuth client credential authentication.

PasswordServiceClientCredentialFactory

A simple implementation of the ServiceClientCredentialsFactory interface.

Retry

Retries asynchronous operations. In case of errors, it collects and returns exceptions in an AggregateException object.

RetryParams

Wrapper class that defines a retrying behavior.

ServiceClientCredentialsFactory

The ServiceClientCredentialsFactory abstract class to allows Bots to provide their own Microsoft.Rest.ServiceClientCredentials for bot to channel or skill bot to parent bot calls.

SimpleChannelProvider

A simple channel provider with basic configuration parameters to connect to a Bot Framework channel service.

SimpleCredentialProvider

A simple implementation of the ICredentialProvider interface.

SkillValidation

Validates JWT tokens sent to and from a Skill.

ThrottleException

Custom throttling exception.

TimeSpanExtensions

Extention methods for the TimeSpan class.

UserTokenClient

Client for access user token service.

Interfaces

IAuthenticator

Contract for authentication classes that retrieve authentication tokens.

IChannelProvider

ChannelProvider interface. This interface allows Bots to provide their own implementation for the configuration parameters to connect to a Bot. Framework channel service.

ICredentialProvider

CredentialProvider interface. This interface allows Bots to provide their own implementation of what is, and what is not, a valid appId and password. This is useful in the case of multi-tenant bots, where the bot may need to call out to a service to determine if a particular appid/password pair is valid.

For Single Tenant bots (the vast majority) the simple static providers are sufficient.

IJwtTokenProviderFactory

A factory that can create OAuth token providers for generating JWT auth tokens.

IServiceClientCredentialProvider

ServiceClientCredentialProvider interface. This interface allows Bots to provide their own proof of service identity for the purpose of making service calls from the bot to channels. The implementor should return ServiceClientCredentails from GetCredentials method.