components/krb5/Solaris/man/gss_inquire_cred.3gss
changeset 5490 9bf0bc57423a
child 7820 a2b9a7de9e1a
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/krb5/Solaris/man/gss_inquire_cred.3gss	Wed Feb 24 10:43:57 2016 -0600
@@ -0,0 +1,174 @@
+'\" te
+.\" Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
+.TH gss_inquire_cred 3GSS "30 Jan 2004" "SunOS 5.12" "Generic Security Services API Library Functions"
+.SH NAME
+gss_inquire_cred \- obtain information about a credential
+.SH SYNOPSIS
+.LP
+.nf
+\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lgss\fR [ \fIlibrary\fR... ]
+#include <gssapi/gssapi.h>
+
+\fBOM_uint32\fR \fBgss_inquire_cred\fR(\fBOM_uint32 *\fR\fIminor_status\fR,
+     \fBconst gss_cred_id_t\fR \fIcred_handle\fR,\fBgss_name_t *\fR\fIname\fR,
+     \fBOM_uint32 *\fR\fIlifetime\fR, \fBgss_cred_usage_t *\fR\fIcred_usage\fR,
+     \fBgss_OID_set *\fR\fImechanisms\fR);
+.fi
+
+.SH PARAMETERS
+.sp
+.LP
+The parameter descriptions for \fBgss_inquire_cred()\fR follow:
+.sp
+.ne 2
+.mk
+.na
+\fB\fIminor_status\fR\fR
+.ad
+.RS 16n
+.rt  
+Mechanism specific status code.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIcred_handle\fR\fR
+.ad
+.RS 16n
+.rt  
+Handle that refers to the target credential. Specify \fBGSS_C_NO_CREDENTIAL\fR to inquire about the default initiator principal.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIname\fR\fR
+.ad
+.RS 16n
+.rt  
+Name of the identity asserted by the credential. Any storage associated with this name should be freed by the application after use by a call to \fBgss_release_name\fR(3GSS).
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIlifetime\fR\fR
+.ad
+.RS 16n
+.rt  
+Number of seconds for which the credential remains valid. If the credential has expired, this parameter will be set to zero. Specify \fBNULL\fR if the parameter is not required.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fIcred_usage\fR\fR
+.ad
+.RS 16n
+.rt  
+Flag that indicates how a credential is used. The \fIcred_usage\fR parameter may contain one of the following values: \fBGSS_C_INITIATE\fR, \fBGSS_C_ACCEPT\fR, or \fBGSS_C_BOTH\fR. Specify \fBNULL\fR if this parameter is not required.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fImechanisms\fR\fR
+.ad
+.RS 16n
+.rt  
+Set of mechanisms supported by the credential. Storage for the returned \fBOID\fR-set must be freed by the application after use by a call to \fBgss_release_oid_set\fR(3GSS). Specify \fBNULL\fR if this parameter is not required.
+.RE
+
+.SH DESCRIPTION
+.sp
+.LP
+Use the \fBgss_inquire_cred()\fR function to obtain information about a credential.
+.SH RETURN VALUES
+.sp
+.LP
+The \fBgss_inquire_cred()\fR function can return the following status codes:
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_COMPLETE\fR\fR
+.ad
+.RS 30n
+.rt  
+Successful completion.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_NO_CRED\fR\fR
+.ad
+.RS 30n
+.rt  
+The referenced credentials could not be accessed.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_DEFECTIVE_CREDENTIAL\fR\fR
+.ad
+.RS 30n
+.rt  
+The referenced credentials were invalid.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_CREDENTIALS_EXPIRED\fR\fR
+.ad
+.RS 30n
+.rt  
+The referenced credentials have expired. If the \fIlifetime\fR parameter was not passed as \fBNULL\fR, it will be set to \fB0\fR.
+.RE
+
+.sp
+.ne 2
+.mk
+.na
+\fB\fBGSS_S_FAILURE\fR\fR
+.ad
+.RS 30n
+.rt  
+The underlying mechanism detected an error for which no specific \fBGSS\fR status code is defined. The mechanism-specific status code reported by means of the \fIminor_status\fR parameter details the error condition.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See \fBattributes\fR(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+tab() box;
+cw(2.75i) |cw(2.75i) 
+lw(2.75i) |lw(2.75i) 
+.
+ATTRIBUTE TYPEATTRIBUTE VALUE
+_
+MT-LevelSafe
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+\fBgss_release_name\fR(3GSS), \fBgss_release_oid_set\fR(3GSS), \fBlibgss\fR(3LIB), \fBattributes\fR(5)
+.sp
+.LP
+\fI\fR