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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
.TH "gss_acquire_cred" 3 "1.0.4" "gss" "gss"
.SH NAME
gss_acquire_cred \- API function
.SH SYNOPSIS
.B #include <gss.h>
.sp
.BI "OM_uint32 gss_acquire_cred(OM_uint32 * " minor_status ", const gss_name_t " desired_name ", OM_uint32 " time_req ", const gss_OID_set " desired_mechs ", gss_cred_usage_t " cred_usage ", gss_cred_id_t * " output_cred_handle ", gss_OID_set * " actual_mechs ", OM_uint32 * " time_rec ");"
.SH ARGUMENTS
.IP "OM_uint32 * minor_status" 12
(integer, modify) Mechanism specific status code.
.IP "const gss_name_t desired_name" 12
(gss_name_t, read) Name of principal whose
credential should be acquired.
.IP "OM_uint32 time_req" 12
(Integer, read, optional) Number of seconds that
credentials should remain valid. Specify GSS_C_INDEFINITE to
request that the credentials have the maximum permitted lifetime.
.IP "const gss_OID_set desired_mechs" 12
(Set of Object IDs, read, optional) Set of
underlying security mechanisms that may be used.
GSS_C_NO_OID_SET may be used to obtain an implementation\-specific
default.
.IP "gss_cred_usage_t cred_usage" 12
(gss_cred_usage_t, read) GSS_C_BOTH \- Credentials may
be used either to initiate or accept security contexts.
GSS_C_INITIATE \- Credentials will only be used to initiate
security contexts. GSS_C_ACCEPT \- Credentials will only be used
to accept security contexts.
.IP "gss_cred_id_t * output_cred_handle" 12
(gss_cred_id_t, modify) The returned
credential handle. Resources associated with this credential
handle must be released by the application after use with a call
to \fBgss_release_cred()\fP.
.IP "gss_OID_set * actual_mechs" 12
(Set of Object IDs, modify, optional) The set of
mechanisms for which the credential is valid. Storage associated
with the returned OID\-set must be released by the application
after use with a call to \fBgss_release_oid_set()\fP. Specify NULL if
not required.
.IP "OM_uint32 * time_rec" 12
(Integer, modify, optional) Actual number of seconds for
which the returned credentials will remain valid. If the
implementation does not support expiration of credentials, the
value GSS_C_INDEFINITE will be returned. Specify NULL if not
required.
.SH "DESCRIPTION"
Allows an application to acquire a handle for a pre\-existing
credential by name. GSS\-API implementations must impose a local
access\-control policy on callers of this routine to prevent
unauthorized callers from acquiring credentials to which they are
not entitled. This routine is not intended to provide a "login to
the network" function, as such a function would involve the
creation of new credentials rather than merely acquiring a handle
to existing credentials. Such functions, if required, should be
defined in implementation\-specific extensions to the API.
If desired_name is GSS_C_NO_NAME, the call is interpreted as a
request for a credential handle that will invoke default behavior
when passed to \fBgss_init_sec_context()\fP (if cred_usage is
GSS_C_INITIATE or GSS_C_BOTH) or \fBgss_accept_sec_context()\fP (if
cred_usage is GSS_C_ACCEPT or GSS_C_BOTH).
Mechanisms should honor the desired_mechs parameter, and return a
credential that is suitable to use only with the requested
mechanisms. An exception to this is the case where one underlying
credential element can be shared by multiple mechanisms; in this
case it is permissible for an implementation to indicate all
mechanisms with which the credential element may be used. If
desired_mechs is an empty set, behavior is undefined.
This routine is expected to be used primarily by context acceptors,
since implementations are likely to provide mechanism\-specific ways
of obtaining GSS\-API initiator credentials from the system login
process. Some implementations may therefore not support the
acquisition of GSS_C_INITIATE or GSS_C_BOTH credentials via
gss_acquire_cred for any name other than GSS_C_NO_NAME, or a name
produced by applying either gss_inquire_cred to a valid credential,
or gss_inquire_context to an active context.
If credential acquisition is time\-consuming for a mechanism, the
mechanism may choose to delay the actual acquisition until the
credential is required (e.g. by gss_init_sec_context or
gss_accept_sec_context). Such mechanism\-specific implementation
decisions should be invisible to the calling application; thus a
call of gss_inquire_cred immediately following the call of
gss_acquire_cred must return valid credential data, and may
therefore incur the overhead of a deferred credential acquisition.
.SH "RETURN VALUE"
`GSS_S_COMPLETE`: Successful completion.
`GSS_S_BAD_MECH`: Unavailable mechanism requested.
`GSS_S_BAD_NAMETYPE`: Type contained within desired_name parameter
is not supported.
`GSS_S_BAD_NAME`: Value supplied for desired_name parameter is ill
formed.
`GSS_S_CREDENTIALS_EXPIRED`: The credentials could not be acquired
Because they have expired.
`GSS_S_NO_CRED`: No credentials were found for the specified name.
.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.
|
