blob: 7063d856a598e3c4f1201c5df26ce86c6158538d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/net/sunrpc/gss_mech_switch.c
3 *
4 * Copyright (c) 2001 The Regents of the University of Michigan.
5 * All rights reserved.
6 *
7 * J. Bruce Fields <bfields@umich.edu>
8 *
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -08009 * Redistribution and use in source and binary forms, with or without
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -080016 * notice, this list of conditions and the following disclaimer in the
Linus Torvalds1da177e2005-04-16 15:20:36 -070017 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
29 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
35
36#include <linux/types.h>
37#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/module.h>
Chuck Leverf7832882013-03-16 15:54:52 -040039#include <linux/oid_registry.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/sunrpc/msg_prot.h>
41#include <linux/sunrpc/gss_asn1.h>
42#include <linux/sunrpc/auth_gss.h>
43#include <linux/sunrpc/svcauth_gss.h>
44#include <linux/sunrpc/gss_err.h>
45#include <linux/sunrpc/sched.h>
46#include <linux/sunrpc/gss_api.h>
47#include <linux/sunrpc/clnt.h>
48
Jeff Laytonf895b252014-11-17 16:58:04 -050049#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050# define RPCDBG_FACILITY RPCDBG_AUTH
51#endif
52
53static LIST_HEAD(registered_mechs);
54static DEFINE_SPINLOCK(registered_mechs_lock);
55
56static void
57gss_mech_free(struct gss_api_mech *gm)
58{
59 struct pf_desc *pf;
60 int i;
61
62 for (i = 0; i < gm->gm_pf_num; i++) {
63 pf = &gm->gm_pfs[i];
Jesper Juhla51482b2005-11-08 09:41:34 -080064 kfree(pf->auth_domain_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 pf->auth_domain_name = NULL;
66 }
67}
68
69static inline char *
70make_auth_domain_name(char *name)
71{
72 static char *prefix = "gss/";
73 char *new;
74
75 new = kmalloc(strlen(name) + strlen(prefix) + 1, GFP_KERNEL);
76 if (new) {
77 strcpy(new, prefix);
78 strcat(new, name);
79 }
80 return new;
81}
82
83static int
84gss_mech_svc_setup(struct gss_api_mech *gm)
85{
86 struct pf_desc *pf;
87 int i, status;
88
89 for (i = 0; i < gm->gm_pf_num; i++) {
90 pf = &gm->gm_pfs[i];
91 pf->auth_domain_name = make_auth_domain_name(pf->name);
92 status = -ENOMEM;
93 if (pf->auth_domain_name == NULL)
94 goto out;
95 status = svcauth_gss_register_pseudoflavor(pf->pseudoflavor,
96 pf->auth_domain_name);
97 if (status)
98 goto out;
99 }
100 return 0;
101out:
102 gss_mech_free(gm);
103 return status;
104}
105
Chuck Lever50072202013-03-16 15:55:27 -0400106/**
107 * gss_mech_register - register a GSS mechanism
108 * @gm: GSS mechanism handle
109 *
110 * Returns zero if successful, or a negative errno.
111 */
112int gss_mech_register(struct gss_api_mech *gm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
114 int status;
115
116 status = gss_mech_svc_setup(gm);
117 if (status)
118 return status;
119 spin_lock(&registered_mechs_lock);
120 list_add(&gm->gm_list, &registered_mechs);
121 spin_unlock(&registered_mechs_lock);
Chuck Lever8885cb32007-01-31 12:14:05 -0500122 dprintk("RPC: registered gss mechanism %s\n", gm->gm_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 return 0;
124}
Trond Myklebust7bd88262008-12-23 15:21:32 -0500125EXPORT_SYMBOL_GPL(gss_mech_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Chuck Lever50072202013-03-16 15:55:27 -0400127/**
128 * gss_mech_unregister - release a GSS mechanism
129 * @gm: GSS mechanism handle
130 *
131 */
132void gss_mech_unregister(struct gss_api_mech *gm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
134 spin_lock(&registered_mechs_lock);
135 list_del(&gm->gm_list);
136 spin_unlock(&registered_mechs_lock);
Chuck Lever8885cb32007-01-31 12:14:05 -0500137 dprintk("RPC: unregistered gss mechanism %s\n", gm->gm_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 gss_mech_free(gm);
139}
Trond Myklebust7bd88262008-12-23 15:21:32 -0500140EXPORT_SYMBOL_GPL(gss_mech_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
J. Bruce Fields0dc15312013-05-14 16:07:13 -0400142struct gss_api_mech *gss_mech_get(struct gss_api_mech *gm)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143{
144 __module_get(gm->gm_owner);
145 return gm;
146}
J. Bruce Fields0dc15312013-05-14 16:07:13 -0400147EXPORT_SYMBOL(gss_mech_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Trond Myklebustc5f5e9c2013-01-12 11:17:14 -0500149static struct gss_api_mech *
J. Bruce Fields058c5c92011-06-22 10:50:08 -0400150_gss_mech_get_by_name(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
152 struct gss_api_mech *pos, *gm = NULL;
153
154 spin_lock(&registered_mechs_lock);
155 list_for_each_entry(pos, &registered_mechs, gm_list) {
156 if (0 == strcmp(name, pos->gm_name)) {
157 if (try_module_get(pos->gm_owner))
158 gm = pos;
159 break;
160 }
161 }
162 spin_unlock(&registered_mechs_lock);
163 return gm;
164
165}
166
J. Bruce Fields058c5c92011-06-22 10:50:08 -0400167struct gss_api_mech * gss_mech_get_by_name(const char *name)
168{
169 struct gss_api_mech *gm = NULL;
170
171 gm = _gss_mech_get_by_name(name);
172 if (!gm) {
173 request_module("rpc-auth-gss-%s", name);
174 gm = _gss_mech_get_by_name(name);
175 }
176 return gm;
177}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
J. Bruce Fieldsb1df7632013-04-29 14:03:30 -0400179struct gss_api_mech *gss_mech_get_by_OID(struct rpcsec_gss_oid *obj)
Bryan Schumaker7ebb9312011-03-24 17:12:30 +0000180{
181 struct gss_api_mech *pos, *gm = NULL;
Chuck Leverf7832882013-03-16 15:54:52 -0400182 char buf[32];
183
184 if (sprint_oid(obj->data, obj->len, buf, sizeof(buf)) < 0)
185 return NULL;
186 dprintk("RPC: %s(%s)\n", __func__, buf);
187 request_module("rpc-auth-gss-%s", buf);
Bryan Schumaker7ebb9312011-03-24 17:12:30 +0000188
189 spin_lock(&registered_mechs_lock);
190 list_for_each_entry(pos, &registered_mechs, gm_list) {
191 if (obj->len == pos->gm_oid.len) {
192 if (0 == memcmp(obj->data, pos->gm_oid.data, obj->len)) {
193 if (try_module_get(pos->gm_owner))
194 gm = pos;
195 break;
196 }
197 }
198 }
199 spin_unlock(&registered_mechs_lock);
200 return gm;
Bryan Schumaker7ebb9312011-03-24 17:12:30 +0000201}
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203static inline int
204mech_supports_pseudoflavor(struct gss_api_mech *gm, u32 pseudoflavor)
205{
206 int i;
207
208 for (i = 0; i < gm->gm_pf_num; i++) {
209 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
210 return 1;
211 }
212 return 0;
213}
214
Trond Myklebustc5f5e9c2013-01-12 11:17:14 -0500215static struct gss_api_mech *_gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216{
J. Bruce Fields058c5c92011-06-22 10:50:08 -0400217 struct gss_api_mech *gm = NULL, *pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219 spin_lock(&registered_mechs_lock);
220 list_for_each_entry(pos, &registered_mechs, gm_list) {
Trond Myklebust7a9a7b72014-05-18 13:47:14 -0400221 if (!mech_supports_pseudoflavor(pos, pseudoflavor))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 if (try_module_get(pos->gm_owner))
224 gm = pos;
225 break;
226 }
227 spin_unlock(&registered_mechs_lock);
228 return gm;
229}
230
J. Bruce Fields058c5c92011-06-22 10:50:08 -0400231struct gss_api_mech *
232gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
233{
234 struct gss_api_mech *gm;
235
236 gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
237
238 if (!gm) {
239 request_module("rpc-auth-gss-%u", pseudoflavor);
240 gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
241 }
242 return gm;
243}
244
Chuck Lever6a1a1e32012-07-11 16:31:08 -0400245/**
246 * gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors
247 * @array: array to fill in
248 * @size: size of "array"
249 *
250 * Returns the number of array items filled in, or a negative errno.
251 *
252 * The returned array is not sorted by any policy. Callers should not
253 * rely on the order of the items in the returned array.
254 */
255int gss_mech_list_pseudoflavors(rpc_authflavor_t *array_ptr, int size)
Bryan Schumaker8f70e952011-03-24 17:12:31 +0000256{
257 struct gss_api_mech *pos = NULL;
Steve Dickson7bdf7412012-05-03 11:47:08 -0400258 int j, i = 0;
Bryan Schumaker8f70e952011-03-24 17:12:31 +0000259
260 spin_lock(&registered_mechs_lock);
261 list_for_each_entry(pos, &registered_mechs, gm_list) {
Chuck Lever6a1a1e32012-07-11 16:31:08 -0400262 for (j = 0; j < pos->gm_pf_num; j++) {
Trond Myklebust013448c2012-07-17 14:47:30 -0400263 if (i >= size) {
264 spin_unlock(&registered_mechs_lock);
Chuck Lever6a1a1e32012-07-11 16:31:08 -0400265 return -ENOMEM;
Trond Myklebust013448c2012-07-17 14:47:30 -0400266 }
Steve Dickson7bdf7412012-05-03 11:47:08 -0400267 array_ptr[i++] = pos->gm_pfs[j].pseudoflavor;
268 }
Bryan Schumaker8f70e952011-03-24 17:12:31 +0000269 }
270 spin_unlock(&registered_mechs_lock);
271 return i;
272}
273
Chuck Lever83523d02013-03-16 15:55:01 -0400274/**
275 * gss_svc_to_pseudoflavor - map a GSS service number to a pseudoflavor
276 * @gm: GSS mechanism handle
277 * @qop: GSS quality-of-protection value
278 * @service: GSS service value
279 *
280 * Returns a matching security flavor, or RPC_AUTH_MAXFLAVOR if none is found.
281 */
282rpc_authflavor_t gss_svc_to_pseudoflavor(struct gss_api_mech *gm, u32 qop,
283 u32 service)
Andy Adamsonc4170582007-07-17 04:04:42 -0700284{
285 int i;
286
287 for (i = 0; i < gm->gm_pf_num; i++) {
Chuck Lever83523d02013-03-16 15:55:01 -0400288 if (gm->gm_pfs[i].qop == qop &&
289 gm->gm_pfs[i].service == service) {
Andy Adamsonc4170582007-07-17 04:04:42 -0700290 return gm->gm_pfs[i].pseudoflavor;
291 }
292 }
Chuck Lever83523d02013-03-16 15:55:01 -0400293 return RPC_AUTH_MAXFLAVOR;
Andy Adamsonc4170582007-07-17 04:04:42 -0700294}
Andy Adamsonc4170582007-07-17 04:04:42 -0700295
Chuck Lever9568c5e2013-03-16 15:54:43 -0400296/**
297 * gss_mech_info2flavor - look up a pseudoflavor given a GSS tuple
298 * @info: a GSS mech OID, quality of protection, and service value
299 *
300 * Returns a matching pseudoflavor, or RPC_AUTH_MAXFLAVOR if the tuple is
301 * not supported.
302 */
303rpc_authflavor_t gss_mech_info2flavor(struct rpcsec_gss_info *info)
304{
305 rpc_authflavor_t pseudoflavor;
306 struct gss_api_mech *gm;
307
308 gm = gss_mech_get_by_OID(&info->oid);
309 if (gm == NULL)
310 return RPC_AUTH_MAXFLAVOR;
311
Chuck Lever83523d02013-03-16 15:55:01 -0400312 pseudoflavor = gss_svc_to_pseudoflavor(gm, info->qop, info->service);
Chuck Lever9568c5e2013-03-16 15:54:43 -0400313
314 gss_mech_put(gm);
315 return pseudoflavor;
316}
317
Chuck Levera77c8062013-03-16 15:55:10 -0400318/**
319 * gss_mech_flavor2info - look up a GSS tuple for a given pseudoflavor
320 * @pseudoflavor: GSS pseudoflavor to match
321 * @info: rpcsec_gss_info structure to fill in
322 *
323 * Returns zero and fills in "info" if pseudoflavor matches a
324 * supported mechanism. Otherwise a negative errno is returned.
325 */
326int gss_mech_flavor2info(rpc_authflavor_t pseudoflavor,
327 struct rpcsec_gss_info *info)
328{
329 struct gss_api_mech *gm;
330 int i;
331
332 gm = gss_mech_get_by_pseudoflavor(pseudoflavor);
333 if (gm == NULL)
334 return -ENOENT;
335
336 for (i = 0; i < gm->gm_pf_num; i++) {
337 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor) {
338 memcpy(info->oid.data, gm->gm_oid.data, gm->gm_oid.len);
339 info->oid.len = gm->gm_oid.len;
340 info->qop = gm->gm_pfs[i].qop;
341 info->service = gm->gm_pfs[i].service;
342 gss_mech_put(gm);
343 return 0;
344 }
345 }
346
347 gss_mech_put(gm);
348 return -ENOENT;
349}
Andy Adamsonc4170582007-07-17 04:04:42 -0700350
351u32
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352gss_pseudoflavor_to_service(struct gss_api_mech *gm, u32 pseudoflavor)
353{
354 int i;
355
356 for (i = 0; i < gm->gm_pf_num; i++) {
357 if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
358 return gm->gm_pfs[i].service;
359 }
360 return 0;
361}
J. Bruce Fields0dc15312013-05-14 16:07:13 -0400362EXPORT_SYMBOL(gss_pseudoflavor_to_service);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364char *
365gss_service_to_auth_domain_name(struct gss_api_mech *gm, u32 service)
366{
367 int i;
368
369 for (i = 0; i < gm->gm_pf_num; i++) {
370 if (gm->gm_pfs[i].service == service)
371 return gm->gm_pfs[i].auth_domain_name;
372 }
373 return NULL;
374}
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376void
377gss_mech_put(struct gss_api_mech * gm)
378{
J. Bruce Fields1df0cad2006-06-30 01:56:16 -0700379 if (gm)
380 module_put(gm->gm_owner);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381}
J. Bruce Fields0dc15312013-05-14 16:07:13 -0400382EXPORT_SYMBOL(gss_mech_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384/* The mech could probably be determined from the token instead, but it's just
385 * as easy for now to pass it in. */
386int
387gss_import_sec_context(const void *input_token, size_t bufsize,
388 struct gss_api_mech *mech,
Trond Myklebust1f4c86c2010-05-13 12:51:02 -0400389 struct gss_ctx **ctx_id,
Simo Sorce400f26b2012-05-25 18:09:53 -0400390 time_t *endtime,
Trond Myklebust1f4c86c2010-05-13 12:51:02 -0400391 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392{
Trond Myklebust1f4c86c2010-05-13 12:51:02 -0400393 if (!(*ctx_id = kzalloc(sizeof(**ctx_id), gfp_mask)))
Trond Myklebustb891e4a2009-12-18 16:28:12 -0500394 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 (*ctx_id)->mech_type = gss_mech_get(mech);
396
Simo Sorce400f26b2012-05-25 18:09:53 -0400397 return mech->gm_ops->gss_import_sec_context(input_token, bufsize,
398 *ctx_id, endtime, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399}
400
401/* gss_get_mic: compute a mic over message and return mic_token. */
402
403u32
404gss_get_mic(struct gss_ctx *context_handle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 struct xdr_buf *message,
406 struct xdr_netobj *mic_token)
407{
408 return context_handle->mech_type->gm_ops
409 ->gss_get_mic(context_handle,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 message,
411 mic_token);
412}
413
414/* gss_verify_mic: check whether the provided mic_token verifies message. */
415
416u32
417gss_verify_mic(struct gss_ctx *context_handle,
418 struct xdr_buf *message,
J. Bruce Fields00fd6e12005-10-13 16:55:18 -0400419 struct xdr_netobj *mic_token)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420{
421 return context_handle->mech_type->gm_ops
422 ->gss_verify_mic(context_handle,
423 message,
J. Bruce Fields00fd6e12005-10-13 16:55:18 -0400424 mic_token);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425}
426
Kevin Coffman75610422010-03-17 13:02:47 -0400427/*
428 * This function is called from both the client and server code.
429 * Each makes guarantees about how much "slack" space is available
430 * for the underlying function in "buf"'s head and tail while
431 * performing the wrap.
432 *
433 * The client and server code allocate RPC_MAX_AUTH_SIZE extra
434 * space in both the head and tail which is available for use by
435 * the wrap function.
436 *
437 * Underlying functions should verify they do not use more than
438 * RPC_MAX_AUTH_SIZE of extra space in either the head or tail
439 * when performing the wrap.
440 */
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400441u32
442gss_wrap(struct gss_ctx *ctx_id,
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400443 int offset,
444 struct xdr_buf *buf,
445 struct page **inpages)
446{
447 return ctx_id->mech_type->gm_ops
J. Bruce Fields00fd6e12005-10-13 16:55:18 -0400448 ->gss_wrap(ctx_id, offset, buf, inpages);
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400449}
450
451u32
452gss_unwrap(struct gss_ctx *ctx_id,
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400453 int offset,
454 struct xdr_buf *buf)
455{
456 return ctx_id->mech_type->gm_ops
J. Bruce Fields00fd6e12005-10-13 16:55:18 -0400457 ->gss_unwrap(ctx_id, offset, buf);
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400458}
459
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461/* gss_delete_sec_context: free all resources associated with context_handle.
462 * Note this differs from the RFC 2744-specified prototype in that we don't
463 * bother returning an output token, since it would never be used anyway. */
464
465u32
466gss_delete_sec_context(struct gss_ctx **context_handle)
467{
Chuck Lever8885cb32007-01-31 12:14:05 -0500468 dprintk("RPC: gss_delete_sec_context deleting %p\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 *context_handle);
470
471 if (!*context_handle)
Eric Dumazeta02cec22010-09-22 20:43:57 +0000472 return GSS_S_NO_CONTEXT;
Al Viro27724422008-03-17 22:48:03 -0700473 if ((*context_handle)->internal_ctx_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 (*context_handle)->mech_type->gm_ops
475 ->gss_delete_sec_context((*context_handle)
476 ->internal_ctx_id);
J. Bruce Fields1df0cad2006-06-30 01:56:16 -0700477 gss_mech_put((*context_handle)->mech_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 kfree(*context_handle);
479 *context_handle=NULL;
480 return GSS_S_COMPLETE;
481}