blob: e64109b02aee72be4627016ece9c6464d25f043c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/net/sunrpc/svcauth.c
3 *
4 * The generic interface for RPC authentication on the server side.
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -08005 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 * 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 Torvalds1da177e2005-04-16 15:20:36 -070013#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 */
27extern struct auth_ops svcauth_null;
28extern struct auth_ops svcauth_unix;
29
30static DEFINE_SPINLOCK(authtab_lock);
31static struct auth_ops *authtab[RPC_AUTH_MAXFLAVOR] = {
32 [0] = &svcauth_null,
33 [1] = &svcauth_unix,
34};
35
36int
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070037svc_authenticate(struct svc_rqst *rqstp, __be32 *authp)
Linus Torvalds1da177e2005-04-16 15:20:36 -070038{
39 rpc_authflavor_t flavor;
40 struct auth_ops *aops;
41
42 *authp = rpc_auth_ok;
43
Alexey Dobriyan76994312006-09-26 22:28:46 -070044 flavor = svc_getnl(&rqstp->rq_arg.head[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46 dprintk("svc: svc_authenticate (%d)\n", flavor);
47
48 spin_lock(&authtab_lock);
49 if (flavor >= RPC_AUTH_MAXFLAVOR || !(aops = authtab[flavor])
50 || !try_module_get(aops->owner)) {
51 spin_unlock(&authtab_lock);
52 *authp = rpc_autherr_badcred;
53 return SVC_DENIED;
54 }
55 spin_unlock(&authtab_lock);
56
57 rqstp->rq_authop = aops;
58 return aops->accept(rqstp, authp);
59}
Trond Myklebust24c37672008-12-23 16:30:12 -050060EXPORT_SYMBOL_GPL(svc_authenticate);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62int svc_set_client(struct svc_rqst *rqstp)
63{
64 return rqstp->rq_authop->set_client(rqstp);
65}
Trond Myklebust24c37672008-12-23 16:30:12 -050066EXPORT_SYMBOL_GPL(svc_set_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68/* A request, which was authenticated, has now executed.
Michael Opdenacker59c51592007-05-09 08:57:56 +020069 * Time to finalise the credentials and verifier
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 * and release and resources
71 */
72int svc_authorise(struct svc_rqst *rqstp)
73{
74 struct auth_ops *aops = rqstp->rq_authop;
75 int rv = 0;
76
77 rqstp->rq_authop = NULL;
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -080078
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 if (aops) {
80 rv = aops->release(rqstp);
81 module_put(aops->owner);
82 }
83 return rv;
84}
85
86int
87svc_auth_register(rpc_authflavor_t flavor, struct auth_ops *aops)
88{
89 int rv = -EINVAL;
90 spin_lock(&authtab_lock);
91 if (flavor < RPC_AUTH_MAXFLAVOR && authtab[flavor] == NULL) {
92 authtab[flavor] = aops;
93 rv = 0;
94 }
95 spin_unlock(&authtab_lock);
96 return rv;
97}
Trond Myklebust24c37672008-12-23 16:30:12 -050098EXPORT_SYMBOL_GPL(svc_auth_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
100void
101svc_auth_unregister(rpc_authflavor_t flavor)
102{
103 spin_lock(&authtab_lock);
104 if (flavor < RPC_AUTH_MAXFLAVOR)
105 authtab[flavor] = NULL;
106 spin_unlock(&authtab_lock);
107}
Trond Myklebust24c37672008-12-23 16:30:12 -0500108EXPORT_SYMBOL_GPL(svc_auth_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
110/**************************************************
NeilBrownefc36aa2006-03-27 01:14:59 -0800111 * 'auth_domains' are stored in a hash table indexed by name.
112 * When the last reference to an 'auth_domain' is dropped,
113 * the object is unhashed and freed.
114 * If auth_domain_lookup fails to find an entry, it will return
115 * it's second argument 'new'. If this is non-null, it will
116 * have been atomically linked into the table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 */
118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119#define DN_HASHBITS 6
120#define DN_HASHMAX (1<<DN_HASHBITS)
121#define DN_HASHMASK (DN_HASHMAX-1)
122
NeilBrownefc36aa2006-03-27 01:14:59 -0800123static struct hlist_head auth_domain_table[DN_HASHMAX];
Peter Zijlstra6cfd76a2006-12-06 20:37:22 -0800124static spinlock_t auth_domain_lock =
125 __SPIN_LOCK_UNLOCKED(auth_domain_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
127void auth_domain_put(struct auth_domain *dom)
128{
NeilBrownefc36aa2006-03-27 01:14:59 -0800129 if (atomic_dec_and_lock(&dom->ref.refcount, &auth_domain_lock)) {
130 hlist_del(&dom->hash);
131 dom->flavour->domain_release(dom);
Akinobu Mita0c7bb312006-11-05 23:52:13 -0800132 spin_unlock(&auth_domain_lock);
NeilBrownefc36aa2006-03-27 01:14:59 -0800133 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134}
Trond Myklebust24c37672008-12-23 16:30:12 -0500135EXPORT_SYMBOL_GPL(auth_domain_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137struct auth_domain *
NeilBrownefc36aa2006-03-27 01:14:59 -0800138auth_domain_lookup(char *name, struct auth_domain *new)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139{
NeilBrownefc36aa2006-03-27 01:14:59 -0800140 struct auth_domain *hp;
141 struct hlist_head *head;
142 struct hlist_node *np;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
NeilBrownefc36aa2006-03-27 01:14:59 -0800144 head = &auth_domain_table[hash_str(name, DN_HASHBITS)];
145
146 spin_lock(&auth_domain_lock);
147
148 hlist_for_each_entry(hp, np, head, hash) {
149 if (strcmp(hp->name, name)==0) {
150 kref_get(&hp->ref);
151 spin_unlock(&auth_domain_lock);
152 return hp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 }
Neil Brownd6740df2006-10-29 22:46:45 -0800155 if (new)
NeilBrownefc36aa2006-03-27 01:14:59 -0800156 hlist_add_head(&new->hash, head);
NeilBrownefc36aa2006-03-27 01:14:59 -0800157 spin_unlock(&auth_domain_lock);
158 return new;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159}
Trond Myklebust24c37672008-12-23 16:30:12 -0500160EXPORT_SYMBOL_GPL(auth_domain_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162struct auth_domain *auth_domain_find(char *name)
163{
NeilBrownefc36aa2006-03-27 01:14:59 -0800164 return auth_domain_lookup(name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165}
Trond Myklebust24c37672008-12-23 16:30:12 -0500166EXPORT_SYMBOL_GPL(auth_domain_find);