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_INQUIRE_CRED 3 PRM 59.Sh NAME 60.Nm gss_inquire_cred 61.Nd Obtain information about a credential 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_inquire_cred 68.Fa "OM_uint32 *minor_status" 69.Fa "const gss_cred_id_t cred_handle" 70.Fa "gss_ctx_id_t *context_handle" 71.Fa "gss_name_t *name" 72.Fa "OM_uint32 *lifetime" 73.Fa "gss_cred_usage_t *cred_usage" 74.Fa "gss_OID_set *mechanisms" 75.Fc 76.Sh DESCRIPTION 77Obtains information about a credential. 78.Sh PARAMETERS 79.Bl -tag 80.It minor_status 81Mechanism specific status code. 82.It cred_handle 83A handle that refers to the target credential. 84Specify 85.Dv GSS_C_NO_CREDENTIAL 86to inquire about the default initiator principal. 87.It name 88The name whose identity the credential asserts. 89Storage associated with this name should be freed by the application 90after use with a call to 91.Fn gss_release_name . 92Specify 93.Dv NULL 94if not required. 95.It lifetime 96The number of seconds for which the credential will remain valid. 97If the credential has expired, 98this parameter will be set to zero. 99If the implementation does not support credential expiration, 100the value GSS_C_INDEFINITE will be returned. 101Specify 102.Dv NULL 103if not required. 104.It cred_usage 105How the credential may be used. 106One of the following: 107.Bl -item -offset indent -compact 108.It 109.Dv GSS_C_INITIATE 110.It 111.Dv GSS_C_ACCEPT 112.It 113.Dv GSS_C_BOTH 114.El 115Specify 116.Dv NULL 117if not required. 118.It mechanisms 119Set of mechanisms supported by the credential. 120Storage associated with this OID set must be freed by the application 121after use with a call to 122.Fn gss_release_oid_set . 123Specify 124.Dv NULL 125if not required. 126.El 127.Sh RETURN VALUES 128.Bl -tag 129.It GSS_S_COMPLETE 130Successful completion 131.It GSS_S_NO_CRED 132The referenced credentials could not be accessed 133.It GSS_S_DEFECTIVE_CREDENTIAL 134The referenced credentials were invalid 135.It GSS_S_CREDENTIALS_EXPIRED 136The referenced credentials have expired. 137If the lifetime parameter was not passed as 138.Dv NULL , 139it will be set to 0 140.El 141.Sh SEE ALSO 142.Xr gss_release_name 3 , 143.Xr gss_release_oid_set 3 144.Sh STANDARDS 145.Bl -tag 146.It RFC 2743 147Generic Security Service Application Program Interface Version 2, Update 1 148.It RFC 2744 149Generic Security Service API Version 2 : C-bindings 150.\" .Sh HISTORY 151.El 152.Sh HISTORY 153The 154.Nm 155manual page example first appeared in 156.Fx 7.0 . 157.Sh AUTHORS 158John Wray, Iris Associates 159