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_clear_bit();
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
);
265 dprintk("RPC: %s Success. gc_expiry %lu now %lu timeout %u\n",
266 __func__
, ctx
->gc_expiry
, now
, timeout
);
269 dprintk("RPC: %s returns error %ld\n", __func__
, -PTR_ERR(p
));
273 #define UPCALL_BUF_LEN 128
275 struct gss_upcall_msg
{
278 struct rpc_pipe_msg msg
;
279 struct list_head list
;
280 struct gss_auth
*auth
;
281 struct rpc_pipe
*pipe
;
282 struct rpc_wait_queue rpc_waitqueue
;
283 wait_queue_head_t waitqueue
;
284 struct gss_cl_ctx
*ctx
;
285 char databuf
[UPCALL_BUF_LEN
];
288 static int get_pipe_version(struct net
*net
)
290 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
293 spin_lock(&pipe_version_lock
);
294 if (sn
->pipe_version
>= 0) {
295 atomic_inc(&sn
->pipe_users
);
296 ret
= sn
->pipe_version
;
299 spin_unlock(&pipe_version_lock
);
303 static void put_pipe_version(struct net
*net
)
305 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
307 if (atomic_dec_and_lock(&sn
->pipe_users
, &pipe_version_lock
)) {
308 sn
->pipe_version
= -1;
309 spin_unlock(&pipe_version_lock
);
314 gss_release_msg(struct gss_upcall_msg
*gss_msg
)
316 struct net
*net
= gss_msg
->auth
->net
;
317 if (!atomic_dec_and_test(&gss_msg
->count
))
319 put_pipe_version(net
);
320 BUG_ON(!list_empty(&gss_msg
->list
));
321 if (gss_msg
->ctx
!= NULL
)
322 gss_put_ctx(gss_msg
->ctx
);
323 rpc_destroy_wait_queue(&gss_msg
->rpc_waitqueue
);
324 gss_put_auth(gss_msg
->auth
);
328 static struct gss_upcall_msg
*
329 __gss_find_upcall(struct rpc_pipe
*pipe
, kuid_t uid
)
331 struct gss_upcall_msg
*pos
;
332 list_for_each_entry(pos
, &pipe
->in_downcall
, list
) {
333 if (!uid_eq(pos
->uid
, uid
))
335 atomic_inc(&pos
->count
);
336 dprintk("RPC: %s found msg %p\n", __func__
, pos
);
339 dprintk("RPC: %s found nothing\n", __func__
);
343 /* Try to add an upcall to the pipefs queue.
344 * If an upcall owned by our uid already exists, then we return a reference
345 * to that upcall instead of adding the new upcall.
347 static inline struct gss_upcall_msg
*
348 gss_add_msg(struct gss_upcall_msg
*gss_msg
)
350 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
351 struct gss_upcall_msg
*old
;
353 spin_lock(&pipe
->lock
);
354 old
= __gss_find_upcall(pipe
, gss_msg
->uid
);
356 atomic_inc(&gss_msg
->count
);
357 list_add(&gss_msg
->list
, &pipe
->in_downcall
);
360 spin_unlock(&pipe
->lock
);
365 __gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
367 list_del_init(&gss_msg
->list
);
368 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
369 wake_up_all(&gss_msg
->waitqueue
);
370 atomic_dec(&gss_msg
->count
);
374 gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
376 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
378 if (list_empty(&gss_msg
->list
))
380 spin_lock(&pipe
->lock
);
381 if (!list_empty(&gss_msg
->list
))
382 __gss_unhash_msg(gss_msg
);
383 spin_unlock(&pipe
->lock
);
387 gss_handle_downcall_result(struct gss_cred
*gss_cred
, struct gss_upcall_msg
*gss_msg
)
389 switch (gss_msg
->msg
.errno
) {
391 if (gss_msg
->ctx
== NULL
)
393 clear_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
394 gss_cred_set_ctx(&gss_cred
->gc_base
, gss_msg
->ctx
);
397 set_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
399 gss_cred
->gc_upcall_timestamp
= jiffies
;
400 gss_cred
->gc_upcall
= NULL
;
401 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
405 gss_upcall_callback(struct rpc_task
*task
)
407 struct gss_cred
*gss_cred
= container_of(task
->tk_rqstp
->rq_cred
,
408 struct gss_cred
, gc_base
);
409 struct gss_upcall_msg
*gss_msg
= gss_cred
->gc_upcall
;
410 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
412 spin_lock(&pipe
->lock
);
413 gss_handle_downcall_result(gss_cred
, gss_msg
);
414 spin_unlock(&pipe
->lock
);
415 task
->tk_status
= gss_msg
->msg
.errno
;
416 gss_release_msg(gss_msg
);
419 static void gss_encode_v0_msg(struct gss_upcall_msg
*gss_msg
)
421 uid_t uid
= from_kuid(&init_user_ns
, gss_msg
->uid
);
422 memcpy(gss_msg
->databuf
, &uid
, sizeof(uid
));
423 gss_msg
->msg
.data
= gss_msg
->databuf
;
424 gss_msg
->msg
.len
= sizeof(uid
);
425 BUG_ON(sizeof(uid
) > UPCALL_BUF_LEN
);
428 static void gss_encode_v1_msg(struct gss_upcall_msg
*gss_msg
,
429 const char *service_name
,
430 const char *target_name
)
432 struct gss_api_mech
*mech
= gss_msg
->auth
->mech
;
433 char *p
= gss_msg
->databuf
;
436 gss_msg
->msg
.len
= sprintf(gss_msg
->databuf
, "mech=%s uid=%d ",
438 from_kuid(&init_user_ns
, gss_msg
->uid
));
439 p
+= gss_msg
->msg
.len
;
441 len
= sprintf(p
, "target=%s ", target_name
);
443 gss_msg
->msg
.len
+= len
;
445 if (service_name
!= NULL
) {
446 len
= sprintf(p
, "service=%s ", service_name
);
448 gss_msg
->msg
.len
+= len
;
450 if (mech
->gm_upcall_enctypes
) {
451 len
= sprintf(p
, "enctypes=%s ", mech
->gm_upcall_enctypes
);
453 gss_msg
->msg
.len
+= len
;
455 len
= sprintf(p
, "\n");
456 gss_msg
->msg
.len
+= len
;
458 gss_msg
->msg
.data
= gss_msg
->databuf
;
459 BUG_ON(gss_msg
->msg
.len
> UPCALL_BUF_LEN
);
462 static struct gss_upcall_msg
*
463 gss_alloc_msg(struct gss_auth
*gss_auth
,
464 kuid_t uid
, const char *service_name
)
466 struct gss_upcall_msg
*gss_msg
;
469 gss_msg
= kzalloc(sizeof(*gss_msg
), GFP_NOFS
);
471 return ERR_PTR(-ENOMEM
);
472 vers
= get_pipe_version(gss_auth
->net
);
475 return ERR_PTR(vers
);
477 gss_msg
->pipe
= gss_auth
->gss_pipe
[vers
]->pipe
;
478 INIT_LIST_HEAD(&gss_msg
->list
);
479 rpc_init_wait_queue(&gss_msg
->rpc_waitqueue
, "RPCSEC_GSS upcall waitq");
480 init_waitqueue_head(&gss_msg
->waitqueue
);
481 atomic_set(&gss_msg
->count
, 1);
483 gss_msg
->auth
= gss_auth
;
486 gss_encode_v0_msg(gss_msg
);
489 gss_encode_v1_msg(gss_msg
, service_name
, gss_auth
->target_name
);
491 kref_get(&gss_auth
->kref
);
495 static struct gss_upcall_msg
*
496 gss_setup_upcall(struct gss_auth
*gss_auth
, struct rpc_cred
*cred
)
498 struct gss_cred
*gss_cred
= container_of(cred
,
499 struct gss_cred
, gc_base
);
500 struct gss_upcall_msg
*gss_new
, *gss_msg
;
501 kuid_t uid
= cred
->cr_uid
;
503 gss_new
= gss_alloc_msg(gss_auth
, uid
, gss_cred
->gc_principal
);
506 gss_msg
= gss_add_msg(gss_new
);
507 if (gss_msg
== gss_new
) {
508 int res
= rpc_queue_upcall(gss_new
->pipe
, &gss_new
->msg
);
510 gss_unhash_msg(gss_new
);
511 gss_msg
= ERR_PTR(res
);
514 gss_release_msg(gss_new
);
518 static void warn_gssd(void)
520 static unsigned long ratelimit
;
521 unsigned long now
= jiffies
;
523 if (time_after(now
, ratelimit
)) {
524 printk(KERN_WARNING
"RPC: AUTH_GSS upcall timed out.\n"
525 "Please check user daemon is running.\n");
526 ratelimit
= now
+ 15*HZ
;
531 gss_refresh_upcall(struct rpc_task
*task
)
533 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
534 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
,
535 struct gss_auth
, rpc_auth
);
536 struct gss_cred
*gss_cred
= container_of(cred
,
537 struct gss_cred
, gc_base
);
538 struct gss_upcall_msg
*gss_msg
;
539 struct rpc_pipe
*pipe
;
542 dprintk("RPC: %5u %s for uid %u\n",
543 task
->tk_pid
, __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
544 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
545 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
546 /* XXX: warning on the first, under the assumption we
547 * shouldn't normally hit this case on a refresh. */
549 task
->tk_timeout
= 15*HZ
;
550 rpc_sleep_on(&pipe_version_rpc_waitqueue
, task
, NULL
);
553 if (IS_ERR(gss_msg
)) {
554 err
= PTR_ERR(gss_msg
);
557 pipe
= gss_msg
->pipe
;
558 spin_lock(&pipe
->lock
);
559 if (gss_cred
->gc_upcall
!= NULL
)
560 rpc_sleep_on(&gss_cred
->gc_upcall
->rpc_waitqueue
, task
, NULL
);
561 else if (gss_msg
->ctx
== NULL
&& gss_msg
->msg
.errno
>= 0) {
562 task
->tk_timeout
= 0;
563 gss_cred
->gc_upcall
= gss_msg
;
564 /* gss_upcall_callback will release the reference to gss_upcall_msg */
565 atomic_inc(&gss_msg
->count
);
566 rpc_sleep_on(&gss_msg
->rpc_waitqueue
, task
, gss_upcall_callback
);
568 gss_handle_downcall_result(gss_cred
, gss_msg
);
569 err
= gss_msg
->msg
.errno
;
571 spin_unlock(&pipe
->lock
);
572 gss_release_msg(gss_msg
);
574 dprintk("RPC: %5u %s for uid %u result %d\n",
575 task
->tk_pid
, __func__
,
576 from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
581 gss_create_upcall(struct gss_auth
*gss_auth
, struct gss_cred
*gss_cred
)
583 struct net
*net
= gss_auth
->net
;
584 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
585 struct rpc_pipe
*pipe
;
586 struct rpc_cred
*cred
= &gss_cred
->gc_base
;
587 struct gss_upcall_msg
*gss_msg
;
588 unsigned long timeout
;
592 dprintk("RPC: %s for uid %u\n",
593 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
596 /* Default timeout is 15s unless we know that gssd is not running */
598 if (!sn
->gssd_running
)
600 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
601 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
602 err
= wait_event_interruptible_timeout(pipe_version_waitqueue
,
603 sn
->pipe_version
>= 0, timeout
);
604 if (sn
->pipe_version
< 0) {
606 sn
->gssd_running
= 0;
614 if (IS_ERR(gss_msg
)) {
615 err
= PTR_ERR(gss_msg
);
618 pipe
= gss_msg
->pipe
;
620 prepare_to_wait(&gss_msg
->waitqueue
, &wait
, TASK_KILLABLE
);
621 spin_lock(&pipe
->lock
);
622 if (gss_msg
->ctx
!= NULL
|| gss_msg
->msg
.errno
< 0) {
625 spin_unlock(&pipe
->lock
);
626 if (fatal_signal_pending(current
)) {
633 gss_cred_set_ctx(cred
, gss_msg
->ctx
);
635 err
= gss_msg
->msg
.errno
;
636 spin_unlock(&pipe
->lock
);
638 finish_wait(&gss_msg
->waitqueue
, &wait
);
639 gss_release_msg(gss_msg
);
641 dprintk("RPC: %s for uid %u result %d\n",
642 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
646 #define MSG_BUF_MAXSIZE 1024
649 gss_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
653 struct gss_upcall_msg
*gss_msg
;
654 struct rpc_pipe
*pipe
= RPC_I(file_inode(filp
))->pipe
;
655 struct gss_cl_ctx
*ctx
;
658 ssize_t err
= -EFBIG
;
660 if (mlen
> MSG_BUF_MAXSIZE
)
663 buf
= kmalloc(mlen
, GFP_NOFS
);
668 if (copy_from_user(buf
, src
, mlen
))
671 end
= (const void *)((char *)buf
+ mlen
);
672 p
= simple_get_bytes(buf
, end
, &id
, sizeof(id
));
678 uid
= make_kuid(&init_user_ns
, id
);
679 if (!uid_valid(uid
)) {
685 ctx
= gss_alloc_context();
690 /* Find a matching upcall */
691 spin_lock(&pipe
->lock
);
692 gss_msg
= __gss_find_upcall(pipe
, uid
);
693 if (gss_msg
== NULL
) {
694 spin_unlock(&pipe
->lock
);
697 list_del_init(&gss_msg
->list
);
698 spin_unlock(&pipe
->lock
);
700 p
= gss_fill_context(p
, end
, ctx
, gss_msg
->auth
->mech
);
706 gss_msg
->msg
.errno
= err
;
713 gss_msg
->msg
.errno
= -EAGAIN
;
716 printk(KERN_CRIT
"%s: bad return from "
717 "gss_fill_context: %zd\n", __func__
, err
);
720 goto err_release_msg
;
722 gss_msg
->ctx
= gss_get_ctx(ctx
);
726 spin_lock(&pipe
->lock
);
727 __gss_unhash_msg(gss_msg
);
728 spin_unlock(&pipe
->lock
);
729 gss_release_msg(gss_msg
);
735 dprintk("RPC: %s returning %Zd\n", __func__
, err
);
739 static int gss_pipe_open(struct inode
*inode
, int new_version
)
741 struct net
*net
= inode
->i_sb
->s_fs_info
;
742 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
745 spin_lock(&pipe_version_lock
);
746 if (sn
->pipe_version
< 0) {
747 /* First open of any gss pipe determines the version: */
748 sn
->pipe_version
= new_version
;
749 rpc_wake_up(&pipe_version_rpc_waitqueue
);
750 wake_up(&pipe_version_waitqueue
);
751 } else if (sn
->pipe_version
!= new_version
) {
752 /* Trying to open a pipe of a different version */
756 atomic_inc(&sn
->pipe_users
);
758 spin_unlock(&pipe_version_lock
);
763 static int gss_pipe_open_v0(struct inode
*inode
)
765 return gss_pipe_open(inode
, 0);
768 static int gss_pipe_open_v1(struct inode
*inode
)
770 return gss_pipe_open(inode
, 1);
774 gss_pipe_release(struct inode
*inode
)
776 struct net
*net
= inode
->i_sb
->s_fs_info
;
777 struct rpc_pipe
*pipe
= RPC_I(inode
)->pipe
;
778 struct gss_upcall_msg
*gss_msg
;
781 spin_lock(&pipe
->lock
);
782 list_for_each_entry(gss_msg
, &pipe
->in_downcall
, list
) {
784 if (!list_empty(&gss_msg
->msg
.list
))
786 gss_msg
->msg
.errno
= -EPIPE
;
787 atomic_inc(&gss_msg
->count
);
788 __gss_unhash_msg(gss_msg
);
789 spin_unlock(&pipe
->lock
);
790 gss_release_msg(gss_msg
);
793 spin_unlock(&pipe
->lock
);
795 put_pipe_version(net
);
799 gss_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
801 struct gss_upcall_msg
*gss_msg
= container_of(msg
, struct gss_upcall_msg
, msg
);
803 if (msg
->errno
< 0) {
804 dprintk("RPC: %s releasing msg %p\n",
806 atomic_inc(&gss_msg
->count
);
807 gss_unhash_msg(gss_msg
);
808 if (msg
->errno
== -ETIMEDOUT
)
810 gss_release_msg(gss_msg
);
814 static void gss_pipe_dentry_destroy(struct dentry
*dir
,
815 struct rpc_pipe_dir_object
*pdo
)
817 struct gss_pipe
*gss_pipe
= pdo
->pdo_data
;
818 struct rpc_pipe
*pipe
= gss_pipe
->pipe
;
820 if (pipe
->dentry
!= NULL
) {
821 rpc_unlink(pipe
->dentry
);
826 static int gss_pipe_dentry_create(struct dentry
*dir
,
827 struct rpc_pipe_dir_object
*pdo
)
829 struct gss_pipe
*p
= pdo
->pdo_data
;
830 struct dentry
*dentry
;
832 dentry
= rpc_mkpipe_dentry(dir
, p
->name
, p
->clnt
, p
->pipe
);
834 return PTR_ERR(dentry
);
835 p
->pipe
->dentry
= dentry
;
839 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops
= {
840 .create
= gss_pipe_dentry_create
,
841 .destroy
= gss_pipe_dentry_destroy
,
844 static struct gss_pipe
*gss_pipe_alloc(struct rpc_clnt
*clnt
,
846 const struct rpc_pipe_ops
*upcall_ops
)
851 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
854 p
->pipe
= rpc_mkpipe_data(upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
855 if (IS_ERR(p
->pipe
)) {
856 err
= PTR_ERR(p
->pipe
);
857 goto err_free_gss_pipe
;
862 rpc_init_pipe_dir_object(&p
->pdo
,
863 &gss_pipe_dir_object_ops
,
872 struct gss_alloc_pdo
{
873 struct rpc_clnt
*clnt
;
875 const struct rpc_pipe_ops
*upcall_ops
;
878 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object
*pdo
, void *data
)
880 struct gss_pipe
*gss_pipe
;
881 struct gss_alloc_pdo
*args
= data
;
883 if (pdo
->pdo_ops
!= &gss_pipe_dir_object_ops
)
885 gss_pipe
= container_of(pdo
, struct gss_pipe
, pdo
);
886 if (strcmp(gss_pipe
->name
, args
->name
) != 0)
888 if (!kref_get_unless_zero(&gss_pipe
->kref
))
893 static struct rpc_pipe_dir_object
*gss_pipe_alloc_pdo(void *data
)
895 struct gss_pipe
*gss_pipe
;
896 struct gss_alloc_pdo
*args
= data
;
898 gss_pipe
= gss_pipe_alloc(args
->clnt
, args
->name
, args
->upcall_ops
);
899 if (!IS_ERR(gss_pipe
))
900 return &gss_pipe
->pdo
;
904 static struct gss_pipe
*gss_pipe_get(struct rpc_clnt
*clnt
,
906 const struct rpc_pipe_ops
*upcall_ops
)
908 struct net
*net
= rpc_net_ns(clnt
);
909 struct rpc_pipe_dir_object
*pdo
;
910 struct gss_alloc_pdo args
= {
913 .upcall_ops
= upcall_ops
,
916 pdo
= rpc_find_or_alloc_pipe_dir_object(net
,
917 &clnt
->cl_pipedir_objects
,
922 return container_of(pdo
, struct gss_pipe
, pdo
);
923 return ERR_PTR(-ENOMEM
);
926 static void __gss_pipe_free(struct gss_pipe
*p
)
928 struct rpc_clnt
*clnt
= p
->clnt
;
929 struct net
*net
= rpc_net_ns(clnt
);
931 rpc_remove_pipe_dir_object(net
,
932 &clnt
->cl_pipedir_objects
,
934 rpc_destroy_pipe_data(p
->pipe
);
938 static void __gss_pipe_release(struct kref
*kref
)
940 struct gss_pipe
*p
= container_of(kref
, struct gss_pipe
, kref
);
945 static void gss_pipe_free(struct gss_pipe
*p
)
948 kref_put(&p
->kref
, __gss_pipe_release
);
952 * NOTE: we have the opportunity to use different
953 * parameters based on the input flavor (which must be a pseudoflavor)
955 static struct gss_auth
*
956 gss_create_new(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
958 rpc_authflavor_t flavor
= args
->pseudoflavor
;
959 struct gss_auth
*gss_auth
;
960 struct gss_pipe
*gss_pipe
;
961 struct rpc_auth
* auth
;
962 int err
= -ENOMEM
; /* XXX? */
964 dprintk("RPC: creating GSS authenticator for client %p\n", clnt
);
966 if (!try_module_get(THIS_MODULE
))
968 if (!(gss_auth
= kmalloc(sizeof(*gss_auth
), GFP_KERNEL
)))
970 INIT_HLIST_NODE(&gss_auth
->hash
);
971 gss_auth
->target_name
= NULL
;
972 if (args
->target_name
) {
973 gss_auth
->target_name
= kstrdup(args
->target_name
, GFP_KERNEL
);
974 if (gss_auth
->target_name
== NULL
)
977 gss_auth
->client
= clnt
;
978 gss_auth
->net
= get_net(rpc_net_ns(clnt
));
980 gss_auth
->mech
= gss_mech_get_by_pseudoflavor(flavor
);
981 if (!gss_auth
->mech
) {
982 dprintk("RPC: Pseudoflavor %d not found!\n", flavor
);
985 gss_auth
->service
= gss_pseudoflavor_to_service(gss_auth
->mech
, flavor
);
986 if (gss_auth
->service
== 0)
988 auth
= &gss_auth
->rpc_auth
;
989 auth
->au_cslack
= GSS_CRED_SLACK
>> 2;
990 auth
->au_rslack
= GSS_VERF_SLACK
>> 2;
991 auth
->au_ops
= &authgss_ops
;
992 auth
->au_flavor
= flavor
;
993 atomic_set(&auth
->au_count
, 1);
994 kref_init(&gss_auth
->kref
);
996 err
= rpcauth_init_credcache(auth
);
1000 * Note: if we created the old pipe first, then someone who
1001 * examined the directory at the right moment might conclude
1002 * that we supported only the old pipe. So we instead create
1003 * the new pipe first.
1005 gss_pipe
= gss_pipe_get(clnt
, "gssd", &gss_upcall_ops_v1
);
1006 if (IS_ERR(gss_pipe
)) {
1007 err
= PTR_ERR(gss_pipe
);
1008 goto err_destroy_credcache
;
1010 gss_auth
->gss_pipe
[1] = gss_pipe
;
1012 gss_pipe
= gss_pipe_get(clnt
, gss_auth
->mech
->gm_name
,
1013 &gss_upcall_ops_v0
);
1014 if (IS_ERR(gss_pipe
)) {
1015 err
= PTR_ERR(gss_pipe
);
1016 goto err_destroy_pipe_1
;
1018 gss_auth
->gss_pipe
[0] = gss_pipe
;
1022 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1023 err_destroy_credcache
:
1024 rpcauth_destroy_credcache(auth
);
1026 gss_mech_put(gss_auth
->mech
);
1028 put_net(gss_auth
->net
);
1030 kfree(gss_auth
->target_name
);
1033 module_put(THIS_MODULE
);
1034 return ERR_PTR(err
);
1038 gss_free(struct gss_auth
*gss_auth
)
1040 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1041 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1042 gss_mech_put(gss_auth
->mech
);
1043 put_net(gss_auth
->net
);
1044 kfree(gss_auth
->target_name
);
1047 module_put(THIS_MODULE
);
1051 gss_free_callback(struct kref
*kref
)
1053 struct gss_auth
*gss_auth
= container_of(kref
, struct gss_auth
, kref
);
1059 gss_put_auth(struct gss_auth
*gss_auth
)
1061 kref_put(&gss_auth
->kref
, gss_free_callback
);
1065 gss_destroy(struct rpc_auth
*auth
)
1067 struct gss_auth
*gss_auth
= container_of(auth
,
1068 struct gss_auth
, rpc_auth
);
1070 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1071 auth
, auth
->au_flavor
);
1073 if (hash_hashed(&gss_auth
->hash
)) {
1074 spin_lock(&gss_auth_hash_lock
);
1075 hash_del(&gss_auth
->hash
);
1076 spin_unlock(&gss_auth_hash_lock
);
1079 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1080 gss_auth
->gss_pipe
[0] = NULL
;
1081 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1082 gss_auth
->gss_pipe
[1] = NULL
;
1083 rpcauth_destroy_credcache(auth
);
1085 gss_put_auth(gss_auth
);
1089 * Auths may be shared between rpc clients that were cloned from a
1090 * common client with the same xprt, if they also share the flavor and
1093 * The auth is looked up from the oldest parent sharing the same
1094 * cl_xprt, and the auth itself references only that common parent
1095 * (which is guaranteed to last as long as any of its descendants).
1097 static struct gss_auth
*
1098 gss_auth_find_or_add_hashed(struct rpc_auth_create_args
*args
,
1099 struct rpc_clnt
*clnt
,
1100 struct gss_auth
*new)
1102 struct gss_auth
*gss_auth
;
1103 unsigned long hashval
= (unsigned long)clnt
;
1105 spin_lock(&gss_auth_hash_lock
);
1106 hash_for_each_possible(gss_auth_hash_table
,
1110 if (gss_auth
->client
!= clnt
)
1112 if (gss_auth
->rpc_auth
.au_flavor
!= args
->pseudoflavor
)
1114 if (gss_auth
->target_name
!= args
->target_name
) {
1115 if (gss_auth
->target_name
== NULL
)
1117 if (args
->target_name
== NULL
)
1119 if (strcmp(gss_auth
->target_name
, args
->target_name
))
1122 if (!atomic_inc_not_zero(&gss_auth
->rpc_auth
.au_count
))
1127 hash_add(gss_auth_hash_table
, &new->hash
, hashval
);
1130 spin_unlock(&gss_auth_hash_lock
);
1134 static struct gss_auth
*
1135 gss_create_hashed(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1137 struct gss_auth
*gss_auth
;
1138 struct gss_auth
*new;
1140 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, NULL
);
1141 if (gss_auth
!= NULL
)
1143 new = gss_create_new(args
, clnt
);
1146 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, new);
1147 if (gss_auth
!= new)
1148 gss_destroy(&new->rpc_auth
);
1153 static struct rpc_auth
*
1154 gss_create(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1156 struct gss_auth
*gss_auth
;
1157 struct rpc_xprt
*xprt
= rcu_access_pointer(clnt
->cl_xprt
);
1159 while (clnt
!= clnt
->cl_parent
) {
1160 struct rpc_clnt
*parent
= clnt
->cl_parent
;
1161 /* Find the original parent for this transport */
1162 if (rcu_access_pointer(parent
->cl_xprt
) != xprt
)
1167 gss_auth
= gss_create_hashed(args
, clnt
);
1168 if (IS_ERR(gss_auth
))
1169 return ERR_CAST(gss_auth
);
1170 return &gss_auth
->rpc_auth
;
1174 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1175 * to the server with the GSS control procedure field set to
1176 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1177 * all RPCSEC_GSS state associated with that context.
1180 gss_destroying_context(struct rpc_cred
*cred
)
1182 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1183 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1184 struct rpc_task
*task
;
1186 if (gss_cred
->gc_ctx
== NULL
||
1187 test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
) == 0)
1190 gss_cred
->gc_ctx
->gc_proc
= RPC_GSS_PROC_DESTROY
;
1191 cred
->cr_ops
= &gss_nullops
;
1193 /* Take a reference to ensure the cred will be destroyed either
1194 * by the RPC call or by the put_rpccred() below */
1197 task
= rpc_call_null(gss_auth
->client
, cred
, RPC_TASK_ASYNC
|RPC_TASK_SOFT
);
1205 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1206 * to create a new cred or context, so they check that things have been
1207 * allocated before freeing them. */
1209 gss_do_free_ctx(struct gss_cl_ctx
*ctx
)
1211 dprintk("RPC: %s\n", __func__
);
1213 gss_delete_sec_context(&ctx
->gc_gss_ctx
);
1214 kfree(ctx
->gc_wire_ctx
.data
);
1219 gss_free_ctx_callback(struct rcu_head
*head
)
1221 struct gss_cl_ctx
*ctx
= container_of(head
, struct gss_cl_ctx
, gc_rcu
);
1222 gss_do_free_ctx(ctx
);
1226 gss_free_ctx(struct gss_cl_ctx
*ctx
)
1228 call_rcu(&ctx
->gc_rcu
, gss_free_ctx_callback
);
1232 gss_free_cred(struct gss_cred
*gss_cred
)
1234 dprintk("RPC: %s cred=%p\n", __func__
, gss_cred
);
1239 gss_free_cred_callback(struct rcu_head
*head
)
1241 struct gss_cred
*gss_cred
= container_of(head
, struct gss_cred
, gc_base
.cr_rcu
);
1242 gss_free_cred(gss_cred
);
1246 gss_destroy_nullcred(struct rpc_cred
*cred
)
1248 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1249 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1250 struct gss_cl_ctx
*ctx
= gss_cred
->gc_ctx
;
1252 RCU_INIT_POINTER(gss_cred
->gc_ctx
, NULL
);
1253 call_rcu(&cred
->cr_rcu
, gss_free_cred_callback
);
1256 gss_put_auth(gss_auth
);
1260 gss_destroy_cred(struct rpc_cred
*cred
)
1263 if (gss_destroying_context(cred
))
1265 gss_destroy_nullcred(cred
);
1269 * Lookup RPCSEC_GSS cred for the current process
1271 static struct rpc_cred
*
1272 gss_lookup_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1274 return rpcauth_lookup_credcache(auth
, acred
, flags
);
1277 static struct rpc_cred
*
1278 gss_create_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1280 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1281 struct gss_cred
*cred
= NULL
;
1284 dprintk("RPC: %s for uid %d, flavor %d\n",
1285 __func__
, from_kuid(&init_user_ns
, acred
->uid
),
1288 if (!(cred
= kzalloc(sizeof(*cred
), GFP_NOFS
)))
1291 rpcauth_init_cred(&cred
->gc_base
, acred
, auth
, &gss_credops
);
1293 * Note: in order to force a call to call_refresh(), we deliberately
1294 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1296 cred
->gc_base
.cr_flags
= 1UL << RPCAUTH_CRED_NEW
;
1297 cred
->gc_service
= gss_auth
->service
;
1298 cred
->gc_principal
= NULL
;
1299 if (acred
->machine_cred
)
1300 cred
->gc_principal
= acred
->principal
;
1301 kref_get(&gss_auth
->kref
);
1302 return &cred
->gc_base
;
1305 dprintk("RPC: %s failed with error %d\n", __func__
, err
);
1306 return ERR_PTR(err
);
1310 gss_cred_init(struct rpc_auth
*auth
, struct rpc_cred
*cred
)
1312 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1313 struct gss_cred
*gss_cred
= container_of(cred
,struct gss_cred
, gc_base
);
1317 err
= gss_create_upcall(gss_auth
, gss_cred
);
1318 } while (err
== -EAGAIN
);
1323 * Returns -EACCES if GSS context is NULL or will expire within the
1324 * timeout (miliseconds)
1327 gss_key_timeout(struct rpc_cred
*rc
)
1329 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1330 unsigned long now
= jiffies
;
1331 unsigned long expire
;
1333 if (gss_cred
->gc_ctx
== NULL
)
1336 expire
= gss_cred
->gc_ctx
->gc_expiry
- (gss_key_expire_timeo
* HZ
);
1338 if (time_after(now
, expire
))
1344 gss_match(struct auth_cred
*acred
, struct rpc_cred
*rc
, int flags
)
1346 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1349 if (test_bit(RPCAUTH_CRED_NEW
, &rc
->cr_flags
))
1351 /* Don't match with creds that have expired. */
1352 if (time_after(jiffies
, gss_cred
->gc_ctx
->gc_expiry
))
1354 if (!test_bit(RPCAUTH_CRED_UPTODATE
, &rc
->cr_flags
))
1357 if (acred
->principal
!= NULL
) {
1358 if (gss_cred
->gc_principal
== NULL
)
1360 ret
= strcmp(acred
->principal
, gss_cred
->gc_principal
) == 0;
1363 if (gss_cred
->gc_principal
!= NULL
)
1365 ret
= uid_eq(rc
->cr_uid
, acred
->uid
);
1371 /* Notify acred users of GSS context expiration timeout */
1372 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
) &&
1373 (gss_key_timeout(rc
) != 0)) {
1374 /* test will now be done from generic cred */
1375 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
);
1376 /* tell NFS layer that key will expire soon */
1377 set_bit(RPC_CRED_KEY_EXPIRE_SOON
, &acred
->ac_flags
);
1383 * Marshal credentials.
1384 * Maybe we should keep a cached credential for performance reasons.
1387 gss_marshal(struct rpc_task
*task
, __be32
*p
)
1389 struct rpc_rqst
*req
= task
->tk_rqstp
;
1390 struct rpc_cred
*cred
= req
->rq_cred
;
1391 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1393 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1396 struct xdr_netobj mic
;
1398 struct xdr_buf verf_buf
;
1400 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1402 *p
++ = htonl(RPC_AUTH_GSS
);
1405 spin_lock(&ctx
->gc_seq_lock
);
1406 req
->rq_seqno
= ctx
->gc_seq
++;
1407 spin_unlock(&ctx
->gc_seq_lock
);
1409 *p
++ = htonl((u32
) RPC_GSS_VERSION
);
1410 *p
++ = htonl((u32
) ctx
->gc_proc
);
1411 *p
++ = htonl((u32
) req
->rq_seqno
);
1412 *p
++ = htonl((u32
) gss_cred
->gc_service
);
1413 p
= xdr_encode_netobj(p
, &ctx
->gc_wire_ctx
);
1414 *cred_len
= htonl((p
- (cred_len
+ 1)) << 2);
1416 /* We compute the checksum for the verifier over the xdr-encoded bytes
1417 * starting with the xid and ending at the end of the credential: */
1418 iov
.iov_base
= xprt_skip_transport_header(req
->rq_xprt
,
1419 req
->rq_snd_buf
.head
[0].iov_base
);
1420 iov
.iov_len
= (u8
*)p
- (u8
*)iov
.iov_base
;
1421 xdr_buf_from_iov(&iov
, &verf_buf
);
1423 /* set verifier flavor*/
1424 *p
++ = htonl(RPC_AUTH_GSS
);
1426 mic
.data
= (u8
*)(p
+ 1);
1427 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1428 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
) {
1429 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1430 } else if (maj_stat
!= 0) {
1431 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat
);
1434 p
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1442 static int gss_renew_cred(struct rpc_task
*task
)
1444 struct rpc_cred
*oldcred
= task
->tk_rqstp
->rq_cred
;
1445 struct gss_cred
*gss_cred
= container_of(oldcred
,
1448 struct rpc_auth
*auth
= oldcred
->cr_auth
;
1449 struct auth_cred acred
= {
1450 .uid
= oldcred
->cr_uid
,
1451 .principal
= gss_cred
->gc_principal
,
1452 .machine_cred
= (gss_cred
->gc_principal
!= NULL
? 1 : 0),
1454 struct rpc_cred
*new;
1456 new = gss_lookup_cred(auth
, &acred
, RPCAUTH_LOOKUP_NEW
);
1458 return PTR_ERR(new);
1459 task
->tk_rqstp
->rq_cred
= new;
1460 put_rpccred(oldcred
);
1464 static int gss_cred_is_negative_entry(struct rpc_cred
*cred
)
1466 if (test_bit(RPCAUTH_CRED_NEGATIVE
, &cred
->cr_flags
)) {
1467 unsigned long now
= jiffies
;
1468 unsigned long begin
, expire
;
1469 struct gss_cred
*gss_cred
;
1471 gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1472 begin
= gss_cred
->gc_upcall_timestamp
;
1473 expire
= begin
+ gss_expired_cred_retry_delay
* HZ
;
1475 if (time_in_range_open(now
, begin
, expire
))
1482 * Refresh credentials. XXX - finish
1485 gss_refresh(struct rpc_task
*task
)
1487 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1490 if (gss_cred_is_negative_entry(cred
))
1491 return -EKEYEXPIRED
;
1493 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
) &&
1494 !test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
)) {
1495 ret
= gss_renew_cred(task
);
1498 cred
= task
->tk_rqstp
->rq_cred
;
1501 if (test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
1502 ret
= gss_refresh_upcall(task
);
1507 /* Dummy refresh routine: used only when destroying the context */
1509 gss_refresh_null(struct rpc_task
*task
)
1515 gss_validate(struct rpc_task
*task
, __be32
*p
)
1517 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1518 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1521 struct xdr_buf verf_buf
;
1522 struct xdr_netobj mic
;
1525 __be32
*ret
= ERR_PTR(-EIO
);
1527 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1530 if ((len
= ntohl(*p
++)) > RPC_MAX_AUTH_SIZE
)
1532 if (flav
!= RPC_AUTH_GSS
)
1534 seq
= htonl(task
->tk_rqstp
->rq_seqno
);
1535 iov
.iov_base
= &seq
;
1536 iov
.iov_len
= sizeof(seq
);
1537 xdr_buf_from_iov(&iov
, &verf_buf
);
1541 ret
= ERR_PTR(-EACCES
);
1542 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1543 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1544 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1546 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1547 task
->tk_pid
, __func__
, maj_stat
);
1550 /* We leave it to unwrap to calculate au_rslack. For now we just
1551 * calculate the length of the verifier: */
1552 cred
->cr_auth
->au_verfsize
= XDR_QUADLEN(len
) + 2;
1554 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1555 task
->tk_pid
, __func__
);
1556 return p
+ XDR_QUADLEN(len
);
1559 dprintk("RPC: %5u %s failed ret %ld.\n", task
->tk_pid
, __func__
,
1564 static void gss_wrap_req_encode(kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1565 __be32
*p
, void *obj
)
1567 struct xdr_stream xdr
;
1569 xdr_init_encode(&xdr
, &rqstp
->rq_snd_buf
, p
);
1570 encode(rqstp
, &xdr
, obj
);
1574 gss_wrap_req_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1575 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1576 __be32
*p
, void *obj
)
1578 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1579 struct xdr_buf integ_buf
;
1580 __be32
*integ_len
= NULL
;
1581 struct xdr_netobj mic
;
1589 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1590 *p
++ = htonl(rqstp
->rq_seqno
);
1592 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1594 if (xdr_buf_subsegment(snd_buf
, &integ_buf
,
1595 offset
, snd_buf
->len
- offset
))
1597 *integ_len
= htonl(integ_buf
.len
);
1599 /* guess whether we're in the head or the tail: */
1600 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1601 iov
= snd_buf
->tail
;
1603 iov
= snd_buf
->head
;
1604 p
= iov
->iov_base
+ iov
->iov_len
;
1605 mic
.data
= (u8
*)(p
+ 1);
1607 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1608 status
= -EIO
; /* XXX? */
1609 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1610 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1613 q
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1615 offset
= (u8
*)q
- (u8
*)p
;
1616 iov
->iov_len
+= offset
;
1617 snd_buf
->len
+= offset
;
1622 priv_release_snd_buf(struct rpc_rqst
*rqstp
)
1626 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++)
1627 __free_page(rqstp
->rq_enc_pages
[i
]);
1628 kfree(rqstp
->rq_enc_pages
);
1632 alloc_enc_pages(struct rpc_rqst
*rqstp
)
1634 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1637 if (snd_buf
->page_len
== 0) {
1638 rqstp
->rq_enc_pages_num
= 0;
1642 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1643 last
= (snd_buf
->page_base
+ snd_buf
->page_len
- 1) >> PAGE_CACHE_SHIFT
;
1644 rqstp
->rq_enc_pages_num
= last
- first
+ 1 + 1;
1646 = kmalloc(rqstp
->rq_enc_pages_num
* sizeof(struct page
*),
1648 if (!rqstp
->rq_enc_pages
)
1650 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++) {
1651 rqstp
->rq_enc_pages
[i
] = alloc_page(GFP_NOFS
);
1652 if (rqstp
->rq_enc_pages
[i
] == NULL
)
1655 rqstp
->rq_release_snd_buf
= priv_release_snd_buf
;
1658 rqstp
->rq_enc_pages_num
= i
;
1659 priv_release_snd_buf(rqstp
);
1665 gss_wrap_req_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1666 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1667 __be32
*p
, void *obj
)
1669 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1674 struct page
**inpages
;
1681 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1682 *p
++ = htonl(rqstp
->rq_seqno
);
1684 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1686 status
= alloc_enc_pages(rqstp
);
1689 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1690 inpages
= snd_buf
->pages
+ first
;
1691 snd_buf
->pages
= rqstp
->rq_enc_pages
;
1692 snd_buf
->page_base
-= first
<< PAGE_CACHE_SHIFT
;
1694 * Give the tail its own page, in case we need extra space in the
1695 * head when wrapping:
1697 * call_allocate() allocates twice the slack space required
1698 * by the authentication flavor to rq_callsize.
1699 * For GSS, slack is GSS_CRED_SLACK.
1701 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
) {
1702 tmp
= page_address(rqstp
->rq_enc_pages
[rqstp
->rq_enc_pages_num
- 1]);
1703 memcpy(tmp
, snd_buf
->tail
[0].iov_base
, snd_buf
->tail
[0].iov_len
);
1704 snd_buf
->tail
[0].iov_base
= tmp
;
1706 maj_stat
= gss_wrap(ctx
->gc_gss_ctx
, offset
, snd_buf
, inpages
);
1707 /* slack space should prevent this ever happening: */
1708 BUG_ON(snd_buf
->len
> snd_buf
->buflen
);
1710 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1711 * done anyway, so it's safe to put the request on the wire: */
1712 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1713 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1717 *opaque_len
= htonl(snd_buf
->len
- offset
);
1718 /* guess whether we're in the head or the tail: */
1719 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1720 iov
= snd_buf
->tail
;
1722 iov
= snd_buf
->head
;
1723 p
= iov
->iov_base
+ iov
->iov_len
;
1724 pad
= 3 - ((snd_buf
->len
- offset
- 1) & 3);
1726 iov
->iov_len
+= pad
;
1727 snd_buf
->len
+= pad
;
1733 gss_wrap_req(struct rpc_task
*task
,
1734 kxdreproc_t encode
, void *rqstp
, __be32
*p
, void *obj
)
1736 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1737 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1739 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1742 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1743 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
) {
1744 /* The spec seems a little ambiguous here, but I think that not
1745 * wrapping context destruction requests makes the most sense.
1747 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1751 switch (gss_cred
->gc_service
) {
1752 case RPC_GSS_SVC_NONE
:
1753 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1756 case RPC_GSS_SVC_INTEGRITY
:
1757 status
= gss_wrap_req_integ(cred
, ctx
, encode
, rqstp
, p
, obj
);
1759 case RPC_GSS_SVC_PRIVACY
:
1760 status
= gss_wrap_req_priv(cred
, ctx
, encode
, rqstp
, p
, obj
);
1765 dprintk("RPC: %5u %s returning %d\n", task
->tk_pid
, __func__
, status
);
1770 gss_unwrap_resp_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1771 struct rpc_rqst
*rqstp
, __be32
**p
)
1773 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1774 struct xdr_buf integ_buf
;
1775 struct xdr_netobj mic
;
1776 u32 data_offset
, mic_offset
;
1781 integ_len
= ntohl(*(*p
)++);
1784 data_offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1785 mic_offset
= integ_len
+ data_offset
;
1786 if (mic_offset
> rcv_buf
->len
)
1788 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1791 if (xdr_buf_subsegment(rcv_buf
, &integ_buf
, data_offset
,
1792 mic_offset
- data_offset
))
1795 if (xdr_buf_read_netobj(rcv_buf
, &mic
, mic_offset
))
1798 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1799 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1800 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1801 if (maj_stat
!= GSS_S_COMPLETE
)
1807 gss_unwrap_resp_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1808 struct rpc_rqst
*rqstp
, __be32
**p
)
1810 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1816 opaque_len
= ntohl(*(*p
)++);
1817 offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1818 if (offset
+ opaque_len
> rcv_buf
->len
)
1820 /* remove padding: */
1821 rcv_buf
->len
= offset
+ opaque_len
;
1823 maj_stat
= gss_unwrap(ctx
->gc_gss_ctx
, offset
, rcv_buf
);
1824 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1825 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1826 if (maj_stat
!= GSS_S_COMPLETE
)
1828 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1835 gss_unwrap_req_decode(kxdrdproc_t decode
, struct rpc_rqst
*rqstp
,
1836 __be32
*p
, void *obj
)
1838 struct xdr_stream xdr
;
1840 xdr_init_decode(&xdr
, &rqstp
->rq_rcv_buf
, p
);
1841 return decode(rqstp
, &xdr
, obj
);
1845 gss_unwrap_resp(struct rpc_task
*task
,
1846 kxdrdproc_t decode
, void *rqstp
, __be32
*p
, void *obj
)
1848 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1849 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1851 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1853 struct kvec
*head
= ((struct rpc_rqst
*)rqstp
)->rq_rcv_buf
.head
;
1854 int savedlen
= head
->iov_len
;
1857 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
)
1859 switch (gss_cred
->gc_service
) {
1860 case RPC_GSS_SVC_NONE
:
1862 case RPC_GSS_SVC_INTEGRITY
:
1863 status
= gss_unwrap_resp_integ(cred
, ctx
, rqstp
, &p
);
1867 case RPC_GSS_SVC_PRIVACY
:
1868 status
= gss_unwrap_resp_priv(cred
, ctx
, rqstp
, &p
);
1873 /* take into account extra slack for integrity and privacy cases: */
1874 cred
->cr_auth
->au_rslack
= cred
->cr_auth
->au_verfsize
+ (p
- savedp
)
1875 + (savedlen
- head
->iov_len
);
1877 status
= gss_unwrap_req_decode(decode
, rqstp
, p
, obj
);
1880 dprintk("RPC: %5u %s returning %d\n",
1881 task
->tk_pid
, __func__
, status
);
1885 static const struct rpc_authops authgss_ops
= {
1886 .owner
= THIS_MODULE
,
1887 .au_flavor
= RPC_AUTH_GSS
,
1888 .au_name
= "RPCSEC_GSS",
1889 .create
= gss_create
,
1890 .destroy
= gss_destroy
,
1891 .lookup_cred
= gss_lookup_cred
,
1892 .crcreate
= gss_create_cred
,
1893 .list_pseudoflavors
= gss_mech_list_pseudoflavors
,
1894 .info2flavor
= gss_mech_info2flavor
,
1895 .flavor2info
= gss_mech_flavor2info
,
1898 static const struct rpc_credops gss_credops
= {
1899 .cr_name
= "AUTH_GSS",
1900 .crdestroy
= gss_destroy_cred
,
1901 .cr_init
= gss_cred_init
,
1902 .crbind
= rpcauth_generic_bind_cred
,
1903 .crmatch
= gss_match
,
1904 .crmarshal
= gss_marshal
,
1905 .crrefresh
= gss_refresh
,
1906 .crvalidate
= gss_validate
,
1907 .crwrap_req
= gss_wrap_req
,
1908 .crunwrap_resp
= gss_unwrap_resp
,
1909 .crkey_timeout
= gss_key_timeout
,
1912 static const struct rpc_credops gss_nullops
= {
1913 .cr_name
= "AUTH_GSS",
1914 .crdestroy
= gss_destroy_nullcred
,
1915 .crbind
= rpcauth_generic_bind_cred
,
1916 .crmatch
= gss_match
,
1917 .crmarshal
= gss_marshal
,
1918 .crrefresh
= gss_refresh_null
,
1919 .crvalidate
= gss_validate
,
1920 .crwrap_req
= gss_wrap_req
,
1921 .crunwrap_resp
= gss_unwrap_resp
,
1924 static const struct rpc_pipe_ops gss_upcall_ops_v0
= {
1925 .upcall
= rpc_pipe_generic_upcall
,
1926 .downcall
= gss_pipe_downcall
,
1927 .destroy_msg
= gss_pipe_destroy_msg
,
1928 .open_pipe
= gss_pipe_open_v0
,
1929 .release_pipe
= gss_pipe_release
,
1932 static const struct rpc_pipe_ops gss_upcall_ops_v1
= {
1933 .upcall
= rpc_pipe_generic_upcall
,
1934 .downcall
= gss_pipe_downcall
,
1935 .destroy_msg
= gss_pipe_destroy_msg
,
1936 .open_pipe
= gss_pipe_open_v1
,
1937 .release_pipe
= gss_pipe_release
,
1940 static __net_init
int rpcsec_gss_init_net(struct net
*net
)
1942 return gss_svc_init_net(net
);
1945 static __net_exit
void rpcsec_gss_exit_net(struct net
*net
)
1947 gss_svc_shutdown_net(net
);
1950 static struct pernet_operations rpcsec_gss_net_ops
= {
1951 .init
= rpcsec_gss_init_net
,
1952 .exit
= rpcsec_gss_exit_net
,
1956 * Initialize RPCSEC_GSS module
1958 static int __init
init_rpcsec_gss(void)
1962 err
= rpcauth_register(&authgss_ops
);
1965 err
= gss_svc_init();
1967 goto out_unregister
;
1968 err
= register_pernet_subsys(&rpcsec_gss_net_ops
);
1971 rpc_init_wait_queue(&pipe_version_rpc_waitqueue
, "gss pipe version");
1976 rpcauth_unregister(&authgss_ops
);
1981 static void __exit
exit_rpcsec_gss(void)
1983 unregister_pernet_subsys(&rpcsec_gss_net_ops
);
1985 rpcauth_unregister(&authgss_ops
);
1986 rcu_barrier(); /* Wait for completion of call_rcu()'s */
1989 MODULE_ALIAS("rpc-auth-6");
1990 MODULE_LICENSE("GPL");
1991 module_param_named(expired_cred_retry_delay
,
1992 gss_expired_cred_retry_delay
,
1994 MODULE_PARM_DESC(expired_cred_retry_delay
, "Timeout (in seconds) until "
1995 "the RPC engine retries an expired credential");
1997 module_param_named(key_expire_timeo
,
1998 gss_key_expire_timeo
,
2000 MODULE_PARM_DESC(key_expire_timeo
, "Time (in seconds) at the end of a "
2001 "credential keys lifetime where the NFS layer cleans up "
2002 "prior to key expiration");
2004 module_init(init_rpcsec_gss
)
2005 module_exit(exit_rpcsec_gss
)