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