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