blob: a1aa4f3d7e50ee91e28cbed8975156d93c0e9bcd [file] [log] [blame]
b.liue9582032025-04-17 19:18:16 +08001// SPDX-License-Identifier: BSD-3-Clause
2/*
3 * linux/net/sunrpc/auth_gss/auth_gss.c
4 *
5 * RPCSEC_GSS client authentication.
6 *
7 * Copyright (c) 2000 The Regents of the University of Michigan.
8 * All rights reserved.
9 *
10 * Dug Song <dugsong@monkey.org>
11 * Andy Adamson <andros@umich.edu>
12 */
13
14#include <linux/module.h>
15#include <linux/init.h>
16#include <linux/types.h>
17#include <linux/slab.h>
18#include <linux/sched.h>
19#include <linux/pagemap.h>
20#include <linux/sunrpc/clnt.h>
21#include <linux/sunrpc/auth.h>
22#include <linux/sunrpc/auth_gss.h>
23#include <linux/sunrpc/gss_krb5.h>
24#include <linux/sunrpc/svcauth_gss.h>
25#include <linux/sunrpc/gss_err.h>
26#include <linux/workqueue.h>
27#include <linux/sunrpc/rpc_pipe_fs.h>
28#include <linux/sunrpc/gss_api.h>
29#include <linux/uaccess.h>
30#include <linux/hashtable.h>
31
32#include "auth_gss_internal.h"
33#include "../netns.h"
34
35#include <trace/events/rpcgss.h>
36
37static const struct rpc_authops authgss_ops;
38
39static const struct rpc_credops gss_credops;
40static const struct rpc_credops gss_nullops;
41
42#define GSS_RETRY_EXPIRED 5
43static unsigned int gss_expired_cred_retry_delay = GSS_RETRY_EXPIRED;
44
45#define GSS_KEY_EXPIRE_TIMEO 240
46static unsigned int gss_key_expire_timeo = GSS_KEY_EXPIRE_TIMEO;
47
48#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
49# define RPCDBG_FACILITY RPCDBG_AUTH
50#endif
51
52#define GSS_CRED_SLACK (RPC_MAX_AUTH_SIZE * 2)
53/* length of a krb5 verifier (48), plus data added before arguments when
54 * using integrity (two 4-byte integers): */
55#define GSS_VERF_SLACK 100
56
57static DEFINE_HASHTABLE(gss_auth_hash_table, 4);
58static DEFINE_SPINLOCK(gss_auth_hash_lock);
59
60struct gss_pipe {
61 struct rpc_pipe_dir_object pdo;
62 struct rpc_pipe *pipe;
63 struct rpc_clnt *clnt;
64 const char *name;
65 struct kref kref;
66};
67
68struct gss_auth {
69 struct kref kref;
70 struct hlist_node hash;
71 struct rpc_auth rpc_auth;
72 struct gss_api_mech *mech;
73 enum rpc_gss_svc service;
74 struct rpc_clnt *client;
75 struct net *net;
76 /*
77 * There are two upcall pipes; dentry[1], named "gssd", is used
78 * for the new text-based upcall; dentry[0] is named after the
79 * mechanism (for example, "krb5") and exists for
80 * backwards-compatibility with older gssd's.
81 */
82 struct gss_pipe *gss_pipe[2];
83 const char *target_name;
84};
85
86/* pipe_version >= 0 if and only if someone has a pipe open. */
87static DEFINE_SPINLOCK(pipe_version_lock);
88static struct rpc_wait_queue pipe_version_rpc_waitqueue;
89static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue);
90static void gss_put_auth(struct gss_auth *gss_auth);
91
92static void gss_free_ctx(struct gss_cl_ctx *);
93static const struct rpc_pipe_ops gss_upcall_ops_v0;
94static const struct rpc_pipe_ops gss_upcall_ops_v1;
95
96static inline struct gss_cl_ctx *
97gss_get_ctx(struct gss_cl_ctx *ctx)
98{
99 refcount_inc(&ctx->count);
100 return ctx;
101}
102
103static inline void
104gss_put_ctx(struct gss_cl_ctx *ctx)
105{
106 if (refcount_dec_and_test(&ctx->count))
107 gss_free_ctx(ctx);
108}
109
110/* gss_cred_set_ctx:
111 * called by gss_upcall_callback and gss_create_upcall in order
112 * to set the gss context. The actual exchange of an old context
113 * and a new one is protected by the pipe->lock.
114 */
115static void
116gss_cred_set_ctx(struct rpc_cred *cred, struct gss_cl_ctx *ctx)
117{
118 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
119
120 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
121 return;
122 gss_get_ctx(ctx);
123 rcu_assign_pointer(gss_cred->gc_ctx, ctx);
124 set_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
125 smp_mb__before_atomic();
126 clear_bit(RPCAUTH_CRED_NEW, &cred->cr_flags);
127}
128
129static struct gss_cl_ctx *
130gss_cred_get_ctx(struct rpc_cred *cred)
131{
132 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
133 struct gss_cl_ctx *ctx = NULL;
134
135 rcu_read_lock();
136 ctx = rcu_dereference(gss_cred->gc_ctx);
137 if (ctx)
138 gss_get_ctx(ctx);
139 rcu_read_unlock();
140 return ctx;
141}
142
143static struct gss_cl_ctx *
144gss_alloc_context(void)
145{
146 struct gss_cl_ctx *ctx;
147
148 ctx = kzalloc(sizeof(*ctx), GFP_NOFS);
149 if (ctx != NULL) {
150 ctx->gc_proc = RPC_GSS_PROC_DATA;
151 ctx->gc_seq = 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
152 spin_lock_init(&ctx->gc_seq_lock);
153 refcount_set(&ctx->count,1);
154 }
155 return ctx;
156}
157
158#define GSSD_MIN_TIMEOUT (60 * 60)
159static const void *
160gss_fill_context(const void *p, const void *end, struct gss_cl_ctx *ctx, struct gss_api_mech *gm)
161{
162 const void *q;
163 unsigned int seclen;
164 unsigned int timeout;
165 unsigned long now = jiffies;
166 u32 window_size;
167 int ret;
168
169 /* First unsigned int gives the remaining lifetime in seconds of the
170 * credential - e.g. the remaining TGT lifetime for Kerberos or
171 * the -t value passed to GSSD.
172 */
173 p = simple_get_bytes(p, end, &timeout, sizeof(timeout));
174 if (IS_ERR(p))
175 goto err;
176 if (timeout == 0)
177 timeout = GSSD_MIN_TIMEOUT;
178 ctx->gc_expiry = now + ((unsigned long)timeout * HZ);
179 /* Sequence number window. Determines the maximum number of
180 * simultaneous requests
181 */
182 p = simple_get_bytes(p, end, &window_size, sizeof(window_size));
183 if (IS_ERR(p))
184 goto err;
185 ctx->gc_win = window_size;
186 /* gssd signals an error by passing ctx->gc_win = 0: */
187 if (ctx->gc_win == 0) {
188 /*
189 * in which case, p points to an error code. Anything other
190 * than -EKEYEXPIRED gets converted to -EACCES.
191 */
192 p = simple_get_bytes(p, end, &ret, sizeof(ret));
193 if (!IS_ERR(p))
194 p = (ret == -EKEYEXPIRED) ? ERR_PTR(-EKEYEXPIRED) :
195 ERR_PTR(-EACCES);
196 goto err;
197 }
198 /* copy the opaque wire context */
199 p = simple_get_netobj(p, end, &ctx->gc_wire_ctx);
200 if (IS_ERR(p))
201 goto err;
202 /* import the opaque security context */
203 p = simple_get_bytes(p, end, &seclen, sizeof(seclen));
204 if (IS_ERR(p))
205 goto err;
206 q = (const void *)((const char *)p + seclen);
207 if (unlikely(q > end || q < p)) {
208 p = ERR_PTR(-EFAULT);
209 goto err;
210 }
211 ret = gss_import_sec_context(p, seclen, gm, &ctx->gc_gss_ctx, NULL, GFP_NOFS);
212 if (ret < 0) {
213 trace_rpcgss_import_ctx(ret);
214 p = ERR_PTR(ret);
215 goto err;
216 }
217
218 /* is there any trailing data? */
219 if (q == end) {
220 p = q;
221 goto done;
222 }
223
224 /* pull in acceptor name (if there is one) */
225 p = simple_get_netobj(q, end, &ctx->gc_acceptor);
226 if (IS_ERR(p))
227 goto err;
228done:
229 trace_rpcgss_context(ctx->gc_expiry, now, timeout,
230 ctx->gc_acceptor.len, ctx->gc_acceptor.data);
231err:
232 return p;
233}
234
235/* XXX: Need some documentation about why UPCALL_BUF_LEN is so small.
236 * Is user space expecting no more than UPCALL_BUF_LEN bytes?
237 * Note that there are now _two_ NI_MAXHOST sized data items
238 * being passed in this string.
239 */
240#define UPCALL_BUF_LEN 256
241
242struct gss_upcall_msg {
243 refcount_t count;
244 kuid_t uid;
245 const char *service_name;
246 struct rpc_pipe_msg msg;
247 struct list_head list;
248 struct gss_auth *auth;
249 struct rpc_pipe *pipe;
250 struct rpc_wait_queue rpc_waitqueue;
251 wait_queue_head_t waitqueue;
252 struct gss_cl_ctx *ctx;
253 char databuf[UPCALL_BUF_LEN];
254};
255
256static int get_pipe_version(struct net *net)
257{
258 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
259 int ret;
260
261 spin_lock(&pipe_version_lock);
262 if (sn->pipe_version >= 0) {
263 atomic_inc(&sn->pipe_users);
264 ret = sn->pipe_version;
265 } else
266 ret = -EAGAIN;
267 spin_unlock(&pipe_version_lock);
268 return ret;
269}
270
271static void put_pipe_version(struct net *net)
272{
273 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
274
275 if (atomic_dec_and_lock(&sn->pipe_users, &pipe_version_lock)) {
276 sn->pipe_version = -1;
277 spin_unlock(&pipe_version_lock);
278 }
279}
280
281static void
282gss_release_msg(struct gss_upcall_msg *gss_msg)
283{
284 struct net *net = gss_msg->auth->net;
285 if (!refcount_dec_and_test(&gss_msg->count))
286 return;
287 put_pipe_version(net);
288 BUG_ON(!list_empty(&gss_msg->list));
289 if (gss_msg->ctx != NULL)
290 gss_put_ctx(gss_msg->ctx);
291 rpc_destroy_wait_queue(&gss_msg->rpc_waitqueue);
292 gss_put_auth(gss_msg->auth);
293 kfree_const(gss_msg->service_name);
294 kfree(gss_msg);
295}
296
297static struct gss_upcall_msg *
298__gss_find_upcall(struct rpc_pipe *pipe, kuid_t uid, const struct gss_auth *auth)
299{
300 struct gss_upcall_msg *pos;
301 list_for_each_entry(pos, &pipe->in_downcall, list) {
302 if (!uid_eq(pos->uid, uid))
303 continue;
304 if (pos->auth->service != auth->service)
305 continue;
306 refcount_inc(&pos->count);
307 return pos;
308 }
309 return NULL;
310}
311
312/* Try to add an upcall to the pipefs queue.
313 * If an upcall owned by our uid already exists, then we return a reference
314 * to that upcall instead of adding the new upcall.
315 */
316static inline struct gss_upcall_msg *
317gss_add_msg(struct gss_upcall_msg *gss_msg)
318{
319 struct rpc_pipe *pipe = gss_msg->pipe;
320 struct gss_upcall_msg *old;
321
322 spin_lock(&pipe->lock);
323 old = __gss_find_upcall(pipe, gss_msg->uid, gss_msg->auth);
324 if (old == NULL) {
325 refcount_inc(&gss_msg->count);
326 list_add(&gss_msg->list, &pipe->in_downcall);
327 } else
328 gss_msg = old;
329 spin_unlock(&pipe->lock);
330 return gss_msg;
331}
332
333static void
334__gss_unhash_msg(struct gss_upcall_msg *gss_msg)
335{
336 list_del_init(&gss_msg->list);
337 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
338 wake_up_all(&gss_msg->waitqueue);
339 refcount_dec(&gss_msg->count);
340}
341
342static void
343gss_unhash_msg(struct gss_upcall_msg *gss_msg)
344{
345 struct rpc_pipe *pipe = gss_msg->pipe;
346
347 if (list_empty(&gss_msg->list))
348 return;
349 spin_lock(&pipe->lock);
350 if (!list_empty(&gss_msg->list))
351 __gss_unhash_msg(gss_msg);
352 spin_unlock(&pipe->lock);
353}
354
355static void
356gss_handle_downcall_result(struct gss_cred *gss_cred, struct gss_upcall_msg *gss_msg)
357{
358 switch (gss_msg->msg.errno) {
359 case 0:
360 if (gss_msg->ctx == NULL)
361 break;
362 clear_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
363 gss_cred_set_ctx(&gss_cred->gc_base, gss_msg->ctx);
364 break;
365 case -EKEYEXPIRED:
366 set_bit(RPCAUTH_CRED_NEGATIVE, &gss_cred->gc_base.cr_flags);
367 }
368 gss_cred->gc_upcall_timestamp = jiffies;
369 gss_cred->gc_upcall = NULL;
370 rpc_wake_up_status(&gss_msg->rpc_waitqueue, gss_msg->msg.errno);
371}
372
373static void
374gss_upcall_callback(struct rpc_task *task)
375{
376 struct gss_cred *gss_cred = container_of(task->tk_rqstp->rq_cred,
377 struct gss_cred, gc_base);
378 struct gss_upcall_msg *gss_msg = gss_cred->gc_upcall;
379 struct rpc_pipe *pipe = gss_msg->pipe;
380
381 spin_lock(&pipe->lock);
382 gss_handle_downcall_result(gss_cred, gss_msg);
383 spin_unlock(&pipe->lock);
384 task->tk_status = gss_msg->msg.errno;
385 gss_release_msg(gss_msg);
386}
387
388static void gss_encode_v0_msg(struct gss_upcall_msg *gss_msg,
389 const struct cred *cred)
390{
391 struct user_namespace *userns = cred->user_ns;
392
393 uid_t uid = from_kuid_munged(userns, gss_msg->uid);
394 memcpy(gss_msg->databuf, &uid, sizeof(uid));
395 gss_msg->msg.data = gss_msg->databuf;
396 gss_msg->msg.len = sizeof(uid);
397
398 BUILD_BUG_ON(sizeof(uid) > sizeof(gss_msg->databuf));
399}
400
401static ssize_t
402gss_v0_upcall(struct file *file, struct rpc_pipe_msg *msg,
403 char __user *buf, size_t buflen)
404{
405 struct gss_upcall_msg *gss_msg = container_of(msg,
406 struct gss_upcall_msg,
407 msg);
408 if (msg->copied == 0)
409 gss_encode_v0_msg(gss_msg, file->f_cred);
410 return rpc_pipe_generic_upcall(file, msg, buf, buflen);
411}
412
413static int gss_encode_v1_msg(struct gss_upcall_msg *gss_msg,
414 const char *service_name,
415 const char *target_name,
416 const struct cred *cred)
417{
418 struct user_namespace *userns = cred->user_ns;
419 struct gss_api_mech *mech = gss_msg->auth->mech;
420 char *p = gss_msg->databuf;
421 size_t buflen = sizeof(gss_msg->databuf);
422 int len;
423
424 len = scnprintf(p, buflen, "mech=%s uid=%d", mech->gm_name,
425 from_kuid_munged(userns, gss_msg->uid));
426 buflen -= len;
427 p += len;
428 gss_msg->msg.len = len;
429
430 /*
431 * target= is a full service principal that names the remote
432 * identity that we are authenticating to.
433 */
434 if (target_name) {
435 len = scnprintf(p, buflen, " target=%s", target_name);
436 buflen -= len;
437 p += len;
438 gss_msg->msg.len += len;
439 }
440
441 /*
442 * gssd uses service= and srchost= to select a matching key from
443 * the system's keytab to use as the source principal.
444 *
445 * service= is the service name part of the source principal,
446 * or "*" (meaning choose any).
447 *
448 * srchost= is the hostname part of the source principal. When
449 * not provided, gssd uses the local hostname.
450 */
451 if (service_name) {
452 char *c = strchr(service_name, '@');
453
454 if (!c)
455 len = scnprintf(p, buflen, " service=%s",
456 service_name);
457 else
458 len = scnprintf(p, buflen,
459 " service=%.*s srchost=%s",
460 (int)(c - service_name),
461 service_name, c + 1);
462 buflen -= len;
463 p += len;
464 gss_msg->msg.len += len;
465 }
466
467 if (mech->gm_upcall_enctypes) {
468 len = scnprintf(p, buflen, " enctypes=%s",
469 mech->gm_upcall_enctypes);
470 buflen -= len;
471 p += len;
472 gss_msg->msg.len += len;
473 }
474 trace_rpcgss_upcall_msg(gss_msg->databuf);
475 len = scnprintf(p, buflen, "\n");
476 if (len == 0)
477 goto out_overflow;
478 gss_msg->msg.len += len;
479 gss_msg->msg.data = gss_msg->databuf;
480 return 0;
481out_overflow:
482 WARN_ON_ONCE(1);
483 return -ENOMEM;
484}
485
486static ssize_t
487gss_v1_upcall(struct file *file, struct rpc_pipe_msg *msg,
488 char __user *buf, size_t buflen)
489{
490 struct gss_upcall_msg *gss_msg = container_of(msg,
491 struct gss_upcall_msg,
492 msg);
493 int err;
494 if (msg->copied == 0) {
495 err = gss_encode_v1_msg(gss_msg,
496 gss_msg->service_name,
497 gss_msg->auth->target_name,
498 file->f_cred);
499 if (err)
500 return err;
501 }
502 return rpc_pipe_generic_upcall(file, msg, buf, buflen);
503}
504
505static struct gss_upcall_msg *
506gss_alloc_msg(struct gss_auth *gss_auth,
507 kuid_t uid, const char *service_name)
508{
509 struct gss_upcall_msg *gss_msg;
510 int vers;
511 int err = -ENOMEM;
512
513 gss_msg = kzalloc(sizeof(*gss_msg), GFP_NOFS);
514 if (gss_msg == NULL)
515 goto err;
516 vers = get_pipe_version(gss_auth->net);
517 err = vers;
518 if (err < 0)
519 goto err_free_msg;
520 gss_msg->pipe = gss_auth->gss_pipe[vers]->pipe;
521 INIT_LIST_HEAD(&gss_msg->list);
522 rpc_init_wait_queue(&gss_msg->rpc_waitqueue, "RPCSEC_GSS upcall waitq");
523 init_waitqueue_head(&gss_msg->waitqueue);
524 refcount_set(&gss_msg->count, 1);
525 gss_msg->uid = uid;
526 gss_msg->auth = gss_auth;
527 kref_get(&gss_auth->kref);
528 if (service_name) {
529 gss_msg->service_name = kstrdup_const(service_name, GFP_NOFS);
530 if (!gss_msg->service_name) {
531 err = -ENOMEM;
532 goto err_put_pipe_version;
533 }
534 }
535 return gss_msg;
536err_put_pipe_version:
537 put_pipe_version(gss_auth->net);
538err_free_msg:
539 kfree(gss_msg);
540err:
541 return ERR_PTR(err);
542}
543
544static struct gss_upcall_msg *
545gss_setup_upcall(struct gss_auth *gss_auth, struct rpc_cred *cred)
546{
547 struct gss_cred *gss_cred = container_of(cred,
548 struct gss_cred, gc_base);
549 struct gss_upcall_msg *gss_new, *gss_msg;
550 kuid_t uid = cred->cr_cred->fsuid;
551
552 gss_new = gss_alloc_msg(gss_auth, uid, gss_cred->gc_principal);
553 if (IS_ERR(gss_new))
554 return gss_new;
555 gss_msg = gss_add_msg(gss_new);
556 if (gss_msg == gss_new) {
557 int res;
558 refcount_inc(&gss_msg->count);
559 res = rpc_queue_upcall(gss_new->pipe, &gss_new->msg);
560 if (res) {
561 gss_unhash_msg(gss_new);
562 refcount_dec(&gss_msg->count);
563 gss_release_msg(gss_new);
564 gss_msg = ERR_PTR(res);
565 }
566 } else
567 gss_release_msg(gss_new);
568 return gss_msg;
569}
570
571static void warn_gssd(void)
572{
573 dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
574}
575
576static inline int
577gss_refresh_upcall(struct rpc_task *task)
578{
579 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
580 struct gss_auth *gss_auth = container_of(cred->cr_auth,
581 struct gss_auth, rpc_auth);
582 struct gss_cred *gss_cred = container_of(cred,
583 struct gss_cred, gc_base);
584 struct gss_upcall_msg *gss_msg;
585 struct rpc_pipe *pipe;
586 int err = 0;
587
588 gss_msg = gss_setup_upcall(gss_auth, cred);
589 if (PTR_ERR(gss_msg) == -EAGAIN) {
590 /* XXX: warning on the first, under the assumption we
591 * shouldn't normally hit this case on a refresh. */
592 warn_gssd();
593 rpc_sleep_on_timeout(&pipe_version_rpc_waitqueue,
594 task, NULL, jiffies + (15 * HZ));
595 err = -EAGAIN;
596 goto out;
597 }
598 if (IS_ERR(gss_msg)) {
599 err = PTR_ERR(gss_msg);
600 goto out;
601 }
602 pipe = gss_msg->pipe;
603 spin_lock(&pipe->lock);
604 if (gss_cred->gc_upcall != NULL)
605 rpc_sleep_on(&gss_cred->gc_upcall->rpc_waitqueue, task, NULL);
606 else if (gss_msg->ctx == NULL && gss_msg->msg.errno >= 0) {
607 gss_cred->gc_upcall = gss_msg;
608 /* gss_upcall_callback will release the reference to gss_upcall_msg */
609 refcount_inc(&gss_msg->count);
610 rpc_sleep_on(&gss_msg->rpc_waitqueue, task, gss_upcall_callback);
611 } else {
612 gss_handle_downcall_result(gss_cred, gss_msg);
613 err = gss_msg->msg.errno;
614 }
615 spin_unlock(&pipe->lock);
616 gss_release_msg(gss_msg);
617out:
618 trace_rpcgss_upcall_result(from_kuid(&init_user_ns,
619 cred->cr_cred->fsuid), err);
620 return err;
621}
622
623static inline int
624gss_create_upcall(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
625{
626 struct net *net = gss_auth->net;
627 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
628 struct rpc_pipe *pipe;
629 struct rpc_cred *cred = &gss_cred->gc_base;
630 struct gss_upcall_msg *gss_msg;
631 DEFINE_WAIT(wait);
632 int err;
633
634retry:
635 err = 0;
636 /* if gssd is down, just skip upcalling altogether */
637 if (!gssd_running(net)) {
638 warn_gssd();
639 err = -EACCES;
640 goto out;
641 }
642 gss_msg = gss_setup_upcall(gss_auth, cred);
643 if (PTR_ERR(gss_msg) == -EAGAIN) {
644 err = wait_event_interruptible_timeout(pipe_version_waitqueue,
645 sn->pipe_version >= 0, 15 * HZ);
646 if (sn->pipe_version < 0) {
647 warn_gssd();
648 err = -EACCES;
649 }
650 if (err < 0)
651 goto out;
652 goto retry;
653 }
654 if (IS_ERR(gss_msg)) {
655 err = PTR_ERR(gss_msg);
656 goto out;
657 }
658 pipe = gss_msg->pipe;
659 for (;;) {
660 prepare_to_wait(&gss_msg->waitqueue, &wait, TASK_KILLABLE);
661 spin_lock(&pipe->lock);
662 if (gss_msg->ctx != NULL || gss_msg->msg.errno < 0) {
663 break;
664 }
665 spin_unlock(&pipe->lock);
666 if (fatal_signal_pending(current)) {
667 err = -ERESTARTSYS;
668 goto out_intr;
669 }
670 schedule();
671 }
672 if (gss_msg->ctx)
673 gss_cred_set_ctx(cred, gss_msg->ctx);
674 else
675 err = gss_msg->msg.errno;
676 spin_unlock(&pipe->lock);
677out_intr:
678 finish_wait(&gss_msg->waitqueue, &wait);
679 gss_release_msg(gss_msg);
680out:
681 trace_rpcgss_upcall_result(from_kuid(&init_user_ns,
682 cred->cr_cred->fsuid), err);
683 return err;
684}
685
686static struct gss_upcall_msg *
687gss_find_downcall(struct rpc_pipe *pipe, kuid_t uid)
688{
689 struct gss_upcall_msg *pos;
690 list_for_each_entry(pos, &pipe->in_downcall, list) {
691 if (!uid_eq(pos->uid, uid))
692 continue;
693 if (!rpc_msg_is_inflight(&pos->msg))
694 continue;
695 refcount_inc(&pos->count);
696 return pos;
697 }
698 return NULL;
699}
700
701#define MSG_BUF_MAXSIZE 1024
702
703static ssize_t
704gss_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
705{
706 const void *p, *end;
707 void *buf;
708 struct gss_upcall_msg *gss_msg;
709 struct rpc_pipe *pipe = RPC_I(file_inode(filp))->pipe;
710 struct gss_cl_ctx *ctx;
711 uid_t id;
712 kuid_t uid;
713 ssize_t err = -EFBIG;
714
715 if (mlen > MSG_BUF_MAXSIZE)
716 goto out;
717 err = -ENOMEM;
718 buf = kmalloc(mlen, GFP_NOFS);
719 if (!buf)
720 goto out;
721
722 err = -EFAULT;
723 if (copy_from_user(buf, src, mlen))
724 goto err;
725
726 end = (const void *)((char *)buf + mlen);
727 p = simple_get_bytes(buf, end, &id, sizeof(id));
728 if (IS_ERR(p)) {
729 err = PTR_ERR(p);
730 goto err;
731 }
732
733 uid = make_kuid(current_user_ns(), id);
734 if (!uid_valid(uid)) {
735 err = -EINVAL;
736 goto err;
737 }
738
739 err = -ENOMEM;
740 ctx = gss_alloc_context();
741 if (ctx == NULL)
742 goto err;
743
744 err = -ENOENT;
745 /* Find a matching upcall */
746 spin_lock(&pipe->lock);
747 gss_msg = gss_find_downcall(pipe, uid);
748 if (gss_msg == NULL) {
749 spin_unlock(&pipe->lock);
750 goto err_put_ctx;
751 }
752 list_del_init(&gss_msg->list);
753 spin_unlock(&pipe->lock);
754
755 p = gss_fill_context(p, end, ctx, gss_msg->auth->mech);
756 if (IS_ERR(p)) {
757 err = PTR_ERR(p);
758 switch (err) {
759 case -EACCES:
760 case -EKEYEXPIRED:
761 gss_msg->msg.errno = err;
762 err = mlen;
763 break;
764 case -EFAULT:
765 case -ENOMEM:
766 case -EINVAL:
767 case -ENOSYS:
768 gss_msg->msg.errno = -EAGAIN;
769 break;
770 default:
771 printk(KERN_CRIT "%s: bad return from "
772 "gss_fill_context: %zd\n", __func__, err);
773 gss_msg->msg.errno = -EIO;
774 }
775 goto err_release_msg;
776 }
777 gss_msg->ctx = gss_get_ctx(ctx);
778 err = mlen;
779
780err_release_msg:
781 spin_lock(&pipe->lock);
782 __gss_unhash_msg(gss_msg);
783 spin_unlock(&pipe->lock);
784 gss_release_msg(gss_msg);
785err_put_ctx:
786 gss_put_ctx(ctx);
787err:
788 kfree(buf);
789out:
790 return err;
791}
792
793static int gss_pipe_open(struct inode *inode, int new_version)
794{
795 struct net *net = inode->i_sb->s_fs_info;
796 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
797 int ret = 0;
798
799 spin_lock(&pipe_version_lock);
800 if (sn->pipe_version < 0) {
801 /* First open of any gss pipe determines the version: */
802 sn->pipe_version = new_version;
803 rpc_wake_up(&pipe_version_rpc_waitqueue);
804 wake_up(&pipe_version_waitqueue);
805 } else if (sn->pipe_version != new_version) {
806 /* Trying to open a pipe of a different version */
807 ret = -EBUSY;
808 goto out;
809 }
810 atomic_inc(&sn->pipe_users);
811out:
812 spin_unlock(&pipe_version_lock);
813 return ret;
814
815}
816
817static int gss_pipe_open_v0(struct inode *inode)
818{
819 return gss_pipe_open(inode, 0);
820}
821
822static int gss_pipe_open_v1(struct inode *inode)
823{
824 return gss_pipe_open(inode, 1);
825}
826
827static void
828gss_pipe_release(struct inode *inode)
829{
830 struct net *net = inode->i_sb->s_fs_info;
831 struct rpc_pipe *pipe = RPC_I(inode)->pipe;
832 struct gss_upcall_msg *gss_msg;
833
834restart:
835 spin_lock(&pipe->lock);
836 list_for_each_entry(gss_msg, &pipe->in_downcall, list) {
837
838 if (!list_empty(&gss_msg->msg.list))
839 continue;
840 gss_msg->msg.errno = -EPIPE;
841 refcount_inc(&gss_msg->count);
842 __gss_unhash_msg(gss_msg);
843 spin_unlock(&pipe->lock);
844 gss_release_msg(gss_msg);
845 goto restart;
846 }
847 spin_unlock(&pipe->lock);
848
849 put_pipe_version(net);
850}
851
852static void
853gss_pipe_destroy_msg(struct rpc_pipe_msg *msg)
854{
855 struct gss_upcall_msg *gss_msg = container_of(msg, struct gss_upcall_msg, msg);
856
857 if (msg->errno < 0) {
858 refcount_inc(&gss_msg->count);
859 gss_unhash_msg(gss_msg);
860 if (msg->errno == -ETIMEDOUT)
861 warn_gssd();
862 gss_release_msg(gss_msg);
863 }
864 gss_release_msg(gss_msg);
865}
866
867static void gss_pipe_dentry_destroy(struct dentry *dir,
868 struct rpc_pipe_dir_object *pdo)
869{
870 struct gss_pipe *gss_pipe = pdo->pdo_data;
871 struct rpc_pipe *pipe = gss_pipe->pipe;
872
873 if (pipe->dentry != NULL) {
874 rpc_unlink(pipe->dentry);
875 pipe->dentry = NULL;
876 }
877}
878
879static int gss_pipe_dentry_create(struct dentry *dir,
880 struct rpc_pipe_dir_object *pdo)
881{
882 struct gss_pipe *p = pdo->pdo_data;
883 struct dentry *dentry;
884
885 dentry = rpc_mkpipe_dentry(dir, p->name, p->clnt, p->pipe);
886 if (IS_ERR(dentry))
887 return PTR_ERR(dentry);
888 p->pipe->dentry = dentry;
889 return 0;
890}
891
892static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops = {
893 .create = gss_pipe_dentry_create,
894 .destroy = gss_pipe_dentry_destroy,
895};
896
897static struct gss_pipe *gss_pipe_alloc(struct rpc_clnt *clnt,
898 const char *name,
899 const struct rpc_pipe_ops *upcall_ops)
900{
901 struct gss_pipe *p;
902 int err = -ENOMEM;
903
904 p = kmalloc(sizeof(*p), GFP_KERNEL);
905 if (p == NULL)
906 goto err;
907 p->pipe = rpc_mkpipe_data(upcall_ops, RPC_PIPE_WAIT_FOR_OPEN);
908 if (IS_ERR(p->pipe)) {
909 err = PTR_ERR(p->pipe);
910 goto err_free_gss_pipe;
911 }
912 p->name = name;
913 p->clnt = clnt;
914 kref_init(&p->kref);
915 rpc_init_pipe_dir_object(&p->pdo,
916 &gss_pipe_dir_object_ops,
917 p);
918 return p;
919err_free_gss_pipe:
920 kfree(p);
921err:
922 return ERR_PTR(err);
923}
924
925struct gss_alloc_pdo {
926 struct rpc_clnt *clnt;
927 const char *name;
928 const struct rpc_pipe_ops *upcall_ops;
929};
930
931static int gss_pipe_match_pdo(struct rpc_pipe_dir_object *pdo, void *data)
932{
933 struct gss_pipe *gss_pipe;
934 struct gss_alloc_pdo *args = data;
935
936 if (pdo->pdo_ops != &gss_pipe_dir_object_ops)
937 return 0;
938 gss_pipe = container_of(pdo, struct gss_pipe, pdo);
939 if (strcmp(gss_pipe->name, args->name) != 0)
940 return 0;
941 if (!kref_get_unless_zero(&gss_pipe->kref))
942 return 0;
943 return 1;
944}
945
946static struct rpc_pipe_dir_object *gss_pipe_alloc_pdo(void *data)
947{
948 struct gss_pipe *gss_pipe;
949 struct gss_alloc_pdo *args = data;
950
951 gss_pipe = gss_pipe_alloc(args->clnt, args->name, args->upcall_ops);
952 if (!IS_ERR(gss_pipe))
953 return &gss_pipe->pdo;
954 return NULL;
955}
956
957static struct gss_pipe *gss_pipe_get(struct rpc_clnt *clnt,
958 const char *name,
959 const struct rpc_pipe_ops *upcall_ops)
960{
961 struct net *net = rpc_net_ns(clnt);
962 struct rpc_pipe_dir_object *pdo;
963 struct gss_alloc_pdo args = {
964 .clnt = clnt,
965 .name = name,
966 .upcall_ops = upcall_ops,
967 };
968
969 pdo = rpc_find_or_alloc_pipe_dir_object(net,
970 &clnt->cl_pipedir_objects,
971 gss_pipe_match_pdo,
972 gss_pipe_alloc_pdo,
973 &args);
974 if (pdo != NULL)
975 return container_of(pdo, struct gss_pipe, pdo);
976 return ERR_PTR(-ENOMEM);
977}
978
979static void __gss_pipe_free(struct gss_pipe *p)
980{
981 struct rpc_clnt *clnt = p->clnt;
982 struct net *net = rpc_net_ns(clnt);
983
984 rpc_remove_pipe_dir_object(net,
985 &clnt->cl_pipedir_objects,
986 &p->pdo);
987 rpc_destroy_pipe_data(p->pipe);
988 kfree(p);
989}
990
991static void __gss_pipe_release(struct kref *kref)
992{
993 struct gss_pipe *p = container_of(kref, struct gss_pipe, kref);
994
995 __gss_pipe_free(p);
996}
997
998static void gss_pipe_free(struct gss_pipe *p)
999{
1000 if (p != NULL)
1001 kref_put(&p->kref, __gss_pipe_release);
1002}
1003
1004/*
1005 * NOTE: we have the opportunity to use different
1006 * parameters based on the input flavor (which must be a pseudoflavor)
1007 */
1008static struct gss_auth *
1009gss_create_new(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1010{
1011 rpc_authflavor_t flavor = args->pseudoflavor;
1012 struct gss_auth *gss_auth;
1013 struct gss_pipe *gss_pipe;
1014 struct rpc_auth * auth;
1015 int err = -ENOMEM; /* XXX? */
1016
1017 if (!try_module_get(THIS_MODULE))
1018 return ERR_PTR(err);
1019 if (!(gss_auth = kmalloc(sizeof(*gss_auth), GFP_KERNEL)))
1020 goto out_dec;
1021 INIT_HLIST_NODE(&gss_auth->hash);
1022 gss_auth->target_name = NULL;
1023 if (args->target_name) {
1024 gss_auth->target_name = kstrdup(args->target_name, GFP_KERNEL);
1025 if (gss_auth->target_name == NULL)
1026 goto err_free;
1027 }
1028 gss_auth->client = clnt;
1029 gss_auth->net = get_net(rpc_net_ns(clnt));
1030 err = -EINVAL;
1031 gss_auth->mech = gss_mech_get_by_pseudoflavor(flavor);
1032 if (!gss_auth->mech)
1033 goto err_put_net;
1034 gss_auth->service = gss_pseudoflavor_to_service(gss_auth->mech, flavor);
1035 if (gss_auth->service == 0)
1036 goto err_put_mech;
1037 if (!gssd_running(gss_auth->net))
1038 goto err_put_mech;
1039 auth = &gss_auth->rpc_auth;
1040 auth->au_cslack = GSS_CRED_SLACK >> 2;
1041 auth->au_rslack = GSS_KRB5_MAX_SLACK_NEEDED >> 2;
1042 auth->au_verfsize = GSS_VERF_SLACK >> 2;
1043 auth->au_ralign = GSS_VERF_SLACK >> 2;
1044 auth->au_flags = 0;
1045 auth->au_ops = &authgss_ops;
1046 auth->au_flavor = flavor;
1047 if (gss_pseudoflavor_to_datatouch(gss_auth->mech, flavor))
1048 auth->au_flags |= RPCAUTH_AUTH_DATATOUCH;
1049 refcount_set(&auth->au_count, 1);
1050 kref_init(&gss_auth->kref);
1051
1052 err = rpcauth_init_credcache(auth);
1053 if (err)
1054 goto err_put_mech;
1055 /*
1056 * Note: if we created the old pipe first, then someone who
1057 * examined the directory at the right moment might conclude
1058 * that we supported only the old pipe. So we instead create
1059 * the new pipe first.
1060 */
1061 gss_pipe = gss_pipe_get(clnt, "gssd", &gss_upcall_ops_v1);
1062 if (IS_ERR(gss_pipe)) {
1063 err = PTR_ERR(gss_pipe);
1064 goto err_destroy_credcache;
1065 }
1066 gss_auth->gss_pipe[1] = gss_pipe;
1067
1068 gss_pipe = gss_pipe_get(clnt, gss_auth->mech->gm_name,
1069 &gss_upcall_ops_v0);
1070 if (IS_ERR(gss_pipe)) {
1071 err = PTR_ERR(gss_pipe);
1072 goto err_destroy_pipe_1;
1073 }
1074 gss_auth->gss_pipe[0] = gss_pipe;
1075
1076 return gss_auth;
1077err_destroy_pipe_1:
1078 gss_pipe_free(gss_auth->gss_pipe[1]);
1079err_destroy_credcache:
1080 rpcauth_destroy_credcache(auth);
1081err_put_mech:
1082 gss_mech_put(gss_auth->mech);
1083err_put_net:
1084 put_net(gss_auth->net);
1085err_free:
1086 kfree(gss_auth->target_name);
1087 kfree(gss_auth);
1088out_dec:
1089 module_put(THIS_MODULE);
1090 trace_rpcgss_createauth(flavor, err);
1091 return ERR_PTR(err);
1092}
1093
1094static void
1095gss_free(struct gss_auth *gss_auth)
1096{
1097 gss_pipe_free(gss_auth->gss_pipe[0]);
1098 gss_pipe_free(gss_auth->gss_pipe[1]);
1099 gss_mech_put(gss_auth->mech);
1100 put_net(gss_auth->net);
1101 kfree(gss_auth->target_name);
1102
1103 kfree(gss_auth);
1104 module_put(THIS_MODULE);
1105}
1106
1107static void
1108gss_free_callback(struct kref *kref)
1109{
1110 struct gss_auth *gss_auth = container_of(kref, struct gss_auth, kref);
1111
1112 gss_free(gss_auth);
1113}
1114
1115static void
1116gss_put_auth(struct gss_auth *gss_auth)
1117{
1118 kref_put(&gss_auth->kref, gss_free_callback);
1119}
1120
1121static void
1122gss_destroy(struct rpc_auth *auth)
1123{
1124 struct gss_auth *gss_auth = container_of(auth,
1125 struct gss_auth, rpc_auth);
1126
1127 if (hash_hashed(&gss_auth->hash)) {
1128 spin_lock(&gss_auth_hash_lock);
1129 hash_del(&gss_auth->hash);
1130 spin_unlock(&gss_auth_hash_lock);
1131 }
1132
1133 gss_pipe_free(gss_auth->gss_pipe[0]);
1134 gss_auth->gss_pipe[0] = NULL;
1135 gss_pipe_free(gss_auth->gss_pipe[1]);
1136 gss_auth->gss_pipe[1] = NULL;
1137 rpcauth_destroy_credcache(auth);
1138
1139 gss_put_auth(gss_auth);
1140}
1141
1142/*
1143 * Auths may be shared between rpc clients that were cloned from a
1144 * common client with the same xprt, if they also share the flavor and
1145 * target_name.
1146 *
1147 * The auth is looked up from the oldest parent sharing the same
1148 * cl_xprt, and the auth itself references only that common parent
1149 * (which is guaranteed to last as long as any of its descendants).
1150 */
1151static struct gss_auth *
1152gss_auth_find_or_add_hashed(const struct rpc_auth_create_args *args,
1153 struct rpc_clnt *clnt,
1154 struct gss_auth *new)
1155{
1156 struct gss_auth *gss_auth;
1157 unsigned long hashval = (unsigned long)clnt;
1158
1159 spin_lock(&gss_auth_hash_lock);
1160 hash_for_each_possible(gss_auth_hash_table,
1161 gss_auth,
1162 hash,
1163 hashval) {
1164 if (gss_auth->client != clnt)
1165 continue;
1166 if (gss_auth->rpc_auth.au_flavor != args->pseudoflavor)
1167 continue;
1168 if (gss_auth->target_name != args->target_name) {
1169 if (gss_auth->target_name == NULL)
1170 continue;
1171 if (args->target_name == NULL)
1172 continue;
1173 if (strcmp(gss_auth->target_name, args->target_name))
1174 continue;
1175 }
1176 if (!refcount_inc_not_zero(&gss_auth->rpc_auth.au_count))
1177 continue;
1178 goto out;
1179 }
1180 if (new)
1181 hash_add(gss_auth_hash_table, &new->hash, hashval);
1182 gss_auth = new;
1183out:
1184 spin_unlock(&gss_auth_hash_lock);
1185 return gss_auth;
1186}
1187
1188static struct gss_auth *
1189gss_create_hashed(const struct rpc_auth_create_args *args,
1190 struct rpc_clnt *clnt)
1191{
1192 struct gss_auth *gss_auth;
1193 struct gss_auth *new;
1194
1195 gss_auth = gss_auth_find_or_add_hashed(args, clnt, NULL);
1196 if (gss_auth != NULL)
1197 goto out;
1198 new = gss_create_new(args, clnt);
1199 if (IS_ERR(new))
1200 return new;
1201 gss_auth = gss_auth_find_or_add_hashed(args, clnt, new);
1202 if (gss_auth != new)
1203 gss_destroy(&new->rpc_auth);
1204out:
1205 return gss_auth;
1206}
1207
1208static struct rpc_auth *
1209gss_create(const struct rpc_auth_create_args *args, struct rpc_clnt *clnt)
1210{
1211 struct gss_auth *gss_auth;
1212 struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
1213
1214 while (clnt != clnt->cl_parent) {
1215 struct rpc_clnt *parent = clnt->cl_parent;
1216 /* Find the original parent for this transport */
1217 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
1218 break;
1219 clnt = parent;
1220 }
1221
1222 gss_auth = gss_create_hashed(args, clnt);
1223 if (IS_ERR(gss_auth))
1224 return ERR_CAST(gss_auth);
1225 return &gss_auth->rpc_auth;
1226}
1227
1228static struct gss_cred *
1229gss_dup_cred(struct gss_auth *gss_auth, struct gss_cred *gss_cred)
1230{
1231 struct gss_cred *new;
1232
1233 /* Make a copy of the cred so that we can reference count it */
1234 new = kzalloc(sizeof(*gss_cred), GFP_NOFS);
1235 if (new) {
1236 struct auth_cred acred = {
1237 .cred = gss_cred->gc_base.cr_cred,
1238 };
1239 struct gss_cl_ctx *ctx =
1240 rcu_dereference_protected(gss_cred->gc_ctx, 1);
1241
1242 rpcauth_init_cred(&new->gc_base, &acred,
1243 &gss_auth->rpc_auth,
1244 &gss_nullops);
1245 new->gc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE;
1246 new->gc_service = gss_cred->gc_service;
1247 new->gc_principal = gss_cred->gc_principal;
1248 kref_get(&gss_auth->kref);
1249 rcu_assign_pointer(new->gc_ctx, ctx);
1250 gss_get_ctx(ctx);
1251 }
1252 return new;
1253}
1254
1255/*
1256 * gss_send_destroy_context will cause the RPCSEC_GSS to send a NULL RPC call
1257 * to the server with the GSS control procedure field set to
1258 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1259 * all RPCSEC_GSS state associated with that context.
1260 */
1261static void
1262gss_send_destroy_context(struct rpc_cred *cred)
1263{
1264 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1265 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1266 struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1267 struct gss_cred *new;
1268 struct rpc_task *task;
1269
1270 new = gss_dup_cred(gss_auth, gss_cred);
1271 if (new) {
1272 ctx->gc_proc = RPC_GSS_PROC_DESTROY;
1273
1274 task = rpc_call_null(gss_auth->client, &new->gc_base,
1275 RPC_TASK_ASYNC|RPC_TASK_SOFT);
1276 if (!IS_ERR(task))
1277 rpc_put_task(task);
1278
1279 put_rpccred(&new->gc_base);
1280 }
1281}
1282
1283/* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1284 * to create a new cred or context, so they check that things have been
1285 * allocated before freeing them. */
1286static void
1287gss_do_free_ctx(struct gss_cl_ctx *ctx)
1288{
1289 gss_delete_sec_context(&ctx->gc_gss_ctx);
1290 kfree(ctx->gc_wire_ctx.data);
1291 kfree(ctx->gc_acceptor.data);
1292 kfree(ctx);
1293}
1294
1295static void
1296gss_free_ctx_callback(struct rcu_head *head)
1297{
1298 struct gss_cl_ctx *ctx = container_of(head, struct gss_cl_ctx, gc_rcu);
1299 gss_do_free_ctx(ctx);
1300}
1301
1302static void
1303gss_free_ctx(struct gss_cl_ctx *ctx)
1304{
1305 call_rcu(&ctx->gc_rcu, gss_free_ctx_callback);
1306}
1307
1308static void
1309gss_free_cred(struct gss_cred *gss_cred)
1310{
1311 kfree(gss_cred);
1312}
1313
1314static void
1315gss_free_cred_callback(struct rcu_head *head)
1316{
1317 struct gss_cred *gss_cred = container_of(head, struct gss_cred, gc_base.cr_rcu);
1318 gss_free_cred(gss_cred);
1319}
1320
1321static void
1322gss_destroy_nullcred(struct rpc_cred *cred)
1323{
1324 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1325 struct gss_auth *gss_auth = container_of(cred->cr_auth, struct gss_auth, rpc_auth);
1326 struct gss_cl_ctx *ctx = rcu_dereference_protected(gss_cred->gc_ctx, 1);
1327
1328 RCU_INIT_POINTER(gss_cred->gc_ctx, NULL);
1329 put_cred(cred->cr_cred);
1330 call_rcu(&cred->cr_rcu, gss_free_cred_callback);
1331 if (ctx)
1332 gss_put_ctx(ctx);
1333 gss_put_auth(gss_auth);
1334}
1335
1336static void
1337gss_destroy_cred(struct rpc_cred *cred)
1338{
1339
1340 if (test_and_clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags) != 0)
1341 gss_send_destroy_context(cred);
1342 gss_destroy_nullcred(cred);
1343}
1344
1345static int
1346gss_hash_cred(struct auth_cred *acred, unsigned int hashbits)
1347{
1348 return hash_64(from_kuid(&init_user_ns, acred->cred->fsuid), hashbits);
1349}
1350
1351/*
1352 * Lookup RPCSEC_GSS cred for the current process
1353 */
1354static struct rpc_cred *
1355gss_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
1356{
1357 return rpcauth_lookup_credcache(auth, acred, flags, GFP_NOFS);
1358}
1359
1360static struct rpc_cred *
1361gss_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags, gfp_t gfp)
1362{
1363 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1364 struct gss_cred *cred = NULL;
1365 int err = -ENOMEM;
1366
1367 if (!(cred = kzalloc(sizeof(*cred), gfp)))
1368 goto out_err;
1369
1370 rpcauth_init_cred(&cred->gc_base, acred, auth, &gss_credops);
1371 /*
1372 * Note: in order to force a call to call_refresh(), we deliberately
1373 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1374 */
1375 cred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_NEW;
1376 cred->gc_service = gss_auth->service;
1377 cred->gc_principal = acred->principal;
1378 kref_get(&gss_auth->kref);
1379 return &cred->gc_base;
1380
1381out_err:
1382 return ERR_PTR(err);
1383}
1384
1385static int
1386gss_cred_init(struct rpc_auth *auth, struct rpc_cred *cred)
1387{
1388 struct gss_auth *gss_auth = container_of(auth, struct gss_auth, rpc_auth);
1389 struct gss_cred *gss_cred = container_of(cred,struct gss_cred, gc_base);
1390 int err;
1391
1392 do {
1393 err = gss_create_upcall(gss_auth, gss_cred);
1394 } while (err == -EAGAIN);
1395 return err;
1396}
1397
1398static char *
1399gss_stringify_acceptor(struct rpc_cred *cred)
1400{
1401 char *string = NULL;
1402 struct gss_cred *gss_cred = container_of(cred, struct gss_cred, gc_base);
1403 struct gss_cl_ctx *ctx;
1404 unsigned int len;
1405 struct xdr_netobj *acceptor;
1406
1407 rcu_read_lock();
1408 ctx = rcu_dereference(gss_cred->gc_ctx);
1409 if (!ctx)
1410 goto out;
1411
1412 len = ctx->gc_acceptor.len;
1413 rcu_read_unlock();
1414
1415 /* no point if there's no string */
1416 if (!len)
1417 return NULL;
1418realloc:
1419 string = kmalloc(len + 1, GFP_KERNEL);
1420 if (!string)
1421 return NULL;
1422
1423 rcu_read_lock();
1424 ctx = rcu_dereference(gss_cred->gc_ctx);
1425
1426 /* did the ctx disappear or was it replaced by one with no acceptor? */
1427 if (!ctx || !ctx->gc_acceptor.len) {
1428 kfree(string);
1429 string = NULL;
1430 goto out;
1431 }
1432
1433 acceptor = &ctx->gc_acceptor;
1434
1435 /*
1436 * Did we find a new acceptor that's longer than the original? Allocate
1437 * a longer buffer and try again.
1438 */
1439 if (len < acceptor->len) {
1440 len = acceptor->len;
1441 rcu_read_unlock();
1442 kfree(string);
1443 goto realloc;
1444 }
1445
1446 memcpy(string, acceptor->data, acceptor->len);
1447 string[acceptor->len] = '\0';
1448out:
1449 rcu_read_unlock();
1450 return string;
1451}
1452
1453/*
1454 * Returns -EACCES if GSS context is NULL or will expire within the
1455 * timeout (miliseconds)
1456 */
1457static int
1458gss_key_timeout(struct rpc_cred *rc)
1459{
1460 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1461 struct gss_cl_ctx *ctx;
1462 unsigned long timeout = jiffies + (gss_key_expire_timeo * HZ);
1463 int ret = 0;
1464
1465 rcu_read_lock();
1466 ctx = rcu_dereference(gss_cred->gc_ctx);
1467 if (!ctx || time_after(timeout, ctx->gc_expiry))
1468 ret = -EACCES;
1469 rcu_read_unlock();
1470
1471 return ret;
1472}
1473
1474static int
1475gss_match(struct auth_cred *acred, struct rpc_cred *rc, int flags)
1476{
1477 struct gss_cred *gss_cred = container_of(rc, struct gss_cred, gc_base);
1478 struct gss_cl_ctx *ctx;
1479 int ret;
1480
1481 if (test_bit(RPCAUTH_CRED_NEW, &rc->cr_flags))
1482 goto out;
1483 /* Don't match with creds that have expired. */
1484 rcu_read_lock();
1485 ctx = rcu_dereference(gss_cred->gc_ctx);
1486 if (!ctx || time_after(jiffies, ctx->gc_expiry)) {
1487 rcu_read_unlock();
1488 return 0;
1489 }
1490 rcu_read_unlock();
1491 if (!test_bit(RPCAUTH_CRED_UPTODATE, &rc->cr_flags))
1492 return 0;
1493out:
1494 if (acred->principal != NULL) {
1495 if (gss_cred->gc_principal == NULL)
1496 return 0;
1497 ret = strcmp(acred->principal, gss_cred->gc_principal) == 0;
1498 } else {
1499 if (gss_cred->gc_principal != NULL)
1500 return 0;
1501 ret = uid_eq(rc->cr_cred->fsuid, acred->cred->fsuid);
1502 }
1503 return ret;
1504}
1505
1506/*
1507 * Marshal credentials.
1508 *
1509 * The expensive part is computing the verifier. We can't cache a
1510 * pre-computed version of the verifier because the seqno, which
1511 * is different every time, is included in the MIC.
1512 */
1513static int gss_marshal(struct rpc_task *task, struct xdr_stream *xdr)
1514{
1515 struct rpc_rqst *req = task->tk_rqstp;
1516 struct rpc_cred *cred = req->rq_cred;
1517 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1518 gc_base);
1519 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1520 __be32 *p, *cred_len;
1521 u32 maj_stat = 0;
1522 struct xdr_netobj mic;
1523 struct kvec iov;
1524 struct xdr_buf verf_buf;
1525 int status;
1526
1527 /* Credential */
1528
1529 p = xdr_reserve_space(xdr, 7 * sizeof(*p) +
1530 ctx->gc_wire_ctx.len);
1531 if (!p)
1532 goto marshal_failed;
1533 *p++ = rpc_auth_gss;
1534 cred_len = p++;
1535
1536 spin_lock(&ctx->gc_seq_lock);
1537 req->rq_seqno = (ctx->gc_seq < MAXSEQ) ? ctx->gc_seq++ : MAXSEQ;
1538 spin_unlock(&ctx->gc_seq_lock);
1539 if (req->rq_seqno == MAXSEQ)
1540 goto expired;
1541 trace_rpcgss_seqno(task);
1542
1543 *p++ = cpu_to_be32(RPC_GSS_VERSION);
1544 *p++ = cpu_to_be32(ctx->gc_proc);
1545 *p++ = cpu_to_be32(req->rq_seqno);
1546 *p++ = cpu_to_be32(gss_cred->gc_service);
1547 p = xdr_encode_netobj(p, &ctx->gc_wire_ctx);
1548 *cred_len = cpu_to_be32((p - (cred_len + 1)) << 2);
1549
1550 /* Verifier */
1551
1552 /* We compute the checksum for the verifier over the xdr-encoded bytes
1553 * starting with the xid and ending at the end of the credential: */
1554 iov.iov_base = req->rq_snd_buf.head[0].iov_base;
1555 iov.iov_len = (u8 *)p - (u8 *)iov.iov_base;
1556 xdr_buf_from_iov(&iov, &verf_buf);
1557
1558 p = xdr_reserve_space(xdr, sizeof(*p));
1559 if (!p)
1560 goto marshal_failed;
1561 *p++ = rpc_auth_gss;
1562 mic.data = (u8 *)(p + 1);
1563 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1564 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1565 goto expired;
1566 else if (maj_stat != 0)
1567 goto bad_mic;
1568 if (xdr_stream_encode_opaque_inline(xdr, (void **)&p, mic.len) < 0)
1569 goto marshal_failed;
1570 status = 0;
1571out:
1572 gss_put_ctx(ctx);
1573 return status;
1574expired:
1575 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1576 status = -EKEYEXPIRED;
1577 goto out;
1578marshal_failed:
1579 status = -EMSGSIZE;
1580 goto out;
1581bad_mic:
1582 trace_rpcgss_get_mic(task, maj_stat);
1583 status = -EIO;
1584 goto out;
1585}
1586
1587static int gss_renew_cred(struct rpc_task *task)
1588{
1589 struct rpc_cred *oldcred = task->tk_rqstp->rq_cred;
1590 struct gss_cred *gss_cred = container_of(oldcred,
1591 struct gss_cred,
1592 gc_base);
1593 struct rpc_auth *auth = oldcred->cr_auth;
1594 struct auth_cred acred = {
1595 .cred = oldcred->cr_cred,
1596 .principal = gss_cred->gc_principal,
1597 };
1598 struct rpc_cred *new;
1599
1600 new = gss_lookup_cred(auth, &acred, RPCAUTH_LOOKUP_NEW);
1601 if (IS_ERR(new))
1602 return PTR_ERR(new);
1603 task->tk_rqstp->rq_cred = new;
1604 put_rpccred(oldcred);
1605 return 0;
1606}
1607
1608static int gss_cred_is_negative_entry(struct rpc_cred *cred)
1609{
1610 if (test_bit(RPCAUTH_CRED_NEGATIVE, &cred->cr_flags)) {
1611 unsigned long now = jiffies;
1612 unsigned long begin, expire;
1613 struct gss_cred *gss_cred;
1614
1615 gss_cred = container_of(cred, struct gss_cred, gc_base);
1616 begin = gss_cred->gc_upcall_timestamp;
1617 expire = begin + gss_expired_cred_retry_delay * HZ;
1618
1619 if (time_in_range_open(now, begin, expire))
1620 return 1;
1621 }
1622 return 0;
1623}
1624
1625/*
1626* Refresh credentials. XXX - finish
1627*/
1628static int
1629gss_refresh(struct rpc_task *task)
1630{
1631 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1632 int ret = 0;
1633
1634 if (gss_cred_is_negative_entry(cred))
1635 return -EKEYEXPIRED;
1636
1637 if (!test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags) &&
1638 !test_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags)) {
1639 ret = gss_renew_cred(task);
1640 if (ret < 0)
1641 goto out;
1642 cred = task->tk_rqstp->rq_cred;
1643 }
1644
1645 if (test_bit(RPCAUTH_CRED_NEW, &cred->cr_flags))
1646 ret = gss_refresh_upcall(task);
1647out:
1648 return ret;
1649}
1650
1651/* Dummy refresh routine: used only when destroying the context */
1652static int
1653gss_refresh_null(struct rpc_task *task)
1654{
1655 return 0;
1656}
1657
1658static int
1659gss_validate(struct rpc_task *task, struct xdr_stream *xdr)
1660{
1661 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1662 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1663 __be32 *p, *seq = NULL;
1664 struct kvec iov;
1665 struct xdr_buf verf_buf;
1666 struct xdr_netobj mic;
1667 u32 len, maj_stat;
1668 int status;
1669
1670 p = xdr_inline_decode(xdr, 2 * sizeof(*p));
1671 if (!p)
1672 goto validate_failed;
1673 if (*p++ != rpc_auth_gss)
1674 goto validate_failed;
1675 len = be32_to_cpup(p);
1676 if (len > RPC_MAX_AUTH_SIZE)
1677 goto validate_failed;
1678 p = xdr_inline_decode(xdr, len);
1679 if (!p)
1680 goto validate_failed;
1681
1682 seq = kmalloc(4, GFP_NOFS);
1683 if (!seq)
1684 goto validate_failed;
1685 *seq = cpu_to_be32(task->tk_rqstp->rq_seqno);
1686 iov.iov_base = seq;
1687 iov.iov_len = 4;
1688 xdr_buf_from_iov(&iov, &verf_buf);
1689 mic.data = (u8 *)p;
1690 mic.len = len;
1691 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &verf_buf, &mic);
1692 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1693 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1694 if (maj_stat)
1695 goto bad_mic;
1696
1697 /* We leave it to unwrap to calculate au_rslack. For now we just
1698 * calculate the length of the verifier: */
1699 cred->cr_auth->au_verfsize = XDR_QUADLEN(len) + 2;
1700 status = 0;
1701out:
1702 gss_put_ctx(ctx);
1703 kfree(seq);
1704 return status;
1705
1706validate_failed:
1707 status = -EIO;
1708 goto out;
1709bad_mic:
1710 trace_rpcgss_verify_mic(task, maj_stat);
1711 status = -EACCES;
1712 goto out;
1713}
1714
1715static int gss_wrap_req_integ(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1716 struct rpc_task *task, struct xdr_stream *xdr)
1717{
1718 struct rpc_rqst *rqstp = task->tk_rqstp;
1719 struct xdr_buf integ_buf, *snd_buf = &rqstp->rq_snd_buf;
1720 struct xdr_netobj mic;
1721 __be32 *p, *integ_len;
1722 u32 offset, maj_stat;
1723
1724 p = xdr_reserve_space(xdr, 2 * sizeof(*p));
1725 if (!p)
1726 goto wrap_failed;
1727 integ_len = p++;
1728 *p = cpu_to_be32(rqstp->rq_seqno);
1729
1730 if (rpcauth_wrap_req_encode(task, xdr))
1731 goto wrap_failed;
1732
1733 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1734 if (xdr_buf_subsegment(snd_buf, &integ_buf,
1735 offset, snd_buf->len - offset))
1736 goto wrap_failed;
1737 *integ_len = cpu_to_be32(integ_buf.len);
1738
1739 p = xdr_reserve_space(xdr, 0);
1740 if (!p)
1741 goto wrap_failed;
1742 mic.data = (u8 *)(p + 1);
1743 maj_stat = gss_get_mic(ctx->gc_gss_ctx, &integ_buf, &mic);
1744 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1745 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1746 else if (maj_stat)
1747 goto bad_mic;
1748 /* Check that the trailing MIC fit in the buffer, after the fact */
1749 if (xdr_stream_encode_opaque_inline(xdr, (void **)&p, mic.len) < 0)
1750 goto wrap_failed;
1751 return 0;
1752wrap_failed:
1753 return -EMSGSIZE;
1754bad_mic:
1755 trace_rpcgss_get_mic(task, maj_stat);
1756 return -EIO;
1757}
1758
1759static void
1760priv_release_snd_buf(struct rpc_rqst *rqstp)
1761{
1762 int i;
1763
1764 for (i=0; i < rqstp->rq_enc_pages_num; i++)
1765 __free_page(rqstp->rq_enc_pages[i]);
1766 kfree(rqstp->rq_enc_pages);
1767 rqstp->rq_release_snd_buf = NULL;
1768}
1769
1770static int
1771alloc_enc_pages(struct rpc_rqst *rqstp)
1772{
1773 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1774 int first, last, i;
1775
1776 if (rqstp->rq_release_snd_buf)
1777 rqstp->rq_release_snd_buf(rqstp);
1778
1779 if (snd_buf->page_len == 0) {
1780 rqstp->rq_enc_pages_num = 0;
1781 return 0;
1782 }
1783
1784 first = snd_buf->page_base >> PAGE_SHIFT;
1785 last = (snd_buf->page_base + snd_buf->page_len - 1) >> PAGE_SHIFT;
1786 rqstp->rq_enc_pages_num = last - first + 1 + 1;
1787 rqstp->rq_enc_pages
1788 = kmalloc_array(rqstp->rq_enc_pages_num,
1789 sizeof(struct page *),
1790 GFP_NOFS);
1791 if (!rqstp->rq_enc_pages)
1792 goto out;
1793 for (i=0; i < rqstp->rq_enc_pages_num; i++) {
1794 rqstp->rq_enc_pages[i] = alloc_page(GFP_NOFS);
1795 if (rqstp->rq_enc_pages[i] == NULL)
1796 goto out_free;
1797 }
1798 rqstp->rq_release_snd_buf = priv_release_snd_buf;
1799 return 0;
1800out_free:
1801 rqstp->rq_enc_pages_num = i;
1802 priv_release_snd_buf(rqstp);
1803out:
1804 return -EAGAIN;
1805}
1806
1807static int gss_wrap_req_priv(struct rpc_cred *cred, struct gss_cl_ctx *ctx,
1808 struct rpc_task *task, struct xdr_stream *xdr)
1809{
1810 struct rpc_rqst *rqstp = task->tk_rqstp;
1811 struct xdr_buf *snd_buf = &rqstp->rq_snd_buf;
1812 u32 pad, offset, maj_stat;
1813 int status;
1814 __be32 *p, *opaque_len;
1815 struct page **inpages;
1816 int first;
1817 struct kvec *iov;
1818
1819 status = -EIO;
1820 p = xdr_reserve_space(xdr, 2 * sizeof(*p));
1821 if (!p)
1822 goto wrap_failed;
1823 opaque_len = p++;
1824 *p = cpu_to_be32(rqstp->rq_seqno);
1825
1826 if (rpcauth_wrap_req_encode(task, xdr))
1827 goto wrap_failed;
1828
1829 status = alloc_enc_pages(rqstp);
1830 if (unlikely(status))
1831 goto wrap_failed;
1832 first = snd_buf->page_base >> PAGE_SHIFT;
1833 inpages = snd_buf->pages + first;
1834 snd_buf->pages = rqstp->rq_enc_pages;
1835 snd_buf->page_base -= first << PAGE_SHIFT;
1836 /*
1837 * Move the tail into its own page, in case gss_wrap needs
1838 * more space in the head when wrapping.
1839 *
1840 * Still... Why can't gss_wrap just slide the tail down?
1841 */
1842 if (snd_buf->page_len || snd_buf->tail[0].iov_len) {
1843 char *tmp;
1844
1845 tmp = page_address(rqstp->rq_enc_pages[rqstp->rq_enc_pages_num - 1]);
1846 memcpy(tmp, snd_buf->tail[0].iov_base, snd_buf->tail[0].iov_len);
1847 snd_buf->tail[0].iov_base = tmp;
1848 }
1849 offset = (u8 *)p - (u8 *)snd_buf->head[0].iov_base;
1850 maj_stat = gss_wrap(ctx->gc_gss_ctx, offset, snd_buf, inpages);
1851 /* slack space should prevent this ever happening: */
1852 if (unlikely(snd_buf->len > snd_buf->buflen)) {
1853 status = -EIO;
1854 goto wrap_failed;
1855 }
1856 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1857 * done anyway, so it's safe to put the request on the wire: */
1858 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1859 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1860 else if (maj_stat)
1861 goto bad_wrap;
1862
1863 *opaque_len = cpu_to_be32(snd_buf->len - offset);
1864 /* guess whether the pad goes into the head or the tail: */
1865 if (snd_buf->page_len || snd_buf->tail[0].iov_len)
1866 iov = snd_buf->tail;
1867 else
1868 iov = snd_buf->head;
1869 p = iov->iov_base + iov->iov_len;
1870 pad = 3 - ((snd_buf->len - offset - 1) & 3);
1871 memset(p, 0, pad);
1872 iov->iov_len += pad;
1873 snd_buf->len += pad;
1874
1875 return 0;
1876wrap_failed:
1877 return status;
1878bad_wrap:
1879 trace_rpcgss_wrap(task, maj_stat);
1880 return -EIO;
1881}
1882
1883static int gss_wrap_req(struct rpc_task *task, struct xdr_stream *xdr)
1884{
1885 struct rpc_cred *cred = task->tk_rqstp->rq_cred;
1886 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
1887 gc_base);
1888 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
1889 int status;
1890
1891 status = -EIO;
1892 if (ctx->gc_proc != RPC_GSS_PROC_DATA) {
1893 /* The spec seems a little ambiguous here, but I think that not
1894 * wrapping context destruction requests makes the most sense.
1895 */
1896 status = rpcauth_wrap_req_encode(task, xdr);
1897 goto out;
1898 }
1899 switch (gss_cred->gc_service) {
1900 case RPC_GSS_SVC_NONE:
1901 status = rpcauth_wrap_req_encode(task, xdr);
1902 break;
1903 case RPC_GSS_SVC_INTEGRITY:
1904 status = gss_wrap_req_integ(cred, ctx, task, xdr);
1905 break;
1906 case RPC_GSS_SVC_PRIVACY:
1907 status = gss_wrap_req_priv(cred, ctx, task, xdr);
1908 break;
1909 default:
1910 status = -EIO;
1911 }
1912out:
1913 gss_put_ctx(ctx);
1914 return status;
1915}
1916
1917static int
1918gss_unwrap_resp_auth(struct rpc_cred *cred)
1919{
1920 struct rpc_auth *auth = cred->cr_auth;
1921
1922 auth->au_rslack = auth->au_verfsize;
1923 auth->au_ralign = auth->au_verfsize;
1924 return 0;
1925}
1926
1927/*
1928 * RFC 2203, Section 5.3.2.2
1929 *
1930 * struct rpc_gss_integ_data {
1931 * opaque databody_integ<>;
1932 * opaque checksum<>;
1933 * };
1934 *
1935 * struct rpc_gss_data_t {
1936 * unsigned int seq_num;
1937 * proc_req_arg_t arg;
1938 * };
1939 */
1940static int
1941gss_unwrap_resp_integ(struct rpc_task *task, struct rpc_cred *cred,
1942 struct gss_cl_ctx *ctx, struct rpc_rqst *rqstp,
1943 struct xdr_stream *xdr)
1944{
1945 struct xdr_buf gss_data, *rcv_buf = &rqstp->rq_rcv_buf;
1946 struct rpc_auth *auth = cred->cr_auth;
1947 u32 len, offset, seqno, maj_stat;
1948 struct xdr_netobj mic;
1949 int ret;
1950
1951 ret = -EIO;
1952 mic.data = NULL;
1953
1954 /* opaque databody_integ<>; */
1955 if (xdr_stream_decode_u32(xdr, &len))
1956 goto unwrap_failed;
1957 if (len & 3)
1958 goto unwrap_failed;
1959 offset = rcv_buf->len - xdr_stream_remaining(xdr);
1960 if (xdr_stream_decode_u32(xdr, &seqno))
1961 goto unwrap_failed;
1962 if (seqno != rqstp->rq_seqno)
1963 goto bad_seqno;
1964 if (xdr_buf_subsegment(rcv_buf, &gss_data, offset, len))
1965 goto unwrap_failed;
1966
1967 /*
1968 * The xdr_stream now points to the beginning of the
1969 * upper layer payload, to be passed below to
1970 * rpcauth_unwrap_resp_decode(). The checksum, which
1971 * follows the upper layer payload in @rcv_buf, is
1972 * located and parsed without updating the xdr_stream.
1973 */
1974
1975 /* opaque checksum<>; */
1976 offset += len;
1977 if (xdr_decode_word(rcv_buf, offset, &len))
1978 goto unwrap_failed;
1979 offset += sizeof(__be32);
1980 if (offset + len > rcv_buf->len)
1981 goto unwrap_failed;
1982 mic.len = len;
1983 mic.data = kmalloc(len, GFP_NOFS);
1984 if (!mic.data)
1985 goto unwrap_failed;
1986 if (read_bytes_from_xdr_buf(rcv_buf, offset, mic.data, mic.len))
1987 goto unwrap_failed;
1988
1989 maj_stat = gss_verify_mic(ctx->gc_gss_ctx, &gss_data, &mic);
1990 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
1991 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
1992 if (maj_stat != GSS_S_COMPLETE)
1993 goto bad_mic;
1994
1995 auth->au_rslack = auth->au_verfsize + 2 + 1 + XDR_QUADLEN(mic.len);
1996 auth->au_ralign = auth->au_verfsize + 2;
1997 ret = 0;
1998
1999out:
2000 kfree(mic.data);
2001 return ret;
2002
2003unwrap_failed:
2004 trace_rpcgss_unwrap_failed(task);
2005 goto out;
2006bad_seqno:
2007 trace_rpcgss_bad_seqno(task, rqstp->rq_seqno, seqno);
2008 goto out;
2009bad_mic:
2010 trace_rpcgss_verify_mic(task, maj_stat);
2011 goto out;
2012}
2013
2014static int
2015gss_unwrap_resp_priv(struct rpc_task *task, struct rpc_cred *cred,
2016 struct gss_cl_ctx *ctx, struct rpc_rqst *rqstp,
2017 struct xdr_stream *xdr)
2018{
2019 struct xdr_buf *rcv_buf = &rqstp->rq_rcv_buf;
2020 struct kvec *head = rqstp->rq_rcv_buf.head;
2021 struct rpc_auth *auth = cred->cr_auth;
2022 u32 offset, opaque_len, maj_stat;
2023 __be32 *p;
2024
2025 p = xdr_inline_decode(xdr, 2 * sizeof(*p));
2026 if (unlikely(!p))
2027 goto unwrap_failed;
2028 opaque_len = be32_to_cpup(p++);
2029 offset = (u8 *)(p) - (u8 *)head->iov_base;
2030 if (offset + opaque_len > rcv_buf->len)
2031 goto unwrap_failed;
2032
2033 maj_stat = gss_unwrap(ctx->gc_gss_ctx, offset,
2034 offset + opaque_len, rcv_buf);
2035 if (maj_stat == GSS_S_CONTEXT_EXPIRED)
2036 clear_bit(RPCAUTH_CRED_UPTODATE, &cred->cr_flags);
2037 if (maj_stat != GSS_S_COMPLETE)
2038 goto bad_unwrap;
2039 /* gss_unwrap decrypted the sequence number */
2040 if (be32_to_cpup(p++) != rqstp->rq_seqno)
2041 goto bad_seqno;
2042
2043 /* gss_unwrap redacts the opaque blob from the head iovec.
2044 * rcv_buf has changed, thus the stream needs to be reset.
2045 */
2046 xdr_init_decode(xdr, rcv_buf, p, rqstp);
2047
2048 auth->au_rslack = auth->au_verfsize + 2 + ctx->gc_gss_ctx->slack;
2049 auth->au_ralign = auth->au_verfsize + 2 + ctx->gc_gss_ctx->align;
2050
2051 return 0;
2052unwrap_failed:
2053 trace_rpcgss_unwrap_failed(task);
2054 return -EIO;
2055bad_seqno:
2056 trace_rpcgss_bad_seqno(task, rqstp->rq_seqno, be32_to_cpup(--p));
2057 return -EIO;
2058bad_unwrap:
2059 trace_rpcgss_unwrap(task, maj_stat);
2060 return -EIO;
2061}
2062
2063static bool
2064gss_seq_is_newer(u32 new, u32 old)
2065{
2066 return (s32)(new - old) > 0;
2067}
2068
2069static bool
2070gss_xmit_need_reencode(struct rpc_task *task)
2071{
2072 struct rpc_rqst *req = task->tk_rqstp;
2073 struct rpc_cred *cred = req->rq_cred;
2074 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
2075 u32 win, seq_xmit = 0;
2076 bool ret = true;
2077
2078 if (!ctx)
2079 goto out;
2080
2081 if (gss_seq_is_newer(req->rq_seqno, READ_ONCE(ctx->gc_seq)))
2082 goto out_ctx;
2083
2084 seq_xmit = READ_ONCE(ctx->gc_seq_xmit);
2085 while (gss_seq_is_newer(req->rq_seqno, seq_xmit)) {
2086 u32 tmp = seq_xmit;
2087
2088 seq_xmit = cmpxchg(&ctx->gc_seq_xmit, tmp, req->rq_seqno);
2089 if (seq_xmit == tmp) {
2090 ret = false;
2091 goto out_ctx;
2092 }
2093 }
2094
2095 win = ctx->gc_win;
2096 if (win > 0)
2097 ret = !gss_seq_is_newer(req->rq_seqno, seq_xmit - win);
2098
2099out_ctx:
2100 gss_put_ctx(ctx);
2101out:
2102 trace_rpcgss_need_reencode(task, seq_xmit, ret);
2103 return ret;
2104}
2105
2106static int
2107gss_unwrap_resp(struct rpc_task *task, struct xdr_stream *xdr)
2108{
2109 struct rpc_rqst *rqstp = task->tk_rqstp;
2110 struct rpc_cred *cred = rqstp->rq_cred;
2111 struct gss_cred *gss_cred = container_of(cred, struct gss_cred,
2112 gc_base);
2113 struct gss_cl_ctx *ctx = gss_cred_get_ctx(cred);
2114 int status = -EIO;
2115
2116 if (ctx->gc_proc != RPC_GSS_PROC_DATA)
2117 goto out_decode;
2118 switch (gss_cred->gc_service) {
2119 case RPC_GSS_SVC_NONE:
2120 status = gss_unwrap_resp_auth(cred);
2121 break;
2122 case RPC_GSS_SVC_INTEGRITY:
2123 status = gss_unwrap_resp_integ(task, cred, ctx, rqstp, xdr);
2124 break;
2125 case RPC_GSS_SVC_PRIVACY:
2126 status = gss_unwrap_resp_priv(task, cred, ctx, rqstp, xdr);
2127 break;
2128 }
2129 if (status)
2130 goto out;
2131
2132out_decode:
2133 status = rpcauth_unwrap_resp_decode(task, xdr);
2134out:
2135 gss_put_ctx(ctx);
2136 return status;
2137}
2138
2139static const struct rpc_authops authgss_ops = {
2140 .owner = THIS_MODULE,
2141 .au_flavor = RPC_AUTH_GSS,
2142 .au_name = "RPCSEC_GSS",
2143 .create = gss_create,
2144 .destroy = gss_destroy,
2145 .hash_cred = gss_hash_cred,
2146 .lookup_cred = gss_lookup_cred,
2147 .crcreate = gss_create_cred,
2148 .list_pseudoflavors = gss_mech_list_pseudoflavors,
2149 .info2flavor = gss_mech_info2flavor,
2150 .flavor2info = gss_mech_flavor2info,
2151};
2152
2153static const struct rpc_credops gss_credops = {
2154 .cr_name = "AUTH_GSS",
2155 .crdestroy = gss_destroy_cred,
2156 .cr_init = gss_cred_init,
2157 .crmatch = gss_match,
2158 .crmarshal = gss_marshal,
2159 .crrefresh = gss_refresh,
2160 .crvalidate = gss_validate,
2161 .crwrap_req = gss_wrap_req,
2162 .crunwrap_resp = gss_unwrap_resp,
2163 .crkey_timeout = gss_key_timeout,
2164 .crstringify_acceptor = gss_stringify_acceptor,
2165 .crneed_reencode = gss_xmit_need_reencode,
2166};
2167
2168static const struct rpc_credops gss_nullops = {
2169 .cr_name = "AUTH_GSS",
2170 .crdestroy = gss_destroy_nullcred,
2171 .crmatch = gss_match,
2172 .crmarshal = gss_marshal,
2173 .crrefresh = gss_refresh_null,
2174 .crvalidate = gss_validate,
2175 .crwrap_req = gss_wrap_req,
2176 .crunwrap_resp = gss_unwrap_resp,
2177 .crstringify_acceptor = gss_stringify_acceptor,
2178};
2179
2180static const struct rpc_pipe_ops gss_upcall_ops_v0 = {
2181 .upcall = gss_v0_upcall,
2182 .downcall = gss_pipe_downcall,
2183 .destroy_msg = gss_pipe_destroy_msg,
2184 .open_pipe = gss_pipe_open_v0,
2185 .release_pipe = gss_pipe_release,
2186};
2187
2188static const struct rpc_pipe_ops gss_upcall_ops_v1 = {
2189 .upcall = gss_v1_upcall,
2190 .downcall = gss_pipe_downcall,
2191 .destroy_msg = gss_pipe_destroy_msg,
2192 .open_pipe = gss_pipe_open_v1,
2193 .release_pipe = gss_pipe_release,
2194};
2195
2196static __net_init int rpcsec_gss_init_net(struct net *net)
2197{
2198 return gss_svc_init_net(net);
2199}
2200
2201static __net_exit void rpcsec_gss_exit_net(struct net *net)
2202{
2203 gss_svc_shutdown_net(net);
2204}
2205
2206static struct pernet_operations rpcsec_gss_net_ops = {
2207 .init = rpcsec_gss_init_net,
2208 .exit = rpcsec_gss_exit_net,
2209};
2210
2211/*
2212 * Initialize RPCSEC_GSS module
2213 */
2214static int __init init_rpcsec_gss(void)
2215{
2216 int err = 0;
2217
2218 err = rpcauth_register(&authgss_ops);
2219 if (err)
2220 goto out;
2221 err = gss_svc_init();
2222 if (err)
2223 goto out_unregister;
2224 err = register_pernet_subsys(&rpcsec_gss_net_ops);
2225 if (err)
2226 goto out_svc_exit;
2227 rpc_init_wait_queue(&pipe_version_rpc_waitqueue, "gss pipe version");
2228 return 0;
2229out_svc_exit:
2230 gss_svc_shutdown();
2231out_unregister:
2232 rpcauth_unregister(&authgss_ops);
2233out:
2234 return err;
2235}
2236
2237static void __exit exit_rpcsec_gss(void)
2238{
2239 unregister_pernet_subsys(&rpcsec_gss_net_ops);
2240 gss_svc_shutdown();
2241 rpcauth_unregister(&authgss_ops);
2242 rcu_barrier(); /* Wait for completion of call_rcu()'s */
2243}
2244
2245MODULE_ALIAS("rpc-auth-6");
2246MODULE_LICENSE("GPL");
2247module_param_named(expired_cred_retry_delay,
2248 gss_expired_cred_retry_delay,
2249 uint, 0644);
2250MODULE_PARM_DESC(expired_cred_retry_delay, "Timeout (in seconds) until "
2251 "the RPC engine retries an expired credential");
2252
2253module_param_named(key_expire_timeo,
2254 gss_key_expire_timeo,
2255 uint, 0644);
2256MODULE_PARM_DESC(key_expire_timeo, "Time (in seconds) at the end of a "
2257 "credential keys lifetime where the NFS layer cleans up "
2258 "prior to key expiration");
2259
2260module_init(init_rpcsec_gss)
2261module_exit(exit_rpcsec_gss)