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

   1 .\" Copyright (c) 1997 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_sname_to_principal.3,v 1.7 2003/04/16 13:58:17 lha Exp $
  33 .\"
  34 .Dd August 8, 1997
  35 .Dt KRB5_PRINCIPAL 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_sname_to_principal ,
  39 .Nm krb5_sock_to_principal
  40 .Nd create a service principal
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5.h
  45 .Ft krb5_error_code
  46 .Fn krb5_sname_to_principal "krb5_context context" "const char *hostname" "const char *sname" "int32_t type" "krb5_principal *principal"
  47 .Ft krb5_error_code
  48 .Fn krb5_sock_to_principal "krb5_context context" "int socket" "const char *sname" "int32_t type" "krb5_principal *principal"
  49 .Sh DESCRIPTION
  50 These functions create a
  51 .Dq service
  52 principal that can, for instance, be used to lookup a key in a keytab. For both these function the
  53 .Fa sname
  54 parameter will be used for the first component of the created principal. If
  55 .Fa sname
  56 is
  57 .Dv NULL ,
  58 .Dq host
  59 will be used instead.
  60 .Fn krb5_sname_to_principal
  61 will use the passed
  62 .Fa hostname
  63 for the second component. If type
  64 .Dv KRB5_NT_SRV_HST
  65 this name will be looked up with
  66 .Fn gethostbyname .
  67 If
  68 .Fa hostname is
  69 .Dv NULL ,
  70 the local hostname will be used.
  71 .Pp
  72 .Fn krb5_sock_to_principal
  73 will use the
  74 .Dq sockname
  75 of the passed
  76 .Fa socket ,
  77 which should be a bound
  78 .Dv AF_INET
  79 socket.
  80 .Sh SEE ALSO
  81 .Xr krb5_425_conv_principal 3 ,
  82 .Xr krb5_build_principal 3 ,
  83 .Xr krb5_free_principal 3 ,
  84 .Xr krb5_parse_name 3 ,
  85 .Xr krb5_unparse_name 3