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