1 // SPDX-License-Identifier: BSD-3-Clause
3 * linux/net/sunrpc/gss_mech_switch.c
5 * Copyright (c) 2001 The Regents of the University of Michigan.
8 * J. Bruce Fields <bfields@umich.edu>
11 #include <linux/types.h>
12 #include <linux/slab.h>
13 #include <linux/module.h>
14 #include <linux/oid_registry.h>
15 #include <linux/sunrpc/msg_prot.h>
16 #include <linux/sunrpc/gss_asn1.h>
17 #include <linux/sunrpc/auth_gss.h>
18 #include <linux/sunrpc/svcauth_gss.h>
19 #include <linux/sunrpc/gss_err.h>
20 #include <linux/sunrpc/sched.h>
21 #include <linux/sunrpc/gss_api.h>
22 #include <linux/sunrpc/clnt.h>
23 #include <trace/events/rpcgss.h>
25 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
26 # define RPCDBG_FACILITY RPCDBG_AUTH
29 static LIST_HEAD(registered_mechs
);
30 static DEFINE_SPINLOCK(registered_mechs_lock
);
33 gss_mech_free(struct gss_api_mech
*gm
)
38 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
41 auth_domain_put(pf
->domain
);
42 kfree(pf
->auth_domain_name
);
43 pf
->auth_domain_name
= NULL
;
48 make_auth_domain_name(char *name
)
50 static char *prefix
= "gss/";
53 new = kmalloc(strlen(name
) + strlen(prefix
) + 1, GFP_KERNEL
);
62 gss_mech_svc_setup(struct gss_api_mech
*gm
)
64 struct auth_domain
*dom
;
68 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
70 pf
->auth_domain_name
= make_auth_domain_name(pf
->name
);
72 if (pf
->auth_domain_name
== NULL
)
74 dom
= svcauth_gss_register_pseudoflavor(
75 pf
->pseudoflavor
, pf
->auth_domain_name
);
77 status
= PTR_ERR(dom
);
89 * gss_mech_register - register a GSS mechanism
90 * @gm: GSS mechanism handle
92 * Returns zero if successful, or a negative errno.
94 int gss_mech_register(struct gss_api_mech
*gm
)
98 status
= gss_mech_svc_setup(gm
);
101 spin_lock(®istered_mechs_lock
);
102 list_add_rcu(&gm
->gm_list
, ®istered_mechs
);
103 spin_unlock(®istered_mechs_lock
);
104 dprintk("RPC: registered gss mechanism %s\n", gm
->gm_name
);
107 EXPORT_SYMBOL_GPL(gss_mech_register
);
110 * gss_mech_unregister - release a GSS mechanism
111 * @gm: GSS mechanism handle
114 void gss_mech_unregister(struct gss_api_mech
*gm
)
116 spin_lock(®istered_mechs_lock
);
117 list_del_rcu(&gm
->gm_list
);
118 spin_unlock(®istered_mechs_lock
);
119 dprintk("RPC: unregistered gss mechanism %s\n", gm
->gm_name
);
122 EXPORT_SYMBOL_GPL(gss_mech_unregister
);
124 struct gss_api_mech
*gss_mech_get(struct gss_api_mech
*gm
)
126 __module_get(gm
->gm_owner
);
129 EXPORT_SYMBOL(gss_mech_get
);
131 static struct gss_api_mech
*
132 _gss_mech_get_by_name(const char *name
)
134 struct gss_api_mech
*pos
, *gm
= NULL
;
137 list_for_each_entry_rcu(pos
, ®istered_mechs
, gm_list
) {
138 if (0 == strcmp(name
, pos
->gm_name
)) {
139 if (try_module_get(pos
->gm_owner
))
149 struct gss_api_mech
* gss_mech_get_by_name(const char *name
)
151 struct gss_api_mech
*gm
= NULL
;
153 gm
= _gss_mech_get_by_name(name
);
155 request_module("rpc-auth-gss-%s", name
);
156 gm
= _gss_mech_get_by_name(name
);
161 struct gss_api_mech
*gss_mech_get_by_OID(struct rpcsec_gss_oid
*obj
)
163 struct gss_api_mech
*pos
, *gm
= NULL
;
166 if (sprint_oid(obj
->data
, obj
->len
, buf
, sizeof(buf
)) < 0)
168 request_module("rpc-auth-gss-%s", buf
);
171 list_for_each_entry_rcu(pos
, ®istered_mechs
, gm_list
) {
172 if (obj
->len
== pos
->gm_oid
.len
) {
173 if (0 == memcmp(obj
->data
, pos
->gm_oid
.data
, obj
->len
)) {
174 if (try_module_get(pos
->gm_owner
))
182 trace_rpcgss_oid_to_mech(buf
);
187 mech_supports_pseudoflavor(struct gss_api_mech
*gm
, u32 pseudoflavor
)
191 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
192 if (gm
->gm_pfs
[i
].pseudoflavor
== pseudoflavor
)
198 static struct gss_api_mech
*_gss_mech_get_by_pseudoflavor(u32 pseudoflavor
)
200 struct gss_api_mech
*gm
= NULL
, *pos
;
203 list_for_each_entry_rcu(pos
, ®istered_mechs
, gm_list
) {
204 if (!mech_supports_pseudoflavor(pos
, pseudoflavor
))
206 if (try_module_get(pos
->gm_owner
))
214 struct gss_api_mech
*
215 gss_mech_get_by_pseudoflavor(u32 pseudoflavor
)
217 struct gss_api_mech
*gm
;
219 gm
= _gss_mech_get_by_pseudoflavor(pseudoflavor
);
222 request_module("rpc-auth-gss-%u", pseudoflavor
);
223 gm
= _gss_mech_get_by_pseudoflavor(pseudoflavor
);
229 * gss_svc_to_pseudoflavor - map a GSS service number to a pseudoflavor
230 * @gm: GSS mechanism handle
231 * @qop: GSS quality-of-protection value
232 * @service: GSS service value
234 * Returns a matching security flavor, or RPC_AUTH_MAXFLAVOR if none is found.
236 rpc_authflavor_t
gss_svc_to_pseudoflavor(struct gss_api_mech
*gm
, u32 qop
,
241 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
242 if (gm
->gm_pfs
[i
].qop
== qop
&&
243 gm
->gm_pfs
[i
].service
== service
) {
244 return gm
->gm_pfs
[i
].pseudoflavor
;
247 return RPC_AUTH_MAXFLAVOR
;
251 * gss_mech_info2flavor - look up a pseudoflavor given a GSS tuple
252 * @info: a GSS mech OID, quality of protection, and service value
254 * Returns a matching pseudoflavor, or RPC_AUTH_MAXFLAVOR if the tuple is
257 rpc_authflavor_t
gss_mech_info2flavor(struct rpcsec_gss_info
*info
)
259 rpc_authflavor_t pseudoflavor
;
260 struct gss_api_mech
*gm
;
262 gm
= gss_mech_get_by_OID(&info
->oid
);
264 return RPC_AUTH_MAXFLAVOR
;
266 pseudoflavor
= gss_svc_to_pseudoflavor(gm
, info
->qop
, info
->service
);
273 * gss_mech_flavor2info - look up a GSS tuple for a given pseudoflavor
274 * @pseudoflavor: GSS pseudoflavor to match
275 * @info: rpcsec_gss_info structure to fill in
277 * Returns zero and fills in "info" if pseudoflavor matches a
278 * supported mechanism. Otherwise a negative errno is returned.
280 int gss_mech_flavor2info(rpc_authflavor_t pseudoflavor
,
281 struct rpcsec_gss_info
*info
)
283 struct gss_api_mech
*gm
;
286 gm
= gss_mech_get_by_pseudoflavor(pseudoflavor
);
290 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
291 if (gm
->gm_pfs
[i
].pseudoflavor
== pseudoflavor
) {
292 memcpy(info
->oid
.data
, gm
->gm_oid
.data
, gm
->gm_oid
.len
);
293 info
->oid
.len
= gm
->gm_oid
.len
;
294 info
->qop
= gm
->gm_pfs
[i
].qop
;
295 info
->service
= gm
->gm_pfs
[i
].service
;
306 gss_pseudoflavor_to_service(struct gss_api_mech
*gm
, u32 pseudoflavor
)
310 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
311 if (gm
->gm_pfs
[i
].pseudoflavor
== pseudoflavor
)
312 return gm
->gm_pfs
[i
].service
;
316 EXPORT_SYMBOL(gss_pseudoflavor_to_service
);
319 gss_pseudoflavor_to_datatouch(struct gss_api_mech
*gm
, u32 pseudoflavor
)
323 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
324 if (gm
->gm_pfs
[i
].pseudoflavor
== pseudoflavor
)
325 return gm
->gm_pfs
[i
].datatouch
;
331 gss_service_to_auth_domain_name(struct gss_api_mech
*gm
, u32 service
)
335 for (i
= 0; i
< gm
->gm_pf_num
; i
++) {
336 if (gm
->gm_pfs
[i
].service
== service
)
337 return gm
->gm_pfs
[i
].auth_domain_name
;
343 gss_mech_put(struct gss_api_mech
* gm
)
346 module_put(gm
->gm_owner
);
348 EXPORT_SYMBOL(gss_mech_put
);
350 /* The mech could probably be determined from the token instead, but it's just
351 * as easy for now to pass it in. */
353 gss_import_sec_context(const void *input_token
, size_t bufsize
,
354 struct gss_api_mech
*mech
,
355 struct gss_ctx
**ctx_id
,
359 if (!(*ctx_id
= kzalloc(sizeof(**ctx_id
), gfp_mask
)))
361 (*ctx_id
)->mech_type
= gss_mech_get(mech
);
363 return mech
->gm_ops
->gss_import_sec_context(input_token
, bufsize
,
364 *ctx_id
, endtime
, gfp_mask
);
367 /* gss_get_mic: compute a mic over message and return mic_token. */
370 gss_get_mic(struct gss_ctx
*context_handle
,
371 struct xdr_buf
*message
,
372 struct xdr_netobj
*mic_token
)
374 return context_handle
->mech_type
->gm_ops
375 ->gss_get_mic(context_handle
,
380 /* gss_verify_mic: check whether the provided mic_token verifies message. */
383 gss_verify_mic(struct gss_ctx
*context_handle
,
384 struct xdr_buf
*message
,
385 struct xdr_netobj
*mic_token
)
387 return context_handle
->mech_type
->gm_ops
388 ->gss_verify_mic(context_handle
,
394 * This function is called from both the client and server code.
395 * Each makes guarantees about how much "slack" space is available
396 * for the underlying function in "buf"'s head and tail while
397 * performing the wrap.
399 * The client and server code allocate RPC_MAX_AUTH_SIZE extra
400 * space in both the head and tail which is available for use by
403 * Underlying functions should verify they do not use more than
404 * RPC_MAX_AUTH_SIZE of extra space in either the head or tail
405 * when performing the wrap.
408 gss_wrap(struct gss_ctx
*ctx_id
,
411 struct page
**inpages
)
413 return ctx_id
->mech_type
->gm_ops
414 ->gss_wrap(ctx_id
, offset
, buf
, inpages
);
418 gss_unwrap(struct gss_ctx
*ctx_id
,
423 return ctx_id
->mech_type
->gm_ops
424 ->gss_unwrap(ctx_id
, offset
, len
, buf
);
428 /* gss_delete_sec_context: free all resources associated with context_handle.
429 * Note this differs from the RFC 2744-specified prototype in that we don't
430 * bother returning an output token, since it would never be used anyway. */
433 gss_delete_sec_context(struct gss_ctx
**context_handle
)
435 dprintk("RPC: gss_delete_sec_context deleting %p\n",
438 if (!*context_handle
)
439 return GSS_S_NO_CONTEXT
;
440 if ((*context_handle
)->internal_ctx_id
)
441 (*context_handle
)->mech_type
->gm_ops
442 ->gss_delete_sec_context((*context_handle
)
444 gss_mech_put((*context_handle
)->mech_type
);
445 kfree(*context_handle
);
446 *context_handle
=NULL
;
447 return GSS_S_COMPLETE
;