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 .\" The following commands are required for all man pages.
  28 .Dd January 26, 2010
  29 .Dt GSS_CANONICALIZE_NAME 3 PRM
  30 .Os
  31 .Sh NAME
  32 .Nm gss_canonicalize_name
  33 .Nd Convert an internal name to an MN
  34 .\" This next command is for sections 2 and 3 only.
  35 .\" .Sh LIBRARY
  36 .Sh SYNOPSIS
  37 .In "gssapi/gssapi.h"
  38 .Ft OM_uint32
  39 .Fo gss_canonicalize_name
  40 .Fa "OM_uint32 *minor_status"
  41 .Fa "const gss_name_t input_name"
  42 .Fa "const gss_OID mech_type"
  43 .Fa "gss_name_t *output_name"
  44 .Fc
  45 .Sh DESCRIPTION
  46 Generate a canonical mechanism name (MN) from an arbitrary internal
  47 name.
  48 The mechanism name is the name that would be returned to a context
  49 acceptor on successful authentication of a context where the initiator
  50 used the
  51 .Fa input_name
  52 in a successful call to
  53 .Fn gss_acquire_cred ,
  54 specifying an OID set containing
  55 .Fa mech_type
  56 as its only member,
  57 followed by a call to
  58 .Fn gss_init_sec_context ,
  59 specifying
  60 .Fa mech_type
  61 as the authentication mechanism.
  62 .Sh PARAMETERS
  63 .Bl -tag -width ".It minor_status"
  64 .It minor_status
  65 Mechanism specific status code.
  66 .It input_name
  67 The name for which a canonical form is desired.
  68 .It mech_type
  69 The authentication mechanism for which the canonical form of the name
  70 is desired.
  71 The desired mechanism must be specified explicitly;
  72  no default is provided.
  73 .It output_name
  74 The resultant canonical name.
  75 Storage associated with this name must be freed by the application
  76 after use with a call to
  77 .Fn gss_release_name .
  78 .El
  79 .Sh RETURN VALUES
  80 .Bl -tag -width ".It GSS_S_BAD_NAMETYPE"
  81 .It GSS_S_COMPLETE
  82 Successful completion.
  83 .It GSS_S_BAD_MECH
  84 The identified mechanism is not supported.
  85 .It GSS_S_BAD_NAMETYPE
  86 The provided internal name contains no elements that could be
  87 processed by the specified mechanism.
  88 .It GSS_S_BAD_NAME
  89 The provided internal name was ill-formed.
  90 .El
  91 .Sh SEE ALSO
  92 .Xr gss_acquire_cred 3 ,
  93 .Xr gss_init_sec_context 3 ,
  94 .Xr gss_release_name 3
  95 .Sh STANDARDS
  96 .Bl -tag -width ".It RFC 2743"
  97 .It RFC 2743
  98 Generic Security Service Application Program Interface Version 2, Update 1
  99 .It RFC 2744
 100 Generic Security Service API Version 2 : C-bindings
 101 .El
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 function first appeared in
 106 .Fx 7.0 .
 107 .Sh AUTHORS
 108 John Wray, Iris Associates
 109 .Sh COPYRIGHT
 110 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 111 .Pp
 112 This document and translations of it may be copied and furnished to
 113 others, and derivative works that comment on or otherwise explain it
 114 or assist in its implementation may be prepared, copied, published
 115 and distributed, in whole or in part, without restriction of any
 116 kind, provided that the above copyright notice and this paragraph are
 117 included on all such copies and derivative works.  However, this
 118 document itself may not be modified in any way, such as by removing
 119 the copyright notice or references to the Internet Society or other
 120 Internet organizations, except as needed for the purpose of
 121 developing Internet standards in which case the procedures for
 122 copyrights defined in the Internet Standards process must be
 123 followed, or as required to translate it into languages other than
 124 English.
 125 .Pp
 126 The limited permissions granted above are perpetual and will not be
 127 revoked by the Internet Society or its successors or assigns.
 128 .Pp
 129 This document and the information contained herein is provided on an
 130 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 131 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 132 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 133 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 134 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.