crypto/heimdal/lib/krb5/krb5_expand_hostname.3

   1 .\" Copyright (c) 2004 - 2006 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_expand_hostname.3 17461 2006-05-05 13:13:18Z lha $
  33 .\"
  34 .Dd May  5, 2006
  35 .Dt KRB5_EXPAND_HOSTNAME 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_expand_hostname ,
  39 .Nm krb5_expand_hostname_realms
  40 .Nd Kerberos 5 host name canonicalization functions
  41 .Sh LIBRARY
  42 Kerberos 5 Library (libkrb5, -lkrb5)
  43 .Sh SYNOPSIS
  44 .In krb5.h
  45 .Pp
  46 .Ft krb5_error_code
  47 .Fo krb5_expand_hostname
  48 .Fa "krb5_context context"
  49 .Fa "const char *orig_hostname"
  50 .Fa "char **new_hostname"
  51 .Fc
  52 .Ft krb5_error_code
  53 .Fo krb5_expand_hostname_realms
  54 .Fa "krb5_context context"
  55 .Fa "const char *orig_hostname"
  56 .Fa "char **new_hostname"
  57 .Fa "char ***realms"
  58 .Fc
  59 .Sh DESCRIPTION
  60 .Fn krb5_expand_hostname
  61 tries to make
  62 .Fa orig_hostname
  63 into a more canonical one in the newly allocated space returned in
  64 .Fa new_hostname .
  65 Caller must free the hostname with
  66 .Xr free 3 .
  67 .Pp
  68 .Fn krb5_expand_hostname_realms
  69 expands
  70 .Fa orig_hostname
  71 to a name we believe to be a hostname in newly
  72 allocated space in
  73 .Fa new_hostname
  74 and return the realms
  75 .Fa new_hostname
  76 is belive to belong to in
  77 .Fa realms .
  78 .Fa Realms
  79 is a array terminated with
  80 .Dv NULL .
  81 Caller must free the
  82 .Fa realms
  83 with
  84 .Fn krb5_free_host_realm
  85 and
  86 .Fa new_hostname
  87 with
  88 .Xr free 3 .
  89 .Sh SEE ALSO
  90 .Xr krb5 3 ,
  91 .Xr krb5_free_host_realm 3 ,
  92 .Xr krb5_get_host_realm 3 ,
  93 .Xr kerberos 8