dist/openpam/doc/man/pam_chauthtok.3

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