2 * linux/net/sunrpc/auth_gss/auth_gss.c
4 * RPCSEC_GSS client authentication.
6 * Copyright (c) 2000 The Regents of the University of Michigan.
9 * Dug Song <dugsong@monkey.org>
10 * Andy Adamson <andros@umich.edu>
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/types.h>
42 #include <linux/slab.h>
43 #include <linux/sched.h>
44 #include <linux/pagemap.h>
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>
54 #include <linux/hashtable.h>
58 static const struct rpc_authops authgss_ops
;
60 static const struct rpc_credops gss_credops
;
61 static const struct rpc_credops gss_nullops
;
63 #define GSS_RETRY_EXPIRED 5
64 static unsigned int gss_expired_cred_retry_delay
= GSS_RETRY_EXPIRED
;
66 #define GSS_KEY_EXPIRE_TIMEO 240
67 static unsigned int gss_key_expire_timeo
= GSS_KEY_EXPIRE_TIMEO
;
70 # define RPCDBG_FACILITY RPCDBG_AUTH
73 #define GSS_CRED_SLACK (RPC_MAX_AUTH_SIZE * 2)
74 /* length of a krb5 verifier (48), plus data added before arguments when
75 * using integrity (two 4-byte integers): */
76 #define GSS_VERF_SLACK 100
78 static DEFINE_HASHTABLE(gss_auth_hash_table
, 4);
79 static DEFINE_SPINLOCK(gss_auth_hash_lock
);
82 struct rpc_pipe_dir_object pdo
;
83 struct rpc_pipe
*pipe
;
84 struct rpc_clnt
*clnt
;
91 struct hlist_node hash
;
92 struct rpc_auth rpc_auth
;
93 struct gss_api_mech
*mech
;
94 enum rpc_gss_svc service
;
95 struct rpc_clnt
*client
;
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.
103 struct gss_pipe
*gss_pipe
[2];
104 const char *target_name
;
107 /* pipe_version >= 0 if and only if someone has a pipe open. */
108 static DEFINE_SPINLOCK(pipe_version_lock
);
109 static struct rpc_wait_queue pipe_version_rpc_waitqueue
;
110 static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue
);
112 static void gss_free_ctx(struct gss_cl_ctx
*);
113 static const struct rpc_pipe_ops gss_upcall_ops_v0
;
114 static const struct rpc_pipe_ops gss_upcall_ops_v1
;
116 static inline struct gss_cl_ctx
*
117 gss_get_ctx(struct gss_cl_ctx
*ctx
)
119 atomic_inc(&ctx
->count
);
124 gss_put_ctx(struct gss_cl_ctx
*ctx
)
126 if (atomic_dec_and_test(&ctx
->count
))
131 * called by gss_upcall_callback and gss_create_upcall in order
132 * to set the gss context. The actual exchange of an old context
133 * and a new one is protected by the pipe->lock.
136 gss_cred_set_ctx(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
)
138 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
140 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
143 rcu_assign_pointer(gss_cred
->gc_ctx
, ctx
);
144 set_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
145 smp_mb__before_clear_bit();
146 clear_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
);
150 simple_get_bytes(const void *p
, const void *end
, void *res
, size_t len
)
152 const void *q
= (const void *)((const char *)p
+ len
);
153 if (unlikely(q
> end
|| q
< p
))
154 return ERR_PTR(-EFAULT
);
159 static inline const void *
160 simple_get_netobj(const void *p
, const void *end
, struct xdr_netobj
*dest
)
165 p
= simple_get_bytes(p
, end
, &len
, sizeof(len
));
168 q
= (const void *)((const char *)p
+ len
);
169 if (unlikely(q
> end
|| q
< p
))
170 return ERR_PTR(-EFAULT
);
171 dest
->data
= kmemdup(p
, len
, GFP_NOFS
);
172 if (unlikely(dest
->data
== NULL
))
173 return ERR_PTR(-ENOMEM
);
178 static struct gss_cl_ctx
*
179 gss_cred_get_ctx(struct rpc_cred
*cred
)
181 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
182 struct gss_cl_ctx
*ctx
= NULL
;
185 if (gss_cred
->gc_ctx
)
186 ctx
= gss_get_ctx(gss_cred
->gc_ctx
);
191 static struct gss_cl_ctx
*
192 gss_alloc_context(void)
194 struct gss_cl_ctx
*ctx
;
196 ctx
= kzalloc(sizeof(*ctx
), GFP_NOFS
);
198 ctx
->gc_proc
= RPC_GSS_PROC_DATA
;
199 ctx
->gc_seq
= 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
200 spin_lock_init(&ctx
->gc_seq_lock
);
201 atomic_set(&ctx
->count
,1);
206 #define GSSD_MIN_TIMEOUT (60 * 60)
208 gss_fill_context(const void *p
, const void *end
, struct gss_cl_ctx
*ctx
, struct gss_api_mech
*gm
)
212 unsigned int timeout
;
213 unsigned long now
= jiffies
;
217 /* First unsigned int gives the remaining lifetime in seconds of the
218 * credential - e.g. the remaining TGT lifetime for Kerberos or
219 * the -t value passed to GSSD.
221 p
= simple_get_bytes(p
, end
, &timeout
, sizeof(timeout
));
225 timeout
= GSSD_MIN_TIMEOUT
;
226 ctx
->gc_expiry
= now
+ ((unsigned long)timeout
* HZ
);
227 /* Sequence number window. Determines the maximum number of
228 * simultaneous requests
230 p
= simple_get_bytes(p
, end
, &window_size
, sizeof(window_size
));
233 ctx
->gc_win
= window_size
;
234 /* gssd signals an error by passing ctx->gc_win = 0: */
235 if (ctx
->gc_win
== 0) {
237 * in which case, p points to an error code. Anything other
238 * than -EKEYEXPIRED gets converted to -EACCES.
240 p
= simple_get_bytes(p
, end
, &ret
, sizeof(ret
));
242 p
= (ret
== -EKEYEXPIRED
) ? ERR_PTR(-EKEYEXPIRED
) :
246 /* copy the opaque wire context */
247 p
= simple_get_netobj(p
, end
, &ctx
->gc_wire_ctx
);
250 /* import the opaque security context */
251 p
= simple_get_bytes(p
, end
, &seclen
, sizeof(seclen
));
254 q
= (const void *)((const char *)p
+ seclen
);
255 if (unlikely(q
> end
|| q
< p
)) {
256 p
= ERR_PTR(-EFAULT
);
259 ret
= gss_import_sec_context(p
, seclen
, gm
, &ctx
->gc_gss_ctx
, NULL
, GFP_NOFS
);
264 dprintk("RPC: %s Success. gc_expiry %lu now %lu timeout %u\n",
265 __func__
, ctx
->gc_expiry
, now
, timeout
);
268 dprintk("RPC: %s returns error %ld\n", __func__
, -PTR_ERR(p
));
272 #define UPCALL_BUF_LEN 128
274 struct gss_upcall_msg
{
277 struct rpc_pipe_msg msg
;
278 struct list_head list
;
279 struct gss_auth
*auth
;
280 struct rpc_pipe
*pipe
;
281 struct rpc_wait_queue rpc_waitqueue
;
282 wait_queue_head_t waitqueue
;
283 struct gss_cl_ctx
*ctx
;
284 char databuf
[UPCALL_BUF_LEN
];
287 static int get_pipe_version(struct net
*net
)
289 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
292 spin_lock(&pipe_version_lock
);
293 if (sn
->pipe_version
>= 0) {
294 atomic_inc(&sn
->pipe_users
);
295 ret
= sn
->pipe_version
;
298 spin_unlock(&pipe_version_lock
);
302 static void put_pipe_version(struct net
*net
)
304 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
306 if (atomic_dec_and_lock(&sn
->pipe_users
, &pipe_version_lock
)) {
307 sn
->pipe_version
= -1;
308 spin_unlock(&pipe_version_lock
);
313 gss_release_msg(struct gss_upcall_msg
*gss_msg
)
315 struct net
*net
= gss_msg
->auth
->net
;
316 if (!atomic_dec_and_test(&gss_msg
->count
))
318 put_pipe_version(net
);
319 BUG_ON(!list_empty(&gss_msg
->list
));
320 if (gss_msg
->ctx
!= NULL
)
321 gss_put_ctx(gss_msg
->ctx
);
322 rpc_destroy_wait_queue(&gss_msg
->rpc_waitqueue
);
326 static struct gss_upcall_msg
*
327 __gss_find_upcall(struct rpc_pipe
*pipe
, kuid_t uid
)
329 struct gss_upcall_msg
*pos
;
330 list_for_each_entry(pos
, &pipe
->in_downcall
, list
) {
331 if (!uid_eq(pos
->uid
, uid
))
333 atomic_inc(&pos
->count
);
334 dprintk("RPC: %s found msg %p\n", __func__
, pos
);
337 dprintk("RPC: %s found nothing\n", __func__
);
341 /* Try to add an upcall to the pipefs queue.
342 * If an upcall owned by our uid already exists, then we return a reference
343 * to that upcall instead of adding the new upcall.
345 static inline struct gss_upcall_msg
*
346 gss_add_msg(struct gss_upcall_msg
*gss_msg
)
348 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
349 struct gss_upcall_msg
*old
;
351 spin_lock(&pipe
->lock
);
352 old
= __gss_find_upcall(pipe
, gss_msg
->uid
);
354 atomic_inc(&gss_msg
->count
);
355 list_add(&gss_msg
->list
, &pipe
->in_downcall
);
358 spin_unlock(&pipe
->lock
);
363 __gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
365 list_del_init(&gss_msg
->list
);
366 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
367 wake_up_all(&gss_msg
->waitqueue
);
368 atomic_dec(&gss_msg
->count
);
372 gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
374 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
376 if (list_empty(&gss_msg
->list
))
378 spin_lock(&pipe
->lock
);
379 if (!list_empty(&gss_msg
->list
))
380 __gss_unhash_msg(gss_msg
);
381 spin_unlock(&pipe
->lock
);
385 gss_handle_downcall_result(struct gss_cred
*gss_cred
, struct gss_upcall_msg
*gss_msg
)
387 switch (gss_msg
->msg
.errno
) {
389 if (gss_msg
->ctx
== NULL
)
391 clear_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
392 gss_cred_set_ctx(&gss_cred
->gc_base
, gss_msg
->ctx
);
395 set_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
397 gss_cred
->gc_upcall_timestamp
= jiffies
;
398 gss_cred
->gc_upcall
= NULL
;
399 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
403 gss_upcall_callback(struct rpc_task
*task
)
405 struct gss_cred
*gss_cred
= container_of(task
->tk_rqstp
->rq_cred
,
406 struct gss_cred
, gc_base
);
407 struct gss_upcall_msg
*gss_msg
= gss_cred
->gc_upcall
;
408 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
410 spin_lock(&pipe
->lock
);
411 gss_handle_downcall_result(gss_cred
, gss_msg
);
412 spin_unlock(&pipe
->lock
);
413 task
->tk_status
= gss_msg
->msg
.errno
;
414 gss_release_msg(gss_msg
);
417 static void gss_encode_v0_msg(struct gss_upcall_msg
*gss_msg
)
419 uid_t uid
= from_kuid(&init_user_ns
, gss_msg
->uid
);
420 memcpy(gss_msg
->databuf
, &uid
, sizeof(uid
));
421 gss_msg
->msg
.data
= gss_msg
->databuf
;
422 gss_msg
->msg
.len
= sizeof(uid
);
423 BUG_ON(sizeof(uid
) > UPCALL_BUF_LEN
);
426 static void gss_encode_v1_msg(struct gss_upcall_msg
*gss_msg
,
427 const char *service_name
,
428 const char *target_name
)
430 struct gss_api_mech
*mech
= gss_msg
->auth
->mech
;
431 char *p
= gss_msg
->databuf
;
434 gss_msg
->msg
.len
= sprintf(gss_msg
->databuf
, "mech=%s uid=%d ",
436 from_kuid(&init_user_ns
, gss_msg
->uid
));
437 p
+= gss_msg
->msg
.len
;
439 len
= sprintf(p
, "target=%s ", target_name
);
441 gss_msg
->msg
.len
+= len
;
443 if (service_name
!= NULL
) {
444 len
= sprintf(p
, "service=%s ", service_name
);
446 gss_msg
->msg
.len
+= len
;
448 if (mech
->gm_upcall_enctypes
) {
449 len
= sprintf(p
, "enctypes=%s ", mech
->gm_upcall_enctypes
);
451 gss_msg
->msg
.len
+= len
;
453 len
= sprintf(p
, "\n");
454 gss_msg
->msg
.len
+= len
;
456 gss_msg
->msg
.data
= gss_msg
->databuf
;
457 BUG_ON(gss_msg
->msg
.len
> UPCALL_BUF_LEN
);
460 static struct gss_upcall_msg
*
461 gss_alloc_msg(struct gss_auth
*gss_auth
,
462 kuid_t uid
, const char *service_name
)
464 struct gss_upcall_msg
*gss_msg
;
467 gss_msg
= kzalloc(sizeof(*gss_msg
), GFP_NOFS
);
469 return ERR_PTR(-ENOMEM
);
470 vers
= get_pipe_version(gss_auth
->net
);
473 return ERR_PTR(vers
);
475 gss_msg
->pipe
= gss_auth
->gss_pipe
[vers
]->pipe
;
476 INIT_LIST_HEAD(&gss_msg
->list
);
477 rpc_init_wait_queue(&gss_msg
->rpc_waitqueue
, "RPCSEC_GSS upcall waitq");
478 init_waitqueue_head(&gss_msg
->waitqueue
);
479 atomic_set(&gss_msg
->count
, 1);
481 gss_msg
->auth
= gss_auth
;
484 gss_encode_v0_msg(gss_msg
);
486 gss_encode_v1_msg(gss_msg
, service_name
, gss_auth
->target_name
);
491 static struct gss_upcall_msg
*
492 gss_setup_upcall(struct gss_auth
*gss_auth
, struct rpc_cred
*cred
)
494 struct gss_cred
*gss_cred
= container_of(cred
,
495 struct gss_cred
, gc_base
);
496 struct gss_upcall_msg
*gss_new
, *gss_msg
;
497 kuid_t uid
= cred
->cr_uid
;
499 gss_new
= gss_alloc_msg(gss_auth
, uid
, gss_cred
->gc_principal
);
502 gss_msg
= gss_add_msg(gss_new
);
503 if (gss_msg
== gss_new
) {
504 int res
= rpc_queue_upcall(gss_new
->pipe
, &gss_new
->msg
);
506 gss_unhash_msg(gss_new
);
507 gss_msg
= ERR_PTR(res
);
510 gss_release_msg(gss_new
);
514 static void warn_gssd(void)
516 static unsigned long ratelimit
;
517 unsigned long now
= jiffies
;
519 if (time_after(now
, ratelimit
)) {
520 printk(KERN_WARNING
"RPC: AUTH_GSS upcall timed out.\n"
521 "Please check user daemon is running.\n");
522 ratelimit
= now
+ 15*HZ
;
527 gss_refresh_upcall(struct rpc_task
*task
)
529 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
530 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
,
531 struct gss_auth
, rpc_auth
);
532 struct gss_cred
*gss_cred
= container_of(cred
,
533 struct gss_cred
, gc_base
);
534 struct gss_upcall_msg
*gss_msg
;
535 struct rpc_pipe
*pipe
;
538 dprintk("RPC: %5u %s for uid %u\n",
539 task
->tk_pid
, __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
540 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
541 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
542 /* XXX: warning on the first, under the assumption we
543 * shouldn't normally hit this case on a refresh. */
545 task
->tk_timeout
= 15*HZ
;
546 rpc_sleep_on(&pipe_version_rpc_waitqueue
, task
, NULL
);
549 if (IS_ERR(gss_msg
)) {
550 err
= PTR_ERR(gss_msg
);
553 pipe
= gss_msg
->pipe
;
554 spin_lock(&pipe
->lock
);
555 if (gss_cred
->gc_upcall
!= NULL
)
556 rpc_sleep_on(&gss_cred
->gc_upcall
->rpc_waitqueue
, task
, NULL
);
557 else if (gss_msg
->ctx
== NULL
&& gss_msg
->msg
.errno
>= 0) {
558 task
->tk_timeout
= 0;
559 gss_cred
->gc_upcall
= gss_msg
;
560 /* gss_upcall_callback will release the reference to gss_upcall_msg */
561 atomic_inc(&gss_msg
->count
);
562 rpc_sleep_on(&gss_msg
->rpc_waitqueue
, task
, gss_upcall_callback
);
564 gss_handle_downcall_result(gss_cred
, gss_msg
);
565 err
= gss_msg
->msg
.errno
;
567 spin_unlock(&pipe
->lock
);
568 gss_release_msg(gss_msg
);
570 dprintk("RPC: %5u %s for uid %u result %d\n",
571 task
->tk_pid
, __func__
,
572 from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
577 gss_create_upcall(struct gss_auth
*gss_auth
, struct gss_cred
*gss_cred
)
579 struct net
*net
= gss_auth
->net
;
580 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
581 struct rpc_pipe
*pipe
;
582 struct rpc_cred
*cred
= &gss_cred
->gc_base
;
583 struct gss_upcall_msg
*gss_msg
;
584 unsigned long timeout
;
588 dprintk("RPC: %s for uid %u\n",
589 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
592 /* Default timeout is 15s unless we know that gssd is not running */
594 if (!sn
->gssd_running
)
596 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
597 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
598 err
= wait_event_interruptible_timeout(pipe_version_waitqueue
,
599 sn
->pipe_version
>= 0, timeout
);
600 if (sn
->pipe_version
< 0) {
602 sn
->gssd_running
= 0;
610 if (IS_ERR(gss_msg
)) {
611 err
= PTR_ERR(gss_msg
);
614 pipe
= gss_msg
->pipe
;
616 prepare_to_wait(&gss_msg
->waitqueue
, &wait
, TASK_KILLABLE
);
617 spin_lock(&pipe
->lock
);
618 if (gss_msg
->ctx
!= NULL
|| gss_msg
->msg
.errno
< 0) {
621 spin_unlock(&pipe
->lock
);
622 if (fatal_signal_pending(current
)) {
629 gss_cred_set_ctx(cred
, gss_msg
->ctx
);
631 err
= gss_msg
->msg
.errno
;
632 spin_unlock(&pipe
->lock
);
634 finish_wait(&gss_msg
->waitqueue
, &wait
);
635 gss_release_msg(gss_msg
);
637 dprintk("RPC: %s for uid %u result %d\n",
638 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
642 #define MSG_BUF_MAXSIZE 1024
645 gss_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
649 struct gss_upcall_msg
*gss_msg
;
650 struct rpc_pipe
*pipe
= RPC_I(file_inode(filp
))->pipe
;
651 struct gss_cl_ctx
*ctx
;
654 ssize_t err
= -EFBIG
;
656 if (mlen
> MSG_BUF_MAXSIZE
)
659 buf
= kmalloc(mlen
, GFP_NOFS
);
664 if (copy_from_user(buf
, src
, mlen
))
667 end
= (const void *)((char *)buf
+ mlen
);
668 p
= simple_get_bytes(buf
, end
, &id
, sizeof(id
));
674 uid
= make_kuid(&init_user_ns
, id
);
675 if (!uid_valid(uid
)) {
681 ctx
= gss_alloc_context();
686 /* Find a matching upcall */
687 spin_lock(&pipe
->lock
);
688 gss_msg
= __gss_find_upcall(pipe
, uid
);
689 if (gss_msg
== NULL
) {
690 spin_unlock(&pipe
->lock
);
693 list_del_init(&gss_msg
->list
);
694 spin_unlock(&pipe
->lock
);
696 p
= gss_fill_context(p
, end
, ctx
, gss_msg
->auth
->mech
);
702 gss_msg
->msg
.errno
= err
;
709 gss_msg
->msg
.errno
= -EAGAIN
;
712 printk(KERN_CRIT
"%s: bad return from "
713 "gss_fill_context: %zd\n", __func__
, err
);
716 goto err_release_msg
;
718 gss_msg
->ctx
= gss_get_ctx(ctx
);
722 spin_lock(&pipe
->lock
);
723 __gss_unhash_msg(gss_msg
);
724 spin_unlock(&pipe
->lock
);
725 gss_release_msg(gss_msg
);
731 dprintk("RPC: %s returning %Zd\n", __func__
, err
);
735 static int gss_pipe_open(struct inode
*inode
, int new_version
)
737 struct net
*net
= inode
->i_sb
->s_fs_info
;
738 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
741 spin_lock(&pipe_version_lock
);
742 if (sn
->pipe_version
< 0) {
743 /* First open of any gss pipe determines the version: */
744 sn
->pipe_version
= new_version
;
745 rpc_wake_up(&pipe_version_rpc_waitqueue
);
746 wake_up(&pipe_version_waitqueue
);
747 } else if (sn
->pipe_version
!= new_version
) {
748 /* Trying to open a pipe of a different version */
752 atomic_inc(&sn
->pipe_users
);
754 spin_unlock(&pipe_version_lock
);
759 static int gss_pipe_open_v0(struct inode
*inode
)
761 return gss_pipe_open(inode
, 0);
764 static int gss_pipe_open_v1(struct inode
*inode
)
766 return gss_pipe_open(inode
, 1);
770 gss_pipe_release(struct inode
*inode
)
772 struct net
*net
= inode
->i_sb
->s_fs_info
;
773 struct rpc_pipe
*pipe
= RPC_I(inode
)->pipe
;
774 struct gss_upcall_msg
*gss_msg
;
777 spin_lock(&pipe
->lock
);
778 list_for_each_entry(gss_msg
, &pipe
->in_downcall
, list
) {
780 if (!list_empty(&gss_msg
->msg
.list
))
782 gss_msg
->msg
.errno
= -EPIPE
;
783 atomic_inc(&gss_msg
->count
);
784 __gss_unhash_msg(gss_msg
);
785 spin_unlock(&pipe
->lock
);
786 gss_release_msg(gss_msg
);
789 spin_unlock(&pipe
->lock
);
791 put_pipe_version(net
);
795 gss_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
797 struct gss_upcall_msg
*gss_msg
= container_of(msg
, struct gss_upcall_msg
, msg
);
799 if (msg
->errno
< 0) {
800 dprintk("RPC: %s releasing msg %p\n",
802 atomic_inc(&gss_msg
->count
);
803 gss_unhash_msg(gss_msg
);
804 if (msg
->errno
== -ETIMEDOUT
)
806 gss_release_msg(gss_msg
);
810 static void gss_pipe_dentry_destroy(struct dentry
*dir
,
811 struct rpc_pipe_dir_object
*pdo
)
813 struct gss_pipe
*gss_pipe
= pdo
->pdo_data
;
814 struct rpc_pipe
*pipe
= gss_pipe
->pipe
;
816 if (pipe
->dentry
!= NULL
) {
817 rpc_unlink(pipe
->dentry
);
822 static int gss_pipe_dentry_create(struct dentry
*dir
,
823 struct rpc_pipe_dir_object
*pdo
)
825 struct gss_pipe
*p
= pdo
->pdo_data
;
826 struct dentry
*dentry
;
828 dentry
= rpc_mkpipe_dentry(dir
, p
->name
, p
->clnt
, p
->pipe
);
830 return PTR_ERR(dentry
);
831 p
->pipe
->dentry
= dentry
;
835 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops
= {
836 .create
= gss_pipe_dentry_create
,
837 .destroy
= gss_pipe_dentry_destroy
,
840 static struct gss_pipe
*gss_pipe_alloc(struct rpc_clnt
*clnt
,
842 const struct rpc_pipe_ops
*upcall_ops
)
847 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
850 p
->pipe
= rpc_mkpipe_data(upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
851 if (IS_ERR(p
->pipe
)) {
852 err
= PTR_ERR(p
->pipe
);
853 goto err_free_gss_pipe
;
858 rpc_init_pipe_dir_object(&p
->pdo
,
859 &gss_pipe_dir_object_ops
,
868 struct gss_alloc_pdo
{
869 struct rpc_clnt
*clnt
;
871 const struct rpc_pipe_ops
*upcall_ops
;
874 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object
*pdo
, void *data
)
876 struct gss_pipe
*gss_pipe
;
877 struct gss_alloc_pdo
*args
= data
;
879 if (pdo
->pdo_ops
!= &gss_pipe_dir_object_ops
)
881 gss_pipe
= container_of(pdo
, struct gss_pipe
, pdo
);
882 if (strcmp(gss_pipe
->name
, args
->name
) != 0)
884 if (!kref_get_unless_zero(&gss_pipe
->kref
))
889 static struct rpc_pipe_dir_object
*gss_pipe_alloc_pdo(void *data
)
891 struct gss_pipe
*gss_pipe
;
892 struct gss_alloc_pdo
*args
= data
;
894 gss_pipe
= gss_pipe_alloc(args
->clnt
, args
->name
, args
->upcall_ops
);
895 if (!IS_ERR(gss_pipe
))
896 return &gss_pipe
->pdo
;
900 static struct gss_pipe
*gss_pipe_get(struct rpc_clnt
*clnt
,
902 const struct rpc_pipe_ops
*upcall_ops
)
904 struct net
*net
= rpc_net_ns(clnt
);
905 struct rpc_pipe_dir_object
*pdo
;
906 struct gss_alloc_pdo args
= {
909 .upcall_ops
= upcall_ops
,
912 pdo
= rpc_find_or_alloc_pipe_dir_object(net
,
913 &clnt
->cl_pipedir_objects
,
918 return container_of(pdo
, struct gss_pipe
, pdo
);
919 return ERR_PTR(-ENOMEM
);
922 static void __gss_pipe_free(struct gss_pipe
*p
)
924 struct rpc_clnt
*clnt
= p
->clnt
;
925 struct net
*net
= rpc_net_ns(clnt
);
927 rpc_remove_pipe_dir_object(net
,
928 &clnt
->cl_pipedir_objects
,
930 rpc_destroy_pipe_data(p
->pipe
);
934 static void __gss_pipe_release(struct kref
*kref
)
936 struct gss_pipe
*p
= container_of(kref
, struct gss_pipe
, kref
);
941 static void gss_pipe_free(struct gss_pipe
*p
)
944 kref_put(&p
->kref
, __gss_pipe_release
);
948 * NOTE: we have the opportunity to use different
949 * parameters based on the input flavor (which must be a pseudoflavor)
951 static struct gss_auth
*
952 gss_create_new(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
954 rpc_authflavor_t flavor
= args
->pseudoflavor
;
955 struct gss_auth
*gss_auth
;
956 struct gss_pipe
*gss_pipe
;
957 struct rpc_auth
* auth
;
958 int err
= -ENOMEM
; /* XXX? */
960 dprintk("RPC: creating GSS authenticator for client %p\n", clnt
);
962 if (!try_module_get(THIS_MODULE
))
964 if (!(gss_auth
= kmalloc(sizeof(*gss_auth
), GFP_KERNEL
)))
966 INIT_HLIST_NODE(&gss_auth
->hash
);
967 gss_auth
->target_name
= NULL
;
968 if (args
->target_name
) {
969 gss_auth
->target_name
= kstrdup(args
->target_name
, GFP_KERNEL
);
970 if (gss_auth
->target_name
== NULL
)
973 gss_auth
->client
= clnt
;
974 gss_auth
->net
= get_net(rpc_net_ns(clnt
));
976 gss_auth
->mech
= gss_mech_get_by_pseudoflavor(flavor
);
977 if (!gss_auth
->mech
) {
978 dprintk("RPC: Pseudoflavor %d not found!\n", flavor
);
981 gss_auth
->service
= gss_pseudoflavor_to_service(gss_auth
->mech
, flavor
);
982 if (gss_auth
->service
== 0)
984 auth
= &gss_auth
->rpc_auth
;
985 auth
->au_cslack
= GSS_CRED_SLACK
>> 2;
986 auth
->au_rslack
= GSS_VERF_SLACK
>> 2;
987 auth
->au_ops
= &authgss_ops
;
988 auth
->au_flavor
= flavor
;
989 atomic_set(&auth
->au_count
, 1);
990 kref_init(&gss_auth
->kref
);
992 err
= rpcauth_init_credcache(auth
);
996 * Note: if we created the old pipe first, then someone who
997 * examined the directory at the right moment might conclude
998 * that we supported only the old pipe. So we instead create
999 * the new pipe first.
1001 gss_pipe
= gss_pipe_get(clnt
, "gssd", &gss_upcall_ops_v1
);
1002 if (IS_ERR(gss_pipe
)) {
1003 err
= PTR_ERR(gss_pipe
);
1004 goto err_destroy_credcache
;
1006 gss_auth
->gss_pipe
[1] = gss_pipe
;
1008 gss_pipe
= gss_pipe_get(clnt
, gss_auth
->mech
->gm_name
,
1009 &gss_upcall_ops_v0
);
1010 if (IS_ERR(gss_pipe
)) {
1011 err
= PTR_ERR(gss_pipe
);
1012 goto err_destroy_pipe_1
;
1014 gss_auth
->gss_pipe
[0] = gss_pipe
;
1018 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1019 err_destroy_credcache
:
1020 rpcauth_destroy_credcache(auth
);
1022 gss_mech_put(gss_auth
->mech
);
1024 put_net(gss_auth
->net
);
1026 kfree(gss_auth
->target_name
);
1029 module_put(THIS_MODULE
);
1030 return ERR_PTR(err
);
1034 gss_free(struct gss_auth
*gss_auth
)
1036 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1037 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1038 gss_mech_put(gss_auth
->mech
);
1039 put_net(gss_auth
->net
);
1040 kfree(gss_auth
->target_name
);
1043 module_put(THIS_MODULE
);
1047 gss_free_callback(struct kref
*kref
)
1049 struct gss_auth
*gss_auth
= container_of(kref
, struct gss_auth
, kref
);
1055 gss_destroy(struct rpc_auth
*auth
)
1057 struct gss_auth
*gss_auth
= container_of(auth
,
1058 struct gss_auth
, rpc_auth
);
1060 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1061 auth
, auth
->au_flavor
);
1063 if (hash_hashed(&gss_auth
->hash
)) {
1064 spin_lock(&gss_auth_hash_lock
);
1065 hash_del(&gss_auth
->hash
);
1066 spin_unlock(&gss_auth_hash_lock
);
1069 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1070 gss_auth
->gss_pipe
[0] = NULL
;
1071 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1072 gss_auth
->gss_pipe
[1] = NULL
;
1073 rpcauth_destroy_credcache(auth
);
1075 kref_put(&gss_auth
->kref
, gss_free_callback
);
1079 * Auths may be shared between rpc clients that were cloned from a
1080 * common client with the same xprt, if they also share the flavor and
1083 * The auth is looked up from the oldest parent sharing the same
1084 * cl_xprt, and the auth itself references only that common parent
1085 * (which is guaranteed to last as long as any of its descendants).
1087 static struct gss_auth
*
1088 gss_auth_find_or_add_hashed(struct rpc_auth_create_args
*args
,
1089 struct rpc_clnt
*clnt
,
1090 struct gss_auth
*new)
1092 struct gss_auth
*gss_auth
;
1093 unsigned long hashval
= (unsigned long)clnt
;
1095 spin_lock(&gss_auth_hash_lock
);
1096 hash_for_each_possible(gss_auth_hash_table
,
1100 if (gss_auth
->client
!= clnt
)
1102 if (gss_auth
->rpc_auth
.au_flavor
!= args
->pseudoflavor
)
1104 if (gss_auth
->target_name
!= args
->target_name
) {
1105 if (gss_auth
->target_name
== NULL
)
1107 if (args
->target_name
== NULL
)
1109 if (strcmp(gss_auth
->target_name
, args
->target_name
))
1112 if (!atomic_inc_not_zero(&gss_auth
->rpc_auth
.au_count
))
1117 hash_add(gss_auth_hash_table
, &new->hash
, hashval
);
1120 spin_unlock(&gss_auth_hash_lock
);
1124 static struct gss_auth
*
1125 gss_create_hashed(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1127 struct gss_auth
*gss_auth
;
1128 struct gss_auth
*new;
1130 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, NULL
);
1131 if (gss_auth
!= NULL
)
1133 new = gss_create_new(args
, clnt
);
1136 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, new);
1137 if (gss_auth
!= new)
1138 gss_destroy(&new->rpc_auth
);
1143 static struct rpc_auth
*
1144 gss_create(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1146 struct gss_auth
*gss_auth
;
1147 struct rpc_xprt
*xprt
= rcu_access_pointer(clnt
->cl_xprt
);
1149 while (clnt
!= clnt
->cl_parent
) {
1150 struct rpc_clnt
*parent
= clnt
->cl_parent
;
1151 /* Find the original parent for this transport */
1152 if (rcu_access_pointer(parent
->cl_xprt
) != xprt
)
1157 gss_auth
= gss_create_hashed(args
, clnt
);
1158 if (IS_ERR(gss_auth
))
1159 return ERR_CAST(gss_auth
);
1160 return &gss_auth
->rpc_auth
;
1164 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1165 * to the server with the GSS control procedure field set to
1166 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1167 * all RPCSEC_GSS state associated with that context.
1170 gss_destroying_context(struct rpc_cred
*cred
)
1172 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1173 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1174 struct rpc_task
*task
;
1176 if (gss_cred
->gc_ctx
== NULL
||
1177 test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
) == 0)
1180 gss_cred
->gc_ctx
->gc_proc
= RPC_GSS_PROC_DESTROY
;
1181 cred
->cr_ops
= &gss_nullops
;
1183 /* Take a reference to ensure the cred will be destroyed either
1184 * by the RPC call or by the put_rpccred() below */
1187 task
= rpc_call_null(gss_auth
->client
, cred
, RPC_TASK_ASYNC
|RPC_TASK_SOFT
);
1195 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1196 * to create a new cred or context, so they check that things have been
1197 * allocated before freeing them. */
1199 gss_do_free_ctx(struct gss_cl_ctx
*ctx
)
1201 dprintk("RPC: %s\n", __func__
);
1203 gss_delete_sec_context(&ctx
->gc_gss_ctx
);
1204 kfree(ctx
->gc_wire_ctx
.data
);
1209 gss_free_ctx_callback(struct rcu_head
*head
)
1211 struct gss_cl_ctx
*ctx
= container_of(head
, struct gss_cl_ctx
, gc_rcu
);
1212 gss_do_free_ctx(ctx
);
1216 gss_free_ctx(struct gss_cl_ctx
*ctx
)
1218 call_rcu(&ctx
->gc_rcu
, gss_free_ctx_callback
);
1222 gss_free_cred(struct gss_cred
*gss_cred
)
1224 dprintk("RPC: %s cred=%p\n", __func__
, gss_cred
);
1229 gss_free_cred_callback(struct rcu_head
*head
)
1231 struct gss_cred
*gss_cred
= container_of(head
, struct gss_cred
, gc_base
.cr_rcu
);
1232 gss_free_cred(gss_cred
);
1236 gss_destroy_nullcred(struct rpc_cred
*cred
)
1238 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1239 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1240 struct gss_cl_ctx
*ctx
= gss_cred
->gc_ctx
;
1242 RCU_INIT_POINTER(gss_cred
->gc_ctx
, NULL
);
1243 call_rcu(&cred
->cr_rcu
, gss_free_cred_callback
);
1246 kref_put(&gss_auth
->kref
, gss_free_callback
);
1250 gss_destroy_cred(struct rpc_cred
*cred
)
1253 if (gss_destroying_context(cred
))
1255 gss_destroy_nullcred(cred
);
1259 * Lookup RPCSEC_GSS cred for the current process
1261 static struct rpc_cred
*
1262 gss_lookup_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1264 return rpcauth_lookup_credcache(auth
, acred
, flags
);
1267 static struct rpc_cred
*
1268 gss_create_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1270 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1271 struct gss_cred
*cred
= NULL
;
1274 dprintk("RPC: %s for uid %d, flavor %d\n",
1275 __func__
, from_kuid(&init_user_ns
, acred
->uid
),
1278 if (!(cred
= kzalloc(sizeof(*cred
), GFP_NOFS
)))
1281 rpcauth_init_cred(&cred
->gc_base
, acred
, auth
, &gss_credops
);
1283 * Note: in order to force a call to call_refresh(), we deliberately
1284 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1286 cred
->gc_base
.cr_flags
= 1UL << RPCAUTH_CRED_NEW
;
1287 cred
->gc_service
= gss_auth
->service
;
1288 cred
->gc_principal
= NULL
;
1289 if (acred
->machine_cred
)
1290 cred
->gc_principal
= acred
->principal
;
1291 kref_get(&gss_auth
->kref
);
1292 return &cred
->gc_base
;
1295 dprintk("RPC: %s failed with error %d\n", __func__
, err
);
1296 return ERR_PTR(err
);
1300 gss_cred_init(struct rpc_auth
*auth
, struct rpc_cred
*cred
)
1302 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1303 struct gss_cred
*gss_cred
= container_of(cred
,struct gss_cred
, gc_base
);
1307 err
= gss_create_upcall(gss_auth
, gss_cred
);
1308 } while (err
== -EAGAIN
);
1313 * Returns -EACCES if GSS context is NULL or will expire within the
1314 * timeout (miliseconds)
1317 gss_key_timeout(struct rpc_cred
*rc
)
1319 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1320 unsigned long now
= jiffies
;
1321 unsigned long expire
;
1323 if (gss_cred
->gc_ctx
== NULL
)
1326 expire
= gss_cred
->gc_ctx
->gc_expiry
- (gss_key_expire_timeo
* HZ
);
1328 if (time_after(now
, expire
))
1334 gss_match(struct auth_cred
*acred
, struct rpc_cred
*rc
, int flags
)
1336 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1339 if (test_bit(RPCAUTH_CRED_NEW
, &rc
->cr_flags
))
1341 /* Don't match with creds that have expired. */
1342 if (time_after(jiffies
, gss_cred
->gc_ctx
->gc_expiry
))
1344 if (!test_bit(RPCAUTH_CRED_UPTODATE
, &rc
->cr_flags
))
1347 if (acred
->principal
!= NULL
) {
1348 if (gss_cred
->gc_principal
== NULL
)
1350 ret
= strcmp(acred
->principal
, gss_cred
->gc_principal
) == 0;
1353 if (gss_cred
->gc_principal
!= NULL
)
1355 ret
= uid_eq(rc
->cr_uid
, acred
->uid
);
1361 /* Notify acred users of GSS context expiration timeout */
1362 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
) &&
1363 (gss_key_timeout(rc
) != 0)) {
1364 /* test will now be done from generic cred */
1365 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
);
1366 /* tell NFS layer that key will expire soon */
1367 set_bit(RPC_CRED_KEY_EXPIRE_SOON
, &acred
->ac_flags
);
1373 * Marshal credentials.
1374 * Maybe we should keep a cached credential for performance reasons.
1377 gss_marshal(struct rpc_task
*task
, __be32
*p
)
1379 struct rpc_rqst
*req
= task
->tk_rqstp
;
1380 struct rpc_cred
*cred
= req
->rq_cred
;
1381 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1383 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1386 struct xdr_netobj mic
;
1388 struct xdr_buf verf_buf
;
1390 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1392 *p
++ = htonl(RPC_AUTH_GSS
);
1395 spin_lock(&ctx
->gc_seq_lock
);
1396 req
->rq_seqno
= ctx
->gc_seq
++;
1397 spin_unlock(&ctx
->gc_seq_lock
);
1399 *p
++ = htonl((u32
) RPC_GSS_VERSION
);
1400 *p
++ = htonl((u32
) ctx
->gc_proc
);
1401 *p
++ = htonl((u32
) req
->rq_seqno
);
1402 *p
++ = htonl((u32
) gss_cred
->gc_service
);
1403 p
= xdr_encode_netobj(p
, &ctx
->gc_wire_ctx
);
1404 *cred_len
= htonl((p
- (cred_len
+ 1)) << 2);
1406 /* We compute the checksum for the verifier over the xdr-encoded bytes
1407 * starting with the xid and ending at the end of the credential: */
1408 iov
.iov_base
= xprt_skip_transport_header(req
->rq_xprt
,
1409 req
->rq_snd_buf
.head
[0].iov_base
);
1410 iov
.iov_len
= (u8
*)p
- (u8
*)iov
.iov_base
;
1411 xdr_buf_from_iov(&iov
, &verf_buf
);
1413 /* set verifier flavor*/
1414 *p
++ = htonl(RPC_AUTH_GSS
);
1416 mic
.data
= (u8
*)(p
+ 1);
1417 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1418 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
) {
1419 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1420 } else if (maj_stat
!= 0) {
1421 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat
);
1424 p
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1432 static int gss_renew_cred(struct rpc_task
*task
)
1434 struct rpc_cred
*oldcred
= task
->tk_rqstp
->rq_cred
;
1435 struct gss_cred
*gss_cred
= container_of(oldcred
,
1438 struct rpc_auth
*auth
= oldcred
->cr_auth
;
1439 struct auth_cred acred
= {
1440 .uid
= oldcred
->cr_uid
,
1441 .principal
= gss_cred
->gc_principal
,
1442 .machine_cred
= (gss_cred
->gc_principal
!= NULL
? 1 : 0),
1444 struct rpc_cred
*new;
1446 new = gss_lookup_cred(auth
, &acred
, RPCAUTH_LOOKUP_NEW
);
1448 return PTR_ERR(new);
1449 task
->tk_rqstp
->rq_cred
= new;
1450 put_rpccred(oldcred
);
1454 static int gss_cred_is_negative_entry(struct rpc_cred
*cred
)
1456 if (test_bit(RPCAUTH_CRED_NEGATIVE
, &cred
->cr_flags
)) {
1457 unsigned long now
= jiffies
;
1458 unsigned long begin
, expire
;
1459 struct gss_cred
*gss_cred
;
1461 gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1462 begin
= gss_cred
->gc_upcall_timestamp
;
1463 expire
= begin
+ gss_expired_cred_retry_delay
* HZ
;
1465 if (time_in_range_open(now
, begin
, expire
))
1472 * Refresh credentials. XXX - finish
1475 gss_refresh(struct rpc_task
*task
)
1477 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1480 if (gss_cred_is_negative_entry(cred
))
1481 return -EKEYEXPIRED
;
1483 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
) &&
1484 !test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
)) {
1485 ret
= gss_renew_cred(task
);
1488 cred
= task
->tk_rqstp
->rq_cred
;
1491 if (test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
1492 ret
= gss_refresh_upcall(task
);
1497 /* Dummy refresh routine: used only when destroying the context */
1499 gss_refresh_null(struct rpc_task
*task
)
1505 gss_validate(struct rpc_task
*task
, __be32
*p
)
1507 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1508 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1511 struct xdr_buf verf_buf
;
1512 struct xdr_netobj mic
;
1515 __be32
*ret
= ERR_PTR(-EIO
);
1517 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1520 if ((len
= ntohl(*p
++)) > RPC_MAX_AUTH_SIZE
)
1522 if (flav
!= RPC_AUTH_GSS
)
1524 seq
= htonl(task
->tk_rqstp
->rq_seqno
);
1525 iov
.iov_base
= &seq
;
1526 iov
.iov_len
= sizeof(seq
);
1527 xdr_buf_from_iov(&iov
, &verf_buf
);
1531 ret
= ERR_PTR(-EACCES
);
1532 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1533 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1534 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1536 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1537 task
->tk_pid
, __func__
, maj_stat
);
1540 /* We leave it to unwrap to calculate au_rslack. For now we just
1541 * calculate the length of the verifier: */
1542 cred
->cr_auth
->au_verfsize
= XDR_QUADLEN(len
) + 2;
1544 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1545 task
->tk_pid
, __func__
);
1546 return p
+ XDR_QUADLEN(len
);
1549 dprintk("RPC: %5u %s failed ret %ld.\n", task
->tk_pid
, __func__
,
1554 static void gss_wrap_req_encode(kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1555 __be32
*p
, void *obj
)
1557 struct xdr_stream xdr
;
1559 xdr_init_encode(&xdr
, &rqstp
->rq_snd_buf
, p
);
1560 encode(rqstp
, &xdr
, obj
);
1564 gss_wrap_req_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1565 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1566 __be32
*p
, void *obj
)
1568 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1569 struct xdr_buf integ_buf
;
1570 __be32
*integ_len
= NULL
;
1571 struct xdr_netobj mic
;
1579 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1580 *p
++ = htonl(rqstp
->rq_seqno
);
1582 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1584 if (xdr_buf_subsegment(snd_buf
, &integ_buf
,
1585 offset
, snd_buf
->len
- offset
))
1587 *integ_len
= htonl(integ_buf
.len
);
1589 /* guess whether we're in the head or the tail: */
1590 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1591 iov
= snd_buf
->tail
;
1593 iov
= snd_buf
->head
;
1594 p
= iov
->iov_base
+ iov
->iov_len
;
1595 mic
.data
= (u8
*)(p
+ 1);
1597 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1598 status
= -EIO
; /* XXX? */
1599 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1600 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1603 q
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1605 offset
= (u8
*)q
- (u8
*)p
;
1606 iov
->iov_len
+= offset
;
1607 snd_buf
->len
+= offset
;
1612 priv_release_snd_buf(struct rpc_rqst
*rqstp
)
1616 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++)
1617 __free_page(rqstp
->rq_enc_pages
[i
]);
1618 kfree(rqstp
->rq_enc_pages
);
1622 alloc_enc_pages(struct rpc_rqst
*rqstp
)
1624 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1627 if (snd_buf
->page_len
== 0) {
1628 rqstp
->rq_enc_pages_num
= 0;
1632 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1633 last
= (snd_buf
->page_base
+ snd_buf
->page_len
- 1) >> PAGE_CACHE_SHIFT
;
1634 rqstp
->rq_enc_pages_num
= last
- first
+ 1 + 1;
1636 = kmalloc(rqstp
->rq_enc_pages_num
* sizeof(struct page
*),
1638 if (!rqstp
->rq_enc_pages
)
1640 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++) {
1641 rqstp
->rq_enc_pages
[i
] = alloc_page(GFP_NOFS
);
1642 if (rqstp
->rq_enc_pages
[i
] == NULL
)
1645 rqstp
->rq_release_snd_buf
= priv_release_snd_buf
;
1648 rqstp
->rq_enc_pages_num
= i
;
1649 priv_release_snd_buf(rqstp
);
1655 gss_wrap_req_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1656 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1657 __be32
*p
, void *obj
)
1659 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1664 struct page
**inpages
;
1671 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1672 *p
++ = htonl(rqstp
->rq_seqno
);
1674 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1676 status
= alloc_enc_pages(rqstp
);
1679 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1680 inpages
= snd_buf
->pages
+ first
;
1681 snd_buf
->pages
= rqstp
->rq_enc_pages
;
1682 snd_buf
->page_base
-= first
<< PAGE_CACHE_SHIFT
;
1684 * Give the tail its own page, in case we need extra space in the
1685 * head when wrapping:
1687 * call_allocate() allocates twice the slack space required
1688 * by the authentication flavor to rq_callsize.
1689 * For GSS, slack is GSS_CRED_SLACK.
1691 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
) {
1692 tmp
= page_address(rqstp
->rq_enc_pages
[rqstp
->rq_enc_pages_num
- 1]);
1693 memcpy(tmp
, snd_buf
->tail
[0].iov_base
, snd_buf
->tail
[0].iov_len
);
1694 snd_buf
->tail
[0].iov_base
= tmp
;
1696 maj_stat
= gss_wrap(ctx
->gc_gss_ctx
, offset
, snd_buf
, inpages
);
1697 /* slack space should prevent this ever happening: */
1698 BUG_ON(snd_buf
->len
> snd_buf
->buflen
);
1700 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1701 * done anyway, so it's safe to put the request on the wire: */
1702 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1703 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1707 *opaque_len
= htonl(snd_buf
->len
- offset
);
1708 /* guess whether we're in the head or the tail: */
1709 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1710 iov
= snd_buf
->tail
;
1712 iov
= snd_buf
->head
;
1713 p
= iov
->iov_base
+ iov
->iov_len
;
1714 pad
= 3 - ((snd_buf
->len
- offset
- 1) & 3);
1716 iov
->iov_len
+= pad
;
1717 snd_buf
->len
+= pad
;
1723 gss_wrap_req(struct rpc_task
*task
,
1724 kxdreproc_t encode
, void *rqstp
, __be32
*p
, void *obj
)
1726 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1727 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1729 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1732 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1733 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
) {
1734 /* The spec seems a little ambiguous here, but I think that not
1735 * wrapping context destruction requests makes the most sense.
1737 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1741 switch (gss_cred
->gc_service
) {
1742 case RPC_GSS_SVC_NONE
:
1743 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1746 case RPC_GSS_SVC_INTEGRITY
:
1747 status
= gss_wrap_req_integ(cred
, ctx
, encode
, rqstp
, p
, obj
);
1749 case RPC_GSS_SVC_PRIVACY
:
1750 status
= gss_wrap_req_priv(cred
, ctx
, encode
, rqstp
, p
, obj
);
1755 dprintk("RPC: %5u %s returning %d\n", task
->tk_pid
, __func__
, status
);
1760 gss_unwrap_resp_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1761 struct rpc_rqst
*rqstp
, __be32
**p
)
1763 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1764 struct xdr_buf integ_buf
;
1765 struct xdr_netobj mic
;
1766 u32 data_offset
, mic_offset
;
1771 integ_len
= ntohl(*(*p
)++);
1774 data_offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1775 mic_offset
= integ_len
+ data_offset
;
1776 if (mic_offset
> rcv_buf
->len
)
1778 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1781 if (xdr_buf_subsegment(rcv_buf
, &integ_buf
, data_offset
,
1782 mic_offset
- data_offset
))
1785 if (xdr_buf_read_netobj(rcv_buf
, &mic
, mic_offset
))
1788 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1789 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1790 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1791 if (maj_stat
!= GSS_S_COMPLETE
)
1797 gss_unwrap_resp_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1798 struct rpc_rqst
*rqstp
, __be32
**p
)
1800 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1806 opaque_len
= ntohl(*(*p
)++);
1807 offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1808 if (offset
+ opaque_len
> rcv_buf
->len
)
1810 /* remove padding: */
1811 rcv_buf
->len
= offset
+ opaque_len
;
1813 maj_stat
= gss_unwrap(ctx
->gc_gss_ctx
, offset
, rcv_buf
);
1814 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1815 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1816 if (maj_stat
!= GSS_S_COMPLETE
)
1818 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1825 gss_unwrap_req_decode(kxdrdproc_t decode
, struct rpc_rqst
*rqstp
,
1826 __be32
*p
, void *obj
)
1828 struct xdr_stream xdr
;
1830 xdr_init_decode(&xdr
, &rqstp
->rq_rcv_buf
, p
);
1831 return decode(rqstp
, &xdr
, obj
);
1835 gss_unwrap_resp(struct rpc_task
*task
,
1836 kxdrdproc_t decode
, void *rqstp
, __be32
*p
, void *obj
)
1838 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1839 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1841 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1843 struct kvec
*head
= ((struct rpc_rqst
*)rqstp
)->rq_rcv_buf
.head
;
1844 int savedlen
= head
->iov_len
;
1847 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
)
1849 switch (gss_cred
->gc_service
) {
1850 case RPC_GSS_SVC_NONE
:
1852 case RPC_GSS_SVC_INTEGRITY
:
1853 status
= gss_unwrap_resp_integ(cred
, ctx
, rqstp
, &p
);
1857 case RPC_GSS_SVC_PRIVACY
:
1858 status
= gss_unwrap_resp_priv(cred
, ctx
, rqstp
, &p
);
1863 /* take into account extra slack for integrity and privacy cases: */
1864 cred
->cr_auth
->au_rslack
= cred
->cr_auth
->au_verfsize
+ (p
- savedp
)
1865 + (savedlen
- head
->iov_len
);
1867 status
= gss_unwrap_req_decode(decode
, rqstp
, p
, obj
);
1870 dprintk("RPC: %5u %s returning %d\n",
1871 task
->tk_pid
, __func__
, status
);
1875 static const struct rpc_authops authgss_ops
= {
1876 .owner
= THIS_MODULE
,
1877 .au_flavor
= RPC_AUTH_GSS
,
1878 .au_name
= "RPCSEC_GSS",
1879 .create
= gss_create
,
1880 .destroy
= gss_destroy
,
1881 .lookup_cred
= gss_lookup_cred
,
1882 .crcreate
= gss_create_cred
,
1883 .list_pseudoflavors
= gss_mech_list_pseudoflavors
,
1884 .info2flavor
= gss_mech_info2flavor
,
1885 .flavor2info
= gss_mech_flavor2info
,
1888 static const struct rpc_credops gss_credops
= {
1889 .cr_name
= "AUTH_GSS",
1890 .crdestroy
= gss_destroy_cred
,
1891 .cr_init
= gss_cred_init
,
1892 .crbind
= rpcauth_generic_bind_cred
,
1893 .crmatch
= gss_match
,
1894 .crmarshal
= gss_marshal
,
1895 .crrefresh
= gss_refresh
,
1896 .crvalidate
= gss_validate
,
1897 .crwrap_req
= gss_wrap_req
,
1898 .crunwrap_resp
= gss_unwrap_resp
,
1899 .crkey_timeout
= gss_key_timeout
,
1902 static const struct rpc_credops gss_nullops
= {
1903 .cr_name
= "AUTH_GSS",
1904 .crdestroy
= gss_destroy_nullcred
,
1905 .crbind
= rpcauth_generic_bind_cred
,
1906 .crmatch
= gss_match
,
1907 .crmarshal
= gss_marshal
,
1908 .crrefresh
= gss_refresh_null
,
1909 .crvalidate
= gss_validate
,
1910 .crwrap_req
= gss_wrap_req
,
1911 .crunwrap_resp
= gss_unwrap_resp
,
1914 static const struct rpc_pipe_ops gss_upcall_ops_v0
= {
1915 .upcall
= rpc_pipe_generic_upcall
,
1916 .downcall
= gss_pipe_downcall
,
1917 .destroy_msg
= gss_pipe_destroy_msg
,
1918 .open_pipe
= gss_pipe_open_v0
,
1919 .release_pipe
= gss_pipe_release
,
1922 static const struct rpc_pipe_ops gss_upcall_ops_v1
= {
1923 .upcall
= rpc_pipe_generic_upcall
,
1924 .downcall
= gss_pipe_downcall
,
1925 .destroy_msg
= gss_pipe_destroy_msg
,
1926 .open_pipe
= gss_pipe_open_v1
,
1927 .release_pipe
= gss_pipe_release
,
1930 static __net_init
int rpcsec_gss_init_net(struct net
*net
)
1932 return gss_svc_init_net(net
);
1935 static __net_exit
void rpcsec_gss_exit_net(struct net
*net
)
1937 gss_svc_shutdown_net(net
);
1940 static struct pernet_operations rpcsec_gss_net_ops
= {
1941 .init
= rpcsec_gss_init_net
,
1942 .exit
= rpcsec_gss_exit_net
,
1946 * Initialize RPCSEC_GSS module
1948 static int __init
init_rpcsec_gss(void)
1952 err
= rpcauth_register(&authgss_ops
);
1955 err
= gss_svc_init();
1957 goto out_unregister
;
1958 err
= register_pernet_subsys(&rpcsec_gss_net_ops
);
1961 rpc_init_wait_queue(&pipe_version_rpc_waitqueue
, "gss pipe version");
1966 rpcauth_unregister(&authgss_ops
);
1971 static void __exit
exit_rpcsec_gss(void)
1973 unregister_pernet_subsys(&rpcsec_gss_net_ops
);
1975 rpcauth_unregister(&authgss_ops
);
1976 rcu_barrier(); /* Wait for completion of call_rcu()'s */
1979 MODULE_ALIAS("rpc-auth-6");
1980 MODULE_LICENSE("GPL");
1981 module_param_named(expired_cred_retry_delay
,
1982 gss_expired_cred_retry_delay
,
1984 MODULE_PARM_DESC(expired_cred_retry_delay
, "Timeout (in seconds) until "
1985 "the RPC engine retries an expired credential");
1987 module_param_named(key_expire_timeo
,
1988 gss_key_expire_timeo
,
1990 MODULE_PARM_DESC(key_expire_timeo
, "Time (in seconds) at the end of a "
1991 "credential keys lifetime where the NFS layer cleans up "
1992 "prior to key expiration");
1994 module_init(init_rpcsec_gss
)
1995 module_exit(exit_rpcsec_gss
)