blob: 2f5db844c172534a229d86b011be1f6ec2c29aff [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",
David Howellsf9167782014-07-18 18:56:35 +0100177 .preparse = user_preparse,
178 .free_preparse = user_free_preparse,
179 .instantiate = generic_key_instantiate,
Bryan Schumaker955a8572010-09-29 15:41:49 -0400180 .revoke = user_revoke,
181 .destroy = user_destroy,
182 .describe = user_describe,
183 .read = user_read,
184};
185
Bryan Schumakere6499c62012-01-26 16:54:23 -0500186static int nfs_idmap_init_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400187{
188 struct cred *cred;
189 struct key *keyring;
190 int ret = 0;
191
Weston Andros Adamsonf9fd2d92012-01-26 13:32:22 -0500192 printk(KERN_NOTICE "NFS: Registering the %s key type\n",
193 key_type_id_resolver.name);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400194
195 cred = prepare_kernel_cred(NULL);
196 if (!cred)
197 return -ENOMEM;
198
Eric W. Biederman4e963d42013-02-01 03:03:16 -0800199 keyring = keyring_alloc(".id_resolver",
200 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, cred,
David Howellsf8aa23a2012-10-02 19:24:56 +0100201 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
202 KEY_USR_VIEW | KEY_USR_READ,
203 KEY_ALLOC_NOT_IN_QUOTA, NULL);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400204 if (IS_ERR(keyring)) {
205 ret = PTR_ERR(keyring);
206 goto failed_put_cred;
207 }
208
Bryan Schumaker955a8572010-09-29 15:41:49 -0400209 ret = register_key_type(&key_type_id_resolver);
210 if (ret < 0)
211 goto failed_put_key;
212
David Howellsa427b9e2012-07-25 16:53:36 +0100213 ret = register_key_type(&key_type_id_resolver_legacy);
214 if (ret < 0)
215 goto failed_reg_legacy;
216
David Howells700920e2012-01-18 15:31:45 +0000217 set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400218 cred->thread_keyring = keyring;
219 cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
220 id_resolver_cache = cred;
221 return 0;
222
David Howellsa427b9e2012-07-25 16:53:36 +0100223failed_reg_legacy:
224 unregister_key_type(&key_type_id_resolver);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400225failed_put_key:
226 key_put(keyring);
227failed_put_cred:
228 put_cred(cred);
229 return ret;
230}
231
Bryan Schumakere6499c62012-01-26 16:54:23 -0500232static void nfs_idmap_quit_keyring(void)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400233{
234 key_revoke(id_resolver_cache->thread_keyring);
235 unregister_key_type(&key_type_id_resolver);
David Howellsa427b9e2012-07-25 16:53:36 +0100236 unregister_key_type(&key_type_id_resolver_legacy);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400237 put_cred(id_resolver_cache);
238}
239
240/*
241 * Assemble the description to pass to request_key()
242 * This function will allocate a new string and update dest to point
243 * at it. The caller is responsible for freeing dest.
244 *
245 * On error 0 is returned. Otherwise, the length of dest is returned.
246 */
247static ssize_t nfs_idmap_get_desc(const char *name, size_t namelen,
248 const char *type, size_t typelen, char **desc)
249{
250 char *cp;
251 size_t desclen = typelen + namelen + 2;
252
253 *desc = kmalloc(desclen, GFP_KERNEL);
Dan Carpenter8f0d97b2010-10-28 08:05:57 +0200254 if (!*desc)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400255 return -ENOMEM;
256
257 cp = *desc;
258 memcpy(cp, type, typelen);
259 cp += typelen;
260 *cp++ = ':';
261
262 memcpy(cp, name, namelen);
263 cp += namelen;
264 *cp = '\0';
265 return desclen;
266}
267
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400268static struct key *nfs_idmap_request_key(const char *name, size_t namelen,
269 const char *type, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400270{
Bryan Schumaker955a8572010-09-29 15:41:49 -0400271 char *desc;
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400272 struct key *rkey;
Bryan Schumaker955a8572010-09-29 15:41:49 -0400273 ssize_t ret;
274
275 ret = nfs_idmap_get_desc(name, namelen, type, strlen(type), &desc);
276 if (ret <= 0)
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400277 return ERR_PTR(ret);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400278
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400279 rkey = request_key(&key_type_id_resolver, desc, "");
280 if (IS_ERR(rkey)) {
281 mutex_lock(&idmap->idmap_mutex);
282 rkey = request_key_with_auxdata(&key_type_id_resolver_legacy,
283 desc, "", 0, idmap);
284 mutex_unlock(&idmap->idmap_mutex);
285 }
David Howells0c7774a2014-07-17 20:45:08 +0100286 if (!IS_ERR(rkey))
287 set_bit(KEY_FLAG_ROOT_CAN_INVAL, &rkey->flags);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500288
Bryan Schumaker955a8572010-09-29 15:41:49 -0400289 kfree(desc);
Bryan Schumakerffa57b92013-06-26 14:09:46 -0400290 return rkey;
291}
292
293static ssize_t nfs_idmap_get_key(const char *name, size_t namelen,
294 const char *type, void *data,
295 size_t data_size, struct idmap *idmap)
296{
297 const struct cred *saved_cred;
298 struct key *rkey;
299 struct user_key_payload *payload;
300 ssize_t ret;
301
302 saved_cred = override_creds(id_resolver_cache);
303 rkey = nfs_idmap_request_key(name, namelen, type, idmap);
304 revert_creds(saved_cred);
305
Bryan Schumaker955a8572010-09-29 15:41:49 -0400306 if (IS_ERR(rkey)) {
307 ret = PTR_ERR(rkey);
308 goto out;
309 }
310
311 rcu_read_lock();
312 rkey->perm |= KEY_USR_VIEW;
313
314 ret = key_validate(rkey);
315 if (ret < 0)
316 goto out_up;
317
Trond Myklebust393faff2013-08-21 20:06:11 -0400318 payload = rcu_dereference(rkey->payload.rcudata);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400319 if (IS_ERR_OR_NULL(payload)) {
320 ret = PTR_ERR(payload);
321 goto out_up;
322 }
323
324 ret = payload->datalen;
325 if (ret > 0 && ret <= data_size)
326 memcpy(data, payload->data, ret);
327 else
328 ret = -EINVAL;
329
330out_up:
331 rcu_read_unlock();
332 key_put(rkey);
333out:
334 return ret;
335}
336
Bryan Schumaker955a8572010-09-29 15:41:49 -0400337/* ID -> Name */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500338static ssize_t nfs_idmap_lookup_name(__u32 id, const char *type, char *buf,
339 size_t buflen, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400340{
341 char id_str[NFS_UINT_MAXLEN];
342 int id_len;
343 ssize_t ret;
344
345 id_len = snprintf(id_str, sizeof(id_str), "%u", id);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500346 ret = nfs_idmap_get_key(id_str, id_len, type, buf, buflen, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400347 if (ret < 0)
348 return -EINVAL;
349 return ret;
350}
351
352/* Name -> ID */
Bryan Schumaker57e62322012-02-24 14:14:51 -0500353static int nfs_idmap_lookup_id(const char *name, size_t namelen, const char *type,
354 __u32 *id, struct idmap *idmap)
Bryan Schumaker955a8572010-09-29 15:41:49 -0400355{
356 char id_str[NFS_UINT_MAXLEN];
357 long id_long;
358 ssize_t data_size;
359 int ret = 0;
360
Bryan Schumaker57e62322012-02-24 14:14:51 -0500361 data_size = nfs_idmap_get_key(name, namelen, type, id_str, NFS_UINT_MAXLEN, idmap);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400362 if (data_size <= 0) {
363 ret = -EINVAL;
364 } else {
Daniel Walter7297cb62012-09-26 21:51:46 +0200365 ret = kstrtol(id_str, 10, &id_long);
Bryan Schumaker955a8572010-09-29 15:41:49 -0400366 *id = (__u32)id_long;
367 }
368 return ret;
369}
370
Bryan Schumakere6499c62012-01-26 16:54:23 -0500371/* idmap classic begins here */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
Bryan Schumaker57e62322012-02-24 14:14:51 -0500373enum {
374 Opt_find_uid, Opt_find_gid, Opt_find_user, Opt_find_group, Opt_find_err
375};
376
377static const match_table_t nfs_idmap_tokens = {
378 { Opt_find_uid, "uid:%s" },
379 { Opt_find_gid, "gid:%s" },
380 { Opt_find_user, "user:%s" },
381 { Opt_find_group, "group:%s" },
382 { Opt_find_err, NULL }
383};
384
385static int nfs_idmap_legacy_upcall(struct key_construction *, const char *, void *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500386static ssize_t idmap_pipe_downcall(struct file *, const char __user *,
387 size_t);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400388static void idmap_release_pipe(struct inode *);
Chuck Lever369af0f2007-12-20 14:54:35 -0500389static void idmap_pipe_destroy_msg(struct rpc_pipe_msg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Trond Myklebustb693ba42009-08-09 15:14:15 -0400391static const struct rpc_pipe_ops idmap_upcall_ops = {
Peng Taoc1225152011-09-22 21:50:10 -0400392 .upcall = rpc_pipe_generic_upcall,
Chuck Lever369af0f2007-12-20 14:54:35 -0500393 .downcall = idmap_pipe_downcall,
Bryan Schumakerc5066942012-08-09 14:05:49 -0400394 .release_pipe = idmap_release_pipe,
Chuck Lever369af0f2007-12-20 14:54:35 -0500395 .destroy_msg = idmap_pipe_destroy_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396};
397
Trond Myklebust17280172012-03-11 13:11:00 -0400398static struct key_type key_type_id_resolver_legacy = {
David Howellsa427b9e2012-07-25 16:53:36 +0100399 .name = "id_legacy",
David Howellsf9167782014-07-18 18:56:35 +0100400 .preparse = user_preparse,
401 .free_preparse = user_free_preparse,
402 .instantiate = generic_key_instantiate,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500403 .revoke = user_revoke,
404 .destroy = user_destroy,
405 .describe = user_describe,
406 .read = user_read,
407 .request_key = nfs_idmap_legacy_upcall,
408};
409
Trond Myklebust2127d822013-08-26 17:16:17 -0400410static void nfs_idmap_pipe_destroy(struct dentry *dir,
411 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400412{
Trond Myklebust2127d822013-08-26 17:16:17 -0400413 struct idmap *idmap = pdo->pdo_data;
414 struct rpc_pipe *pipe = idmap->idmap_pipe;
415
Trond Myklebustd7631252013-08-26 17:26:51 -0400416 if (pipe->dentry) {
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400417 rpc_unlink(pipe->dentry);
Trond Myklebustd7631252013-08-26 17:26:51 -0400418 pipe->dentry = NULL;
419 }
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400420}
421
Trond Myklebust2127d822013-08-26 17:16:17 -0400422static int nfs_idmap_pipe_create(struct dentry *dir,
423 struct rpc_pipe_dir_object *pdo)
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400424{
Trond Myklebust2127d822013-08-26 17:16:17 -0400425 struct idmap *idmap = pdo->pdo_data;
426 struct rpc_pipe *pipe = idmap->idmap_pipe;
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400427 struct dentry *dentry;
428
429 dentry = rpc_mkpipe_dentry(dir, "idmap", idmap, pipe);
430 if (IS_ERR(dentry))
431 return PTR_ERR(dentry);
432 pipe->dentry = dentry;
433 return 0;
434}
435
Trond Myklebust2127d822013-08-26 17:16:17 -0400436static const struct rpc_pipe_dir_object_ops nfs_idmap_pipe_dir_object_ops = {
437 .create = nfs_idmap_pipe_create,
438 .destroy = nfs_idmap_pipe_destroy,
439};
Stanislav Kinsbursky4929d1d2012-01-10 16:13:11 +0400440
David Howellsb7162792006-08-22 20:06:09 -0400441int
David Howellsadfa6f92006-08-22 20:06:08 -0400442nfs_idmap_new(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
444 struct idmap *idmap;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300445 struct rpc_pipe *pipe;
David Howellsb7162792006-08-22 20:06:09 -0400446 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Chuck Lever369af0f2007-12-20 14:54:35 -0500448 idmap = kzalloc(sizeof(*idmap), GFP_KERNEL);
449 if (idmap == NULL)
450 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Trond Myklebust2127d822013-08-26 17:16:17 -0400452 rpc_init_pipe_dir_object(&idmap->idmap_pdo,
453 &nfs_idmap_pipe_dir_object_ops,
454 idmap);
455
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300456 pipe = rpc_mkpipe_data(&idmap_upcall_ops, 0);
457 if (IS_ERR(pipe)) {
458 error = PTR_ERR(pipe);
Trond Myklebust2127d822013-08-26 17:16:17 -0400459 goto err;
Stanislav Kinsburskyc239d832011-12-26 15:44:06 +0300460 }
461 idmap->idmap_pipe = pipe;
Bryan Schumakerb1027432012-06-20 14:35:28 -0400462 mutex_init(&idmap->idmap_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
Trond Myklebust2127d822013-08-26 17:16:17 -0400464 error = rpc_add_pipe_dir_object(clp->cl_net,
465 &clp->cl_rpcclient->cl_pipedir_objects,
466 &idmap->idmap_pdo);
467 if (error)
468 goto err_destroy_pipe;
469
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 clp->cl_idmap = idmap;
David Howellsb7162792006-08-22 20:06:09 -0400471 return 0;
Trond Myklebust2127d822013-08-26 17:16:17 -0400472err_destroy_pipe:
473 rpc_destroy_pipe_data(idmap->idmap_pipe);
474err:
475 kfree(idmap);
476 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477}
478
479void
David Howellsadfa6f92006-08-22 20:06:08 -0400480nfs_idmap_delete(struct nfs_client *clp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
482 struct idmap *idmap = clp->cl_idmap;
483
484 if (!idmap)
485 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 clp->cl_idmap = NULL;
Trond Myklebust2127d822013-08-26 17:16:17 -0400487 rpc_remove_pipe_dir_object(clp->cl_net,
488 &clp->cl_rpcclient->cl_pipedir_objects,
489 &idmap->idmap_pdo);
490 rpc_destroy_pipe_data(idmap->idmap_pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 kfree(idmap);
492}
493
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400494int nfs_idmap_init(void)
495{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500496 int ret;
497 ret = nfs_idmap_init_keyring();
498 if (ret != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 goto out;
Bryan Schumakere6499c62012-01-26 16:54:23 -0500500out:
Chuck Lever369af0f2007-12-20 14:54:35 -0500501 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502}
503
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400504void nfs_idmap_quit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Bryan Schumakere6499c62012-01-26 16:54:23 -0500506 nfs_idmap_quit_keyring();
Stanislav Kinsburskyeee17322012-01-10 16:13:19 +0400507}
508
Bryan Schumakerc5066942012-08-09 14:05:49 -0400509static int nfs_idmap_prepare_message(char *desc, struct idmap *idmap,
510 struct idmap_msg *im,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500511 struct rpc_pipe_msg *msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Bryan Schumaker57e62322012-02-24 14:14:51 -0500513 substring_t substr;
514 int token, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Bryan Schumaker57e62322012-02-24 14:14:51 -0500516 im->im_type = IDMAP_TYPE_GROUP;
517 token = match_token(desc, nfs_idmap_tokens, &substr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
Bryan Schumaker57e62322012-02-24 14:14:51 -0500519 switch (token) {
520 case Opt_find_uid:
521 im->im_type = IDMAP_TYPE_USER;
522 case Opt_find_gid:
523 im->im_conv = IDMAP_CONV_NAMETOID;
524 ret = match_strlcpy(im->im_name, &substr, IDMAP_NAMESZ);
525 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Bryan Schumaker57e62322012-02-24 14:14:51 -0500527 case Opt_find_user:
528 im->im_type = IDMAP_TYPE_USER;
529 case Opt_find_group:
530 im->im_conv = IDMAP_CONV_IDTONAME;
531 ret = match_int(&substr, &im->im_id);
532 break;
Trond Myklebust685f50f2012-02-08 13:39:15 -0500533
Bryan Schumaker57e62322012-02-24 14:14:51 -0500534 default:
535 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 goto out;
537 }
538
Bryan Schumaker57e62322012-02-24 14:14:51 -0500539 msg->data = im;
540 msg->len = sizeof(struct idmap_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Bryan Schumaker57e62322012-02-24 14:14:51 -0500542out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 return ret;
544}
545
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400546static bool
547nfs_idmap_prepare_pipe_upcall(struct idmap *idmap,
Trond Myklebust0cac1202012-09-27 16:15:00 -0400548 struct idmap_legacy_upcalldata *data)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400549{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400550 if (idmap->idmap_upcall_data != NULL) {
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400551 WARN_ON_ONCE(1);
552 return false;
553 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400554 idmap->idmap_upcall_data = data;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400555 return true;
556}
557
558static void
559nfs_idmap_complete_pipe_upcall_locked(struct idmap *idmap, int ret)
560{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400561 struct key_construction *cons = idmap->idmap_upcall_data->key_cons;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400562
Trond Myklebust0cac1202012-09-27 16:15:00 -0400563 kfree(idmap->idmap_upcall_data);
564 idmap->idmap_upcall_data = NULL;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400565 complete_request_key(cons, ret);
566}
567
568static void
569nfs_idmap_abort_pipe_upcall(struct idmap *idmap, int ret)
570{
Trond Myklebust0cac1202012-09-27 16:15:00 -0400571 if (idmap->idmap_upcall_data != NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400572 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
573}
574
Bryan Schumaker57e62322012-02-24 14:14:51 -0500575static int nfs_idmap_legacy_upcall(struct key_construction *cons,
576 const char *op,
577 void *aux)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400579 struct idmap_legacy_upcalldata *data;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500580 struct rpc_pipe_msg *msg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 struct idmap_msg *im;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500582 struct idmap *idmap = (struct idmap *)aux;
583 struct key *key = cons->key;
Dan Carpenter5abc03c2012-05-14 22:45:28 +0300584 int ret = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Bryan Schumaker57e62322012-02-24 14:14:51 -0500586 /* msg and im are freed in idmap_pipe_destroy_msg */
Bryan Schumaker57a51042012-08-09 14:05:51 -0400587 data = kzalloc(sizeof(*data), GFP_KERNEL);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400588 if (!data)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500589 goto out1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Bryan Schumakerc5066942012-08-09 14:05:49 -0400591 msg = &data->pipe_msg;
592 im = &data->idmap_msg;
593 data->idmap = idmap;
Bryan Schumakerddfc4e12012-10-02 16:01:38 -0400594 data->key_cons = cons;
Bryan Schumakerc5066942012-08-09 14:05:49 -0400595
596 ret = nfs_idmap_prepare_message(key->description, idmap, im, msg);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500597 if (ret < 0)
598 goto out2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400600 ret = -EAGAIN;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400601 if (!nfs_idmap_prepare_pipe_upcall(idmap, data))
Trond Myklebust0e24d842012-09-28 12:03:09 -0400602 goto out2;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500603
Bryan Schumaker11588f42012-03-12 11:33:00 -0400604 ret = rpc_queue_upcall(idmap->idmap_pipe, msg);
605 if (ret < 0)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400606 nfs_idmap_abort_pipe_upcall(idmap, ret);
Bryan Schumaker11588f42012-03-12 11:33:00 -0400607
608 return ret;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500609out2:
Bryan Schumakerc5066942012-08-09 14:05:49 -0400610 kfree(data);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500611out1:
David Howellsa427b9e2012-07-25 16:53:36 +0100612 complete_request_key(cons, ret);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500613 return ret;
614}
615
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500616static int nfs_idmap_instantiate(struct key *key, struct key *authkey, char *data, size_t datalen)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500617{
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500618 return key_instantiate_and_link(key, data, datalen,
Bryan Schumaker57e62322012-02-24 14:14:51 -0500619 id_resolver_cache->thread_keyring,
620 authkey);
621}
622
Trond Myklebust0cac1202012-09-27 16:15:00 -0400623static int nfs_idmap_read_and_verify_message(struct idmap_msg *im,
624 struct idmap_msg *upcall,
625 struct key *key, struct key *authkey)
Bryan Schumaker57e62322012-02-24 14:14:51 -0500626{
627 char id_str[NFS_UINT_MAXLEN];
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500628 size_t len;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400629 int ret = -ENOKEY;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500630
Trond Myklebust0cac1202012-09-27 16:15:00 -0400631 /* ret = -ENOKEY */
632 if (upcall->im_type != im->im_type || upcall->im_conv != im->im_conv)
633 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500634 switch (im->im_conv) {
635 case IDMAP_CONV_NAMETOID:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400636 if (strcmp(upcall->im_name, im->im_name) != 0)
637 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500638 /* Note: here we store the NUL terminator too */
639 len = sprintf(id_str, "%d", im->im_id) + 1;
640 ret = nfs_idmap_instantiate(key, authkey, id_str, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500641 break;
642 case IDMAP_CONV_IDTONAME:
Trond Myklebust0cac1202012-09-27 16:15:00 -0400643 if (upcall->im_id != im->im_id)
644 break;
Trond Myklebustcf4ab532013-03-08 12:56:37 -0500645 len = strlen(im->im_name);
646 ret = nfs_idmap_instantiate(key, authkey, im->im_name, len);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500647 break;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400648 default:
649 ret = -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 }
Trond Myklebust0cac1202012-09-27 16:15:00 -0400651out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return ret;
653}
654
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655static ssize_t
656idmap_pipe_downcall(struct file *filp, const char __user *src, size_t mlen)
657{
Al Viro496ad9a2013-01-23 17:07:38 -0500658 struct rpc_inode *rpci = RPC_I(file_inode(filp));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 struct idmap *idmap = (struct idmap *)rpci->private;
David Howellsa427b9e2012-07-25 16:53:36 +0100660 struct key_construction *cons;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500661 struct idmap_msg im;
Chuck Leverd24aae42007-12-20 14:54:49 -0500662 size_t namelen_in;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400663 int ret = -ENOKEY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
David Howellsa427b9e2012-07-25 16:53:36 +0100665 /* If instantiation is successful, anyone waiting for key construction
666 * will have been woken up and someone else may now have used
667 * idmap_key_cons - so after this point we may no longer touch it.
668 */
Trond Myklebust0cac1202012-09-27 16:15:00 -0400669 if (idmap->idmap_upcall_data == NULL)
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400670 goto out_noupcall;
David Howellsa427b9e2012-07-25 16:53:36 +0100671
Trond Myklebust0cac1202012-09-27 16:15:00 -0400672 cons = idmap->idmap_upcall_data->key_cons;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
Bryan Schumaker57e62322012-02-24 14:14:51 -0500674 if (mlen != sizeof(im)) {
675 ret = -ENOSPC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 goto out;
677 }
678
Bryan Schumaker57e62322012-02-24 14:14:51 -0500679 if (copy_from_user(&im, src, mlen) != 0) {
680 ret = -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 goto out;
682 }
683
Bryan Schumaker57e62322012-02-24 14:14:51 -0500684 if (!(im.im_status & IDMAP_STATUS_SUCCESS)) {
Bryan Schumaker12dfd082012-08-09 14:05:50 -0400685 ret = -ENOKEY;
686 goto out;
Bryan Schumaker57e62322012-02-24 14:14:51 -0500687 }
688
689 namelen_in = strnlen(im.im_name, IDMAP_NAMESZ);
690 if (namelen_in == 0 || namelen_in == IDMAP_NAMESZ) {
691 ret = -EINVAL;
692 goto out;
Trond Myklebust0cac1202012-09-27 16:15:00 -0400693}
Bryan Schumaker57e62322012-02-24 14:14:51 -0500694
Trond Myklebust0cac1202012-09-27 16:15:00 -0400695 ret = nfs_idmap_read_and_verify_message(&im,
696 &idmap->idmap_upcall_data->idmap_msg,
697 cons->key, cons->authkey);
Bryan Schumaker57e62322012-02-24 14:14:51 -0500698 if (ret >= 0) {
699 key_set_timeout(cons->key, nfs_idmap_cache_timeout);
700 ret = mlen;
701 }
702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703out:
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400704 nfs_idmap_complete_pipe_upcall_locked(idmap, ret);
705out_noupcall:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 return ret;
707}
708
Adrian Bunk75c96f82005-05-05 16:16:09 -0700709static void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710idmap_pipe_destroy_msg(struct rpc_pipe_msg *msg)
711{
Bryan Schumakerc5066942012-08-09 14:05:49 -0400712 struct idmap_legacy_upcalldata *data = container_of(msg,
713 struct idmap_legacy_upcalldata,
714 pipe_msg);
715 struct idmap *idmap = data->idmap;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400716
717 if (msg->errno)
718 nfs_idmap_abort_pipe_upcall(idmap, msg->errno);
Bryan Schumakerc5066942012-08-09 14:05:49 -0400719}
720
721static void
722idmap_release_pipe(struct inode *inode)
723{
724 struct rpc_inode *rpci = RPC_I(inode);
725 struct idmap *idmap = (struct idmap *)rpci->private;
Trond Myklebuste9ab41b62012-09-27 15:44:19 -0400726
727 nfs_idmap_abort_pipe_upcall(idmap, -EPIPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
729
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800730int 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 -0700731{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800732 struct idmap *idmap = server->nfs_client->cl_idmap;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800733 __u32 id = -1;
734 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800736 if (!nfs_map_string_to_numeric(name, namelen, &id))
737 ret = nfs_idmap_lookup_id(name, namelen, "uid", &id, idmap);
738 if (ret == 0) {
739 *uid = make_kuid(&init_user_ns, id);
740 if (!uid_valid(*uid))
741 ret = -ERANGE;
742 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400743 trace_nfs4_map_name_to_uid(name, namelen, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800744 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745}
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800746
747int nfs_map_group_to_gid(const struct nfs_server *server, const char *name, size_t namelen, kgid_t *gid)
748{
749 struct idmap *idmap = server->nfs_client->cl_idmap;
750 __u32 id = -1;
751 int ret = 0;
752
753 if (!nfs_map_string_to_numeric(name, namelen, &id))
754 ret = nfs_idmap_lookup_id(name, namelen, "gid", &id, idmap);
755 if (ret == 0) {
756 *gid = make_kgid(&init_user_ns, id);
757 if (!gid_valid(*gid))
758 ret = -ERANGE;
759 }
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400760 trace_nfs4_map_group_to_gid(name, namelen, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800761 return ret;
762}
763
764int 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 -0700765{
Trond Myklebuste4fd72a2011-02-22 15:44:31 -0800766 struct idmap *idmap = server->nfs_client->cl_idmap;
Trond Myklebustb064eca22011-02-22 15:44:32 -0800767 int ret = -EINVAL;
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800768 __u32 id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800770 id = from_kuid(&init_user_ns, uid);
Trond Myklebustb064eca22011-02-22 15:44:32 -0800771 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800772 ret = nfs_idmap_lookup_name(id, "user", buf, buflen, idmap);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800773 if (ret < 0)
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800774 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400775 trace_nfs4_map_uid_to_name(buf, ret, id, ret);
Eric W. Biederman9f309c82013-02-01 03:21:47 -0800776 return ret;
777}
778int nfs_map_gid_to_group(const struct nfs_server *server, kgid_t gid, char *buf, size_t buflen)
779{
780 struct idmap *idmap = server->nfs_client->cl_idmap;
781 int ret = -EINVAL;
782 __u32 id;
783
784 id = from_kgid(&init_user_ns, gid);
785 if (!(server->caps & NFS_CAP_UIDGID_NOMAP))
786 ret = nfs_idmap_lookup_name(id, "group", buf, buflen, idmap);
787 if (ret < 0)
788 ret = nfs_map_numeric_to_string(id, buf, buflen);
Trond Myklebust1f2d30b2013-08-13 11:34:01 -0400789 trace_nfs4_map_gid_to_group(buf, ret, id, ret);
Trond Myklebustf0b85162011-02-22 15:44:31 -0800790 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791}