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