Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * linux/net/sunrpc/svcauth.c |
| 3 | * |
| 4 | * The generic interface for RPC authentication on the server side. |
YOSHIFUJI Hideaki | cca5172 | 2007-02-09 15:38:13 -0800 | [diff] [blame] | 5 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de> |
| 7 | * |
| 8 | * CHANGES |
| 9 | * 19-Apr-2000 Chris Evans - Security fix |
| 10 | */ |
| 11 | |
| 12 | #include <linux/types.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 13 | #include <linux/module.h> |
| 14 | #include <linux/sunrpc/types.h> |
| 15 | #include <linux/sunrpc/xdr.h> |
| 16 | #include <linux/sunrpc/svcsock.h> |
| 17 | #include <linux/sunrpc/svcauth.h> |
| 18 | #include <linux/err.h> |
| 19 | #include <linux/hash.h> |
| 20 | |
| 21 | #define RPCDBG_FACILITY RPCDBG_AUTH |
| 22 | |
| 23 | |
| 24 | /* |
| 25 | * Table of authenticators |
| 26 | */ |
| 27 | extern struct auth_ops svcauth_null; |
| 28 | extern struct auth_ops svcauth_unix; |
| 29 | |
| 30 | static DEFINE_SPINLOCK(authtab_lock); |
| 31 | static struct auth_ops *authtab[RPC_AUTH_MAXFLAVOR] = { |
| 32 | [0] = &svcauth_null, |
| 33 | [1] = &svcauth_unix, |
| 34 | }; |
| 35 | |
| 36 | int |
Alexey Dobriyan | d8ed029 | 2006-09-26 22:29:38 -0700 | [diff] [blame] | 37 | svc_authenticate(struct svc_rqst *rqstp, __be32 *authp) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | { |
| 39 | rpc_authflavor_t flavor; |
| 40 | struct auth_ops *aops; |
| 41 | |
| 42 | *authp = rpc_auth_ok; |
| 43 | |
Alexey Dobriyan | 7699431 | 2006-09-26 22:28:46 -0700 | [diff] [blame] | 44 | flavor = svc_getnl(&rqstp->rq_arg.head[0]); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | |
| 46 | dprintk("svc: svc_authenticate (%d)\n", flavor); |
| 47 | |
| 48 | spin_lock(&authtab_lock); |
Joe Perches | f64f9e7 | 2009-11-29 16:55:45 -0800 | [diff] [blame] | 49 | if (flavor >= RPC_AUTH_MAXFLAVOR || !(aops = authtab[flavor]) || |
| 50 | !try_module_get(aops->owner)) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | spin_unlock(&authtab_lock); |
| 52 | *authp = rpc_autherr_badcred; |
| 53 | return SVC_DENIED; |
| 54 | } |
| 55 | spin_unlock(&authtab_lock); |
| 56 | |
J. Bruce Fields | a5cddc8 | 2014-05-12 18:10:58 -0400 | [diff] [blame] | 57 | rqstp->rq_auth_slack = 0; |
J. Bruce Fields | 6496500c | 2015-11-20 15:45:35 -0500 | [diff] [blame] | 58 | init_svc_cred(&rqstp->rq_cred); |
J. Bruce Fields | a5cddc8 | 2014-05-12 18:10:58 -0400 | [diff] [blame] | 59 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | rqstp->rq_authop = aops; |
| 61 | return aops->accept(rqstp, authp); |
| 62 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 63 | EXPORT_SYMBOL_GPL(svc_authenticate); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 64 | |
| 65 | int svc_set_client(struct svc_rqst *rqstp) |
| 66 | { |
J. Bruce Fields | 6496500c | 2015-11-20 15:45:35 -0500 | [diff] [blame] | 67 | rqstp->rq_client = NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | return rqstp->rq_authop->set_client(rqstp); |
| 69 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 70 | EXPORT_SYMBOL_GPL(svc_set_client); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | |
| 72 | /* A request, which was authenticated, has now executed. |
Michael Opdenacker | 59c5159 | 2007-05-09 08:57:56 +0200 | [diff] [blame] | 73 | * Time to finalise the credentials and verifier |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 74 | * and release and resources |
| 75 | */ |
| 76 | int svc_authorise(struct svc_rqst *rqstp) |
| 77 | { |
| 78 | struct auth_ops *aops = rqstp->rq_authop; |
| 79 | int rv = 0; |
| 80 | |
| 81 | rqstp->rq_authop = NULL; |
YOSHIFUJI Hideaki | cca5172 | 2007-02-09 15:38:13 -0800 | [diff] [blame] | 82 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 83 | if (aops) { |
| 84 | rv = aops->release(rqstp); |
| 85 | module_put(aops->owner); |
| 86 | } |
| 87 | return rv; |
| 88 | } |
| 89 | |
| 90 | int |
| 91 | svc_auth_register(rpc_authflavor_t flavor, struct auth_ops *aops) |
| 92 | { |
| 93 | int rv = -EINVAL; |
| 94 | spin_lock(&authtab_lock); |
| 95 | if (flavor < RPC_AUTH_MAXFLAVOR && authtab[flavor] == NULL) { |
| 96 | authtab[flavor] = aops; |
| 97 | rv = 0; |
| 98 | } |
| 99 | spin_unlock(&authtab_lock); |
| 100 | return rv; |
| 101 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 102 | EXPORT_SYMBOL_GPL(svc_auth_register); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | |
| 104 | void |
| 105 | svc_auth_unregister(rpc_authflavor_t flavor) |
| 106 | { |
| 107 | spin_lock(&authtab_lock); |
| 108 | if (flavor < RPC_AUTH_MAXFLAVOR) |
| 109 | authtab[flavor] = NULL; |
| 110 | spin_unlock(&authtab_lock); |
| 111 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 112 | EXPORT_SYMBOL_GPL(svc_auth_unregister); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | |
| 114 | /************************************************** |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 115 | * 'auth_domains' are stored in a hash table indexed by name. |
| 116 | * When the last reference to an 'auth_domain' is dropped, |
| 117 | * the object is unhashed and freed. |
| 118 | * If auth_domain_lookup fails to find an entry, it will return |
| 119 | * it's second argument 'new'. If this is non-null, it will |
| 120 | * have been atomically linked into the table. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | */ |
| 122 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | #define DN_HASHBITS 6 |
| 124 | #define DN_HASHMAX (1<<DN_HASHBITS) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 126 | static struct hlist_head auth_domain_table[DN_HASHMAX]; |
Fabian Frederick | 3eb15f2 | 2016-12-04 13:45:28 +0100 | [diff] [blame] | 127 | static DEFINE_SPINLOCK(auth_domain_lock); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | |
| 129 | void auth_domain_put(struct auth_domain *dom) |
| 130 | { |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 131 | if (atomic_dec_and_lock(&dom->ref.refcount, &auth_domain_lock)) { |
| 132 | hlist_del(&dom->hash); |
| 133 | dom->flavour->domain_release(dom); |
Akinobu Mita | 0c7bb31 | 2006-11-05 23:52:13 -0800 | [diff] [blame] | 134 | spin_unlock(&auth_domain_lock); |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 135 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 137 | EXPORT_SYMBOL_GPL(auth_domain_put); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 138 | |
| 139 | struct auth_domain * |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 140 | auth_domain_lookup(char *name, struct auth_domain *new) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | { |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 142 | struct auth_domain *hp; |
| 143 | struct hlist_head *head; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 145 | head = &auth_domain_table[hash_str(name, DN_HASHBITS)]; |
| 146 | |
| 147 | spin_lock(&auth_domain_lock); |
| 148 | |
Sasha Levin | b67bfe0 | 2013-02-27 17:06:00 -0800 | [diff] [blame] | 149 | hlist_for_each_entry(hp, head, hash) { |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 150 | if (strcmp(hp->name, name)==0) { |
| 151 | kref_get(&hp->ref); |
| 152 | spin_unlock(&auth_domain_lock); |
| 153 | return hp; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 154 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | } |
Neil Brown | d6740df | 2006-10-29 22:46:45 -0800 | [diff] [blame] | 156 | if (new) |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 157 | hlist_add_head(&new->hash, head); |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 158 | spin_unlock(&auth_domain_lock); |
| 159 | return new; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 160 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 161 | EXPORT_SYMBOL_GPL(auth_domain_lookup); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | |
| 163 | struct auth_domain *auth_domain_find(char *name) |
| 164 | { |
NeilBrown | efc36aa | 2006-03-27 01:14:59 -0800 | [diff] [blame] | 165 | return auth_domain_lookup(name, NULL); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 166 | } |
Trond Myklebust | 24c3767 | 2008-12-23 16:30:12 -0500 | [diff] [blame] | 167 | EXPORT_SYMBOL_GPL(auth_domain_find); |