xref: /onnv-gate/usr/src/uts/common/nfs/nfsid_map.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _NFSID_MAP_H
28*0Sstevel@tonic-gate #define	_NFSID_MAP_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifndef _KERNEL
33*0Sstevel@tonic-gate #include <stddef.h>
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate #include <sys/sysmacros.h>
36*0Sstevel@tonic-gate #include <sys/types.h>
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate /*
39*0Sstevel@tonic-gate  * NFSv4 id mapping daemon
40*0Sstevel@tonic-gate  *
41*0Sstevel@tonic-gate  * This daemon is used by the kernel to map strings in the form
42*0Sstevel@tonic-gate  * "user@dns_domain" from an integer form or vice-versa.  The daemon
43*0Sstevel@tonic-gate  * uses the system configured name services for the mapping.
44*0Sstevel@tonic-gate  *
45*0Sstevel@tonic-gate  * The status results determines if a mapping was successful.
46*0Sstevel@tonic-gate  *
47*0Sstevel@tonic-gate  * The mapping is cached in the kernel, so that expensive upcalls are
48*0Sstevel@tonic-gate  * reduced to a minimum.
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate #ifdef	__cplusplus
52*0Sstevel@tonic-gate extern "C" {
53*0Sstevel@tonic-gate #endif
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate /*
56*0Sstevel@tonic-gate  * mapid commands
57*0Sstevel@tonic-gate  */
58*0Sstevel@tonic-gate #define	NFSMAPID_STR_UID	1
59*0Sstevel@tonic-gate #define	NFSMAPID_UID_STR	2
60*0Sstevel@tonic-gate #define	NFSMAPID_STR_GID	3
61*0Sstevel@tonic-gate #define	NFSMAPID_GID_STR	4
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate /*
64*0Sstevel@tonic-gate  * We are passing in arguments in a variable length struct
65*0Sstevel@tonic-gate  * similar to a dirent_t. We break apart a utf8string into
66*0Sstevel@tonic-gate  * its components and allocate a struct long enough to hold
67*0Sstevel@tonic-gate  * the string and a NUL terminator.  The caller must ensure the
68*0Sstevel@tonic-gate  * terminator is set.
69*0Sstevel@tonic-gate  */
70*0Sstevel@tonic-gate struct mapid_arg {
71*0Sstevel@tonic-gate 	uint_t	cmd;
72*0Sstevel@tonic-gate 	union {
73*0Sstevel@tonic-gate 		uid_t		uid;
74*0Sstevel@tonic-gate 		gid_t		gid;
75*0Sstevel@tonic-gate 		int		len;
76*0Sstevel@tonic-gate 	} u_arg;
77*0Sstevel@tonic-gate 	char str[1];
78*0Sstevel@tonic-gate };
79*0Sstevel@tonic-gate typedef struct mapid_arg mapid_arg_t;
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate /*
82*0Sstevel@tonic-gate  * The actual required size of the args, rounded up to a 64 bit boundary
83*0Sstevel@tonic-gate  */
84*0Sstevel@tonic-gate #define	MAPID_ARG_LEN(str_length)	\
85*0Sstevel@tonic-gate 	((offsetof(mapid_arg_t, str[0]) + 1 + (str_length) + 7) & ~ 7)
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate /*
88*0Sstevel@tonic-gate  * Return status codes
89*0Sstevel@tonic-gate  */
90*0Sstevel@tonic-gate #define	NFSMAPID_OK		0
91*0Sstevel@tonic-gate 
92*0Sstevel@tonic-gate /*
93*0Sstevel@tonic-gate  * numeric string is mapped to its literal number
94*0Sstevel@tonic-gate  */
95*0Sstevel@tonic-gate #define	NFSMAPID_NUMSTR		1
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * Value cannot be mapped, badly formed string
99*0Sstevel@tonic-gate  */
100*0Sstevel@tonic-gate #define	NFSMAPID_UNMAPPABLE	2
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate /*
103*0Sstevel@tonic-gate  * Caller provided invalid arguments
104*0Sstevel@tonic-gate  */
105*0Sstevel@tonic-gate #define	NFSMAPID_INVALID	3
106*0Sstevel@tonic-gate 
107*0Sstevel@tonic-gate /*
108*0Sstevel@tonic-gate  * Internal error in daemon e.g. out of memory, can't return result
109*0Sstevel@tonic-gate  */
110*0Sstevel@tonic-gate #define	NFSMAPID_INTERNAL	4
111*0Sstevel@tonic-gate 
112*0Sstevel@tonic-gate /*
113*0Sstevel@tonic-gate  * Incorrect domain used
114*0Sstevel@tonic-gate  */
115*0Sstevel@tonic-gate #define	NFSMAPID_BADDOMAIN	5
116*0Sstevel@tonic-gate 
117*0Sstevel@tonic-gate /*
118*0Sstevel@tonic-gate  * Out of range uid/gid
119*0Sstevel@tonic-gate  */
120*0Sstevel@tonic-gate #define	NFSMAPID_BADID		6
121*0Sstevel@tonic-gate 
122*0Sstevel@tonic-gate /*
123*0Sstevel@tonic-gate  * User or group cannot be found in nameservice
124*0Sstevel@tonic-gate  */
125*0Sstevel@tonic-gate #define	NFSMAPID_NOTFOUND	7
126*0Sstevel@tonic-gate 
127*0Sstevel@tonic-gate /*
128*0Sstevel@tonic-gate  * Similar to the arguments, the result is variable length.
129*0Sstevel@tonic-gate  * The returner must ensure the string terminator is set.
130*0Sstevel@tonic-gate  */
131*0Sstevel@tonic-gate struct mapid_res {
132*0Sstevel@tonic-gate 	uint_t	status;
133*0Sstevel@tonic-gate 	union {
134*0Sstevel@tonic-gate 		uid_t		uid;
135*0Sstevel@tonic-gate 		gid_t		gid;
136*0Sstevel@tonic-gate 		int		len;
137*0Sstevel@tonic-gate 	} u_res;
138*0Sstevel@tonic-gate 	char str[1];
139*0Sstevel@tonic-gate };
140*0Sstevel@tonic-gate typedef struct mapid_res mapid_res_t;
141*0Sstevel@tonic-gate 
142*0Sstevel@tonic-gate /*
143*0Sstevel@tonic-gate  * The actual required size of the result, rounded up to a 64 bit boundary
144*0Sstevel@tonic-gate  */
145*0Sstevel@tonic-gate #define	MAPID_RES_LEN(str_length)	\
146*0Sstevel@tonic-gate 	((offsetof(mapid_res_t, str[0]) + 1 + (str_length) + 7) & ~ 7)
147*0Sstevel@tonic-gate 
148*0Sstevel@tonic-gate #ifdef	__cplusplus
149*0Sstevel@tonic-gate }
150*0Sstevel@tonic-gate #endif
151*0Sstevel@tonic-gate 
152*0Sstevel@tonic-gate #endif /* _NFSID_MAP_H */
153