blob: 567983d2c0ebada3105f5c1ef42bc0c4595c2ca6 [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 }
Bryan Schumaker57e62322012-02-24 14:14:51 -0500285
Bryan Schumaker955a8572010-09-29 15:41:49 -0400286 kfree(desc);
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400287 return rkey;
288}
289
290static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
291 const char *type, void *data,
292 size_t data_size, struct idmap *idmap)
293{
294 const struct cred *saved_cred;
295 struct key *rkey;
296 struct user_key_payload *payload;
297 ssize_t ret;
298
299 saved_cred = override_creds(id_resolver_cache);
300 rkey = nfs_idmap_request_key(name, namelen, type, idmap);
301 revert_creds(saved_cred);
302
Bryan Schumaker955a8572010-09-29 15:41:49 -0400303 if (IS_ERR(rkey)) {
304 ret = PTR_ERR(rkey);
305 goto out;
306 }
307
308 rcu_read_lock();
309 rkey->perm |= KEY_USR_VIEW;
310
311 ret = key_validate(rkey);
312 if (ret < 0)
313 goto out_up;
314
Trond Myklebust393faff2013-08-21 20:06:11 -0400315 payload = rcu_dereference(rkey->payload.rcudata);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400316 if (IS_ERR_OR_NULL(payload)) {
317 ret = PTR_ERR(payload);
318 goto out_up;
319 }
320
321 ret = payload->datalen;
322 if (ret > 0 && ret <= data_size)
323 memcpy(data, payload->data, ret);
324 else
325 ret = -EINVAL;
326
327out_up:
328 rcu_read_unlock();
329 key_put(rkey);
330out:
331 return ret;
332}
333
Bryan Schumaker955a8572010-09-29 15:41:49 -0400334/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500335static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
336 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400337{
338 char id_str[NFS_UINT_MAXLEN];
339 int id_len;
340 ssize_t ret;
341
342 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500343 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400344 if (ret < 0)
345 return -EINVAL;
346 return ret;
347}
348
349/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500350static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
351 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400352{
353 char id_str[NFS_UINT_MAXLEN];
354 long id_long;
355 ssize_t data_size;
356 int ret = 0;
357
Bryan Schumaker57e62322012-02-24 14:14:51 -0500358 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400359 if (data_size <= 0) {
360 ret = -EINVAL;
361 } else {
Daniel Walter7297cb62012-09-26 21:51:46 +0200362 ret = kstrtol(id_str, 10, &id_long);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400363 *id = (__u32)id_long;
364 }
365 return ret;
366}
367
Bryan Schumakere6499c62012-01-26 16:54:23 -0500368/* idmap classic begins here */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Bryan Schumaker57e62322012-02-24 14:14:51 -0500370enum {
371 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
372};
373
374static const match_table_t nfs_idmap_tokens = {
375 { Opt_find_uid, "uid:%s" },
376 { Opt_find_gid, "gid:%s" },
377 { Opt_find_user, "user:%s" },
378 { Opt_find_group, "group:%s" },
379 { Opt_find_err, NULL }
380};
381
382static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500383static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
384 size_t);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400385static void idmap_release_pipe(struct inode *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500386static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Trond Myklebustb693ba42009-08-09 15:14:15 -0400388static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400389 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500390 .downcall = idmap_pipe_downcall,
Bryan Schumakerc5066942012-08-09 14:05:49 -0400391 .release_pipe = idmap_release_pipe,
Chuck Lever369af0f2007-12-20 14:54:35 -0500392 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393};
394
Trond Myklebust17280172012-03-11 13:11:00 -0400395static struct key_type key_type_id_resolver_legacy = {
David Howellsa427b9e2012-07-25 16:53:36 +0100396 .name = "id_legacy",
Bryan Schumaker57e62322012-02-24 14:14:51 -0500397 .instantiate = user_instantiate,
398 .match = user_match,
399 .revoke = user_revoke,
400 .destroy = user_destroy,
401 .describe = user_describe,
402 .read = user_read,
403 .request_key = nfs_idmap_legacy_upcall,
404};
405
Trond Myklebust2127d822013-08-26 17:16:17 -0400406static void nfs_idmap_pipe_destroy(struct dentry *dir,
407 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400408{
Trond Myklebust2127d822013-08-26 17:16:17 -0400409 struct idmap *idmap = pdo->pdo_data;
410 struct rpc_pipe *pipe = idmap->idmap_pipe;
411
Trond Myklebustd7631252013-08-26 17:26:51 -0400412 if (pipe->dentry) {
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400413 rpc_unlink(pipe->dentry);
Trond Myklebustd7631252013-08-26 17:26:51 -0400414 pipe->dentry = NULL;
415 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400416}
417
Trond Myklebust2127d822013-08-26 17:16:17 -0400418static int nfs_idmap_pipe_create(struct dentry *dir,
419 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400420{
Trond Myklebust2127d822013-08-26 17:16:17 -0400421 struct idmap *idmap = pdo->pdo_data;
422 struct rpc_pipe *pipe = idmap->idmap_pipe;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400423 struct dentry *dentry;
424
425 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
426 if (IS_ERR(dentry))
427 return PTR_ERR(dentry);
428 pipe->dentry = dentry;
429 return 0;
430}
431
Trond Myklebust2127d822013-08-26 17:16:17 -0400432static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops = {
433 .create = nfs_idmap_pipe_create,
434 .destroy = nfs_idmap_pipe_destroy,
435};
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400436
David Howellsb7162792006-08-22 20:06:09 -0400437int
David Howellsadfa6f92006-08-22 20:06:08 -0400438nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439{
440 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300441 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400442 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Chuck Lever369af0f2007-12-20 14:54:35 -0500444 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
445 if (idmap == NULL)
446 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Trond Myklebust2127d822013-08-26 17:16:17 -0400448 rpc_init_pipe_dir_object(&idmap->idmap_pdo,
449 &nfs_idmap_pipe_dir_object_ops,
450 idmap);
451
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300452 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
453 if (IS_ERR(pipe)) {
454 error = PTR_ERR(pipe);
Trond Myklebust2127d822013-08-26 17:16:17 -0400455 goto err;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300456 }
457 idmap->idmap_pipe = pipe;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400458 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Trond Myklebust2127d822013-08-26 17:16:17 -0400460 error = rpc_add_pipe_dir_object(clp->cl_net,
461 &clp->cl_rpcclient->cl_pipedir_objects,
462 &idmap->idmap_pdo);
463 if (error)
464 goto err_destroy_pipe;
465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400467 return 0;
Trond Myklebust2127d822013-08-26 17:16:17 -0400468err_destroy_pipe:
469 rpc_destroy_pipe_data(idmap->idmap_pipe);
470err:
471 kfree(idmap);
472 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473}
474
475void
David Howellsadfa6f92006-08-22 20:06:08 -0400476nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477{
478 struct idmap *idmap = clp->cl_idmap;
479
480 if (!idmap)
481 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 clp->cl_idmap = NULL;
Trond Myklebust2127d822013-08-26 17:16:17 -0400483 rpc_remove_pipe_dir_object(clp->cl_net,
484 &clp->cl_rpcclient->cl_pipedir_objects,
485 &idmap->idmap_pdo);
486 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 kfree(idmap);
488}
489
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400490int nfs_idmap_init(void)
491{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500492 int ret;
493 ret = nfs_idmap_init_keyring();
494 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500496out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500497 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498}
499
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400500void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500502 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400503}
504
Bryan Schumakerc5066942012-08-09 14:05:49 -0400505static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
506 struct idmap_msg *im,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500507 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500509 substring_t substr;
510 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Bryan Schumaker57e62322012-02-24 14:14:51 -0500512 im->im_type = IDMAP_TYPE_GROUP;
513 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Bryan Schumaker57e62322012-02-24 14:14:51 -0500515 switch (token) {
516 case Opt_find_uid:
517 im->im_type = IDMAP_TYPE_USER;
518 case Opt_find_gid:
519 im->im_conv = IDMAP_CONV_NAMETOID;
520 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
521 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Bryan Schumaker57e62322012-02-24 14:14:51 -0500523 case Opt_find_user:
524 im->im_type = IDMAP_TYPE_USER;
525 case Opt_find_group:
526 im->im_conv = IDMAP_CONV_IDTONAME;
527 ret = match_int(&substr, &im->im_id);
528 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500529
Bryan Schumaker57e62322012-02-24 14:14:51 -0500530 default:
531 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 goto out;
533 }
534
Bryan Schumaker57e62322012-02-24 14:14:51 -0500535 msg->data = im;
536 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Bryan Schumaker57e62322012-02-24 14:14:51 -0500538out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 return ret;
540}
541
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400542static bool
543nfs_idmap_prepare_pipe_upcall(struct idmap *idmap,
Trond Myklebust0cac1202012-09-27 16:15:00 -0400544 struct idmap_legacy_upcalldata *data)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400545{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400546 if (idmap->idmap_upcall_data != NULL) {
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400547 WARN_ON_ONCE(1);
548 return false;
549 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400550 idmap->idmap_upcall_data = data;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400551 return true;
552}
553
554static void
555nfs_idmap_complete_pipe_upcall_locked(struct idmap *idmap, int ret)
556{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400557 struct key_construction *cons = idmap->idmap_upcall_data->key_cons;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400558
Trond Myklebust0cac1202012-09-27 16:15:00 -0400559 kfree(idmap->idmap_upcall_data);
560 idmap->idmap_upcall_data = NULL;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400561 complete_request_key(cons, ret);
562}
563
564static void
565nfs_idmap_abort_pipe_upcall(struct idmap *idmap, int ret)
566{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400567 if (idmap->idmap_upcall_data != NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400568 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
569}
570
Bryan Schumaker57e62322012-02-24 14:14:51 -0500571static int nfs_idmap_legacy_upcall(struct key_construction *cons,
572 const char *op,
573 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400575 struct idmap_legacy_upcalldata *data;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500576 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500578 struct idmap *idmap = (struct idmap *)aux;
579 struct key *key = cons->key;
Dan Carpenter5abc03c2012-05-14 22:45:28 +0300580 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
Bryan Schumaker57e62322012-02-24 14:14:51 -0500582 /* msg and im are freed in idmap_pipe_destroy_msg */
Bryan Schumaker57a51042012-08-09 14:05:51 -0400583 data = kzalloc(sizeof(*data), GFP_KERNEL);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400584 if (!data)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500585 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Bryan Schumakerc5066942012-08-09 14:05:49 -0400587 msg = &data->pipe_msg;
588 im = &data->idmap_msg;
589 data->idmap = idmap;
Bryan Schumakerddfc4e12012-10-02 16:01:38 -0400590 data->key_cons = cons;
Bryan Schumakerc5066942012-08-09 14:05:49 -0400591
592 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500593 if (ret < 0)
594 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400596 ret = -EAGAIN;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400597 if (!nfs_idmap_prepare_pipe_upcall(idmap, data))
Trond Myklebust0e24d842012-09-28 12:03:09 -0400598 goto out2;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500599
Bryan Schumaker11588f42012-03-12 11:33:00 -0400600 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
601 if (ret < 0)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400602 nfs_idmap_abort_pipe_upcall(idmap, ret);
Bryan Schumaker11588f42012-03-12 11:33:00 -0400603
604 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500605out2:
Bryan Schumakerc5066942012-08-09 14:05:49 -0400606 kfree(data);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500607out1:
David Howellsa427b9e2012-07-25 16:53:36 +0100608 complete_request_key(cons, ret);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500609 return ret;
610}
611
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500612static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data, size_t datalen)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500613{
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500614 return key_instantiate_and_link(key, data, datalen,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500615 id_resolver_cache->thread_keyring,
616 authkey);
617}
618
Trond Myklebust0cac1202012-09-27 16:15:00 -0400619static int nfs_idmap_read_and_verify_message(struct idmap_msg *im,
620 struct idmap_msg *upcall,
621 struct key *key, struct key *authkey)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500622{
623 char id_str[NFS_UINT_MAXLEN];
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500624 size_t len;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400625 int ret = -ENOKEY;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500626
Trond Myklebust0cac1202012-09-27 16:15:00 -0400627 /* ret = -ENOKEY */
628 if (upcall->im_type != im->im_type || upcall->im_conv != im->im_conv)
629 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500630 switch (im->im_conv) {
631 case IDMAP_CONV_NAMETOID:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400632 if (strcmp(upcall->im_name, im->im_name) != 0)
633 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500634 /* Note: here we store the NUL terminator too */
635 len = sprintf(id_str, "%d", im->im_id) + 1;
636 ret = nfs_idmap_instantiate(key, authkey, id_str, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500637 break;
638 case IDMAP_CONV_IDTONAME:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400639 if (upcall->im_id != im->im_id)
640 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500641 len = strlen(im->im_name);
642 ret = nfs_idmap_instantiate(key, authkey, im->im_name, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500643 break;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400644 default:
645 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400647out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 return ret;
649}
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651static ssize_t
652idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
653{
Al Viro496ad9a2013-01-23 17:07:38 -0500654 struct rpc_inode *rpci = RPC_I(file_inode(filp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 struct idmap *idmap = (struct idmap *)rpci->private;
David Howellsa427b9e2012-07-25 16:53:36 +0100656 struct key_construction *cons;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500657 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500658 size_t namelen_in;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400659 int ret = -ENOKEY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
David Howellsa427b9e2012-07-25 16:53:36 +0100661 /* If instantiation is successful, anyone waiting for key construction
662 * will have been woken up and someone else may now have used
663 * idmap_key_cons - so after this point we may no longer touch it.
664 */
Trond Myklebust0cac1202012-09-27 16:15:00 -0400665 if (idmap->idmap_upcall_data == NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400666 goto out_noupcall;
David Howellsa427b9e2012-07-25 16:53:36 +0100667
Trond Myklebust0cac1202012-09-27 16:15:00 -0400668 cons = idmap->idmap_upcall_data->key_cons;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Bryan Schumaker57e62322012-02-24 14:14:51 -0500670 if (mlen != sizeof(im)) {
671 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 goto out;
673 }
674
Bryan Schumaker57e62322012-02-24 14:14:51 -0500675 if (copy_from_user(&im, src, mlen) != 0) {
676 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 goto out;
678 }
679
Bryan Schumaker57e62322012-02-24 14:14:51 -0500680 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
Bryan Schumaker12dfd082012-08-09 14:05:50 -0400681 ret = -ENOKEY;
682 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500683 }
684
685 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
686 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
687 ret = -EINVAL;
688 goto out;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400689}
Bryan Schumaker57e62322012-02-24 14:14:51 -0500690
Trond Myklebust0cac1202012-09-27 16:15:00 -0400691 ret = nfs_idmap_read_and_verify_message(&im,
692 &idmap->idmap_upcall_data->idmap_msg,
693 cons->key, cons->authkey);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500694 if (ret >= 0) {
695 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
696 ret = mlen;
697 }
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699out:
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400700 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
701out_noupcall:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702 return ret;
703}
704
Adrian Bunk75c96f82005-05-05 16:16:09 -0700705static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
707{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400708 struct idmap_legacy_upcalldata *data = container_of(msg,
709 struct idmap_legacy_upcalldata,
710 pipe_msg);
711 struct idmap *idmap = data->idmap;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400712
713 if (msg->errno)
714 nfs_idmap_abort_pipe_upcall(idmap, msg->errno);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400715}
716
717static void
718idmap_release_pipe(struct inode *inode)
719{
720 struct rpc_inode *rpci = RPC_I(inode);
721 struct idmap *idmap = (struct idmap *)rpci->private;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400722
723 nfs_idmap_abort_pipe_upcall(idmap, -EPIPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724}
725
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800726int 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 -0700727{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800728 struct idmap *idmap = server->nfs_client->cl_idmap;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800729 __u32 id = -1;
730 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800732 if (!nfs_map_string_to_numeric(name, namelen, &id))
733 ret = nfs_idmap_lookup_id(name, namelen, "uid", &id, idmap);
734 if (ret == 0) {
735 *uid = make_kuid(&init_user_ns, id);
736 if (!uid_valid(*uid))
737 ret = -ERANGE;
738 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400739 trace_nfs4_map_name_to_uid(name, namelen, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800740 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741}
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800742
743int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, kgid_t *gid)
744{
745 struct idmap *idmap = server->nfs_client->cl_idmap;
746 __u32 id = -1;
747 int ret = 0;
748
749 if (!nfs_map_string_to_numeric(name, namelen, &id))
750 ret = nfs_idmap_lookup_id(name, namelen, "gid", &id, idmap);
751 if (ret == 0) {
752 *gid = make_kgid(&init_user_ns, id);
753 if (!gid_valid(*gid))
754 ret = -ERANGE;
755 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400756 trace_nfs4_map_group_to_gid(name, namelen, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800757 return ret;
758}
759
760int 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 -0700761{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800762 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800763 int ret = -EINVAL;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800764 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800766 id = from_kuid(&init_user_ns, uid);
Trond Myklebustb064eca22011-02-22 15:44:32 -0800767 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800768 ret = nfs_idmap_lookup_name(id, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800769 if (ret < 0)
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800770 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400771 trace_nfs4_map_uid_to_name(buf, ret, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800772 return ret;
773}
774int nfs_map_gid_to_group(const struct nfs_server *server, kgid_t gid, char *buf, size_t buflen)
775{
776 struct idmap *idmap = server->nfs_client->cl_idmap;
777 int ret = -EINVAL;
778 __u32 id;
779
780 id = from_kgid(&init_user_ns, gid);
781 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
782 ret = nfs_idmap_lookup_name(id, "group", buf, buflen, idmap);
783 if (ret < 0)
784 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400785 trace_nfs4_map_gid_to_group(buf, ret, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800786 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787}