xref: /openbmc/linux/fs/nfs/nfs4idmap.h (revision 3cea11cd)
1 /*
2  * fs/nfs/nfs4idmap.h
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  */
36 #ifndef NFS_IDMAP_H
37 #define NFS_IDMAP_H
38 
39 #include <linux/uidgid.h>
40 #include <uapi/linux/nfs_idmap.h>
41 
42 
43 /* Forward declaration to make this header independent of others */
44 struct nfs_client;
45 struct nfs_server;
46 struct nfs_fattr;
47 struct nfs4_string;
48 
49 int nfs_idmap_init(void);
50 void nfs_idmap_quit(void);
51 int nfs_idmap_new(struct nfs_client *);
52 void nfs_idmap_delete(struct nfs_client *);
53 
54 void nfs_fattr_init_names(struct nfs_fattr *fattr,
55 		struct nfs4_string *owner_name,
56 		struct nfs4_string *group_name);
57 void nfs_fattr_free_names(struct nfs_fattr *);
58 void nfs_fattr_map_and_free_names(struct nfs_server *, struct nfs_fattr *);
59 
60 int nfs_map_name_to_uid(const struct nfs_server *, const char *, size_t, kuid_t *);
61 int nfs_map_group_to_gid(const struct nfs_server *, const char *, size_t, kgid_t *);
62 int nfs_map_uid_to_name(const struct nfs_server *, kuid_t, char *, size_t);
63 int nfs_map_gid_to_group(const struct nfs_server *, kgid_t, char *, size_t);
64 
65 int nfs_map_string_to_numeric(const char *name, size_t namelen, __u32 *res);
66 
67 extern unsigned int nfs_idmap_cache_timeout;
68 #endif /* NFS_IDMAP_H */
69