crypto/dist/heimdal/lib/krb5/krb5_aname_to_localname.3

   1 .\" Copyright (c) 2003 - 2007 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_aname_to_localname.3 22071 2007-11-14 20:04:50Z lha $
  33 .\" $NetBSD$
  34 .\"
  35 .Dd February 18, 2006
  36 .Dt KRB5_ANAME_TO_LOCALNAME 3
  37 .Os
  38 .Sh NAME
  39 .Nm krb5_aname_to_localname
  40 .Nd converts a principal to a system local name
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5/krb5.h
  45 .Ft krb5_boolean
  46 .Fo krb5_aname_to_localname
  47 .Fa "krb5_context context"
  48 .Fa "krb5_const_principal name"
  49 .Fa "size_t lnsize"
  50 .Fa "char *lname"
  51 .Fc
  52 .Sh DESCRIPTION
  53 This function takes a principal
  54 .Fa name ,
  55 verifies that it is in the local realm (using
  56 .Fn krb5_get_default_realms )
  57 and then returns the local name of the principal.
  58 .Pp
  59 If
  60 .Fa name
  61 isn't in one of the local realms an error is returned.
  62 .Pp
  63 If the size
  64 .Fa ( lnsize )
  65 of the local name
  66 .Fa ( lname )
  67 is too small, an error is returned.
  68 .Pp
  69 .Fn krb5_aname_to_localname
  70 should only be use by an application that implements protocols that
  71 don't transport the login name and thus needs to convert a principal
  72 to a local name.
  73 .Pp
  74 Protocols should be designed so that they authenticate using
  75 Kerberos, send over the login name and then verify the principal
  76 that is authenticated is allowed to login and the login name.
  77 A way to check if a user is allowed to login is using the function
  78 .Fn krb5_kuserok .
  79 .Sh SEE ALSO
  80 .Xr krb5_get_default_realms 3 ,
  81 .Xr krb5_kuserok 3