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