URL: https://github.com/SSSD/sssd/pull/911
Author: alexal
 Title: #911: Update pam_sss.8.xml
Action: synchronized

To pull the PR as Git branch:
git remote add ghsssd https://github.com/SSSD/sssd
git fetch ghsssd pull/911/head:pr911
git checkout pr911
From 2d3a93d5991f9a7492d4fcac442d40ad6ac58230 Mon Sep 17 00:00:00 2001
From: Alex Rodin <alex.ro...@sas.com>
Date: Mon, 28 Oct 2019 11:39:33 -0400
Subject: [PATCH] Update pam_sss.8.xml

pam_sss: Added return values on a man page

Resolves: https://pagure.io/SSSD/sssd/issue/3672
---
 src/man/pam_sss.8.xml | 108 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 108 insertions(+)

diff --git a/src/man/pam_sss.8.xml b/src/man/pam_sss.8.xml
index 834d9d2683..cb7d6a81e7 100644
--- a/src/man/pam_sss.8.xml
+++ b/src/man/pam_sss.8.xml
@@ -262,6 +262,114 @@ auth sufficient pam_sss.so allow_missing_name
         from other sources during access control.</para>
     </refsect1>
 
+    <refsect1 id="return_values">
+        <title>RETURN VALUES</title>
+        <variablelist>
+            <varlistentry>
+                <term>PAM_SUCCESS</term>
+                <listitem>
+                    <para>
+                        The user is allowed to continue authentication.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_USER_UNKNOWN</term>
+                <listitem>
+                    <para>
+                        The user is not known to the authentication service or
+                        the SSSD's PAM responder is not running.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_AUTH_ERR</term>
+                <listitem>
+                    <para>
+                        Authentication failure. Also, could be returned when there
+                        is a problem with getting the certificate.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_PERM_DENIED</term>
+                <listitem>
+                    <para>
+                        Permission denied. The SSSD log files may contain additional
+                        information about the error.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_IGNORE</term>
+                <listitem>
+                    <para>
+                        See options <option>ignore_unknown_user</option> and
+                        <option>ignore_authinfo_unavail</option>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_AUTHTOK_ERR</term>
+                <listitem>
+                    <para>
+                        Unable to obtain the new authentication token. Also, could be
+                        returned when the user authenticates with certificates and
+                        multiple certificates are available, but the installed version
+                        of GDM does not support selection from multiple certificates.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_AUTHINFO_UNAVAIL</term>
+                <listitem>
+                    <para>
+                        Unable to access the authentication information.
+                        This might be due to a network or hardware failure.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_BUF_ERR</term>
+                <listitem>
+                    <para>
+                        A memory error occurred. Also, could be returned when options
+                        use_first_pass or use_authtok were set, but no password was
+                        found from the previously stacked PAM module.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_SYSTEM_ERR</term>
+                <listitem>
+                    <para>
+                        A system error occurred. The SSSD log files may contain additional
+                        information about the error.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_CRED_ERR</term>
+                <listitem>
+                    <para>
+                        Unable to set the credentials of the user.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>PAM_CRED_INSUFFICIENT</term>
+                <listitem>
+                    <para>
+                        The application does not have sufficient credentials
+                        to authenticate the user. For example, missing PIN during
+                        smartcard authentication or missing factor during
+                        two-factor authentication.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsect1>
+
     <refsect1 id='files'>
         <title>FILES</title>
         <para>If a password reset by root fails, because the corresponding SSSD
_______________________________________________
sssd-devel mailing list -- sssd-devel@lists.fedorahosted.org
To unsubscribe send an email to sssd-devel-le...@lists.fedorahosted.org
Fedora Code of Conduct: 
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: 
https://lists.fedorahosted.org/archives/list/sssd-devel@lists.fedorahosted.org

Reply via email to