lib/libgssapi/gss_canonicalize_name.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2005 Doug Rabson
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     $FreeBSD$
  28 .\"
  29 .\" The following commands are required for all man pages.
  30 .Dd January 26, 2010
  31 .Dt GSS_CANONICALIZE_NAME 3 PRM
  32 .Os
  33 .Sh NAME
  34 .Nm gss_canonicalize_name
  35 .Nd Convert an internal name to an MN
  36 .\" This next command is for sections 2 and 3 only.
  37 .\" .Sh LIBRARY
  38 .Sh SYNOPSIS
  39 .In "gssapi/gssapi.h"
  40 .Ft OM_uint32
  41 .Fo gss_canonicalize_name
  42 .Fa "OM_uint32 *minor_status"
  43 .Fa "const gss_name_t input_name"
  44 .Fa "const gss_OID mech_type"
  45 .Fa "gss_name_t *output_name"
  46 .Fc
  47 .Sh DESCRIPTION
  48 Generate a canonical mechanism name (MN) from an arbitrary internal
  49 name.
  50 The mechanism name is the name that would be returned to a context
  51 acceptor on successful authentication of a context where the initiator
  52 used the
  53 .Fa input_name
  54 in a successful call to
  55 .Fn gss_acquire_cred ,
  56 specifying an OID set containing
  57 .Fa mech_type
  58 as its only member,
  59 followed by a call to
  60 .Fn gss_init_sec_context ,
  61 specifying
  62 .Fa mech_type
  63 as the authentication mechanism.
  64 .Sh PARAMETERS
  65 .Bl -tag
  66 .It minor_status
  67 Mechanism specific status code.
  68 .It input_name
  69 The name for which a canonical form is desired.
  70 .It mech_type
  71 The authentication mechanism for which the canonical form of the name
  72 is desired.
  73 The desired mechanism must be specified explicitly;
  74  no default is provided.
  75 .It output_name
  76 The resultant canonical name.
  77 Storage associated with this name must be freed by the application
  78 after use with a call to
  79 .Fn gss_release_name .
  80 .El
  81 .Sh RETURN VALUES
  82 .Bl -tag
  83 .It GSS_S_COMPLETE
  84 Successful completion.
  85 .It GSS_S_BAD_MECH
  86 The identified mechanism is not supported.
  87 .It GSS_S_BAD_NAMETYPE
  88 The provided internal name contains no elements that could be
  89 processed by the specified mechanism.
  90 .It GSS_S_BAD_NAME
  91 The provided internal name was ill-formed.
  92 .El
  93 .Sh SEE ALSO
  94 .Xr gss_acquire_cred 3 ,
  95 .Xr gss_init_sec_context 3 ,
  96 .Xr gss_release_name 3
  97 .Sh STANDARDS
  98 .Bl -tag
  99 .It RFC 2743
 100 Generic Security Service Application Program Interface Version 2, Update 1
 101 .It RFC 2744
 102 Generic Security Service API Version 2 : C-bindings
 103 .El
 104 .Sh HISTORY
 105 The
 106 .Nm
 107 function first appeared in
 108 .Fx 7.0 .
 109 .Sh AUTHORS
 110 John Wray, Iris Associates
 111 .Sh COPYRIGHT
 112 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 113 .Pp
 114 This document and translations of it may be copied and furnished to
 115 others, and derivative works that comment on or otherwise explain it
 116 or assist in its implementation may be prepared, copied, published
 117 and distributed, in whole or in part, without restriction of any
 118 kind, provided that the above copyright notice and this paragraph are
 119 included on all such copies and derivative works.  However, this
 120 document itself may not be modified in any way, such as by removing
 121 the copyright notice or references to the Internet Society or other
 122 Internet organizations, except as needed for the purpose of
 123 developing Internet standards in which case the procedures for
 124 copyrights defined in the Internet Standards process must be
 125 followed, or as required to translate it into languages other than
 126 English.
 127 .Pp
 128 The limited permissions granted above are perpetual and will not be
 129 revoked by the Internet Society or its successors or assigns.
 130 .Pp
 131 This document and the information contained herein is provided on an
 132 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 133 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 134 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 135 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 136 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.