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_INQUIRE_CRED 3 PRM 33.Sh NAME 34.Nm gss_inquire_cred 35.Nd Obtain information about a credential 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_inquire_cred 42.Fa "OM_uint32 *minor_status" 43.Fa "const gss_cred_id_t cred_handle" 44.Fa "gss_ctx_id_t *context_handle" 45.Fa "gss_name_t *name" 46.Fa "OM_uint32 *lifetime" 47.Fa "gss_cred_usage_t *cred_usage" 48.Fa "gss_OID_set *mechanisms" 49.Fc 50.Sh DESCRIPTION 51Obtains information about a credential. 52.Sh PARAMETERS 53.Bl -tag 54.It minor_status 55Mechanism specific status code. 56.It cred_handle 57A handle that refers to the target credential. 58Specify 59.Dv GSS_C_NO_CREDENTIAL 60to inquire about the default initiator principal. 61.It name 62The name whose identity the credential asserts. 63Storage associated with this name should be freed by the application 64after use with a call to 65.Fn gss_release_name . 66Specify 67.Dv NULL 68if not required. 69.It lifetime 70The number of seconds for which the credential will remain valid. 71If the credential has expired, 72this parameter will be set to zero. 73If the implementation does not support credential expiration, 74the value GSS_C_INDEFINITE will be returned. 75Specify 76.Dv NULL 77if not required. 78.It cred_usage 79How the credential may be used. 80One of the following: 81.Bl -item -offset indent -compact 82.It 83.Dv GSS_C_INITIATE 84.It 85.Dv GSS_C_ACCEPT 86.It 87.Dv GSS_C_BOTH 88.El 89Specify 90.Dv NULL 91if not required. 92.It mechanisms 93Set of mechanisms supported by the credential. 94Storage associated with this OID set must be freed by the application 95after use with a call to 96.Fn gss_release_oid_set . 97Specify 98.Dv NULL 99if not required. 100.El 101.Sh RETURN VALUES 102.Bl -tag 103.It GSS_S_COMPLETE 104Successful completion 105.It GSS_S_NO_CRED 106The referenced credentials could not be accessed 107.It GSS_S_DEFECTIVE_CREDENTIAL 108The referenced credentials were invalid 109.It GSS_S_CREDENTIALS_EXPIRED 110The referenced credentials have expired. 111If the lifetime parameter was not passed as 112.Dv NULL , 113it will be set to 0 114.El 115.Sh SEE ALSO 116.Xr gss_release_name 3 , 117.Xr gss_release_oid_set 3 118.Sh STANDARDS 119.Bl -tag 120.It RFC 2743 121Generic Security Service Application Program Interface Version 2, Update 1 122.It RFC 2744 123Generic Security Service API Version 2 : C-bindings 124.\" .Sh HISTORY 125.El 126.Sh HISTORY 127The 128.Nm 129manual page example first appeared in 130.Fx 7.0 . 131.Sh AUTHORS 132John Wray, Iris Associates 133.Sh COPYRIGHT 134Copyright (C) The Internet Society (2000). All Rights Reserved. 135.Pp 136This document and translations of it may be copied and furnished to 137others, and derivative works that comment on or otherwise explain it 138or assist in its implementation may be prepared, copied, published 139and distributed, in whole or in part, without restriction of any 140kind, provided that the above copyright notice and this paragraph are 141included on all such copies and derivative works. However, this 142document itself may not be modified in any way, such as by removing 143the copyright notice or references to the Internet Society or other 144Internet organizations, except as needed for the purpose of 145developing Internet standards in which case the procedures for 146copyrights defined in the Internet Standards process must be 147followed, or as required to translate it into languages other than 148English. 149.Pp 150The limited permissions granted above are perpetual and will not be 151revoked by the Internet Society or its successors or assigns. 152.Pp 153This document and the information contained herein is provided on an 154"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 155TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 156BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 157HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 158MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 159