contrib/openpam/doc/man/pam_chauthtok.3

   1 .\" Generated from pam_chauthtok.c by gendoc.pl
   2 .\" $Id: pam_chauthtok.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt PAM_CHAUTHTOK 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_chauthtok
   8 .Nd perform password related functions within the PAM framework
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .Ft "int"
  15 .Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
  16 .Sh DESCRIPTION
  17 The
  18 .Fn pam_chauthtok
  19 function attempts to change the authentication token
  20 for the user associated with the pam context specified by the
  21 .Fa pamh
  22 argument.
  23 .Pp
  24 The
  25 .Fa flags
  26 argument is the binary or of zero or more of the following
  27 values:
  28 .Bl -tag -width 18n
  29 .It Dv PAM_SILENT
  30 Do not emit any messages.
  31 .It Dv PAM_CHANGE_EXPIRED_AUTHTOK
  32 Change only those authentication tokens that have expired.
  33 .El
  34 .Pp
  35 If any other bits are set,
  36 .Fn pam_chauthtok
  37 will return
  38 .Dv PAM_SYMBOL_ERR .
  39 .Sh RETURN VALUES
  40 The
  41 .Fn pam_chauthtok
  42 function returns one of the following values:
  43 .Bl -tag -width 18n
  44 .It Bq Er PAM_ABORT
  45 General failure.
  46 .It Bq Er PAM_AUTHTOK_DISABLE_AGING
  47 Authentication token aging disabled.
  48 .It Bq Er PAM_AUTHTOK_ERR
  49 Authentication token failure.
  50 .It Bq Er PAM_AUTHTOK_LOCK_BUSY
  51 Authentication token lock busy.
  52 .It Bq Er PAM_AUTHTOK_RECOVERY_ERR
  53 Failed to recover old authentication token.
  54 .It Bq Er PAM_BUF_ERR
  55 Memory buffer error.
  56 .It Bq Er PAM_CONV_ERR
  57 Conversation failure.
  58 .It Bq Er PAM_PERM_DENIED
  59 Permission denied.
  60 .It Bq Er PAM_SERVICE_ERR
  61 Error in service module.
  62 .It Bq Er PAM_SYMBOL_ERR
  63 Invalid symbol.
  64 .It Bq Er PAM_SYSTEM_ERR
  65 System error.
  66 .It Bq Er PAM_TRY_AGAIN
  67 Try again.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr pam 3 ,
  71 .Xr pam_strerror 3
  72 .Sh STANDARDS
  73 .Rs
  74 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  75 .%D "June 1997"
  76 .Re
  77 .Sh AUTHORS
  78 The
  79 .Fn pam_chauthtok
  80 function and this manual page were
  81 developed for the
  82 .Fx
  83 Project by ThinkSec AS and Network Associates Laboratories, the
  84 Security Research Division of Network Associates, Inc.\& under
  85 DARPA/SPAWAR contract N66001-01-C-8035
  86 .Pq Dq CBOSS ,
  87 as part of the DARPA CHATS research program.
  88 .Pp
  89 The OpenPAM library is maintained by
  90 .An Dag-Erling Sm\(/orgrav Aq des@des.no .