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