blob: 54dd3fdead54b8813bb6cbdf769f96a11d8f49ea [file] [log] [blame]
Trond Myklebust9a559ef2008-03-12 12:24:49 -04001/*
2 * Generic RPC credential
3 *
4 * Copyright (C) 2008, Trond Myklebust <Trond.Myklebust@netapp.com>
5 */
6
7#include <linux/err.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +09008#include <linux/slab.h>
Trond Myklebust9a559ef2008-03-12 12:24:49 -04009#include <linux/types.h>
10#include <linux/module.h>
11#include <linux/sched.h>
12#include <linux/sunrpc/auth.h>
13#include <linux/sunrpc/clnt.h>
14#include <linux/sunrpc/debug.h>
15#include <linux/sunrpc/sched.h>
16
Jeff Laytonf895b252014-11-17 16:58:04 -050017#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
Trond Myklebust9a559ef2008-03-12 12:24:49 -040018# define RPCDBG_FACILITY RPCDBG_AUTH
19#endif
20
Eric W. Biedermanbf37f792013-02-01 15:55:38 -080021#define RPC_MACHINE_CRED_USERID GLOBAL_ROOT_UID
22#define RPC_MACHINE_CRED_GROUPID GLOBAL_ROOT_GID
Trond Myklebust7c67db32008-04-07 20:50:11 -040023
Trond Myklebust9a559ef2008-03-12 12:24:49 -040024struct generic_cred {
25 struct rpc_cred gc_base;
26 struct auth_cred acred;
27};
28
29static struct rpc_auth generic_auth;
Trond Myklebust9a559ef2008-03-12 12:24:49 -040030static const struct rpc_credops generic_credops;
31
32/*
33 * Public call interface
34 */
35struct rpc_cred *rpc_lookup_cred(void)
36{
37 return rpcauth_lookupcred(&generic_auth, 0);
38}
39EXPORT_SYMBOL_GPL(rpc_lookup_cred);
40
Weston Andros Adamsonc065d222016-04-21 20:51:55 -040041struct rpc_cred *
42rpc_lookup_generic_cred(struct auth_cred *acred, int flags, gfp_t gfp)
43{
44 return rpcauth_lookup_credcache(&generic_auth, acred, flags, gfp);
45}
46EXPORT_SYMBOL_GPL(rpc_lookup_generic_cred);
47
NeilBrownbd956082014-07-14 11:28:20 +100048struct rpc_cred *rpc_lookup_cred_nonblock(void)
49{
50 return rpcauth_lookupcred(&generic_auth, RPCAUTH_LOOKUP_RCU);
51}
52EXPORT_SYMBOL_GPL(rpc_lookup_cred_nonblock);
53
Trond Myklebust7c67db32008-04-07 20:50:11 -040054/*
55 * Public call interface for looking up machine creds.
56 */
Trond Myklebust68c97152012-01-03 13:22:46 -050057struct rpc_cred *rpc_lookup_machine_cred(const char *service_name)
Trond Myklebust7c67db32008-04-07 20:50:11 -040058{
59 struct auth_cred acred = {
Trond Myklebustb4528762008-05-11 12:18:51 -070060 .uid = RPC_MACHINE_CRED_USERID,
61 .gid = RPC_MACHINE_CRED_GROUPID,
Trond Myklebust68c97152012-01-03 13:22:46 -050062 .principal = service_name,
Trond Myklebust7c67db32008-04-07 20:50:11 -040063 .machine_cred = 1,
64 };
65
Trond Myklebust68c97152012-01-03 13:22:46 -050066 dprintk("RPC: looking up machine cred for service %s\n",
67 service_name);
Trond Myklebust7c67db32008-04-07 20:50:11 -040068 return generic_auth.au_ops->lookup_cred(&generic_auth, &acred, 0);
69}
70EXPORT_SYMBOL_GPL(rpc_lookup_machine_cred);
71
Trond Myklebust8572b8e2010-07-31 14:29:08 -040072static struct rpc_cred *generic_bind_cred(struct rpc_task *task,
73 struct rpc_cred *cred, int lookupflags)
Trond Myklebust5c691042008-03-12 16:21:07 -040074{
75 struct rpc_auth *auth = task->tk_client->cl_auth;
76 struct auth_cred *acred = &container_of(cred, struct generic_cred, gc_base)->acred;
Trond Myklebust5c691042008-03-12 16:21:07 -040077
Trond Myklebust8572b8e2010-07-31 14:29:08 -040078 return auth->au_ops->lookup_cred(auth, acred, lookupflags);
Trond Myklebust5c691042008-03-12 16:21:07 -040079}
80
Trond Myklebust9a559ef2008-03-12 12:24:49 -040081/*
82 * Lookup generic creds for current process
83 */
84static struct rpc_cred *
85generic_lookup_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags)
86{
Jeff Layton3c6e0bc2016-04-21 20:51:54 -040087 return rpcauth_lookup_credcache(&generic_auth, acred, flags, GFP_KERNEL);
Trond Myklebust9a559ef2008-03-12 12:24:49 -040088}
89
90static struct rpc_cred *
Jeff Layton3c6e0bc2016-04-21 20:51:54 -040091generic_create_cred(struct rpc_auth *auth, struct auth_cred *acred, int flags, gfp_t gfp)
Trond Myklebust9a559ef2008-03-12 12:24:49 -040092{
93 struct generic_cred *gcred;
94
Jeff Layton3c6e0bc2016-04-21 20:51:54 -040095 gcred = kmalloc(sizeof(*gcred), gfp);
Trond Myklebust9a559ef2008-03-12 12:24:49 -040096 if (gcred == NULL)
97 return ERR_PTR(-ENOMEM);
98
99 rpcauth_init_cred(&gcred->gc_base, acred, &generic_auth, &generic_credops);
100 gcred->gc_base.cr_flags = 1UL << RPCAUTH_CRED_UPTODATE;
101
102 gcred->acred.uid = acred->uid;
103 gcred->acred.gid = acred->gid;
104 gcred->acred.group_info = acred->group_info;
Andy Adamson4de6caa2013-08-14 11:59:15 -0400105 gcred->acred.ac_flags = 0;
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400106 if (gcred->acred.group_info != NULL)
107 get_group_info(gcred->acred.group_info);
Trond Myklebust7c67db32008-04-07 20:50:11 -0400108 gcred->acred.machine_cred = acred->machine_cred;
Trond Myklebust875ad3f2012-01-23 12:49:36 -0500109 gcred->acred.principal = acred->principal;
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400110
Trond Myklebust7c67db32008-04-07 20:50:11 -0400111 dprintk("RPC: allocated %s cred %p for uid %d gid %d\n",
112 gcred->acred.machine_cred ? "machine" : "generic",
Eric W. Biedermancdba3212013-02-01 17:10:52 -0800113 gcred,
114 from_kuid(&init_user_ns, acred->uid),
115 from_kgid(&init_user_ns, acred->gid));
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400116 return &gcred->gc_base;
117}
118
119static void
120generic_free_cred(struct rpc_cred *cred)
121{
122 struct generic_cred *gcred = container_of(cred, struct generic_cred, gc_base);
123
124 dprintk("RPC: generic_free_cred %p\n", gcred);
125 if (gcred->acred.group_info != NULL)
126 put_group_info(gcred->acred.group_info);
127 kfree(gcred);
128}
129
130static void
131generic_free_cred_callback(struct rcu_head *head)
132{
133 struct rpc_cred *cred = container_of(head, struct rpc_cred, cr_rcu);
134 generic_free_cred(cred);
135}
136
137static void
138generic_destroy_cred(struct rpc_cred *cred)
139{
140 call_rcu(&cred->cr_rcu, generic_free_cred_callback);
141}
142
Trond Myklebust875ad3f2012-01-23 12:49:36 -0500143static int
144machine_cred_match(struct auth_cred *acred, struct generic_cred *gcred, int flags)
145{
146 if (!gcred->acred.machine_cred ||
147 gcred->acred.principal != acred->principal ||
Eric W. Biederman0b4d51b2013-02-01 16:39:32 -0800148 !uid_eq(gcred->acred.uid, acred->uid) ||
149 !gid_eq(gcred->acred.gid, acred->gid))
Trond Myklebust875ad3f2012-01-23 12:49:36 -0500150 return 0;
151 return 1;
152}
153
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400154/*
155 * Match credentials against current process creds.
156 */
157static int
158generic_match(struct auth_cred *acred, struct rpc_cred *cred, int flags)
159{
160 struct generic_cred *gcred = container_of(cred, struct generic_cred, gc_base);
Trond Myklebust23918b02008-11-20 16:06:21 -0500161 int i;
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400162
Trond Myklebust875ad3f2012-01-23 12:49:36 -0500163 if (acred->machine_cred)
164 return machine_cred_match(acred, gcred, flags);
165
Eric W. Biederman0b4d51b2013-02-01 16:39:32 -0800166 if (!uid_eq(gcred->acred.uid, acred->uid) ||
167 !gid_eq(gcred->acred.gid, acred->gid) ||
Trond Myklebust875ad3f2012-01-23 12:49:36 -0500168 gcred->acred.machine_cred != 0)
Trond Myklebust23918b02008-11-20 16:06:21 -0500169 goto out_nomatch;
170
171 /* Optimisation in the case where pointers are identical... */
172 if (gcred->acred.group_info == acred->group_info)
173 goto out_match;
174
175 /* Slow path... */
176 if (gcred->acred.group_info->ngroups != acred->group_info->ngroups)
177 goto out_nomatch;
178 for (i = 0; i < gcred->acred.group_info->ngroups; i++) {
Eric W. Biedermanae2975b2011-11-14 15:56:38 -0800179 if (!gid_eq(GROUP_AT(gcred->acred.group_info, i),
180 GROUP_AT(acred->group_info, i)))
Trond Myklebust23918b02008-11-20 16:06:21 -0500181 goto out_nomatch;
182 }
183out_match:
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400184 return 1;
Trond Myklebust23918b02008-11-20 16:06:21 -0500185out_nomatch:
186 return 0;
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400187}
188
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400189int __init rpc_init_generic_auth(void)
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400190{
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400191 return rpcauth_init_credcache(&generic_auth);
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400192}
193
Stephen Rothwellc135e842010-09-29 14:16:57 +1000194void rpc_destroy_generic_auth(void)
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400195{
Trond Myklebust5d8d9a42010-07-31 14:29:07 -0400196 rpcauth_destroy_credcache(&generic_auth);
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400197}
198
Andy Adamson4de6caa2013-08-14 11:59:15 -0400199/*
200 * Test the the current time (now) against the underlying credential key expiry
201 * minus a timeout and setup notification.
202 *
203 * The normal case:
204 * If 'now' is before the key expiry minus RPC_KEY_EXPIRE_TIMEO, set
205 * the RPC_CRED_NOTIFY_TIMEOUT flag to setup the underlying credential
206 * rpc_credops crmatch routine to notify this generic cred when it's key
207 * expiration is within RPC_KEY_EXPIRE_TIMEO, and return 0.
208 *
209 * The error case:
210 * If the underlying cred lookup fails, return -EACCES.
211 *
212 * The 'almost' error case:
213 * If 'now' is within key expiry minus RPC_KEY_EXPIRE_TIMEO, but not within
214 * key expiry minus RPC_KEY_EXPIRE_FAIL, set the RPC_CRED_EXPIRE_SOON bit
215 * on the acred ac_flags and return 0.
216 */
217static int
218generic_key_timeout(struct rpc_auth *auth, struct rpc_cred *cred)
219{
220 struct auth_cred *acred = &container_of(cred, struct generic_cred,
221 gc_base)->acred;
222 struct rpc_cred *tcred;
223 int ret = 0;
224
225
226 /* Fast track for non crkey_timeout (no key) underlying credentials */
227 if (test_bit(RPC_CRED_NO_CRKEY_TIMEOUT, &acred->ac_flags))
228 return 0;
229
230 /* Fast track for the normal case */
231 if (test_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags))
232 return 0;
233
234 /* lookup_cred either returns a valid referenced rpc_cred, or PTR_ERR */
235 tcred = auth->au_ops->lookup_cred(auth, acred, 0);
236 if (IS_ERR(tcred))
237 return -EACCES;
238
239 if (!tcred->cr_ops->crkey_timeout) {
240 set_bit(RPC_CRED_NO_CRKEY_TIMEOUT, &acred->ac_flags);
241 ret = 0;
242 goto out_put;
243 }
244
245 /* Test for the almost error case */
246 ret = tcred->cr_ops->crkey_timeout(tcred);
247 if (ret != 0) {
248 set_bit(RPC_CRED_KEY_EXPIRE_SOON, &acred->ac_flags);
249 ret = 0;
250 } else {
251 /* In case underlying cred key has been reset */
252 if (test_and_clear_bit(RPC_CRED_KEY_EXPIRE_SOON,
253 &acred->ac_flags))
254 dprintk("RPC: UID %d Credential key reset\n",
Geert Uytterhoeven13429302013-09-12 15:09:39 +0200255 from_kuid(&init_user_ns, tcred->cr_uid));
Andy Adamson4de6caa2013-08-14 11:59:15 -0400256 /* set up fasttrack for the normal case */
257 set_bit(RPC_CRED_NOTIFY_TIMEOUT, &acred->ac_flags);
258 }
259
260out_put:
261 put_rpccred(tcred);
262 return ret;
263}
264
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400265static const struct rpc_authops generic_auth_ops = {
266 .owner = THIS_MODULE,
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400267 .au_name = "Generic",
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400268 .lookup_cred = generic_lookup_cred,
269 .crcreate = generic_create_cred,
Andy Adamson4de6caa2013-08-14 11:59:15 -0400270 .key_timeout = generic_key_timeout,
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400271};
272
273static struct rpc_auth generic_auth = {
274 .au_ops = &generic_auth_ops,
275 .au_count = ATOMIC_INIT(0),
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400276};
277
Andy Adamson4de6caa2013-08-14 11:59:15 -0400278static bool generic_key_to_expire(struct rpc_cred *cred)
279{
280 struct auth_cred *acred = &container_of(cred, struct generic_cred,
281 gc_base)->acred;
282 bool ret;
283
284 get_rpccred(cred);
285 ret = test_bit(RPC_CRED_KEY_EXPIRE_SOON, &acred->ac_flags);
286 put_rpccred(cred);
287
288 return ret;
289}
290
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400291static const struct rpc_credops generic_credops = {
292 .cr_name = "Generic cred",
293 .crdestroy = generic_destroy_cred,
Trond Myklebust5c691042008-03-12 16:21:07 -0400294 .crbind = generic_bind_cred,
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400295 .crmatch = generic_match,
Andy Adamson4de6caa2013-08-14 11:59:15 -0400296 .crkey_to_expire = generic_key_to_expire,
Trond Myklebust9a559ef2008-03-12 12:24:49 -0400297};