crypto/dist/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 .\" $Heimdal: krb5_kuserok.3 15083 2005-05-04 12:11:22Z joda $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd May 4, 2005
  36 .Dt KRB5_KUSEROK 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_kuserok
  40 .Nd "checks if a principal is permitted to login as a user"
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5/krb5.h
  45 .Ft krb5_boolean
  46 .Fo krb5_kuserok
  47 .Fa "krb5_context context"
  48 .Fa "krb5_principal principal"
  49 .Fa "const char *user"
  50 .Fc
  51 .Sh DESCRIPTION
  52 This function takes the name of a local
  53 .Fa user
  54 and checks if
  55 .Fa principal
  56 is allowed to log in as that user.
  57 .Pp
  58 The
  59 .Fa user
  60 may have a
  61 .Pa ~/.k5login
  62 file listing principals that are allowed to login as that user. If
  63 that file does not exist, all principals with a first component
  64 identical to the username, and a realm considered local, are allowed
  65 access.
  66 .Pp
  67 The
  68 .Pa .k5login
  69 file must contain one principal per line, be owned by
  70 .Fa user ,
  71 and not be writable by group or other (but must be readable by
  72 anyone).
  73 .Pp
  74 Note that if the file exists, no implicit access rights are given to
  75 .Fa user Ns @ Ns Aq localrealm .
  76 .Pp
  77 Optionally, a set of files may be put in
  78 .Pa ~/.k5login.d ( Ns
  79 a directory), in which case they will all be checked in the same
  80 manner as
  81 .Pa .k5login .
  82 The files may be called anything, but files starting with a hash
  83 .Dq ( # ) ,
  84 or ending with a tilde
  85 .Dq ( ~ )
  86 are ignored. Subdirectories are not traversed. Note that this
  87 directory may not be checked by other implementations.
  88 .Sh RETURN VALUES
  89 .Nm
  90 returns
  91 .Dv TRUE
  92 if access should be granted,
  93 .Dv FALSE
  94 otherwise.
  95 .Sh HISTORY
  96 The
  97 .Pa ~/.k5login.d
  98 feature appeared in Heimdal 0.7.
  99 .Sh SEE ALSO
 100 .Xr krb5_get_default_realms 3 ,
 101 .Xr krb5_verify_user 3 ,
 102 .Xr krb5_verify_user_lrealm 3 ,
 103 .Xr krb5_verify_user_opt 3 ,
 104 .Xr krb5.conf 5