PAM_STRESS(8)

  .SH "NAME" pam_stress - The stress-testing PAM module
  .SH "SYNOPSIS"
    .HP u
      pam_stress.so
       [debug]
       [no_warn]
       [use_first_pass]
       [try_first_pass]
       [rootok]
       [expired]
       [fail_1]
       [fail_2]
       [prelim]
       [required]

  .SH "DESCRIPTION"

    .PP The pam_stress PAM module is mainly intended to give the impression of failing as a fully functioning module might.

  .SH "OPTIONS"

      .PP debug

              Put lots of information in syslog. *NOTE* this option writes passwords to syslog, so don't use anything sensitive when testing.

          .RE
          .PP no_warn

                  Do not give warnings about things (otherwise warnings are issued via the conversation function)

              .RE
              .PP use_first_pass

                      Do not prompt for a password, for pam_sm_authentication function just use item PAM_AUTHTOK.

                  .RE
                  .PP try_first_pass

                          Do not prompt for a password unless there has been no previous authentication token (item PAM_AUTHTOK is NULL)

                      .RE
                      .PP rootok

                              This is intended for the pam_sm_chauthtok function and it instructs this function to permit root to change the user's password without entering the old password.

                          .RE
                          .PP expired

                                  An argument intended for the account and chauthtok module parts. It instructs the module to act as if the user's password has expired

                              .RE
                              .PP fail_1

                                      This instructs the module to make its first function fail.

                                  .RE
                                  .PP fail_2

                                          This instructs the module to make its second function (if there is one) fail.

                                      .RE
                                      .PP prelim

                                              For pam_sm_chauthtok, means fail on PAM_PRELIM_CHECK.

                                          .RE
                                          .PP required

                                                  For pam_sm_chauthtok, means fail if the user hasn't already been authenticated by this module. (See stress_new_pwd data string in the NOTES.)

                                              .RE

                                          .SH "MODULE TYPES PROVIDED"

                                            .PP All module types (auth, account, password and session) are provided.

                                          .SH "RETURN VALUES"

                                              .PP PAM_BUF_ERR

                                                       Memory buffer error.

                                                  .RE
                                                  .PP PAM_PERM_DENIED

                                                           Permission denied.

                                                      .RE
                                                      .PP PAM_AUTH_ERR

                                                               Access to the system was denied.

                                                          .RE
                                                          .PP PAM_CONV_ERR

                                                                   Conversation failure.

                                                              .RE
                                                              .PP PAM_SUCCESS

                                                                       The function passes all checks.

                                                                  .RE
                                                                  .PP PAM_USER_UNKNOWN

                                                                           The user is not known to the system.

                                                                      .RE
                                                                      .PP PAM_CRED_ERR

                                                                               Failure involving user credentials.

                                                                          .RE
                                                                          .PP PAM_NEW_AUTHTOK_REQD

                                                                                   Authentication token is no longer valid; new one required.

                                                                              .RE
                                                                              .PP PAM_SESSION_ERR

                                                                                       Session failure.

                                                                                  .RE
                                                                                  .PP PAM_TRY_AGAIN

                                                                                           Failed preliminary check by service.

                                                                                      .RE
                                                                                      .PP PAM_AUTHTOK_LOCK_BUSY

                                                                                               Authentication token lock busy.

                                                                                          .RE
                                                                                          .PP PAM_AUTHTOK_ERR

                                                                                                   Authentication token manipulation error.

                                                                                              .RE
                                                                                              .PP PAM_SYSTEM_ERR

                                                                                                       System error.

                                                                                                  .RE

                                                                                              .SH "NOTES"

                                                                                                .PP This module uses the stress_new_pwd data string which tells pam_sm_chauthtok that pam_sm_acct_mgmt says we need a new password. The only possible value for this data string is 'yes'.

                                                                                              .SH "EXAMPLES"

                                                                                                #%PAM-1.0
                                                                                                #
                                                                                                # Any of the following will suffice
                                                                                                account  required pam_stress.so
                                                                                                auth     required pam_stress.so
                                                                                                password required pam_stress.so
                                                                                                session  required pam_stress.so

                                                                                              .SH "SEE ALSO"

                                                                                                .PP pam.conf(5), pam.d(5), pam(8).

                                                                                              .SH "AUTHORS"

                                                                                                .PP The pam_stress PAM module was developed by Andrew Morgan <morgan@linux.kernel.org>. The man page for pam_stress was written by Lucas Ramage <ramage.lucas@protonmail.com>.