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