blob: 93aa3a4c4b0f0bf60f33e809e8147dbd7cb7c5b7 [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
Bryan Schumakerd5b8efa2012-06-20 14:35:28 -040060struct idmap {
61 struct rpc_pipe *idmap_pipe;
62 struct key_construction *idmap_key_cons;
63 struct mutex idmap_mutex;
64};
Trond Myklebust6926afd2012-01-07 13:22:46 -050065
66/**
67 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
68 * @fattr: fully initialised struct nfs_fattr
69 * @owner_name: owner name string cache
70 * @group_name: group name string cache
71 */
72void nfs_fattr_init_names(struct nfs_fattr *fattr,
73 struct nfs4_string *owner_name,
74 struct nfs4_string *group_name)
75{
76 fattr->owner_name = owner_name;
77 fattr->group_name = group_name;
78}
79
80static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
81{
82 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
83 kfree(fattr->owner_name->data);
84}
85
86static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
87{
88 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
89 kfree(fattr->group_name->data);
90}
91
92static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
93{
94 struct nfs4_string *owner = fattr->owner_name;
95 __u32 uid;
96
97 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
98 return false;
99 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
100 fattr->uid = uid;
101 fattr->valid |= NFS_ATTR_FATTR_OWNER;
102 }
103 return true;
104}
105
106static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
107{
108 struct nfs4_string *group = fattr->group_name;
109 __u32 gid;
110
111 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
112 return false;
113 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
114 fattr->gid = gid;
115 fattr->valid |= NFS_ATTR_FATTR_GROUP;
116 }
117 return true;
118}
119
120/**
121 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
122 * @fattr: a fully initialised nfs_fattr structure
123 */
124void nfs_fattr_free_names(struct nfs_fattr *fattr)
125{
126 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
127 nfs_fattr_free_owner_name(fattr);
128 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
129 nfs_fattr_free_group_name(fattr);
130}
131
132/**
133 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
134 * @server: pointer to the filesystem nfs_server structure
135 * @fattr: a fully initialised nfs_fattr structure
136 *
137 * This helper maps the cached NFSv4 owner/group strings in fattr into
138 * their numeric uid/gid equivalents, and then frees the cached strings.
139 */
140void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
141{
142 if (nfs_fattr_map_owner_name(server, fattr))
143 nfs_fattr_free_owner_name(fattr);
144 if (nfs_fattr_map_group_name(server, fattr))
145 nfs_fattr_free_group_name(fattr);
146}
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800147
148static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
149{
150 unsigned long val;
151 char buf[16];
152
153 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
154 return 0;
155 memcpy(buf, name, namelen);
156 buf[namelen] = '\0';
157 if (strict_strtoul(buf, 0, &val) != 0)
158 return 0;
159 *res = val;
160 return 1;
161}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Trond Myklebustf0b85162011-02-22 15:44:31 -0800163static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
164{
165 return snprintf(buf, buflen, "%u", id);
166}
167
Trond Myklebust17280172012-03-11 13:11:00 -0400168static struct key_type key_type_id_resolver = {
Bryan Schumaker955a8572010-09-29 15:41:49 -0400169 .name = "id_resolver",
170 .instantiate = user_instantiate,
171 .match = user_match,
172 .revoke = user_revoke,
173 .destroy = user_destroy,
174 .describe = user_describe,
175 .read = user_read,
176};
177
Bryan Schumakere6499c62012-01-26 16:54:23 -0500178static int nfs_idmap_init_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400179{
180 struct cred *cred;
181 struct key *keyring;
182 int ret = 0;
183
Weston Andros Adamsonf9fd2d92012-01-26 13:32:22 -0500184 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
185 key_type_id_resolver.name);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400186
187 cred = prepare_kernel_cred(NULL);
188 if (!cred)
189 return -ENOMEM;
190
191 keyring = key_alloc(&key_type_keyring, ".id_resolver", 0, 0, cred,
192 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
193 KEY_USR_VIEW | KEY_USR_READ,
194 KEY_ALLOC_NOT_IN_QUOTA);
195 if (IS_ERR(keyring)) {
196 ret = PTR_ERR(keyring);
197 goto failed_put_cred;
198 }
199
200 ret = key_instantiate_and_link(keyring, NULL, 0, NULL, NULL);
201 if (ret < 0)
202 goto failed_put_key;
203
204 ret = register_key_type(&key_type_id_resolver);
205 if (ret < 0)
206 goto failed_put_key;
207
David Howells700920e2012-01-18 15:31:45 +0000208 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400209 cred->thread_keyring = keyring;
210 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
211 id_resolver_cache = cred;
212 return 0;
213
214failed_put_key:
215 key_put(keyring);
216failed_put_cred:
217 put_cred(cred);
218 return ret;
219}
220
Bryan Schumakere6499c62012-01-26 16:54:23 -0500221static void nfs_idmap_quit_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400222{
223 key_revoke(id_resolver_cache->thread_keyring);
224 unregister_key_type(&key_type_id_resolver);
225 put_cred(id_resolver_cache);
226}
227
228/*
229 * Assemble the description to pass to request_key()
230 * This function will allocate a new string and update dest to point
231 * at it. The caller is responsible for freeing dest.
232 *
233 * On error 0 is returned. Otherwise, the length of dest is returned.
234 */
235static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
236 const char *type, size_t typelen, char **desc)
237{
238 char *cp;
239 size_t desclen = typelen + namelen + 2;
240
241 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200242 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400243 return -ENOMEM;
244
245 cp = *desc;
246 memcpy(cp, type, typelen);
247 cp += typelen;
248 *cp++ = ':';
249
250 memcpy(cp, name, namelen);
251 cp += namelen;
252 *cp = '\0';
253 return desclen;
254}
255
Bryan Schumaker57e62322012-02-24 14:14:51 -0500256static ssize_t nfs_idmap_request_key(struct key_type *key_type,
257 const char *name, size_t namelen,
258 const char *type, void *data,
259 size_t data_size, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400260{
261 const struct cred *saved_cred;
262 struct key *rkey;
263 char *desc;
264 struct user_key_payload *payload;
265 ssize_t ret;
266
267 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
268 if (ret <= 0)
269 goto out;
270
271 saved_cred = override_creds(id_resolver_cache);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500272 if (idmap)
273 rkey = request_key_with_auxdata(key_type, desc, "", 0, idmap);
274 else
275 rkey = request_key(&key_type_id_resolver, desc, "");
Bryan Schumaker955a8572010-09-29 15:41:49 -0400276 revert_creds(saved_cred);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500277
Bryan Schumaker955a8572010-09-29 15:41:49 -0400278 kfree(desc);
279 if (IS_ERR(rkey)) {
280 ret = PTR_ERR(rkey);
281 goto out;
282 }
283
284 rcu_read_lock();
285 rkey->perm |= KEY_USR_VIEW;
286
287 ret = key_validate(rkey);
288 if (ret < 0)
289 goto out_up;
290
291 payload = rcu_dereference(rkey->payload.data);
292 if (IS_ERR_OR_NULL(payload)) {
293 ret = PTR_ERR(payload);
294 goto out_up;
295 }
296
297 ret = payload->datalen;
298 if (ret > 0 && ret <= data_size)
299 memcpy(data, payload->data, ret);
300 else
301 ret = -EINVAL;
302
303out_up:
304 rcu_read_unlock();
305 key_put(rkey);
306out:
307 return ret;
308}
309
Bryan Schumaker57e62322012-02-24 14:14:51 -0500310static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
311 const char *type, void *data,
312 size_t data_size, struct idmap *idmap)
313{
314 ssize_t ret = nfs_idmap_request_key(&key_type_id_resolver,
315 name, namelen, type, data,
316 data_size, NULL);
317 if (ret < 0) {
Bryan Schumakerd5b8efa2012-06-20 14:35:28 -0400318 mutex_lock(&idmap->idmap_mutex);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500319 ret = nfs_idmap_request_key(&key_type_id_resolver_legacy,
320 name, namelen, type, data,
321 data_size, idmap);
Bryan Schumakerd5b8efa2012-06-20 14:35:28 -0400322 mutex_unlock(&idmap->idmap_mutex);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500323 }
324 return ret;
325}
Bryan Schumaker955a8572010-09-29 15:41:49 -0400326
327/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500328static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
329 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400330{
331 char id_str[NFS_UINT_MAXLEN];
332 int id_len;
333 ssize_t ret;
334
335 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500336 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400337 if (ret < 0)
338 return -EINVAL;
339 return ret;
340}
341
342/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500343static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
344 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400345{
346 char id_str[NFS_UINT_MAXLEN];
347 long id_long;
348 ssize_t data_size;
349 int ret = 0;
350
Bryan Schumaker57e62322012-02-24 14:14:51 -0500351 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400352 if (data_size <= 0) {
353 ret = -EINVAL;
354 } else {
355 ret = strict_strtol(id_str, 10, &id_long);
356 *id = (__u32)id_long;
357 }
358 return ret;
359}
360
Bryan Schumakere6499c62012-01-26 16:54:23 -0500361/* idmap classic begins here */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500362module_param(nfs_idmap_cache_timeout, int, 0644);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
Bryan Schumaker57e62322012-02-24 14:14:51 -0500364enum {
365 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
366};
367
368static const match_table_t nfs_idmap_tokens = {
369 { Opt_find_uid, "uid:%s" },
370 { Opt_find_gid, "gid:%s" },
371 { Opt_find_user, "user:%s" },
372 { Opt_find_group, "group:%s" },
373 { Opt_find_err, NULL }
374};
375
376static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500377static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
378 size_t);
379static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Trond Myklebustb693ba42009-08-09 15:14:15 -0400381static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400382 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500383 .downcall = idmap_pipe_downcall,
384 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385};
386
Trond Myklebust17280172012-03-11 13:11:00 -0400387static struct key_type key_type_id_resolver_legacy = {
Bryan Schumaker57e62322012-02-24 14:14:51 -0500388 .name = "id_resolver",
389 .instantiate = user_instantiate,
390 .match = user_match,
391 .revoke = user_revoke,
392 .destroy = user_destroy,
393 .describe = user_describe,
394 .read = user_read,
395 .request_key = nfs_idmap_legacy_upcall,
396};
397
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400398static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
399{
400 if (pipe->dentry)
401 rpc_unlink(pipe->dentry);
402}
403
404static int __nfs_idmap_register(struct dentry *dir,
405 struct idmap *idmap,
406 struct rpc_pipe *pipe)
407{
408 struct dentry *dentry;
409
410 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
411 if (IS_ERR(dentry))
412 return PTR_ERR(dentry);
413 pipe->dentry = dentry;
414 return 0;
415}
416
417static void nfs_idmap_unregister(struct nfs_client *clp,
418 struct rpc_pipe *pipe)
419{
420 struct net *net = clp->net;
421 struct super_block *pipefs_sb;
422
423 pipefs_sb = rpc_get_sb_net(net);
424 if (pipefs_sb) {
425 __nfs_idmap_unregister(pipe);
426 rpc_put_sb_net(net);
427 }
428}
429
430static int nfs_idmap_register(struct nfs_client *clp,
431 struct idmap *idmap,
432 struct rpc_pipe *pipe)
433{
434 struct net *net = clp->net;
435 struct super_block *pipefs_sb;
436 int err = 0;
437
438 pipefs_sb = rpc_get_sb_net(net);
439 if (pipefs_sb) {
440 if (clp->cl_rpcclient->cl_dentry)
441 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
442 idmap, pipe);
443 rpc_put_sb_net(net);
444 }
445 return err;
446}
447
David Howellsb7162792006-08-22 20:06:09 -0400448int
David Howellsadfa6f92006-08-22 20:06:08 -0400449nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
451 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300452 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400453 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
David Howells54ceac42006-08-22 20:06:13 -0400455 BUG_ON(clp->cl_idmap != NULL);
David Howellsb7162792006-08-22 20:06:09 -0400456
Chuck Lever369af0f2007-12-20 14:54:35 -0500457 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
458 if (idmap == NULL)
459 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300461 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
462 if (IS_ERR(pipe)) {
463 error = PTR_ERR(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 kfree(idmap);
David Howellsb7162792006-08-22 20:06:09 -0400465 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400467 error = nfs_idmap_register(clp, idmap, pipe);
468 if (error) {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300469 rpc_destroy_pipe_data(pipe);
470 kfree(idmap);
471 return error;
472 }
473 idmap->idmap_pipe = pipe;
Bryan Schumakerd5b8efa2012-06-20 14:35:28 -0400474 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400477 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
480void
David Howellsadfa6f92006-08-22 20:06:08 -0400481nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482{
483 struct idmap *idmap = clp->cl_idmap;
484
485 if (!idmap)
486 return;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400487 nfs_idmap_unregister(clp, idmap->idmap_pipe);
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300488 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 clp->cl_idmap = NULL;
490 kfree(idmap);
491}
492
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400493static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
494 struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400496 int err = 0;
497
498 switch (event) {
499 case RPC_PIPEFS_MOUNT:
500 BUG_ON(clp->cl_rpcclient->cl_dentry == NULL);
501 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
502 clp->cl_idmap,
503 clp->cl_idmap->idmap_pipe);
504 break;
505 case RPC_PIPEFS_UMOUNT:
506 if (clp->cl_idmap->idmap_pipe) {
507 struct dentry *parent;
508
509 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
510 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
511 /*
512 * Note: This is a dirty hack. SUNRPC hook has been
513 * called already but simple_rmdir() call for the
514 * directory returned with error because of idmap pipe
515 * inside. Thus now we have to remove this directory
516 * here.
517 */
518 if (rpc_rmdir(parent))
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500519 printk(KERN_ERR "NFS: %s: failed to remove "
520 "clnt dir!\n", __func__);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400521 }
522 break;
523 default:
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500524 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
525 event);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400526 return -ENOTSUPP;
527 }
528 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529}
530
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400531static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400533 struct nfs_net *nn = net_generic(net, nfs_net_id);
534 struct dentry *cl_dentry;
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400535 struct nfs_client *clp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Stanislav Kinsburskydc030852012-01-23 17:26:31 +0000537 spin_lock(&nn->nfs_client_lock);
Stanislav Kinsbursky6b131682012-01-23 17:26:05 +0000538 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400539 if (clp->rpc_ops != &nfs_v4_clientops)
540 continue;
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400541 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
542 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
543 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
544 continue;
545 atomic_inc(&clp->cl_count);
546 spin_unlock(&nn->nfs_client_lock);
547 return clp;
548 }
549 spin_unlock(&nn->nfs_client_lock);
550 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551}
552
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400553static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
554 void *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400556 struct super_block *sb = ptr;
557 struct nfs_client *clp;
558 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400560 if (!try_module_get(THIS_MODULE))
561 return 0;
562
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400563 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400564 error = __rpc_pipefs_event(clp, event, sb);
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400565 nfs_put_client(clp);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400566 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 }
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400569 module_put(THIS_MODULE);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400570 return error;
571}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400573#define PIPEFS_NFS_PRIO 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400575static struct notifier_block nfs_idmap_block = {
576 .notifier_call = rpc_pipefs_event,
577 .priority = SUNRPC_PIPEFS_NFS_PRIO,
578};
579
580int nfs_idmap_init(void)
581{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500582 int ret;
583 ret = nfs_idmap_init_keyring();
584 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500586 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
587 if (ret != 0)
588 nfs_idmap_quit_keyring();
589out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500590 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400593void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400595 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
Bryan Schumakere6499c62012-01-26 16:54:23 -0500596 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400597}
598
Bryan Schumaker57e62322012-02-24 14:14:51 -0500599static int nfs_idmap_prepare_message(char *desc, struct idmap_msg *im,
600 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500602 substring_t substr;
603 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604
Bryan Schumaker57e62322012-02-24 14:14:51 -0500605 memset(im, 0, sizeof(*im));
606 memset(msg, 0, sizeof(*msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Bryan Schumaker57e62322012-02-24 14:14:51 -0500608 im->im_type = IDMAP_TYPE_GROUP;
609 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Bryan Schumaker57e62322012-02-24 14:14:51 -0500611 switch (token) {
612 case Opt_find_uid:
613 im->im_type = IDMAP_TYPE_USER;
614 case Opt_find_gid:
615 im->im_conv = IDMAP_CONV_NAMETOID;
616 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
617 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Bryan Schumaker57e62322012-02-24 14:14:51 -0500619 case Opt_find_user:
620 im->im_type = IDMAP_TYPE_USER;
621 case Opt_find_group:
622 im->im_conv = IDMAP_CONV_IDTONAME;
623 ret = match_int(&substr, &im->im_id);
624 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500625
Bryan Schumaker57e62322012-02-24 14:14:51 -0500626 default:
627 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 goto out;
629 }
630
Bryan Schumaker57e62322012-02-24 14:14:51 -0500631 msg->data = im;
632 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Bryan Schumaker57e62322012-02-24 14:14:51 -0500634out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 return ret;
636}
637
Bryan Schumaker57e62322012-02-24 14:14:51 -0500638static int nfs_idmap_legacy_upcall(struct key_construction *cons,
639 const char *op,
640 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500642 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500644 struct idmap *idmap = (struct idmap *)aux;
645 struct key *key = cons->key;
Dan Carpenterc7806822012-05-14 22:45:28 +0300646 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Bryan Schumaker57e62322012-02-24 14:14:51 -0500648 /* msg and im are freed in idmap_pipe_destroy_msg */
649 msg = kmalloc(sizeof(*msg), GFP_KERNEL);
Dan Carpenterc7806822012-05-14 22:45:28 +0300650 if (!msg)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500651 goto out0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Bryan Schumaker57e62322012-02-24 14:14:51 -0500653 im = kmalloc(sizeof(*im), GFP_KERNEL);
Dan Carpenterc7806822012-05-14 22:45:28 +0300654 if (!im)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500655 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
Bryan Schumaker57e62322012-02-24 14:14:51 -0500657 ret = nfs_idmap_prepare_message(key->description, im, msg);
658 if (ret < 0)
659 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Bryan Schumaker57e62322012-02-24 14:14:51 -0500661 idmap->idmap_key_cons = cons;
662
Bryan Schumaker11588f42012-03-12 11:33:00 -0400663 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
664 if (ret < 0)
665 goto out2;
666
667 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500668
669out2:
670 kfree(im);
671out1:
672 kfree(msg);
673out0:
Bryan Schumaker11588f42012-03-12 11:33:00 -0400674 key_revoke(cons->key);
675 key_revoke(cons->authkey);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500676 return ret;
677}
678
679static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
680{
681 return key_instantiate_and_link(key, data, strlen(data) + 1,
682 id_resolver_cache->thread_keyring,
683 authkey);
684}
685
686static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
687{
688 char id_str[NFS_UINT_MAXLEN];
689 int ret = -EINVAL;
690
691 switch (im->im_conv) {
692 case IDMAP_CONV_NAMETOID:
693 sprintf(id_str, "%d", im->im_id);
694 ret = nfs_idmap_instantiate(key, authkey, id_str);
695 break;
696 case IDMAP_CONV_IDTONAME:
697 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
698 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 }
700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 return ret;
702}
703
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704static ssize_t
705idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
706{
Chuck Lever369af0f2007-12-20 14:54:35 -0500707 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 struct idmap *idmap = (struct idmap *)rpci->private;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500709 struct key_construction *cons = idmap->idmap_key_cons;
710 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500711 size_t namelen_in;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 int ret;
713
Bryan Schumaker57e62322012-02-24 14:14:51 -0500714 if (mlen != sizeof(im)) {
715 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 goto out;
717 }
718
Bryan Schumaker57e62322012-02-24 14:14:51 -0500719 if (copy_from_user(&im, src, mlen) != 0) {
720 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 goto out;
722 }
723
Bryan Schumaker57e62322012-02-24 14:14:51 -0500724 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
725 ret = mlen;
726 complete_request_key(idmap->idmap_key_cons, -ENOKEY);
727 goto out_incomplete;
728 }
729
730 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
731 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
732 ret = -EINVAL;
733 goto out;
734 }
735
736 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
737 if (ret >= 0) {
738 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
739 ret = mlen;
740 }
741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742out:
Bryan Schumaker57e62322012-02-24 14:14:51 -0500743 complete_request_key(idmap->idmap_key_cons, ret);
744out_incomplete:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 return ret;
746}
747
Adrian Bunk75c96f82005-05-05 16:16:09 -0700748static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
750{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500751 /* Free memory allocated in nfs_idmap_legacy_upcall() */
752 kfree(msg->data);
753 kfree(msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754}
755
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800756int 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 -0700757{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800758 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800760 if (nfs_map_string_to_numeric(name, namelen, uid))
761 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500762 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763}
764
Bryan Schumakere6499c62012-01-26 16:54:23 -0500765int 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 -0700766{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800767 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Bryan Schumakere6499c62012-01-26 16:54:23 -0500769 if (nfs_map_string_to_numeric(name, namelen, gid))
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800770 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500771 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800774int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800776 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800777 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Trond Myklebustb064eca22011-02-22 15:44:32 -0800779 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500780 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800781 if (ret < 0)
782 ret = nfs_map_numeric_to_string(uid, buf, buflen);
783 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784}
Bryan Schumakere6499c62012-01-26 16:54:23 -0500785int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800787 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800788 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
Trond Myklebustb064eca22011-02-22 15:44:32 -0800790 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500791 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800792 if (ret < 0)
Bryan Schumakere6499c62012-01-26 16:54:23 -0500793 ret = nfs_map_numeric_to_string(gid, buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800794 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795}