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
;
69 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
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 ctx
= rcu_dereference(gss_cred
->gc_ctx
);
193 static struct gss_cl_ctx
*
194 gss_alloc_context(void)
196 struct gss_cl_ctx
*ctx
;
198 ctx
= kzalloc(sizeof(*ctx
), GFP_NOFS
);
200 ctx
->gc_proc
= RPC_GSS_PROC_DATA
;
201 ctx
->gc_seq
= 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
202 spin_lock_init(&ctx
->gc_seq_lock
);
203 atomic_set(&ctx
->count
,1);
208 #define GSSD_MIN_TIMEOUT (60 * 60)
210 gss_fill_context(const void *p
, const void *end
, struct gss_cl_ctx
*ctx
, struct gss_api_mech
*gm
)
214 unsigned int timeout
;
215 unsigned long now
= jiffies
;
219 /* First unsigned int gives the remaining lifetime in seconds of the
220 * credential - e.g. the remaining TGT lifetime for Kerberos or
221 * the -t value passed to GSSD.
223 p
= simple_get_bytes(p
, end
, &timeout
, sizeof(timeout
));
227 timeout
= GSSD_MIN_TIMEOUT
;
228 ctx
->gc_expiry
= now
+ ((unsigned long)timeout
* HZ
);
229 /* Sequence number window. Determines the maximum number of
230 * simultaneous requests
232 p
= simple_get_bytes(p
, end
, &window_size
, sizeof(window_size
));
235 ctx
->gc_win
= window_size
;
236 /* gssd signals an error by passing ctx->gc_win = 0: */
237 if (ctx
->gc_win
== 0) {
239 * in which case, p points to an error code. Anything other
240 * than -EKEYEXPIRED gets converted to -EACCES.
242 p
= simple_get_bytes(p
, end
, &ret
, sizeof(ret
));
244 p
= (ret
== -EKEYEXPIRED
) ? ERR_PTR(-EKEYEXPIRED
) :
248 /* copy the opaque wire context */
249 p
= simple_get_netobj(p
, end
, &ctx
->gc_wire_ctx
);
252 /* import the opaque security context */
253 p
= simple_get_bytes(p
, end
, &seclen
, sizeof(seclen
));
256 q
= (const void *)((const char *)p
+ seclen
);
257 if (unlikely(q
> end
|| q
< p
)) {
258 p
= ERR_PTR(-EFAULT
);
261 ret
= gss_import_sec_context(p
, seclen
, gm
, &ctx
->gc_gss_ctx
, NULL
, GFP_NOFS
);
267 /* is there any trailing data? */
273 /* pull in acceptor name (if there is one) */
274 p
= simple_get_netobj(q
, end
, &ctx
->gc_acceptor
);
278 dprintk("RPC: %s Success. gc_expiry %lu now %lu timeout %u acceptor %.*s\n",
279 __func__
, ctx
->gc_expiry
, now
, timeout
, ctx
->gc_acceptor
.len
,
280 ctx
->gc_acceptor
.data
);
283 dprintk("RPC: %s returns error %ld\n", __func__
, -PTR_ERR(p
));
287 #define UPCALL_BUF_LEN 128
289 struct gss_upcall_msg
{
292 struct rpc_pipe_msg msg
;
293 struct list_head list
;
294 struct gss_auth
*auth
;
295 struct rpc_pipe
*pipe
;
296 struct rpc_wait_queue rpc_waitqueue
;
297 wait_queue_head_t waitqueue
;
298 struct gss_cl_ctx
*ctx
;
299 char databuf
[UPCALL_BUF_LEN
];
302 static int get_pipe_version(struct net
*net
)
304 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
307 spin_lock(&pipe_version_lock
);
308 if (sn
->pipe_version
>= 0) {
309 atomic_inc(&sn
->pipe_users
);
310 ret
= sn
->pipe_version
;
313 spin_unlock(&pipe_version_lock
);
317 static void put_pipe_version(struct net
*net
)
319 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
321 if (atomic_dec_and_lock(&sn
->pipe_users
, &pipe_version_lock
)) {
322 sn
->pipe_version
= -1;
323 spin_unlock(&pipe_version_lock
);
328 gss_release_msg(struct gss_upcall_msg
*gss_msg
)
330 struct net
*net
= gss_msg
->auth
->net
;
331 if (!atomic_dec_and_test(&gss_msg
->count
))
333 put_pipe_version(net
);
334 BUG_ON(!list_empty(&gss_msg
->list
));
335 if (gss_msg
->ctx
!= NULL
)
336 gss_put_ctx(gss_msg
->ctx
);
337 rpc_destroy_wait_queue(&gss_msg
->rpc_waitqueue
);
338 gss_put_auth(gss_msg
->auth
);
342 static struct gss_upcall_msg
*
343 __gss_find_upcall(struct rpc_pipe
*pipe
, kuid_t uid
)
345 struct gss_upcall_msg
*pos
;
346 list_for_each_entry(pos
, &pipe
->in_downcall
, list
) {
347 if (!uid_eq(pos
->uid
, uid
))
349 atomic_inc(&pos
->count
);
350 dprintk("RPC: %s found msg %p\n", __func__
, pos
);
353 dprintk("RPC: %s found nothing\n", __func__
);
357 /* Try to add an upcall to the pipefs queue.
358 * If an upcall owned by our uid already exists, then we return a reference
359 * to that upcall instead of adding the new upcall.
361 static inline struct gss_upcall_msg
*
362 gss_add_msg(struct gss_upcall_msg
*gss_msg
)
364 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
365 struct gss_upcall_msg
*old
;
367 spin_lock(&pipe
->lock
);
368 old
= __gss_find_upcall(pipe
, gss_msg
->uid
);
370 atomic_inc(&gss_msg
->count
);
371 list_add(&gss_msg
->list
, &pipe
->in_downcall
);
374 spin_unlock(&pipe
->lock
);
379 __gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
381 list_del_init(&gss_msg
->list
);
382 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
383 wake_up_all(&gss_msg
->waitqueue
);
384 atomic_dec(&gss_msg
->count
);
388 gss_unhash_msg(struct gss_upcall_msg
*gss_msg
)
390 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
392 if (list_empty(&gss_msg
->list
))
394 spin_lock(&pipe
->lock
);
395 if (!list_empty(&gss_msg
->list
))
396 __gss_unhash_msg(gss_msg
);
397 spin_unlock(&pipe
->lock
);
401 gss_handle_downcall_result(struct gss_cred
*gss_cred
, struct gss_upcall_msg
*gss_msg
)
403 switch (gss_msg
->msg
.errno
) {
405 if (gss_msg
->ctx
== NULL
)
407 clear_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
408 gss_cred_set_ctx(&gss_cred
->gc_base
, gss_msg
->ctx
);
411 set_bit(RPCAUTH_CRED_NEGATIVE
, &gss_cred
->gc_base
.cr_flags
);
413 gss_cred
->gc_upcall_timestamp
= jiffies
;
414 gss_cred
->gc_upcall
= NULL
;
415 rpc_wake_up_status(&gss_msg
->rpc_waitqueue
, gss_msg
->msg
.errno
);
419 gss_upcall_callback(struct rpc_task
*task
)
421 struct gss_cred
*gss_cred
= container_of(task
->tk_rqstp
->rq_cred
,
422 struct gss_cred
, gc_base
);
423 struct gss_upcall_msg
*gss_msg
= gss_cred
->gc_upcall
;
424 struct rpc_pipe
*pipe
= gss_msg
->pipe
;
426 spin_lock(&pipe
->lock
);
427 gss_handle_downcall_result(gss_cred
, gss_msg
);
428 spin_unlock(&pipe
->lock
);
429 task
->tk_status
= gss_msg
->msg
.errno
;
430 gss_release_msg(gss_msg
);
433 static void gss_encode_v0_msg(struct gss_upcall_msg
*gss_msg
)
435 uid_t uid
= from_kuid(&init_user_ns
, gss_msg
->uid
);
436 memcpy(gss_msg
->databuf
, &uid
, sizeof(uid
));
437 gss_msg
->msg
.data
= gss_msg
->databuf
;
438 gss_msg
->msg
.len
= sizeof(uid
);
440 BUILD_BUG_ON(sizeof(uid
) > sizeof(gss_msg
->databuf
));
443 static int gss_encode_v1_msg(struct gss_upcall_msg
*gss_msg
,
444 const char *service_name
,
445 const char *target_name
)
447 struct gss_api_mech
*mech
= gss_msg
->auth
->mech
;
448 char *p
= gss_msg
->databuf
;
449 size_t buflen
= sizeof(gss_msg
->databuf
);
452 len
= scnprintf(p
, buflen
, "mech=%s uid=%d ", mech
->gm_name
,
453 from_kuid(&init_user_ns
, gss_msg
->uid
));
456 gss_msg
->msg
.len
= len
;
458 len
= scnprintf(p
, buflen
, "target=%s ", target_name
);
461 gss_msg
->msg
.len
+= len
;
463 if (service_name
!= NULL
) {
464 len
= scnprintf(p
, buflen
, "service=%s ", service_name
);
467 gss_msg
->msg
.len
+= len
;
469 if (mech
->gm_upcall_enctypes
) {
470 len
= scnprintf(p
, buflen
, "enctypes=%s ",
471 mech
->gm_upcall_enctypes
);
474 gss_msg
->msg
.len
+= len
;
476 len
= scnprintf(p
, buflen
, "\n");
479 gss_msg
->msg
.len
+= len
;
481 gss_msg
->msg
.data
= gss_msg
->databuf
;
488 static struct gss_upcall_msg
*
489 gss_alloc_msg(struct gss_auth
*gss_auth
,
490 kuid_t uid
, const char *service_name
)
492 struct gss_upcall_msg
*gss_msg
;
496 gss_msg
= kzalloc(sizeof(*gss_msg
), GFP_NOFS
);
499 vers
= get_pipe_version(gss_auth
->net
);
503 gss_msg
->pipe
= gss_auth
->gss_pipe
[vers
]->pipe
;
504 INIT_LIST_HEAD(&gss_msg
->list
);
505 rpc_init_wait_queue(&gss_msg
->rpc_waitqueue
, "RPCSEC_GSS upcall waitq");
506 init_waitqueue_head(&gss_msg
->waitqueue
);
507 atomic_set(&gss_msg
->count
, 1);
509 gss_msg
->auth
= gss_auth
;
512 gss_encode_v0_msg(gss_msg
);
515 err
= gss_encode_v1_msg(gss_msg
, service_name
, gss_auth
->target_name
);
517 goto err_put_pipe_version
;
519 kref_get(&gss_auth
->kref
);
521 err_put_pipe_version
:
522 put_pipe_version(gss_auth
->net
);
529 static struct gss_upcall_msg
*
530 gss_setup_upcall(struct gss_auth
*gss_auth
, struct rpc_cred
*cred
)
532 struct gss_cred
*gss_cred
= container_of(cred
,
533 struct gss_cred
, gc_base
);
534 struct gss_upcall_msg
*gss_new
, *gss_msg
;
535 kuid_t uid
= cred
->cr_uid
;
537 gss_new
= gss_alloc_msg(gss_auth
, uid
, gss_cred
->gc_principal
);
540 gss_msg
= gss_add_msg(gss_new
);
541 if (gss_msg
== gss_new
) {
542 int res
= rpc_queue_upcall(gss_new
->pipe
, &gss_new
->msg
);
544 gss_unhash_msg(gss_new
);
545 gss_msg
= ERR_PTR(res
);
548 gss_release_msg(gss_new
);
552 static void warn_gssd(void)
554 dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
558 gss_refresh_upcall(struct rpc_task
*task
)
560 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
561 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
,
562 struct gss_auth
, rpc_auth
);
563 struct gss_cred
*gss_cred
= container_of(cred
,
564 struct gss_cred
, gc_base
);
565 struct gss_upcall_msg
*gss_msg
;
566 struct rpc_pipe
*pipe
;
569 dprintk("RPC: %5u %s for uid %u\n",
570 task
->tk_pid
, __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
571 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
572 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
573 /* XXX: warning on the first, under the assumption we
574 * shouldn't normally hit this case on a refresh. */
576 task
->tk_timeout
= 15*HZ
;
577 rpc_sleep_on(&pipe_version_rpc_waitqueue
, task
, NULL
);
580 if (IS_ERR(gss_msg
)) {
581 err
= PTR_ERR(gss_msg
);
584 pipe
= gss_msg
->pipe
;
585 spin_lock(&pipe
->lock
);
586 if (gss_cred
->gc_upcall
!= NULL
)
587 rpc_sleep_on(&gss_cred
->gc_upcall
->rpc_waitqueue
, task
, NULL
);
588 else if (gss_msg
->ctx
== NULL
&& gss_msg
->msg
.errno
>= 0) {
589 task
->tk_timeout
= 0;
590 gss_cred
->gc_upcall
= gss_msg
;
591 /* gss_upcall_callback will release the reference to gss_upcall_msg */
592 atomic_inc(&gss_msg
->count
);
593 rpc_sleep_on(&gss_msg
->rpc_waitqueue
, task
, gss_upcall_callback
);
595 gss_handle_downcall_result(gss_cred
, gss_msg
);
596 err
= gss_msg
->msg
.errno
;
598 spin_unlock(&pipe
->lock
);
599 gss_release_msg(gss_msg
);
601 dprintk("RPC: %5u %s for uid %u result %d\n",
602 task
->tk_pid
, __func__
,
603 from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
608 gss_create_upcall(struct gss_auth
*gss_auth
, struct gss_cred
*gss_cred
)
610 struct net
*net
= gss_auth
->net
;
611 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
612 struct rpc_pipe
*pipe
;
613 struct rpc_cred
*cred
= &gss_cred
->gc_base
;
614 struct gss_upcall_msg
*gss_msg
;
618 dprintk("RPC: %s for uid %u\n",
619 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
622 /* if gssd is down, just skip upcalling altogether */
623 if (!gssd_running(net
)) {
627 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
628 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
629 err
= wait_event_interruptible_timeout(pipe_version_waitqueue
,
630 sn
->pipe_version
>= 0, 15 * HZ
);
631 if (sn
->pipe_version
< 0) {
639 if (IS_ERR(gss_msg
)) {
640 err
= PTR_ERR(gss_msg
);
643 pipe
= gss_msg
->pipe
;
645 prepare_to_wait(&gss_msg
->waitqueue
, &wait
, TASK_KILLABLE
);
646 spin_lock(&pipe
->lock
);
647 if (gss_msg
->ctx
!= NULL
|| gss_msg
->msg
.errno
< 0) {
650 spin_unlock(&pipe
->lock
);
651 if (fatal_signal_pending(current
)) {
658 gss_cred_set_ctx(cred
, gss_msg
->ctx
);
660 err
= gss_msg
->msg
.errno
;
661 spin_unlock(&pipe
->lock
);
663 finish_wait(&gss_msg
->waitqueue
, &wait
);
664 gss_release_msg(gss_msg
);
666 dprintk("RPC: %s for uid %u result %d\n",
667 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
671 #define MSG_BUF_MAXSIZE 1024
674 gss_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
678 struct gss_upcall_msg
*gss_msg
;
679 struct rpc_pipe
*pipe
= RPC_I(file_inode(filp
))->pipe
;
680 struct gss_cl_ctx
*ctx
;
683 ssize_t err
= -EFBIG
;
685 if (mlen
> MSG_BUF_MAXSIZE
)
688 buf
= kmalloc(mlen
, GFP_NOFS
);
693 if (copy_from_user(buf
, src
, mlen
))
696 end
= (const void *)((char *)buf
+ mlen
);
697 p
= simple_get_bytes(buf
, end
, &id
, sizeof(id
));
703 uid
= make_kuid(&init_user_ns
, id
);
704 if (!uid_valid(uid
)) {
710 ctx
= gss_alloc_context();
715 /* Find a matching upcall */
716 spin_lock(&pipe
->lock
);
717 gss_msg
= __gss_find_upcall(pipe
, uid
);
718 if (gss_msg
== NULL
) {
719 spin_unlock(&pipe
->lock
);
722 list_del_init(&gss_msg
->list
);
723 spin_unlock(&pipe
->lock
);
725 p
= gss_fill_context(p
, end
, ctx
, gss_msg
->auth
->mech
);
731 gss_msg
->msg
.errno
= err
;
738 gss_msg
->msg
.errno
= -EAGAIN
;
741 printk(KERN_CRIT
"%s: bad return from "
742 "gss_fill_context: %zd\n", __func__
, err
);
743 gss_msg
->msg
.errno
= -EIO
;
745 goto err_release_msg
;
747 gss_msg
->ctx
= gss_get_ctx(ctx
);
751 spin_lock(&pipe
->lock
);
752 __gss_unhash_msg(gss_msg
);
753 spin_unlock(&pipe
->lock
);
754 gss_release_msg(gss_msg
);
760 dprintk("RPC: %s returning %Zd\n", __func__
, err
);
764 static int gss_pipe_open(struct inode
*inode
, int new_version
)
766 struct net
*net
= inode
->i_sb
->s_fs_info
;
767 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
770 spin_lock(&pipe_version_lock
);
771 if (sn
->pipe_version
< 0) {
772 /* First open of any gss pipe determines the version: */
773 sn
->pipe_version
= new_version
;
774 rpc_wake_up(&pipe_version_rpc_waitqueue
);
775 wake_up(&pipe_version_waitqueue
);
776 } else if (sn
->pipe_version
!= new_version
) {
777 /* Trying to open a pipe of a different version */
781 atomic_inc(&sn
->pipe_users
);
783 spin_unlock(&pipe_version_lock
);
788 static int gss_pipe_open_v0(struct inode
*inode
)
790 return gss_pipe_open(inode
, 0);
793 static int gss_pipe_open_v1(struct inode
*inode
)
795 return gss_pipe_open(inode
, 1);
799 gss_pipe_release(struct inode
*inode
)
801 struct net
*net
= inode
->i_sb
->s_fs_info
;
802 struct rpc_pipe
*pipe
= RPC_I(inode
)->pipe
;
803 struct gss_upcall_msg
*gss_msg
;
806 spin_lock(&pipe
->lock
);
807 list_for_each_entry(gss_msg
, &pipe
->in_downcall
, list
) {
809 if (!list_empty(&gss_msg
->msg
.list
))
811 gss_msg
->msg
.errno
= -EPIPE
;
812 atomic_inc(&gss_msg
->count
);
813 __gss_unhash_msg(gss_msg
);
814 spin_unlock(&pipe
->lock
);
815 gss_release_msg(gss_msg
);
818 spin_unlock(&pipe
->lock
);
820 put_pipe_version(net
);
824 gss_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
826 struct gss_upcall_msg
*gss_msg
= container_of(msg
, struct gss_upcall_msg
, msg
);
828 if (msg
->errno
< 0) {
829 dprintk("RPC: %s releasing msg %p\n",
831 atomic_inc(&gss_msg
->count
);
832 gss_unhash_msg(gss_msg
);
833 if (msg
->errno
== -ETIMEDOUT
)
835 gss_release_msg(gss_msg
);
839 static void gss_pipe_dentry_destroy(struct dentry
*dir
,
840 struct rpc_pipe_dir_object
*pdo
)
842 struct gss_pipe
*gss_pipe
= pdo
->pdo_data
;
843 struct rpc_pipe
*pipe
= gss_pipe
->pipe
;
845 if (pipe
->dentry
!= NULL
) {
846 rpc_unlink(pipe
->dentry
);
851 static int gss_pipe_dentry_create(struct dentry
*dir
,
852 struct rpc_pipe_dir_object
*pdo
)
854 struct gss_pipe
*p
= pdo
->pdo_data
;
855 struct dentry
*dentry
;
857 dentry
= rpc_mkpipe_dentry(dir
, p
->name
, p
->clnt
, p
->pipe
);
859 return PTR_ERR(dentry
);
860 p
->pipe
->dentry
= dentry
;
864 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops
= {
865 .create
= gss_pipe_dentry_create
,
866 .destroy
= gss_pipe_dentry_destroy
,
869 static struct gss_pipe
*gss_pipe_alloc(struct rpc_clnt
*clnt
,
871 const struct rpc_pipe_ops
*upcall_ops
)
876 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
879 p
->pipe
= rpc_mkpipe_data(upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
880 if (IS_ERR(p
->pipe
)) {
881 err
= PTR_ERR(p
->pipe
);
882 goto err_free_gss_pipe
;
887 rpc_init_pipe_dir_object(&p
->pdo
,
888 &gss_pipe_dir_object_ops
,
897 struct gss_alloc_pdo
{
898 struct rpc_clnt
*clnt
;
900 const struct rpc_pipe_ops
*upcall_ops
;
903 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object
*pdo
, void *data
)
905 struct gss_pipe
*gss_pipe
;
906 struct gss_alloc_pdo
*args
= data
;
908 if (pdo
->pdo_ops
!= &gss_pipe_dir_object_ops
)
910 gss_pipe
= container_of(pdo
, struct gss_pipe
, pdo
);
911 if (strcmp(gss_pipe
->name
, args
->name
) != 0)
913 if (!kref_get_unless_zero(&gss_pipe
->kref
))
918 static struct rpc_pipe_dir_object
*gss_pipe_alloc_pdo(void *data
)
920 struct gss_pipe
*gss_pipe
;
921 struct gss_alloc_pdo
*args
= data
;
923 gss_pipe
= gss_pipe_alloc(args
->clnt
, args
->name
, args
->upcall_ops
);
924 if (!IS_ERR(gss_pipe
))
925 return &gss_pipe
->pdo
;
929 static struct gss_pipe
*gss_pipe_get(struct rpc_clnt
*clnt
,
931 const struct rpc_pipe_ops
*upcall_ops
)
933 struct net
*net
= rpc_net_ns(clnt
);
934 struct rpc_pipe_dir_object
*pdo
;
935 struct gss_alloc_pdo args
= {
938 .upcall_ops
= upcall_ops
,
941 pdo
= rpc_find_or_alloc_pipe_dir_object(net
,
942 &clnt
->cl_pipedir_objects
,
947 return container_of(pdo
, struct gss_pipe
, pdo
);
948 return ERR_PTR(-ENOMEM
);
951 static void __gss_pipe_free(struct gss_pipe
*p
)
953 struct rpc_clnt
*clnt
= p
->clnt
;
954 struct net
*net
= rpc_net_ns(clnt
);
956 rpc_remove_pipe_dir_object(net
,
957 &clnt
->cl_pipedir_objects
,
959 rpc_destroy_pipe_data(p
->pipe
);
963 static void __gss_pipe_release(struct kref
*kref
)
965 struct gss_pipe
*p
= container_of(kref
, struct gss_pipe
, kref
);
970 static void gss_pipe_free(struct gss_pipe
*p
)
973 kref_put(&p
->kref
, __gss_pipe_release
);
977 * NOTE: we have the opportunity to use different
978 * parameters based on the input flavor (which must be a pseudoflavor)
980 static struct gss_auth
*
981 gss_create_new(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
983 rpc_authflavor_t flavor
= args
->pseudoflavor
;
984 struct gss_auth
*gss_auth
;
985 struct gss_pipe
*gss_pipe
;
986 struct rpc_auth
* auth
;
987 int err
= -ENOMEM
; /* XXX? */
989 dprintk("RPC: creating GSS authenticator for client %p\n", clnt
);
991 if (!try_module_get(THIS_MODULE
))
993 if (!(gss_auth
= kmalloc(sizeof(*gss_auth
), GFP_KERNEL
)))
995 INIT_HLIST_NODE(&gss_auth
->hash
);
996 gss_auth
->target_name
= NULL
;
997 if (args
->target_name
) {
998 gss_auth
->target_name
= kstrdup(args
->target_name
, GFP_KERNEL
);
999 if (gss_auth
->target_name
== NULL
)
1002 gss_auth
->client
= clnt
;
1003 gss_auth
->net
= get_net(rpc_net_ns(clnt
));
1005 gss_auth
->mech
= gss_mech_get_by_pseudoflavor(flavor
);
1006 if (!gss_auth
->mech
) {
1007 dprintk("RPC: Pseudoflavor %d not found!\n", flavor
);
1010 gss_auth
->service
= gss_pseudoflavor_to_service(gss_auth
->mech
, flavor
);
1011 if (gss_auth
->service
== 0)
1013 if (!gssd_running(gss_auth
->net
))
1015 auth
= &gss_auth
->rpc_auth
;
1016 auth
->au_cslack
= GSS_CRED_SLACK
>> 2;
1017 auth
->au_rslack
= GSS_VERF_SLACK
>> 2;
1019 auth
->au_ops
= &authgss_ops
;
1020 auth
->au_flavor
= flavor
;
1021 if (gss_pseudoflavor_to_datatouch(gss_auth
->mech
, flavor
))
1022 auth
->au_flags
|= RPCAUTH_AUTH_DATATOUCH
;
1023 atomic_set(&auth
->au_count
, 1);
1024 kref_init(&gss_auth
->kref
);
1026 err
= rpcauth_init_credcache(auth
);
1030 * Note: if we created the old pipe first, then someone who
1031 * examined the directory at the right moment might conclude
1032 * that we supported only the old pipe. So we instead create
1033 * the new pipe first.
1035 gss_pipe
= gss_pipe_get(clnt
, "gssd", &gss_upcall_ops_v1
);
1036 if (IS_ERR(gss_pipe
)) {
1037 err
= PTR_ERR(gss_pipe
);
1038 goto err_destroy_credcache
;
1040 gss_auth
->gss_pipe
[1] = gss_pipe
;
1042 gss_pipe
= gss_pipe_get(clnt
, gss_auth
->mech
->gm_name
,
1043 &gss_upcall_ops_v0
);
1044 if (IS_ERR(gss_pipe
)) {
1045 err
= PTR_ERR(gss_pipe
);
1046 goto err_destroy_pipe_1
;
1048 gss_auth
->gss_pipe
[0] = gss_pipe
;
1052 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1053 err_destroy_credcache
:
1054 rpcauth_destroy_credcache(auth
);
1056 gss_mech_put(gss_auth
->mech
);
1058 put_net(gss_auth
->net
);
1060 kfree(gss_auth
->target_name
);
1063 module_put(THIS_MODULE
);
1064 return ERR_PTR(err
);
1068 gss_free(struct gss_auth
*gss_auth
)
1070 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1071 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1072 gss_mech_put(gss_auth
->mech
);
1073 put_net(gss_auth
->net
);
1074 kfree(gss_auth
->target_name
);
1077 module_put(THIS_MODULE
);
1081 gss_free_callback(struct kref
*kref
)
1083 struct gss_auth
*gss_auth
= container_of(kref
, struct gss_auth
, kref
);
1089 gss_put_auth(struct gss_auth
*gss_auth
)
1091 kref_put(&gss_auth
->kref
, gss_free_callback
);
1095 gss_destroy(struct rpc_auth
*auth
)
1097 struct gss_auth
*gss_auth
= container_of(auth
,
1098 struct gss_auth
, rpc_auth
);
1100 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1101 auth
, auth
->au_flavor
);
1103 if (hash_hashed(&gss_auth
->hash
)) {
1104 spin_lock(&gss_auth_hash_lock
);
1105 hash_del(&gss_auth
->hash
);
1106 spin_unlock(&gss_auth_hash_lock
);
1109 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1110 gss_auth
->gss_pipe
[0] = NULL
;
1111 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1112 gss_auth
->gss_pipe
[1] = NULL
;
1113 rpcauth_destroy_credcache(auth
);
1115 gss_put_auth(gss_auth
);
1119 * Auths may be shared between rpc clients that were cloned from a
1120 * common client with the same xprt, if they also share the flavor and
1123 * The auth is looked up from the oldest parent sharing the same
1124 * cl_xprt, and the auth itself references only that common parent
1125 * (which is guaranteed to last as long as any of its descendants).
1127 static struct gss_auth
*
1128 gss_auth_find_or_add_hashed(struct rpc_auth_create_args
*args
,
1129 struct rpc_clnt
*clnt
,
1130 struct gss_auth
*new)
1132 struct gss_auth
*gss_auth
;
1133 unsigned long hashval
= (unsigned long)clnt
;
1135 spin_lock(&gss_auth_hash_lock
);
1136 hash_for_each_possible(gss_auth_hash_table
,
1140 if (gss_auth
->client
!= clnt
)
1142 if (gss_auth
->rpc_auth
.au_flavor
!= args
->pseudoflavor
)
1144 if (gss_auth
->target_name
!= args
->target_name
) {
1145 if (gss_auth
->target_name
== NULL
)
1147 if (args
->target_name
== NULL
)
1149 if (strcmp(gss_auth
->target_name
, args
->target_name
))
1152 if (!atomic_inc_not_zero(&gss_auth
->rpc_auth
.au_count
))
1157 hash_add(gss_auth_hash_table
, &new->hash
, hashval
);
1160 spin_unlock(&gss_auth_hash_lock
);
1164 static struct gss_auth
*
1165 gss_create_hashed(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1167 struct gss_auth
*gss_auth
;
1168 struct gss_auth
*new;
1170 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, NULL
);
1171 if (gss_auth
!= NULL
)
1173 new = gss_create_new(args
, clnt
);
1176 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, new);
1177 if (gss_auth
!= new)
1178 gss_destroy(&new->rpc_auth
);
1183 static struct rpc_auth
*
1184 gss_create(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1186 struct gss_auth
*gss_auth
;
1187 struct rpc_xprt_switch
*xps
= rcu_access_pointer(clnt
->cl_xpi
.xpi_xpswitch
);
1189 while (clnt
!= clnt
->cl_parent
) {
1190 struct rpc_clnt
*parent
= clnt
->cl_parent
;
1191 /* Find the original parent for this transport */
1192 if (rcu_access_pointer(parent
->cl_xpi
.xpi_xpswitch
) != xps
)
1197 gss_auth
= gss_create_hashed(args
, clnt
);
1198 if (IS_ERR(gss_auth
))
1199 return ERR_CAST(gss_auth
);
1200 return &gss_auth
->rpc_auth
;
1204 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1205 * to the server with the GSS control procedure field set to
1206 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1207 * all RPCSEC_GSS state associated with that context.
1210 gss_destroying_context(struct rpc_cred
*cred
)
1212 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1213 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1214 struct gss_cl_ctx
*ctx
= rcu_dereference_protected(gss_cred
->gc_ctx
, 1);
1215 struct rpc_task
*task
;
1217 if (test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
) == 0)
1220 ctx
->gc_proc
= RPC_GSS_PROC_DESTROY
;
1221 cred
->cr_ops
= &gss_nullops
;
1223 /* Take a reference to ensure the cred will be destroyed either
1224 * by the RPC call or by the put_rpccred() below */
1227 task
= rpc_call_null(gss_auth
->client
, cred
, RPC_TASK_ASYNC
|RPC_TASK_SOFT
);
1235 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1236 * to create a new cred or context, so they check that things have been
1237 * allocated before freeing them. */
1239 gss_do_free_ctx(struct gss_cl_ctx
*ctx
)
1241 dprintk("RPC: %s\n", __func__
);
1243 gss_delete_sec_context(&ctx
->gc_gss_ctx
);
1244 kfree(ctx
->gc_wire_ctx
.data
);
1245 kfree(ctx
->gc_acceptor
.data
);
1250 gss_free_ctx_callback(struct rcu_head
*head
)
1252 struct gss_cl_ctx
*ctx
= container_of(head
, struct gss_cl_ctx
, gc_rcu
);
1253 gss_do_free_ctx(ctx
);
1257 gss_free_ctx(struct gss_cl_ctx
*ctx
)
1259 call_rcu(&ctx
->gc_rcu
, gss_free_ctx_callback
);
1263 gss_free_cred(struct gss_cred
*gss_cred
)
1265 dprintk("RPC: %s cred=%p\n", __func__
, gss_cred
);
1270 gss_free_cred_callback(struct rcu_head
*head
)
1272 struct gss_cred
*gss_cred
= container_of(head
, struct gss_cred
, gc_base
.cr_rcu
);
1273 gss_free_cred(gss_cred
);
1277 gss_destroy_nullcred(struct rpc_cred
*cred
)
1279 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1280 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1281 struct gss_cl_ctx
*ctx
= rcu_dereference_protected(gss_cred
->gc_ctx
, 1);
1283 RCU_INIT_POINTER(gss_cred
->gc_ctx
, NULL
);
1284 call_rcu(&cred
->cr_rcu
, gss_free_cred_callback
);
1287 gss_put_auth(gss_auth
);
1291 gss_destroy_cred(struct rpc_cred
*cred
)
1294 if (gss_destroying_context(cred
))
1296 gss_destroy_nullcred(cred
);
1300 * Lookup RPCSEC_GSS cred for the current process
1302 static struct rpc_cred
*
1303 gss_lookup_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1305 return rpcauth_lookup_credcache(auth
, acred
, flags
, GFP_NOFS
);
1308 static struct rpc_cred
*
1309 gss_create_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
, gfp_t gfp
)
1311 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1312 struct gss_cred
*cred
= NULL
;
1315 dprintk("RPC: %s for uid %d, flavor %d\n",
1316 __func__
, from_kuid(&init_user_ns
, acred
->uid
),
1319 if (!(cred
= kzalloc(sizeof(*cred
), gfp
)))
1322 rpcauth_init_cred(&cred
->gc_base
, acred
, auth
, &gss_credops
);
1324 * Note: in order to force a call to call_refresh(), we deliberately
1325 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1327 cred
->gc_base
.cr_flags
= 1UL << RPCAUTH_CRED_NEW
;
1328 cred
->gc_service
= gss_auth
->service
;
1329 cred
->gc_principal
= NULL
;
1330 if (acred
->machine_cred
)
1331 cred
->gc_principal
= acred
->principal
;
1332 kref_get(&gss_auth
->kref
);
1333 return &cred
->gc_base
;
1336 dprintk("RPC: %s failed with error %d\n", __func__
, err
);
1337 return ERR_PTR(err
);
1341 gss_cred_init(struct rpc_auth
*auth
, struct rpc_cred
*cred
)
1343 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1344 struct gss_cred
*gss_cred
= container_of(cred
,struct gss_cred
, gc_base
);
1348 err
= gss_create_upcall(gss_auth
, gss_cred
);
1349 } while (err
== -EAGAIN
);
1354 gss_stringify_acceptor(struct rpc_cred
*cred
)
1356 char *string
= NULL
;
1357 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1358 struct gss_cl_ctx
*ctx
;
1360 struct xdr_netobj
*acceptor
;
1363 ctx
= rcu_dereference(gss_cred
->gc_ctx
);
1367 len
= ctx
->gc_acceptor
.len
;
1370 /* no point if there's no string */
1374 string
= kmalloc(len
+ 1, GFP_KERNEL
);
1379 ctx
= rcu_dereference(gss_cred
->gc_ctx
);
1381 /* did the ctx disappear or was it replaced by one with no acceptor? */
1382 if (!ctx
|| !ctx
->gc_acceptor
.len
) {
1388 acceptor
= &ctx
->gc_acceptor
;
1391 * Did we find a new acceptor that's longer than the original? Allocate
1392 * a longer buffer and try again.
1394 if (len
< acceptor
->len
) {
1395 len
= acceptor
->len
;
1401 memcpy(string
, acceptor
->data
, acceptor
->len
);
1402 string
[acceptor
->len
] = '\0';
1409 * Returns -EACCES if GSS context is NULL or will expire within the
1410 * timeout (miliseconds)
1413 gss_key_timeout(struct rpc_cred
*rc
)
1415 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1416 struct gss_cl_ctx
*ctx
;
1417 unsigned long timeout
= jiffies
+ (gss_key_expire_timeo
* HZ
);
1421 ctx
= rcu_dereference(gss_cred
->gc_ctx
);
1422 if (!ctx
|| time_after(timeout
, ctx
->gc_expiry
))
1430 gss_match(struct auth_cred
*acred
, struct rpc_cred
*rc
, int flags
)
1432 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1433 struct gss_cl_ctx
*ctx
;
1436 if (test_bit(RPCAUTH_CRED_NEW
, &rc
->cr_flags
))
1438 /* Don't match with creds that have expired. */
1440 ctx
= rcu_dereference(gss_cred
->gc_ctx
);
1441 if (!ctx
|| time_after(jiffies
, ctx
->gc_expiry
)) {
1446 if (!test_bit(RPCAUTH_CRED_UPTODATE
, &rc
->cr_flags
))
1449 if (acred
->principal
!= NULL
) {
1450 if (gss_cred
->gc_principal
== NULL
)
1452 ret
= strcmp(acred
->principal
, gss_cred
->gc_principal
) == 0;
1455 if (gss_cred
->gc_principal
!= NULL
)
1457 ret
= uid_eq(rc
->cr_uid
, acred
->uid
);
1463 /* Notify acred users of GSS context expiration timeout */
1464 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
) &&
1465 (gss_key_timeout(rc
) != 0)) {
1466 /* test will now be done from generic cred */
1467 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
);
1468 /* tell NFS layer that key will expire soon */
1469 set_bit(RPC_CRED_KEY_EXPIRE_SOON
, &acred
->ac_flags
);
1475 * Marshal credentials.
1476 * Maybe we should keep a cached credential for performance reasons.
1479 gss_marshal(struct rpc_task
*task
, __be32
*p
)
1481 struct rpc_rqst
*req
= task
->tk_rqstp
;
1482 struct rpc_cred
*cred
= req
->rq_cred
;
1483 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1485 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1488 struct xdr_netobj mic
;
1490 struct xdr_buf verf_buf
;
1492 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1494 *p
++ = htonl(RPC_AUTH_GSS
);
1497 spin_lock(&ctx
->gc_seq_lock
);
1498 req
->rq_seqno
= ctx
->gc_seq
++;
1499 spin_unlock(&ctx
->gc_seq_lock
);
1501 *p
++ = htonl((u32
) RPC_GSS_VERSION
);
1502 *p
++ = htonl((u32
) ctx
->gc_proc
);
1503 *p
++ = htonl((u32
) req
->rq_seqno
);
1504 *p
++ = htonl((u32
) gss_cred
->gc_service
);
1505 p
= xdr_encode_netobj(p
, &ctx
->gc_wire_ctx
);
1506 *cred_len
= htonl((p
- (cred_len
+ 1)) << 2);
1508 /* We compute the checksum for the verifier over the xdr-encoded bytes
1509 * starting with the xid and ending at the end of the credential: */
1510 iov
.iov_base
= xprt_skip_transport_header(req
->rq_xprt
,
1511 req
->rq_snd_buf
.head
[0].iov_base
);
1512 iov
.iov_len
= (u8
*)p
- (u8
*)iov
.iov_base
;
1513 xdr_buf_from_iov(&iov
, &verf_buf
);
1515 /* set verifier flavor*/
1516 *p
++ = htonl(RPC_AUTH_GSS
);
1518 mic
.data
= (u8
*)(p
+ 1);
1519 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1520 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
) {
1521 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1522 } else if (maj_stat
!= 0) {
1523 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat
);
1526 p
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1534 static int gss_renew_cred(struct rpc_task
*task
)
1536 struct rpc_cred
*oldcred
= task
->tk_rqstp
->rq_cred
;
1537 struct gss_cred
*gss_cred
= container_of(oldcred
,
1540 struct rpc_auth
*auth
= oldcred
->cr_auth
;
1541 struct auth_cred acred
= {
1542 .uid
= oldcred
->cr_uid
,
1543 .principal
= gss_cred
->gc_principal
,
1544 .machine_cred
= (gss_cred
->gc_principal
!= NULL
? 1 : 0),
1546 struct rpc_cred
*new;
1548 new = gss_lookup_cred(auth
, &acred
, RPCAUTH_LOOKUP_NEW
);
1550 return PTR_ERR(new);
1551 task
->tk_rqstp
->rq_cred
= new;
1552 put_rpccred(oldcred
);
1556 static int gss_cred_is_negative_entry(struct rpc_cred
*cred
)
1558 if (test_bit(RPCAUTH_CRED_NEGATIVE
, &cred
->cr_flags
)) {
1559 unsigned long now
= jiffies
;
1560 unsigned long begin
, expire
;
1561 struct gss_cred
*gss_cred
;
1563 gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1564 begin
= gss_cred
->gc_upcall_timestamp
;
1565 expire
= begin
+ gss_expired_cred_retry_delay
* HZ
;
1567 if (time_in_range_open(now
, begin
, expire
))
1574 * Refresh credentials. XXX - finish
1577 gss_refresh(struct rpc_task
*task
)
1579 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1582 if (gss_cred_is_negative_entry(cred
))
1583 return -EKEYEXPIRED
;
1585 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
) &&
1586 !test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
)) {
1587 ret
= gss_renew_cred(task
);
1590 cred
= task
->tk_rqstp
->rq_cred
;
1593 if (test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
1594 ret
= gss_refresh_upcall(task
);
1599 /* Dummy refresh routine: used only when destroying the context */
1601 gss_refresh_null(struct rpc_task
*task
)
1607 gss_validate(struct rpc_task
*task
, __be32
*p
)
1609 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1610 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1613 struct xdr_buf verf_buf
;
1614 struct xdr_netobj mic
;
1617 __be32
*ret
= ERR_PTR(-EIO
);
1619 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1622 if ((len
= ntohl(*p
++)) > RPC_MAX_AUTH_SIZE
)
1624 if (flav
!= RPC_AUTH_GSS
)
1626 seq
= htonl(task
->tk_rqstp
->rq_seqno
);
1627 iov
.iov_base
= &seq
;
1628 iov
.iov_len
= sizeof(seq
);
1629 xdr_buf_from_iov(&iov
, &verf_buf
);
1633 ret
= ERR_PTR(-EACCES
);
1634 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1635 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1636 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1638 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1639 task
->tk_pid
, __func__
, maj_stat
);
1642 /* We leave it to unwrap to calculate au_rslack. For now we just
1643 * calculate the length of the verifier: */
1644 cred
->cr_auth
->au_verfsize
= XDR_QUADLEN(len
) + 2;
1646 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1647 task
->tk_pid
, __func__
);
1648 return p
+ XDR_QUADLEN(len
);
1651 dprintk("RPC: %5u %s failed ret %ld.\n", task
->tk_pid
, __func__
,
1656 static void gss_wrap_req_encode(kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1657 __be32
*p
, void *obj
)
1659 struct xdr_stream xdr
;
1661 xdr_init_encode(&xdr
, &rqstp
->rq_snd_buf
, p
);
1662 encode(rqstp
, &xdr
, obj
);
1666 gss_wrap_req_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1667 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1668 __be32
*p
, void *obj
)
1670 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1671 struct xdr_buf integ_buf
;
1672 __be32
*integ_len
= NULL
;
1673 struct xdr_netobj mic
;
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 if (xdr_buf_subsegment(snd_buf
, &integ_buf
,
1687 offset
, snd_buf
->len
- offset
))
1689 *integ_len
= htonl(integ_buf
.len
);
1691 /* guess whether we're in the head or the tail: */
1692 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1693 iov
= snd_buf
->tail
;
1695 iov
= snd_buf
->head
;
1696 p
= iov
->iov_base
+ iov
->iov_len
;
1697 mic
.data
= (u8
*)(p
+ 1);
1699 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1700 status
= -EIO
; /* XXX? */
1701 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1702 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1705 q
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1707 offset
= (u8
*)q
- (u8
*)p
;
1708 iov
->iov_len
+= offset
;
1709 snd_buf
->len
+= offset
;
1714 priv_release_snd_buf(struct rpc_rqst
*rqstp
)
1718 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++)
1719 __free_page(rqstp
->rq_enc_pages
[i
]);
1720 kfree(rqstp
->rq_enc_pages
);
1724 alloc_enc_pages(struct rpc_rqst
*rqstp
)
1726 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1729 if (snd_buf
->page_len
== 0) {
1730 rqstp
->rq_enc_pages_num
= 0;
1734 first
= snd_buf
->page_base
>> PAGE_SHIFT
;
1735 last
= (snd_buf
->page_base
+ snd_buf
->page_len
- 1) >> PAGE_SHIFT
;
1736 rqstp
->rq_enc_pages_num
= last
- first
+ 1 + 1;
1738 = kmalloc(rqstp
->rq_enc_pages_num
* sizeof(struct page
*),
1740 if (!rqstp
->rq_enc_pages
)
1742 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++) {
1743 rqstp
->rq_enc_pages
[i
] = alloc_page(GFP_NOFS
);
1744 if (rqstp
->rq_enc_pages
[i
] == NULL
)
1747 rqstp
->rq_release_snd_buf
= priv_release_snd_buf
;
1750 rqstp
->rq_enc_pages_num
= i
;
1751 priv_release_snd_buf(rqstp
);
1757 gss_wrap_req_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1758 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1759 __be32
*p
, void *obj
)
1761 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1766 struct page
**inpages
;
1773 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1774 *p
++ = htonl(rqstp
->rq_seqno
);
1776 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1778 status
= alloc_enc_pages(rqstp
);
1781 first
= snd_buf
->page_base
>> PAGE_SHIFT
;
1782 inpages
= snd_buf
->pages
+ first
;
1783 snd_buf
->pages
= rqstp
->rq_enc_pages
;
1784 snd_buf
->page_base
-= first
<< PAGE_SHIFT
;
1786 * Give the tail its own page, in case we need extra space in the
1787 * head when wrapping:
1789 * call_allocate() allocates twice the slack space required
1790 * by the authentication flavor to rq_callsize.
1791 * For GSS, slack is GSS_CRED_SLACK.
1793 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
) {
1794 tmp
= page_address(rqstp
->rq_enc_pages
[rqstp
->rq_enc_pages_num
- 1]);
1795 memcpy(tmp
, snd_buf
->tail
[0].iov_base
, snd_buf
->tail
[0].iov_len
);
1796 snd_buf
->tail
[0].iov_base
= tmp
;
1798 maj_stat
= gss_wrap(ctx
->gc_gss_ctx
, offset
, snd_buf
, inpages
);
1799 /* slack space should prevent this ever happening: */
1800 BUG_ON(snd_buf
->len
> snd_buf
->buflen
);
1802 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1803 * done anyway, so it's safe to put the request on the wire: */
1804 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1805 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1809 *opaque_len
= htonl(snd_buf
->len
- offset
);
1810 /* guess whether we're in the head or the tail: */
1811 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1812 iov
= snd_buf
->tail
;
1814 iov
= snd_buf
->head
;
1815 p
= iov
->iov_base
+ iov
->iov_len
;
1816 pad
= 3 - ((snd_buf
->len
- offset
- 1) & 3);
1818 iov
->iov_len
+= pad
;
1819 snd_buf
->len
+= pad
;
1825 gss_wrap_req(struct rpc_task
*task
,
1826 kxdreproc_t encode
, void *rqstp
, __be32
*p
, void *obj
)
1828 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1829 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1831 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1834 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1835 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
) {
1836 /* The spec seems a little ambiguous here, but I think that not
1837 * wrapping context destruction requests makes the most sense.
1839 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1843 switch (gss_cred
->gc_service
) {
1844 case RPC_GSS_SVC_NONE
:
1845 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1848 case RPC_GSS_SVC_INTEGRITY
:
1849 status
= gss_wrap_req_integ(cred
, ctx
, encode
, rqstp
, p
, obj
);
1851 case RPC_GSS_SVC_PRIVACY
:
1852 status
= gss_wrap_req_priv(cred
, ctx
, encode
, rqstp
, p
, obj
);
1857 dprintk("RPC: %5u %s returning %d\n", task
->tk_pid
, __func__
, status
);
1862 gss_unwrap_resp_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1863 struct rpc_rqst
*rqstp
, __be32
**p
)
1865 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1866 struct xdr_buf integ_buf
;
1867 struct xdr_netobj mic
;
1868 u32 data_offset
, mic_offset
;
1873 integ_len
= ntohl(*(*p
)++);
1876 data_offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1877 mic_offset
= integ_len
+ data_offset
;
1878 if (mic_offset
> rcv_buf
->len
)
1880 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1883 if (xdr_buf_subsegment(rcv_buf
, &integ_buf
, data_offset
,
1884 mic_offset
- data_offset
))
1887 if (xdr_buf_read_netobj(rcv_buf
, &mic
, mic_offset
))
1890 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1891 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1892 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1893 if (maj_stat
!= GSS_S_COMPLETE
)
1899 gss_unwrap_resp_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1900 struct rpc_rqst
*rqstp
, __be32
**p
)
1902 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1908 opaque_len
= ntohl(*(*p
)++);
1909 offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1910 if (offset
+ opaque_len
> rcv_buf
->len
)
1912 /* remove padding: */
1913 rcv_buf
->len
= offset
+ opaque_len
;
1915 maj_stat
= gss_unwrap(ctx
->gc_gss_ctx
, offset
, rcv_buf
);
1916 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1917 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1918 if (maj_stat
!= GSS_S_COMPLETE
)
1920 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1927 gss_unwrap_req_decode(kxdrdproc_t decode
, struct rpc_rqst
*rqstp
,
1928 __be32
*p
, void *obj
)
1930 struct xdr_stream xdr
;
1932 xdr_init_decode(&xdr
, &rqstp
->rq_rcv_buf
, p
);
1933 return decode(rqstp
, &xdr
, obj
);
1937 gss_unwrap_resp(struct rpc_task
*task
,
1938 kxdrdproc_t decode
, void *rqstp
, __be32
*p
, void *obj
)
1940 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1941 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1943 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1945 struct kvec
*head
= ((struct rpc_rqst
*)rqstp
)->rq_rcv_buf
.head
;
1946 int savedlen
= head
->iov_len
;
1949 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
)
1951 switch (gss_cred
->gc_service
) {
1952 case RPC_GSS_SVC_NONE
:
1954 case RPC_GSS_SVC_INTEGRITY
:
1955 status
= gss_unwrap_resp_integ(cred
, ctx
, rqstp
, &p
);
1959 case RPC_GSS_SVC_PRIVACY
:
1960 status
= gss_unwrap_resp_priv(cred
, ctx
, rqstp
, &p
);
1965 /* take into account extra slack for integrity and privacy cases: */
1966 cred
->cr_auth
->au_rslack
= cred
->cr_auth
->au_verfsize
+ (p
- savedp
)
1967 + (savedlen
- head
->iov_len
);
1969 status
= gss_unwrap_req_decode(decode
, rqstp
, p
, obj
);
1972 dprintk("RPC: %5u %s returning %d\n",
1973 task
->tk_pid
, __func__
, status
);
1977 static const struct rpc_authops authgss_ops
= {
1978 .owner
= THIS_MODULE
,
1979 .au_flavor
= RPC_AUTH_GSS
,
1980 .au_name
= "RPCSEC_GSS",
1981 .create
= gss_create
,
1982 .destroy
= gss_destroy
,
1983 .lookup_cred
= gss_lookup_cred
,
1984 .crcreate
= gss_create_cred
,
1985 .list_pseudoflavors
= gss_mech_list_pseudoflavors
,
1986 .info2flavor
= gss_mech_info2flavor
,
1987 .flavor2info
= gss_mech_flavor2info
,
1990 static const struct rpc_credops gss_credops
= {
1991 .cr_name
= "AUTH_GSS",
1992 .crdestroy
= gss_destroy_cred
,
1993 .cr_init
= gss_cred_init
,
1994 .crbind
= rpcauth_generic_bind_cred
,
1995 .crmatch
= gss_match
,
1996 .crmarshal
= gss_marshal
,
1997 .crrefresh
= gss_refresh
,
1998 .crvalidate
= gss_validate
,
1999 .crwrap_req
= gss_wrap_req
,
2000 .crunwrap_resp
= gss_unwrap_resp
,
2001 .crkey_timeout
= gss_key_timeout
,
2002 .crstringify_acceptor
= gss_stringify_acceptor
,
2005 static const struct rpc_credops gss_nullops
= {
2006 .cr_name
= "AUTH_GSS",
2007 .crdestroy
= gss_destroy_nullcred
,
2008 .crbind
= rpcauth_generic_bind_cred
,
2009 .crmatch
= gss_match
,
2010 .crmarshal
= gss_marshal
,
2011 .crrefresh
= gss_refresh_null
,
2012 .crvalidate
= gss_validate
,
2013 .crwrap_req
= gss_wrap_req
,
2014 .crunwrap_resp
= gss_unwrap_resp
,
2015 .crstringify_acceptor
= gss_stringify_acceptor
,
2018 static const struct rpc_pipe_ops gss_upcall_ops_v0
= {
2019 .upcall
= rpc_pipe_generic_upcall
,
2020 .downcall
= gss_pipe_downcall
,
2021 .destroy_msg
= gss_pipe_destroy_msg
,
2022 .open_pipe
= gss_pipe_open_v0
,
2023 .release_pipe
= gss_pipe_release
,
2026 static const struct rpc_pipe_ops gss_upcall_ops_v1
= {
2027 .upcall
= rpc_pipe_generic_upcall
,
2028 .downcall
= gss_pipe_downcall
,
2029 .destroy_msg
= gss_pipe_destroy_msg
,
2030 .open_pipe
= gss_pipe_open_v1
,
2031 .release_pipe
= gss_pipe_release
,
2034 static __net_init
int rpcsec_gss_init_net(struct net
*net
)
2036 return gss_svc_init_net(net
);
2039 static __net_exit
void rpcsec_gss_exit_net(struct net
*net
)
2041 gss_svc_shutdown_net(net
);
2044 static struct pernet_operations rpcsec_gss_net_ops
= {
2045 .init
= rpcsec_gss_init_net
,
2046 .exit
= rpcsec_gss_exit_net
,
2050 * Initialize RPCSEC_GSS module
2052 static int __init
init_rpcsec_gss(void)
2056 err
= rpcauth_register(&authgss_ops
);
2059 err
= gss_svc_init();
2061 goto out_unregister
;
2062 err
= register_pernet_subsys(&rpcsec_gss_net_ops
);
2065 rpc_init_wait_queue(&pipe_version_rpc_waitqueue
, "gss pipe version");
2070 rpcauth_unregister(&authgss_ops
);
2075 static void __exit
exit_rpcsec_gss(void)
2077 unregister_pernet_subsys(&rpcsec_gss_net_ops
);
2079 rpcauth_unregister(&authgss_ops
);
2080 rcu_barrier(); /* Wait for completion of call_rcu()'s */
2083 MODULE_ALIAS("rpc-auth-6");
2084 MODULE_LICENSE("GPL");
2085 module_param_named(expired_cred_retry_delay
,
2086 gss_expired_cred_retry_delay
,
2088 MODULE_PARM_DESC(expired_cred_retry_delay
, "Timeout (in seconds) until "
2089 "the RPC engine retries an expired credential");
2091 module_param_named(key_expire_timeo
,
2092 gss_key_expire_timeo
,
2094 MODULE_PARM_DESC(key_expire_timeo
, "Time (in seconds) at the end of a "
2095 "credential keys lifetime where the NFS layer cleans up "
2096 "prior to key expiration");
2098 module_init(init_rpcsec_gss
)
2099 module_exit(exit_rpcsec_gss
)