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