blob: bb8db3cb8032ee0a4714cf3b49aeb83cb73037bd [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);
Joe Perchesf64f9e72009-11-29 16:55:45 -080049 if (flavor >= RPC_AUTH_MAXFLAVOR || !(aops = authtab[flavor]) ||
50 !try_module_get(aops->owner)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 spin_unlock(&authtab_lock);
52 *authp = rpc_autherr_badcred;
53 return SVC_DENIED;
54 }
55 spin_unlock(&authtab_lock);
56
J. Bruce Fieldsa5cddc82014-05-12 18:10:58 -040057 rqstp->rq_auth_slack = 0;
J. Bruce Fields6496500c2015-11-20 15:45:35 -050058 init_svc_cred(&rqstp->rq_cred);
J. Bruce Fieldsa5cddc82014-05-12 18:10:58 -040059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 rqstp->rq_authop = aops;
61 return aops->accept(rqstp, authp);
62}
Trond Myklebust24c37672008-12-23 16:30:12 -050063EXPORT_SYMBOL_GPL(svc_authenticate);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65int svc_set_client(struct svc_rqst *rqstp)
66{
J. Bruce Fields6496500c2015-11-20 15:45:35 -050067 rqstp->rq_client = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 return rqstp->rq_authop->set_client(rqstp);
69}
Trond Myklebust24c37672008-12-23 16:30:12 -050070EXPORT_SYMBOL_GPL(svc_set_client);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72/* A request, which was authenticated, has now executed.
Michael Opdenacker59c51592007-05-09 08:57:56 +020073 * Time to finalise the credentials and verifier
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * and release and resources
75 */
76int 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 Hideakicca51722007-02-09 15:38:13 -080082
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 if (aops) {
84 rv = aops->release(rqstp);
85 module_put(aops->owner);
86 }
87 return rv;
88}
89
90int
91svc_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 Myklebust24c37672008-12-23 16:30:12 -0500102EXPORT_SYMBOL_GPL(svc_auth_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104void
105svc_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 Myklebust24c37672008-12-23 16:30:12 -0500112EXPORT_SYMBOL_GPL(svc_auth_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114/**************************************************
NeilBrownefc36aa2006-03-27 01:14:59 -0800115 * '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 Torvalds1da177e2005-04-16 15:20:36 -0700121 */
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123#define DN_HASHBITS 6
124#define DN_HASHMAX (1<<DN_HASHBITS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
NeilBrownefc36aa2006-03-27 01:14:59 -0800126static struct hlist_head auth_domain_table[DN_HASHMAX];
Fabian Frederick3eb15f22016-12-04 13:45:28 +0100127static DEFINE_SPINLOCK(auth_domain_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Peter Zijlstra0a13cd12016-11-14 18:03:11 +0100129static void auth_domain_release(struct kref *kref)
130{
131 struct auth_domain *dom = container_of(kref, struct auth_domain, ref);
132
133 hlist_del(&dom->hash);
134 dom->flavour->domain_release(dom);
135 spin_unlock(&auth_domain_lock);
136}
137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138void auth_domain_put(struct auth_domain *dom)
139{
Peter Zijlstra0a13cd12016-11-14 18:03:11 +0100140 kref_put_lock(&dom->ref, auth_domain_release, &auth_domain_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141}
Trond Myklebust24c37672008-12-23 16:30:12 -0500142EXPORT_SYMBOL_GPL(auth_domain_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144struct auth_domain *
NeilBrownefc36aa2006-03-27 01:14:59 -0800145auth_domain_lookup(char *name, struct auth_domain *new)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
NeilBrownefc36aa2006-03-27 01:14:59 -0800147 struct auth_domain *hp;
148 struct hlist_head *head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
NeilBrownefc36aa2006-03-27 01:14:59 -0800150 head = &auth_domain_table[hash_str(name, DN_HASHBITS)];
151
152 spin_lock(&auth_domain_lock);
153
Sasha Levinb67bfe02013-02-27 17:06:00 -0800154 hlist_for_each_entry(hp, head, hash) {
NeilBrownefc36aa2006-03-27 01:14:59 -0800155 if (strcmp(hp->name, name)==0) {
156 kref_get(&hp->ref);
157 spin_unlock(&auth_domain_lock);
158 return hp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 }
Neil Brownd6740df2006-10-29 22:46:45 -0800161 if (new)
NeilBrownefc36aa2006-03-27 01:14:59 -0800162 hlist_add_head(&new->hash, head);
NeilBrownefc36aa2006-03-27 01:14:59 -0800163 spin_unlock(&auth_domain_lock);
164 return new;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165}
Trond Myklebust24c37672008-12-23 16:30:12 -0500166EXPORT_SYMBOL_GPL(auth_domain_lookup);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168struct auth_domain *auth_domain_find(char *name)
169{
NeilBrownefc36aa2006-03-27 01:14:59 -0800170 return auth_domain_lookup(name, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171}
Trond Myklebust24c37672008-12-23 16:30:12 -0500172EXPORT_SYMBOL_GPL(auth_domain_find);