lib/libgssapi/gss_export_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_EXPORT_NAME 3 PRM
  30 .Os
  31 .Sh NAME
  32 .Nm gss_export_name
  33 .Nd Convert an MN to export form
  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_export_name
  40 .Fa "OM_uint32 *minor_status"
  41 .Fa "const gss_name_t input_name"
  42 .Fa "gss_buffer_t exported_name"
  43 .Fc
  44 .Sh DESCRIPTION
  45 To produce a canonical contiguous string representation of a mechanism
  46 name (MN),
  47 suitable for direct comparison
  48 (e.g. with memcmp)
  49 for use in authorization functions
  50 (e.g. matching entries in an access-control list).
  51 The
  52 .Fa input_name
  53 parameter must specify a valid MN
  54 (i.e. an internal name generated by
  55 .Fn gss_accept_sec_context
  56 or by
  57 .Fn gss_canonicalize_name ).
  58 .Sh PARAMETERS
  59 .Bl -tag -width ".It exported_name"
  60 .It minor_status
  61 Mechanism specific status code.
  62 .It input_name
  63 The MN to be exported.
  64 .It exported_name
  65 The canonical contiguous string form of
  66 .Fa input_name .
  67 Storage associated with this string must freed by the application
  68 after use with
  69 .Fn gss_release_buffer .
  70 .El
  71 .Sh RETURN VALUES
  72 .Bl -tag -width ".It GSS_S_BAD_NAMETYPE"
  73 .It GSS_S_COMPLETE
  74 Successful completion
  75 .It GSS_S_NAME_NOT_MN
  76 The provided internal name was not a mechanism name.
  77 .It GSS_S_BAD_NAME
  78 The provided internal name was ill-formed.
  79 .It GSS_S_BAD_NAMETYPE
  80 The internal name was of a type not supported by the GSS-API implementation.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr gss_accept_sec_context 3 ,
  84 .Xr gss_canonicalize_name 3 ,
  85 .Xr gss_release_buffer 3
  86 .Sh STANDARDS
  87 .Bl -tag -width ".It RFC 2743"
  88 .It RFC 2743
  89 Generic Security Service Application Program Interface Version 2, Update 1
  90 .It RFC 2744
  91 Generic Security Service API Version 2 : C-bindings
  92 .El
  93 .Sh HISTORY
  94 The
  95 .Nm
  96 function first appeared in
  97 .Fx 7.0 .
  98 .Sh AUTHORS
  99 John Wray, Iris Associates
 100 .Sh COPYRIGHT
 101 Copyright (C) The Internet Society (2000).  All Rights Reserved.
 102 .Pp
 103 This document and translations of it may be copied and furnished to
 104 others, and derivative works that comment on or otherwise explain it
 105 or assist in its implementation may be prepared, copied, published
 106 and distributed, in whole or in part, without restriction of any
 107 kind, provided that the above copyright notice and this paragraph are
 108 included on all such copies and derivative works.  However, this
 109 document itself may not be modified in any way, such as by removing
 110 the copyright notice or references to the Internet Society or other
 111 Internet organizations, except as needed for the purpose of
 112 developing Internet standards in which case the procedures for
 113 copyrights defined in the Internet Standards process must be
 114 followed, or as required to translate it into languages other than
 115 English.
 116 .Pp
 117 The limited permissions granted above are perpetual and will not be
 118 revoked by the Internet Society or its successors or assigns.
 119 .Pp
 120 This document and the information contained herein is provided on an
 121 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 122 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 123 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 124 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
 125 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.