crypto/external/bsd/heimdal/dist/lib/krb5/krb5_parse_name.3

   1 .\"     $NetBSD: krb5_parse_name.3,v 1.1.1.2 2011/04/14 14:09:23 elric Exp $
   2 .\"
   3 .\" Copyright (c) 1997 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 May  1, 2006
  37 .Dt KRB5_PARSE_NAME 3
  38 .Os
  39 .Sh NAME
  40 .Nm krb5_parse_name
  41 .Nd string to principal conversion
  42 .Sh LIBRARY
  43 Kerberos 5 Library (libkrb5, -lkrb5)
  44 .Sh SYNOPSIS
  45 .In krb5/krb5.h
  46 .Ft krb5_error_code
  47 .Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal"
  48 .Sh DESCRIPTION
  49 .Fn krb5_parse_name
  50 converts a string representation of a principal name to
  51 .Nm krb5_principal .
  52 The
  53 .Fa principal
  54 will point to allocated data that should be freed with
  55 .Fn krb5_free_principal .
  56 .Pp
  57 The string should consist of one or more name components separated with slashes
  58 .Pq Dq / ,
  59 optionally followed with an
  60 .Dq @
  61 and a realm name. A slash or @ may be contained in a name component by
  62 quoting it with a backslash
  63 .Pq Dq \e .
  64 A realm should not contain slashes or colons.
  65 .Sh SEE ALSO
  66 .Xr krb5_425_conv_principal 3 ,
  67 .Xr krb5_build_principal 3 ,
  68 .Xr krb5_free_principal 3 ,
  69 .Xr krb5_sname_to_principal 3 ,
  70 .Xr krb5_unparse_name 3