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>
24 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
25 # define RPCDBG_FACILITY RPCDBG_AUTH
28 static LIST_HEAD(registered_mechs);
29 static DEFINE_SPINLOCK(registered_mechs_lock);
32 gss_mech_free(struct gss_api_mech *gm)
37 for (i = 0; i < gm->gm_pf_num; i++) {
40 auth_domain_put(pf->domain);
41 kfree(pf->auth_domain_name);
42 pf->auth_domain_name = NULL;
47 make_auth_domain_name(char *name)
49 static char *prefix = "gss/";
52 new = kmalloc(strlen(name) + strlen(prefix) + 1, GFP_KERNEL);
61 gss_mech_svc_setup(struct gss_api_mech *gm)
63 struct auth_domain *dom;
67 for (i = 0; i < gm->gm_pf_num; i++) {
69 pf->auth_domain_name = make_auth_domain_name(pf->name);
71 if (pf->auth_domain_name == NULL)
73 dom = svcauth_gss_register_pseudoflavor(
74 pf->pseudoflavor, pf->auth_domain_name);
76 status = PTR_ERR(dom);
88 * gss_mech_register - register a GSS mechanism
89 * @gm: GSS mechanism handle
91 * Returns zero if successful, or a negative errno.
93 int gss_mech_register(struct gss_api_mech *gm)
97 status = gss_mech_svc_setup(gm);
100 spin_lock(®istered_mechs_lock);
101 list_add_rcu(&gm->gm_list, ®istered_mechs);
102 spin_unlock(®istered_mechs_lock);
103 dprintk("RPC: registered gss mechanism %s\n", gm->gm_name);
106 EXPORT_SYMBOL_GPL(gss_mech_register);
109 * gss_mech_unregister - release a GSS mechanism
110 * @gm: GSS mechanism handle
113 void gss_mech_unregister(struct gss_api_mech *gm)
115 spin_lock(®istered_mechs_lock);
116 list_del_rcu(&gm->gm_list);
117 spin_unlock(®istered_mechs_lock);
118 dprintk("RPC: unregistered gss mechanism %s\n", gm->gm_name);
121 EXPORT_SYMBOL_GPL(gss_mech_unregister);
123 struct gss_api_mech *gss_mech_get(struct gss_api_mech *gm)
125 __module_get(gm->gm_owner);
128 EXPORT_SYMBOL(gss_mech_get);
130 static struct gss_api_mech *
131 _gss_mech_get_by_name(const char *name)
133 struct gss_api_mech *pos, *gm = NULL;
136 list_for_each_entry_rcu(pos, ®istered_mechs, gm_list) {
137 if (0 == strcmp(name, pos->gm_name)) {
138 if (try_module_get(pos->gm_owner))
148 struct gss_api_mech * gss_mech_get_by_name(const char *name)
150 struct gss_api_mech *gm = NULL;
152 gm = _gss_mech_get_by_name(name);
154 request_module("rpc-auth-gss-%s", name);
155 gm = _gss_mech_get_by_name(name);
160 struct gss_api_mech *gss_mech_get_by_OID(struct rpcsec_gss_oid *obj)
162 struct gss_api_mech *pos, *gm = NULL;
165 if (sprint_oid(obj->data, obj->len, buf, sizeof(buf)) < 0)
167 dprintk("RPC: %s(%s)\n", __func__, buf);
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))
185 mech_supports_pseudoflavor(struct gss_api_mech *gm, u32 pseudoflavor)
189 for (i = 0; i < gm->gm_pf_num; i++) {
190 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
196 static struct gss_api_mech *_gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
198 struct gss_api_mech *gm = NULL, *pos;
201 list_for_each_entry_rcu(pos, ®istered_mechs, gm_list) {
202 if (!mech_supports_pseudoflavor(pos, pseudoflavor))
204 if (try_module_get(pos->gm_owner))
212 struct gss_api_mech *
213 gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
215 struct gss_api_mech *gm;
217 gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
220 request_module("rpc-auth-gss-%u", pseudoflavor);
221 gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
227 * gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors
228 * @array_ptr: array to fill in
229 * @size: size of "array"
231 * Returns the number of array items filled in, or a negative errno.
233 * The returned array is not sorted by any policy. Callers should not
234 * rely on the order of the items in the returned array.
236 int gss_mech_list_pseudoflavors(rpc_authflavor_t *array_ptr, int size)
238 struct gss_api_mech *pos = NULL;
242 list_for_each_entry_rcu(pos, ®istered_mechs, gm_list) {
243 for (j = 0; j < pos->gm_pf_num; j++) {
245 spin_unlock(®istered_mechs_lock);
248 array_ptr[i++] = pos->gm_pfs[j].pseudoflavor;
256 * gss_svc_to_pseudoflavor - map a GSS service number to a pseudoflavor
257 * @gm: GSS mechanism handle
258 * @qop: GSS quality-of-protection value
259 * @service: GSS service value
261 * Returns a matching security flavor, or RPC_AUTH_MAXFLAVOR if none is found.
263 rpc_authflavor_t gss_svc_to_pseudoflavor(struct gss_api_mech *gm, u32 qop,
268 for (i = 0; i < gm->gm_pf_num; i++) {
269 if (gm->gm_pfs[i].qop == qop &&
270 gm->gm_pfs[i].service == service) {
271 return gm->gm_pfs[i].pseudoflavor;
274 return RPC_AUTH_MAXFLAVOR;
278 * gss_mech_info2flavor - look up a pseudoflavor given a GSS tuple
279 * @info: a GSS mech OID, quality of protection, and service value
281 * Returns a matching pseudoflavor, or RPC_AUTH_MAXFLAVOR if the tuple is
284 rpc_authflavor_t gss_mech_info2flavor(struct rpcsec_gss_info *info)
286 rpc_authflavor_t pseudoflavor;
287 struct gss_api_mech *gm;
289 gm = gss_mech_get_by_OID(&info->oid);
291 return RPC_AUTH_MAXFLAVOR;
293 pseudoflavor = gss_svc_to_pseudoflavor(gm, info->qop, info->service);
300 * gss_mech_flavor2info - look up a GSS tuple for a given pseudoflavor
301 * @pseudoflavor: GSS pseudoflavor to match
302 * @info: rpcsec_gss_info structure to fill in
304 * Returns zero and fills in "info" if pseudoflavor matches a
305 * supported mechanism. Otherwise a negative errno is returned.
307 int gss_mech_flavor2info(rpc_authflavor_t pseudoflavor,
308 struct rpcsec_gss_info *info)
310 struct gss_api_mech *gm;
313 gm = gss_mech_get_by_pseudoflavor(pseudoflavor);
317 for (i = 0; i < gm->gm_pf_num; i++) {
318 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor) {
319 memcpy(info->oid.data, gm->gm_oid.data, gm->gm_oid.len);
320 info->oid.len = gm->gm_oid.len;
321 info->qop = gm->gm_pfs[i].qop;
322 info->service = gm->gm_pfs[i].service;
333 gss_pseudoflavor_to_service(struct gss_api_mech *gm, u32 pseudoflavor)
337 for (i = 0; i < gm->gm_pf_num; i++) {
338 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
339 return gm->gm_pfs[i].service;
343 EXPORT_SYMBOL(gss_pseudoflavor_to_service);
346 gss_pseudoflavor_to_datatouch(struct gss_api_mech *gm, u32 pseudoflavor)
350 for (i = 0; i < gm->gm_pf_num; i++) {
351 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
352 return gm->gm_pfs[i].datatouch;
358 gss_service_to_auth_domain_name(struct gss_api_mech *gm, u32 service)
362 for (i = 0; i < gm->gm_pf_num; i++) {
363 if (gm->gm_pfs[i].service == service)
364 return gm->gm_pfs[i].auth_domain_name;
370 gss_mech_put(struct gss_api_mech * gm)
373 module_put(gm->gm_owner);
375 EXPORT_SYMBOL(gss_mech_put);
377 /* The mech could probably be determined from the token instead, but it's just
378 * as easy for now to pass it in. */
380 gss_import_sec_context(const void *input_token, size_t bufsize,
381 struct gss_api_mech *mech,
382 struct gss_ctx **ctx_id,
386 if (!(*ctx_id = kzalloc(sizeof(**ctx_id), gfp_mask)))
388 (*ctx_id)->mech_type = gss_mech_get(mech);
390 return mech->gm_ops->gss_import_sec_context(input_token, bufsize,
391 *ctx_id, endtime, gfp_mask);
394 /* gss_get_mic: compute a mic over message and return mic_token. */
397 gss_get_mic(struct gss_ctx *context_handle,
398 struct xdr_buf *message,
399 struct xdr_netobj *mic_token)
401 return context_handle->mech_type->gm_ops
402 ->gss_get_mic(context_handle,
407 /* gss_verify_mic: check whether the provided mic_token verifies message. */
410 gss_verify_mic(struct gss_ctx *context_handle,
411 struct xdr_buf *message,
412 struct xdr_netobj *mic_token)
414 return context_handle->mech_type->gm_ops
415 ->gss_verify_mic(context_handle,
421 * This function is called from both the client and server code.
422 * Each makes guarantees about how much "slack" space is available
423 * for the underlying function in "buf"'s head and tail while
424 * performing the wrap.
426 * The client and server code allocate RPC_MAX_AUTH_SIZE extra
427 * space in both the head and tail which is available for use by
430 * Underlying functions should verify they do not use more than
431 * RPC_MAX_AUTH_SIZE of extra space in either the head or tail
432 * when performing the wrap.
435 gss_wrap(struct gss_ctx *ctx_id,
438 struct page **inpages)
440 return ctx_id->mech_type->gm_ops
441 ->gss_wrap(ctx_id, offset, buf, inpages);
445 gss_unwrap(struct gss_ctx *ctx_id,
450 return ctx_id->mech_type->gm_ops
451 ->gss_unwrap(ctx_id, offset, len, buf);
455 /* gss_delete_sec_context: free all resources associated with context_handle.
456 * Note this differs from the RFC 2744-specified prototype in that we don't
457 * bother returning an output token, since it would never be used anyway. */
460 gss_delete_sec_context(struct gss_ctx **context_handle)
462 dprintk("RPC: gss_delete_sec_context deleting %p\n",
465 if (!*context_handle)
466 return GSS_S_NO_CONTEXT;
467 if ((*context_handle)->internal_ctx_id)
468 (*context_handle)->mech_type->gm_ops
469 ->gss_delete_sec_context((*context_handle)
471 gss_mech_put((*context_handle)->mech_type);
472 kfree(*context_handle);
473 *context_handle=NULL;
474 return GSS_S_COMPLETE;