xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_sid.h (revision d8a7fe16f62711cdc5c4267da8b34ff24a6b668c)
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  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SMB_SID_H
27 #define	_SMB_SID_H
28 
29 /*
30  * Security Identifier (SID) interface definition.
31  */
32 #include <smbsrv/wintypes.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 /*
39  * Predefined global user RIDs.
40  */
41 #define	DOMAIN_USER_RID_ADMIN		(0x000001F4L)	/* 500 */
42 #define	DOMAIN_USER_RID_GUEST		(0x000001F5L)	/* 501 */
43 #define	DOMAIN_USER_RID_KRBTGT		(0x000001F6L)	/* 502 */
44 
45 /*
46  * Predefined global group RIDs.
47  */
48 #define	DOMAIN_GROUP_RID_ADMINS		(0x00000200L)	/* 512 */
49 #define	DOMAIN_GROUP_RID_USERS		(0x00000201L)
50 #define	DOMAIN_GROUP_RID_GUESTS		(0x00000202L)
51 #define	DOMAIN_GROUP_RID_COMPUTERS	(0x00000203L)
52 #define	DOMAIN_GROUP_RID_CONTROLLERS	(0x00000204L)
53 #define	DOMAIN_GROUP_RID_CERT_ADMINS	(0x00000205L)
54 #define	DOMAIN_GROUP_RID_SCHEMA_ADMINS	(0x00000206L)
55 
56 
57 /*
58  * Predefined local alias RIDs.
59  */
60 #define	DOMAIN_ALIAS_RID_ADMINS		(0x00000220L)	/* 544 */
61 #define	DOMAIN_ALIAS_RID_USERS		(0x00000221L)
62 #define	DOMAIN_ALIAS_RID_GUESTS		(0x00000222L)
63 #define	DOMAIN_ALIAS_RID_POWER_USERS	(0x00000223L)
64 #define	DOMAIN_ALIAS_RID_ACCOUNT_OPS	(0x00000224L)
65 #define	DOMAIN_ALIAS_RID_SYSTEM_OPS	(0x00000225L)
66 #define	DOMAIN_ALIAS_RID_PRINT_OPS	(0x00000226L)
67 #define	DOMAIN_ALIAS_RID_BACKUP_OPS	(0x00000227L)
68 #define	DOMAIN_ALIAS_RID_REPLICATOR	(0x00000228L)
69 
70 
71 /*
72  * Universal and NT well-known SIDs
73  */
74 #define	NT_NULL_SIDSTR				"S-1-0-0"
75 #define	NT_WORLD_SIDSTR				"S-1-1-0"
76 #define	NT_LOCAL_SIDSTR				"S-1-2-0"
77 #define	NT_CREATOR_OWNER_ID_SIDSTR		"S-1-3-0"
78 #define	NT_CREATOR_GROUP_ID_SIDSTR		"S-1-3-1"
79 #define	NT_CREATOR_OWNER_SERVER_ID_SIDSTR	"S-1-3-2"
80 #define	NT_CREATOR_GROUP_SERVER_ID_SIDSTR	"S-1-3-3"
81 #define	NT_NON_UNIQUE_IDS_SIDSTR		"S-1-4"
82 #define	NT_AUTHORITY_SIDSTR			"S-1-5"
83 #define	NT_DIALUP_SIDSTR			"S-1-5-1"
84 #define	NT_NETWORK_SIDSTR			"S-1-5-2"
85 #define	NT_BATCH_SIDSTR				"S-1-5-3"
86 #define	NT_INTERACTIVE_SIDSTR			"S-1-5-4"
87 #define	NT_SERVICE_SIDSTR			"S-1-5-6"
88 #define	NT_ANONYMOUS_LOGON_SIDSTR		"S-1-5-7"
89 #define	NT_PROXY_SIDSTR				"S-1-5-8"
90 #define	NT_SERVER_LOGON_SIDSTR			"S-1-5-9"
91 #define	NT_SELF_SIDSTR				"S-1-5-10"
92 #define	NT_AUTHENTICATED_USER_SIDSTR		"S-1-5-11"
93 #define	NT_RESTRICTED_CODE_SIDSTR		"S-1-5-12"
94 #define	NT_LOCAL_SYSTEM_SIDSTR			"S-1-5-18"
95 #define	NT_NON_UNIQUE_SIDSTR			"S-1-5-21"
96 #define	NT_BUILTIN_DOMAIN_SIDSTR		"S-1-5-32"
97 
98 
99 /*
100  * SID type indicators (SID_NAME_USE).
101  */
102 #define	SidTypeNull			0
103 #define	SidTypeUser			1
104 #define	SidTypeGroup			2
105 #define	SidTypeDomain			3
106 #define	SidTypeAlias			4
107 #define	SidTypeWellKnownGroup		5
108 #define	SidTypeDeletedAccount		6
109 #define	SidTypeInvalid			7
110 #define	SidTypeUnknown			8
111 #define	SidTypeComputer			9
112 #define	SidTypeLabel			10
113 
114 
115 /*
116  * Identifier authorities for various domains.
117  */
118 #define	NT_SID_NULL_AUTH		0
119 #define	NT_SID_WORLD_AUTH		1
120 #define	NT_SID_LOCAL_AUTH		2
121 #define	NT_SID_CREATOR_AUTH		3
122 #define	NT_SID_NON_UNIQUE_AUTH		4
123 #define	NT_SID_NT_AUTH			5
124 
125 
126 #define	NT_SECURITY_NULL_AUTH		{0, 0, 0, 0, 0, 0}
127 #define	NT_SECURITY_WORLD_AUTH		{0, 0, 0, 0, 0, 1}
128 #define	NT_SECURITY_LOCAL_AUTH		{0, 0, 0, 0, 0, 2}
129 #define	NT_SECURITY_CREATOR_AUTH	{0, 0, 0, 0, 0, 3}
130 #define	NT_SECURITY_NON_UNIQUE_AUTH	{0, 0, 0, 0, 0, 4}
131 #define	NT_SECURITY_NT_AUTH		{0, 0, 0, 0, 0, 5}
132 #define	NT_SECURITY_UNIX_AUTH		{0, 0, 0, 0, 0, 99}
133 
134 
135 #define	SECURITY_NULL_RID			(0x00000000L)
136 #define	SECURITY_WORLD_RID			(0x00000000L)
137 #define	SECURITY_LOCAL_RID			(0X00000000L)
138 
139 #define	SECURITY_CREATOR_OWNER_RID		(0x00000000L)
140 #define	SECURITY_CREATOR_GROUP_RID		(0x00000001L)
141 #define	SECURITY_CREATOR_OWNER_SERVER_RID	(0x00000002L)
142 #define	SECURITY_CREATOR_GROUP_SERVER_RID	(0x00000003L)
143 
144 #define	SECURITY_DIALUP_RID			(0x00000001L)
145 #define	SECURITY_NETWORK_RID			(0x00000002L)
146 #define	SECURITY_BATCH_RID			(0x00000003L)
147 #define	SECURITY_INTERACTIVE_RID		(0x00000004L)
148 #define	SECURITY_LOGON_IDS_RID			(0x00000005L)
149 #define	SECURITY_LOGON_IDS_RID_COUNT		(3L)
150 #define	SECURITY_SERVICE_RID			(0x00000006L)
151 #define	SECURITY_ANONYMOUS_LOGON_RID		(0x00000007L)
152 #define	SECURITY_PROXY_RID			(0x00000008L)
153 #define	SECURITY_ENTERPRISE_CONTROLLERS_RID	(0x00000009L)
154 #define	SECURITY_SERVER_LOGON_RID	SECURITY_ENTERPRISE_CONTROLLERS_RID
155 #define	SECURITY_PRINCIPAL_SELF_RID		(0x0000000AL)
156 #define	SECURITY_AUTHENTICATED_USER_RID		(0x0000000BL)
157 #define	SECURITY_RESTRICTED_CODE_RID		(0x0000000CL)
158 
159 #define	SECURITY_LOCAL_SYSTEM_RID		(0x00000012L)
160 #define	SECURITY_NT_NON_UNIQUE			(0x00000015L)
161 #define	SECURITY_BUILTIN_DOMAIN_RID		(0x00000020L)
162 
163 
164 #define	NT_SID_NON_UNIQUE_SUBAUTH 21
165 
166 
167 /*
168  * Common definition for a SID.
169  */
170 #define	NT_SID_REVISION		1
171 #define	NT_SID_AUTH_MAX		6
172 #define	NT_SID_SUBAUTH_MAX	15
173 
174 
175 /*
176  * Security Identifier (SID)
177  *
178  * The security identifier (SID) uniquely identifies a user, group or
179  * a domain. It consists of a revision number, the identifier authority,
180  * and a list of sub-authorities. The revision number is currently 1.
181  * The identifier authority identifies which system issued the SID. The
182  * sub-authorities of a domain SID uniquely identify a domain. A user
183  * or group SID consists of a domain SID with the user or group id
184  * appended. The user or group id (also known as a relative id (RID)
185  * uniquely identifies a user within a domain. A user or group SID
186  * uniquely identifies a user or group across all domains. The SidType
187  * values identify the various types of SID.
188  *
189  *      1   1   1   1   1   1
190  *      5   4   3   2   1   0   9   8   7   6   5   4   3   2   1   0
191  *   +---------------------------------------------------------------+
192  *   |      SubAuthorityCount        |Reserved1 (SBZ)|   Revision    |
193  *   +---------------------------------------------------------------+
194  *   |                   IdentifierAuthority[0]                      |
195  *   +---------------------------------------------------------------+
196  *   |                   IdentifierAuthority[1]                      |
197  *   +---------------------------------------------------------------+
198  *   |                   IdentifierAuthority[2]                      |
199  *   +---------------------------------------------------------------+
200  *   |                                                               |
201  *   +- -  -  -  -  -  -  -  SubAuthority[]  -  -  -  -  -  -  -  - -+
202  *   |                                                               |
203  *   +---------------------------------------------------------------+
204  *
205  */
206 /*
207  * Note: NT defines the Identifier Authority as a separate
208  * structure (SID_IDENTIFIER_AUTHORITY) containing a literal
209  * definition of a 6 byte vector but the effect is the same
210  * as defining it as a member value.
211  */
212 typedef struct smb_sid {
213 	uint8_t sid_revision;
214 	uint8_t sid_subauthcnt;
215 	uint8_t sid_authority[NT_SID_AUTH_MAX];
216 	uint32_t sid_subauth[ANY_SIZE_ARRAY];
217 } smb_sid_t;
218 
219 /*
220  * Only group attributes are defined. No user attributes defined.
221  */
222 #define	SE_GROUP_MANDATORY		0x00000001
223 #define	SE_GROUP_ENABLED_BY_DEFAULT	0x00000002
224 #define	SE_GROUP_ENABLED		0x00000004
225 #define	SE_GROUP_OWNER			0x00000008
226 #define	SE_GROUP_USE_FOR_DENY_ONLY	0x00000010
227 #define	SE_GROUP_LOGON_ID		0xC0000000
228 
229 /*
230  * smb_id_t consists of both the Windows security identifier
231  * and its corresponding POSIX/ephemeral ID.
232  */
233 typedef struct smb_id {
234 	uint32_t	i_attrs;
235 	smb_sid_t	*i_sid;
236 	uid_t		i_id;
237 } smb_id_t;
238 
239 typedef struct smb_ids {
240 	uint32_t	i_cnt;
241 	smb_id_t	*i_ids;
242 } smb_ids_t;
243 
244 /*
245  * The maximum size of a SID in string format
246  */
247 #define	SMB_SID_STRSZ		256
248 
249 boolean_t smb_sid_isvalid(smb_sid_t *);
250 int smb_sid_len(smb_sid_t *);
251 smb_sid_t *smb_sid_dup(smb_sid_t *);
252 smb_sid_t *smb_sid_splice(smb_sid_t *, uint32_t);
253 int smb_sid_getrid(smb_sid_t *, uint32_t *);
254 smb_sid_t *smb_sid_split(smb_sid_t *, uint32_t *);
255 boolean_t smb_sid_cmp(smb_sid_t *, smb_sid_t *);
256 boolean_t smb_sid_islocal(smb_sid_t *);
257 boolean_t smb_sid_indomain(smb_sid_t *, smb_sid_t *);
258 void smb_sid_free(smb_sid_t *);
259 int smb_sid_splitstr(char *, uint32_t *);
260 void smb_sid_tostr(smb_sid_t *, char *);
261 smb_sid_t *smb_sid_fromstr(char *);
262 char *smb_sid_type2str(uint16_t);
263 
264 void smb_ids_free(smb_ids_t *);
265 
266 #ifdef __cplusplus
267 }
268 #endif
269 
270 
271 #endif /* _SMB_SID_H */
272