xref: /titanic_41/usr/src/lib/smbsrv/libsmb/common/libsmb.h (revision ae5b046d8f8cec187d40041c4b74b43f561d5ac7)
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	_LIBSMB_H
27 #define	_LIBSMB_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 #include <sys/types.h>
36 #include <sys/list.h>
37 #include <arpa/inet.h>
38 #include <net/if.h>
39 #include <netdb.h>
40 
41 #include <stdlib.h>
42 #include <libscf.h>
43 #include <libshare.h>
44 #include <sqlite/sqlite.h>
45 
46 #include <smbsrv/string.h>
47 #include <smbsrv/smb_idmap.h>
48 #include <smbsrv/netbios.h>
49 
50 /*
51  * XXX - These header files are here, only because other libraries
52  * can compile. Move the header files in to the internal header files
53  * of other libraries, once the restructure is complete. libsmb.h does not
54  * need these header files.
55  */
56 #include <smbsrv/lmshare.h>
57 #include <smbsrv/lmshare_door.h>
58 #include <smbsrv/ntstatus.h>
59 #include <smbsrv/smb_door_svc.h>
60 #include <smbsrv/alloc.h>
61 #include <smbsrv/codepage.h>
62 #include <smbsrv/crypt.h>
63 #include <smbsrv/ctype.h>
64 #include <smbsrv/hash_table.h>
65 #include <smbsrv/msgbuf.h>
66 #include <smbsrv/oem.h>
67 #include <smbsrv/string.h>
68 #include <smbsrv/smb_i18n.h>
69 #include <smbsrv/wintypes.h>
70 #include <smbsrv/smb_xdr.h>
71 #include <smbsrv/smbinfo.h>
72 /* End of header files to be removed. */
73 
74 #define	SMB_VARRUN_DIR "/var/run/smb"
75 #define	SMB_CCACHE_FILE "ccache"
76 #define	SMB_CCACHE_PATH SMB_VARRUN_DIR "/" SMB_CCACHE_FILE
77 
78 /* Max value length of all SMB properties */
79 #define	MAX_VALUE_BUFLEN	512
80 
81 #define	SMBD_FMRI_PREFIX		"network/smb/server"
82 #define	SMBD_DEFAULT_INSTANCE_FMRI	"svc:/network/smb/server:default"
83 #define	SMBD_PG_NAME			"smbd"
84 #define	SMBD_PROTECTED_PG_NAME		"read"
85 
86 #define	SMBD_SMF_OK		0
87 #define	SMBD_SMF_NO_MEMORY	1	/* no memory for data structures */
88 #define	SMBD_SMF_SYSTEM_ERR	2	/* system error, use errno */
89 #define	SMBD_SMF_NO_PERMISSION	3	/* no permission for operation */
90 #define	SMBD_SMF_INVALID_ARG	4
91 
92 #define	SCH_STATE_UNINIT	0
93 #define	SCH_STATE_INITIALIZING	1
94 #define	SCH_STATE_INIT		2
95 
96 typedef struct smb_scfhandle {
97 	scf_handle_t		*scf_handle;
98 	int			scf_state;
99 	scf_service_t		*scf_service;
100 	scf_scope_t		*scf_scope;
101 	scf_transaction_t	*scf_trans;
102 	scf_transaction_entry_t	*scf_entry;
103 	scf_propertygroup_t	*scf_pg;
104 	scf_instance_t		*scf_instance;
105 	scf_iter_t		*scf_inst_iter;
106 	scf_iter_t		*scf_pg_iter;
107 } smb_scfhandle_t;
108 
109 /*
110  * CIFS Configuration Management
111  */
112 typedef enum {
113 	SMB_CI_OPLOCK_ENABLE = 0,
114 
115 	SMB_CI_AUTOHOME_MAP,
116 
117 	SMB_CI_DOMAIN_SID,
118 	SMB_CI_DOMAIN_MEMB,
119 	SMB_CI_DOMAIN_NAME,
120 	SMB_CI_DOMAIN_SRV,
121 
122 	SMB_CI_WINS_SRV1,
123 	SMB_CI_WINS_SRV2,
124 	SMB_CI_WINS_EXCL,
125 
126 	SMB_CI_SRVSVC_SHRSET_ENABLE,
127 	SMB_CI_MLRPC_KALIVE,
128 
129 	SMB_CI_MAX_WORKERS,
130 	SMB_CI_MAX_CONNECTIONS,
131 	SMB_CI_KEEPALIVE,
132 	SMB_CI_RESTRICT_ANON,
133 
134 	SMB_CI_SIGNING_ENABLE,
135 	SMB_CI_SIGNING_REQD,
136 	SMB_CI_SIGNING_CHECK,
137 
138 	SMB_CI_SYNC_ENABLE,
139 
140 	SMB_CI_SECURITY,
141 	SMB_CI_NBSCOPE,
142 	SMB_CI_SYS_CMNT,
143 	SMB_CI_LM_LEVEL,
144 
145 	SMB_CI_ADS_SITE,
146 
147 	SMB_CI_DYNDNS_ENABLE,
148 
149 	SMB_CI_MACHINE_PASSWD,
150 	SMB_CI_KPASSWD_SRV,
151 	SMB_CI_KPASSWD_DOMAIN,
152 	SMB_CI_KPASSWD_SEQNUM,
153 	SMB_CI_NETLOGON_SEQNUM,
154 	SMB_CI_MAX
155 } smb_cfg_id_t;
156 
157 /* SMF helper functions */
158 extern smb_scfhandle_t *smb_smf_scf_init(char *);
159 extern void smb_smf_scf_fini(smb_scfhandle_t *);
160 extern int smb_smf_start_transaction(smb_scfhandle_t *);
161 extern int smb_smf_end_transaction(smb_scfhandle_t *);
162 extern int smb_smf_set_string_property(smb_scfhandle_t *, char *, char *);
163 extern int smb_smf_get_string_property(smb_scfhandle_t *, char *,
164     char *, size_t);
165 extern int smb_smf_set_integer_property(smb_scfhandle_t *, char *, int64_t);
166 extern int smb_smf_get_integer_property(smb_scfhandle_t *, char *, int64_t *);
167 extern int smb_smf_set_boolean_property(smb_scfhandle_t *, char *, uint8_t);
168 extern int smb_smf_get_boolean_property(smb_scfhandle_t *, char *, uint8_t *);
169 extern int smb_smf_set_opaque_property(smb_scfhandle_t *, char *,
170     void *, size_t);
171 extern int smb_smf_get_opaque_property(smb_scfhandle_t *, char *,
172     void *, size_t);
173 extern int smb_smf_create_service_pgroup(smb_scfhandle_t *, char *);
174 
175 /* Configuration management functions  */
176 extern int smb_config_get(smb_cfg_id_t, char *, int);
177 extern char *smb_config_getname(smb_cfg_id_t);
178 extern int smb_config_getstr(smb_cfg_id_t, char *, int);
179 extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
180 extern boolean_t smb_config_getbool(smb_cfg_id_t);
181 
182 extern int smb_config_set(smb_cfg_id_t, char *);
183 extern int smb_config_setstr(smb_cfg_id_t, char *);
184 extern int smb_config_setnum(smb_cfg_id_t, int64_t);
185 extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
186 
187 extern uint8_t smb_config_get_fg_flag(void);
188 extern char *smb_config_get_localsid(void);
189 extern int smb_config_secmode_fromstr(char *);
190 extern char *smb_config_secmode_tostr(int);
191 extern int smb_config_get_secmode(void);
192 extern int smb_config_set_secmode(int);
193 extern int smb_config_set_idmap_domain(char *);
194 extern int smb_config_refresh_idmap(void);
195 
196 extern void smb_load_kconfig(smb_kmod_cfg_t *kcfg);
197 
198 extern boolean_t smb_match_netlogon_seqnum(void);
199 extern int smb_setdomainprops(char *, char *, char *);
200 extern void smb_update_netlogon_seqnum(void);
201 
202 /* smb_door_client.c */
203 typedef struct smb_joininfo {
204 	char domain_name[MAXHOSTNAMELEN];
205 	char domain_username[BUF_LEN + 1];
206 	char domain_passwd[BUF_LEN + 1];
207 	uint32_t mode;
208 } smb_joininfo_t;
209 
210 /* APIs to communicate with SMB daemon via door calls */
211 extern uint32_t smb_join(smb_joininfo_t *info);
212 extern bool_t xdr_smb_dr_joininfo_t(XDR *, smb_joininfo_t *);
213 
214 
215 #define	SMB_DOMAIN_NOMACHINE_SID	-1
216 #define	SMB_DOMAIN_NODOMAIN_SID		-2
217 
218 extern int nt_domain_init(char *resource_domain, uint32_t secmode);
219 
220 /* Following set of functions, manipulate WINS server configuration */
221 extern int smb_wins_allow_list(char *config_list, char *allow_list);
222 extern int smb_wins_exclude_list(char *config_list, char *exclude_list);
223 extern boolean_t smb_wins_is_excluded(in_addr_t ipaddr,
224     ipaddr_t *exclude_list, int nexclude);
225 extern void smb_wins_build_list(char *buf, uint32_t iplist[], int max_naddr);
226 extern int smb_wins_iplist(char *list, uint32_t iplist[], int max_naddr);
227 
228 /*
229  * Information on a particular domain: the domain name, the
230  * name of a controller (PDC or BDC) and it's ip address.
231  */
232 typedef struct smb_ntdomain {
233 	char domain[SMB_PI_MAX_DOMAIN];
234 	char server[SMB_PI_MAX_DOMAIN];
235 	uint32_t ipaddr;
236 } smb_ntdomain_t;
237 
238 /* SMB domain information management functions */
239 extern smb_ntdomain_t *smb_getdomaininfo(uint32_t timeout);
240 extern void smb_setdomaininfo(char *domain, char *server, uint32_t ipaddr);
241 extern void smb_logdomaininfo(smb_ntdomain_t *di);
242 
243 /*
244  * Following set of function, handle calls to SMB Kernel driver, via
245  * Kernel doors interface.
246  */
247 extern uint64_t smb_dwncall_user_num(void);
248 extern int smb_dwncall_share(int, char *, char *);
249 
250 /*
251  * buffer context structure. This is used to keep track of the buffer
252  * context.
253  *
254  * basep:  points to the beginning of the buffer
255  * curp:   points to the current offset
256  * endp:   points to the limit of the buffer
257  */
258 typedef struct {
259 	unsigned char *basep;
260 	unsigned char *curp;
261 	unsigned char *endp;
262 } smb_ctxbuf_t;
263 
264 extern int smb_ctxbuf_init(smb_ctxbuf_t *ctx, unsigned char *buf,
265     size_t buflen);
266 extern int smb_ctxbuf_len(smb_ctxbuf_t *ctx);
267 extern int smb_ctxbuf_printf(smb_ctxbuf_t *ctx, const char *fmt, ...);
268 
269 /* Functions to handle SMB daemon communications with idmap service */
270 extern int smb_idmap_start(void);
271 extern void smb_idmap_stop(void);
272 extern int smb_idmap_restart(void);
273 
274 /* Miscellaneous functions */
275 extern void hexdump(unsigned char *, int);
276 extern size_t bintohex(const char *, size_t, char *, size_t);
277 extern size_t hextobin(const char *, size_t, char *, size_t);
278 extern char *trim_whitespace(char *buf);
279 extern void randomize(char *, unsigned);
280 extern void rand_hash(unsigned char *, size_t, unsigned char *, size_t);
281 
282 extern int smb_resolve_netbiosname(char *, char *, size_t);
283 extern int smb_resolve_fqdn(char *, char *, size_t);
284 extern int smb_getdomainname(char *, size_t);
285 extern int smb_getfqdomainname(char *, size_t);
286 extern int smb_gethostname(char *, size_t, int);
287 extern int smb_getfqhostname(char *, size_t);
288 extern int smb_getnetbiosname(char *, size_t);
289 extern smb_sid_t *smb_getdomainsid(void);
290 
291 extern int smb_get_nameservers(struct in_addr *, int);
292 extern void smb_tonetbiosname(char *, char *, char);
293 
294 
295 void smb_trace(const char *s);
296 void smb_tracef(const char *fmt, ...);
297 
298 /*
299  * Authentication
300  */
301 
302 #define	SMBAUTH_LM_MAGIC_STR	"KGS!@#$%"
303 
304 #define	SMBAUTH_HASH_SZ		16	/* also LM/NTLM/NTLMv2 Hash size */
305 #define	SMBAUTH_LM_RESP_SZ	24	/* also NTLM Response size */
306 #define	SMBAUTH_LM_PWD_SZ	14	/* LM password size */
307 #define	SMBAUTH_V2_CLNT_CHALLENGE_SZ 8	/* both LMv2 and NTLMv2 */
308 #define	SMBAUTH_SESSION_KEY_SZ	SMBAUTH_HASH_SZ
309 #define	SMBAUTH_HEXHASH_SZ	(SMBAUTH_HASH_SZ * 2)
310 
311 #define	SMBAUTH_FAILURE		1
312 #define	SMBAUTH_SUCCESS		0
313 #define	MD_DIGEST_LEN		16
314 
315 /*
316  * Name Types
317  *
318  * The list of names near the end of the data blob (i.e. the ndb_names
319  * field of the smb_auth_data_blob_t data structure) can be classify into
320  * the following types:
321  *
322  * 0x0000 Indicates the end of the list.
323  * 0x0001 The name is a NetBIOS machine name (e.g. server name)
324  * 0x0002 The name is an NT Domain NetBIOS name.
325  * 0x0003 The name is the server's DNS hostname.
326  * 0x0004 The name is a W2K Domain name (a DNS name).
327  */
328 #define	SMBAUTH_NAME_TYPE_LIST_END		0x0000
329 #define	SMBAUTH_NAME_TYPE_SERVER_NETBIOS 	0x0001
330 #define	SMBAUTH_NAME_TYPE_DOMAIN_NETBIOS 	0x0002
331 #define	SMBAUTH_NAME_TYPE_SERVER_DNS		0x0003
332 #define	SMBAUTH_NAME_TYPE_DOMAIN_DNS 		0x0004
333 
334 /*
335  * smb_auth_name_entry_t
336  *
337  * Each name entry in the data blob consists of the following 3 fields:
338  *
339  * nne_type - name type
340  * nne_len  - the length of the name
341  * nne_name - the name, in uppercase UCS-2LE Unicode format
342  */
343 typedef struct smb_auth_name_entry {
344 	unsigned short nne_type;
345 	unsigned short nne_len;
346 	mts_wchar_t nne_name[SMB_PI_MAX_DOMAIN * 2];
347 } smb_auth_name_entry_t;
348 
349 /*
350  * smb_auth_data_blob
351  *
352  * The format of this NTLMv2 data blob structure is as follow:
353  *
354  *	- Blob Signature 0x01010000 (4 bytes)
355  * - Reserved (0x00000000) (4 bytes)
356  * - Timestamp Little-endian, 64-bit signed value representing
357  *   the number of tenths of a microsecond since January 1, 1601.
358  *   (8 bytes)
359  * - Client Challenge (8 bytes)
360  * - Unknown1 (4 bytes)
361  * - List of Target Information (variable length)
362  * - Unknown2 (4 bytes)
363  */
364 typedef struct smb_auth_data_blob {
365 	unsigned char ndb_signature[4];
366 	unsigned char ndb_reserved[4];
367 	uint64_t ndb_timestamp;
368 	unsigned char ndb_clnt_challenge[SMBAUTH_V2_CLNT_CHALLENGE_SZ];
369 	unsigned char ndb_unknown[4];
370 	smb_auth_name_entry_t ndb_names[2];
371 	unsigned char ndb_unknown2[4];
372 } smb_auth_data_blob_t;
373 
374 #define	SMBAUTH_BLOB_MAXLEN (sizeof (smb_auth_data_blob_t))
375 #define	SMBAUTH_CI_MAXLEN   SMBAUTH_LM_RESP_SZ
376 #define	SMBAUTH_CS_MAXLEN   (SMBAUTH_BLOB_MAXLEN + SMBAUTH_HASH_SZ)
377 
378 /*
379  * smb_auth_info_t
380  *
381  * The structure contains all the authentication information
382  * needed for the preparaton of the SMBSessionSetupAndx request
383  * and the user session key.
384  *
385  * hash      - NTLM hash
386  * hash_v2   - NTLMv2 hash
387  * ci_len    - the length of the case-insensitive password
388  * ci        - case-insensitive password
389  *             (If NTLMv2 authentication mechanism is used, it
390  *              represents the LMv2 response. Otherwise, it
391  *              is empty.)
392  * cs_len    - the length of the case-sensitive password
393  * cs        - case-sensitive password
394  *             (If NTLMv2 authentication mechanism is used, it
395  *              represents the NTLMv2 response. Otherwise, it
396  *              represents the NTLM response.)
397  * data_blob - NTLMv2 data blob
398  */
399 typedef struct smb_auth_info {
400 	unsigned char hash[SMBAUTH_HASH_SZ];
401 	unsigned char hash_v2[SMBAUTH_HASH_SZ];
402 	unsigned short ci_len;
403 	unsigned char ci[SMBAUTH_CI_MAXLEN];
404 	unsigned short cs_len;
405 	unsigned char cs[SMBAUTH_CS_MAXLEN];
406 	int lmcompatibility_lvl;
407 	smb_auth_data_blob_t data_blob;
408 } smb_auth_info_t;
409 
410 /*
411  * SMB password management
412  */
413 
414 #define	SMB_PWF_LM	0x01	/* LM hash is present */
415 #define	SMB_PWF_NT	0x02	/* NT hash is present */
416 #define	SMB_PWF_DISABLE	0x04	/* Account is disabled */
417 
418 typedef struct smb_passwd {
419 	uid_t pw_uid;
420 	uint32_t pw_flags;
421 	unsigned char pw_lmhash[SMBAUTH_HASH_SZ];
422 	unsigned char pw_nthash[SMBAUTH_HASH_SZ];
423 } smb_passwd_t;
424 
425 /*
426  * Control flags passed to smb_pwd_setcntl
427  */
428 #define	SMB_PWC_DISABLE	0x01
429 #define	SMB_PWC_ENABLE	0x02
430 #define	SMB_PWC_NOLM	0x04
431 
432 #define	SMB_PWE_SUCCESS		0
433 #define	SMB_PWE_USER_UNKNOWN	1
434 #define	SMB_PWE_USER_DISABLE	2
435 #define	SMB_PWE_CLOSE_FAILED	3
436 #define	SMB_PWE_OPEN_FAILED	4
437 #define	SMB_PWE_WRITE_FAILED	6
438 #define	SMB_PWE_UPDATE_FAILED	7
439 #define	SMB_PWE_STAT_FAILED	8
440 #define	SMB_PWE_BUSY		9
441 #define	SMB_PWE_DENIED		10
442 #define	SMB_PWE_SYSTEM_ERROR	11
443 #define	SMB_PWE_MAX		12
444 
445 extern void smb_pwd_init(void);
446 extern void smb_pwd_fini(void);
447 extern smb_passwd_t *smb_pwd_getpasswd(const char *, smb_passwd_t *);
448 extern int smb_pwd_setpasswd(const char *, const char *);
449 extern int smb_pwd_setcntl(const char *, int);
450 
451 extern int smb_auth_qnd_unicode(mts_wchar_t *dst, char *src, int length);
452 extern int smb_auth_hmac_md5(unsigned char *data, int data_len,
453     unsigned char *key, int key_len, unsigned char *digest);
454 
455 /*
456  * A variation on HMAC-MD5 known as HMACT64 is used by Windows systems.
457  * The HMACT64() function is the same as the HMAC-MD5() except that
458  * it truncates the input key to 64 bytes rather than hashing it down
459  * to 16 bytes using the MD5() function.
460  */
461 #define	SMBAUTH_HMACT64(D, Ds, K, Ks, digest) \
462 	smb_auth_hmac_md5(D, Ds, K, (Ks > 64) ? 64 : Ks, digest)
463 
464 extern int smb_auth_DES(unsigned char *, int, unsigned char *, int,
465     unsigned char *, int);
466 
467 extern int smb_auth_md4(unsigned char *, unsigned char *, int);
468 extern int smb_auth_lm_hash(char *, unsigned char *);
469 extern int smb_auth_ntlm_hash(char *, unsigned char *);
470 
471 extern int smb_auth_set_info(char *, char *,
472     unsigned char *, char *, unsigned char *,
473     int, int, smb_auth_info_t *);
474 
475 extern int smb_auth_ntlmv2_hash(unsigned char *,
476 	char *, char *, unsigned char *);
477 
478 extern int smb_auth_gen_session_key(smb_auth_info_t *, unsigned char *);
479 
480 boolean_t smb_auth_validate_lm(unsigned char *, uint32_t, smb_passwd_t *,
481     unsigned char *, int, char *, char *);
482 boolean_t smb_auth_validate_nt(unsigned char *, uint32_t, smb_passwd_t *,
483     unsigned char *, int, char *, char *);
484 
485 /*
486  * SMB MAC Signing
487  */
488 
489 #define	SMB_MAC_KEY_SZ	(SMBAUTH_SESSION_KEY_SZ + SMBAUTH_CS_MAXLEN)
490 #define	SMB_SIG_OFFS	14	/* signature field offset within header */
491 #define	SMB_SIG_SIZE	8	/* SMB signature size */
492 
493 /*
494  * Signing flags:
495  *
496  * SMB_SCF_ENABLE                 Signing is enabled.
497  *
498  * SMB_SCF_REQUIRED               Signing is enabled and required.
499  *                                This flag shouldn't be set if
500  *                                SMB_SCF_ENABLE isn't set.
501  *
502  * SMB_SCF_STARTED                Signing will start after receiving
503  *                                the first non-anonymous SessionSetup
504  *                                request.
505  *
506  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
507  *                                been set for this logon. (prior to
508  *                                sending the SMBSessionSetup request)
509  *
510  */
511 #define	SMB_SCF_ENABLE		0x01
512 #define	SMB_SCF_REQUIRED	0x02
513 #define	SMB_SCF_STARTED		0x04
514 #define	SMB_SCF_KEY_ISSET_THIS_LOGON	0x08
515 
516 /*
517  * smb_sign_ctx
518  *
519  * SMB signing context.
520  *
521  *	ssc_seqnum				sequence number
522  *	ssc_keylen				mac key length
523  *	ssc_mid					multiplex id - reserved
524  *	ssc_flags				flags
525  *	ssc_mackey				mac key
526  *	ssc_sign				mac signature
527  *
528  */
529 typedef struct smb_sign_ctx {
530 	unsigned int ssc_seqnum;
531 	unsigned short ssc_keylen;
532 	unsigned short ssc_mid;
533 	unsigned int ssc_flags;
534 	unsigned char ssc_mackey[SMB_MAC_KEY_SZ];
535 	unsigned char ssc_sign[SMB_SIG_SIZE];
536 } smb_sign_ctx_t;
537 
538 extern int smb_mac_init(smb_sign_ctx_t *sign_ctx, smb_auth_info_t *auth);
539 extern int smb_mac_calc(smb_sign_ctx_t *sign_ctx,
540     const unsigned char *buf, size_t buf_len, unsigned char *mac_sign);
541 extern int smb_mac_chk(smb_sign_ctx_t *sign_ctx,
542     const unsigned char *buf, size_t buf_len);
543 extern int smb_mac_sign(smb_sign_ctx_t *sign_ctx,
544     unsigned char *buf, size_t buf_len);
545 extern void smb_mac_inc_seqnum(smb_sign_ctx_t *sign_ctx);
546 extern void smb_mac_dec_seqnum(smb_sign_ctx_t *sign_ctx);
547 
548 /*
549  * Each domain is categorized using the enum values below.
550  * The local domain refers to the local machine and is named
551  * after the local hostname. The primary domain is the domain
552  * that the system joined. All other domains are either
553  * trusted or untrusted, as defined by the primary domain PDC.
554  *
555  * This enum must be kept in step with the table of strings
556  * in ntdomain.c.
557  */
558 typedef enum nt_domain_type {
559 	NT_DOMAIN_NULL,
560 	NT_DOMAIN_BUILTIN,
561 	NT_DOMAIN_LOCAL,
562 	NT_DOMAIN_PRIMARY,
563 	NT_DOMAIN_ACCOUNT,
564 	NT_DOMAIN_TRUSTED,
565 	NT_DOMAIN_UNTRUSTED,
566 	NT_DOMAIN_NUM_TYPES
567 } nt_domain_type_t;
568 
569 
570 /*
571  * This is the information that is held about each domain. The database
572  * is a linked list that is threaded through the domain structures. As
573  * the number of domains in the database should be small (32 max), this
574  * should be sufficient.
575  */
576 typedef struct nt_domain {
577 	struct nt_domain *next;
578 	nt_domain_type_t type;
579 	char *name;
580 	smb_sid_t *sid;
581 } nt_domain_t;
582 
583 nt_domain_t *nt_domain_new(nt_domain_type_t type, char *name, smb_sid_t *sid);
584 void nt_domain_delete(nt_domain_t *domain);
585 nt_domain_t *nt_domain_add(nt_domain_t *new_domain);
586 void nt_domain_remove(nt_domain_t *domain);
587 void nt_domain_flush(nt_domain_type_t domain_type);
588 void nt_domain_sync(void);
589 char *nt_domain_xlat_type(nt_domain_type_t domain_type);
590 nt_domain_type_t nt_domain_xlat_type_name(char *type_name);
591 nt_domain_t *nt_domain_lookup_name(char *domain_name);
592 nt_domain_t *nt_domain_lookup_sid(smb_sid_t *domain_sid);
593 nt_domain_t *nt_domain_lookupbytype(nt_domain_type_t type);
594 smb_sid_t *nt_domain_local_sid(void);
595 
596 typedef enum {
597 	SMB_LGRP_BUILTIN = 1,
598 	SMB_LGRP_LOCAL
599 } smb_gdomain_t;
600 
601 typedef struct smb_gsid {
602 	smb_sid_t *gs_sid;
603 	uint16_t gs_type;
604 } smb_gsid_t;
605 
606 typedef struct smb_giter {
607 	sqlite_vm	*sgi_vm;
608 	sqlite		*sgi_db;
609 } smb_giter_t;
610 
611 typedef struct smb_group {
612 	char			*sg_name;
613 	char			*sg_cmnt;
614 	uint32_t		sg_attr;
615 	uint32_t		sg_rid;
616 	smb_gsid_t		sg_id;
617 	smb_gdomain_t		sg_domain;
618 	smb_privset_t		*sg_privs;
619 	uint32_t		sg_nmembers;
620 	smb_gsid_t		*sg_members;
621 } smb_group_t;
622 
623 int smb_lgrp_start(void);
624 void smb_lgrp_stop(void);
625 int smb_lgrp_add(char *, char *);
626 int smb_lgrp_rename(char *, char *);
627 int smb_lgrp_delete(char *);
628 int smb_lgrp_setcmnt(char *, char *);
629 int smb_lgrp_getcmnt(char *, char **);
630 int smb_lgrp_getpriv(char *, uint8_t, boolean_t *);
631 int smb_lgrp_setpriv(char *, uint8_t, boolean_t);
632 int smb_lgrp_add_member(char *, smb_sid_t *, uint16_t);
633 int smb_lgrp_del_member(char *, smb_sid_t *, uint16_t);
634 int smb_lgrp_getbyname(char *, smb_group_t *);
635 int smb_lgrp_getbyrid(uint32_t, smb_gdomain_t, smb_group_t *);
636 int smb_lgrp_numbydomain(smb_gdomain_t, int *);
637 int smb_lgrp_numbymember(smb_sid_t *, int *);
638 void smb_lgrp_free(smb_group_t *);
639 boolean_t smb_lgrp_is_member(smb_group_t *, smb_sid_t *);
640 char *smb_lgrp_strerror(int);
641 int smb_lgrp_iteropen(smb_giter_t *);
642 void smb_lgrp_iterclose(smb_giter_t *);
643 int smb_lgrp_iterate(smb_giter_t *, smb_group_t *);
644 
645 int smb_lookup_sid(smb_sid_t *, char *buf, int buflen);
646 int smb_lookup_name(char *, smb_gsid_t *);
647 
648 #define	SMB_LGRP_SUCCESS		0
649 #define	SMB_LGRP_INVALID_ARG		1
650 #define	SMB_LGRP_INVALID_MEMBER		2
651 #define	SMB_LGRP_INVALID_NAME		3
652 #define	SMB_LGRP_NOT_FOUND		4
653 #define	SMB_LGRP_EXISTS			5
654 #define	SMB_LGRP_NO_SID			6
655 #define	SMB_LGRP_NO_LOCAL_SID		7
656 #define	SMB_LGRP_SID_NOTLOCAL		8
657 #define	SMB_LGRP_WKSID			9
658 #define	SMB_LGRP_NO_MEMORY		10
659 #define	SMB_LGRP_DB_ERROR		11
660 #define	SMB_LGRP_DBINIT_ERROR		12
661 #define	SMB_LGRP_INTERNAL_ERROR		13
662 #define	SMB_LGRP_MEMBER_IN_GROUP	14
663 #define	SMB_LGRP_MEMBER_NOT_IN_GROUP	15
664 #define	SMB_LGRP_NO_SUCH_PRIV		16
665 #define	SMB_LGRP_NO_SUCH_DOMAIN		17
666 #define	SMB_LGRP_PRIV_HELD		18
667 #define	SMB_LGRP_PRIV_NOT_HELD		19
668 #define	SMB_LGRP_BAD_DATA		20
669 #define	SMB_LGRP_NO_MORE		21
670 #define	SMB_LGRP_DBOPEN_FAILED		22
671 #define	SMB_LGRP_DBEXEC_FAILED		23
672 #define	SMB_LGRP_DBINIT_FAILED		24
673 #define	SMB_LGRP_DOMLKP_FAILED		25
674 #define	SMB_LGRP_DOMINS_FAILED		26
675 #define	SMB_LGRP_INSERT_FAILED		27
676 #define	SMB_LGRP_DELETE_FAILED		28
677 #define	SMB_LGRP_UPDATE_FAILED		29
678 #define	SMB_LGRP_LOOKUP_FAILED		30
679 #define	SMB_LGRP_NOT_SUPPORTED		31
680 
681 #define	SMB_LGRP_NAME_CHAR_MAX	32
682 #define	SMB_LGRP_COMMENT_MAX	256
683 #define	SMB_LGRP_NAME_MAX	(SMB_LGRP_NAME_CHAR_MAX * MTS_MB_CHAR_MAX + 1)
684 
685 /*
686  * values for smb_nic_t.smbflags
687  */
688 #define	SMB_NICF_NBEXCL		0x01	/* Excluded from Netbios activities */
689 #define	SMB_NICF_ALIAS		0x02	/* This is an alias */
690 
691 /*
692  * smb_nic_t
693  *     nic_host		actual host name
694  *     nic_nbname	16-byte NetBIOS host name
695  */
696 typedef struct {
697 	char		nic_host[MAXHOSTNAMELEN];
698 	char		nic_nbname[NETBIOS_NAME_SZ];
699 	char		nic_cmnt[SMB_PI_MAX_COMMENT];
700 	char		nic_ifname[LIFNAMSIZ];
701 	uint32_t	nic_ip;
702 	uint32_t	nic_mask;
703 	uint32_t	nic_bcast;
704 	uint32_t	nic_smbflags;
705 	uint64_t	nic_sysflags;
706 } smb_nic_t;
707 
708 typedef struct smb_niciter {
709 	smb_nic_t ni_nic;
710 	int ni_cookie;
711 	int ni_seqnum;
712 } smb_niciter_t;
713 
714 /* NIC config functions */
715 int smb_nic_init(void);
716 void smb_nic_fini(void);
717 int smb_nic_getnum(char *);
718 int smb_nic_addhost(const char *, const char *, int, const char **);
719 int smb_nic_delhost(const char *);
720 int smb_nic_getfirst(smb_niciter_t *);
721 int smb_nic_getnext(smb_niciter_t *);
722 boolean_t smb_nic_exists(uint32_t, boolean_t);
723 
724 /* NIC Monitoring functions */
725 int smb_nicmon_start(const char *);
726 void smb_nicmon_stop(void);
727 
728 #ifdef	__cplusplus
729 }
730 #endif
731 
732 #endif	/* _LIBSMB_H */
733