2 * linux/net/sunrpc/auth_gss/auth_gss.c
4 * RPCSEC_GSS client authentication.
6 * Copyright (c) 2000 The Regents of the University of Michigan.
9 * Dug Song <dugsong@monkey.org>
10 * Andy Adamson <andros@umich.edu>
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. Neither the name of the University nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
26 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
27 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/types.h>
42 #include <linux/slab.h>
43 #include <linux/sched.h>
44 #include <linux/pagemap.h>
45 #include <linux/sunrpc/clnt.h>
46 #include <linux/sunrpc/auth.h>
47 #include <linux/sunrpc/auth_gss.h>
48 #include <linux/sunrpc/svcauth_gss.h>
49 #include <linux/sunrpc/gss_err.h>
50 #include <linux/workqueue.h>
51 #include <linux/sunrpc/rpc_pipe_fs.h>
52 #include <linux/sunrpc/gss_api.h>
53 #include <asm/uaccess.h>
54 #include <linux/hashtable.h>
58 static const struct rpc_authops authgss_ops
;
60 static const struct rpc_credops gss_credops
;
61 static const struct rpc_credops gss_nullops
;
63 #define GSS_RETRY_EXPIRED 5
64 static unsigned int gss_expired_cred_retry_delay
= GSS_RETRY_EXPIRED
;
66 #define GSS_KEY_EXPIRE_TIMEO 240
67 static unsigned int gss_key_expire_timeo
= GSS_KEY_EXPIRE_TIMEO
;
70 # define RPCDBG_FACILITY RPCDBG_AUTH
73 #define GSS_CRED_SLACK (RPC_MAX_AUTH_SIZE * 2)
74 /* length of a krb5 verifier (48), plus data added before arguments when
75 * using integrity (two 4-byte integers): */
76 #define GSS_VERF_SLACK 100
78 static DEFINE_HASHTABLE(gss_auth_hash_table
, 4);
79 static DEFINE_SPINLOCK(gss_auth_hash_lock
);
82 struct rpc_pipe_dir_object pdo
;
83 struct rpc_pipe
*pipe
;
84 struct rpc_clnt
*clnt
;
91 struct hlist_node hash
;
92 struct rpc_auth rpc_auth
;
93 struct gss_api_mech
*mech
;
94 enum rpc_gss_svc service
;
95 struct rpc_clnt
*client
;
98 * There are two upcall pipes; dentry[1], named "gssd", is used
99 * for the new text-based upcall; dentry[0] is named after the
100 * mechanism (for example, "krb5") and exists for
101 * backwards-compatibility with older gssd's.
103 struct gss_pipe
*gss_pipe
[2];
104 const char *target_name
;
107 /* pipe_version >= 0 if and only if someone has a pipe open. */
108 static DEFINE_SPINLOCK(pipe_version_lock
);
109 static struct rpc_wait_queue pipe_version_rpc_waitqueue
;
110 static DECLARE_WAIT_QUEUE_HEAD(pipe_version_waitqueue
);
111 static void gss_put_auth(struct gss_auth
*gss_auth
);
113 static void gss_free_ctx(struct gss_cl_ctx
*);
114 static const struct rpc_pipe_ops gss_upcall_ops_v0
;
115 static const struct rpc_pipe_ops gss_upcall_ops_v1
;
117 static inline struct gss_cl_ctx
*
118 gss_get_ctx(struct gss_cl_ctx
*ctx
)
120 atomic_inc(&ctx
->count
);
125 gss_put_ctx(struct gss_cl_ctx
*ctx
)
127 if (atomic_dec_and_test(&ctx
->count
))
132 * called by gss_upcall_callback and gss_create_upcall in order
133 * to set the gss context. The actual exchange of an old context
134 * and a new one is protected by the pipe->lock.
137 gss_cred_set_ctx(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
)
139 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
141 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
144 rcu_assign_pointer(gss_cred
->gc_ctx
, ctx
);
145 set_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
146 smp_mb__before_atomic();
147 clear_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
);
151 simple_get_bytes(const void *p
, const void *end
, void *res
, size_t len
)
153 const void *q
= (const void *)((const char *)p
+ len
);
154 if (unlikely(q
> end
|| q
< p
))
155 return ERR_PTR(-EFAULT
);
160 static inline const void *
161 simple_get_netobj(const void *p
, const void *end
, struct xdr_netobj
*dest
)
166 p
= simple_get_bytes(p
, end
, &len
, sizeof(len
));
169 q
= (const void *)((const char *)p
+ len
);
170 if (unlikely(q
> end
|| q
< p
))
171 return ERR_PTR(-EFAULT
);
172 dest
->data
= kmemdup(p
, len
, GFP_NOFS
);
173 if (unlikely(dest
->data
== NULL
))
174 return ERR_PTR(-ENOMEM
);
179 static struct gss_cl_ctx
*
180 gss_cred_get_ctx(struct rpc_cred
*cred
)
182 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
183 struct gss_cl_ctx
*ctx
= NULL
;
186 if (gss_cred
->gc_ctx
)
187 ctx
= gss_get_ctx(gss_cred
->gc_ctx
);
192 static struct gss_cl_ctx
*
193 gss_alloc_context(void)
195 struct gss_cl_ctx
*ctx
;
197 ctx
= kzalloc(sizeof(*ctx
), GFP_NOFS
);
199 ctx
->gc_proc
= RPC_GSS_PROC_DATA
;
200 ctx
->gc_seq
= 1; /* NetApp 6.4R1 doesn't accept seq. no. 0 */
201 spin_lock_init(&ctx
->gc_seq_lock
);
202 atomic_set(&ctx
->count
,1);
207 #define GSSD_MIN_TIMEOUT (60 * 60)
209 gss_fill_context(const void *p
, const void *end
, struct gss_cl_ctx
*ctx
, struct gss_api_mech
*gm
)
213 unsigned int timeout
;
214 unsigned long now
= jiffies
;
218 /* First unsigned int gives the remaining lifetime in seconds of the
219 * credential - e.g. the remaining TGT lifetime for Kerberos or
220 * the -t value passed to GSSD.
222 p
= simple_get_bytes(p
, end
, &timeout
, sizeof(timeout
));
226 timeout
= GSSD_MIN_TIMEOUT
;
227 ctx
->gc_expiry
= now
+ ((unsigned long)timeout
* HZ
);
228 /* Sequence number window. Determines the maximum number of
229 * simultaneous requests
231 p
= simple_get_bytes(p
, end
, &window_size
, sizeof(window_size
));
234 ctx
->gc_win
= window_size
;
235 /* gssd signals an error by passing ctx->gc_win = 0: */
236 if (ctx
->gc_win
== 0) {
238 * in which case, p points to an error code. Anything other
239 * than -EKEYEXPIRED gets converted to -EACCES.
241 p
= simple_get_bytes(p
, end
, &ret
, sizeof(ret
));
243 p
= (ret
== -EKEYEXPIRED
) ? ERR_PTR(-EKEYEXPIRED
) :
247 /* copy the opaque wire context */
248 p
= simple_get_netobj(p
, end
, &ctx
->gc_wire_ctx
);
251 /* import the opaque security context */
252 p
= simple_get_bytes(p
, end
, &seclen
, sizeof(seclen
));
255 q
= (const void *)((const char *)p
+ seclen
);
256 if (unlikely(q
> end
|| q
< p
)) {
257 p
= ERR_PTR(-EFAULT
);
260 ret
= gss_import_sec_context(p
, seclen
, gm
, &ctx
->gc_gss_ctx
, NULL
, GFP_NOFS
);
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
);
426 BUILD_BUG_ON(sizeof(uid
) > sizeof(gss_msg
->databuf
));
429 static int gss_encode_v1_msg(struct gss_upcall_msg
*gss_msg
,
430 const char *service_name
,
431 const char *target_name
)
433 struct gss_api_mech
*mech
= gss_msg
->auth
->mech
;
434 char *p
= gss_msg
->databuf
;
435 size_t buflen
= sizeof(gss_msg
->databuf
);
438 len
= scnprintf(p
, buflen
, "mech=%s uid=%d ", mech
->gm_name
,
439 from_kuid(&init_user_ns
, gss_msg
->uid
));
442 gss_msg
->msg
.len
= len
;
444 len
= scnprintf(p
, buflen
, "target=%s ", target_name
);
447 gss_msg
->msg
.len
+= len
;
449 if (service_name
!= NULL
) {
450 len
= scnprintf(p
, buflen
, "service=%s ", service_name
);
453 gss_msg
->msg
.len
+= len
;
455 if (mech
->gm_upcall_enctypes
) {
456 len
= scnprintf(p
, buflen
, "enctypes=%s ",
457 mech
->gm_upcall_enctypes
);
460 gss_msg
->msg
.len
+= len
;
462 len
= scnprintf(p
, buflen
, "\n");
465 gss_msg
->msg
.len
+= len
;
467 gss_msg
->msg
.data
= gss_msg
->databuf
;
474 static struct gss_upcall_msg
*
475 gss_alloc_msg(struct gss_auth
*gss_auth
,
476 kuid_t uid
, const char *service_name
)
478 struct gss_upcall_msg
*gss_msg
;
482 gss_msg
= kzalloc(sizeof(*gss_msg
), GFP_NOFS
);
485 vers
= get_pipe_version(gss_auth
->net
);
489 gss_msg
->pipe
= gss_auth
->gss_pipe
[vers
]->pipe
;
490 INIT_LIST_HEAD(&gss_msg
->list
);
491 rpc_init_wait_queue(&gss_msg
->rpc_waitqueue
, "RPCSEC_GSS upcall waitq");
492 init_waitqueue_head(&gss_msg
->waitqueue
);
493 atomic_set(&gss_msg
->count
, 1);
495 gss_msg
->auth
= gss_auth
;
498 gss_encode_v0_msg(gss_msg
);
501 err
= gss_encode_v1_msg(gss_msg
, service_name
, gss_auth
->target_name
);
503 goto err_put_pipe_version
;
505 kref_get(&gss_auth
->kref
);
507 err_put_pipe_version
:
508 put_pipe_version(gss_auth
->net
);
515 static struct gss_upcall_msg
*
516 gss_setup_upcall(struct gss_auth
*gss_auth
, struct rpc_cred
*cred
)
518 struct gss_cred
*gss_cred
= container_of(cred
,
519 struct gss_cred
, gc_base
);
520 struct gss_upcall_msg
*gss_new
, *gss_msg
;
521 kuid_t uid
= cred
->cr_uid
;
523 gss_new
= gss_alloc_msg(gss_auth
, uid
, gss_cred
->gc_principal
);
526 gss_msg
= gss_add_msg(gss_new
);
527 if (gss_msg
== gss_new
) {
528 int res
= rpc_queue_upcall(gss_new
->pipe
, &gss_new
->msg
);
530 gss_unhash_msg(gss_new
);
531 gss_msg
= ERR_PTR(res
);
534 gss_release_msg(gss_new
);
538 static void warn_gssd(void)
540 dprintk("AUTH_GSS upcall failed. Please check user daemon is running.\n");
544 gss_refresh_upcall(struct rpc_task
*task
)
546 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
547 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
,
548 struct gss_auth
, rpc_auth
);
549 struct gss_cred
*gss_cred
= container_of(cred
,
550 struct gss_cred
, gc_base
);
551 struct gss_upcall_msg
*gss_msg
;
552 struct rpc_pipe
*pipe
;
555 dprintk("RPC: %5u %s for uid %u\n",
556 task
->tk_pid
, __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
557 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
558 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
559 /* XXX: warning on the first, under the assumption we
560 * shouldn't normally hit this case on a refresh. */
562 task
->tk_timeout
= 15*HZ
;
563 rpc_sleep_on(&pipe_version_rpc_waitqueue
, task
, NULL
);
566 if (IS_ERR(gss_msg
)) {
567 err
= PTR_ERR(gss_msg
);
570 pipe
= gss_msg
->pipe
;
571 spin_lock(&pipe
->lock
);
572 if (gss_cred
->gc_upcall
!= NULL
)
573 rpc_sleep_on(&gss_cred
->gc_upcall
->rpc_waitqueue
, task
, NULL
);
574 else if (gss_msg
->ctx
== NULL
&& gss_msg
->msg
.errno
>= 0) {
575 task
->tk_timeout
= 0;
576 gss_cred
->gc_upcall
= gss_msg
;
577 /* gss_upcall_callback will release the reference to gss_upcall_msg */
578 atomic_inc(&gss_msg
->count
);
579 rpc_sleep_on(&gss_msg
->rpc_waitqueue
, task
, gss_upcall_callback
);
581 gss_handle_downcall_result(gss_cred
, gss_msg
);
582 err
= gss_msg
->msg
.errno
;
584 spin_unlock(&pipe
->lock
);
585 gss_release_msg(gss_msg
);
587 dprintk("RPC: %5u %s for uid %u result %d\n",
588 task
->tk_pid
, __func__
,
589 from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
594 gss_create_upcall(struct gss_auth
*gss_auth
, struct gss_cred
*gss_cred
)
596 struct net
*net
= gss_auth
->net
;
597 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
598 struct rpc_pipe
*pipe
;
599 struct rpc_cred
*cred
= &gss_cred
->gc_base
;
600 struct gss_upcall_msg
*gss_msg
;
604 dprintk("RPC: %s for uid %u\n",
605 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
));
608 /* if gssd is down, just skip upcalling altogether */
609 if (!gssd_running(net
)) {
613 gss_msg
= gss_setup_upcall(gss_auth
, cred
);
614 if (PTR_ERR(gss_msg
) == -EAGAIN
) {
615 err
= wait_event_interruptible_timeout(pipe_version_waitqueue
,
616 sn
->pipe_version
>= 0, 15 * HZ
);
617 if (sn
->pipe_version
< 0) {
625 if (IS_ERR(gss_msg
)) {
626 err
= PTR_ERR(gss_msg
);
629 pipe
= gss_msg
->pipe
;
631 prepare_to_wait(&gss_msg
->waitqueue
, &wait
, TASK_KILLABLE
);
632 spin_lock(&pipe
->lock
);
633 if (gss_msg
->ctx
!= NULL
|| gss_msg
->msg
.errno
< 0) {
636 spin_unlock(&pipe
->lock
);
637 if (fatal_signal_pending(current
)) {
644 gss_cred_set_ctx(cred
, gss_msg
->ctx
);
646 err
= gss_msg
->msg
.errno
;
647 spin_unlock(&pipe
->lock
);
649 finish_wait(&gss_msg
->waitqueue
, &wait
);
650 gss_release_msg(gss_msg
);
652 dprintk("RPC: %s for uid %u result %d\n",
653 __func__
, from_kuid(&init_user_ns
, cred
->cr_uid
), err
);
657 #define MSG_BUF_MAXSIZE 1024
660 gss_pipe_downcall(struct file
*filp
, const char __user
*src
, size_t mlen
)
664 struct gss_upcall_msg
*gss_msg
;
665 struct rpc_pipe
*pipe
= RPC_I(file_inode(filp
))->pipe
;
666 struct gss_cl_ctx
*ctx
;
669 ssize_t err
= -EFBIG
;
671 if (mlen
> MSG_BUF_MAXSIZE
)
674 buf
= kmalloc(mlen
, GFP_NOFS
);
679 if (copy_from_user(buf
, src
, mlen
))
682 end
= (const void *)((char *)buf
+ mlen
);
683 p
= simple_get_bytes(buf
, end
, &id
, sizeof(id
));
689 uid
= make_kuid(&init_user_ns
, id
);
690 if (!uid_valid(uid
)) {
696 ctx
= gss_alloc_context();
701 /* Find a matching upcall */
702 spin_lock(&pipe
->lock
);
703 gss_msg
= __gss_find_upcall(pipe
, uid
);
704 if (gss_msg
== NULL
) {
705 spin_unlock(&pipe
->lock
);
708 list_del_init(&gss_msg
->list
);
709 spin_unlock(&pipe
->lock
);
711 p
= gss_fill_context(p
, end
, ctx
, gss_msg
->auth
->mech
);
717 gss_msg
->msg
.errno
= err
;
724 gss_msg
->msg
.errno
= -EAGAIN
;
727 printk(KERN_CRIT
"%s: bad return from "
728 "gss_fill_context: %zd\n", __func__
, err
);
731 goto err_release_msg
;
733 gss_msg
->ctx
= gss_get_ctx(ctx
);
737 spin_lock(&pipe
->lock
);
738 __gss_unhash_msg(gss_msg
);
739 spin_unlock(&pipe
->lock
);
740 gss_release_msg(gss_msg
);
746 dprintk("RPC: %s returning %Zd\n", __func__
, err
);
750 static int gss_pipe_open(struct inode
*inode
, int new_version
)
752 struct net
*net
= inode
->i_sb
->s_fs_info
;
753 struct sunrpc_net
*sn
= net_generic(net
, sunrpc_net_id
);
756 spin_lock(&pipe_version_lock
);
757 if (sn
->pipe_version
< 0) {
758 /* First open of any gss pipe determines the version: */
759 sn
->pipe_version
= new_version
;
760 rpc_wake_up(&pipe_version_rpc_waitqueue
);
761 wake_up(&pipe_version_waitqueue
);
762 } else if (sn
->pipe_version
!= new_version
) {
763 /* Trying to open a pipe of a different version */
767 atomic_inc(&sn
->pipe_users
);
769 spin_unlock(&pipe_version_lock
);
774 static int gss_pipe_open_v0(struct inode
*inode
)
776 return gss_pipe_open(inode
, 0);
779 static int gss_pipe_open_v1(struct inode
*inode
)
781 return gss_pipe_open(inode
, 1);
785 gss_pipe_release(struct inode
*inode
)
787 struct net
*net
= inode
->i_sb
->s_fs_info
;
788 struct rpc_pipe
*pipe
= RPC_I(inode
)->pipe
;
789 struct gss_upcall_msg
*gss_msg
;
792 spin_lock(&pipe
->lock
);
793 list_for_each_entry(gss_msg
, &pipe
->in_downcall
, list
) {
795 if (!list_empty(&gss_msg
->msg
.list
))
797 gss_msg
->msg
.errno
= -EPIPE
;
798 atomic_inc(&gss_msg
->count
);
799 __gss_unhash_msg(gss_msg
);
800 spin_unlock(&pipe
->lock
);
801 gss_release_msg(gss_msg
);
804 spin_unlock(&pipe
->lock
);
806 put_pipe_version(net
);
810 gss_pipe_destroy_msg(struct rpc_pipe_msg
*msg
)
812 struct gss_upcall_msg
*gss_msg
= container_of(msg
, struct gss_upcall_msg
, msg
);
814 if (msg
->errno
< 0) {
815 dprintk("RPC: %s releasing msg %p\n",
817 atomic_inc(&gss_msg
->count
);
818 gss_unhash_msg(gss_msg
);
819 if (msg
->errno
== -ETIMEDOUT
)
821 gss_release_msg(gss_msg
);
825 static void gss_pipe_dentry_destroy(struct dentry
*dir
,
826 struct rpc_pipe_dir_object
*pdo
)
828 struct gss_pipe
*gss_pipe
= pdo
->pdo_data
;
829 struct rpc_pipe
*pipe
= gss_pipe
->pipe
;
831 if (pipe
->dentry
!= NULL
) {
832 rpc_unlink(pipe
->dentry
);
837 static int gss_pipe_dentry_create(struct dentry
*dir
,
838 struct rpc_pipe_dir_object
*pdo
)
840 struct gss_pipe
*p
= pdo
->pdo_data
;
841 struct dentry
*dentry
;
843 dentry
= rpc_mkpipe_dentry(dir
, p
->name
, p
->clnt
, p
->pipe
);
845 return PTR_ERR(dentry
);
846 p
->pipe
->dentry
= dentry
;
850 static const struct rpc_pipe_dir_object_ops gss_pipe_dir_object_ops
= {
851 .create
= gss_pipe_dentry_create
,
852 .destroy
= gss_pipe_dentry_destroy
,
855 static struct gss_pipe
*gss_pipe_alloc(struct rpc_clnt
*clnt
,
857 const struct rpc_pipe_ops
*upcall_ops
)
862 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
865 p
->pipe
= rpc_mkpipe_data(upcall_ops
, RPC_PIPE_WAIT_FOR_OPEN
);
866 if (IS_ERR(p
->pipe
)) {
867 err
= PTR_ERR(p
->pipe
);
868 goto err_free_gss_pipe
;
873 rpc_init_pipe_dir_object(&p
->pdo
,
874 &gss_pipe_dir_object_ops
,
883 struct gss_alloc_pdo
{
884 struct rpc_clnt
*clnt
;
886 const struct rpc_pipe_ops
*upcall_ops
;
889 static int gss_pipe_match_pdo(struct rpc_pipe_dir_object
*pdo
, void *data
)
891 struct gss_pipe
*gss_pipe
;
892 struct gss_alloc_pdo
*args
= data
;
894 if (pdo
->pdo_ops
!= &gss_pipe_dir_object_ops
)
896 gss_pipe
= container_of(pdo
, struct gss_pipe
, pdo
);
897 if (strcmp(gss_pipe
->name
, args
->name
) != 0)
899 if (!kref_get_unless_zero(&gss_pipe
->kref
))
904 static struct rpc_pipe_dir_object
*gss_pipe_alloc_pdo(void *data
)
906 struct gss_pipe
*gss_pipe
;
907 struct gss_alloc_pdo
*args
= data
;
909 gss_pipe
= gss_pipe_alloc(args
->clnt
, args
->name
, args
->upcall_ops
);
910 if (!IS_ERR(gss_pipe
))
911 return &gss_pipe
->pdo
;
915 static struct gss_pipe
*gss_pipe_get(struct rpc_clnt
*clnt
,
917 const struct rpc_pipe_ops
*upcall_ops
)
919 struct net
*net
= rpc_net_ns(clnt
);
920 struct rpc_pipe_dir_object
*pdo
;
921 struct gss_alloc_pdo args
= {
924 .upcall_ops
= upcall_ops
,
927 pdo
= rpc_find_or_alloc_pipe_dir_object(net
,
928 &clnt
->cl_pipedir_objects
,
933 return container_of(pdo
, struct gss_pipe
, pdo
);
934 return ERR_PTR(-ENOMEM
);
937 static void __gss_pipe_free(struct gss_pipe
*p
)
939 struct rpc_clnt
*clnt
= p
->clnt
;
940 struct net
*net
= rpc_net_ns(clnt
);
942 rpc_remove_pipe_dir_object(net
,
943 &clnt
->cl_pipedir_objects
,
945 rpc_destroy_pipe_data(p
->pipe
);
949 static void __gss_pipe_release(struct kref
*kref
)
951 struct gss_pipe
*p
= container_of(kref
, struct gss_pipe
, kref
);
956 static void gss_pipe_free(struct gss_pipe
*p
)
959 kref_put(&p
->kref
, __gss_pipe_release
);
963 * NOTE: we have the opportunity to use different
964 * parameters based on the input flavor (which must be a pseudoflavor)
966 static struct gss_auth
*
967 gss_create_new(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
969 rpc_authflavor_t flavor
= args
->pseudoflavor
;
970 struct gss_auth
*gss_auth
;
971 struct gss_pipe
*gss_pipe
;
972 struct rpc_auth
* auth
;
973 int err
= -ENOMEM
; /* XXX? */
975 dprintk("RPC: creating GSS authenticator for client %p\n", clnt
);
977 if (!try_module_get(THIS_MODULE
))
979 if (!(gss_auth
= kmalloc(sizeof(*gss_auth
), GFP_KERNEL
)))
981 INIT_HLIST_NODE(&gss_auth
->hash
);
982 gss_auth
->target_name
= NULL
;
983 if (args
->target_name
) {
984 gss_auth
->target_name
= kstrdup(args
->target_name
, GFP_KERNEL
);
985 if (gss_auth
->target_name
== NULL
)
988 gss_auth
->client
= clnt
;
989 gss_auth
->net
= get_net(rpc_net_ns(clnt
));
991 gss_auth
->mech
= gss_mech_get_by_pseudoflavor(flavor
);
992 if (!gss_auth
->mech
) {
993 dprintk("RPC: Pseudoflavor %d not found!\n", flavor
);
996 gss_auth
->service
= gss_pseudoflavor_to_service(gss_auth
->mech
, flavor
);
997 if (gss_auth
->service
== 0)
999 if (!gssd_running(gss_auth
->net
))
1001 auth
= &gss_auth
->rpc_auth
;
1002 auth
->au_cslack
= GSS_CRED_SLACK
>> 2;
1003 auth
->au_rslack
= GSS_VERF_SLACK
>> 2;
1004 auth
->au_ops
= &authgss_ops
;
1005 auth
->au_flavor
= flavor
;
1006 atomic_set(&auth
->au_count
, 1);
1007 kref_init(&gss_auth
->kref
);
1009 err
= rpcauth_init_credcache(auth
);
1013 * Note: if we created the old pipe first, then someone who
1014 * examined the directory at the right moment might conclude
1015 * that we supported only the old pipe. So we instead create
1016 * the new pipe first.
1018 gss_pipe
= gss_pipe_get(clnt
, "gssd", &gss_upcall_ops_v1
);
1019 if (IS_ERR(gss_pipe
)) {
1020 err
= PTR_ERR(gss_pipe
);
1021 goto err_destroy_credcache
;
1023 gss_auth
->gss_pipe
[1] = gss_pipe
;
1025 gss_pipe
= gss_pipe_get(clnt
, gss_auth
->mech
->gm_name
,
1026 &gss_upcall_ops_v0
);
1027 if (IS_ERR(gss_pipe
)) {
1028 err
= PTR_ERR(gss_pipe
);
1029 goto err_destroy_pipe_1
;
1031 gss_auth
->gss_pipe
[0] = gss_pipe
;
1035 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1036 err_destroy_credcache
:
1037 rpcauth_destroy_credcache(auth
);
1039 gss_mech_put(gss_auth
->mech
);
1041 put_net(gss_auth
->net
);
1043 kfree(gss_auth
->target_name
);
1046 module_put(THIS_MODULE
);
1047 return ERR_PTR(err
);
1051 gss_free(struct gss_auth
*gss_auth
)
1053 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1054 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1055 gss_mech_put(gss_auth
->mech
);
1056 put_net(gss_auth
->net
);
1057 kfree(gss_auth
->target_name
);
1060 module_put(THIS_MODULE
);
1064 gss_free_callback(struct kref
*kref
)
1066 struct gss_auth
*gss_auth
= container_of(kref
, struct gss_auth
, kref
);
1072 gss_put_auth(struct gss_auth
*gss_auth
)
1074 kref_put(&gss_auth
->kref
, gss_free_callback
);
1078 gss_destroy(struct rpc_auth
*auth
)
1080 struct gss_auth
*gss_auth
= container_of(auth
,
1081 struct gss_auth
, rpc_auth
);
1083 dprintk("RPC: destroying GSS authenticator %p flavor %d\n",
1084 auth
, auth
->au_flavor
);
1086 if (hash_hashed(&gss_auth
->hash
)) {
1087 spin_lock(&gss_auth_hash_lock
);
1088 hash_del(&gss_auth
->hash
);
1089 spin_unlock(&gss_auth_hash_lock
);
1092 gss_pipe_free(gss_auth
->gss_pipe
[0]);
1093 gss_auth
->gss_pipe
[0] = NULL
;
1094 gss_pipe_free(gss_auth
->gss_pipe
[1]);
1095 gss_auth
->gss_pipe
[1] = NULL
;
1096 rpcauth_destroy_credcache(auth
);
1098 gss_put_auth(gss_auth
);
1102 * Auths may be shared between rpc clients that were cloned from a
1103 * common client with the same xprt, if they also share the flavor and
1106 * The auth is looked up from the oldest parent sharing the same
1107 * cl_xprt, and the auth itself references only that common parent
1108 * (which is guaranteed to last as long as any of its descendants).
1110 static struct gss_auth
*
1111 gss_auth_find_or_add_hashed(struct rpc_auth_create_args
*args
,
1112 struct rpc_clnt
*clnt
,
1113 struct gss_auth
*new)
1115 struct gss_auth
*gss_auth
;
1116 unsigned long hashval
= (unsigned long)clnt
;
1118 spin_lock(&gss_auth_hash_lock
);
1119 hash_for_each_possible(gss_auth_hash_table
,
1123 if (gss_auth
->client
!= clnt
)
1125 if (gss_auth
->rpc_auth
.au_flavor
!= args
->pseudoflavor
)
1127 if (gss_auth
->target_name
!= args
->target_name
) {
1128 if (gss_auth
->target_name
== NULL
)
1130 if (args
->target_name
== NULL
)
1132 if (strcmp(gss_auth
->target_name
, args
->target_name
))
1135 if (!atomic_inc_not_zero(&gss_auth
->rpc_auth
.au_count
))
1140 hash_add(gss_auth_hash_table
, &new->hash
, hashval
);
1143 spin_unlock(&gss_auth_hash_lock
);
1147 static struct gss_auth
*
1148 gss_create_hashed(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1150 struct gss_auth
*gss_auth
;
1151 struct gss_auth
*new;
1153 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, NULL
);
1154 if (gss_auth
!= NULL
)
1156 new = gss_create_new(args
, clnt
);
1159 gss_auth
= gss_auth_find_or_add_hashed(args
, clnt
, new);
1160 if (gss_auth
!= new)
1161 gss_destroy(&new->rpc_auth
);
1166 static struct rpc_auth
*
1167 gss_create(struct rpc_auth_create_args
*args
, struct rpc_clnt
*clnt
)
1169 struct gss_auth
*gss_auth
;
1170 struct rpc_xprt
*xprt
= rcu_access_pointer(clnt
->cl_xprt
);
1172 while (clnt
!= clnt
->cl_parent
) {
1173 struct rpc_clnt
*parent
= clnt
->cl_parent
;
1174 /* Find the original parent for this transport */
1175 if (rcu_access_pointer(parent
->cl_xprt
) != xprt
)
1180 gss_auth
= gss_create_hashed(args
, clnt
);
1181 if (IS_ERR(gss_auth
))
1182 return ERR_CAST(gss_auth
);
1183 return &gss_auth
->rpc_auth
;
1187 * gss_destroying_context will cause the RPCSEC_GSS to send a NULL RPC call
1188 * to the server with the GSS control procedure field set to
1189 * RPC_GSS_PROC_DESTROY. This should normally cause the server to release
1190 * all RPCSEC_GSS state associated with that context.
1193 gss_destroying_context(struct rpc_cred
*cred
)
1195 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1196 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1197 struct rpc_task
*task
;
1199 if (gss_cred
->gc_ctx
== NULL
||
1200 test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
) == 0)
1203 gss_cred
->gc_ctx
->gc_proc
= RPC_GSS_PROC_DESTROY
;
1204 cred
->cr_ops
= &gss_nullops
;
1206 /* Take a reference to ensure the cred will be destroyed either
1207 * by the RPC call or by the put_rpccred() below */
1210 task
= rpc_call_null(gss_auth
->client
, cred
, RPC_TASK_ASYNC
|RPC_TASK_SOFT
);
1218 /* gss_destroy_cred (and gss_free_ctx) are used to clean up after failure
1219 * to create a new cred or context, so they check that things have been
1220 * allocated before freeing them. */
1222 gss_do_free_ctx(struct gss_cl_ctx
*ctx
)
1224 dprintk("RPC: %s\n", __func__
);
1226 gss_delete_sec_context(&ctx
->gc_gss_ctx
);
1227 kfree(ctx
->gc_wire_ctx
.data
);
1232 gss_free_ctx_callback(struct rcu_head
*head
)
1234 struct gss_cl_ctx
*ctx
= container_of(head
, struct gss_cl_ctx
, gc_rcu
);
1235 gss_do_free_ctx(ctx
);
1239 gss_free_ctx(struct gss_cl_ctx
*ctx
)
1241 call_rcu(&ctx
->gc_rcu
, gss_free_ctx_callback
);
1245 gss_free_cred(struct gss_cred
*gss_cred
)
1247 dprintk("RPC: %s cred=%p\n", __func__
, gss_cred
);
1252 gss_free_cred_callback(struct rcu_head
*head
)
1254 struct gss_cred
*gss_cred
= container_of(head
, struct gss_cred
, gc_base
.cr_rcu
);
1255 gss_free_cred(gss_cred
);
1259 gss_destroy_nullcred(struct rpc_cred
*cred
)
1261 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1262 struct gss_auth
*gss_auth
= container_of(cred
->cr_auth
, struct gss_auth
, rpc_auth
);
1263 struct gss_cl_ctx
*ctx
= gss_cred
->gc_ctx
;
1265 RCU_INIT_POINTER(gss_cred
->gc_ctx
, NULL
);
1266 call_rcu(&cred
->cr_rcu
, gss_free_cred_callback
);
1269 gss_put_auth(gss_auth
);
1273 gss_destroy_cred(struct rpc_cred
*cred
)
1276 if (gss_destroying_context(cred
))
1278 gss_destroy_nullcred(cred
);
1282 * Lookup RPCSEC_GSS cred for the current process
1284 static struct rpc_cred
*
1285 gss_lookup_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1287 return rpcauth_lookup_credcache(auth
, acred
, flags
);
1290 static struct rpc_cred
*
1291 gss_create_cred(struct rpc_auth
*auth
, struct auth_cred
*acred
, int flags
)
1293 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1294 struct gss_cred
*cred
= NULL
;
1297 dprintk("RPC: %s for uid %d, flavor %d\n",
1298 __func__
, from_kuid(&init_user_ns
, acred
->uid
),
1301 if (!(cred
= kzalloc(sizeof(*cred
), GFP_NOFS
)))
1304 rpcauth_init_cred(&cred
->gc_base
, acred
, auth
, &gss_credops
);
1306 * Note: in order to force a call to call_refresh(), we deliberately
1307 * fail to flag the credential as RPCAUTH_CRED_UPTODATE.
1309 cred
->gc_base
.cr_flags
= 1UL << RPCAUTH_CRED_NEW
;
1310 cred
->gc_service
= gss_auth
->service
;
1311 cred
->gc_principal
= NULL
;
1312 if (acred
->machine_cred
)
1313 cred
->gc_principal
= acred
->principal
;
1314 kref_get(&gss_auth
->kref
);
1315 return &cred
->gc_base
;
1318 dprintk("RPC: %s failed with error %d\n", __func__
, err
);
1319 return ERR_PTR(err
);
1323 gss_cred_init(struct rpc_auth
*auth
, struct rpc_cred
*cred
)
1325 struct gss_auth
*gss_auth
= container_of(auth
, struct gss_auth
, rpc_auth
);
1326 struct gss_cred
*gss_cred
= container_of(cred
,struct gss_cred
, gc_base
);
1330 err
= gss_create_upcall(gss_auth
, gss_cred
);
1331 } while (err
== -EAGAIN
);
1336 * Returns -EACCES if GSS context is NULL or will expire within the
1337 * timeout (miliseconds)
1340 gss_key_timeout(struct rpc_cred
*rc
)
1342 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1343 unsigned long now
= jiffies
;
1344 unsigned long expire
;
1346 if (gss_cred
->gc_ctx
== NULL
)
1349 expire
= gss_cred
->gc_ctx
->gc_expiry
- (gss_key_expire_timeo
* HZ
);
1351 if (time_after(now
, expire
))
1357 gss_match(struct auth_cred
*acred
, struct rpc_cred
*rc
, int flags
)
1359 struct gss_cred
*gss_cred
= container_of(rc
, struct gss_cred
, gc_base
);
1362 if (test_bit(RPCAUTH_CRED_NEW
, &rc
->cr_flags
))
1364 /* Don't match with creds that have expired. */
1365 if (time_after(jiffies
, gss_cred
->gc_ctx
->gc_expiry
))
1367 if (!test_bit(RPCAUTH_CRED_UPTODATE
, &rc
->cr_flags
))
1370 if (acred
->principal
!= NULL
) {
1371 if (gss_cred
->gc_principal
== NULL
)
1373 ret
= strcmp(acred
->principal
, gss_cred
->gc_principal
) == 0;
1376 if (gss_cred
->gc_principal
!= NULL
)
1378 ret
= uid_eq(rc
->cr_uid
, acred
->uid
);
1384 /* Notify acred users of GSS context expiration timeout */
1385 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
) &&
1386 (gss_key_timeout(rc
) != 0)) {
1387 /* test will now be done from generic cred */
1388 test_and_clear_bit(RPC_CRED_NOTIFY_TIMEOUT
, &acred
->ac_flags
);
1389 /* tell NFS layer that key will expire soon */
1390 set_bit(RPC_CRED_KEY_EXPIRE_SOON
, &acred
->ac_flags
);
1396 * Marshal credentials.
1397 * Maybe we should keep a cached credential for performance reasons.
1400 gss_marshal(struct rpc_task
*task
, __be32
*p
)
1402 struct rpc_rqst
*req
= task
->tk_rqstp
;
1403 struct rpc_cred
*cred
= req
->rq_cred
;
1404 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1406 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1409 struct xdr_netobj mic
;
1411 struct xdr_buf verf_buf
;
1413 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1415 *p
++ = htonl(RPC_AUTH_GSS
);
1418 spin_lock(&ctx
->gc_seq_lock
);
1419 req
->rq_seqno
= ctx
->gc_seq
++;
1420 spin_unlock(&ctx
->gc_seq_lock
);
1422 *p
++ = htonl((u32
) RPC_GSS_VERSION
);
1423 *p
++ = htonl((u32
) ctx
->gc_proc
);
1424 *p
++ = htonl((u32
) req
->rq_seqno
);
1425 *p
++ = htonl((u32
) gss_cred
->gc_service
);
1426 p
= xdr_encode_netobj(p
, &ctx
->gc_wire_ctx
);
1427 *cred_len
= htonl((p
- (cred_len
+ 1)) << 2);
1429 /* We compute the checksum for the verifier over the xdr-encoded bytes
1430 * starting with the xid and ending at the end of the credential: */
1431 iov
.iov_base
= xprt_skip_transport_header(req
->rq_xprt
,
1432 req
->rq_snd_buf
.head
[0].iov_base
);
1433 iov
.iov_len
= (u8
*)p
- (u8
*)iov
.iov_base
;
1434 xdr_buf_from_iov(&iov
, &verf_buf
);
1436 /* set verifier flavor*/
1437 *p
++ = htonl(RPC_AUTH_GSS
);
1439 mic
.data
= (u8
*)(p
+ 1);
1440 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1441 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
) {
1442 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1443 } else if (maj_stat
!= 0) {
1444 printk("gss_marshal: gss_get_mic FAILED (%d)\n", maj_stat
);
1447 p
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1455 static int gss_renew_cred(struct rpc_task
*task
)
1457 struct rpc_cred
*oldcred
= task
->tk_rqstp
->rq_cred
;
1458 struct gss_cred
*gss_cred
= container_of(oldcred
,
1461 struct rpc_auth
*auth
= oldcred
->cr_auth
;
1462 struct auth_cred acred
= {
1463 .uid
= oldcred
->cr_uid
,
1464 .principal
= gss_cred
->gc_principal
,
1465 .machine_cred
= (gss_cred
->gc_principal
!= NULL
? 1 : 0),
1467 struct rpc_cred
*new;
1469 new = gss_lookup_cred(auth
, &acred
, RPCAUTH_LOOKUP_NEW
);
1471 return PTR_ERR(new);
1472 task
->tk_rqstp
->rq_cred
= new;
1473 put_rpccred(oldcred
);
1477 static int gss_cred_is_negative_entry(struct rpc_cred
*cred
)
1479 if (test_bit(RPCAUTH_CRED_NEGATIVE
, &cred
->cr_flags
)) {
1480 unsigned long now
= jiffies
;
1481 unsigned long begin
, expire
;
1482 struct gss_cred
*gss_cred
;
1484 gss_cred
= container_of(cred
, struct gss_cred
, gc_base
);
1485 begin
= gss_cred
->gc_upcall_timestamp
;
1486 expire
= begin
+ gss_expired_cred_retry_delay
* HZ
;
1488 if (time_in_range_open(now
, begin
, expire
))
1495 * Refresh credentials. XXX - finish
1498 gss_refresh(struct rpc_task
*task
)
1500 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1503 if (gss_cred_is_negative_entry(cred
))
1504 return -EKEYEXPIRED
;
1506 if (!test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
) &&
1507 !test_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
)) {
1508 ret
= gss_renew_cred(task
);
1511 cred
= task
->tk_rqstp
->rq_cred
;
1514 if (test_bit(RPCAUTH_CRED_NEW
, &cred
->cr_flags
))
1515 ret
= gss_refresh_upcall(task
);
1520 /* Dummy refresh routine: used only when destroying the context */
1522 gss_refresh_null(struct rpc_task
*task
)
1528 gss_validate(struct rpc_task
*task
, __be32
*p
)
1530 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1531 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1534 struct xdr_buf verf_buf
;
1535 struct xdr_netobj mic
;
1538 __be32
*ret
= ERR_PTR(-EIO
);
1540 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1543 if ((len
= ntohl(*p
++)) > RPC_MAX_AUTH_SIZE
)
1545 if (flav
!= RPC_AUTH_GSS
)
1547 seq
= htonl(task
->tk_rqstp
->rq_seqno
);
1548 iov
.iov_base
= &seq
;
1549 iov
.iov_len
= sizeof(seq
);
1550 xdr_buf_from_iov(&iov
, &verf_buf
);
1554 ret
= ERR_PTR(-EACCES
);
1555 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &verf_buf
, &mic
);
1556 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1557 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1559 dprintk("RPC: %5u %s: gss_verify_mic returned error 0x%08x\n",
1560 task
->tk_pid
, __func__
, maj_stat
);
1563 /* We leave it to unwrap to calculate au_rslack. For now we just
1564 * calculate the length of the verifier: */
1565 cred
->cr_auth
->au_verfsize
= XDR_QUADLEN(len
) + 2;
1567 dprintk("RPC: %5u %s: gss_verify_mic succeeded.\n",
1568 task
->tk_pid
, __func__
);
1569 return p
+ XDR_QUADLEN(len
);
1572 dprintk("RPC: %5u %s failed ret %ld.\n", task
->tk_pid
, __func__
,
1577 static void gss_wrap_req_encode(kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1578 __be32
*p
, void *obj
)
1580 struct xdr_stream xdr
;
1582 xdr_init_encode(&xdr
, &rqstp
->rq_snd_buf
, p
);
1583 encode(rqstp
, &xdr
, obj
);
1587 gss_wrap_req_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1588 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1589 __be32
*p
, void *obj
)
1591 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1592 struct xdr_buf integ_buf
;
1593 __be32
*integ_len
= NULL
;
1594 struct xdr_netobj mic
;
1602 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1603 *p
++ = htonl(rqstp
->rq_seqno
);
1605 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1607 if (xdr_buf_subsegment(snd_buf
, &integ_buf
,
1608 offset
, snd_buf
->len
- offset
))
1610 *integ_len
= htonl(integ_buf
.len
);
1612 /* guess whether we're in the head or the tail: */
1613 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1614 iov
= snd_buf
->tail
;
1616 iov
= snd_buf
->head
;
1617 p
= iov
->iov_base
+ iov
->iov_len
;
1618 mic
.data
= (u8
*)(p
+ 1);
1620 maj_stat
= gss_get_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1621 status
= -EIO
; /* XXX? */
1622 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1623 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1626 q
= xdr_encode_opaque(p
, NULL
, mic
.len
);
1628 offset
= (u8
*)q
- (u8
*)p
;
1629 iov
->iov_len
+= offset
;
1630 snd_buf
->len
+= offset
;
1635 priv_release_snd_buf(struct rpc_rqst
*rqstp
)
1639 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++)
1640 __free_page(rqstp
->rq_enc_pages
[i
]);
1641 kfree(rqstp
->rq_enc_pages
);
1645 alloc_enc_pages(struct rpc_rqst
*rqstp
)
1647 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1650 if (snd_buf
->page_len
== 0) {
1651 rqstp
->rq_enc_pages_num
= 0;
1655 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1656 last
= (snd_buf
->page_base
+ snd_buf
->page_len
- 1) >> PAGE_CACHE_SHIFT
;
1657 rqstp
->rq_enc_pages_num
= last
- first
+ 1 + 1;
1659 = kmalloc(rqstp
->rq_enc_pages_num
* sizeof(struct page
*),
1661 if (!rqstp
->rq_enc_pages
)
1663 for (i
=0; i
< rqstp
->rq_enc_pages_num
; i
++) {
1664 rqstp
->rq_enc_pages
[i
] = alloc_page(GFP_NOFS
);
1665 if (rqstp
->rq_enc_pages
[i
] == NULL
)
1668 rqstp
->rq_release_snd_buf
= priv_release_snd_buf
;
1671 rqstp
->rq_enc_pages_num
= i
;
1672 priv_release_snd_buf(rqstp
);
1678 gss_wrap_req_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1679 kxdreproc_t encode
, struct rpc_rqst
*rqstp
,
1680 __be32
*p
, void *obj
)
1682 struct xdr_buf
*snd_buf
= &rqstp
->rq_snd_buf
;
1687 struct page
**inpages
;
1694 offset
= (u8
*)p
- (u8
*)snd_buf
->head
[0].iov_base
;
1695 *p
++ = htonl(rqstp
->rq_seqno
);
1697 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1699 status
= alloc_enc_pages(rqstp
);
1702 first
= snd_buf
->page_base
>> PAGE_CACHE_SHIFT
;
1703 inpages
= snd_buf
->pages
+ first
;
1704 snd_buf
->pages
= rqstp
->rq_enc_pages
;
1705 snd_buf
->page_base
-= first
<< PAGE_CACHE_SHIFT
;
1707 * Give the tail its own page, in case we need extra space in the
1708 * head when wrapping:
1710 * call_allocate() allocates twice the slack space required
1711 * by the authentication flavor to rq_callsize.
1712 * For GSS, slack is GSS_CRED_SLACK.
1714 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
) {
1715 tmp
= page_address(rqstp
->rq_enc_pages
[rqstp
->rq_enc_pages_num
- 1]);
1716 memcpy(tmp
, snd_buf
->tail
[0].iov_base
, snd_buf
->tail
[0].iov_len
);
1717 snd_buf
->tail
[0].iov_base
= tmp
;
1719 maj_stat
= gss_wrap(ctx
->gc_gss_ctx
, offset
, snd_buf
, inpages
);
1720 /* slack space should prevent this ever happening: */
1721 BUG_ON(snd_buf
->len
> snd_buf
->buflen
);
1723 /* We're assuming that when GSS_S_CONTEXT_EXPIRED, the encryption was
1724 * done anyway, so it's safe to put the request on the wire: */
1725 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1726 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1730 *opaque_len
= htonl(snd_buf
->len
- offset
);
1731 /* guess whether we're in the head or the tail: */
1732 if (snd_buf
->page_len
|| snd_buf
->tail
[0].iov_len
)
1733 iov
= snd_buf
->tail
;
1735 iov
= snd_buf
->head
;
1736 p
= iov
->iov_base
+ iov
->iov_len
;
1737 pad
= 3 - ((snd_buf
->len
- offset
- 1) & 3);
1739 iov
->iov_len
+= pad
;
1740 snd_buf
->len
+= pad
;
1746 gss_wrap_req(struct rpc_task
*task
,
1747 kxdreproc_t encode
, void *rqstp
, __be32
*p
, void *obj
)
1749 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1750 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1752 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1755 dprintk("RPC: %5u %s\n", task
->tk_pid
, __func__
);
1756 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
) {
1757 /* The spec seems a little ambiguous here, but I think that not
1758 * wrapping context destruction requests makes the most sense.
1760 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1764 switch (gss_cred
->gc_service
) {
1765 case RPC_GSS_SVC_NONE
:
1766 gss_wrap_req_encode(encode
, rqstp
, p
, obj
);
1769 case RPC_GSS_SVC_INTEGRITY
:
1770 status
= gss_wrap_req_integ(cred
, ctx
, encode
, rqstp
, p
, obj
);
1772 case RPC_GSS_SVC_PRIVACY
:
1773 status
= gss_wrap_req_priv(cred
, ctx
, encode
, rqstp
, p
, obj
);
1778 dprintk("RPC: %5u %s returning %d\n", task
->tk_pid
, __func__
, status
);
1783 gss_unwrap_resp_integ(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1784 struct rpc_rqst
*rqstp
, __be32
**p
)
1786 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1787 struct xdr_buf integ_buf
;
1788 struct xdr_netobj mic
;
1789 u32 data_offset
, mic_offset
;
1794 integ_len
= ntohl(*(*p
)++);
1797 data_offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1798 mic_offset
= integ_len
+ data_offset
;
1799 if (mic_offset
> rcv_buf
->len
)
1801 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1804 if (xdr_buf_subsegment(rcv_buf
, &integ_buf
, data_offset
,
1805 mic_offset
- data_offset
))
1808 if (xdr_buf_read_netobj(rcv_buf
, &mic
, mic_offset
))
1811 maj_stat
= gss_verify_mic(ctx
->gc_gss_ctx
, &integ_buf
, &mic
);
1812 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1813 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1814 if (maj_stat
!= GSS_S_COMPLETE
)
1820 gss_unwrap_resp_priv(struct rpc_cred
*cred
, struct gss_cl_ctx
*ctx
,
1821 struct rpc_rqst
*rqstp
, __be32
**p
)
1823 struct xdr_buf
*rcv_buf
= &rqstp
->rq_rcv_buf
;
1829 opaque_len
= ntohl(*(*p
)++);
1830 offset
= (u8
*)(*p
) - (u8
*)rcv_buf
->head
[0].iov_base
;
1831 if (offset
+ opaque_len
> rcv_buf
->len
)
1833 /* remove padding: */
1834 rcv_buf
->len
= offset
+ opaque_len
;
1836 maj_stat
= gss_unwrap(ctx
->gc_gss_ctx
, offset
, rcv_buf
);
1837 if (maj_stat
== GSS_S_CONTEXT_EXPIRED
)
1838 clear_bit(RPCAUTH_CRED_UPTODATE
, &cred
->cr_flags
);
1839 if (maj_stat
!= GSS_S_COMPLETE
)
1841 if (ntohl(*(*p
)++) != rqstp
->rq_seqno
)
1848 gss_unwrap_req_decode(kxdrdproc_t decode
, struct rpc_rqst
*rqstp
,
1849 __be32
*p
, void *obj
)
1851 struct xdr_stream xdr
;
1853 xdr_init_decode(&xdr
, &rqstp
->rq_rcv_buf
, p
);
1854 return decode(rqstp
, &xdr
, obj
);
1858 gss_unwrap_resp(struct rpc_task
*task
,
1859 kxdrdproc_t decode
, void *rqstp
, __be32
*p
, void *obj
)
1861 struct rpc_cred
*cred
= task
->tk_rqstp
->rq_cred
;
1862 struct gss_cred
*gss_cred
= container_of(cred
, struct gss_cred
,
1864 struct gss_cl_ctx
*ctx
= gss_cred_get_ctx(cred
);
1866 struct kvec
*head
= ((struct rpc_rqst
*)rqstp
)->rq_rcv_buf
.head
;
1867 int savedlen
= head
->iov_len
;
1870 if (ctx
->gc_proc
!= RPC_GSS_PROC_DATA
)
1872 switch (gss_cred
->gc_service
) {
1873 case RPC_GSS_SVC_NONE
:
1875 case RPC_GSS_SVC_INTEGRITY
:
1876 status
= gss_unwrap_resp_integ(cred
, ctx
, rqstp
, &p
);
1880 case RPC_GSS_SVC_PRIVACY
:
1881 status
= gss_unwrap_resp_priv(cred
, ctx
, rqstp
, &p
);
1886 /* take into account extra slack for integrity and privacy cases: */
1887 cred
->cr_auth
->au_rslack
= cred
->cr_auth
->au_verfsize
+ (p
- savedp
)
1888 + (savedlen
- head
->iov_len
);
1890 status
= gss_unwrap_req_decode(decode
, rqstp
, p
, obj
);
1893 dprintk("RPC: %5u %s returning %d\n",
1894 task
->tk_pid
, __func__
, status
);
1898 static const struct rpc_authops authgss_ops
= {
1899 .owner
= THIS_MODULE
,
1900 .au_flavor
= RPC_AUTH_GSS
,
1901 .au_name
= "RPCSEC_GSS",
1902 .create
= gss_create
,
1903 .destroy
= gss_destroy
,
1904 .lookup_cred
= gss_lookup_cred
,
1905 .crcreate
= gss_create_cred
,
1906 .list_pseudoflavors
= gss_mech_list_pseudoflavors
,
1907 .info2flavor
= gss_mech_info2flavor
,
1908 .flavor2info
= gss_mech_flavor2info
,
1911 static const struct rpc_credops gss_credops
= {
1912 .cr_name
= "AUTH_GSS",
1913 .crdestroy
= gss_destroy_cred
,
1914 .cr_init
= gss_cred_init
,
1915 .crbind
= rpcauth_generic_bind_cred
,
1916 .crmatch
= gss_match
,
1917 .crmarshal
= gss_marshal
,
1918 .crrefresh
= gss_refresh
,
1919 .crvalidate
= gss_validate
,
1920 .crwrap_req
= gss_wrap_req
,
1921 .crunwrap_resp
= gss_unwrap_resp
,
1922 .crkey_timeout
= gss_key_timeout
,
1925 static const struct rpc_credops gss_nullops
= {
1926 .cr_name
= "AUTH_GSS",
1927 .crdestroy
= gss_destroy_nullcred
,
1928 .crbind
= rpcauth_generic_bind_cred
,
1929 .crmatch
= gss_match
,
1930 .crmarshal
= gss_marshal
,
1931 .crrefresh
= gss_refresh_null
,
1932 .crvalidate
= gss_validate
,
1933 .crwrap_req
= gss_wrap_req
,
1934 .crunwrap_resp
= gss_unwrap_resp
,
1937 static const struct rpc_pipe_ops gss_upcall_ops_v0
= {
1938 .upcall
= rpc_pipe_generic_upcall
,
1939 .downcall
= gss_pipe_downcall
,
1940 .destroy_msg
= gss_pipe_destroy_msg
,
1941 .open_pipe
= gss_pipe_open_v0
,
1942 .release_pipe
= gss_pipe_release
,
1945 static const struct rpc_pipe_ops gss_upcall_ops_v1
= {
1946 .upcall
= rpc_pipe_generic_upcall
,
1947 .downcall
= gss_pipe_downcall
,
1948 .destroy_msg
= gss_pipe_destroy_msg
,
1949 .open_pipe
= gss_pipe_open_v1
,
1950 .release_pipe
= gss_pipe_release
,
1953 static __net_init
int rpcsec_gss_init_net(struct net
*net
)
1955 return gss_svc_init_net(net
);
1958 static __net_exit
void rpcsec_gss_exit_net(struct net
*net
)
1960 gss_svc_shutdown_net(net
);
1963 static struct pernet_operations rpcsec_gss_net_ops
= {
1964 .init
= rpcsec_gss_init_net
,
1965 .exit
= rpcsec_gss_exit_net
,
1969 * Initialize RPCSEC_GSS module
1971 static int __init
init_rpcsec_gss(void)
1975 err
= rpcauth_register(&authgss_ops
);
1978 err
= gss_svc_init();
1980 goto out_unregister
;
1981 err
= register_pernet_subsys(&rpcsec_gss_net_ops
);
1984 rpc_init_wait_queue(&pipe_version_rpc_waitqueue
, "gss pipe version");
1989 rpcauth_unregister(&authgss_ops
);
1994 static void __exit
exit_rpcsec_gss(void)
1996 unregister_pernet_subsys(&rpcsec_gss_net_ops
);
1998 rpcauth_unregister(&authgss_ops
);
1999 rcu_barrier(); /* Wait for completion of call_rcu()'s */
2002 MODULE_ALIAS("rpc-auth-6");
2003 MODULE_LICENSE("GPL");
2004 module_param_named(expired_cred_retry_delay
,
2005 gss_expired_cred_retry_delay
,
2007 MODULE_PARM_DESC(expired_cred_retry_delay
, "Timeout (in seconds) until "
2008 "the RPC engine retries an expired credential");
2010 module_param_named(key_expire_timeo
,
2011 gss_key_expire_timeo
,
2013 MODULE_PARM_DESC(key_expire_timeo
, "Time (in seconds) at the end of a "
2014 "credential keys lifetime where the NFS layer cleans up "
2015 "prior to key expiration");
2017 module_init(init_rpcsec_gss
)
2018 module_exit(exit_rpcsec_gss
)