lib/libgssapi/gss_display_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 .\" Copyright (C) The Internet Society (2000).  All Rights Reserved.
  30 .\"
  31 .\" This document and translations of it may be copied and furnished to
  32 .\" others, and derivative works that comment on or otherwise explain it
  33 .\" or assist in its implementation may be prepared, copied, published
  34 .\" and distributed, in whole or in part, without restriction of any
  35 .\" kind, provided that the above copyright notice and this paragraph are
  36 .\" included on all such copies and derivative works.  However, this
  37 .\" document itself may not be modified in any way, such as by removing
  38 .\" the copyright notice or references to the Internet Society or other
  39 .\" Internet organizations, except as needed for the purpose of
  40 .\" developing Internet standards in which case the procedures for
  41 .\" copyrights defined in the Internet Standards process must be
  42 .\" followed, or as required to translate it into languages other than
  43 .\" English.
  44 .\"
  45 .\" The limited permissions granted above are perpetual and will not be
  46 .\" revoked by the Internet Society or its successors or assigns.
  47 .\"
  48 .\" This document and the information contained herein is provided on an
  49 .\" "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
  50 .\" TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
  51 .\" BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
  52 .\" HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
  53 .\" MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  54 .\"
  55 .\" The following commands are required for all man pages.
  56 .Dd November 12, 2005
  57 .Os
  58 .Dt GSS_DISPLAY_NAME 3 PRM
  59 .Sh NAME
  60 .Nm gss_display_name
  61 .Nd Convert internal-form name to text
  62 .\" This next command is for sections 2 and 3 only.
  63 .\" .Sh LIBRARY
  64 .Sh SYNOPSIS
  65 .In "gssapi/gssapi.h"
  66 .Ft OM_uint32
  67 .Fo gss_display_name
  68 .Fa "OM_uint32 *minor_status"
  69 .Fa "const gss_name_t input_name"
  70 .Fa "gss_buffer_t output_name_buffer"
  71 .Fa "gss_OID *output_name_type"
  72 .Fc
  73 .Sh DESCRIPTION
  74 Allows an application to obtain a textual representation of an opaque
  75 internal-form name for display purposes.
  76 The syntax of a printable name is defined by the GSS-API implementation.
  77 .Pp
  78 If
  79 .Fa input_name
  80 denotes an anonymous principal,
  81 the implementation should return the
  82 .Fa gss_OID
  83 value
  84 .Dv GSS_C_NT_ANONYMOUS
  85 as the
  86 .Fa output_name_type ,
  87 and a textual name that is syntactically distinct from all valid
  88 supported printable names in
  89 .Fa output_name_buffer .
  90 .Pp
  91 If
  92 .Fa input_name
  93 was created by a call to
  94 .Fn gss_import_name ,
  95 specifying
  96 .Dv GSS_C_NO_OID
  97 as the name-type,
  98 implementations that employ lazy conversion between name types may
  99 return
 100 .Dv GSS_C_NO_OID
 101 via the
 102 .Fa output_name_type
 103 parameter.
 104 .Sh PARAMETERS
 105 .Bl -tag
 106 .It minor_status
 107 Mechanism specific status code.
 108 .It input_name
 109 Name to be displayed.
 110 .It output_name_buffer
 111 Buffer to receive textual name string.
 112 The application must free storage associated with this name after use
 113 with a call to
 114 .Fn gss_release_buffer .
 115 .It output_name_type
 116 The type of the returned name.
 117 The returned
 118 .Fa gss_OID
 119 will be a pointer into static storage,
 120 and should be treated as read-only by the caller
 121 (in particular, the application should not attempt to free it).
 122 Specify
 123 .Dv NULL
 124 if not required.
 125 .El
 126 .Sh RETURN VALUES
 127 .Bl -tag
 128 .It GSS_S_COMPLETE
 129 Successful completion
 130 .It GSS_S_BAD_NAME
 131 .Fa input_name
 132 was ill-formed
 133 .El
 134 .Sh SEE ALSO
 135 .Xr gss_import_name 3 ,
 136 .Xr gss_release_buffer 3
 137 .Sh STANDARDS
 138 .Bl -tag
 139 .It RFC 2743
 140 Generic Security Service Application Program Interface Version 2, Update 1
 141 .It RFC 2744
 142 Generic Security Service API Version 2 : C-bindings
 143 .\" .Sh HISTORY
 144 .El
 145 .Sh HISTORY
 146 The
 147 .Nm
 148 manual page example first appeared in
 149 .Fx 7.0 .
 150 .Sh AUTHORS
 151 John Wray, Iris Associates