contrib/openpam/doc/man/pam_sm_chauthtok.3

   1 .\" Generated from pam_sm_chauthtok.c by gendoc.pl
   2 .\" $OpenPAM: pam_sm_chauthtok.c 938 2017-04-30 21:34:42Z des $
   3 .Dd April 30, 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_SUCCESS
  38 Success.
  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 Mt des@des.no .