blob: 2e1737c40a29837488823e04f27db975e0a51b9b [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>
Bryan Schumaker57e62322012-02-24 14:14:51 -050039#include <net/net_namespace.h>
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050040#include <linux/sunrpc/rpc_pipe_fs.h>
Trond Myklebust6926afd2012-01-07 13:22:46 -050041#include <linux/nfs_fs.h>
Bryan Schumaker57e62322012-02-24 14:14:51 -050042#include <linux/nfs_fs_sb.h>
43#include <linux/key.h>
44#include <linux/keyctl.h>
45#include <linux/key-type.h>
46#include <keys/user-type.h>
47#include <linux/module.h>
48
Bryan Schumaker3cd0f372012-01-26 16:54:24 -050049#include "internal.h"
Stanislav Kinsbursky17347d02012-01-26 15:11:41 +040050#include "netns.h"
Anna Schumaker40c64c22015-04-15 13:00:05 -040051#include "nfs4idmap.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
Tom Haynesd67ae822014-12-11 17:02:04 -0500155int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res)
Trond Myklebust5cf36cf2011-02-22 15:44:31 -0800156{
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}
Tom Haynesd67ae822014-12-11 17:02:04 -0500169EXPORT_SYMBOL_GPL(nfs_map_string_to_numeric);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Trond Myklebustf0b85162011-02-22 15:44:31 -0800171static int nfs_map_numeric_to_string(__u32 id, char *buf, size_t buflen)
172{
173 return snprintf(buf, buflen, "%u", id);
174}
175
Trond Myklebust17280172012-03-11 13:11:00 -0400176static struct key_type key_type_id_resolver = {
Bryan Schumaker955a8572010-09-29 15:41:49 -0400177 .name = "id_resolver",
David Howellsf9167782014-07-18 18:56:35 +0100178 .preparse = user_preparse,
179 .free_preparse = user_free_preparse,
180 .instantiate = generic_key_instantiate,
Bryan Schumaker955a8572010-09-29 15:41:49 -0400181 .revoke = user_revoke,
182 .destroy = user_destroy,
183 .describe = user_describe,
184 .read = user_read,
185};
186
Bryan Schumakere6499c62012-01-26 16:54:23 -0500187static int nfs_idmap_init_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400188{
189 struct cred *cred;
190 struct key *keyring;
191 int ret = 0;
192
Weston Andros Adamsonf9fd2d92012-01-26 13:32:22 -0500193 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
194 key_type_id_resolver.name);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400195
196 cred = prepare_kernel_cred(NULL);
197 if (!cred)
198 return -ENOMEM;
199
Eric W. Biederman4e963d42013-02-01 03:03:16 -0800200 keyring = keyring_alloc(".id_resolver",
201 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, cred,
David Howellsf8aa23a2012-10-02 19:24:56 +0100202 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
203 KEY_USR_VIEW | KEY_USR_READ,
204 KEY_ALLOC_NOT_IN_QUOTA, NULL);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400205 if (IS_ERR(keyring)) {
206 ret = PTR_ERR(keyring);
207 goto failed_put_cred;
208 }
209
Bryan Schumaker955a8572010-09-29 15:41:49 -0400210 ret = register_key_type(&key_type_id_resolver);
211 if (ret < 0)
212 goto failed_put_key;
213
David Howellsa427b9e2012-07-25 16:53:36 +0100214 ret = register_key_type(&key_type_id_resolver_legacy);
215 if (ret < 0)
216 goto failed_reg_legacy;
217
David Howells700920e2012-01-18 15:31:45 +0000218 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400219 cred->thread_keyring = keyring;
220 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
221 id_resolver_cache = cred;
222 return 0;
223
David Howellsa427b9e2012-07-25 16:53:36 +0100224failed_reg_legacy:
225 unregister_key_type(&key_type_id_resolver);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400226failed_put_key:
227 key_put(keyring);
228failed_put_cred:
229 put_cred(cred);
230 return ret;
231}
232
Bryan Schumakere6499c62012-01-26 16:54:23 -0500233static void nfs_idmap_quit_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400234{
235 key_revoke(id_resolver_cache->thread_keyring);
236 unregister_key_type(&key_type_id_resolver);
David Howellsa427b9e2012-07-25 16:53:36 +0100237 unregister_key_type(&key_type_id_resolver_legacy);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400238 put_cred(id_resolver_cache);
239}
240
241/*
242 * Assemble the description to pass to request_key()
243 * This function will allocate a new string and update dest to point
244 * at it. The caller is responsible for freeing dest.
245 *
246 * On error 0 is returned. Otherwise, the length of dest is returned.
247 */
248static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
249 const char *type, size_t typelen, char **desc)
250{
251 char *cp;
252 size_t desclen = typelen + namelen + 2;
253
254 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200255 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400256 return -ENOMEM;
257
258 cp = *desc;
259 memcpy(cp, type, typelen);
260 cp += typelen;
261 *cp++ = ':';
262
263 memcpy(cp, name, namelen);
264 cp += namelen;
265 *cp = '\0';
266 return desclen;
267}
268
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400269static struct key *nfs_idmap_request_key(const char *name, size_t namelen,
270 const char *type, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400271{
Bryan Schumaker955a8572010-09-29 15:41:49 -0400272 char *desc;
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400273 struct key *rkey;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400274 ssize_t ret;
275
276 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
277 if (ret <= 0)
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400278 return ERR_PTR(ret);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400279
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400280 rkey = request_key(&key_type_id_resolver, desc, "");
281 if (IS_ERR(rkey)) {
282 mutex_lock(&idmap->idmap_mutex);
283 rkey = request_key_with_auxdata(&key_type_id_resolver_legacy,
284 desc, "", 0, idmap);
285 mutex_unlock(&idmap->idmap_mutex);
286 }
David Howells0c7774a2014-07-17 20:45:08 +0100287 if (!IS_ERR(rkey))
288 set_bit(KEY_FLAG_ROOT_CAN_INVAL, &rkey->flags);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500289
Bryan Schumaker955a8572010-09-29 15:41:49 -0400290 kfree(desc);
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400291 return rkey;
292}
293
294static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
295 const char *type, void *data,
296 size_t data_size, struct idmap *idmap)
297{
298 const struct cred *saved_cred;
299 struct key *rkey;
300 struct user_key_payload *payload;
301 ssize_t ret;
302
303 saved_cred = override_creds(id_resolver_cache);
304 rkey = nfs_idmap_request_key(name, namelen, type, idmap);
305 revert_creds(saved_cred);
306
Bryan Schumaker955a8572010-09-29 15:41:49 -0400307 if (IS_ERR(rkey)) {
308 ret = PTR_ERR(rkey);
309 goto out;
310 }
311
312 rcu_read_lock();
313 rkey->perm |= KEY_USR_VIEW;
314
315 ret = key_validate(rkey);
316 if (ret < 0)
317 goto out_up;
318
Trond Myklebust393faff2013-08-21 20:06:11 -0400319 payload = rcu_dereference(rkey->payload.rcudata);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400320 if (IS_ERR_OR_NULL(payload)) {
321 ret = PTR_ERR(payload);
322 goto out_up;
323 }
324
325 ret = payload->datalen;
326 if (ret > 0 && ret <= data_size)
327 memcpy(data, payload->data, ret);
328 else
329 ret = -EINVAL;
330
331out_up:
332 rcu_read_unlock();
333 key_put(rkey);
334out:
335 return ret;
336}
337
Bryan Schumaker955a8572010-09-29 15:41:49 -0400338/* 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 {
Daniel Walter7297cb62012-09-26 21:51:46 +0200366 ret = kstrtol(id_str, 10, &id_long);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400367 *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",
David Howellsf9167782014-07-18 18:56:35 +0100401 .preparse = user_preparse,
402 .free_preparse = user_free_preparse,
403 .instantiate = generic_key_instantiate,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500404 .revoke = user_revoke,
405 .destroy = user_destroy,
406 .describe = user_describe,
407 .read = user_read,
408 .request_key = nfs_idmap_legacy_upcall,
409};
410
Trond Myklebust2127d822013-08-26 17:16:17 -0400411static void nfs_idmap_pipe_destroy(struct dentry *dir,
412 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400413{
Trond Myklebust2127d822013-08-26 17:16:17 -0400414 struct idmap *idmap = pdo->pdo_data;
415 struct rpc_pipe *pipe = idmap->idmap_pipe;
416
Trond Myklebustd7631252013-08-26 17:26:51 -0400417 if (pipe->dentry) {
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400418 rpc_unlink(pipe->dentry);
Trond Myklebustd7631252013-08-26 17:26:51 -0400419 pipe->dentry = NULL;
420 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400421}
422
Trond Myklebust2127d822013-08-26 17:16:17 -0400423static int nfs_idmap_pipe_create(struct dentry *dir,
424 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400425{
Trond Myklebust2127d822013-08-26 17:16:17 -0400426 struct idmap *idmap = pdo->pdo_data;
427 struct rpc_pipe *pipe = idmap->idmap_pipe;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400428 struct dentry *dentry;
429
430 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
431 if (IS_ERR(dentry))
432 return PTR_ERR(dentry);
433 pipe->dentry = dentry;
434 return 0;
435}
436
Trond Myklebust2127d822013-08-26 17:16:17 -0400437static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops = {
438 .create = nfs_idmap_pipe_create,
439 .destroy = nfs_idmap_pipe_destroy,
440};
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400441
David Howellsb7162792006-08-22 20:06:09 -0400442int
David Howellsadfa6f92006-08-22 20:06:08 -0400443nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
445 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300446 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400447 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Chuck Lever369af0f2007-12-20 14:54:35 -0500449 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
450 if (idmap == NULL)
451 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Trond Myklebust2127d822013-08-26 17:16:17 -0400453 rpc_init_pipe_dir_object(&idmap->idmap_pdo,
454 &nfs_idmap_pipe_dir_object_ops,
455 idmap);
456
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300457 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
458 if (IS_ERR(pipe)) {
459 error = PTR_ERR(pipe);
Trond Myklebust2127d822013-08-26 17:16:17 -0400460 goto err;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300461 }
462 idmap->idmap_pipe = pipe;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400463 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Trond Myklebust2127d822013-08-26 17:16:17 -0400465 error = rpc_add_pipe_dir_object(clp->cl_net,
466 &clp->cl_rpcclient->cl_pipedir_objects,
467 &idmap->idmap_pdo);
468 if (error)
469 goto err_destroy_pipe;
470
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400472 return 0;
Trond Myklebust2127d822013-08-26 17:16:17 -0400473err_destroy_pipe:
474 rpc_destroy_pipe_data(idmap->idmap_pipe);
475err:
476 kfree(idmap);
477 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478}
479
480void
David Howellsadfa6f92006-08-22 20:06:08 -0400481nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482{
483 struct idmap *idmap = clp->cl_idmap;
484
485 if (!idmap)
486 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 clp->cl_idmap = NULL;
Trond Myklebust2127d822013-08-26 17:16:17 -0400488 rpc_remove_pipe_dir_object(clp->cl_net,
489 &clp->cl_rpcclient->cl_pipedir_objects,
490 &idmap->idmap_pdo);
491 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 kfree(idmap);
493}
494
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400495int nfs_idmap_init(void)
496{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500497 int ret;
498 ret = nfs_idmap_init_keyring();
499 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500501out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500502 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503}
504
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400505void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500507 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400508}
509
Bryan Schumakerc5066942012-08-09 14:05:49 -0400510static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
511 struct idmap_msg *im,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500512 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500514 substring_t substr;
515 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Bryan Schumaker57e62322012-02-24 14:14:51 -0500517 im->im_type = IDMAP_TYPE_GROUP;
518 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Bryan Schumaker57e62322012-02-24 14:14:51 -0500520 switch (token) {
521 case Opt_find_uid:
522 im->im_type = IDMAP_TYPE_USER;
523 case Opt_find_gid:
524 im->im_conv = IDMAP_CONV_NAMETOID;
525 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
526 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Bryan Schumaker57e62322012-02-24 14:14:51 -0500528 case Opt_find_user:
529 im->im_type = IDMAP_TYPE_USER;
530 case Opt_find_group:
531 im->im_conv = IDMAP_CONV_IDTONAME;
532 ret = match_int(&substr, &im->im_id);
533 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500534
Bryan Schumaker57e62322012-02-24 14:14:51 -0500535 default:
536 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 goto out;
538 }
539
Bryan Schumaker57e62322012-02-24 14:14:51 -0500540 msg->data = im;
541 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Bryan Schumaker57e62322012-02-24 14:14:51 -0500543out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 return ret;
545}
546
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400547static bool
548nfs_idmap_prepare_pipe_upcall(struct idmap *idmap,
Trond Myklebust0cac1202012-09-27 16:15:00 -0400549 struct idmap_legacy_upcalldata *data)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400550{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400551 if (idmap->idmap_upcall_data != NULL) {
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400552 WARN_ON_ONCE(1);
553 return false;
554 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400555 idmap->idmap_upcall_data = data;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400556 return true;
557}
558
559static void
560nfs_idmap_complete_pipe_upcall_locked(struct idmap *idmap, int ret)
561{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400562 struct key_construction *cons = idmap->idmap_upcall_data->key_cons;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400563
Trond Myklebust0cac1202012-09-27 16:15:00 -0400564 kfree(idmap->idmap_upcall_data);
565 idmap->idmap_upcall_data = NULL;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400566 complete_request_key(cons, ret);
567}
568
569static void
570nfs_idmap_abort_pipe_upcall(struct idmap *idmap, int ret)
571{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400572 if (idmap->idmap_upcall_data != NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400573 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
574}
575
Bryan Schumaker57e62322012-02-24 14:14:51 -0500576static int nfs_idmap_legacy_upcall(struct key_construction *cons,
577 const char *op,
578 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400580 struct idmap_legacy_upcalldata *data;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500581 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500583 struct idmap *idmap = (struct idmap *)aux;
584 struct key *key = cons->key;
Dan Carpenter5abc03c2012-05-14 22:45:28 +0300585 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
Bryan Schumaker57e62322012-02-24 14:14:51 -0500587 /* msg and im are freed in idmap_pipe_destroy_msg */
Bryan Schumaker57a51042012-08-09 14:05:51 -0400588 data = kzalloc(sizeof(*data), GFP_KERNEL);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400589 if (!data)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500590 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Bryan Schumakerc5066942012-08-09 14:05:49 -0400592 msg = &data->pipe_msg;
593 im = &data->idmap_msg;
594 data->idmap = idmap;
Bryan Schumakerddfc4e12012-10-02 16:01:38 -0400595 data->key_cons = cons;
Bryan Schumakerc5066942012-08-09 14:05:49 -0400596
597 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500598 if (ret < 0)
599 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400601 ret = -EAGAIN;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400602 if (!nfs_idmap_prepare_pipe_upcall(idmap, data))
Trond Myklebust0e24d842012-09-28 12:03:09 -0400603 goto out2;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500604
Bryan Schumaker11588f42012-03-12 11:33:00 -0400605 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
606 if (ret < 0)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400607 nfs_idmap_abort_pipe_upcall(idmap, ret);
Bryan Schumaker11588f42012-03-12 11:33:00 -0400608
609 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500610out2:
Bryan Schumakerc5066942012-08-09 14:05:49 -0400611 kfree(data);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500612out1:
David Howellsa427b9e2012-07-25 16:53:36 +0100613 complete_request_key(cons, ret);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500614 return ret;
615}
616
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500617static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data, size_t datalen)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500618{
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500619 return key_instantiate_and_link(key, data, datalen,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500620 id_resolver_cache->thread_keyring,
621 authkey);
622}
623
Trond Myklebust0cac1202012-09-27 16:15:00 -0400624static int nfs_idmap_read_and_verify_message(struct idmap_msg *im,
625 struct idmap_msg *upcall,
626 struct key *key, struct key *authkey)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500627{
628 char id_str[NFS_UINT_MAXLEN];
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500629 size_t len;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400630 int ret = -ENOKEY;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500631
Trond Myklebust0cac1202012-09-27 16:15:00 -0400632 /* ret = -ENOKEY */
633 if (upcall->im_type != im->im_type || upcall->im_conv != im->im_conv)
634 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500635 switch (im->im_conv) {
636 case IDMAP_CONV_NAMETOID:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400637 if (strcmp(upcall->im_name, im->im_name) != 0)
638 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500639 /* Note: here we store the NUL terminator too */
640 len = sprintf(id_str, "%d", im->im_id) + 1;
641 ret = nfs_idmap_instantiate(key, authkey, id_str, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500642 break;
643 case IDMAP_CONV_IDTONAME:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400644 if (upcall->im_id != im->im_id)
645 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500646 len = strlen(im->im_name);
647 ret = nfs_idmap_instantiate(key, authkey, im->im_name, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500648 break;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400649 default:
650 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400652out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 return ret;
654}
655
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656static ssize_t
657idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
658{
Al Viro496ad9a2013-01-23 17:07:38 -0500659 struct rpc_inode *rpci = RPC_I(file_inode(filp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 struct idmap *idmap = (struct idmap *)rpci->private;
David Howellsa427b9e2012-07-25 16:53:36 +0100661 struct key_construction *cons;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500662 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500663 size_t namelen_in;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400664 int ret = -ENOKEY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
David Howellsa427b9e2012-07-25 16:53:36 +0100666 /* If instantiation is successful, anyone waiting for key construction
667 * will have been woken up and someone else may now have used
668 * idmap_key_cons - so after this point we may no longer touch it.
669 */
Trond Myklebust0cac1202012-09-27 16:15:00 -0400670 if (idmap->idmap_upcall_data == NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400671 goto out_noupcall;
David Howellsa427b9e2012-07-25 16:53:36 +0100672
Trond Myklebust0cac1202012-09-27 16:15:00 -0400673 cons = idmap->idmap_upcall_data->key_cons;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Bryan Schumaker57e62322012-02-24 14:14:51 -0500675 if (mlen != sizeof(im)) {
676 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 goto out;
678 }
679
Bryan Schumaker57e62322012-02-24 14:14:51 -0500680 if (copy_from_user(&im, src, mlen) != 0) {
681 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 goto out;
683 }
684
Bryan Schumaker57e62322012-02-24 14:14:51 -0500685 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
Bryan Schumaker12dfd082012-08-09 14:05:50 -0400686 ret = -ENOKEY;
687 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500688 }
689
690 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
691 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
692 ret = -EINVAL;
693 goto out;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400694}
Bryan Schumaker57e62322012-02-24 14:14:51 -0500695
Trond Myklebust0cac1202012-09-27 16:15:00 -0400696 ret = nfs_idmap_read_and_verify_message(&im,
697 &idmap->idmap_upcall_data->idmap_msg,
698 cons->key, cons->authkey);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500699 if (ret >= 0) {
700 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
701 ret = mlen;
702 }
703
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704out:
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400705 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
706out_noupcall:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 return ret;
708}
709
Adrian Bunk75c96f82005-05-05 16:16:09 -0700710static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
712{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400713 struct idmap_legacy_upcalldata *data = container_of(msg,
714 struct idmap_legacy_upcalldata,
715 pipe_msg);
716 struct idmap *idmap = data->idmap;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400717
718 if (msg->errno)
719 nfs_idmap_abort_pipe_upcall(idmap, msg->errno);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400720}
721
722static void
723idmap_release_pipe(struct inode *inode)
724{
725 struct rpc_inode *rpci = RPC_I(inode);
726 struct idmap *idmap = (struct idmap *)rpci->private;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400727
728 nfs_idmap_abort_pipe_upcall(idmap, -EPIPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
730
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800731int 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 -0700732{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800733 struct idmap *idmap = server->nfs_client->cl_idmap;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800734 __u32 id = -1;
735 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800737 if (!nfs_map_string_to_numeric(name, namelen, &id))
738 ret = nfs_idmap_lookup_id(name, namelen, "uid", &id, idmap);
739 if (ret == 0) {
740 *uid = make_kuid(&init_user_ns, id);
741 if (!uid_valid(*uid))
742 ret = -ERANGE;
743 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400744 trace_nfs4_map_name_to_uid(name, namelen, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800745 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746}
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800747
748int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, kgid_t *gid)
749{
750 struct idmap *idmap = server->nfs_client->cl_idmap;
751 __u32 id = -1;
752 int ret = 0;
753
754 if (!nfs_map_string_to_numeric(name, namelen, &id))
755 ret = nfs_idmap_lookup_id(name, namelen, "gid", &id, idmap);
756 if (ret == 0) {
757 *gid = make_kgid(&init_user_ns, id);
758 if (!gid_valid(*gid))
759 ret = -ERANGE;
760 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400761 trace_nfs4_map_group_to_gid(name, namelen, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800762 return ret;
763}
764
765int 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 -0700766{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800767 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800768 int ret = -EINVAL;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800769 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800771 id = from_kuid(&init_user_ns, uid);
Trond Myklebustb064eca22011-02-22 15:44:32 -0800772 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800773 ret = nfs_idmap_lookup_name(id, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800774 if (ret < 0)
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800775 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400776 trace_nfs4_map_uid_to_name(buf, ret, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800777 return ret;
778}
779int nfs_map_gid_to_group(const struct nfs_server *server, kgid_t gid, char *buf, size_t buflen)
780{
781 struct idmap *idmap = server->nfs_client->cl_idmap;
782 int ret = -EINVAL;
783 __u32 id;
784
785 id = from_kgid(&init_user_ns, gid);
786 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
787 ret = nfs_idmap_lookup_name(id, "group", buf, buflen, idmap);
788 if (ret < 0)
789 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400790 trace_nfs4_map_gid_to_group(buf, ret, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800791 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792}