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