blob: ba3019f5934c21a610a96569b1d239b90eca0459 [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
55/* Default cache timeout is 10 minutes */
Bryan Schumaker57e62322012-02-24 14:14:51 -050056unsigned int nfs_idmap_cache_timeout = 600;
Trond Myklebust17280172012-03-11 13:11:00 -040057static const struct cred *id_resolver_cache;
58static struct key_type key_type_id_resolver_legacy;
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050059
Trond Myklebust6926afd2012-01-07 13:22:46 -050060
61/**
62 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
63 * @fattr: fully initialised struct nfs_fattr
64 * @owner_name: owner name string cache
65 * @group_name: group name string cache
66 */
67void nfs_fattr_init_names(struct nfs_fattr *fattr,
68 struct nfs4_string *owner_name,
69 struct nfs4_string *group_name)
70{
71 fattr->owner_name = owner_name;
72 fattr->group_name = group_name;
73}
74
75static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
76{
77 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
78 kfree(fattr->owner_name->data);
79}
80
81static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
82{
83 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
84 kfree(fattr->group_name->data);
85}
86
87static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
88{
89 struct nfs4_string *owner = fattr->owner_name;
90 __u32 uid;
91
92 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
93 return false;
94 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
95 fattr->uid = uid;
96 fattr->valid |= NFS_ATTR_FATTR_OWNER;
97 }
98 return true;
99}
100
101static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
102{
103 struct nfs4_string *group = fattr->group_name;
104 __u32 gid;
105
106 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
107 return false;
108 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
109 fattr->gid = gid;
110 fattr->valid |= NFS_ATTR_FATTR_GROUP;
111 }
112 return true;
113}
114
115/**
116 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
117 * @fattr: a fully initialised nfs_fattr structure
118 */
119void nfs_fattr_free_names(struct nfs_fattr *fattr)
120{
121 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
122 nfs_fattr_free_owner_name(fattr);
123 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
124 nfs_fattr_free_group_name(fattr);
125}
126
127/**
128 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
129 * @server: pointer to the filesystem nfs_server structure
130 * @fattr: a fully initialised nfs_fattr structure
131 *
132 * This helper maps the cached NFSv4 owner/group strings in fattr into
133 * their numeric uid/gid equivalents, and then frees the cached strings.
134 */
135void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
136{
137 if (nfs_fattr_map_owner_name(server, fattr))
138 nfs_fattr_free_owner_name(fattr);
139 if (nfs_fattr_map_group_name(server, fattr))
140 nfs_fattr_free_group_name(fattr);
141}
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800142
143static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
144{
145 unsigned long val;
146 char buf[16];
147
148 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
149 return 0;
150 memcpy(buf, name, namelen);
151 buf[namelen] = '\0';
152 if (strict_strtoul(buf, 0, &val) != 0)
153 return 0;
154 *res = val;
155 return 1;
156}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Trond Myklebustf0b85162011-02-22 15:44:31 -0800158static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
159{
160 return snprintf(buf, buflen, "%u", id);
161}
162
Trond Myklebust17280172012-03-11 13:11:00 -0400163static struct key_type key_type_id_resolver = {
Bryan Schumaker955a8572010-09-29 15:41:49 -0400164 .name = "id_resolver",
165 .instantiate = user_instantiate,
166 .match = user_match,
167 .revoke = user_revoke,
168 .destroy = user_destroy,
169 .describe = user_describe,
170 .read = user_read,
171};
172
Bryan Schumakere6499c62012-01-26 16:54:23 -0500173static int nfs_idmap_init_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400174{
175 struct cred *cred;
176 struct key *keyring;
177 int ret = 0;
178
Weston Andros Adamsonf9fd2d92012-01-26 13:32:22 -0500179 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
180 key_type_id_resolver.name);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400181
182 cred = prepare_kernel_cred(NULL);
183 if (!cred)
184 return -ENOMEM;
185
186 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
187 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
188 KEY_USR_VIEW | KEY_USR_READ,
189 KEY_ALLOC_NOT_IN_QUOTA);
190 if (IS_ERR(keyring)) {
191 ret = PTR_ERR(keyring);
192 goto failed_put_cred;
193 }
194
195 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
196 if (ret < 0)
197 goto failed_put_key;
198
199 ret = register_key_type(&key_type_id_resolver);
200 if (ret < 0)
201 goto failed_put_key;
202
David Howells700920e2012-01-18 15:31:45 +0000203 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400204 cred->thread_keyring = keyring;
205 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
206 id_resolver_cache = cred;
207 return 0;
208
209failed_put_key:
210 key_put(keyring);
211failed_put_cred:
212 put_cred(cred);
213 return ret;
214}
215
Bryan Schumakere6499c62012-01-26 16:54:23 -0500216static void nfs_idmap_quit_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400217{
218 key_revoke(id_resolver_cache->thread_keyring);
219 unregister_key_type(&key_type_id_resolver);
220 put_cred(id_resolver_cache);
221}
222
223/*
224 * Assemble the description to pass to request_key()
225 * This function will allocate a new string and update dest to point
226 * at it. The caller is responsible for freeing dest.
227 *
228 * On error 0 is returned. Otherwise, the length of dest is returned.
229 */
230static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
231 const char *type, size_t typelen, char **desc)
232{
233 char *cp;
234 size_t desclen = typelen + namelen + 2;
235
236 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200237 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400238 return -ENOMEM;
239
240 cp = *desc;
241 memcpy(cp, type, typelen);
242 cp += typelen;
243 *cp++ = ':';
244
245 memcpy(cp, name, namelen);
246 cp += namelen;
247 *cp = '\0';
248 return desclen;
249}
250
Bryan Schumaker57e62322012-02-24 14:14:51 -0500251static ssize_t nfs_idmap_request_key(struct key_type *key_type,
252 const char *name, size_t namelen,
253 const char *type, void *data,
254 size_t data_size, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400255{
256 const struct cred *saved_cred;
257 struct key *rkey;
258 char *desc;
259 struct user_key_payload *payload;
260 ssize_t ret;
261
262 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
263 if (ret <= 0)
264 goto out;
265
266 saved_cred = override_creds(id_resolver_cache);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500267 if (idmap)
268 rkey = request_key_with_auxdata(key_type, desc, "", 0, idmap);
269 else
270 rkey = request_key(&key_type_id_resolver, desc, "");
Bryan Schumaker955a8572010-09-29 15:41:49 -0400271 revert_creds(saved_cred);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500272
Bryan Schumaker955a8572010-09-29 15:41:49 -0400273 kfree(desc);
274 if (IS_ERR(rkey)) {
275 ret = PTR_ERR(rkey);
276 goto out;
277 }
278
279 rcu_read_lock();
280 rkey->perm |= KEY_USR_VIEW;
281
282 ret = key_validate(rkey);
283 if (ret < 0)
284 goto out_up;
285
286 payload = rcu_dereference(rkey->payload.data);
287 if (IS_ERR_OR_NULL(payload)) {
288 ret = PTR_ERR(payload);
289 goto out_up;
290 }
291
292 ret = payload->datalen;
293 if (ret > 0 && ret <= data_size)
294 memcpy(data, payload->data, ret);
295 else
296 ret = -EINVAL;
297
298out_up:
299 rcu_read_unlock();
300 key_put(rkey);
301out:
302 return ret;
303}
304
Bryan Schumaker57e62322012-02-24 14:14:51 -0500305static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
306 const char *type, void *data,
307 size_t data_size, struct idmap *idmap)
308{
309 ssize_t ret = nfs_idmap_request_key(&key_type_id_resolver,
310 name, namelen, type, data,
311 data_size, NULL);
312 if (ret < 0) {
313 ret = nfs_idmap_request_key(&key_type_id_resolver_legacy,
314 name, namelen, type, data,
315 data_size, idmap);
316 }
317 return ret;
318}
Bryan Schumaker955a8572010-09-29 15:41:49 -0400319
320/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500321static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
322 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400323{
324 char id_str[NFS_UINT_MAXLEN];
325 int id_len;
326 ssize_t ret;
327
328 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500329 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400330 if (ret < 0)
331 return -EINVAL;
332 return ret;
333}
334
335/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500336static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
337 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400338{
339 char id_str[NFS_UINT_MAXLEN];
340 long id_long;
341 ssize_t data_size;
342 int ret = 0;
343
Bryan Schumaker57e62322012-02-24 14:14:51 -0500344 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400345 if (data_size <= 0) {
346 ret = -EINVAL;
347 } else {
348 ret = strict_strtol(id_str, 10, &id_long);
349 *id = (__u32)id_long;
350 }
351 return ret;
352}
353
Bryan Schumakere6499c62012-01-26 16:54:23 -0500354/* idmap classic begins here */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500355module_param(nfs_idmap_cache_timeout, int, 0644);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
357struct idmap {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300358 struct rpc_pipe *idmap_pipe;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500359 struct key_construction *idmap_key_cons;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360};
361
Bryan Schumaker57e62322012-02-24 14:14:51 -0500362enum {
363 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
364};
365
366static const match_table_t nfs_idmap_tokens = {
367 { Opt_find_uid, "uid:%s" },
368 { Opt_find_gid, "gid:%s" },
369 { Opt_find_user, "user:%s" },
370 { Opt_find_group, "group:%s" },
371 { Opt_find_err, NULL }
372};
373
374static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500375static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
376 size_t);
377static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Trond Myklebustb693ba42009-08-09 15:14:15 -0400379static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400380 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500381 .downcall = idmap_pipe_downcall,
382 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383};
384
Trond Myklebust17280172012-03-11 13:11:00 -0400385static struct key_type key_type_id_resolver_legacy = {
Bryan Schumaker57e62322012-02-24 14:14:51 -0500386 .name = "id_resolver",
387 .instantiate = user_instantiate,
388 .match = user_match,
389 .revoke = user_revoke,
390 .destroy = user_destroy,
391 .describe = user_describe,
392 .read = user_read,
393 .request_key = nfs_idmap_legacy_upcall,
394};
395
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400396static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
397{
398 if (pipe->dentry)
399 rpc_unlink(pipe->dentry);
400}
401
402static int __nfs_idmap_register(struct dentry *dir,
403 struct idmap *idmap,
404 struct rpc_pipe *pipe)
405{
406 struct dentry *dentry;
407
408 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
409 if (IS_ERR(dentry))
410 return PTR_ERR(dentry);
411 pipe->dentry = dentry;
412 return 0;
413}
414
415static void nfs_idmap_unregister(struct nfs_client *clp,
416 struct rpc_pipe *pipe)
417{
418 struct net *net = clp->net;
419 struct super_block *pipefs_sb;
420
421 pipefs_sb = rpc_get_sb_net(net);
422 if (pipefs_sb) {
423 __nfs_idmap_unregister(pipe);
424 rpc_put_sb_net(net);
425 }
426}
427
428static int nfs_idmap_register(struct nfs_client *clp,
429 struct idmap *idmap,
430 struct rpc_pipe *pipe)
431{
432 struct net *net = clp->net;
433 struct super_block *pipefs_sb;
434 int err = 0;
435
436 pipefs_sb = rpc_get_sb_net(net);
437 if (pipefs_sb) {
438 if (clp->cl_rpcclient->cl_dentry)
439 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
440 idmap, pipe);
441 rpc_put_sb_net(net);
442 }
443 return err;
444}
445
David Howellsb7162792006-08-22 20:06:09 -0400446int
David Howellsadfa6f92006-08-22 20:06:08 -0400447nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448{
449 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300450 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400451 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
David Howells54ceac42006-08-22 20:06:13 -0400453 BUG_ON(clp->cl_idmap != NULL);
David Howellsb7162792006-08-22 20:06:09 -0400454
Chuck Lever369af0f2007-12-20 14:54:35 -0500455 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
456 if (idmap == NULL)
457 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300459 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
460 if (IS_ERR(pipe)) {
461 error = PTR_ERR(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 kfree(idmap);
David Howellsb7162792006-08-22 20:06:09 -0400463 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400465 error = nfs_idmap_register(clp, idmap, pipe);
466 if (error) {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300467 rpc_destroy_pipe_data(pipe);
468 kfree(idmap);
469 return error;
470 }
471 idmap->idmap_pipe = pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400474 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475}
476
477void
David Howellsadfa6f92006-08-22 20:06:08 -0400478nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
480 struct idmap *idmap = clp->cl_idmap;
481
482 if (!idmap)
483 return;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400484 nfs_idmap_unregister(clp, idmap->idmap_pipe);
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300485 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 clp->cl_idmap = NULL;
487 kfree(idmap);
488}
489
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400490static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
491 struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400493 int err = 0;
494
495 switch (event) {
496 case RPC_PIPEFS_MOUNT:
497 BUG_ON(clp->cl_rpcclient->cl_dentry == NULL);
498 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
499 clp->cl_idmap,
500 clp->cl_idmap->idmap_pipe);
501 break;
502 case RPC_PIPEFS_UMOUNT:
503 if (clp->cl_idmap->idmap_pipe) {
504 struct dentry *parent;
505
506 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
507 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
508 /*
509 * Note: This is a dirty hack. SUNRPC hook has been
510 * called already but simple_rmdir() call for the
511 * directory returned with error because of idmap pipe
512 * inside. Thus now we have to remove this directory
513 * here.
514 */
515 if (rpc_rmdir(parent))
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500516 printk(KERN_ERR "NFS: %s: failed to remove "
517 "clnt dir!\n", __func__);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400518 }
519 break;
520 default:
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500521 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
522 event);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400523 return -ENOTSUPP;
524 }
525 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526}
527
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400528static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400530 struct nfs_net *nn = net_generic(net, nfs_net_id);
531 struct dentry *cl_dentry;
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400532 struct nfs_client *clp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
Stanislav Kinsburskydc030852012-01-23 17:26:31 +0000534 spin_lock(&nn->nfs_client_lock);
Stanislav Kinsbursky6b131682012-01-23 17:26:05 +0000535 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400536 if (clp->rpc_ops != &nfs_v4_clientops)
537 continue;
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400538 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
539 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
540 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
541 continue;
542 atomic_inc(&clp->cl_count);
543 spin_unlock(&nn->nfs_client_lock);
544 return clp;
545 }
546 spin_unlock(&nn->nfs_client_lock);
547 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548}
549
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400550static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
551 void *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400553 struct super_block *sb = ptr;
554 struct nfs_client *clp;
555 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400557 if (!try_module_get(THIS_MODULE))
558 return 0;
559
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400560 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400561 error = __rpc_pipefs_event(clp, event, sb);
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400562 nfs_put_client(clp);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400563 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400566 module_put(THIS_MODULE);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400567 return error;
568}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400570#define PIPEFS_NFS_PRIO 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400572static struct notifier_block nfs_idmap_block = {
573 .notifier_call = rpc_pipefs_event,
574 .priority = SUNRPC_PIPEFS_NFS_PRIO,
575};
576
577int nfs_idmap_init(void)
578{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500579 int ret;
580 ret = nfs_idmap_init_keyring();
581 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500583 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
584 if (ret != 0)
585 nfs_idmap_quit_keyring();
586out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500587 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588}
589
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400590void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400592 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
Bryan Schumakere6499c62012-01-26 16:54:23 -0500593 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400594}
595
Bryan Schumaker57e62322012-02-24 14:14:51 -0500596static int nfs_idmap_prepare_message(char *desc, struct idmap_msg *im,
597 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500599 substring_t substr;
600 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Bryan Schumaker57e62322012-02-24 14:14:51 -0500602 memset(im, 0, sizeof(*im));
603 memset(msg, 0, sizeof(*msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
Bryan Schumaker57e62322012-02-24 14:14:51 -0500605 im->im_type = IDMAP_TYPE_GROUP;
606 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Bryan Schumaker57e62322012-02-24 14:14:51 -0500608 switch (token) {
609 case Opt_find_uid:
610 im->im_type = IDMAP_TYPE_USER;
611 case Opt_find_gid:
612 im->im_conv = IDMAP_CONV_NAMETOID;
613 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
614 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Bryan Schumaker57e62322012-02-24 14:14:51 -0500616 case Opt_find_user:
617 im->im_type = IDMAP_TYPE_USER;
618 case Opt_find_group:
619 im->im_conv = IDMAP_CONV_IDTONAME;
620 ret = match_int(&substr, &im->im_id);
621 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500622
Bryan Schumaker57e62322012-02-24 14:14:51 -0500623 default:
624 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 goto out;
626 }
627
Bryan Schumaker57e62322012-02-24 14:14:51 -0500628 msg->data = im;
629 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Bryan Schumaker57e62322012-02-24 14:14:51 -0500631out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 return ret;
633}
634
Bryan Schumaker57e62322012-02-24 14:14:51 -0500635static int nfs_idmap_legacy_upcall(struct key_construction *cons,
636 const char *op,
637 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500639 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500641 struct idmap *idmap = (struct idmap *)aux;
642 struct key *key = cons->key;
643 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Bryan Schumaker57e62322012-02-24 14:14:51 -0500645 /* msg and im are freed in idmap_pipe_destroy_msg */
646 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
647 if (IS_ERR(msg)) {
648 ret = PTR_ERR(msg);
649 goto out0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 }
651
Bryan Schumaker57e62322012-02-24 14:14:51 -0500652 im = kmalloc(sizeof(*im), GFP_KERNEL);
653 if (IS_ERR(im)) {
654 ret = PTR_ERR(im);
655 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 }
657
Bryan Schumaker57e62322012-02-24 14:14:51 -0500658 ret = nfs_idmap_prepare_message(key->description, im, msg);
659 if (ret < 0)
660 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
Bryan Schumaker57e62322012-02-24 14:14:51 -0500662 idmap->idmap_key_cons = cons;
663
Bryan Schumaker11588f42012-03-12 11:33:00 -0400664 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
665 if (ret < 0)
666 goto out2;
667
668 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500669
670out2:
671 kfree(im);
672out1:
673 kfree(msg);
674out0:
Bryan Schumaker11588f42012-03-12 11:33:00 -0400675 key_revoke(cons->key);
676 key_revoke(cons->authkey);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500677 return ret;
678}
679
680static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
681{
682 return key_instantiate_and_link(key, data, strlen(data) + 1,
683 id_resolver_cache->thread_keyring,
684 authkey);
685}
686
687static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
688{
689 char id_str[NFS_UINT_MAXLEN];
690 int ret = -EINVAL;
691
692 switch (im->im_conv) {
693 case IDMAP_CONV_NAMETOID:
694 sprintf(id_str, "%d", im->im_id);
695 ret = nfs_idmap_instantiate(key, authkey, id_str);
696 break;
697 case IDMAP_CONV_IDTONAME:
698 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
699 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 }
701
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 return ret;
703}
704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705static ssize_t
706idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
707{
Chuck Lever369af0f2007-12-20 14:54:35 -0500708 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 struct idmap *idmap = (struct idmap *)rpci->private;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500710 struct key_construction *cons = idmap->idmap_key_cons;
711 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500712 size_t namelen_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 int ret;
714
Bryan Schumaker57e62322012-02-24 14:14:51 -0500715 if (mlen != sizeof(im)) {
716 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 goto out;
718 }
719
Bryan Schumaker57e62322012-02-24 14:14:51 -0500720 if (copy_from_user(&im, src, mlen) != 0) {
721 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 goto out;
723 }
724
Bryan Schumaker57e62322012-02-24 14:14:51 -0500725 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
726 ret = mlen;
727 complete_request_key(idmap->idmap_key_cons, -ENOKEY);
728 goto out_incomplete;
729 }
730
731 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
732 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
733 ret = -EINVAL;
734 goto out;
735 }
736
737 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
738 if (ret >= 0) {
739 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
740 ret = mlen;
741 }
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743out:
Bryan Schumaker57e62322012-02-24 14:14:51 -0500744 complete_request_key(idmap->idmap_key_cons, ret);
745out_incomplete:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 return ret;
747}
748
Adrian Bunk75c96f82005-05-05 16:16:09 -0700749static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
751{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500752 /* Free memory allocated in nfs_idmap_legacy_upcall() */
753 kfree(msg->data);
754 kfree(msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755}
756
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800757int 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 -0700758{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800759 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800761 if (nfs_map_string_to_numeric(name, namelen, uid))
762 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500763 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
765
Bryan Schumakere6499c62012-01-26 16:54:23 -0500766int 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 -0700767{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800768 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Bryan Schumakere6499c62012-01-26 16:54:23 -0500770 if (nfs_map_string_to_numeric(name, namelen, gid))
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800771 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500772 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800775int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800777 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800778 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Trond Myklebustb064eca22011-02-22 15:44:32 -0800780 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500781 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800782 if (ret < 0)
783 ret = nfs_map_numeric_to_string(uid, buf, buflen);
784 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785}
Bryan Schumakere6499c62012-01-26 16:54:23 -0500786int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800788 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800789 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Trond Myklebustb064eca22011-02-22 15:44:32 -0800791 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500792 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800793 if (ret < 0)
Bryan Schumakere6499c62012-01-26 16:54:23 -0500794 ret = nfs_map_numeric_to_string(gid, buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800795 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}