sssd 2.9.4
Modules | Enumerations
Messages from the server

SSSD can send different kind of information back to the client. More...

Modules

 User info messages
 To achieve a consistent user experience and to facilitate internationalization all messages show to the user are generate by the PAM client and not by the SSSD server components.
 

Enumerations

enum  response_type {
  SSS_PAM_SYSTEM_INFO = 0x01 , SSS_PAM_DOMAIN_NAME , SSS_PAM_ENV_ITEM , SSS_ENV_ITEM ,
  SSS_ALL_ENV_ITEM , SSS_PAM_USER_INFO , SSS_PAM_TEXT_MSG , SSS_PAM_OTP_INFO ,
  SSS_PAM_CERT_INFO , SSS_OTP , SSS_PASSWORD_PROMPTING , SSS_CERT_AUTH_PROMPTING ,
  SSS_PAM_CERT_INFO_WITH_HINT , SSS_PAM_PROMPT_CONFIG , SSS_CHILD_KEEP_ALIVE , SSS_PAM_OAUTH2_INFO ,
  SSS_PAM_PASSKEY_INFO , SSS_PAM_PASSKEY_KRB_INFO
}
 Types of different messages. More...
 

Detailed Description

SSSD can send different kind of information back to the client.

A response from the SSSD can contain 0 or more messages. Each message contains a type tag and the size of the message data, both are unsigned 32-bit integer values, followed be the message specific data.

If the message is generated by a backend it is send back to the PAM responder via a D-BUS message in an array of D-BUS structs. The struct consists of a DBUS_TYPE_UINT32 for the tag and a DBUS_TYPE_ARRAY to hold the message.

Examples:

Enumeration Type Documentation

◆ response_type

Types of different messages.

Enumerator
SSS_PAM_SYSTEM_INFO 

Message for the system log.

Parameters
String,zeroterminated.
SSS_PAM_DOMAIN_NAME 

Name of the domain the user belongs too.

This messages is generated by the PAM responder.

Parameters
String,zeroterminated, with the domain name.
SSS_PAM_ENV_ITEM 

Set and environment variable with pam_putenv(3).

Parameters
String,zeroterminated, of the form name=value. See pam_putenv(3) for details.
SSS_ENV_ITEM 

Set and environment variable with putenv(3).

Parameters
String,zeroterminated, of the form name=value. See putenv(3) for details.
SSS_ALL_ENV_ITEM 

Set and environment variable with putenv(3) and pam_putenv(3).

Parameters
String,zeroterminated, of the form name=value. See putenv(3) and pam_putenv(3) for details.
SSS_PAM_USER_INFO 

A message which should be displayed to the user.

Parameters
Userinfo message, see user_info_type for details.
SSS_PAM_TEXT_MSG 

A plain text message which should be displayed to the user.

This should only be used in the case where it is not possible to use SSS_PAM_USER_INFO.

Parameters
Azero terminated string.
SSS_PAM_OTP_INFO 

A message which optionally may contain the name of the vendor, the ID of an OTP token and a challenge.

Parameters
Threezero terminated strings, if one of the strings is missing the message will contain only an empty string (\0) for that component.
SSS_PAM_CERT_INFO 

A message indicating that Smartcard/certificate based authentication is available and contains details about the found Smartcard.

Parameters
username, zero terminated
tokenname, zero terminated
PKCS11module name, zero terminated
keyid, zero terminated
SSS_OTP 

Indicates that the authtok was a OTP, so don't cache it.

There is no message.

Parameters
None.
SSS_PASSWORD_PROMPTING 

Indicates that password prompting is possible.

This might be used together with SSS_PAM_OTP_INFO to determine the type of prompting. There is no message.

Parameters
None.
SSS_CERT_AUTH_PROMPTING 

Indicates that on the server side Smartcard/certificate based authentication is available for the selected account.

This might be used together with other prompting options to determine the type of prompting.

Parameters
None.
SSS_PAM_CERT_INFO_WITH_HINT 

Same as SSS_PAM_CERT_INFO but user name might be missing and should be prompted for.

SSS_PAM_PROMPT_CONFIG 

Contains data which controls which credentials are expected and how the user is prompted for them.

SSS_CHILD_KEEP_ALIVE 

Indicates that the child process is kept alived and further communication must be done with the same child.

The message is the pid of the child process.

SSS_PAM_OAUTH2_INFO 

A message which contains the oauth2 parameters for the user.

Parameters
Threezero terminated strings:
  • verification_uri
  • verification_uri_complete
  • user_code
SSS_PAM_PASSKEY_INFO 

Indicates that passkey authentication is available.

including a parameter string which dictates whether prompting for PIN is needed.

Parameters
-prompt_pin
SSS_PAM_PASSKEY_KRB_INFO 

A message containing the passkey parameters for the user.

The key is the cryptographic challenge used as the key to the passkey hash table entry.

Parameters
-user verification (string)
  • key (string)