.\" Copyright (c) 2003 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden). 
.\" 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. Redistributions in binary form must reproduce the above copyright 
.\"    notice, this list of conditions and the following disclaimer in the 
.\"    documentation and/or other materials provided with the distribution. 
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors 
.\"    may be used to endorse or promote products derived from this software 
.\"    without specific prior written permission. 
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``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 INSTITUTE OR CONTRIBUTORS 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. 
.\"
.\" $Id: krb5_kuserok.3,v 1.5 2003/04/16 13:58:10 lha Exp $
.\"
.Dd Oct 17, 2002
.Dt KRB5_KUSEROK 3
.Os HEIMDAL
.Sh NAME
.Nm krb5_kuserok
.Nd verifies if a principal can log in as a user
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5.h
.Ft krb5_boolean
.Fo krb5_kuserok 
.Fa "krb5_context context"
.Fa "krb5_principal principal"
.Fa "const char *name"
.Fc
.Sh DESCRIPTION
This function takes a local user
.Fa name
and verifies if
.Fa principal
is allowed to log in as that user.
.Pp
First
.Nm
check if there is a local account name
.Fa username.
If there isn't,
.Nm
returns
.Dv FALSE .
.Pp
Then
.Nm
checks if principal is the same as user@realm in any of the default
realms. If that is the case,
.Nm
returns
.Dv TRUE .
.Pp
After that it reads the file 
.Pa .k5login
(if it exists) in the users home directory and checks if
.Fa principal
is in the file.
If it does exists,
.Dv TRUE
is returned.
If neither of the above turns out to be true,
.DV FALSE
is returned.
.Pp
The
.Pa .k5login
should contain one principal per line.
.Sh SEE ALSO
.Xr krb5_get_default_realms 3 ,
.Xr krb5_verify_user 3 ,
.Xr krb5_verify_user_lrealm 3 ,
.Xr krb5_verify_user_opt 3,
.Xr krb5.conf 5