File: gss_inquire_cred_by_mech.3

package info (click to toggle)
gss 1.0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 8,168 kB
  • sloc: ansic: 22,018; sh: 7,410; python: 2,873; perl: 861; makefile: 334; xml: 52; sed: 16
file content (81 lines) | stat: -rw-r--r-- 3,487 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gss_inquire_cred_by_mech" 3 "1.0.4" "gss" "gss"
.SH NAME
gss_inquire_cred_by_mech \- API function
.SH SYNOPSIS
.B #include <gss.h>
.sp
.BI "OM_uint32 gss_inquire_cred_by_mech(OM_uint32 * " minor_status ", const gss_cred_id_t " cred_handle ", const gss_OID " mech_type ", gss_name_t * " name ", OM_uint32 * " initiator_lifetime ", OM_uint32 * " acceptor_lifetime ", gss_cred_usage_t * " cred_usage ");"
.SH ARGUMENTS
.IP "OM_uint32 * minor_status" 12
(Integer, modify) Mechanism specific status code.
.IP "const gss_cred_id_t cred_handle" 12
(gss_cred_id_t, read) A handle that refers to the
  target credential.  Specify GSS_C_NO_CREDENTIAL to inquire about
  the default initiator principal.
.IP "const gss_OID mech_type" 12
(gss_OID, read) The mechanism for which information
 should be returned.
.IP "gss_name_t * name" 12
(gss_name_t, modify, optional) The name whose identity the
  credential asserts.  Storage associated with this name must be
  freed by the application after use with a call to
  \fBgss_release_name()\fP.  Specify NULL if not required.
.IP "OM_uint32 * initiator_lifetime" 12
(Integer, modify, optional) The number of
  seconds for which the credential will remain capable of
  initiating security contexts under the specified mechanism.  If
  the credential can no longer be used to initiate contexts, or if
  the credential usage for this mechanism is GSS_C_ACCEPT, this
  parameter will be set to zero.  If the implementation does not
  support expiration of initiator credentials, the value
  GSS_C_INDEFINITE will be returned.  Specify NULL if not required.
.IP "OM_uint32 * acceptor_lifetime" 12
(Integer, modify, optional) The number of
  seconds for which the credential will remain capable of accepting
  security contexts under the specified mechanism.  If the
  credential can no longer be used to accept contexts, or if the
  credential usage for this mechanism is GSS_C_INITIATE, this
  parameter will be set to zero.  If the implementation does not
  support expiration of acceptor credentials, the value
  GSS_C_INDEFINITE will be returned.  Specify NULL if not required.
.IP "gss_cred_usage_t * cred_usage" 12
(gss_cred_usage_t, modify, optional) How the
  credential may be used with the specified mechanism.  One of the
  following: GSS_C_INITIATE, GSS_C_ACCEPT, GSS_C_BOTH. Specify NULL
  if not required.
.SH "DESCRIPTION"
Obtains per\-mechanism information about a credential.
.SH "RETURN VALUE"

`GSS_S_COMPLETE`: Successful completion.

`GSS_S_NO_CRED`: The referenced credentials could not be accessed.

`GSS_S_DEFECTIVE_CREDENTIAL`: The referenced credentials were invalid.

`GSS_S_CREDENTIALS_EXPIRED`: The referenced credentials have
expired.  If the lifetime parameter was not passed as NULL, it will
be set to 0.
.SH "REPORTING BUGS"
Report bugs to <bug-gss@gnu.org>.
GNU Generic Security Service home page: http://www.gnu.org/software/gss/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2003-2022 Simon Josefsson.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gss
is maintained as a Texinfo manual.  If the
.B info
and
.B gss
programs are properly installed at your site, the command
.IP
.B info gss
.PP
should give you access to the complete manual.