contrib/openpam/doc/man/pam_chauthtok.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed for the FreeBSD Project by ThinkSec AS and
   6 .\" Network Associates Laboratories, the Security Research Division of
   7 .\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   8 .\" ("CBOSS"), as part of the DARPA CHATS research program.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. The name of the author may not be used to endorse or promote
  19 .\"    products derived from this software without specific prior written
  20 .\"    permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\" $P4$
  35 .\"
  36 .Dd June 16, 2005
  37 .Dt PAM_CHAUTHTOK 3
  38 .Os
  39 .Sh NAME
  40 .Nm pam_chauthtok
  41 .Nd perform password related functions within the PAM framework
  42 .Sh LIBRARY
  43 .Lb libpam
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In security/pam_appl.h
  47 .Ft "int"
  48 .Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 function attempts to change the authentication token
  53 for the user associated with the pam context specified by the
  54 .Fa pamh
  55 argument.
  56 .Pp
  57 The
  58 .Fa flags
  59 argument is the binary or of zero or more of the following
  60 values:
  61 .Bl -tag -width 18n
  62 .It Dv PAM_SILENT
  63 Do not emit any messages.
  64 .It Dv PAM_CHANGE_EXPIRED_AUTHTOK
  65 Change only those authentication tokens that have expired.
  66 .El
  67 .Pp
  68 If any other bits are set,
  69 .Nm
  70 will return
  71 .Dv PAM_SYMBOL_ERR .
  72 .Sh RETURN VALUES
  73 The
  74 .Nm
  75 function returns one of the following values:
  76 .Bl -tag -width 18n
  77 .It Bq Er PAM_ABORT
  78 General failure.
  79 .It Bq Er PAM_AUTHTOK_DISABLE_AGING
  80 Authentication token aging disabled.
  81 .It Bq Er PAM_AUTHTOK_ERR
  82 Authentication token failure.
  83 .It Bq Er PAM_AUTHTOK_LOCK_BUSY
  84 Authentication token lock busy.
  85 .It Bq Er PAM_AUTHTOK_RECOVERY_ERR
  86 Failed to recover old authentication token.
  87 .It Bq Er PAM_BUF_ERR
  88 Memory buffer error.
  89 .It Bq Er PAM_CONV_ERR
  90 Conversation failure.
  91 .It Bq Er PAM_PERM_DENIED
  92 Permission denied.
  93 .It Bq Er PAM_SERVICE_ERR
  94 Error in service module.
  95 .It Bq Er PAM_SYMBOL_ERR
  96 Invalid symbol.
  97 .It Bq Er PAM_SYSTEM_ERR
  98 System error.
  99 .It Bq Er PAM_TRY_AGAIN
 100 Try again.
 101 .El
 102 .Sh SEE ALSO
 103 .Xr pam 3 ,
 104 .Xr pam_strerror 3
 105 .Sh STANDARDS
 106 .Rs
 107 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
 108 .%D "June 1997"
 109 .Re
 110 .Sh AUTHORS
 111 The
 112 .Nm
 113 function and this manual page were developed for the
 114 .Fx
 115 Project by ThinkSec AS and Network Associates Laboratories, the
 116 Security Research Division of Network Associates, Inc.\& under
 117 DARPA/SPAWAR contract N66001-01-C-8035
 118 .Pq Dq CBOSS ,
 119 as part of the DARPA CHATS research program.