package
0.0.3
Repository: https://github.com/wakeful-cloud/pam-oauth.git
Documentation: pkg.go.dev

# Functions

EvaluateShellScript evaluates the specified shell script with the specified timeout.
EvaluateTextTemplate evaluates the specified text (i.e.: **NON-HTML**) template with the specified data.
GetChallengeID returns the challenge ID from the environment.
GetConfigPath returns the configuration path from the environment.
GetRemoteHost returns the remote host from the environment.
GetRemoteUser returns the remote user from the environment.
GetService returns the service from the environment.
GetTTY returns the tty from the environment.
GetType returns the type from the environment.
GetUsername returns the username from the environment.
LoadConfig loads a configuration file.
NewInternalClient creates a new internal server client.
NewPamErrorWithCode returns a new PamErrorWithCode.
SaveConfig saves a configuration file.
SetChallengeID sets the challenge ID in the PAM module environment.
SetConfigPath sets the configuration path in the PAM module environment.
SwitchUser switches the current process to the specified user.

# Constants

Critical error value (?module fail now request).
User account has expired.
Authentication failure.
Underlying authentication service can not retrieve authentication information.
Authentication token aging error.
Authentication token manipulation error.
User's authentication token has expired.
Authentication token lock busy.
Authentication information cannot be recovered.
Bad item passed to pam_*_item().
Memory buffer error.
Conversation function is event driven and data is not available yet.
Conversation error.
Failure setting user credentials.
User credentials expired.
Can not access authentication data due to insufficient credentials.
Underlying authentication service can not retrieve user credentials unavailable.
Ignore underlying account module regardless of whether the control flag is required, optional, or sufficient.
Please call this function again to complete authentication stack.
An authentication service has maintained a retry count which has been reached.
Module is not known.
New authentication token required.
No module specific data is present.
PAM_OAUTH_CHALLENGE_ID is the environment variable key for the challenge ID.
PAM_OAUTH_CONFIG is the environment variable key for the configuration path.
PAM_OAUTH_USERNAME is the environment variable key for the username.
dlopen() failure when dynamically loading a service module.
Permission denied.
PAM_REMOTE_HOST_KEY is the environment variable key for the remote host.
PAM_REMOTE_USER_KEY is the environment variable key for the remote user.
Error in service module.
PAM_SERVICE_KEY is the environment variable key for the service.
Can not make/remove an entry for the specified session.
Account management.
User authentication.
Alter the authentication token (password).
Terminate session management.
Start session management.
Alter credentials #nosec G101.
Successful function return.
Symbol not found.
System error.
Preliminary check by password service.
PAM_TTY_KEY is the environment variable key for the tty.
PAM_TYPE_KEY is the environment variable key for the service module type.
User not known to the underlying authentication module.
PAM_USERNAME_KEY is the environment variable key for the username.

# Variables

ErrPAMOAuthChallengeIDNotFound is returned when the PAM OAuth challenge ID is not found.
ErrPAMOAuthConfigNotFound is returned when the PAM OAuth config is not found.
ErrPAMRemoteHostNotFound is returned when the PAM remote host is not found.
ErrPAMRemoteUserNotFound is returned when the PAM remote user is not found.
ErrPAMServiceNotFound is returned when the PAM service is not found.
ErrPAMTTYNotFound is returned when the PAM TTY is not found.
ErrPAMTypeInvalid is returned when the PAM type is invalid.
ErrPAMTypeNotFound is returned when the PAM type is not found.
ErrPAMUsernameNotFound is returned when the PAM username is not found.

# Structs

Config is the global client configuration.
InternalClient is the internal server client.
InternalClientConfig is the internal server client configuration.
LogConfig is the logging configuration.
PamErrorWithCode is an error with a PAM exit code.
PromptConfig is the prompt configuration.

# Type aliases

PamExitCode is the exit code returned by a pam_exec binary.
PamSmType is the type of PAM service module type.