blob: 8222ad861456458dcf17971fb3ade26beda95287 [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 Schumakerb1027432012-06-20 14:35:28 -0400333 mutex_unlock(&idmap->idmap_mutex);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500334 }
335 return ret;
336}
Bryan Schumaker955a8572010-09-29 15:41:49 -0400337
338/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500339static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
340 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400341{
342 char id_str[NFS_UINT_MAXLEN];
343 int id_len;
344 ssize_t ret;
345
346 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500347 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400348 if (ret < 0)
349 return -EINVAL;
350 return ret;
351}
352
353/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500354static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
355 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400356{
357 char id_str[NFS_UINT_MAXLEN];
358 long id_long;
359 ssize_t data_size;
360 int ret = 0;
361
Bryan Schumaker57e62322012-02-24 14:14:51 -0500362 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400363 if (data_size <= 0) {
364 ret = -EINVAL;
365 } else {
366 ret = strict_strtol(id_str, 10, &id_long);
367 *id = (__u32)id_long;
368 }
369 return ret;
370}
371
Bryan Schumakere6499c62012-01-26 16:54:23 -0500372/* idmap classic begins here */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Bryan Schumaker57e62322012-02-24 14:14:51 -0500374enum {
375 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
376};
377
378static const match_table_t nfs_idmap_tokens = {
379 { Opt_find_uid, "uid:%s" },
380 { Opt_find_gid, "gid:%s" },
381 { Opt_find_user, "user:%s" },
382 { Opt_find_group, "group:%s" },
383 { Opt_find_err, NULL }
384};
385
386static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500387static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
388 size_t);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400389static void idmap_release_pipe(struct inode *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500390static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Trond Myklebustb693ba42009-08-09 15:14:15 -0400392static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400393 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500394 .downcall = idmap_pipe_downcall,
Bryan Schumakerc5066942012-08-09 14:05:49 -0400395 .release_pipe = idmap_release_pipe,
Chuck Lever369af0f2007-12-20 14:54:35 -0500396 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397};
398
Trond Myklebust17280172012-03-11 13:11:00 -0400399static struct key_type key_type_id_resolver_legacy = {
David Howellsa427b9e2012-07-25 16:53:36 +0100400 .name = "id_legacy",
Bryan Schumaker57e62322012-02-24 14:14:51 -0500401 .instantiate = user_instantiate,
402 .match = user_match,
403 .revoke = user_revoke,
404 .destroy = user_destroy,
405 .describe = user_describe,
406 .read = user_read,
407 .request_key = nfs_idmap_legacy_upcall,
408};
409
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400410static void __nfs_idmap_unregister(struct rpc_pipe *pipe)
411{
412 if (pipe->dentry)
413 rpc_unlink(pipe->dentry);
414}
415
416static int __nfs_idmap_register(struct dentry *dir,
417 struct idmap *idmap,
418 struct rpc_pipe *pipe)
419{
420 struct dentry *dentry;
421
422 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
423 if (IS_ERR(dentry))
424 return PTR_ERR(dentry);
425 pipe->dentry = dentry;
426 return 0;
427}
428
429static void nfs_idmap_unregister(struct nfs_client *clp,
430 struct rpc_pipe *pipe)
431{
Chuck Lever73ea6662012-05-21 22:44:50 -0400432 struct net *net = clp->cl_net;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400433 struct super_block *pipefs_sb;
434
435 pipefs_sb = rpc_get_sb_net(net);
436 if (pipefs_sb) {
437 __nfs_idmap_unregister(pipe);
438 rpc_put_sb_net(net);
439 }
440}
441
442static int nfs_idmap_register(struct nfs_client *clp,
443 struct idmap *idmap,
444 struct rpc_pipe *pipe)
445{
Chuck Lever73ea6662012-05-21 22:44:50 -0400446 struct net *net = clp->cl_net;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400447 struct super_block *pipefs_sb;
448 int err = 0;
449
450 pipefs_sb = rpc_get_sb_net(net);
451 if (pipefs_sb) {
452 if (clp->cl_rpcclient->cl_dentry)
453 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
454 idmap, pipe);
455 rpc_put_sb_net(net);
456 }
457 return err;
458}
459
David Howellsb7162792006-08-22 20:06:09 -0400460int
David Howellsadfa6f92006-08-22 20:06:08 -0400461nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462{
463 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300464 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400465 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
Chuck Lever369af0f2007-12-20 14:54:35 -0500467 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
468 if (idmap == NULL)
469 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300471 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
472 if (IS_ERR(pipe)) {
473 error = PTR_ERR(pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 kfree(idmap);
David Howellsb7162792006-08-22 20:06:09 -0400475 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400477 error = nfs_idmap_register(clp, idmap, pipe);
478 if (error) {
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300479 rpc_destroy_pipe_data(pipe);
480 kfree(idmap);
481 return error;
482 }
483 idmap->idmap_pipe = pipe;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400484 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400487 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488}
489
490void
David Howellsadfa6f92006-08-22 20:06:08 -0400491nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492{
493 struct idmap *idmap = clp->cl_idmap;
494
495 if (!idmap)
496 return;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400497 nfs_idmap_unregister(clp, idmap->idmap_pipe);
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300498 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 clp->cl_idmap = NULL;
500 kfree(idmap);
501}
502
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400503static int __rpc_pipefs_event(struct nfs_client *clp, unsigned long event,
504 struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400506 int err = 0;
507
508 switch (event) {
509 case RPC_PIPEFS_MOUNT:
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400510 err = __nfs_idmap_register(clp->cl_rpcclient->cl_dentry,
511 clp->cl_idmap,
512 clp->cl_idmap->idmap_pipe);
513 break;
514 case RPC_PIPEFS_UMOUNT:
515 if (clp->cl_idmap->idmap_pipe) {
516 struct dentry *parent;
517
518 parent = clp->cl_idmap->idmap_pipe->dentry->d_parent;
519 __nfs_idmap_unregister(clp->cl_idmap->idmap_pipe);
520 /*
521 * Note: This is a dirty hack. SUNRPC hook has been
522 * called already but simple_rmdir() call for the
523 * directory returned with error because of idmap pipe
524 * inside. Thus now we have to remove this directory
525 * here.
526 */
527 if (rpc_rmdir(parent))
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500528 printk(KERN_ERR "NFS: %s: failed to remove "
529 "clnt dir!\n", __func__);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400530 }
531 break;
532 default:
Weston Andros Adamsona0308892012-01-26 13:32:23 -0500533 printk(KERN_ERR "NFS: %s: unknown event: %ld\n", __func__,
534 event);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400535 return -ENOTSUPP;
536 }
537 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538}
539
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400540static struct nfs_client *nfs_get_client_for_event(struct net *net, int event)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400542 struct nfs_net *nn = net_generic(net, nfs_net_id);
543 struct dentry *cl_dentry;
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400544 struct nfs_client *clp;
Trond Myklebust4697bd52012-05-23 13:24:36 -0400545 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Trond Myklebust4697bd52012-05-23 13:24:36 -0400547restart:
Stanislav Kinsburskydc030852012-01-23 17:26:31 +0000548 spin_lock(&nn->nfs_client_lock);
Stanislav Kinsbursky6b131682012-01-23 17:26:05 +0000549 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
Trond Myklebust4697bd52012-05-23 13:24:36 -0400550 /* Wait for initialisation to finish */
551 if (clp->cl_cons_state == NFS_CS_INITING) {
552 atomic_inc(&clp->cl_count);
553 spin_unlock(&nn->nfs_client_lock);
554 err = nfs_wait_client_init_complete(clp);
555 nfs_put_client(clp);
556 if (err)
557 return NULL;
558 goto restart;
559 }
560 /* Skip nfs_clients that failed to initialise */
561 if (clp->cl_cons_state < 0)
562 continue;
Trond Myklebust54ac4712012-05-23 13:26:10 -0400563 smp_rmb();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400564 if (clp->rpc_ops != &nfs_v4_clientops)
565 continue;
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400566 cl_dentry = clp->cl_idmap->idmap_pipe->dentry;
567 if (((event == RPC_PIPEFS_MOUNT) && cl_dentry) ||
568 ((event == RPC_PIPEFS_UMOUNT) && !cl_dentry))
569 continue;
570 atomic_inc(&clp->cl_count);
571 spin_unlock(&nn->nfs_client_lock);
572 return clp;
573 }
574 spin_unlock(&nn->nfs_client_lock);
575 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400578static int rpc_pipefs_event(struct notifier_block *nb, unsigned long event,
579 void *ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400581 struct super_block *sb = ptr;
582 struct nfs_client *clp;
583 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400585 if (!try_module_get(THIS_MODULE))
586 return 0;
587
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400588 while ((clp = nfs_get_client_for_event(sb->s_fs_info, event))) {
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400589 error = __rpc_pipefs_event(clp, event, sb);
Stanislav Kinsburskye9dbca82012-02-27 22:05:37 +0400590 nfs_put_client(clp);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400591 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 }
Stanislav Kinsbursky71dfc5f2012-04-28 19:32:21 +0400594 module_put(THIS_MODULE);
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400595 return error;
596}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400598#define PIPEFS_NFS_PRIO 1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400600static struct notifier_block nfs_idmap_block = {
601 .notifier_call = rpc_pipefs_event,
602 .priority = SUNRPC_PIPEFS_NFS_PRIO,
603};
604
605int nfs_idmap_init(void)
606{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500607 int ret;
608 ret = nfs_idmap_init_keyring();
609 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500611 ret = rpc_pipefs_notifier_register(&nfs_idmap_block);
612 if (ret != 0)
613 nfs_idmap_quit_keyring();
614out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500615 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616}
617
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400618void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400620 rpc_pipefs_notifier_unregister(&nfs_idmap_block);
Bryan Schumakere6499c62012-01-26 16:54:23 -0500621 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400622}
623
Bryan Schumakerc5066942012-08-09 14:05:49 -0400624static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
625 struct idmap_msg *im,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500626 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500628 substring_t substr;
629 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Bryan Schumaker57e62322012-02-24 14:14:51 -0500631 memset(im, 0, sizeof(*im));
632 memset(msg, 0, sizeof(*msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Bryan Schumaker57e62322012-02-24 14:14:51 -0500634 im->im_type = IDMAP_TYPE_GROUP;
635 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Bryan Schumaker57e62322012-02-24 14:14:51 -0500637 switch (token) {
638 case Opt_find_uid:
639 im->im_type = IDMAP_TYPE_USER;
640 case Opt_find_gid:
641 im->im_conv = IDMAP_CONV_NAMETOID;
642 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
643 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Bryan Schumaker57e62322012-02-24 14:14:51 -0500645 case Opt_find_user:
646 im->im_type = IDMAP_TYPE_USER;
647 case Opt_find_group:
648 im->im_conv = IDMAP_CONV_IDTONAME;
649 ret = match_int(&substr, &im->im_id);
650 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500651
Bryan Schumaker57e62322012-02-24 14:14:51 -0500652 default:
653 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 goto out;
655 }
656
Bryan Schumaker57e62322012-02-24 14:14:51 -0500657 msg->data = im;
658 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Bryan Schumaker57e62322012-02-24 14:14:51 -0500660out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 return ret;
662}
663
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400664static bool
665nfs_idmap_prepare_pipe_upcall(struct idmap *idmap,
666 struct key_construction *cons)
667{
668 if (idmap->idmap_key_cons != NULL) {
669 WARN_ON_ONCE(1);
670 return false;
671 }
672 idmap->idmap_key_cons = cons;
673 return true;
674}
675
676static void
677nfs_idmap_complete_pipe_upcall_locked(struct idmap *idmap, int ret)
678{
679 struct key_construction *cons = idmap->idmap_key_cons;
680
681 idmap->idmap_key_cons = NULL;
682 complete_request_key(cons, ret);
683}
684
685static void
686nfs_idmap_abort_pipe_upcall(struct idmap *idmap, int ret)
687{
688 if (idmap->idmap_key_cons != NULL)
689 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
690}
691
Bryan Schumaker57e62322012-02-24 14:14:51 -0500692static int nfs_idmap_legacy_upcall(struct key_construction *cons,
693 const char *op,
694 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400696 struct idmap_legacy_upcalldata *data;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500697 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500699 struct idmap *idmap = (struct idmap *)aux;
700 struct key *key = cons->key;
Dan Carpenter5abc03c2012-05-14 22:45:28 +0300701 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Bryan Schumaker57e62322012-02-24 14:14:51 -0500703 /* msg and im are freed in idmap_pipe_destroy_msg */
Bryan Schumakerc5066942012-08-09 14:05:49 -0400704 data = kmalloc(sizeof(*data), GFP_KERNEL);
705 if (!data)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500706 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Bryan Schumakerc5066942012-08-09 14:05:49 -0400708 msg = &data->pipe_msg;
709 im = &data->idmap_msg;
710 data->idmap = idmap;
711
712 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500713 if (ret < 0)
714 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400716 ret = -EAGAIN;
717 if (!nfs_idmap_prepare_pipe_upcall(idmap, cons))
Trond Myklebust0e24d842012-09-28 12:03:09 -0400718 goto out2;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500719
Bryan Schumaker11588f42012-03-12 11:33:00 -0400720 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400721 if (ret < 0) {
722 nfs_idmap_abort_pipe_upcall(idmap, ret);
723 kfree(data);
724 }
Bryan Schumaker11588f42012-03-12 11:33:00 -0400725
726 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500727out2:
Bryan Schumakerc5066942012-08-09 14:05:49 -0400728 kfree(data);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500729out1:
David Howellsa427b9e2012-07-25 16:53:36 +0100730 complete_request_key(cons, ret);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500731 return ret;
732}
733
734static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data)
735{
736 return key_instantiate_and_link(key, data, strlen(data) + 1,
737 id_resolver_cache->thread_keyring,
738 authkey);
739}
740
741static int nfs_idmap_read_message(struct idmap_msg *im, struct key *key, struct key *authkey)
742{
743 char id_str[NFS_UINT_MAXLEN];
744 int ret = -EINVAL;
745
746 switch (im->im_conv) {
747 case IDMAP_CONV_NAMETOID:
748 sprintf(id_str, "%d", im->im_id);
749 ret = nfs_idmap_instantiate(key, authkey, id_str);
750 break;
751 case IDMAP_CONV_IDTONAME:
752 ret = nfs_idmap_instantiate(key, authkey, im->im_name);
753 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 }
755
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 return ret;
757}
758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759static ssize_t
760idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
761{
Chuck Lever369af0f2007-12-20 14:54:35 -0500762 struct rpc_inode *rpci = RPC_I(filp->f_path.dentry->d_inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 struct idmap *idmap = (struct idmap *)rpci->private;
David Howellsa427b9e2012-07-25 16:53:36 +0100764 struct key_construction *cons;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500765 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500766 size_t namelen_in;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400767 int ret = -ENOKEY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
David Howellsa427b9e2012-07-25 16:53:36 +0100769 /* If instantiation is successful, anyone waiting for key construction
770 * will have been woken up and someone else may now have used
771 * idmap_key_cons - so after this point we may no longer touch it.
772 */
Trond Myklebust0e24d842012-09-28 12:03:09 -0400773 cons = idmap->idmap_key_cons;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400774 if (cons == NULL)
775 goto out_noupcall;
David Howellsa427b9e2012-07-25 16:53:36 +0100776
Bryan Schumaker57e62322012-02-24 14:14:51 -0500777 if (mlen != sizeof(im)) {
778 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 goto out;
780 }
781
Bryan Schumaker57e62322012-02-24 14:14:51 -0500782 if (copy_from_user(&im, src, mlen) != 0) {
783 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 goto out;
785 }
786
Bryan Schumaker57e62322012-02-24 14:14:51 -0500787 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
Bryan Schumaker12dfd082012-08-09 14:05:50 -0400788 ret = -ENOKEY;
789 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500790 }
791
792 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
793 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
794 ret = -EINVAL;
795 goto out;
796 }
797
798 ret = nfs_idmap_read_message(&im, cons->key, cons->authkey);
799 if (ret >= 0) {
800 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
801 ret = mlen;
802 }
803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804out:
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400805 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
806out_noupcall:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 return ret;
808}
809
Adrian Bunk75c96f82005-05-05 16:16:09 -0700810static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
812{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400813 struct idmap_legacy_upcalldata *data = container_of(msg,
814 struct idmap_legacy_upcalldata,
815 pipe_msg);
816 struct idmap *idmap = data->idmap;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400817
818 if (msg->errno)
819 nfs_idmap_abort_pipe_upcall(idmap, msg->errno);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500820 /* Free memory allocated in nfs_idmap_legacy_upcall() */
Bryan Schumakerc5066942012-08-09 14:05:49 -0400821 kfree(data);
822}
823
824static void
825idmap_release_pipe(struct inode *inode)
826{
827 struct rpc_inode *rpci = RPC_I(inode);
828 struct idmap *idmap = (struct idmap *)rpci->private;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400829
830 nfs_idmap_abort_pipe_upcall(idmap, -EPIPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}
832
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800833int 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 -0700834{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800835 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800837 if (nfs_map_string_to_numeric(name, namelen, uid))
838 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500839 return nfs_idmap_lookup_id(name, namelen, "uid", uid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
841
Bryan Schumakere6499c62012-01-26 16:54:23 -0500842int 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 -0700843{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800844 struct idmap *idmap = server->nfs_client->cl_idmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845
Bryan Schumakere6499c62012-01-26 16:54:23 -0500846 if (nfs_map_string_to_numeric(name, namelen, gid))
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800847 return 0;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500848 return nfs_idmap_lookup_id(name, namelen, "gid", gid, idmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849}
850
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800851int nfs_map_uid_to_name(const struct nfs_server *server, __u32 uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800853 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800854 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
Trond Myklebustb064eca22011-02-22 15:44:32 -0800856 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500857 ret = nfs_idmap_lookup_name(uid, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800858 if (ret < 0)
859 ret = nfs_map_numeric_to_string(uid, buf, buflen);
860 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861}
Bryan Schumakere6499c62012-01-26 16:54:23 -0500862int nfs_map_gid_to_group(const struct nfs_server *server, __u32 gid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800864 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800865 int ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866
Trond Myklebustb064eca22011-02-22 15:44:32 -0800867 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Bryan Schumaker57e62322012-02-24 14:14:51 -0500868 ret = nfs_idmap_lookup_name(gid, "group", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800869 if (ret < 0)
Bryan Schumakere6499c62012-01-26 16:54:23 -0500870 ret = nfs_map_numeric_to_string(gid, buf, buflen);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800871 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}