1.\" $NetBSD: krb5_aname_to_localname.3,v 1.2 2017/01/28 21:31:49 christos Exp $ 2.\" 3.\" Copyright (c) 2003 - 2007 Kungliga Tekniska Högskolan 4.\" (Royal Institute of Technology, Stockholm, Sweden). 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" 3. Neither the name of the Institute nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" Id 35.\" 36.Dd February 18, 2006 37.Dt KRB5_ANAME_TO_LOCALNAME 3 38.Os 39.Sh NAME 40.Nm krb5_aname_to_localname 41.Nd converts a principal to a system local name 42.Sh LIBRARY 43Kerberos 5 Library (libkrb5, -lkrb5) 44.Sh SYNOPSIS 45.In krb5/krb5.h 46.Ft krb5_boolean 47.Fo krb5_aname_to_localname 48.Fa "krb5_context context" 49.Fa "krb5_const_principal name" 50.Fa "size_t lnsize" 51.Fa "char *lname" 52.Fc 53.Sh DESCRIPTION 54This function takes a principal 55.Fa name , 56verifies that it is in the local realm (using 57.Fn krb5_get_default_realms ) 58and then returns the local name of the principal. 59.Pp 60If 61.Fa name 62isn't in one of the local realms an error is returned. 63.Pp 64If the size 65.Fa ( lnsize ) 66of the local name 67.Fa ( lname ) 68is too small, an error is returned. 69.Pp 70.Fn krb5_aname_to_localname 71should only be use by an application that implements protocols that 72don't transport the login name and thus needs to convert a principal 73to a local name. 74.Pp 75Protocols should be designed so that they authenticate using 76Kerberos, send over the login name and then verify the principal 77that is authenticated is allowed to login and the login name. 78A way to check if a user is allowed to login is using the function 79.Fn krb5_kuserok . 80.Sh SEE ALSO 81.Xr krb5_get_default_realms 3 , 82.Xr krb5_kuserok 3 83