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
);
111 static void gss_put_auth(struct gss_auth
*gss_auth
);
113 static void gss_free_ctx(struct gss_cl_ctx
*);
114 static const struct rpc_pipe_ops gss_upcall_ops_v0
;
115 static const struct rpc_pipe_ops gss_upcall_ops_v1
;
117 static inline struct gss_cl_ctx
*
118 gss_get_ctx(struct gss_cl_ctx
*ctx
)
120 atomic_inc(&ctx
->count
);
125 gss_put_ctx(struct gss_cl_ctx
*ctx
)
127 if (atomic_dec_and_test(&ctx
->count
))
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
134 * and a new one is protected by the pipe->lock.
137 gss_cred_set_ctx(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
)
139 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
141 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
144 rcu_assign_pointer(gss_cred
->gc_ctx
, ctx
);
145 set_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
146 smp_mb__before_atomic();
147 clear_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
);
151 simple_get_bytes(const void *p
, const void *end
, void *res
, size_t len
)
153 const void *q
= (const void *)((const char *)p
+ len
);
154 if (unlikely(q
> end
|| q
< p
))
155 return ERR_PTR(-EFAULT
);
160 static inline const void *
161 simple_get_netobj(const void *p
, const void *end
, struct xdr_netobj
*dest
)
166 p
= simple_get_bytes(p
, end
, &len
, sizeof(len
));
169 q
= (const void *)((const char *)p
+ len
);
170 if (unlikely(q
> end
|| q
< p
))
171 return ERR_PTR(-EFAULT
);
172 dest
->data
= kmemdup(p
, len
, GFP_NOFS
);
173 if (unlikely(dest
->data
== NULL
))
174 return ERR_PTR(-ENOMEM
);
179 static struct gss_cl_ctx
*
180 gss_cred_get_ctx(struct rpc_cred
*cred
)
182 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
183 struct gss_cl_ctx
*ctx
= NULL
;
186 if (gss_cred
->gc_ctx
)
187 ctx
= gss_get_ctx(gss_cred
->gc_ctx
);
192 static struct gss_cl_ctx
*
193 gss_alloc_context(void)
195 struct gss_cl_ctx
*ctx
;
197 ctx
= kzalloc(sizeof(*ctx
), GFP_NOFS
);
199 ctx
->gc_proc
= RPC_GSS_PROC_DATA
;
200 ctx
->gc_seq
= 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
201 spin_lock_init(&ctx
->gc_seq_lock
);
202 atomic_set(&ctx
->count
,1);
207 #define GSSD_MIN_TIMEOUT (60 * 60)
209 gss_fill_context(const void *p
, const void *end
, struct gss_cl_ctx
*ctx
, struct gss_api_mech
*gm
)
213 unsigned int timeout
;
214 unsigned long now
= jiffies
;
218 /* First unsigned int gives the remaining lifetime in seconds of the
219 * credential - e.g. the remaining TGT lifetime for Kerberos or
220 * the -t value passed to GSSD.
222 p
= simple_get_bytes(p
, end
, &timeout
, sizeof(timeout
));
226 timeout
= GSSD_MIN_TIMEOUT
;
227 ctx
->gc_expiry
= now
+ ((unsigned long)timeout
* HZ
);
228 /* Sequence number window. Determines the maximum number of
229 * simultaneous requests
231 p
= simple_get_bytes(p
, end
, &window_size
, sizeof(window_size
));
234 ctx
->gc_win
= window_size
;
235 /* gssd signals an error by passing ctx->gc_win = 0: */
236 if (ctx
->gc_win
== 0) {
238 * in which case, p points to an error code. Anything other
239 * than -EKEYEXPIRED gets converted to -EACCES.
241 p
= simple_get_bytes(p
, end
, &ret
, sizeof(ret
));
243 p
= (ret
== -EKEYEXPIRED
) ? ERR_PTR(-EKEYEXPIRED
) :
247 /* copy the opaque wire context */
248 p
= simple_get_netobj(p
, end
, &ctx
->gc_wire_ctx
);
251 /* import the opaque security context */
252 p
= simple_get_bytes(p
, end
, &seclen
, sizeof(seclen
));
255 q
= (const void *)((const char *)p
+ seclen
);
256 if (unlikely(q
> end
|| q
< p
)) {
257 p
= ERR_PTR(-EFAULT
);
260 ret
= gss_import_sec_context(p
, seclen
, gm
, &ctx
->gc_gss_ctx
, NULL
, GFP_NOFS
);
266 /* is there any trailing data? */
272 /* pull in acceptor name (if there is one) */
273 p
= simple_get_netobj(q
, end
, &ctx
->gc_acceptor
);
277 dprintk("RPC: %s Success. gc_expiry %lu now %lu timeout %u acceptor %.*s\n",
278 __func__
, ctx
->gc_expiry
, now
, timeout
, ctx
->gc_acceptor
.len
,
279 ctx
->gc_acceptor
.data
);
282 dprintk("RPC: %s returns error %ld\n", __func__
, -PTR_ERR(p
));
286 #define UPCALL_BUF_LEN 128
288 struct gss_upcall_msg
{
291 struct rpc_pipe_msg msg
;
292 struct list_head list
;
293 struct gss_auth
*auth
;
294 struct rpc_pipe
*pipe
;
295 struct rpc_wait_queue rpc_waitqueue
;
296 wait_queue_head_t waitqueue
;
297 struct gss_cl_ctx
*ctx
;
298 char databuf
[UPCALL_BUF_LEN
];
301 static int get_pipe_version(struct net
*net
)
303 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
306 spin_lock(&pipe_version_lock
);
307 if (sn
->pipe_version
>= 0) {
308 atomic_inc(&sn
->pipe_users
);
309 ret
= sn
->pipe_version
;
312 spin_unlock(&pipe_version_lock
);
316 static void put_pipe_version(struct net
*net
)
318 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
320 if (atomic_dec_and_lock(&sn
->pipe_users
, &pipe_version_lock
)) {
321 sn
->pipe_version
= -1;
322 spin_unlock(&pipe_version_lock
);
327 gss_release_msg(struct gss_upcall_msg
*gss_msg
)
329 struct net
*net
= gss_msg
->auth
->net
;
330 if (!atomic_dec_and_test(&gss_msg
->count
))
332 put_pipe_version(net
);
333 BUG_ON(!list_empty(&gss_msg
->list
));
334 if (gss_msg
->ctx
!= NULL
)
335 gss_put_ctx(gss_msg
->ctx
);
336 rpc_destroy_wait_queue(&gss_msg
->rpc_waitqueue
);
337 gss_put_auth(gss_msg
->auth
);
341 static struct gss_upcall_msg
*
342 __gss_find_upcall(struct rpc_pipe
*pipe
, kuid_t uid
)
344 struct gss_upcall_msg
*pos
;
345 list_for_each_entry(pos
, &pipe
->in_downcall
, list
) {
346 if (!uid_eq(pos
->uid
, uid
))
348 atomic_inc(&pos
->count
);
349 dprintk("RPC: %s found msg %p\n", __func__
, pos
);
352 dprintk("RPC: %s found nothing\n", __func__
);
356 /* Try to add an upcall to the pipefs queue.
357 * If an upcall owned by our uid already exists, then we return a reference
358 * to that upcall instead of adding the new upcall.
360 static inline struct gss_upcall_msg
*
361 gss_add_msg(struct gss_upcall_msg
*gss_msg
)
363 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
364 struct gss_upcall_msg
*old
;
366 spin_lock(&pipe
->lock
);
367 old
= __gss_find_upcall(pipe
, gss_msg
->uid
);
369 atomic_inc(&gss_msg
->count
);
370 list_add(&gss_msg
->list
, &pipe
->in_downcall
);
373 spin_unlock(&pipe
->lock
);
378 __gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
380 list_del_init(&gss_msg
->list
);
381 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
382 wake_up_all(&gss_msg
->waitqueue
);
383 atomic_dec(&gss_msg
->count
);
387 gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
389 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
391 if (list_empty(&gss_msg
->list
))
393 spin_lock(&pipe
->lock
);
394 if (!list_empty(&gss_msg
->list
))
395 __gss_unhash_msg(gss_msg
);
396 spin_unlock(&pipe
->lock
);
400 gss_handle_downcall_result(struct gss_cred
*gss_cred
, struct gss_upcall_msg
*gss_msg
)
402 switch (gss_msg
->msg
.errno
) {
404 if (gss_msg
->ctx
== NULL
)
406 clear_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
407 gss_cred_set_ctx(&gss_cred
->gc_base
, gss_msg
->ctx
);
410 set_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
412 gss_cred
->gc_upcall_timestamp
= jiffies
;
413 gss_cred
->gc_upcall
= NULL
;
414 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
418 gss_upcall_callback(struct rpc_task
*task
)
420 struct gss_cred
*gss_cred
= container_of(task
->tk_rqstp
->rq_cred
,
421 struct gss_cred
, gc_base
);
422 struct gss_upcall_msg
*gss_msg
= gss_cred
->gc_upcall
;
423 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
425 spin_lock(&pipe
->lock
);
426 gss_handle_downcall_result(gss_cred
, gss_msg
);
427 spin_unlock(&pipe
->lock
);
428 task
->tk_status
= gss_msg
->msg
.errno
;
429 gss_release_msg(gss_msg
);
432 static void gss_encode_v0_msg(struct gss_upcall_msg
*gss_msg
)
434 uid_t uid
= from_kuid(&init_user_ns
, gss_msg
->uid
);
435 memcpy(gss_msg
->databuf
, &uid
, sizeof(uid
));
436 gss_msg
->msg
.data
= gss_msg
->databuf
;
437 gss_msg
->msg
.len
= sizeof(uid
);
439 BUILD_BUG_ON(sizeof(uid
) > sizeof(gss_msg
->databuf
));
442 static int gss_encode_v1_msg(struct gss_upcall_msg
*gss_msg
,
443 const char *service_name
,
444 const char *target_name
)
446 struct gss_api_mech
*mech
= gss_msg
->auth
->mech
;
447 char *p
= gss_msg
->databuf
;
448 size_t buflen
= sizeof(gss_msg
->databuf
);
451 len
= scnprintf(p
, buflen
, "mech=%s uid=%d ", mech
->gm_name
,
452 from_kuid(&init_user_ns
, gss_msg
->uid
));
455 gss_msg
->msg
.len
= len
;
457 len
= scnprintf(p
, buflen
, "target=%s ", target_name
);
460 gss_msg
->msg
.len
+= len
;
462 if (service_name
!= NULL
) {
463 len
= scnprintf(p
, buflen
, "service=%s ", service_name
);
466 gss_msg
->msg
.len
+= len
;
468 if (mech
->gm_upcall_enctypes
) {
469 len
= scnprintf(p
, buflen
, "enctypes=%s ",
470 mech
->gm_upcall_enctypes
);
473 gss_msg
->msg
.len
+= len
;
475 len
= scnprintf(p
, buflen
, "\n");
478 gss_msg
->msg
.len
+= len
;
480 gss_msg
->msg
.data
= gss_msg
->databuf
;
487 static struct gss_upcall_msg
*
488 gss_alloc_msg(struct gss_auth
*gss_auth
,
489 kuid_t uid
, const char *service_name
)
491 struct gss_upcall_msg
*gss_msg
;
495 gss_msg
= kzalloc(sizeof(*gss_msg
), GFP_NOFS
);
498 vers
= get_pipe_version(gss_auth
->net
);
502 gss_msg
->pipe
= gss_auth
->gss_pipe
[vers
]->pipe
;
503 INIT_LIST_HEAD(&gss_msg
->list
);
504 rpc_init_wait_queue(&gss_msg
->rpc_waitqueue
, "RPCSEC_GSS upcall waitq");
505 init_waitqueue_head(&gss_msg
->waitqueue
);
506 atomic_set(&gss_msg
->count
, 1);
508 gss_msg
->auth
= gss_auth
;
511 gss_encode_v0_msg(gss_msg
);
514 err
= gss_encode_v1_msg(gss_msg
, service_name
, gss_auth
->target_name
);
516 goto err_put_pipe_version
;
518 kref_get(&gss_auth
->kref
);
520 err_put_pipe_version
:
521 put_pipe_version(gss_auth
->net
);
528 static struct gss_upcall_msg
*
529 gss_setup_upcall(struct gss_auth
*gss_auth
, struct rpc_cred
*cred
)
531 struct gss_cred
*gss_cred
= container_of(cred
,
532 struct gss_cred
, gc_base
);
533 struct gss_upcall_msg
*gss_new
, *gss_msg
;
534 kuid_t uid
= cred
->cr_uid
;
536 gss_new
= gss_alloc_msg(gss_auth
, uid
, gss_cred
->gc_principal
);
539 gss_msg
= gss_add_msg(gss_new
);
540 if (gss_msg
== gss_new
) {
541 int res
= rpc_queue_upcall(gss_new
->pipe
, &gss_new
->msg
);
543 gss_unhash_msg(gss_new
);
544 gss_msg
= ERR_PTR(res
);
547 gss_release_msg(gss_new
);
551 static void warn_gssd(void)
553 dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
557 gss_refresh_upcall(struct rpc_task
*task
)
559 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
560 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
,
561 struct gss_auth
, rpc_auth
);
562 struct gss_cred
*gss_cred
= container_of(cred
,
563 struct gss_cred
, gc_base
);
564 struct gss_upcall_msg
*gss_msg
;
565 struct rpc_pipe
*pipe
;
568 dprintk("RPC: %5u %s for uid %u\n",
569 task
->tk_pid
, __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
570 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
571 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
572 /* XXX: warning on the first, under the assumption we
573 * shouldn't normally hit this case on a refresh. */
575 task
->tk_timeout
= 15*HZ
;
576 rpc_sleep_on(&pipe_version_rpc_waitqueue
, task
, NULL
);
579 if (IS_ERR(gss_msg
)) {
580 err
= PTR_ERR(gss_msg
);
583 pipe
= gss_msg
->pipe
;
584 spin_lock(&pipe
->lock
);
585 if (gss_cred
->gc_upcall
!= NULL
)
586 rpc_sleep_on(&gss_cred
->gc_upcall
->rpc_waitqueue
, task
, NULL
);
587 else if (gss_msg
->ctx
== NULL
&& gss_msg
->msg
.errno
>= 0) {
588 task
->tk_timeout
= 0;
589 gss_cred
->gc_upcall
= gss_msg
;
590 /* gss_upcall_callback will release the reference to gss_upcall_msg */
591 atomic_inc(&gss_msg
->count
);
592 rpc_sleep_on(&gss_msg
->rpc_waitqueue
, task
, gss_upcall_callback
);
594 gss_handle_downcall_result(gss_cred
, gss_msg
);
595 err
= gss_msg
->msg
.errno
;
597 spin_unlock(&pipe
->lock
);
598 gss_release_msg(gss_msg
);
600 dprintk("RPC: %5u %s for uid %u result %d\n",
601 task
->tk_pid
, __func__
,
602 from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
607 gss_create_upcall(struct gss_auth
*gss_auth
, struct gss_cred
*gss_cred
)
609 struct net
*net
= gss_auth
->net
;
610 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
611 struct rpc_pipe
*pipe
;
612 struct rpc_cred
*cred
= &gss_cred
->gc_base
;
613 struct gss_upcall_msg
*gss_msg
;
617 dprintk("RPC: %s for uid %u\n",
618 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
621 /* if gssd is down, just skip upcalling altogether */
622 if (!gssd_running(net
)) {
626 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
627 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
628 err
= wait_event_interruptible_timeout(pipe_version_waitqueue
,
629 sn
->pipe_version
>= 0, 15 * HZ
);
630 if (sn
->pipe_version
< 0) {
638 if (IS_ERR(gss_msg
)) {
639 err
= PTR_ERR(gss_msg
);
642 pipe
= gss_msg
->pipe
;
644 prepare_to_wait(&gss_msg
->waitqueue
, &wait
, TASK_KILLABLE
);
645 spin_lock(&pipe
->lock
);
646 if (gss_msg
->ctx
!= NULL
|| gss_msg
->msg
.errno
< 0) {
649 spin_unlock(&pipe
->lock
);
650 if (fatal_signal_pending(current
)) {
657 gss_cred_set_ctx(cred
, gss_msg
->ctx
);
659 err
= gss_msg
->msg
.errno
;
660 spin_unlock(&pipe
->lock
);
662 finish_wait(&gss_msg
->waitqueue
, &wait
);
663 gss_release_msg(gss_msg
);
665 dprintk("RPC: %s for uid %u result %d\n",
666 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
670 #define MSG_BUF_MAXSIZE 1024
673 gss_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
677 struct gss_upcall_msg
*gss_msg
;
678 struct rpc_pipe
*pipe
= RPC_I(file_inode(filp
))->pipe
;
679 struct gss_cl_ctx
*ctx
;
682 ssize_t err
= -EFBIG
;
684 if (mlen
> MSG_BUF_MAXSIZE
)
687 buf
= kmalloc(mlen
, GFP_NOFS
);
692 if (copy_from_user(buf
, src
, mlen
))
695 end
= (const void *)((char *)buf
+ mlen
);
696 p
= simple_get_bytes(buf
, end
, &id
, sizeof(id
));
702 uid
= make_kuid(&init_user_ns
, id
);
703 if (!uid_valid(uid
)) {
709 ctx
= gss_alloc_context();
714 /* Find a matching upcall */
715 spin_lock(&pipe
->lock
);
716 gss_msg
= __gss_find_upcall(pipe
, uid
);
717 if (gss_msg
== NULL
) {
718 spin_unlock(&pipe
->lock
);
721 list_del_init(&gss_msg
->list
);
722 spin_unlock(&pipe
->lock
);
724 p
= gss_fill_context(p
, end
, ctx
, gss_msg
->auth
->mech
);
730 gss_msg
->msg
.errno
= err
;
737 gss_msg
->msg
.errno
= -EAGAIN
;
740 printk(KERN_CRIT
"%s: bad return from "
741 "gss_fill_context: %zd\n", __func__
, err
);
744 goto err_release_msg
;
746 gss_msg
->ctx
= gss_get_ctx(ctx
);
750 spin_lock(&pipe
->lock
);
751 __gss_unhash_msg(gss_msg
);
752 spin_unlock(&pipe
->lock
);
753 gss_release_msg(gss_msg
);
759 dprintk("RPC: %s returning %Zd\n", __func__
, err
);
763 static int gss_pipe_open(struct inode
*inode
, int new_version
)
765 struct net
*net
= inode
->i_sb
->s_fs_info
;
766 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
769 spin_lock(&pipe_version_lock
);
770 if (sn
->pipe_version
< 0) {
771 /* First open of any gss pipe determines the version: */
772 sn
->pipe_version
= new_version
;
773 rpc_wake_up(&pipe_version_rpc_waitqueue
);
774 wake_up(&pipe_version_waitqueue
);
775 } else if (sn
->pipe_version
!= new_version
) {
776 /* Trying to open a pipe of a different version */
780 atomic_inc(&sn
->pipe_users
);
782 spin_unlock(&pipe_version_lock
);
787 static int gss_pipe_open_v0(struct inode
*inode
)
789 return gss_pipe_open(inode
, 0);
792 static int gss_pipe_open_v1(struct inode
*inode
)
794 return gss_pipe_open(inode
, 1);
798 gss_pipe_release(struct inode
*inode
)
800 struct net
*net
= inode
->i_sb
->s_fs_info
;
801 struct rpc_pipe
*pipe
= RPC_I(inode
)->pipe
;
802 struct gss_upcall_msg
*gss_msg
;
805 spin_lock(&pipe
->lock
);
806 list_for_each_entry(gss_msg
, &pipe
->in_downcall
, list
) {
808 if (!list_empty(&gss_msg
->msg
.list
))
810 gss_msg
->msg
.errno
= -EPIPE
;
811 atomic_inc(&gss_msg
->count
);
812 __gss_unhash_msg(gss_msg
);
813 spin_unlock(&pipe
->lock
);
814 gss_release_msg(gss_msg
);
817 spin_unlock(&pipe
->lock
);
819 put_pipe_version(net
);
823 gss_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
825 struct gss_upcall_msg
*gss_msg
= container_of(msg
, struct gss_upcall_msg
, msg
);
827 if (msg
->errno
< 0) {
828 dprintk("RPC: %s releasing msg %p\n",
830 atomic_inc(&gss_msg
->count
);
831 gss_unhash_msg(gss_msg
);
832 if (msg
->errno
== -ETIMEDOUT
)
834 gss_release_msg(gss_msg
);
838 static void gss_pipe_dentry_destroy(struct dentry
*dir
,
839 struct rpc_pipe_dir_object
*pdo
)
841 struct gss_pipe
*gss_pipe
= pdo
->pdo_data
;
842 struct rpc_pipe
*pipe
= gss_pipe
->pipe
;
844 if (pipe
->dentry
!= NULL
) {
845 rpc_unlink(pipe
->dentry
);
850 static int gss_pipe_dentry_create(struct dentry
*dir
,
851 struct rpc_pipe_dir_object
*pdo
)
853 struct gss_pipe
*p
= pdo
->pdo_data
;
854 struct dentry
*dentry
;
856 dentry
= rpc_mkpipe_dentry(dir
, p
->name
, p
->clnt
, p
->pipe
);
858 return PTR_ERR(dentry
);
859 p
->pipe
->dentry
= dentry
;
863 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops
= {
864 .create
= gss_pipe_dentry_create
,
865 .destroy
= gss_pipe_dentry_destroy
,
868 static struct gss_pipe
*gss_pipe_alloc(struct rpc_clnt
*clnt
,
870 const struct rpc_pipe_ops
*upcall_ops
)
875 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
878 p
->pipe
= rpc_mkpipe_data(upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
879 if (IS_ERR(p
->pipe
)) {
880 err
= PTR_ERR(p
->pipe
);
881 goto err_free_gss_pipe
;
886 rpc_init_pipe_dir_object(&p
->pdo
,
887 &gss_pipe_dir_object_ops
,
896 struct gss_alloc_pdo
{
897 struct rpc_clnt
*clnt
;
899 const struct rpc_pipe_ops
*upcall_ops
;
902 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object
*pdo
, void *data
)
904 struct gss_pipe
*gss_pipe
;
905 struct gss_alloc_pdo
*args
= data
;
907 if (pdo
->pdo_ops
!= &gss_pipe_dir_object_ops
)
909 gss_pipe
= container_of(pdo
, struct gss_pipe
, pdo
);
910 if (strcmp(gss_pipe
->name
, args
->name
) != 0)
912 if (!kref_get_unless_zero(&gss_pipe
->kref
))
917 static struct rpc_pipe_dir_object
*gss_pipe_alloc_pdo(void *data
)
919 struct gss_pipe
*gss_pipe
;
920 struct gss_alloc_pdo
*args
= data
;
922 gss_pipe
= gss_pipe_alloc(args
->clnt
, args
->name
, args
->upcall_ops
);
923 if (!IS_ERR(gss_pipe
))
924 return &gss_pipe
->pdo
;
928 static struct gss_pipe
*gss_pipe_get(struct rpc_clnt
*clnt
,
930 const struct rpc_pipe_ops
*upcall_ops
)
932 struct net
*net
= rpc_net_ns(clnt
);
933 struct rpc_pipe_dir_object
*pdo
;
934 struct gss_alloc_pdo args
= {
937 .upcall_ops
= upcall_ops
,
940 pdo
= rpc_find_or_alloc_pipe_dir_object(net
,
941 &clnt
->cl_pipedir_objects
,
946 return container_of(pdo
, struct gss_pipe
, pdo
);
947 return ERR_PTR(-ENOMEM
);
950 static void __gss_pipe_free(struct gss_pipe
*p
)
952 struct rpc_clnt
*clnt
= p
->clnt
;
953 struct net
*net
= rpc_net_ns(clnt
);
955 rpc_remove_pipe_dir_object(net
,
956 &clnt
->cl_pipedir_objects
,
958 rpc_destroy_pipe_data(p
->pipe
);
962 static void __gss_pipe_release(struct kref
*kref
)
964 struct gss_pipe
*p
= container_of(kref
, struct gss_pipe
, kref
);
969 static void gss_pipe_free(struct gss_pipe
*p
)
972 kref_put(&p
->kref
, __gss_pipe_release
);
976 * NOTE: we have the opportunity to use different
977 * parameters based on the input flavor (which must be a pseudoflavor)
979 static struct gss_auth
*
980 gss_create_new(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
982 rpc_authflavor_t flavor
= args
->pseudoflavor
;
983 struct gss_auth
*gss_auth
;
984 struct gss_pipe
*gss_pipe
;
985 struct rpc_auth
* auth
;
986 int err
= -ENOMEM
; /* XXX? */
988 dprintk("RPC: creating GSS authenticator for client %p\n", clnt
);
990 if (!try_module_get(THIS_MODULE
))
992 if (!(gss_auth
= kmalloc(sizeof(*gss_auth
), GFP_KERNEL
)))
994 INIT_HLIST_NODE(&gss_auth
->hash
);
995 gss_auth
->target_name
= NULL
;
996 if (args
->target_name
) {
997 gss_auth
->target_name
= kstrdup(args
->target_name
, GFP_KERNEL
);
998 if (gss_auth
->target_name
== NULL
)
1001 gss_auth
->client
= clnt
;
1002 gss_auth
->net
= get_net(rpc_net_ns(clnt
));
1004 gss_auth
->mech
= gss_mech_get_by_pseudoflavor(flavor
);
1005 if (!gss_auth
->mech
) {
1006 dprintk("RPC: Pseudoflavor %d not found!\n", flavor
);
1009 gss_auth
->service
= gss_pseudoflavor_to_service(gss_auth
->mech
, flavor
);
1010 if (gss_auth
->service
== 0)
1012 if (!gssd_running(gss_auth
->net
))
1014 auth
= &gss_auth
->rpc_auth
;
1015 auth
->au_cslack
= GSS_CRED_SLACK
>> 2;
1016 auth
->au_rslack
= GSS_VERF_SLACK
>> 2;
1017 auth
->au_ops
= &authgss_ops
;
1018 auth
->au_flavor
= flavor
;
1019 atomic_set(&auth
->au_count
, 1);
1020 kref_init(&gss_auth
->kref
);
1022 err
= rpcauth_init_credcache(auth
);
1026 * Note: if we created the old pipe first, then someone who
1027 * examined the directory at the right moment might conclude
1028 * that we supported only the old pipe. So we instead create
1029 * the new pipe first.
1031 gss_pipe
= gss_pipe_get(clnt
, "gssd", &gss_upcall_ops_v1
);
1032 if (IS_ERR(gss_pipe
)) {
1033 err
= PTR_ERR(gss_pipe
);
1034 goto err_destroy_credcache
;
1036 gss_auth
->gss_pipe
[1] = gss_pipe
;
1038 gss_pipe
= gss_pipe_get(clnt
, gss_auth
->mech
->gm_name
,
1039 &gss_upcall_ops_v0
);
1040 if (IS_ERR(gss_pipe
)) {
1041 err
= PTR_ERR(gss_pipe
);
1042 goto err_destroy_pipe_1
;
1044 gss_auth
->gss_pipe
[0] = gss_pipe
;
1048 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1049 err_destroy_credcache
:
1050 rpcauth_destroy_credcache(auth
);
1052 gss_mech_put(gss_auth
->mech
);
1054 put_net(gss_auth
->net
);
1056 kfree(gss_auth
->target_name
);
1059 module_put(THIS_MODULE
);
1060 return ERR_PTR(err
);
1064 gss_free(struct gss_auth
*gss_auth
)
1066 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1067 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1068 gss_mech_put(gss_auth
->mech
);
1069 put_net(gss_auth
->net
);
1070 kfree(gss_auth
->target_name
);
1073 module_put(THIS_MODULE
);
1077 gss_free_callback(struct kref
*kref
)
1079 struct gss_auth
*gss_auth
= container_of(kref
, struct gss_auth
, kref
);
1085 gss_put_auth(struct gss_auth
*gss_auth
)
1087 kref_put(&gss_auth
->kref
, gss_free_callback
);
1091 gss_destroy(struct rpc_auth
*auth
)
1093 struct gss_auth
*gss_auth
= container_of(auth
,
1094 struct gss_auth
, rpc_auth
);
1096 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1097 auth
, auth
->au_flavor
);
1099 if (hash_hashed(&gss_auth
->hash
)) {
1100 spin_lock(&gss_auth_hash_lock
);
1101 hash_del(&gss_auth
->hash
);
1102 spin_unlock(&gss_auth_hash_lock
);
1105 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1106 gss_auth
->gss_pipe
[0] = NULL
;
1107 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1108 gss_auth
->gss_pipe
[1] = NULL
;
1109 rpcauth_destroy_credcache(auth
);
1111 gss_put_auth(gss_auth
);
1115 * Auths may be shared between rpc clients that were cloned from a
1116 * common client with the same xprt, if they also share the flavor and
1119 * The auth is looked up from the oldest parent sharing the same
1120 * cl_xprt, and the auth itself references only that common parent
1121 * (which is guaranteed to last as long as any of its descendants).
1123 static struct gss_auth
*
1124 gss_auth_find_or_add_hashed(struct rpc_auth_create_args
*args
,
1125 struct rpc_clnt
*clnt
,
1126 struct gss_auth
*new)
1128 struct gss_auth
*gss_auth
;
1129 unsigned long hashval
= (unsigned long)clnt
;
1131 spin_lock(&gss_auth_hash_lock
);
1132 hash_for_each_possible(gss_auth_hash_table
,
1136 if (gss_auth
->client
!= clnt
)
1138 if (gss_auth
->rpc_auth
.au_flavor
!= args
->pseudoflavor
)
1140 if (gss_auth
->target_name
!= args
->target_name
) {
1141 if (gss_auth
->target_name
== NULL
)
1143 if (args
->target_name
== NULL
)
1145 if (strcmp(gss_auth
->target_name
, args
->target_name
))
1148 if (!atomic_inc_not_zero(&gss_auth
->rpc_auth
.au_count
))
1153 hash_add(gss_auth_hash_table
, &new->hash
, hashval
);
1156 spin_unlock(&gss_auth_hash_lock
);
1160 static struct gss_auth
*
1161 gss_create_hashed(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1163 struct gss_auth
*gss_auth
;
1164 struct gss_auth
*new;
1166 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, NULL
);
1167 if (gss_auth
!= NULL
)
1169 new = gss_create_new(args
, clnt
);
1172 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, new);
1173 if (gss_auth
!= new)
1174 gss_destroy(&new->rpc_auth
);
1179 static struct rpc_auth
*
1180 gss_create(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1182 struct gss_auth
*gss_auth
;
1183 struct rpc_xprt
*xprt
= rcu_access_pointer(clnt
->cl_xprt
);
1185 while (clnt
!= clnt
->cl_parent
) {
1186 struct rpc_clnt
*parent
= clnt
->cl_parent
;
1187 /* Find the original parent for this transport */
1188 if (rcu_access_pointer(parent
->cl_xprt
) != xprt
)
1193 gss_auth
= gss_create_hashed(args
, clnt
);
1194 if (IS_ERR(gss_auth
))
1195 return ERR_CAST(gss_auth
);
1196 return &gss_auth
->rpc_auth
;
1200 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1201 * to the server with the GSS control procedure field set to
1202 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1203 * all RPCSEC_GSS state associated with that context.
1206 gss_destroying_context(struct rpc_cred
*cred
)
1208 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1209 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1210 struct rpc_task
*task
;
1212 if (gss_cred
->gc_ctx
== NULL
||
1213 test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
) == 0)
1216 gss_cred
->gc_ctx
->gc_proc
= RPC_GSS_PROC_DESTROY
;
1217 cred
->cr_ops
= &gss_nullops
;
1219 /* Take a reference to ensure the cred will be destroyed either
1220 * by the RPC call or by the put_rpccred() below */
1223 task
= rpc_call_null(gss_auth
->client
, cred
, RPC_TASK_ASYNC
|RPC_TASK_SOFT
);
1231 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1232 * to create a new cred or context, so they check that things have been
1233 * allocated before freeing them. */
1235 gss_do_free_ctx(struct gss_cl_ctx
*ctx
)
1237 dprintk("RPC: %s\n", __func__
);
1239 gss_delete_sec_context(&ctx
->gc_gss_ctx
);
1240 kfree(ctx
->gc_wire_ctx
.data
);
1241 kfree(ctx
->gc_acceptor
.data
);
1246 gss_free_ctx_callback(struct rcu_head
*head
)
1248 struct gss_cl_ctx
*ctx
= container_of(head
, struct gss_cl_ctx
, gc_rcu
);
1249 gss_do_free_ctx(ctx
);
1253 gss_free_ctx(struct gss_cl_ctx
*ctx
)
1255 call_rcu(&ctx
->gc_rcu
, gss_free_ctx_callback
);
1259 gss_free_cred(struct gss_cred
*gss_cred
)
1261 dprintk("RPC: %s cred=%p\n", __func__
, gss_cred
);
1266 gss_free_cred_callback(struct rcu_head
*head
)
1268 struct gss_cred
*gss_cred
= container_of(head
, struct gss_cred
, gc_base
.cr_rcu
);
1269 gss_free_cred(gss_cred
);
1273 gss_destroy_nullcred(struct rpc_cred
*cred
)
1275 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1276 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1277 struct gss_cl_ctx
*ctx
= gss_cred
->gc_ctx
;
1279 RCU_INIT_POINTER(gss_cred
->gc_ctx
, NULL
);
1280 call_rcu(&cred
->cr_rcu
, gss_free_cred_callback
);
1283 gss_put_auth(gss_auth
);
1287 gss_destroy_cred(struct rpc_cred
*cred
)
1290 if (gss_destroying_context(cred
))
1292 gss_destroy_nullcred(cred
);
1296 * Lookup RPCSEC_GSS cred for the current process
1298 static struct rpc_cred
*
1299 gss_lookup_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1301 return rpcauth_lookup_credcache(auth
, acred
, flags
);
1304 static struct rpc_cred
*
1305 gss_create_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1307 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1308 struct gss_cred
*cred
= NULL
;
1311 dprintk("RPC: %s for uid %d, flavor %d\n",
1312 __func__
, from_kuid(&init_user_ns
, acred
->uid
),
1315 if (!(cred
= kzalloc(sizeof(*cred
), GFP_NOFS
)))
1318 rpcauth_init_cred(&cred
->gc_base
, acred
, auth
, &gss_credops
);
1320 * Note: in order to force a call to call_refresh(), we deliberately
1321 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1323 cred
->gc_base
.cr_flags
= 1UL << RPCAUTH_CRED_NEW
;
1324 cred
->gc_service
= gss_auth
->service
;
1325 cred
->gc_principal
= NULL
;
1326 if (acred
->machine_cred
)
1327 cred
->gc_principal
= acred
->principal
;
1328 kref_get(&gss_auth
->kref
);
1329 return &cred
->gc_base
;
1332 dprintk("RPC: %s failed with error %d\n", __func__
, err
);
1333 return ERR_PTR(err
);
1337 gss_cred_init(struct rpc_auth
*auth
, struct rpc_cred
*cred
)
1339 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1340 struct gss_cred
*gss_cred
= container_of(cred
,struct gss_cred
, gc_base
);
1344 err
= gss_create_upcall(gss_auth
, gss_cred
);
1345 } while (err
== -EAGAIN
);
1350 * Returns -EACCES if GSS context is NULL or will expire within the
1351 * timeout (miliseconds)
1354 gss_key_timeout(struct rpc_cred
*rc
)
1356 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1357 unsigned long now
= jiffies
;
1358 unsigned long expire
;
1360 if (gss_cred
->gc_ctx
== NULL
)
1363 expire
= gss_cred
->gc_ctx
->gc_expiry
- (gss_key_expire_timeo
* HZ
);
1365 if (time_after(now
, expire
))
1371 gss_match(struct auth_cred
*acred
, struct rpc_cred
*rc
, int flags
)
1373 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1376 if (test_bit(RPCAUTH_CRED_NEW
, &rc
->cr_flags
))
1378 /* Don't match with creds that have expired. */
1379 if (time_after(jiffies
, gss_cred
->gc_ctx
->gc_expiry
))
1381 if (!test_bit(RPCAUTH_CRED_UPTODATE
, &rc
->cr_flags
))
1384 if (acred
->principal
!= NULL
) {
1385 if (gss_cred
->gc_principal
== NULL
)
1387 ret
= strcmp(acred
->principal
, gss_cred
->gc_principal
) == 0;
1390 if (gss_cred
->gc_principal
!= NULL
)
1392 ret
= uid_eq(rc
->cr_uid
, acred
->uid
);
1398 /* Notify acred users of GSS context expiration timeout */
1399 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
) &&
1400 (gss_key_timeout(rc
) != 0)) {
1401 /* test will now be done from generic cred */
1402 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
);
1403 /* tell NFS layer that key will expire soon */
1404 set_bit(RPC_CRED_KEY_EXPIRE_SOON
, &acred
->ac_flags
);
1410 * Marshal credentials.
1411 * Maybe we should keep a cached credential for performance reasons.
1414 gss_marshal(struct rpc_task
*task
, __be32
*p
)
1416 struct rpc_rqst
*req
= task
->tk_rqstp
;
1417 struct rpc_cred
*cred
= req
->rq_cred
;
1418 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1420 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1423 struct xdr_netobj mic
;
1425 struct xdr_buf verf_buf
;
1427 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1429 *p
++ = htonl(RPC_AUTH_GSS
);
1432 spin_lock(&ctx
->gc_seq_lock
);
1433 req
->rq_seqno
= ctx
->gc_seq
++;
1434 spin_unlock(&ctx
->gc_seq_lock
);
1436 *p
++ = htonl((u32
) RPC_GSS_VERSION
);
1437 *p
++ = htonl((u32
) ctx
->gc_proc
);
1438 *p
++ = htonl((u32
) req
->rq_seqno
);
1439 *p
++ = htonl((u32
) gss_cred
->gc_service
);
1440 p
= xdr_encode_netobj(p
, &ctx
->gc_wire_ctx
);
1441 *cred_len
= htonl((p
- (cred_len
+ 1)) << 2);
1443 /* We compute the checksum for the verifier over the xdr-encoded bytes
1444 * starting with the xid and ending at the end of the credential: */
1445 iov
.iov_base
= xprt_skip_transport_header(req
->rq_xprt
,
1446 req
->rq_snd_buf
.head
[0].iov_base
);
1447 iov
.iov_len
= (u8
*)p
- (u8
*)iov
.iov_base
;
1448 xdr_buf_from_iov(&iov
, &verf_buf
);
1450 /* set verifier flavor*/
1451 *p
++ = htonl(RPC_AUTH_GSS
);
1453 mic
.data
= (u8
*)(p
+ 1);
1454 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1455 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
) {
1456 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1457 } else if (maj_stat
!= 0) {
1458 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat
);
1461 p
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1469 static int gss_renew_cred(struct rpc_task
*task
)
1471 struct rpc_cred
*oldcred
= task
->tk_rqstp
->rq_cred
;
1472 struct gss_cred
*gss_cred
= container_of(oldcred
,
1475 struct rpc_auth
*auth
= oldcred
->cr_auth
;
1476 struct auth_cred acred
= {
1477 .uid
= oldcred
->cr_uid
,
1478 .principal
= gss_cred
->gc_principal
,
1479 .machine_cred
= (gss_cred
->gc_principal
!= NULL
? 1 : 0),
1481 struct rpc_cred
*new;
1483 new = gss_lookup_cred(auth
, &acred
, RPCAUTH_LOOKUP_NEW
);
1485 return PTR_ERR(new);
1486 task
->tk_rqstp
->rq_cred
= new;
1487 put_rpccred(oldcred
);
1491 static int gss_cred_is_negative_entry(struct rpc_cred
*cred
)
1493 if (test_bit(RPCAUTH_CRED_NEGATIVE
, &cred
->cr_flags
)) {
1494 unsigned long now
= jiffies
;
1495 unsigned long begin
, expire
;
1496 struct gss_cred
*gss_cred
;
1498 gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1499 begin
= gss_cred
->gc_upcall_timestamp
;
1500 expire
= begin
+ gss_expired_cred_retry_delay
* HZ
;
1502 if (time_in_range_open(now
, begin
, expire
))
1509 * Refresh credentials. XXX - finish
1512 gss_refresh(struct rpc_task
*task
)
1514 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1517 if (gss_cred_is_negative_entry(cred
))
1518 return -EKEYEXPIRED
;
1520 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
) &&
1521 !test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
)) {
1522 ret
= gss_renew_cred(task
);
1525 cred
= task
->tk_rqstp
->rq_cred
;
1528 if (test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
1529 ret
= gss_refresh_upcall(task
);
1534 /* Dummy refresh routine: used only when destroying the context */
1536 gss_refresh_null(struct rpc_task
*task
)
1542 gss_validate(struct rpc_task
*task
, __be32
*p
)
1544 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1545 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1548 struct xdr_buf verf_buf
;
1549 struct xdr_netobj mic
;
1552 __be32
*ret
= ERR_PTR(-EIO
);
1554 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1557 if ((len
= ntohl(*p
++)) > RPC_MAX_AUTH_SIZE
)
1559 if (flav
!= RPC_AUTH_GSS
)
1561 seq
= htonl(task
->tk_rqstp
->rq_seqno
);
1562 iov
.iov_base
= &seq
;
1563 iov
.iov_len
= sizeof(seq
);
1564 xdr_buf_from_iov(&iov
, &verf_buf
);
1568 ret
= ERR_PTR(-EACCES
);
1569 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1570 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1571 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1573 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1574 task
->tk_pid
, __func__
, maj_stat
);
1577 /* We leave it to unwrap to calculate au_rslack. For now we just
1578 * calculate the length of the verifier: */
1579 cred
->cr_auth
->au_verfsize
= XDR_QUADLEN(len
) + 2;
1581 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1582 task
->tk_pid
, __func__
);
1583 return p
+ XDR_QUADLEN(len
);
1586 dprintk("RPC: %5u %s failed ret %ld.\n", task
->tk_pid
, __func__
,
1591 static void gss_wrap_req_encode(kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1592 __be32
*p
, void *obj
)
1594 struct xdr_stream xdr
;
1596 xdr_init_encode(&xdr
, &rqstp
->rq_snd_buf
, p
);
1597 encode(rqstp
, &xdr
, obj
);
1601 gss_wrap_req_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1602 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1603 __be32
*p
, void *obj
)
1605 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1606 struct xdr_buf integ_buf
;
1607 __be32
*integ_len
= NULL
;
1608 struct xdr_netobj mic
;
1616 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1617 *p
++ = htonl(rqstp
->rq_seqno
);
1619 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1621 if (xdr_buf_subsegment(snd_buf
, &integ_buf
,
1622 offset
, snd_buf
->len
- offset
))
1624 *integ_len
= htonl(integ_buf
.len
);
1626 /* guess whether we're in the head or the tail: */
1627 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1628 iov
= snd_buf
->tail
;
1630 iov
= snd_buf
->head
;
1631 p
= iov
->iov_base
+ iov
->iov_len
;
1632 mic
.data
= (u8
*)(p
+ 1);
1634 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1635 status
= -EIO
; /* XXX? */
1636 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1637 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1640 q
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1642 offset
= (u8
*)q
- (u8
*)p
;
1643 iov
->iov_len
+= offset
;
1644 snd_buf
->len
+= offset
;
1649 priv_release_snd_buf(struct rpc_rqst
*rqstp
)
1653 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++)
1654 __free_page(rqstp
->rq_enc_pages
[i
]);
1655 kfree(rqstp
->rq_enc_pages
);
1659 alloc_enc_pages(struct rpc_rqst
*rqstp
)
1661 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1664 if (snd_buf
->page_len
== 0) {
1665 rqstp
->rq_enc_pages_num
= 0;
1669 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1670 last
= (snd_buf
->page_base
+ snd_buf
->page_len
- 1) >> PAGE_CACHE_SHIFT
;
1671 rqstp
->rq_enc_pages_num
= last
- first
+ 1 + 1;
1673 = kmalloc(rqstp
->rq_enc_pages_num
* sizeof(struct page
*),
1675 if (!rqstp
->rq_enc_pages
)
1677 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++) {
1678 rqstp
->rq_enc_pages
[i
] = alloc_page(GFP_NOFS
);
1679 if (rqstp
->rq_enc_pages
[i
] == NULL
)
1682 rqstp
->rq_release_snd_buf
= priv_release_snd_buf
;
1685 rqstp
->rq_enc_pages_num
= i
;
1686 priv_release_snd_buf(rqstp
);
1692 gss_wrap_req_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1693 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1694 __be32
*p
, void *obj
)
1696 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1701 struct page
**inpages
;
1708 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1709 *p
++ = htonl(rqstp
->rq_seqno
);
1711 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1713 status
= alloc_enc_pages(rqstp
);
1716 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1717 inpages
= snd_buf
->pages
+ first
;
1718 snd_buf
->pages
= rqstp
->rq_enc_pages
;
1719 snd_buf
->page_base
-= first
<< PAGE_CACHE_SHIFT
;
1721 * Give the tail its own page, in case we need extra space in the
1722 * head when wrapping:
1724 * call_allocate() allocates twice the slack space required
1725 * by the authentication flavor to rq_callsize.
1726 * For GSS, slack is GSS_CRED_SLACK.
1728 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
) {
1729 tmp
= page_address(rqstp
->rq_enc_pages
[rqstp
->rq_enc_pages_num
- 1]);
1730 memcpy(tmp
, snd_buf
->tail
[0].iov_base
, snd_buf
->tail
[0].iov_len
);
1731 snd_buf
->tail
[0].iov_base
= tmp
;
1733 maj_stat
= gss_wrap(ctx
->gc_gss_ctx
, offset
, snd_buf
, inpages
);
1734 /* slack space should prevent this ever happening: */
1735 BUG_ON(snd_buf
->len
> snd_buf
->buflen
);
1737 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1738 * done anyway, so it's safe to put the request on the wire: */
1739 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1740 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1744 *opaque_len
= htonl(snd_buf
->len
- offset
);
1745 /* guess whether we're in the head or the tail: */
1746 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1747 iov
= snd_buf
->tail
;
1749 iov
= snd_buf
->head
;
1750 p
= iov
->iov_base
+ iov
->iov_len
;
1751 pad
= 3 - ((snd_buf
->len
- offset
- 1) & 3);
1753 iov
->iov_len
+= pad
;
1754 snd_buf
->len
+= pad
;
1760 gss_wrap_req(struct rpc_task
*task
,
1761 kxdreproc_t encode
, void *rqstp
, __be32
*p
, void *obj
)
1763 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1764 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1766 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1769 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1770 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
) {
1771 /* The spec seems a little ambiguous here, but I think that not
1772 * wrapping context destruction requests makes the most sense.
1774 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1778 switch (gss_cred
->gc_service
) {
1779 case RPC_GSS_SVC_NONE
:
1780 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1783 case RPC_GSS_SVC_INTEGRITY
:
1784 status
= gss_wrap_req_integ(cred
, ctx
, encode
, rqstp
, p
, obj
);
1786 case RPC_GSS_SVC_PRIVACY
:
1787 status
= gss_wrap_req_priv(cred
, ctx
, encode
, rqstp
, p
, obj
);
1792 dprintk("RPC: %5u %s returning %d\n", task
->tk_pid
, __func__
, status
);
1797 gss_unwrap_resp_integ(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
;
1801 struct xdr_buf integ_buf
;
1802 struct xdr_netobj mic
;
1803 u32 data_offset
, mic_offset
;
1808 integ_len
= ntohl(*(*p
)++);
1811 data_offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1812 mic_offset
= integ_len
+ data_offset
;
1813 if (mic_offset
> rcv_buf
->len
)
1815 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1818 if (xdr_buf_subsegment(rcv_buf
, &integ_buf
, data_offset
,
1819 mic_offset
- data_offset
))
1822 if (xdr_buf_read_netobj(rcv_buf
, &mic
, mic_offset
))
1825 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1826 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1827 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1828 if (maj_stat
!= GSS_S_COMPLETE
)
1834 gss_unwrap_resp_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1835 struct rpc_rqst
*rqstp
, __be32
**p
)
1837 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1843 opaque_len
= ntohl(*(*p
)++);
1844 offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1845 if (offset
+ opaque_len
> rcv_buf
->len
)
1847 /* remove padding: */
1848 rcv_buf
->len
= offset
+ opaque_len
;
1850 maj_stat
= gss_unwrap(ctx
->gc_gss_ctx
, offset
, rcv_buf
);
1851 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1852 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1853 if (maj_stat
!= GSS_S_COMPLETE
)
1855 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1862 gss_unwrap_req_decode(kxdrdproc_t decode
, struct rpc_rqst
*rqstp
,
1863 __be32
*p
, void *obj
)
1865 struct xdr_stream xdr
;
1867 xdr_init_decode(&xdr
, &rqstp
->rq_rcv_buf
, p
);
1868 return decode(rqstp
, &xdr
, obj
);
1872 gss_unwrap_resp(struct rpc_task
*task
,
1873 kxdrdproc_t decode
, void *rqstp
, __be32
*p
, void *obj
)
1875 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1876 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1878 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1880 struct kvec
*head
= ((struct rpc_rqst
*)rqstp
)->rq_rcv_buf
.head
;
1881 int savedlen
= head
->iov_len
;
1884 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
)
1886 switch (gss_cred
->gc_service
) {
1887 case RPC_GSS_SVC_NONE
:
1889 case RPC_GSS_SVC_INTEGRITY
:
1890 status
= gss_unwrap_resp_integ(cred
, ctx
, rqstp
, &p
);
1894 case RPC_GSS_SVC_PRIVACY
:
1895 status
= gss_unwrap_resp_priv(cred
, ctx
, rqstp
, &p
);
1900 /* take into account extra slack for integrity and privacy cases: */
1901 cred
->cr_auth
->au_rslack
= cred
->cr_auth
->au_verfsize
+ (p
- savedp
)
1902 + (savedlen
- head
->iov_len
);
1904 status
= gss_unwrap_req_decode(decode
, rqstp
, p
, obj
);
1907 dprintk("RPC: %5u %s returning %d\n",
1908 task
->tk_pid
, __func__
, status
);
1912 static const struct rpc_authops authgss_ops
= {
1913 .owner
= THIS_MODULE
,
1914 .au_flavor
= RPC_AUTH_GSS
,
1915 .au_name
= "RPCSEC_GSS",
1916 .create
= gss_create
,
1917 .destroy
= gss_destroy
,
1918 .lookup_cred
= gss_lookup_cred
,
1919 .crcreate
= gss_create_cred
,
1920 .list_pseudoflavors
= gss_mech_list_pseudoflavors
,
1921 .info2flavor
= gss_mech_info2flavor
,
1922 .flavor2info
= gss_mech_flavor2info
,
1925 static const struct rpc_credops gss_credops
= {
1926 .cr_name
= "AUTH_GSS",
1927 .crdestroy
= gss_destroy_cred
,
1928 .cr_init
= gss_cred_init
,
1929 .crbind
= rpcauth_generic_bind_cred
,
1930 .crmatch
= gss_match
,
1931 .crmarshal
= gss_marshal
,
1932 .crrefresh
= gss_refresh
,
1933 .crvalidate
= gss_validate
,
1934 .crwrap_req
= gss_wrap_req
,
1935 .crunwrap_resp
= gss_unwrap_resp
,
1936 .crkey_timeout
= gss_key_timeout
,
1939 static const struct rpc_credops gss_nullops
= {
1940 .cr_name
= "AUTH_GSS",
1941 .crdestroy
= gss_destroy_nullcred
,
1942 .crbind
= rpcauth_generic_bind_cred
,
1943 .crmatch
= gss_match
,
1944 .crmarshal
= gss_marshal
,
1945 .crrefresh
= gss_refresh_null
,
1946 .crvalidate
= gss_validate
,
1947 .crwrap_req
= gss_wrap_req
,
1948 .crunwrap_resp
= gss_unwrap_resp
,
1951 static const struct rpc_pipe_ops gss_upcall_ops_v0
= {
1952 .upcall
= rpc_pipe_generic_upcall
,
1953 .downcall
= gss_pipe_downcall
,
1954 .destroy_msg
= gss_pipe_destroy_msg
,
1955 .open_pipe
= gss_pipe_open_v0
,
1956 .release_pipe
= gss_pipe_release
,
1959 static const struct rpc_pipe_ops gss_upcall_ops_v1
= {
1960 .upcall
= rpc_pipe_generic_upcall
,
1961 .downcall
= gss_pipe_downcall
,
1962 .destroy_msg
= gss_pipe_destroy_msg
,
1963 .open_pipe
= gss_pipe_open_v1
,
1964 .release_pipe
= gss_pipe_release
,
1967 static __net_init
int rpcsec_gss_init_net(struct net
*net
)
1969 return gss_svc_init_net(net
);
1972 static __net_exit
void rpcsec_gss_exit_net(struct net
*net
)
1974 gss_svc_shutdown_net(net
);
1977 static struct pernet_operations rpcsec_gss_net_ops
= {
1978 .init
= rpcsec_gss_init_net
,
1979 .exit
= rpcsec_gss_exit_net
,
1983 * Initialize RPCSEC_GSS module
1985 static int __init
init_rpcsec_gss(void)
1989 err
= rpcauth_register(&authgss_ops
);
1992 err
= gss_svc_init();
1994 goto out_unregister
;
1995 err
= register_pernet_subsys(&rpcsec_gss_net_ops
);
1998 rpc_init_wait_queue(&pipe_version_rpc_waitqueue
, "gss pipe version");
2003 rpcauth_unregister(&authgss_ops
);
2008 static void __exit
exit_rpcsec_gss(void)
2010 unregister_pernet_subsys(&rpcsec_gss_net_ops
);
2012 rpcauth_unregister(&authgss_ops
);
2013 rcu_barrier(); /* Wait for completion of call_rcu()'s */
2016 MODULE_ALIAS("rpc-auth-6");
2017 MODULE_LICENSE("GPL");
2018 module_param_named(expired_cred_retry_delay
,
2019 gss_expired_cred_retry_delay
,
2021 MODULE_PARM_DESC(expired_cred_retry_delay
, "Timeout (in seconds) until "
2022 "the RPC engine retries an expired credential");
2024 module_param_named(key_expire_timeo
,
2025 gss_key_expire_timeo
,
2027 MODULE_PARM_DESC(key_expire_timeo
, "Time (in seconds) at the end of a "
2028 "credential keys lifetime where the NFS layer cleans up "
2029 "prior to key expiration");
2031 module_init(init_rpcsec_gss
)
2032 module_exit(exit_rpcsec_gss
)