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