blob: 79f6424aa0819b7a56d0835d1d2418c9ea703b4d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/nfs/idmap.c
3 *
4 * UID and GID to name mapping for clients.
5 *
6 * Copyright (c) 2002 The Regents of the University of Michigan.
7 * All rights reserved.
8 *
9 * Marius Aamodt Eriksen <marius@umich.edu>
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
25 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
31 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
32 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
33 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
34 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
Trond Myklebust5cf36cf2011-02-22 15:44:31 -080036#include <linux/types.h>
Bryan Schumaker57e62322012-02-24 14:14:51 -050037#include <linux/parser.h>
38#include <linux/fs.h>
Vitaliy Ivanove44ba032011-06-20 16:08:07 +020039#include <linux/nfs_idmap.h>
Bryan Schumaker57e62322012-02-24 14:14:51 -050040#include <net/net_namespace.h>
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050041#include <linux/sunrpc/rpc_pipe_fs.h>
Trond Myklebust6926afd2012-01-07 13:22:46 -050042#include <linux/nfs_fs.h>
Bryan Schumaker57e62322012-02-24 14:14:51 -050043#include <linux/nfs_fs_sb.h>
44#include <linux/key.h>
45#include <linux/keyctl.h>
46#include <linux/key-type.h>
47#include <keys/user-type.h>
48#include <linux/module.h>
49
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050050#include "internal.h"
Stanislav Kinsbursky17347d02012-01-26 15:11:41 +040051#include "netns.h"
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050052
53#define NFS_UINT_MAXLEN 11
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050054
Trond Myklebust17280172012-03-11 13:11:00 -040055static const struct cred *id_resolver_cache;
56static struct key_type key_type_id_resolver_legacy;
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050057
Bryan Schumakerb1027432012-06-20 14:35:28 -040058struct idmap {
59 struct rpc_pipe *idmap_pipe;
60 struct key_construction *idmap_key_cons;
61 struct mutex idmap_mutex;
62};
Trond Myklebust6926afd2012-01-07 13:22:46 -050063
Bryan Schumakerc5066942012-08-09 14:05:49 -040064struct idmap_legacy_upcalldata {
65 struct rpc_pipe_msg pipe_msg;
66 struct idmap_msg idmap_msg;
67 struct idmap *idmap;
68};
69
Trond Myklebust6926afd2012-01-07 13:22:46 -050070/**
71 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
72 * @fattr: fully initialised struct nfs_fattr
73 * @owner_name: owner name string cache
74 * @group_name: group name string cache
75 */
76void nfs_fattr_init_names(struct nfs_fattr *fattr,
77 struct nfs4_string *owner_name,
78 struct nfs4_string *group_name)
79{
80 fattr->owner_name = owner_name;
81 fattr->group_name = group_name;
82}
83
84static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
85{
86 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
87 kfree(fattr->owner_name->data);
88}
89
90static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
91{
92 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
93 kfree(fattr->group_name->data);
94}
95
96static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
97{
98 struct nfs4_string *owner = fattr->owner_name;
99 __u32 uid;
100
101 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
102 return false;
103 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
104 fattr->uid = uid;
105 fattr->valid |= NFS_ATTR_FATTR_OWNER;
106 }
107 return true;
108}
109
110static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
111{
112 struct nfs4_string *group = fattr->group_name;
113 __u32 gid;
114
115 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
116 return false;
117 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
118 fattr->gid = gid;
119 fattr->valid |= NFS_ATTR_FATTR_GROUP;
120 }
121 return true;
122}
123
124/**
125 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
126 * @fattr: a fully initialised nfs_fattr structure
127 */
128void nfs_fattr_free_names(struct nfs_fattr *fattr)
129{
130 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
131 nfs_fattr_free_owner_name(fattr);
132 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
133 nfs_fattr_free_group_name(fattr);
134}
135
136/**
137 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
138 * @server: pointer to the filesystem nfs_server structure
139 * @fattr: a fully initialised nfs_fattr structure
140 *
141 * This helper maps the cached NFSv4 owner/group strings in fattr into
142 * their numeric uid/gid equivalents, and then frees the cached strings.
143 */
144void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
145{
146 if (nfs_fattr_map_owner_name(server, fattr))
147 nfs_fattr_free_owner_name(fattr);
148 if (nfs_fattr_map_group_name(server, fattr))
149 nfs_fattr_free_group_name(fattr);
150}
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800151
152static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
153{
154 unsigned long val;
155 char buf[16];
156
157 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
158 return 0;
159 memcpy(buf, name, namelen);
160 buf[namelen] = '\0';
161 if (strict_strtoul(buf, 0, &val) != 0)
162 return 0;
163 *res = val;
164 return 1;
165}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Trond Myklebustf0b85162011-02-22 15:44:31 -0800167static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
168{
169 return snprintf(buf, buflen, "%u", id);
170}
171
Trond Myklebust17280172012-03-11 13:11:00 -0400172static struct key_type key_type_id_resolver = {
Bryan Schumaker955a8572010-09-29 15:41:49 -0400173 .name = "id_resolver",
174 .instantiate = user_instantiate,
175 .match = user_match,
176 .revoke = user_revoke,
177 .destroy = user_destroy,
178 .describe = user_describe,
179 .read = user_read,
180};
181
Bryan Schumakere6499c62012-01-26 16:54:23 -0500182static int nfs_idmap_init_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400183{
184 struct cred *cred;
185 struct key *keyring;
186 int ret = 0;
187
Weston Andros Adamsonf9fd2d92012-01-26 13:32:22 -0500188 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
189 key_type_id_resolver.name);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400190
191 cred = prepare_kernel_cred(NULL);
192 if (!cred)
193 return -ENOMEM;
194
195 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
196 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
197 KEY_USR_VIEW | KEY_USR_READ,
198 KEY_ALLOC_NOT_IN_QUOTA);
199 if (IS_ERR(keyring)) {
200 ret = PTR_ERR(keyring);
201 goto failed_put_cred;
202 }
203
204 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
205 if (ret < 0)
206 goto failed_put_key;
207
208 ret = register_key_type(&key_type_id_resolver);
209 if (ret < 0)
210 goto failed_put_key;
211
David Howellsa427b9e2012-07-25 16:53:36 +0100212 ret = register_key_type(&key_type_id_resolver_legacy);
213 if (ret < 0)
214 goto failed_reg_legacy;
215
David Howells700920e2012-01-18 15:31:45 +0000216 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400217 cred->thread_keyring = keyring;
218 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
219 id_resolver_cache = cred;
220 return 0;
221
David Howellsa427b9e2012-07-25 16:53:36 +0100222failed_reg_legacy:
223 unregister_key_type(&key_type_id_resolver);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400224failed_put_key:
225 key_put(keyring);
226failed_put_cred:
227 put_cred(cred);
228 return ret;
229}
230
Bryan Schumakere6499c62012-01-26 16:54:23 -0500231static void nfs_idmap_quit_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400232{
233 key_revoke(id_resolver_cache->thread_keyring);
234 unregister_key_type(&key_type_id_resolver);
David Howellsa427b9e2012-07-25 16:53:36 +0100235 unregister_key_type(&key_type_id_resolver_legacy);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400236 put_cred(id_resolver_cache);
237}
238
239/*
240 * Assemble the description to pass to request_key()
241 * This function will allocate a new string and update dest to point
242 * at it. The caller is responsible for freeing dest.
243 *
244 * On error 0 is returned. Otherwise, the length of dest is returned.
245 */
246static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
247 const char *type, size_t typelen, char **desc)
248{
249 char *cp;
250 size_t desclen = typelen + namelen + 2;
251
252 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200253 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400254 return -ENOMEM;
255
256 cp = *desc;
257 memcpy(cp, type, typelen);
258 cp += typelen;
259 *cp++ = ':';
260
261 memcpy(cp, name, namelen);
262 cp += namelen;
263 *cp = '\0';
264 return desclen;
265}
266
Bryan Schumaker57e62322012-02-24 14:14:51 -0500267static ssize_t nfs_idmap_request_key(struct key_type *key_type,
268 const char *name, size_t namelen,
269 const char *type, void *data,
270 size_t data_size, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400271{
272 const struct cred *saved_cred;
273 struct key *rkey;
274 char *desc;
275 struct user_key_payload *payload;
276 ssize_t ret;
277
278 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
279 if (ret <= 0)
280 goto out;
281
282 saved_cred = override_creds(id_resolver_cache);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500283 if (idmap)
284 rkey = request_key_with_auxdata(key_type, desc, "", 0, idmap);
285 else
286 rkey = request_key(&key_type_id_resolver, desc, "");
Bryan Schumaker955a8572010-09-29 15:41:49 -0400287 revert_creds(saved_cred);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500288
Bryan Schumaker955a8572010-09-29 15:41:49 -0400289 kfree(desc);
290 if (IS_ERR(rkey)) {
291 ret = PTR_ERR(rkey);
292 goto out;
293 }
294
295 rcu_read_lock();
296 rkey->perm |= KEY_USR_VIEW;
297
298 ret = key_validate(rkey);
299 if (ret < 0)
300 goto out_up;
301
302 payload = rcu_dereference(rkey->payload.data);
303 if (IS_ERR_OR_NULL(payload)) {
304 ret = PTR_ERR(payload);
305 goto out_up;
306 }
307
308 ret = payload->datalen;
309 if (ret > 0 && ret <= data_size)
310 memcpy(data, payload->data, ret);
311 else
312 ret = -EINVAL;
313
314out_up:
315 rcu_read_unlock();
316 key_put(rkey);
317out:
318 return ret;
319}
320
Bryan Schumaker57e62322012-02-24 14:14:51 -0500321static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
322 const char *type, void *data,
323 size_t data_size, struct idmap *idmap)
324{
325 ssize_t ret = nfs_idmap_request_key(&key_type_id_resolver,
326 name, namelen, type, data,
327 data_size, NULL);
328 if (ret < 0) {
Bryan Schumakerb1027432012-06-20 14:35:28 -0400329 mutex_lock(&idmap->idmap_mutex);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500330 ret = nfs_idmap_request_key(&key_type_id_resolver_legacy,
331 name, namelen, type, data,
332 data_size, idmap);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400333 idmap->idmap_key_cons = NULL;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400334 mutex_unlock(&idmap->idmap_mutex);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500335 }
336 return ret;
337}
Bryan Schumaker955a8572010-09-29 15:41:49 -0400338
339/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500340static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
341 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400342{
343 char id_str[NFS_UINT_MAXLEN];
344 int id_len;
345 ssize_t ret;
346
347 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500348 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400349 if (ret < 0)
350 return -EINVAL;
351 return ret;
352}
353
354/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500355static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
356 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400357{
358 char id_str[NFS_UINT_MAXLEN];
359 long id_long;
360 ssize_t data_size;
361 int ret = 0;
362
Bryan Schumaker57e62322012-02-24 14:14:51 -0500363 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400364 if (data_size <= 0) {
365 ret = -EINVAL;
366 } else {
367 ret = strict_strtol(id_str, 10, &id_long);
368 *id = (__u32)id_long;
369 }
370 return ret;
371}
372
Bryan Schumakere6499c62012-01-26 16:54:23 -0500373/* idmap classic begins here */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Bryan Schumaker57e62322012-02-24 14:14:51 -0500375enum {
376 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
377};
378
379static const match_table_t nfs_idmap_tokens = {
380 { Opt_find_uid, "uid:%s" },
381 { Opt_find_gid, "gid:%s" },
382 { Opt_find_user, "user:%s" },
383 { Opt_find_group, "group:%s" },
384 { Opt_find_err, NULL }
385};
386
387static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500388static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
389 size_t);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400390static void idmap_release_pipe(struct inode *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500391static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Trond Myklebustb693ba42009-08-09 15:14:15 -0400393static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400394 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500395 .downcall = idmap_pipe_downcall,
Bryan Schumakerc5066942012-08-09 14:05:49 -0400396 .release_pipe = idmap_release_pipe,
Chuck Lever369af0f2007-12-20 14:54:35 -0500397 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398};
399
Trond Myklebust17280172012-03-11 13:11:00 -0400400static struct key_type key_type_id_resolver_legacy = {
David Howellsa427b9e2012-07-25 16:53:36 +0100401 .name = "id_legacy",
Bryan Schumaker57e62322012-02-24 14:14:51 -0500402 .instantiate = user_instantiate,
403 .match = user_match,
404 .revoke = user_revoke,
405 .destroy = user_destroy,
406 .describe = user_describe,
407 .read = user_read,
408 .request_key = nfs_idmap_legacy_upcall,
409};
410
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400411static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
412{
413 if (pipe->dentry)
414 rpc_unlink(pipe->dentry);
415}
416
417static int __nfs_idmap_register(struct dentry *dir,
418 struct idmap *idmap,
419 struct rpc_pipe *pipe)
420{
421 struct dentry *dentry;
422
423 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
424 if (IS_ERR(dentry))
425 return PTR_ERR(dentry);
426 pipe->dentry = dentry;
427 return 0;
428}
429
430static void nfs_idmap_unregister(struct nfs_client *clp,
431 struct rpc_pipe *pipe)
432{
Chuck Lever73ea6662012-05-21 22:44:50 -0400433 struct net *net = clp->cl_net;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400434 struct super_block *pipefs_sb;
435
436 pipefs_sb = rpc_get_sb_net(net);
437 if (pipefs_sb) {
438 __nfs_idmap_unregister(pipe);
439 rpc_put_sb_net(net);
440 }
441}
442
443static int nfs_idmap_register(struct nfs_client *clp,
444 struct idmap *idmap,
445 struct rpc_pipe *pipe)
446{
Chuck Lever73ea6662012-05-21 22:44:50 -0400447 struct net *net = clp->cl_net;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400448 struct super_block *pipefs_sb;
449 int err = 0;
450
451 pipefs_sb = rpc_get_sb_net(net);
452 if (pipefs_sb) {
453 if (clp->cl_rpcclient->cl_dentry)
454 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
455 idmap, pipe);
456 rpc_put_sb_net(net);
457 }
458 return err;
459}
460
David Howellsb7162792006-08-22 20:06:09 -0400461int
David Howellsadfa6f92006-08-22 20:06:08 -0400462nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
464 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300465 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400466 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Chuck Lever369af0f2007-12-20 14:54:35 -0500468 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
469 if (idmap == NULL)
470 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300472 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
473 if (IS_ERR(pipe)) {
474 error = PTR_ERR(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 kfree(idmap);
David Howellsb7162792006-08-22 20:06:09 -0400476 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400478 error = nfs_idmap_register(clp, idmap, pipe);
479 if (error) {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300480 rpc_destroy_pipe_data(pipe);
481 kfree(idmap);
482 return error;
483 }
484 idmap->idmap_pipe = pipe;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400485 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
487 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400488 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
491void
David Howellsadfa6f92006-08-22 20:06:08 -0400492nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
494 struct idmap *idmap = clp->cl_idmap;
495
496 if (!idmap)
497 return;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400498 nfs_idmap_unregister(clp, idmap->idmap_pipe);
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300499 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 clp->cl_idmap = NULL;
501 kfree(idmap);
502}
503
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400504static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
505 struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400507 int err = 0;
508
509 switch (event) {
510 case RPC_PIPEFS_MOUNT:
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400511 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
512 clp->cl_idmap,
513 clp->cl_idmap->idmap_pipe);
514 break;
515 case RPC_PIPEFS_UMOUNT:
516 if (clp->cl_idmap->idmap_pipe) {
517 struct dentry *parent;
518
519 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
520 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
521 /*
522 * Note: This is a dirty hack. SUNRPC hook has been
523 * called already but simple_rmdir() call for the
524 * directory returned with error because of idmap pipe
525 * inside. Thus now we have to remove this directory
526 * here.
527 */
528 if (rpc_rmdir(parent))
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500529 printk(KERN_ERR "NFS: %s: failed to remove "
530 "clnt dir!\n", __func__);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400531 }
532 break;
533 default:
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500534 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
535 event);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400536 return -ENOTSUPP;
537 }
538 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539}
540
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400541static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400543 struct nfs_net *nn = net_generic(net, nfs_net_id);
544 struct dentry *cl_dentry;
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400545 struct nfs_client *clp;
Trond Myklebust4697bd52012-05-23 13:24:36 -0400546 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Trond Myklebust4697bd52012-05-23 13:24:36 -0400548restart:
Stanislav Kinsburskydc030852012-01-23 17:26:31 +0000549 spin_lock(&nn->nfs_client_lock);
Stanislav Kinsbursky6b131682012-01-23 17:26:05 +0000550 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
Trond Myklebust4697bd52012-05-23 13:24:36 -0400551 /* Wait for initialisation to finish */
552 if (clp->cl_cons_state == NFS_CS_INITING) {
553 atomic_inc(&clp->cl_count);
554 spin_unlock(&nn->nfs_client_lock);
555 err = nfs_wait_client_init_complete(clp);
556 nfs_put_client(clp);
557 if (err)
558 return NULL;
559 goto restart;
560 }
561 /* Skip nfs_clients that failed to initialise */
562 if (clp->cl_cons_state < 0)
563 continue;
Trond Myklebust54ac4712012-05-23 13:26:10 -0400564 smp_rmb();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400565 if (clp->rpc_ops != &nfs_v4_clientops)
566 continue;
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400567 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
568 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
569 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
570 continue;
571 atomic_inc(&clp->cl_count);
572 spin_unlock(&nn->nfs_client_lock);
573 return clp;
574 }
575 spin_unlock(&nn->nfs_client_lock);
576 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577}
578
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400579static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
580 void *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400582 struct super_block *sb = ptr;
583 struct nfs_client *clp;
584 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400586 if (!try_module_get(THIS_MODULE))
587 return 0;
588
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400589 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400590 error = __rpc_pipefs_event(clp, event, sb);
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400591 nfs_put_client(clp);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400592 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 }
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400595 module_put(THIS_MODULE);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400596 return error;
597}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400599#define PIPEFS_NFS_PRIO 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400601static struct notifier_block nfs_idmap_block = {
602 .notifier_call = rpc_pipefs_event,
603 .priority = SUNRPC_PIPEFS_NFS_PRIO,
604};
605
606int nfs_idmap_init(void)
607{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500608 int ret;
609 ret = nfs_idmap_init_keyring();
610 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500612 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
613 if (ret != 0)
614 nfs_idmap_quit_keyring();
615out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500616 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617}
618
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400619void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400621 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
Bryan Schumakere6499c62012-01-26 16:54:23 -0500622 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400623}
624
Bryan Schumakerc5066942012-08-09 14:05:49 -0400625static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
626 struct idmap_msg *im,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500627 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500629 substring_t substr;
630 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Bryan Schumaker57e62322012-02-24 14:14:51 -0500632 memset(im, 0, sizeof(*im));
633 memset(msg, 0, sizeof(*msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Bryan Schumaker57e62322012-02-24 14:14:51 -0500635 im->im_type = IDMAP_TYPE_GROUP;
636 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Bryan Schumaker57e62322012-02-24 14:14:51 -0500638 switch (token) {
639 case Opt_find_uid:
640 im->im_type = IDMAP_TYPE_USER;
641 case Opt_find_gid:
642 im->im_conv = IDMAP_CONV_NAMETOID;
643 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
644 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Bryan Schumaker57e62322012-02-24 14:14:51 -0500646 case Opt_find_user:
647 im->im_type = IDMAP_TYPE_USER;
648 case Opt_find_group:
649 im->im_conv = IDMAP_CONV_IDTONAME;
650 ret = match_int(&substr, &im->im_id);
651 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500652
Bryan Schumaker57e62322012-02-24 14:14:51 -0500653 default:
654 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 goto out;
656 }
657
Bryan Schumaker57e62322012-02-24 14:14:51 -0500658 msg->data = im;
659 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Bryan Schumaker57e62322012-02-24 14:14:51 -0500661out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 return ret;
663}
664
Bryan Schumaker57e62322012-02-24 14:14:51 -0500665static int nfs_idmap_legacy_upcall(struct key_construction *cons,
666 const char *op,
667 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400669 struct idmap_legacy_upcalldata *data;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500670 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500672 struct idmap *idmap = (struct idmap *)aux;
673 struct key *key = cons->key;
Dan Carpenter5abc03c2012-05-14 22:45:28 +0300674 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Bryan Schumaker57e62322012-02-24 14:14:51 -0500676 /* msg and im are freed in idmap_pipe_destroy_msg */
Bryan Schumakerc5066942012-08-09 14:05:49 -0400677 data = kmalloc(sizeof(*data), GFP_KERNEL);
678 if (!data)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500679 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Bryan Schumakerc5066942012-08-09 14:05:49 -0400681 msg = &data->pipe_msg;
682 im = &data->idmap_msg;
683 data->idmap = idmap;
684
685 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500686 if (ret < 0)
687 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688
Trond Myklebust0e24d842012-09-28 12:03:09 -0400689 if (idmap->idmap_key_cons != NULL) {
690 WARN_ON_ONCE(1);
691 ret = -EAGAIN;
692 goto out2;
693 }
Bryan Schumaker57e62322012-02-24 14:14:51 -0500694 idmap->idmap_key_cons = cons;
695
Bryan Schumaker11588f42012-03-12 11:33:00 -0400696 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
697 if (ret < 0)
Bryan Schumakerc5066942012-08-09 14:05:49 -0400698 goto out3;
Bryan Schumaker11588f42012-03-12 11:33:00 -0400699
700 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500701
Bryan Schumakerc5066942012-08-09 14:05:49 -0400702out3:
703 idmap->idmap_key_cons = NULL;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500704out2:
Bryan Schumakerc5066942012-08-09 14:05:49 -0400705 kfree(data);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500706out1:
David Howellsa427b9e2012-07-25 16:53:36 +0100707 complete_request_key(cons, ret);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500708 return ret;
709}
710
711static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
712{
713 return key_instantiate_and_link(key, data, strlen(data) + 1,
714 id_resolver_cache->thread_keyring,
715 authkey);
716}
717
718static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
719{
720 char id_str[NFS_UINT_MAXLEN];
721 int ret = -EINVAL;
722
723 switch (im->im_conv) {
724 case IDMAP_CONV_NAMETOID:
725 sprintf(id_str, "%d", im->im_id);
726 ret = nfs_idmap_instantiate(key, authkey, id_str);
727 break;
728 case IDMAP_CONV_IDTONAME:
729 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
730 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 }
732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return ret;
734}
735
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736static ssize_t
737idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
738{
Chuck Lever369af0f2007-12-20 14:54:35 -0500739 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 struct idmap *idmap = (struct idmap *)rpci->private;
David Howellsa427b9e2012-07-25 16:53:36 +0100741 struct key_construction *cons;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500742 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500743 size_t namelen_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 int ret;
745
David Howellsa427b9e2012-07-25 16:53:36 +0100746 /* If instantiation is successful, anyone waiting for key construction
747 * will have been woken up and someone else may now have used
748 * idmap_key_cons - so after this point we may no longer touch it.
749 */
Trond Myklebust0e24d842012-09-28 12:03:09 -0400750 cons = idmap->idmap_key_cons;
David Howellsa427b9e2012-07-25 16:53:36 +0100751 idmap->idmap_key_cons = NULL;
752
Bryan Schumaker57e62322012-02-24 14:14:51 -0500753 if (mlen != sizeof(im)) {
754 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 goto out;
756 }
757
Bryan Schumaker57e62322012-02-24 14:14:51 -0500758 if (copy_from_user(&im, src, mlen) != 0) {
759 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 goto out;
761 }
762
Bryan Schumaker57e62322012-02-24 14:14:51 -0500763 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
Bryan Schumaker12dfd082012-08-09 14:05:50 -0400764 ret = -ENOKEY;
765 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500766 }
767
768 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
769 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
770 ret = -EINVAL;
771 goto out;
772 }
773
774 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
775 if (ret >= 0) {
776 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
777 ret = mlen;
778 }
779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780out:
David Howellsa427b9e2012-07-25 16:53:36 +0100781 complete_request_key(cons, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 return ret;
783}
784
Adrian Bunk75c96f82005-05-05 16:16:09 -0700785static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
787{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400788 struct idmap_legacy_upcalldata *data = container_of(msg,
789 struct idmap_legacy_upcalldata,
790 pipe_msg);
791 struct idmap *idmap = data->idmap;
792 struct key_construction *cons;
793 if (msg->errno) {
Trond Myklebust0e24d842012-09-28 12:03:09 -0400794 cons = idmap->idmap_key_cons;
Bryan Schumakerc5066942012-08-09 14:05:49 -0400795 idmap->idmap_key_cons = NULL;
796 complete_request_key(cons, msg->errno);
797 }
Bryan Schumaker57e62322012-02-24 14:14:51 -0500798 /* Free memory allocated in nfs_idmap_legacy_upcall() */
Bryan Schumakerc5066942012-08-09 14:05:49 -0400799 kfree(data);
800}
801
802static void
803idmap_release_pipe(struct inode *inode)
804{
805 struct rpc_inode *rpci = RPC_I(inode);
806 struct idmap *idmap = (struct idmap *)rpci->private;
807 idmap->idmap_key_cons = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808}
809
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800810int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *uid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800812 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800814 if (nfs_map_string_to_numeric(name, namelen, uid))
815 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500816 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817}
818
Bryan Schumakere6499c62012-01-26 16:54:23 -0500819int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, __u32 *gid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800821 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Bryan Schumakere6499c62012-01-26 16:54:23 -0500823 if (nfs_map_string_to_numeric(name, namelen, gid))
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800824 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500825 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826}
827
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800828int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800830 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800831 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Trond Myklebustb064eca22011-02-22 15:44:32 -0800833 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500834 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800835 if (ret < 0)
836 ret = nfs_map_numeric_to_string(uid, buf, buflen);
837 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
Bryan Schumakere6499c62012-01-26 16:54:23 -0500839int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800841 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800842 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
Trond Myklebustb064eca22011-02-22 15:44:32 -0800844 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500845 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800846 if (ret < 0)
Bryan Schumakere6499c62012-01-26 16:54:23 -0500847 ret = nfs_map_numeric_to_string(gid, buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800848 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849}