package
18.0.0-dev.vnet-windows.4+incompatible
Repository: https://github.com/gravitational/teleport.git
Documentation: pkg.go.dev

# Functions

ContextWithMFAResponse embeds the MFA response in the context.
CredentialsFromContext can be called from a GRPC server method to return MFA credentials added to the GRPC metadata for requests that require MFA, like admin-level requests.
EncodeMFAChallengeResponseCredentials encodes the given MFA challenge response into a string.
MFAResponseFromContext returns the MFA response from the context.
PerformAdminActionMFACeremony retrieves an MFA challenge from the server for an admin action, prompts the user to answer the challenge, and returns the resulting MFA response.
WithCredentials can be called on a GRPC client request to attach MFA credentials to the GRPC metadata for requests that require MFA, like admin-level requests.
WithPromptChallengeExtensions sets the challenge extensions used to create the prompt's challenge.
WithPromptDeviceType sets the prompt's DeviceType field.
WithPromptReason sets the prompt's PromptReason field.
WithPromptReasonAdminAction sets the prompt's PromptReason field to a standard admin action message.
WithPromptReasonSessionMFA sets the prompt's PromptReason field to a standard session mfa message.
WithQuiet sets the prompt's Quiet field.

# Constants

DeviceDescriptorRegistered is a registered device.
ResponseMetadataKey is the context metadata key for an MFA response in a gRPC request.

# Variables

ErrAdminActionMFARequired is an error indicating that an admin-level API request failed due to missing MFA verification.
ErrMFANotRequired is returned by MFA ceremonies when it is discovered or inferred that an MFA ceremony is not required by the server.
ErrMFANotSupported is returned by MFA ceremonies when the client does not support MFA ceremonies, or the server does not support MFA ceremonies for the client user.

# Structs

Ceremony is an MFA ceremony.
PromptConfig contains universal mfa prompt config options.

# Interfaces

Prompt is an MFA prompt.
SSOMFACeremony is an SSO MFA ceremony.

# Type aliases

CeremonyFn is a function that will carry out an MFA ceremony.
CreateAuthenticateChallengeFunc is a function that creates an authentication challenge.
DeviceDescriptor is a descriptor for a device, such as "registered".
PromptConstructor is a function that creates a new MFA prompt.
PromptFunc is a function wrapper that implements the Prompt interface.
PromptOpt applies configuration options to a prompt.
SSOMFACeremonyConstructor constructs a new SSO MFA ceremony.