diff options
Diffstat (limited to 'src/pam.c')
| -rw-r--r-- | src/pam.c | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -58,6 +58,33 @@ static GParamSpec *astal_auth_pam_properties[ASTAL_AUTH_PAM_N_PROPERTIES] = { G_DEFINE_TYPE_WITH_PRIVATE(AstalAuthPam, astal_auth_pam, G_TYPE_OBJECT); /** + * + * AstalAuthPam + * + * For simple authentication using only a password, using the [[email protected]] + * method is recommended. Look at the simple examples for how to use it. + * + * There is also a way to get access to the pam conversation, to allow for a more complex + * authentication process, like using multiple factor authentication. Generally it can be used like + * this: + * + * 1. create the Pam object. + * 2. set username and service if so required. It has sane defaults, so in most cases you can skip + * this. + * 3. connect to the signals. + * After an `auth-*` signal is emitted, it has to be responded with exactly one + * [[email protected]_secret] call. The secret is a string containing the user input. For + * [auth-info][[email protected]::auth-info:] and [auth-error][[email protected]::auth-error:] + * it should be `NULL`. Not connecting those signals, is equivalent to calling + * [[email protected]_secret] with `NULL` immediately after the signal is emitted. + * 4. start authentication process using [[email protected]_authenticate]. + * 5. it is possible to reuse the same Pam object for multiple sequential authentication attempts. + * Just call [[email protected]_authenticate] again after the `success` or `fail` signal + * was emitted. + * + */ + +/** * astal_auth_pam_set_username * @self: a AstalAuthPam object * @username: the new username @@ -317,7 +344,7 @@ gboolean astal_auth_pam_start_authenticate_with_callback(AstalAuthPam *self, } /** - * astal_auth_pam_start_authentication: + * astal_auth_pam_start_authenticate: * @self: a AstalAuthPam Object * * starts a new authentication process using the PAM (Pluggable Authentication Modules) system. |