crypto/heimdal-0.6.3/lib/krb5/krb5_kuserok.3

   1 .\" Copyright (c) 2003 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,v 1.5 2003/04/16 13:58:10 lha Exp $
  33 .\"
  34 .Dd Oct 17, 2002
  35 .Dt KRB5_KUSEROK 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_kuserok
  39 .Nd verifies if a principal can log in 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 *name"
  49 .Fc
  50 .Sh DESCRIPTION
  51 This function takes a local user
  52 .Fa name
  53 and verifies if
  54 .Fa principal
  55 is allowed to log in as that user.
  56 .Pp
  57 First
  58 .Nm
  59 check if there is a local account name
  60 .Fa username.
  61 If there isn't,
  62 .Nm
  63 returns
  64 .Dv FALSE .
  65 .Pp
  66 Then
  67 .Nm
  68 checks if principal is the same as user@realm in any of the default
  69 realms. If that is the case,
  70 .Nm
  71 returns
  72 .Dv TRUE .
  73 .Pp
  74 After that it reads the file
  75 .Pa .k5login
  76 (if it exists) in the users home directory and checks if
  77 .Fa principal
  78 is in the file.
  79 If it does exists,
  80 .Dv TRUE
  81 is returned.
  82 If neither of the above turns out to be true,
  83 .DV FALSE
  84 is returned.
  85 .Pp
  86 The
  87 .Pa .k5login
  88 should contain one principal per line.
  89 .Sh SEE ALSO
  90 .Xr krb5_get_default_realms 3 ,
  91 .Xr krb5_verify_user 3 ,
  92 .Xr krb5_verify_user_lrealm 3 ,
  93 .Xr krb5_verify_user_opt 3,
  94 .Xr krb5.conf 5