xref: /illumos-gate/usr/src/cmd/idmap/idmapd/idmapd.h (revision 6cefaae1e90a413ba01560575bb3998e1a3df40e)
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _IDMAPD_H
27 #define	_IDMAPD_H
28 
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <stdarg.h>
32 #include <rpc/rpc.h>
33 #include <synch.h>
34 #include <thread.h>
35 #include <libintl.h>
36 #include <strings.h>
37 #include <sqlite/sqlite.h>
38 #include <inttypes.h>
39 #include "idmap_prot.h"
40 #include "adutils.h"
41 #include "idmap_config.h"
42 #include "libadutils.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 /* States a server can be in wrt request */
49 #define	_IDLE	0
50 #define	_SERVED	1
51 
52 #define	SENTINEL_PID	UINT32_MAX
53 #define	CHECK_NULL(s)	(s != NULL ? s : "null")
54 
55 extern int _rpcsvcstate;	/* set when a request is serviced */
56 extern int _rpcsvccount;	/* number of requests being serviced */
57 extern mutex_t _svcstate_lock;	/* lock for _rpcsvcstate, _rpcsvccount */
58 
59 typedef enum idmap_namemap_mode {
60 	IDMAP_NM_NONE = 0,
61 	IDMAP_NM_AD,
62 	IDMAP_NM_NLDAP,
63 	IDMAP_NM_MIXED
64 } idmap_namemap_mode_t;
65 
66 /*
67  * Global state of idmapd daemon.
68  */
69 #define	IDMAP_MAX_NAME_LEN	512
70 typedef struct idmapd_state {
71 	rwlock_t	rwlk_cfg;		/* config lock */
72 	idmap_cfg_t	*cfg;			/* config */
73 	bool_t		daemon_mode;
74 	bool_t		debug_mode;
75 	char		hostname[MAX_NAME_LEN];	/* my hostname */
76 	uid_t		next_uid;
77 	gid_t		next_gid;
78 	uid_t		limit_uid;
79 	gid_t		limit_gid;
80 	int		new_eph_db;	/* was the ephem ID db [re-]created? */
81 	bool_t		eph_map_unres_sids;
82 	adutils_ad_t	*ad;
83 } idmapd_state_t;
84 extern idmapd_state_t	_idmapdstate;
85 
86 #define	RDLOCK_CONFIG() \
87 	(void) rw_rdlock(&_idmapdstate.rwlk_cfg);
88 #define	WRLOCK_CONFIG() \
89 	(void) rw_wrlock(&_idmapdstate.rwlk_cfg);
90 #define	UNLOCK_CONFIG() \
91 	(void) rw_unlock(&_idmapdstate.rwlk_cfg);
92 
93 typedef struct hashentry {
94 	uint_t	key;
95 	uint_t	next;
96 } hashentry_t;
97 
98 typedef struct lookup_state {
99 	bool_t			sid2pid_done;
100 	bool_t			pid2sid_done;
101 	int			ad_nqueries;
102 	int			nldap_nqueries;
103 	bool_t			eph_map_unres_sids;
104 	uint_t			curpos;
105 	hashentry_t		*sid_history;
106 	uint_t			sid_history_size;
107 	idmap_mapping_batch	*batch;
108 	idmap_ids_res		*result;
109 	idmap_namemap_mode_t	nm_siduid;
110 	idmap_namemap_mode_t	nm_sidgid;
111 	char			*ad_unixuser_attr;
112 	char			*ad_unixgroup_attr;
113 	char			*nldap_winname_attr;
114 	char			*defdom;
115 	sqlite			*cache;
116 	sqlite			*db;
117 } lookup_state_t;
118 
119 #define	NLDAP_OR_MIXED(nm) \
120 	(nm == IDMAP_NM_NLDAP || nm == IDMAP_NM_MIXED)
121 #define	AD_OR_MIXED(nm) \
122 	(nm == IDMAP_NM_AD || nm == IDMAP_NM_MIXED)
123 
124 #define	NLDAP_OR_MIXED_MODE(pidtype, ls) \
125 	((pidtype == IDMAP_UID && NLDAP_OR_MIXED(ls->nm_siduid)) || \
126 	(pidtype == IDMAP_GID && NLDAP_OR_MIXED(ls->nm_sidgid)))
127 #define	AD_OR_MIXED_MODE(pidtype, ls)\
128 	((pidtype == IDMAP_UID && AD_OR_MIXED(ls->nm_siduid)) || \
129 	(pidtype == IDMAP_GID && AD_OR_MIXED(ls->nm_sidgid)))
130 #define	NLDAP_MODE(pidtype, ls) \
131 	((pidtype == IDMAP_UID && ls->nm_siduid == IDMAP_NM_NLDAP) || \
132 	(pidtype == IDMAP_GID && ls->nm_sidgid == IDMAP_NM_NLDAP))
133 #define	AD_MODE(pidtype, ls) \
134 	((pidtype == IDMAP_UID && ls->nm_siduid == IDMAP_NM_AD) || \
135 	(pidtype == IDMAP_GID && ls->nm_sidgid == IDMAP_NM_AD))
136 #define	MIXED_MODE(pidtype, ls) \
137 	((pidtype == IDMAP_UID && ls->nm_siduid == IDMAP_NM_MIXED) || \
138 	(pidtype == IDMAP_GID && ls->nm_sidgid == IDMAP_NM_MIXED))
139 
140 
141 typedef struct list_cb_data {
142 	void		*result;
143 	uint64_t	next;
144 	uint64_t	len;
145 	uint64_t	limit;
146 	int		flag;
147 } list_cb_data_t;
148 
149 typedef struct msg_table {
150 	idmap_retcode	retcode;
151 	const char	*msg;
152 } msg_table_t;
153 
154 #define	IDMAPD_SEARCH_TIMEOUT		3   /* seconds */
155 #define	IDMAPD_LDAP_OPEN_TIMEOUT	1   /* secs; initial, w/ exp backoff */
156 
157 /*
158  * The following flags are used by idmapd while processing a
159  * given mapping request. Note that idmapd uses multiple passes to
160  * process the request and the flags are used to pass information
161  * about the state of the request between these passes.
162  */
163 
164 /* Initial state. Done. Reset all flags. Remaining passes can be skipped */
165 #define	_IDMAP_F_DONE			0x00000000
166 /* Set when subsequent passes are required */
167 #define	_IDMAP_F_NOTDONE		0x00000001
168 /* Don't update name_cache. (e.g. set when winname,SID found in name_cache) */
169 #define	_IDMAP_F_DONT_UPDATE_NAMECACHE	0x00000002
170 /* Batch this request for AD lookup */
171 #define	_IDMAP_F_LOOKUP_AD		0x00000004
172 /* Batch this request for nldap directory lookup */
173 #define	_IDMAP_F_LOOKUP_NLDAP		0x00000008
174 /*
175  * Expired ephemeral mapping found in cache when processing sid2uid request.
176  * Use it if the given SID cannot be mapped by name
177  */
178 #define	_IDMAP_F_EXP_EPH_UID		0x00000010
179 /* Same as above. Used for sid2gid request */
180 #define	_IDMAP_F_EXP_EPH_GID		0x00000020
181 
182 /*
183  * Check if we are done. If so, subsequent passes can be skipped
184  * when processing a given mapping request.
185  */
186 #define	ARE_WE_DONE(f)	((f & _IDMAP_F_NOTDONE) == 0)
187 
188 #define	SIZE_INCR	5
189 #define	MAX_TRIES	5
190 #define	IDMAP_DBDIR	"/var/idmap"
191 #define	IDMAP_CACHEDIR	"/var/run/idmap"
192 #define	IDMAP_DBNAME	IDMAP_DBDIR "/idmap.db"
193 #define	IDMAP_CACHENAME	IDMAP_CACHEDIR "/idmap.db"
194 
195 #define	IS_BATCH_SID(batch, i) \
196 	(batch.idmap_mapping_batch_val[i].id1.idtype == IDMAP_SID ||	\
197 	batch.idmap_mapping_batch_val[i].id1.idtype == IDMAP_USID ||	\
198 	batch.idmap_mapping_batch_val[i].id1.idtype == IDMAP_GSID)
199 
200 #define	IS_BATCH_UID(batch, i) \
201 	(batch.idmap_mapping_batch_val[i].id1.idtype == IDMAP_UID)
202 
203 #define	IS_BATCH_GID(batch, i) \
204 	(batch.idmap_mapping_batch_val[i].id1.idtype == IDMAP_GID)
205 
206 #define	IS_REQUEST_SID(req, n) \
207 	((req).id##n.idtype == IDMAP_SID ||	\
208 	(req).id##n.idtype == IDMAP_USID ||	\
209 	(req).id##n.idtype == IDMAP_GSID)	\
210 
211 
212 #define	IS_REQUEST_UID(request) \
213 	((request).id1.idtype == IDMAP_UID)
214 
215 #define	IS_REQUEST_GID(request) \
216 	((request).id1.idtype == IDMAP_GID)
217 
218 typedef idmap_retcode (*update_list_res_cb)(void *, const char **, uint64_t);
219 typedef int (*list_svc_cb)(void *, int, char **, char **);
220 
221 extern void	idmap_prog_1(struct svc_req *, register SVCXPRT *);
222 extern void	idmapdlog(int, const char *, ...);
223 extern int	init_mapping_system();
224 extern void	fini_mapping_system();
225 extern void	print_idmapdstate();
226 extern int	create_directory(const char *, uid_t, gid_t);
227 extern int	load_config();
228 extern void	reload_ad();
229 extern int	idmap_init_tsd_key(void);
230 extern void	degrade_svc(int, const char *);
231 extern void	restore_svc(void);
232 
233 
234 extern int		init_dbs();
235 extern void		fini_dbs();
236 extern idmap_retcode	get_db_handle(sqlite **);
237 extern idmap_retcode	get_cache_handle(sqlite **);
238 extern idmap_retcode	sql_exec_no_cb(sqlite *, const char *, char *);
239 extern idmap_retcode	add_namerule(sqlite *, idmap_namerule *);
240 extern idmap_retcode	rm_namerule(sqlite *, idmap_namerule *);
241 extern idmap_retcode	flush_namerules(sqlite *);
242 
243 extern char 		*tolower_u8(const char *);
244 
245 extern idmap_retcode	gen_sql_expr_from_rule(idmap_namerule *, char **);
246 extern idmap_retcode	validate_list_cb_data(list_cb_data_t *, int,
247 				char **, int, uchar_t **, size_t);
248 extern idmap_retcode	process_list_svc_sql(sqlite *, const char *, char *,
249 				uint64_t, int, list_svc_cb, void *);
250 extern idmap_retcode	sid2pid_first_pass(lookup_state_t *,
251 				idmap_mapping *, idmap_id_res *);
252 extern idmap_retcode	sid2pid_second_pass(lookup_state_t *,
253 				idmap_mapping *, idmap_id_res *);
254 extern idmap_retcode	pid2sid_first_pass(lookup_state_t *,
255 				idmap_mapping *, idmap_id_res *, int, int);
256 extern idmap_retcode	pid2sid_second_pass(lookup_state_t *,
257 				idmap_mapping *, idmap_id_res *, int);
258 extern idmap_retcode	update_cache_sid2pid(lookup_state_t *,
259 				idmap_mapping *, idmap_id_res *);
260 extern idmap_retcode	update_cache_pid2sid(lookup_state_t *,
261 				idmap_mapping *, idmap_id_res *);
262 extern idmap_retcode	get_u2w_mapping(sqlite *, sqlite *, idmap_mapping *,
263 				idmap_mapping *, int);
264 extern idmap_retcode	get_w2u_mapping(sqlite *, sqlite *, idmap_mapping *,
265 				idmap_mapping *);
266 extern idmap_retcode	load_cfg_in_state(lookup_state_t *);
267 extern void		cleanup_lookup_state(lookup_state_t *);
268 
269 extern idmap_retcode	ad_lookup_batch(lookup_state_t *,
270 				idmap_mapping_batch *, idmap_ids_res *);
271 extern idmap_retcode	lookup_name2sid(sqlite *, const char *, const char *,
272 				int *, char **, char **, idmap_rid_t *,
273 				idmap_mapping *, int);
274 extern idmap_retcode	lookup_wksids_name2sid(const char *, char **, char **,
275 				idmap_rid_t *, int *);
276 
277 #ifdef __cplusplus
278 }
279 #endif
280 
281 #endif /* _IDMAPD_H */
282