xref: /illumos-gate/usr/src/uts/common/sys/sid.h (revision f37b3cbb)
1f48205beScasper /*
2f48205beScasper  * CDDL HEADER START
3f48205beScasper  *
4f48205beScasper  * The contents of this file are subject to the terms of the
5f48205beScasper  * Common Development and Distribution License (the "License").
6f48205beScasper  * You may not use this file except in compliance with the License.
7f48205beScasper  *
8f48205beScasper  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9f48205beScasper  * or http://www.opensolaris.org/os/licensing.
10f48205beScasper  * See the License for the specific language governing permissions
11f48205beScasper  * and limitations under the License.
12f48205beScasper  *
13f48205beScasper  * When distributing Covered Code, include this CDDL HEADER in each
14f48205beScasper  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15f48205beScasper  * If applicable, add the following below this CDDL HEADER, with the
16f48205beScasper  * fields enclosed by brackets "[]" replaced with your own identifying
17f48205beScasper  * information: Portions Copyright [yyyy] [name of copyright owner]
18f48205beScasper  *
19f48205beScasper  * CDDL HEADER END
20f48205beScasper  */
21f48205beScasper 
22f48205beScasper /*
239fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
24f48205beScasper  * Use is subject to license terms.
25b819cea2SGordon Ross  *
26*f37b3cbbSMatt Barden  * Copyright 2020 Tintri by DDN, Inc. All rights reserved.
27f48205beScasper  */
28f48205beScasper 
29f48205beScasper #ifndef _SYS_SID_H
30f48205beScasper #define	_SYS_SID_H
31f48205beScasper 
32f48205beScasper #include <sys/types.h>
33f48205beScasper #include <sys/avl.h>
34b819cea2SGordon Ross #if defined(_KERNEL) || defined(_FAKE_KERNEL)
35bda89588Sjp151216 #include <sys/zone.h>
36bda89588Sjp151216 #endif
37f48205beScasper 
38f48205beScasper /*
39f48205beScasper  * Kernel SID data structure and functions.
40f48205beScasper  */
41f48205beScasper #ifdef __cplusplus
42f48205beScasper extern "C" {
43f48205beScasper #endif
44f48205beScasper 
45f48205beScasper /* sidsys subcodes */
46f48205beScasper #define	SIDSYS_ALLOC_IDS	0
47f48205beScasper /* Flags for ALLOC_IDS */
48f48205beScasper #define	SID_EXTEND_RANGE	0
49f48205beScasper #define	SID_NEW_RANGE		1
50f48205beScasper 
51f48205beScasper #define	SIDSYS_IDMAP_REG	1
52f48205beScasper #define	SIDSYS_IDMAP_UNREG	2
539fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define	SIDSYS_IDMAP_FLUSH_KCACHE 3
54f48205beScasper 
55f48205beScasper #define	SIDSYS_SID2ID	0
56f48205beScasper #define	SIDSYS_ID2SID	1
57f48205beScasper 
58b819cea2SGordon Ross #if defined(_KERNEL) || defined(_FAKE_KERNEL)
59da6c28aaSamw #define	KSIDLIST_MEM(n)	(sizeof (ksidlist_t) + ((n) - 1) * sizeof (ksid_t))
60da6c28aaSamw 
61f48205beScasper /* Domains are stored in AVL trees so we can share them among SIDs */
62f48205beScasper typedef struct ksiddomain {
63f48205beScasper 	uint_t		kd_ref;
64f48205beScasper 	uint_t		kd_len;
65f48205beScasper 	char		*kd_name;	/* Domain part of SID */
66f48205beScasper 	avl_node_t	kd_link;
67f48205beScasper } ksiddomain_t;
68f48205beScasper 
69f48205beScasper typedef struct ksid {
70f48205beScasper 	uid_t		ks_id;		/* Cache of (ephemeral) uid */
71f48205beScasper 	uint32_t	ks_rid;		/* Rid part of the name */
72f48205beScasper 	uint32_t	ks_attr;	/* Attribute */
73f48205beScasper 	ksiddomain_t	*ks_domain;	/* Domain descsriptor */
74f48205beScasper } ksid_t;
75f48205beScasper 
76f48205beScasper typedef enum ksid_index {
77f48205beScasper 	KSID_USER,
78f48205beScasper 	KSID_GROUP,
79f48205beScasper 	KSID_OWNER,
80f48205beScasper 	KSID_COUNT			/* Must be last */
81f48205beScasper } ksid_index_t;
82f48205beScasper 
83f48205beScasper /*
84f48205beScasper  * As no memory may be allocated for credentials while holding p_crlock,
85f48205beScasper  * all sub data structures need to be ref counted.
86f48205beScasper  */
87f48205beScasper 
88f48205beScasper typedef struct ksidlist {
89f48205beScasper 	uint_t		ksl_ref;
90f48205beScasper 	uint_t		ksl_nsid;
91f48205beScasper 	uint_t		ksl_neid;	/* Number of ids which are ephemeral */
92*f37b3cbbSMatt Barden 	ksid_t		**ksl_sorted;	/* ksl_sids sorted by ID */
93f48205beScasper 	ksid_t		ksl_sids[1];	/* Allocate ksl_nsid times */
94f48205beScasper } ksidlist_t;
95f48205beScasper 
96f48205beScasper typedef struct credsid {
97f48205beScasper 	uint_t		kr_ref;			/* Reference count */
98f48205beScasper 	ksid_t		kr_sidx[KSID_COUNT];	/* User, group, default owner */
99f48205beScasper 	ksidlist_t	*kr_sidlist;		/* List of SIDS */
100f48205beScasper } credsid_t;
101f48205beScasper 
102f48205beScasper const char *ksid_getdomain(ksid_t *);
103f48205beScasper uint_t ksid_getrid(ksid_t *);
104c1ce5987SMark Shellenbaum uid_t ksid_getid(ksid_t *);
105f48205beScasper 
106bda89588Sjp151216 int ksid_lookupbyuid(zone_t *, uid_t, ksid_t *);
107bda89588Sjp151216 int ksid_lookupbygid(zone_t *, gid_t, ksid_t *);
108f48205beScasper void ksid_rele(ksid_t *);
109f48205beScasper 
110f48205beScasper credsid_t *kcrsid_alloc(void);
111f48205beScasper 
112f48205beScasper credsid_t *kcrsid_setsid(credsid_t *, ksid_t *, ksid_index_t);
113f48205beScasper credsid_t *kcrsid_setsidlist(credsid_t *, ksidlist_t *);
114f48205beScasper 
115f48205beScasper void kcrsid_rele(credsid_t *);
116f48205beScasper void kcrsid_hold(credsid_t *);
117f48205beScasper void kcrsidcopy_to(const credsid_t *okcr, credsid_t *nkcr);
118f48205beScasper 
119f48205beScasper void ksiddomain_rele(ksiddomain_t *);
120f48205beScasper void ksiddomain_hold(ksiddomain_t *);
121f48205beScasper void ksidlist_rele(ksidlist_t *);
122f48205beScasper void ksidlist_hold(ksidlist_t *);
123*f37b3cbbSMatt Barden boolean_t ksidlist_has_sid(ksidlist_t *, const char *, uint32_t);
124*f37b3cbbSMatt Barden boolean_t ksidlist_has_pid(ksidlist_t *, uint32_t);
125f48205beScasper 
126f48205beScasper ksiddomain_t *ksid_lookupdomain(const char *);
127f48205beScasper 
128bda89588Sjp151216 ksidlist_t *kcrsid_gidstosids(zone_t *, int, gid_t *);
129f48205beScasper 
130b819cea2SGordon Ross #else /* _KERNEL */
131f48205beScasper 
132f48205beScasper int allocids(int, int, uid_t *, int, gid_t *);
1339fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States int __idmap_reg(int);
1349fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States int __idmap_unreg(int);
1359fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States int __idmap_flush_kcache(void);
136f48205beScasper 
137f48205beScasper #endif /* _KERNEL */
138f48205beScasper 
139f48205beScasper #ifdef __cplusplus
140f48205beScasper }
141f48205beScasper #endif
142f48205beScasper 
143f48205beScasper #endif /* _SYS_SID_H */
144