doc/man/pam_sm_chauthtok.3

   1 .\" Generated from pam_sm_chauthtok.c by gendoc.pl
   2 .\" $Id: pam_sm_chauthtok.c 648 2013-03-05 17:54:27Z des $
   3 .Dd February 19, 2017
   4 .Dt PAM_SM_CHAUTHTOK 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_sm_chauthtok
   8 .Nd service module implementation for pam_chauthtok
   9 .Sh SYNOPSIS
  10 .In sys/types.h
  11 .In security/pam_appl.h
  12 .In security/pam_modules.h
  13 .Ft "int"
  14 .Fn pam_sm_chauthtok "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
  15 .Sh DESCRIPTION
  16 The
  17 .Fn pam_sm_chauthtok
  18 function is the service module's implementation
  19 of the
  20 .Xr pam_chauthtok 3
  21 API function.
  22 .Pp
  23 When the application calls
  24 .Xr pam_chauthtok 3 ,
  25 the service function is
  26 called twice, first with the
  27 .Dv PAM_PRELIM_CHECK
  28 flag set and then again
  29 with the
  30 .Dv PAM_UPDATE_AUTHTOK
  31 flag set.
  32 .Sh RETURN VALUES
  33 The
  34 .Fn pam_sm_chauthtok
  35 function returns one of the following values:
  36 .Bl -tag -width 18n
  37 .It Bq Er PAM_ABORT
  38 General failure.
  39 .It Bq Er PAM_AUTHTOK_DISABLE_AGING
  40 Authentication token aging disabled.
  41 .It Bq Er PAM_AUTHTOK_ERR
  42 Authentication token failure.
  43 .It Bq Er PAM_AUTHTOK_LOCK_BUSY
  44 Authentication token lock busy.
  45 .It Bq Er PAM_AUTHTOK_RECOVERY_ERR
  46 Failed to recover old authentication token.
  47 .It Bq Er PAM_BUF_ERR
  48 Memory buffer error.
  49 .It Bq Er PAM_CONV_ERR
  50 Conversation failure.
  51 .It Bq Er PAM_IGNORE
  52 Ignore this module.
  53 .It Bq Er PAM_PERM_DENIED
  54 Permission denied.
  55 .It Bq Er PAM_SERVICE_ERR
  56 Error in service module.
  57 .It Bq Er PAM_SYSTEM_ERR
  58 System error.
  59 .It Bq Er PAM_TRY_AGAIN
  60 Try again.
  61 .El
  62 .Sh SEE ALSO
  63 .Xr pam 3 ,
  64 .Xr pam_chauthtok 3 ,
  65 .Xr pam_strerror 3
  66 .Sh STANDARDS
  67 .Rs
  68 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  69 .%D "June 1997"
  70 .Re
  71 .Sh AUTHORS
  72 The
  73 .Fn pam_sm_chauthtok
  74 function and this manual page were
  75 developed for the
  76 .Fx
  77 Project by ThinkSec AS and Network Associates Laboratories, the
  78 Security Research Division of Network Associates, Inc.\& under
  79 DARPA/SPAWAR contract N66001-01-C-8035
  80 .Pq Dq CBOSS ,
  81 as part of the DARPA CHATS research program.
  82 .Pp
  83 The OpenPAM library is maintained by
  84 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .