blob: b7458d77f511e045fdb141ba26cafd8ad9633b9a [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"
Trond Myklebust1f2d30b2013-08-13 11:34:01 -040052#include "nfs4trace.h"
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050053
54#define NFS_UINT_MAXLEN 11
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050055
Trond Myklebust17280172012-03-11 13:11:00 -040056static const struct cred *id_resolver_cache;
57static struct key_type key_type_id_resolver_legacy;
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050058
Bryan Schumakerc5066942012-08-09 14:05:49 -040059struct idmap_legacy_upcalldata {
60 struct rpc_pipe_msg pipe_msg;
61 struct idmap_msg idmap_msg;
Trond Myklebust0cac1202012-09-27 16:15:00 -040062 struct key_construction *key_cons;
Bryan Schumakerc5066942012-08-09 14:05:49 -040063 struct idmap *idmap;
64};
65
Trond Myklebust0cac1202012-09-27 16:15:00 -040066struct idmap {
Trond Myklebust2127d822013-08-26 17:16:17 -040067 struct rpc_pipe_dir_object idmap_pdo;
Trond Myklebust0cac1202012-09-27 16:15:00 -040068 struct rpc_pipe *idmap_pipe;
69 struct idmap_legacy_upcalldata *idmap_upcall_data;
70 struct mutex idmap_mutex;
71};
72
Trond Myklebust6926afd2012-01-07 13:22:46 -050073/**
74 * nfs_fattr_init_names - initialise the nfs_fattr owner_name/group_name fields
75 * @fattr: fully initialised struct nfs_fattr
76 * @owner_name: owner name string cache
77 * @group_name: group name string cache
78 */
79void nfs_fattr_init_names(struct nfs_fattr *fattr,
80 struct nfs4_string *owner_name,
81 struct nfs4_string *group_name)
82{
83 fattr->owner_name = owner_name;
84 fattr->group_name = group_name;
85}
86
87static void nfs_fattr_free_owner_name(struct nfs_fattr *fattr)
88{
89 fattr->valid &= ~NFS_ATTR_FATTR_OWNER_NAME;
90 kfree(fattr->owner_name->data);
91}
92
93static void nfs_fattr_free_group_name(struct nfs_fattr *fattr)
94{
95 fattr->valid &= ~NFS_ATTR_FATTR_GROUP_NAME;
96 kfree(fattr->group_name->data);
97}
98
99static bool nfs_fattr_map_owner_name(struct nfs_server *server, struct nfs_fattr *fattr)
100{
101 struct nfs4_string *owner = fattr->owner_name;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800102 kuid_t uid;
Trond Myklebust6926afd2012-01-07 13:22:46 -0500103
104 if (!(fattr->valid & NFS_ATTR_FATTR_OWNER_NAME))
105 return false;
106 if (nfs_map_name_to_uid(server, owner->data, owner->len, &uid) == 0) {
107 fattr->uid = uid;
108 fattr->valid |= NFS_ATTR_FATTR_OWNER;
109 }
110 return true;
111}
112
113static bool nfs_fattr_map_group_name(struct nfs_server *server, struct nfs_fattr *fattr)
114{
115 struct nfs4_string *group = fattr->group_name;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800116 kgid_t gid;
Trond Myklebust6926afd2012-01-07 13:22:46 -0500117
118 if (!(fattr->valid & NFS_ATTR_FATTR_GROUP_NAME))
119 return false;
120 if (nfs_map_group_to_gid(server, group->data, group->len, &gid) == 0) {
121 fattr->gid = gid;
122 fattr->valid |= NFS_ATTR_FATTR_GROUP;
123 }
124 return true;
125}
126
127/**
128 * nfs_fattr_free_names - free up the NFSv4 owner and group strings
129 * @fattr: a fully initialised nfs_fattr structure
130 */
131void nfs_fattr_free_names(struct nfs_fattr *fattr)
132{
133 if (fattr->valid & NFS_ATTR_FATTR_OWNER_NAME)
134 nfs_fattr_free_owner_name(fattr);
135 if (fattr->valid & NFS_ATTR_FATTR_GROUP_NAME)
136 nfs_fattr_free_group_name(fattr);
137}
138
139/**
140 * nfs_fattr_map_and_free_names - map owner/group strings into uid/gid and free
141 * @server: pointer to the filesystem nfs_server structure
142 * @fattr: a fully initialised nfs_fattr structure
143 *
144 * This helper maps the cached NFSv4 owner/group strings in fattr into
145 * their numeric uid/gid equivalents, and then frees the cached strings.
146 */
147void nfs_fattr_map_and_free_names(struct nfs_server *server, struct nfs_fattr *fattr)
148{
149 if (nfs_fattr_map_owner_name(server, fattr))
150 nfs_fattr_free_owner_name(fattr);
151 if (nfs_fattr_map_group_name(server, fattr))
152 nfs_fattr_free_group_name(fattr);
153}
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800154
155static int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
156{
157 unsigned long val;
158 char buf[16];
159
160 if (memchr(name, '@', namelen) != NULL || namelen >= sizeof(buf))
161 return 0;
162 memcpy(buf, name, namelen);
163 buf[namelen] = '\0';
Daniel Walter7297cb62012-09-26 21:51:46 +0200164 if (kstrtoul(buf, 0, &val) != 0)
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800165 return 0;
166 *res = val;
167 return 1;
168}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Trond Myklebustf0b85162011-02-22 15:44:31 -0800170static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
171{
172 return snprintf(buf, buflen, "%u", id);
173}
174
Trond Myklebust17280172012-03-11 13:11:00 -0400175static struct key_type key_type_id_resolver = {
Bryan Schumaker955a8572010-09-29 15:41:49 -0400176 .name = "id_resolver",
177 .instantiate = user_instantiate,
178 .match = user_match,
179 .revoke = user_revoke,
180 .destroy = user_destroy,
181 .describe = user_describe,
182 .read = user_read,
183};
184
Bryan Schumakere6499c62012-01-26 16:54:23 -0500185static int nfs_idmap_init_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400186{
187 struct cred *cred;
188 struct key *keyring;
189 int ret = 0;
190
Weston Andros Adamsonf9fd2d92012-01-26 13:32:22 -0500191 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
192 key_type_id_resolver.name);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400193
194 cred = prepare_kernel_cred(NULL);
195 if (!cred)
196 return -ENOMEM;
197
Eric W. Biederman4e963d42013-02-01 03:03:16 -0800198 keyring = keyring_alloc(".id_resolver",
199 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, cred,
David Howellsf8aa23a2012-10-02 19:24:56 +0100200 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
201 KEY_USR_VIEW | KEY_USR_READ,
202 KEY_ALLOC_NOT_IN_QUOTA, NULL);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400203 if (IS_ERR(keyring)) {
204 ret = PTR_ERR(keyring);
205 goto failed_put_cred;
206 }
207
Bryan Schumaker955a8572010-09-29 15:41:49 -0400208 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 Schumakerffa57b92013-06-26 14:09:46 -0400267static struct key *nfs_idmap_request_key(const char *name, size_t namelen,
268 const char *type, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400269{
Bryan Schumaker955a8572010-09-29 15:41:49 -0400270 char *desc;
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400271 struct key *rkey;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400272 ssize_t ret;
273
274 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
275 if (ret <= 0)
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400276 return ERR_PTR(ret);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400277
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400278 rkey = request_key(&key_type_id_resolver, desc, "");
279 if (IS_ERR(rkey)) {
280 mutex_lock(&idmap->idmap_mutex);
281 rkey = request_key_with_auxdata(&key_type_id_resolver_legacy,
282 desc, "", 0, idmap);
283 mutex_unlock(&idmap->idmap_mutex);
284 }
David Howells0c7774a2014-07-17 20:45:08 +0100285 if (!IS_ERR(rkey))
286 set_bit(KEY_FLAG_ROOT_CAN_INVAL, &rkey->flags);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500287
Bryan Schumaker955a8572010-09-29 15:41:49 -0400288 kfree(desc);
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400289 return rkey;
290}
291
292static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
293 const char *type, void *data,
294 size_t data_size, struct idmap *idmap)
295{
296 const struct cred *saved_cred;
297 struct key *rkey;
298 struct user_key_payload *payload;
299 ssize_t ret;
300
301 saved_cred = override_creds(id_resolver_cache);
302 rkey = nfs_idmap_request_key(name, namelen, type, idmap);
303 revert_creds(saved_cred);
304
Bryan Schumaker955a8572010-09-29 15:41:49 -0400305 if (IS_ERR(rkey)) {
306 ret = PTR_ERR(rkey);
307 goto out;
308 }
309
310 rcu_read_lock();
311 rkey->perm |= KEY_USR_VIEW;
312
313 ret = key_validate(rkey);
314 if (ret < 0)
315 goto out_up;
316
Trond Myklebust393faff2013-08-21 20:06:11 -0400317 payload = rcu_dereference(rkey->payload.rcudata);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400318 if (IS_ERR_OR_NULL(payload)) {
319 ret = PTR_ERR(payload);
320 goto out_up;
321 }
322
323 ret = payload->datalen;
324 if (ret > 0 && ret <= data_size)
325 memcpy(data, payload->data, ret);
326 else
327 ret = -EINVAL;
328
329out_up:
330 rcu_read_unlock();
331 key_put(rkey);
332out:
333 return ret;
334}
335
Bryan Schumaker955a8572010-09-29 15:41:49 -0400336/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500337static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
338 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400339{
340 char id_str[NFS_UINT_MAXLEN];
341 int id_len;
342 ssize_t ret;
343
344 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500345 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400346 if (ret < 0)
347 return -EINVAL;
348 return ret;
349}
350
351/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500352static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
353 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400354{
355 char id_str[NFS_UINT_MAXLEN];
356 long id_long;
357 ssize_t data_size;
358 int ret = 0;
359
Bryan Schumaker57e62322012-02-24 14:14:51 -0500360 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400361 if (data_size <= 0) {
362 ret = -EINVAL;
363 } else {
Daniel Walter7297cb62012-09-26 21:51:46 +0200364 ret = kstrtol(id_str, 10, &id_long);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400365 *id = (__u32)id_long;
366 }
367 return ret;
368}
369
Bryan Schumakere6499c62012-01-26 16:54:23 -0500370/* idmap classic begins here */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Bryan Schumaker57e62322012-02-24 14:14:51 -0500372enum {
373 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
374};
375
376static const match_table_t nfs_idmap_tokens = {
377 { Opt_find_uid, "uid:%s" },
378 { Opt_find_gid, "gid:%s" },
379 { Opt_find_user, "user:%s" },
380 { Opt_find_group, "group:%s" },
381 { Opt_find_err, NULL }
382};
383
384static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500385static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
386 size_t);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400387static void idmap_release_pipe(struct inode *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500388static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Trond Myklebustb693ba42009-08-09 15:14:15 -0400390static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400391 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500392 .downcall = idmap_pipe_downcall,
Bryan Schumakerc5066942012-08-09 14:05:49 -0400393 .release_pipe = idmap_release_pipe,
Chuck Lever369af0f2007-12-20 14:54:35 -0500394 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395};
396
Trond Myklebust17280172012-03-11 13:11:00 -0400397static struct key_type key_type_id_resolver_legacy = {
David Howellsa427b9e2012-07-25 16:53:36 +0100398 .name = "id_legacy",
Bryan Schumaker57e62322012-02-24 14:14:51 -0500399 .instantiate = user_instantiate,
400 .match = user_match,
401 .revoke = user_revoke,
402 .destroy = user_destroy,
403 .describe = user_describe,
404 .read = user_read,
405 .request_key = nfs_idmap_legacy_upcall,
406};
407
Trond Myklebust2127d822013-08-26 17:16:17 -0400408static void nfs_idmap_pipe_destroy(struct dentry *dir,
409 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400410{
Trond Myklebust2127d822013-08-26 17:16:17 -0400411 struct idmap *idmap = pdo->pdo_data;
412 struct rpc_pipe *pipe = idmap->idmap_pipe;
413
Trond Myklebustd7631252013-08-26 17:26:51 -0400414 if (pipe->dentry) {
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400415 rpc_unlink(pipe->dentry);
Trond Myklebustd7631252013-08-26 17:26:51 -0400416 pipe->dentry = NULL;
417 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400418}
419
Trond Myklebust2127d822013-08-26 17:16:17 -0400420static int nfs_idmap_pipe_create(struct dentry *dir,
421 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400422{
Trond Myklebust2127d822013-08-26 17:16:17 -0400423 struct idmap *idmap = pdo->pdo_data;
424 struct rpc_pipe *pipe = idmap->idmap_pipe;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400425 struct dentry *dentry;
426
427 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
428 if (IS_ERR(dentry))
429 return PTR_ERR(dentry);
430 pipe->dentry = dentry;
431 return 0;
432}
433
Trond Myklebust2127d822013-08-26 17:16:17 -0400434static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops = {
435 .create = nfs_idmap_pipe_create,
436 .destroy = nfs_idmap_pipe_destroy,
437};
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400438
David Howellsb7162792006-08-22 20:06:09 -0400439int
David Howellsadfa6f92006-08-22 20:06:08 -0400440nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300443 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400444 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Chuck Lever369af0f2007-12-20 14:54:35 -0500446 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
447 if (idmap == NULL)
448 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Trond Myklebust2127d822013-08-26 17:16:17 -0400450 rpc_init_pipe_dir_object(&idmap->idmap_pdo,
451 &nfs_idmap_pipe_dir_object_ops,
452 idmap);
453
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300454 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
455 if (IS_ERR(pipe)) {
456 error = PTR_ERR(pipe);
Trond Myklebust2127d822013-08-26 17:16:17 -0400457 goto err;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300458 }
459 idmap->idmap_pipe = pipe;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400460 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Trond Myklebust2127d822013-08-26 17:16:17 -0400462 error = rpc_add_pipe_dir_object(clp->cl_net,
463 &clp->cl_rpcclient->cl_pipedir_objects,
464 &idmap->idmap_pdo);
465 if (error)
466 goto err_destroy_pipe;
467
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400469 return 0;
Trond Myklebust2127d822013-08-26 17:16:17 -0400470err_destroy_pipe:
471 rpc_destroy_pipe_data(idmap->idmap_pipe);
472err:
473 kfree(idmap);
474 return error;
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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 clp->cl_idmap = NULL;
Trond Myklebust2127d822013-08-26 17:16:17 -0400485 rpc_remove_pipe_dir_object(clp->cl_net,
486 &clp->cl_rpcclient->cl_pipedir_objects,
487 &idmap->idmap_pdo);
488 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 kfree(idmap);
490}
491
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400492int nfs_idmap_init(void)
493{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500494 int ret;
495 ret = nfs_idmap_init_keyring();
496 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500498out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500499 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
501
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400502void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500504 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400505}
506
Bryan Schumakerc5066942012-08-09 14:05:49 -0400507static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
508 struct idmap_msg *im,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500509 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500511 substring_t substr;
512 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Bryan Schumaker57e62322012-02-24 14:14:51 -0500514 im->im_type = IDMAP_TYPE_GROUP;
515 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Bryan Schumaker57e62322012-02-24 14:14:51 -0500517 switch (token) {
518 case Opt_find_uid:
519 im->im_type = IDMAP_TYPE_USER;
520 case Opt_find_gid:
521 im->im_conv = IDMAP_CONV_NAMETOID;
522 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
523 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Bryan Schumaker57e62322012-02-24 14:14:51 -0500525 case Opt_find_user:
526 im->im_type = IDMAP_TYPE_USER;
527 case Opt_find_group:
528 im->im_conv = IDMAP_CONV_IDTONAME;
529 ret = match_int(&substr, &im->im_id);
530 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500531
Bryan Schumaker57e62322012-02-24 14:14:51 -0500532 default:
533 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 goto out;
535 }
536
Bryan Schumaker57e62322012-02-24 14:14:51 -0500537 msg->data = im;
538 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Bryan Schumaker57e62322012-02-24 14:14:51 -0500540out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 return ret;
542}
543
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400544static bool
545nfs_idmap_prepare_pipe_upcall(struct idmap *idmap,
Trond Myklebust0cac1202012-09-27 16:15:00 -0400546 struct idmap_legacy_upcalldata *data)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400547{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400548 if (idmap->idmap_upcall_data != NULL) {
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400549 WARN_ON_ONCE(1);
550 return false;
551 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400552 idmap->idmap_upcall_data = data;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400553 return true;
554}
555
556static void
557nfs_idmap_complete_pipe_upcall_locked(struct idmap *idmap, int ret)
558{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400559 struct key_construction *cons = idmap->idmap_upcall_data->key_cons;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400560
Trond Myklebust0cac1202012-09-27 16:15:00 -0400561 kfree(idmap->idmap_upcall_data);
562 idmap->idmap_upcall_data = NULL;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400563 complete_request_key(cons, ret);
564}
565
566static void
567nfs_idmap_abort_pipe_upcall(struct idmap *idmap, int ret)
568{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400569 if (idmap->idmap_upcall_data != NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400570 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
571}
572
Bryan Schumaker57e62322012-02-24 14:14:51 -0500573static int nfs_idmap_legacy_upcall(struct key_construction *cons,
574 const char *op,
575 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400577 struct idmap_legacy_upcalldata *data;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500578 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500580 struct idmap *idmap = (struct idmap *)aux;
581 struct key *key = cons->key;
Dan Carpenter5abc03c2012-05-14 22:45:28 +0300582 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Bryan Schumaker57e62322012-02-24 14:14:51 -0500584 /* msg and im are freed in idmap_pipe_destroy_msg */
Bryan Schumaker57a51042012-08-09 14:05:51 -0400585 data = kzalloc(sizeof(*data), GFP_KERNEL);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400586 if (!data)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500587 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Bryan Schumakerc5066942012-08-09 14:05:49 -0400589 msg = &data->pipe_msg;
590 im = &data->idmap_msg;
591 data->idmap = idmap;
Bryan Schumakerddfc4e12012-10-02 16:01:38 -0400592 data->key_cons = cons;
Bryan Schumakerc5066942012-08-09 14:05:49 -0400593
594 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500595 if (ret < 0)
596 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400598 ret = -EAGAIN;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400599 if (!nfs_idmap_prepare_pipe_upcall(idmap, data))
Trond Myklebust0e24d842012-09-28 12:03:09 -0400600 goto out2;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500601
Bryan Schumaker11588f42012-03-12 11:33:00 -0400602 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
603 if (ret < 0)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400604 nfs_idmap_abort_pipe_upcall(idmap, ret);
Bryan Schumaker11588f42012-03-12 11:33:00 -0400605
606 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500607out2:
Bryan Schumakerc5066942012-08-09 14:05:49 -0400608 kfree(data);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500609out1:
David Howellsa427b9e2012-07-25 16:53:36 +0100610 complete_request_key(cons, ret);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500611 return ret;
612}
613
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500614static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data, size_t datalen)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500615{
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500616 return key_instantiate_and_link(key, data, datalen,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500617 id_resolver_cache->thread_keyring,
618 authkey);
619}
620
Trond Myklebust0cac1202012-09-27 16:15:00 -0400621static int nfs_idmap_read_and_verify_message(struct idmap_msg *im,
622 struct idmap_msg *upcall,
623 struct key *key, struct key *authkey)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500624{
625 char id_str[NFS_UINT_MAXLEN];
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500626 size_t len;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400627 int ret = -ENOKEY;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500628
Trond Myklebust0cac1202012-09-27 16:15:00 -0400629 /* ret = -ENOKEY */
630 if (upcall->im_type != im->im_type || upcall->im_conv != im->im_conv)
631 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500632 switch (im->im_conv) {
633 case IDMAP_CONV_NAMETOID:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400634 if (strcmp(upcall->im_name, im->im_name) != 0)
635 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500636 /* Note: here we store the NUL terminator too */
637 len = sprintf(id_str, "%d", im->im_id) + 1;
638 ret = nfs_idmap_instantiate(key, authkey, id_str, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500639 break;
640 case IDMAP_CONV_IDTONAME:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400641 if (upcall->im_id != im->im_id)
642 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500643 len = strlen(im->im_name);
644 ret = nfs_idmap_instantiate(key, authkey, im->im_name, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500645 break;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400646 default:
647 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400649out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 return ret;
651}
652
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653static ssize_t
654idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
655{
Al Viro496ad9a2013-01-23 17:07:38 -0500656 struct rpc_inode *rpci = RPC_I(file_inode(filp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 struct idmap *idmap = (struct idmap *)rpci->private;
David Howellsa427b9e2012-07-25 16:53:36 +0100658 struct key_construction *cons;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500659 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500660 size_t namelen_in;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400661 int ret = -ENOKEY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
David Howellsa427b9e2012-07-25 16:53:36 +0100663 /* If instantiation is successful, anyone waiting for key construction
664 * will have been woken up and someone else may now have used
665 * idmap_key_cons - so after this point we may no longer touch it.
666 */
Trond Myklebust0cac1202012-09-27 16:15:00 -0400667 if (idmap->idmap_upcall_data == NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400668 goto out_noupcall;
David Howellsa427b9e2012-07-25 16:53:36 +0100669
Trond Myklebust0cac1202012-09-27 16:15:00 -0400670 cons = idmap->idmap_upcall_data->key_cons;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Bryan Schumaker57e62322012-02-24 14:14:51 -0500672 if (mlen != sizeof(im)) {
673 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 goto out;
675 }
676
Bryan Schumaker57e62322012-02-24 14:14:51 -0500677 if (copy_from_user(&im, src, mlen) != 0) {
678 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 goto out;
680 }
681
Bryan Schumaker57e62322012-02-24 14:14:51 -0500682 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
Bryan Schumaker12dfd082012-08-09 14:05:50 -0400683 ret = -ENOKEY;
684 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500685 }
686
687 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
688 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
689 ret = -EINVAL;
690 goto out;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400691}
Bryan Schumaker57e62322012-02-24 14:14:51 -0500692
Trond Myklebust0cac1202012-09-27 16:15:00 -0400693 ret = nfs_idmap_read_and_verify_message(&im,
694 &idmap->idmap_upcall_data->idmap_msg,
695 cons->key, cons->authkey);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500696 if (ret >= 0) {
697 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
698 ret = mlen;
699 }
700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701out:
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400702 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
703out_noupcall:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 return ret;
705}
706
Adrian Bunk75c96f82005-05-05 16:16:09 -0700707static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
709{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400710 struct idmap_legacy_upcalldata *data = container_of(msg,
711 struct idmap_legacy_upcalldata,
712 pipe_msg);
713 struct idmap *idmap = data->idmap;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400714
715 if (msg->errno)
716 nfs_idmap_abort_pipe_upcall(idmap, msg->errno);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400717}
718
719static void
720idmap_release_pipe(struct inode *inode)
721{
722 struct rpc_inode *rpci = RPC_I(inode);
723 struct idmap *idmap = (struct idmap *)rpci->private;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400724
725 nfs_idmap_abort_pipe_upcall(idmap, -EPIPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}
727
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800728int nfs_map_name_to_uid(const struct nfs_server *server, const char *name, size_t namelen, kuid_t *uid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800730 struct idmap *idmap = server->nfs_client->cl_idmap;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800731 __u32 id = -1;
732 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800734 if (!nfs_map_string_to_numeric(name, namelen, &id))
735 ret = nfs_idmap_lookup_id(name, namelen, "uid", &id, idmap);
736 if (ret == 0) {
737 *uid = make_kuid(&init_user_ns, id);
738 if (!uid_valid(*uid))
739 ret = -ERANGE;
740 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400741 trace_nfs4_map_name_to_uid(name, namelen, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800742 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743}
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800744
745int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, kgid_t *gid)
746{
747 struct idmap *idmap = server->nfs_client->cl_idmap;
748 __u32 id = -1;
749 int ret = 0;
750
751 if (!nfs_map_string_to_numeric(name, namelen, &id))
752 ret = nfs_idmap_lookup_id(name, namelen, "gid", &id, idmap);
753 if (ret == 0) {
754 *gid = make_kgid(&init_user_ns, id);
755 if (!gid_valid(*gid))
756 ret = -ERANGE;
757 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400758 trace_nfs4_map_group_to_gid(name, namelen, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800759 return ret;
760}
761
762int nfs_map_uid_to_name(const struct nfs_server *server, kuid_t uid, char *buf, size_t buflen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800764 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800765 int ret = -EINVAL;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800766 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800768 id = from_kuid(&init_user_ns, uid);
Trond Myklebustb064eca22011-02-22 15:44:32 -0800769 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800770 ret = nfs_idmap_lookup_name(id, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800771 if (ret < 0)
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800772 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400773 trace_nfs4_map_uid_to_name(buf, ret, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800774 return ret;
775}
776int nfs_map_gid_to_group(const struct nfs_server *server, kgid_t gid, char *buf, size_t buflen)
777{
778 struct idmap *idmap = server->nfs_client->cl_idmap;
779 int ret = -EINVAL;
780 __u32 id;
781
782 id = from_kgid(&init_user_ns, gid);
783 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
784 ret = nfs_idmap_lookup_name(id, "group", buf, buflen, idmap);
785 if (ret < 0)
786 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400787 trace_nfs4_map_gid_to_group(buf, ret, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800788 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789}