xref: /illumos-gate/usr/src/uts/common/sys/sid.h (revision dd4eeefd)
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 2007 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 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/types.h>
33 #include <sys/avl.h>
34 
35 /*
36  * Kernel SID data structure and functions.
37  */
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /* sidsys subcodes */
43 #define	SIDSYS_ALLOC_IDS	0
44 /* Flags for ALLOC_IDS */
45 #define		SID_EXTEND_RANGE	0
46 #define		SID_NEW_RANGE		1
47 
48 #define	SIDSYS_IDMAP_REG	1
49 #define	SIDSYS_IDMAP_UNREG	2
50 
51 #define	SIDSYS_SID2ID	0
52 #define	SIDSYS_ID2SID	1
53 
54 #ifdef _KERNEL
55 /* Domains are stored in AVL trees so we can share them among SIDs */
56 typedef struct ksiddomain {
57 	uint_t		kd_ref;
58 	uint_t		kd_len;
59 	char		*kd_name;	/* Domain part of SID */
60 	avl_node_t	kd_link;
61 } ksiddomain_t;
62 
63 typedef struct ksid {
64 	uid_t		ks_id;		/* Cache of (ephemeral) uid */
65 	uint32_t	ks_rid;		/* Rid part of the name */
66 	uint32_t	ks_attr;	/* Attribute */
67 	ksiddomain_t	*ks_domain;	/* Domain descsriptor */
68 } ksid_t;
69 
70 typedef enum ksid_index {
71 	KSID_USER,
72 	KSID_GROUP,
73 	KSID_OWNER,
74 	KSID_COUNT			/* Must be last */
75 } ksid_index_t;
76 
77 /*
78  * As no memory may be allocated for credentials while holding p_crlock,
79  * all sub data structures need to be ref counted.
80  */
81 
82 typedef struct ksidlist {
83 	uint_t		ksl_ref;
84 	uint_t		ksl_nsid;
85 	uint_t		ksl_neid;	/* Number of ids which are ephemeral */
86 	ksid_t		ksl_sids[1];	/* Allocate ksl_nsid times */
87 } ksidlist_t;
88 
89 typedef struct credsid {
90 	uint_t		kr_ref;			/* Reference count */
91 	ksid_t		kr_sidx[KSID_COUNT];	/* User, group, default owner */
92 	ksidlist_t	*kr_sidlist;		/* List of SIDS */
93 } credsid_t;
94 
95 const char *ksid_getdomain(ksid_t *);
96 uint_t ksid_getrid(ksid_t *);
97 
98 int ksid_lookupbyuid(uid_t, ksid_t *);
99 int ksid_lookupbygid(gid_t, ksid_t *);
100 void ksid_rele(ksid_t *);
101 
102 credsid_t *kcrsid_alloc(void);
103 
104 credsid_t *kcrsid_setsid(credsid_t *, ksid_t *, ksid_index_t);
105 credsid_t *kcrsid_setsidlist(credsid_t *, ksidlist_t *);
106 
107 void kcrsid_rele(credsid_t *);
108 void kcrsid_hold(credsid_t *);
109 void kcrsidcopy_to(const credsid_t *okcr, credsid_t *nkcr);
110 
111 void ksiddomain_rele(ksiddomain_t *);
112 void ksiddomain_hold(ksiddomain_t *);
113 void ksidlist_rele(ksidlist_t *);
114 void ksidlist_hold(ksidlist_t *);
115 
116 ksiddomain_t *ksid_lookupdomain(const char *);
117 
118 ksidlist_t *kcrsid_gidstosids(int, gid_t *);
119 
120 #else
121 
122 int allocids(int, int, uid_t *, int, gid_t *);
123 int idmap_reg(int);
124 int idmap_unreg(int);
125 
126 #endif /* _KERNEL */
127 
128 #ifdef __cplusplus
129 }
130 #endif
131 
132 #endif /* _SYS_SID_H */
133