|
|
.\" $OpenBSD: check_expire.3,v 1.3 2001/07/13 23:06:23 millert Exp $
|
|
|
.\"
|
|
|
.\" Copyright (c) 2000 Todd C. Miller <Todd.Miller@courtesan.com>
|
|
|
.\" All rights reserved.
|
|
|
.\"
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
.\" are met:
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
.\" 2. The name of the author may not be used to endorse or promote products
|
|
|
.\" derived from this software without specific prior written permission.
|
|
|
.\"
|
|
|
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
|
|
.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
|
.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
|
|
.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
|
.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
|
.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
|
|
|
.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
|
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
|
.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
|
|
.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
.\"
|
|
|
.Dd November 26, 2000
|
|
|
.Dt CHECK_EXPIRE 3
|
|
|
.Os
|
|
|
.Sh NAME
|
|
|
.Nm check_expire
|
|
|
.Nd check for password expiration
|
|
|
.Sh SYNOPSIS
|
|
|
.Fd #include <stdio.h>
|
|
|
.Fd #include <util.h>
|
|
|
.Ft int
|
|
|
.Fn login_check_expire "FILE *back" "struct passwd *pwd" "char *class" "int lastchance"
|
|
|
.Sh DESCRIPTION
|
|
|
The
|
|
|
.Fn login_check_expire
|
|
|
function is called by a BSD authentication login script to
|
|
|
check whether the user's password entry, as described by
|
|
|
.Fa pwd ,
|
|
|
has expired.
|
|
|
.Pp
|
|
|
If a
|
|
|
.Fa class
|
|
|
is specified, it is used instead of the class specified in the user's
|
|
|
password database entry.
|
|
|
If the
|
|
|
.Fa lastchance
|
|
|
argument is non-zero, the user's password has expired, and it has not been
|
|
|
expired longer than
|
|
|
.Dq password-dead
|
|
|
seconds (see
|
|
|
.Xr login.conf 5 ) ,
|
|
|
the user will be able to log in one last time to change the password.
|
|
|
.Sh RETURN VALUES
|
|
|
The
|
|
|
.Fn login_check_expire
|
|
|
function returns 0 if the user's password has not expired, and 1 if it has
|
|
|
expired or if an error occurred.
|
|
|
.br
|
|
|
Status and error messages are passed
|
|
|
back to the login script caller via the back channel,
|
|
|
.Fa back .
|
|
|
.Sh SEE ALSO
|
|
|
.Xr authenticate 3 ,
|
|
|
.Xr auth_subr 3 ,
|
|
|
.Xr login.conf 5
|