crypto/heimdal/lib/krb5/krb5_kuserok.3

   1 .\" Copyright (c) 2003-2005 Kungliga Tekniska Högskolan
   2 .\" (Royal Institute of Technology, Stockholm, Sweden).
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" 3. Neither the name of the Institute nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Id: krb5_kuserok.3 15083 2005-05-04 12:11:22Z joda $
  33 .\"
  34 .Dd May 4, 2005
  35 .Dt KRB5_KUSEROK 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_kuserok
  39 .Nd "checks if a principal is permitted to login as a user"
  40 .Sh LIBRARY
  41 Kerberos 5 Library (libkrb5, -lkrb5)
  42 .Sh SYNOPSIS
  43 .In krb5.h
  44 .Ft krb5_boolean
  45 .Fo krb5_kuserok
  46 .Fa "krb5_context context"
  47 .Fa "krb5_principal principal"
  48 .Fa "const char *user"
  49 .Fc
  50 .Sh DESCRIPTION
  51 This function takes the name of a local
  52 .Fa user
  53 and checks if
  54 .Fa principal
  55 is allowed to log in as that user.
  56 .Pp
  57 The
  58 .Fa user
  59 may have a
  60 .Pa ~/.k5login
  61 file listing principals that are allowed to login as that user. If
  62 that file does not exist, all principals with a first component
  63 identical to the username, and a realm considered local, are allowed
  64 access.
  65 .Pp
  66 The
  67 .Pa .k5login
  68 file must contain one principal per line, be owned by
  69 .Fa user ,
  70 and not be writable by group or other (but must be readable by
  71 anyone).
  72 .Pp
  73 Note that if the file exists, no implicit access rights are given to
  74 .Fa user Ns @ Ns Aq localrealm .
  75 .Pp
  76 Optionally, a set of files may be put in
  77 .Pa ~/.k5login.d ( Ns
  78 a directory), in which case they will all be checked in the same
  79 manner as
  80 .Pa .k5login .
  81 The files may be called anything, but files starting with a hash
  82 .Dq ( # ) ,
  83 or ending with a tilde
  84 .Dq ( ~ )
  85 are ignored. Subdirectories are not traversed. Note that this
  86 directory may not be checked by other implementations.
  87 .Sh RETURN VALUES
  88 .Nm
  89 returns
  90 .Dv TRUE
  91 if access should be granted,
  92 .Dv FALSE
  93 otherwise.
  94 .Sh HISTORY
  95 The
  96 .Pa ~/.k5login.d
  97 feature appeared in Heimdal 0.7.
  98 .Sh SEE ALSO
  99 .Xr krb5_get_default_realms 3 ,
 100 .Xr krb5_verify_user 3 ,
 101 .Xr krb5_verify_user_lrealm 3 ,
 102 .Xr krb5_verify_user_opt 3 ,
 103 .Xr krb5.conf 5