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 (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
25  */
26 
27 #ifndef	_LIBSMB_H
28 #define	_LIBSMB_H
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 #include <sys/types.h>
35 #include <sys/list.h>
36 #include <sys/avl.h>
37 #include <arpa/inet.h>
38 #include <net/if.h>	/* LIFNAMSIZ */
39 #include <netdb.h>
40 #include <stdlib.h>
41 #include <libscf.h>
42 #include <libshare.h>
43 #include <uuid/uuid.h>
44 #include <synch.h>
45 #include <stdarg.h>
46 
47 #include <smbsrv/string.h>
48 #include <smbsrv/smb_idmap.h>
49 #include <smbsrv/netbios.h>
50 #include <smbsrv/smb_share.h>
51 #include <smb/nterror.h>
52 #include <smb/ntstatus.h>
53 #include <smbsrv/smb_door.h>
54 #include <smbsrv/alloc.h>
55 #include <smbsrv/hash_table.h>
56 #include <smbsrv/msgbuf.h>
57 #include <smbsrv/wintypes.h>
58 #include <smbsrv/smb_xdr.h>
59 #include <smbsrv/smbinfo.h>
60 #include <smbsrv/ntifs.h>
61 
62 #define	SMB_VARSMB_DIR "/var/smb"
63 #define	SMB_VARRUN_DIR "/var/run/smb"
64 #define	SMB_CCACHE_FILE "ccache"
65 #define	SMB_CCACHE_PATH SMB_VARRUN_DIR "/" SMB_CCACHE_FILE
66 
67 
68 /* Max value length of all SMB properties */
69 #define	MAX_VALUE_BUFLEN	512
70 
71 #define	SMBD_FMRI_PREFIX		"network/smb/server"
72 #define	SMBD_DEFAULT_INSTANCE_FMRI	"svc:/network/smb/server:default"
73 #define	SMBD_PG_NAME			"smbd"
74 #define	SMBD_PROTECTED_PG_NAME		"read"
75 #define	SMBD_EXEC_PG_NAME		"exec"
76 
77 #define	SMBD_SMF_OK		0
78 #define	SMBD_SMF_NO_MEMORY	1	/* no memory for data structures */
79 #define	SMBD_SMF_SYSTEM_ERR	2	/* system error, use errno */
80 #define	SMBD_SMF_NO_PERMISSION	3	/* no permission for operation */
81 #define	SMBD_SMF_INVALID_ARG	4
82 
83 #define	SCH_STATE_UNINIT	0
84 #define	SCH_STATE_INITIALIZING	1
85 #define	SCH_STATE_INIT		2
86 
87 typedef struct smb_scfhandle {
88 	scf_handle_t		*scf_handle;
89 	int			scf_state;
90 	scf_service_t		*scf_service;
91 	scf_scope_t		*scf_scope;
92 	scf_transaction_t	*scf_trans;
93 	scf_transaction_entry_t	*scf_entry;
94 	scf_propertygroup_t	*scf_pg;
95 	scf_instance_t		*scf_instance;
96 	scf_iter_t		*scf_inst_iter;
97 	scf_iter_t		*scf_pg_iter;
98 } smb_scfhandle_t;
99 
100 /*
101  * CIFS Configuration Management
102  */
103 typedef enum {
104 	SMB_CI_VERSION = 0,
105 	SMB_CI_OPLOCK_ENABLE,
106 
107 	SMB_CI_AUTOHOME_MAP,
108 
109 	SMB_CI_DOMAIN_SID,
110 	SMB_CI_DOMAIN_MEMB,
111 	SMB_CI_DOMAIN_NAME,
112 	SMB_CI_DOMAIN_FQDN,
113 	SMB_CI_DOMAIN_FOREST,
114 	SMB_CI_DOMAIN_GUID,
115 	SMB_CI_DOMAIN_SRV,
116 
117 	SMB_CI_WINS_SRV1,
118 	SMB_CI_WINS_SRV2,
119 	SMB_CI_WINS_EXCL,
120 
121 	SMB_CI_MAX_WORKERS,
122 	SMB_CI_MAX_CONNECTIONS,
123 	SMB_CI_KEEPALIVE,
124 	SMB_CI_RESTRICT_ANON,
125 
126 	SMB_CI_SIGNING_ENABLE,
127 	SMB_CI_SIGNING_REQD,
128 
129 	SMB_CI_SYNC_ENABLE,
130 
131 	SMB_CI_SECURITY,
132 	SMB_CI_NETBIOS_ENABLE,
133 	SMB_CI_NBSCOPE,
134 	SMB_CI_SYS_CMNT,
135 	SMB_CI_LM_LEVEL,
136 
137 	SMB_CI_ADS_SITE,
138 
139 	SMB_CI_DYNDNS_ENABLE,
140 
141 	SMB_CI_MACHINE_PASSWD,
142 	SMB_CI_MACHINE_UUID,
143 	SMB_CI_KPASSWD_SRV,
144 	SMB_CI_KPASSWD_DOMAIN,
145 	SMB_CI_KPASSWD_SEQNUM,
146 	SMB_CI_NETLOGON_SEQNUM,
147 	SMB_CI_IPV6_ENABLE,
148 	SMB_CI_PRINT_ENABLE,
149 	SMB_CI_MAP,
150 	SMB_CI_UNMAP,
151 	SMB_CI_DISPOSITION,
152 	SMB_CI_DFS_STDROOT_NUM,
153 	SMB_CI_TRAVERSE_MOUNTS,
154 
155 	SMB_CI_MAX
156 } smb_cfg_id_t;
157 
158 /* SMF helper functions */
159 extern smb_scfhandle_t *smb_smf_scf_init(char *);
160 extern void smb_smf_scf_fini(smb_scfhandle_t *);
161 extern int smb_smf_start_transaction(smb_scfhandle_t *);
162 extern int smb_smf_end_transaction(smb_scfhandle_t *);
163 extern int smb_smf_set_string_property(smb_scfhandle_t *, char *, char *);
164 extern int smb_smf_get_string_property(smb_scfhandle_t *, char *,
165     char *, size_t);
166 extern int smb_smf_set_integer_property(smb_scfhandle_t *, char *, int64_t);
167 extern int smb_smf_get_integer_property(smb_scfhandle_t *, char *, int64_t *);
168 extern int smb_smf_set_boolean_property(smb_scfhandle_t *, char *, uint8_t);
169 extern int smb_smf_get_boolean_property(smb_scfhandle_t *, char *, uint8_t *);
170 extern int smb_smf_set_opaque_property(smb_scfhandle_t *, char *,
171     void *, size_t);
172 extern int smb_smf_get_opaque_property(smb_scfhandle_t *, char *,
173     void *, size_t);
174 extern int smb_smf_create_service_pgroup(smb_scfhandle_t *, char *);
175 extern int smb_smf_restart_service(void);
176 extern int smb_smf_maintenance_mode(void);
177 
178 /* ZFS interface */
179 int smb_getdataset(const char *, char *, size_t);
180 
181 /* Configuration management functions  */
182 extern int smb_config_get(smb_cfg_id_t, char *, int);
183 extern char *smb_config_getname(smb_cfg_id_t);
184 extern int smb_config_getstr(smb_cfg_id_t, char *, int);
185 extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
186 extern boolean_t smb_config_getbool(smb_cfg_id_t);
187 
188 extern int smb_config_set(smb_cfg_id_t, char *);
189 extern int smb_config_setstr(smb_cfg_id_t, char *);
190 extern int smb_config_setnum(smb_cfg_id_t, int64_t);
191 extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
192 
193 extern boolean_t smb_config_get_ads_enable(void);
194 extern int smb_config_get_debug(void);
195 extern uint8_t smb_config_get_fg_flag(void);
196 extern char *smb_config_get_localsid(void);
197 extern int smb_config_get_localuuid(uuid_t);
198 extern int smb_config_secmode_fromstr(char *);
199 extern char *smb_config_secmode_tostr(int);
200 extern int smb_config_get_secmode(void);
201 extern int smb_config_set_secmode(int);
202 extern int smb_config_set_idmap_domain(char *);
203 extern int smb_config_refresh_idmap(void);
204 extern int smb_config_getip(smb_cfg_id_t, smb_inaddr_t *);
205 extern void smb_config_get_version(smb_version_t *);
206 uint32_t smb_config_get_execinfo(char *, char *, size_t);
207 extern void smb_config_get_negtok(uchar_t *, uint32_t *);
208 
209 extern void smb_load_kconfig(smb_kmod_cfg_t *kcfg);
210 extern uint32_t smb_crc_gen(uint8_t *, size_t);
211 
212 extern boolean_t smb_match_netlogon_seqnum(void);
213 extern int smb_setdomainprops(char *, char *, char *);
214 extern void smb_update_netlogon_seqnum(void);
215 
216 /* maximum password length on Windows 2000 and above */
217 #define	SMB_PASSWD_MAXLEN	127
218 #define	SMB_USERNAME_MAXLEN	40
219 
220 typedef struct smb_joininfo {
221 	char domain_name[MAXHOSTNAMELEN];
222 	char domain_username[SMB_USERNAME_MAXLEN + 1];
223 	char domain_passwd[SMB_PASSWD_MAXLEN + 1];
224 	uint32_t mode;
225 } smb_joininfo_t;
226 
227 /* APIs to communicate with SMB daemon via door calls */
228 uint32_t smb_join(smb_joininfo_t *info);
229 bool_t smb_joininfo_xdr(XDR *, smb_joininfo_t *);
230 boolean_t smb_find_ads_server(char *, char *, int);
231 
232 extern void smb_config_getdomaininfo(char *, char *, char *, char *, char *);
233 extern void smb_config_setdomaininfo(char *, char *, char *, char *, char *);
234 extern uint32_t smb_get_dcinfo(char *, uint32_t, smb_inaddr_t *);
235 
236 /*
237  * buffer context structure. This is used to keep track of the buffer
238  * context.
239  *
240  * basep:  points to the beginning of the buffer
241  * curp:   points to the current offset
242  * endp:   points to the limit of the buffer
243  */
244 typedef struct {
245 	unsigned char *basep;
246 	unsigned char *curp;
247 	unsigned char *endp;
248 } smb_ctxbuf_t;
249 
250 extern int smb_ctxbuf_init(smb_ctxbuf_t *ctx, unsigned char *buf,
251     size_t buflen);
252 extern int smb_ctxbuf_len(smb_ctxbuf_t *ctx);
253 extern int smb_ctxbuf_printf(smb_ctxbuf_t *ctx, const char *fmt, ...);
254 
255 void smb_idmap_check(const char *, idmap_stat);
256 
257 /* Miscellaneous functions */
258 extern void hexdump(unsigned char *, int);
259 extern size_t bintohex(const char *, size_t, char *, size_t);
260 extern size_t hextobin(const char *, size_t, char *, size_t);
261 extern char *strstrip(char *, const char *);
262 extern char *strtrim(char *, const char *);
263 extern char *trim_whitespace(char *);
264 extern void randomize(char *, unsigned);
265 extern void rand_hash(unsigned char *, size_t, unsigned char *, size_t);
266 
267 extern int smb_getdomainname(char *, size_t);
268 extern int smb_getfqdomainname(char *, size_t);
269 
270 typedef enum smb_caseconv {
271 	SMB_CASE_PRESERVE = 0,
272 	SMB_CASE_UPPER,
273 	SMB_CASE_LOWER
274 } smb_caseconv_t;
275 
276 extern int smb_gethostname(char *, size_t, smb_caseconv_t);
277 extern int smb_getfqhostname(char *, size_t);
278 extern int smb_getnetbiosname(char *, size_t);
279 extern struct hostent *smb_gethostbyname(const char *, int *);
280 extern struct hostent *smb_gethostbyaddr(const char *, int, int, int *);
281 
282 #define	SMB_SAMACCT_MAXLEN	(NETBIOS_NAME_SZ + 1)
283 extern int smb_getsamaccount(char *, size_t);
284 
285 extern int smb_get_nameservers(smb_inaddr_t *, int);
286 extern void smb_tonetbiosname(char *, char *, char);
287 
288 extern int smb_chk_hostaccess(smb_inaddr_t *, char *);
289 
290 extern int smb_getnameinfo(smb_inaddr_t *, char *, int, int);
291 
292 void smb_trace(const char *s);
293 void smb_tracef(const char *fmt, ...);
294 
295 const char *xlate_nt_status(unsigned int);
296 
297 void libsmb_redirect_syslog(__FILE_TAG *fp, int priority);
298 
299 /*
300  * Authentication
301  */
302 
303 #define	SMBAUTH_LM_MAGIC_STR	"KGS!@#$%"
304 
305 #define	SMBAUTH_HASH_SZ		16	/* also LM/NTLM/NTLMv2 Hash size */
306 #define	SMBAUTH_LM_RESP_SZ	24	/* also NTLM Response size */
307 #define	SMBAUTH_LM_PWD_SZ	14	/* LM password size */
308 #define	SMBAUTH_CHAL_SZ		 8	/* both LMv2 and NTLMv2 */
309 #define	SMBAUTH_SESSION_KEY_SZ	SMBAUTH_HASH_SZ
310 #define	SMBAUTH_HEXHASH_SZ	(SMBAUTH_HASH_SZ * 2)
311 
312 #define	SMBAUTH_FAILURE		1
313 #define	SMBAUTH_SUCCESS		0
314 #define	MD_DIGEST_LEN		16
315 
316 /*
317  * Name Types
318  *
319  * The list of names near the end of the data blob (i.e. the ndb_names
320  * field of the smb_auth_data_blob_t data structure) can be classify into
321  * the following types:
322  *
323  * 0x0000 Indicates the end of the list.
324  * 0x0001 The name is a NetBIOS machine name (e.g. server name)
325  * 0x0002 The name is an NT Domain NetBIOS name.
326  * 0x0003 The name is the server's DNS hostname.
327  * 0x0004 The name is a W2K Domain name (a DNS name).
328  */
329 #define	SMBAUTH_NAME_TYPE_LIST_END		0x0000
330 #define	SMBAUTH_NAME_TYPE_SERVER_NETBIOS 	0x0001
331 #define	SMBAUTH_NAME_TYPE_DOMAIN_NETBIOS 	0x0002
332 #define	SMBAUTH_NAME_TYPE_SERVER_DNS		0x0003
333 #define	SMBAUTH_NAME_TYPE_DOMAIN_DNS 		0x0004
334 
335 /*
336  * smb_auth_name_entry_t
337  *
338  * Each name entry in the data blob consists of the following 3 fields:
339  *
340  * nne_type - name type
341  * nne_len  - the length of the name
342  * nne_name - the name, in uppercase UCS-2LE Unicode format
343  */
344 typedef struct smb_auth_name_entry {
345 	unsigned short nne_type;
346 	unsigned short nne_len;
347 	smb_wchar_t nne_name[SMB_PI_MAX_DOMAIN * 2];
348 } smb_auth_name_entry_t;
349 
350 /*
351  * smb_auth_data_blob
352  *
353  * The format of this NTLMv2 data blob structure is as follow:
354  *
355  *	- Blob Signature 0x01010000 (4 bytes)
356  * - Reserved (0x00000000) (4 bytes)
357  * - Timestamp Little-endian, 64-bit signed value representing
358  *   the number of tenths of a microsecond since January 1, 1601.
359  *   (8 bytes)
360  * - Client Challenge (8 bytes)
361  * - Unknown1 (4 bytes)
362  * - List of Target Information (variable length)
363  * - Unknown2 (4 bytes)
364  */
365 typedef struct smb_auth_data_blob {
366 	unsigned char ndb_signature[4];
367 	unsigned char ndb_reserved[4];
368 	uint64_t ndb_timestamp;
369 	unsigned char ndb_clnt_challenge[SMBAUTH_CHAL_SZ];
370 	unsigned char ndb_unknown[4];
371 	smb_auth_name_entry_t ndb_names[2];
372 	unsigned char ndb_unknown2[4];
373 } smb_auth_data_blob_t;
374 
375 #define	SMBAUTH_BLOB_MAXLEN (sizeof (smb_auth_data_blob_t))
376 #define	SMBAUTH_CI_MAXLEN   SMBAUTH_LM_RESP_SZ
377 #define	SMBAUTH_CS_MAXLEN   (SMBAUTH_BLOB_MAXLEN + SMBAUTH_HASH_SZ)
378 
379 /*
380  * smb_auth_info_t
381  *
382  * The structure contains all the authentication information
383  * needed for the preparaton of the SMBSessionSetupAndx request
384  * and the user session key.
385  *
386  * hash      - NTLM hash
387  * hash_v2   - NTLMv2 hash
388  * ci_len    - the length of the case-insensitive password
389  * ci        - case-insensitive password
390  *             (If NTLMv2 authentication mechanism is used, it
391  *              represents the LMv2 response. Otherwise, it
392  *              is empty.)
393  * cs_len    - the length of the case-sensitive password
394  * cs        - case-sensitive password
395  *             (If NTLMv2 authentication mechanism is used, it
396  *              represents the NTLMv2 response. Otherwise, it
397  *              represents the NTLM response.)
398  * data_blob - NTLMv2 data blob
399  */
400 typedef struct smb_auth_info {
401 	unsigned char hash[SMBAUTH_HASH_SZ];
402 	unsigned char hash_v2[SMBAUTH_HASH_SZ];
403 	unsigned short ci_len;
404 	unsigned char ci[SMBAUTH_CI_MAXLEN];
405 	unsigned short cs_len;
406 	unsigned char cs[SMBAUTH_CS_MAXLEN];
407 	int lmcompatibility_lvl;
408 	smb_auth_data_blob_t data_blob;
409 } smb_auth_info_t;
410 
411 /*
412  * SMB password management
413  */
414 
415 #define	SMB_PWF_LM	0x01	/* LM hash is present */
416 #define	SMB_PWF_NT	0x02	/* NT hash is present */
417 #define	SMB_PWF_DISABLE	0x04	/* Account is disabled */
418 
419 typedef struct smb_passwd {
420 	uid_t		pw_uid;
421 	uint32_t	pw_flags;
422 	char		pw_name[SMB_USERNAME_MAXLEN];
423 	uint8_t		pw_lmhash[SMBAUTH_HASH_SZ];
424 	uint8_t		pw_nthash[SMBAUTH_HASH_SZ];
425 } smb_passwd_t;
426 
427 /*
428  * Control flags passed to smb_pwd_setcntl
429  */
430 #define	SMB_PWC_DISABLE	0x01
431 #define	SMB_PWC_ENABLE	0x02
432 #define	SMB_PWC_NOLM	0x04
433 
434 #define	SMB_PWE_SUCCESS		0
435 #define	SMB_PWE_USER_UNKNOWN	1
436 #define	SMB_PWE_USER_DISABLE	2
437 #define	SMB_PWE_CLOSE_FAILED	3
438 #define	SMB_PWE_OPEN_FAILED	4
439 #define	SMB_PWE_WRITE_FAILED	6
440 #define	SMB_PWE_UPDATE_FAILED	7
441 #define	SMB_PWE_STAT_FAILED	8
442 #define	SMB_PWE_BUSY		9
443 #define	SMB_PWE_DENIED		10
444 #define	SMB_PWE_SYSTEM_ERROR	11
445 #define	SMB_PWE_INVALID_PARAM	12
446 #define	SMB_PWE_NO_MEMORY	13
447 #define	SMB_PWE_MAX		14
448 
449 typedef struct smb_pwditer {
450 	void *spi_next;
451 } smb_pwditer_t;
452 
453 typedef struct smb_luser {
454 	char *su_name;
455 	char *su_fullname;
456 	char *su_desc;
457 	uint32_t su_rid;
458 	uint32_t su_ctrl;
459 } smb_luser_t;
460 
461 extern void smb_pwd_init(boolean_t);
462 extern void smb_pwd_fini(void);
463 extern smb_passwd_t *smb_pwd_getpwnam(const char *, smb_passwd_t *);
464 extern smb_passwd_t *smb_pwd_getpwuid(uid_t, smb_passwd_t *);
465 extern int smb_pwd_setpasswd(const char *, const char *);
466 extern int smb_pwd_setcntl(const char *, int);
467 
468 extern int smb_pwd_iteropen(smb_pwditer_t *);
469 extern smb_luser_t *smb_pwd_iterate(smb_pwditer_t *);
470 extern void smb_pwd_iterclose(smb_pwditer_t *);
471 
472 extern int smb_auth_qnd_unicode(smb_wchar_t *, const char *, int);
473 extern int smb_auth_hmac_md5(unsigned char *, int, unsigned char *, int,
474     unsigned char *);
475 
476 /*
477  * A variation on HMAC-MD5 known as HMACT64 is used by Windows systems.
478  * The HMACT64() function is the same as the HMAC-MD5() except that
479  * it truncates the input key to 64 bytes rather than hashing it down
480  * to 16 bytes using the MD5() function.
481  */
482 #define	SMBAUTH_HMACT64(D, Ds, K, Ks, digest) \
483 	smb_auth_hmac_md5(D, Ds, K, (Ks > 64) ? 64 : Ks, digest)
484 
485 extern int smb_auth_DES(unsigned char *, int, unsigned char *, int,
486     unsigned char *, int);
487 extern int smb_auth_RC4(unsigned char *, int, unsigned char *, int,
488     unsigned char *, int);
489 
490 extern int smb_auth_md4(unsigned char *, unsigned char *, int);
491 extern int smb_auth_lm_hash(const char *, unsigned char *);
492 extern int smb_auth_ntlm_hash(const char *, unsigned char *);
493 extern void smb_auth_ntlm2_mkchallenge(char *, const char *, const char *);
494 extern void smb_auth_ntlm2_kxkey(unsigned char *, const char *, const char *,
495     unsigned char *);
496 
497 extern int smb_auth_set_info(char *, char *,
498     unsigned char *, char *, unsigned char *,
499     int, int, smb_auth_info_t *);
500 
501 extern int smb_auth_ntlmv2_hash(unsigned char *,
502 	char *, char *, unsigned char *);
503 
504 boolean_t smb_auth_validate(smb_passwd_t *, char *, char *,
505     uchar_t *, uint_t, uchar_t *, uint_t, uchar_t *, uint_t, uchar_t *);
506 
507 int smb_gen_random_passwd(char *passwd, size_t bufsz);
508 
509 /*
510  * SMB authenticated IPC
511  */
512 extern void smb_ipc_commit(void);
513 extern void smb_ipc_get_user(char *, size_t);
514 extern void smb_ipc_get_passwd(uint8_t *, size_t);
515 extern void smb_ipc_init(void);
516 extern void smb_ipc_rollback(void);
517 extern void smb_ipc_set(char *, uint8_t *);
518 
519 /*
520  * Signing flags:
521  *
522  * SMB_SCF_ENABLE                 Signing is enabled.
523  *
524  * SMB_SCF_REQUIRED               Signing is enabled and required.
525  *                                This flag shouldn't be set if
526  *                                SMB_SCF_ENABLE isn't set.
527  *
528  * SMB_SCF_STARTED                Signing will start after receiving
529  *                                the first non-anonymous SessionSetup
530  *                                request.
531  *
532  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
533  *                                been set for this logon. (prior to
534  *                                sending the SMBSessionSetup request)
535  *
536  */
537 #define	SMB_SCF_ENABLE		0x01
538 #define	SMB_SCF_REQUIRED	0x02
539 #define	SMB_SCF_STARTED		0x04
540 #define	SMB_SCF_KEY_ISSET_THIS_LOGON	0x08
541 
542 /*
543  * Each domain is categorized using the enum values below.
544  * The local domain refers to the local machine and is named
545  * after the local hostname. The primary domain is the domain
546  * that the system joined. All other domains are either
547  * trusted or untrusted, as defined by the primary domain PDC.
548  */
549 typedef enum smb_domain_type {
550 	SMB_DOMAIN_NULL,
551 	SMB_DOMAIN_BUILTIN,
552 	SMB_DOMAIN_LOCAL,
553 	SMB_DOMAIN_PRIMARY,
554 	SMB_DOMAIN_ACCOUNT,
555 	SMB_DOMAIN_TRUSTED,
556 	SMB_DOMAIN_UNTRUSTED,
557 	SMB_DOMAIN_NUM_TYPES
558 } smb_domain_type_t;
559 
560 /*
561  * Information specific to trusted domains
562  */
563 typedef struct smb_domain_trust {
564 	uint32_t		dti_trust_direction;
565 	uint32_t		dti_trust_type;
566 	uint32_t		dti_trust_attrs;
567 } smb_domain_trust_t;
568 
569 /*
570  * DNS information for domain types that this info is
571  * obtained/available. Currently this is only obtained
572  * for the primary domain.
573  */
574 typedef struct smb_domain_dns {
575 	char			ddi_forest[MAXHOSTNAMELEN];
576 	char			ddi_guid[UUID_PRINTABLE_STRING_LENGTH];
577 } smb_domain_dns_t;
578 
579 /*
580  * This is the information that is held about each domain.
581  */
582 typedef struct smb_domain {
583 	list_node_t		di_lnd;
584 	smb_domain_type_t	di_type;
585 	char			di_sid[SMB_SID_STRSZ];
586 	char			di_nbname[NETBIOS_NAME_SZ];
587 	char			di_fqname[MAXHOSTNAMELEN];
588 	smb_sid_t		*di_binsid;
589 	union {
590 		smb_domain_dns_t	di_dns;
591 		smb_domain_trust_t	di_trust;
592 	} di_u;
593 } smb_domain_t;
594 
595 typedef struct smb_trusted_domains {
596 	uint32_t	td_num;
597 	smb_domain_t	*td_domains;
598 } smb_trusted_domains_t;
599 
600 #define	SMB_DOMAIN_SUCCESS		0
601 #define	SMB_DOMAIN_NOMACHINE_SID	1
602 #define	SMB_DOMAIN_NODOMAIN_SID		2
603 #define	SMB_DOMAIN_NODOMAIN_NAME	3
604 #define	SMB_DOMAIN_INTERNAL_ERR		4
605 #define	SMB_DOMAIN_INVALID_ARG		5
606 #define	SMB_DOMAIN_NO_MEMORY		6
607 #define	SMB_DOMAIN_NO_CACHE		7
608 
609 /*
610  * This structure could contain information about
611  * the primary domain the name of selected domain controller
612  * for the primary domain and a list of trusted domains if
613  * any. The "ex" in the structure name stands for extended.
614  * This is to differentiate this structure from smb_domain_t
615  * which only contains information about a single domain.
616  */
617 typedef struct smb_domainex {
618 	char			d_dc[MAXHOSTNAMELEN];
619 	smb_domain_t		d_primary;
620 	smb_trusted_domains_t	d_trusted;
621 } smb_domainex_t;
622 
623 int smb_domain_init(uint32_t);
624 void smb_domain_fini(void);
625 void smb_domain_show(void);
626 void smb_domain_save(void);
627 boolean_t smb_domain_lookup_name(char *, smb_domain_t *);
628 boolean_t smb_domain_lookup_sid(smb_sid_t *, smb_domain_t *);
629 boolean_t smb_domain_lookup_type(smb_domain_type_t, smb_domain_t *);
630 boolean_t smb_domain_getinfo(smb_domainex_t *);
631 void smb_domain_update(smb_domainex_t *);
632 uint32_t smb_domain_start_update(void);
633 void smb_domain_end_update(void);
634 void smb_domain_set_basic_info(char *, char *, char *, smb_domain_t *);
635 void smb_domain_set_dns_info(char *, char *, char *, char *, char *,
636     smb_domain_t *);
637 void smb_domain_set_trust_info(char *, char *, char *,
638     uint32_t, uint32_t, uint32_t, smb_domain_t *);
639 void smb_domain_current_dc(char *buf, size_t len);
640 
641 typedef struct smb_gsid {
642 	smb_sid_t *gs_sid;
643 	uint16_t gs_type;
644 } smb_gsid_t;
645 
646 struct sqlite_vm;
647 struct sqlite;
648 
649 typedef struct smb_giter {
650 	struct sqlite_vm	*sgi_vm;
651 	struct sqlite		*sgi_db;
652 	uint32_t		sgi_nerr;
653 } smb_giter_t;
654 
655 typedef struct smb_group {
656 	char			*sg_name;
657 	char			*sg_cmnt;
658 	uint32_t		sg_attr;
659 	uint32_t		sg_rid;
660 	smb_gsid_t		sg_id;
661 	smb_domain_type_t	sg_domain;
662 	smb_privset_t		*sg_privs;
663 	uint32_t		sg_nmembers;
664 	smb_gsid_t		*sg_members;
665 } smb_group_t;
666 
667 int smb_lgrp_start(void);
668 void smb_lgrp_stop(void);
669 int smb_lgrp_add(char *, char *);
670 int smb_lgrp_rename(char *, char *);
671 int smb_lgrp_delete(char *);
672 int smb_lgrp_setcmnt(char *, char *);
673 int smb_lgrp_getcmnt(char *, char **);
674 int smb_lgrp_getpriv(char *, uint8_t, boolean_t *);
675 int smb_lgrp_setpriv(char *, uint8_t, boolean_t);
676 int smb_lgrp_add_member(char *, smb_sid_t *, uint16_t);
677 int smb_lgrp_del_member(char *, smb_sid_t *, uint16_t);
678 int smb_lgrp_getbyname(char *, smb_group_t *);
679 int smb_lgrp_getbyrid(uint32_t, smb_domain_type_t, smb_group_t *);
680 void smb_lgrp_free(smb_group_t *);
681 uint32_t smb_lgrp_err_to_ntstatus(uint32_t);
682 boolean_t smb_lgrp_is_member(smb_group_t *, smb_sid_t *);
683 char *smb_lgrp_strerror(int);
684 int smb_lgrp_iteropen(smb_giter_t *);
685 void smb_lgrp_iterclose(smb_giter_t *);
686 boolean_t smb_lgrp_itererror(smb_giter_t *);
687 int smb_lgrp_iterate(smb_giter_t *, smb_group_t *);
688 
689 int smb_lookup_sid(const char *, lsa_account_t *);
690 int smb_lookup_name(const char *, sid_type_t, lsa_account_t *);
691 
692 #define	SMB_LGRP_SUCCESS		0
693 #define	SMB_LGRP_INVALID_ARG		1
694 #define	SMB_LGRP_INVALID_MEMBER		2
695 #define	SMB_LGRP_INVALID_NAME		3
696 #define	SMB_LGRP_NOT_FOUND		4
697 #define	SMB_LGRP_EXISTS			5
698 #define	SMB_LGRP_NO_SID			6
699 #define	SMB_LGRP_NO_LOCAL_SID		7
700 #define	SMB_LGRP_SID_NOTLOCAL		8
701 #define	SMB_LGRP_WKSID			9
702 #define	SMB_LGRP_NO_MEMORY		10
703 #define	SMB_LGRP_DB_ERROR		11
704 #define	SMB_LGRP_DBINIT_ERROR		12
705 #define	SMB_LGRP_INTERNAL_ERROR		13
706 #define	SMB_LGRP_MEMBER_IN_GROUP	14
707 #define	SMB_LGRP_MEMBER_NOT_IN_GROUP	15
708 #define	SMB_LGRP_NO_SUCH_PRIV		16
709 #define	SMB_LGRP_NO_SUCH_DOMAIN		17
710 #define	SMB_LGRP_PRIV_HELD		18
711 #define	SMB_LGRP_PRIV_NOT_HELD		19
712 #define	SMB_LGRP_BAD_DATA		20
713 #define	SMB_LGRP_NO_MORE		21
714 #define	SMB_LGRP_DBOPEN_FAILED		22
715 #define	SMB_LGRP_DBEXEC_FAILED		23
716 #define	SMB_LGRP_DBINIT_FAILED		24
717 #define	SMB_LGRP_DOMLKP_FAILED		25
718 #define	SMB_LGRP_DOMINS_FAILED		26
719 #define	SMB_LGRP_INSERT_FAILED		27
720 #define	SMB_LGRP_DELETE_FAILED		28
721 #define	SMB_LGRP_UPDATE_FAILED		29
722 #define	SMB_LGRP_LOOKUP_FAILED		30
723 #define	SMB_LGRP_NOT_SUPPORTED		31
724 #define	SMB_LGRP_OFFLINE		32
725 #define	SMB_LGRP_POSIXCREATE_FAILED	33
726 
727 #define	SMB_LGRP_COMMENT_MAX	256
728 
729 /*
730  * values for smb_nic_t.smbflags
731  */
732 #define	SMB_NICF_NBEXCL		0x01	/* Excluded from Netbios activities */
733 #define	SMB_NICF_ALIAS		0x02	/* This is an alias */
734 
735 /*
736  * smb_nic_t
737  *     nic_host		actual host name
738  *     nic_nbname	16-byte NetBIOS host name
739  */
740 typedef struct {
741 	char		nic_host[MAXHOSTNAMELEN];
742 	char		nic_nbname[NETBIOS_NAME_SZ];
743 	char		nic_cmnt[SMB_PI_MAX_COMMENT];
744 	char		nic_ifname[LIFNAMSIZ];
745 	smb_inaddr_t	nic_ip;
746 	uint32_t	nic_mask;
747 	uint32_t	nic_bcast;
748 	uint32_t	nic_smbflags;
749 	uint64_t	nic_sysflags;
750 } smb_nic_t;
751 
752 typedef struct smb_niciter {
753 	smb_nic_t ni_nic;
754 	int ni_cookie;
755 	int ni_seqnum;
756 } smb_niciter_t;
757 
758 /* NIC config functions */
759 int smb_nic_init(void);
760 void smb_nic_fini(void);
761 int smb_nic_getnum(char *);
762 int smb_nic_addhost(const char *, const char *, int, const char **);
763 int smb_nic_delhost(const char *);
764 int smb_nic_getfirst(smb_niciter_t *);
765 int smb_nic_getnext(smb_niciter_t *);
766 boolean_t smb_nic_is_local(smb_inaddr_t *);
767 boolean_t smb_nic_is_same_subnet(smb_inaddr_t *);
768 
769 #define	SMB_NIC_SUCCESS			0
770 #define	SMB_NIC_INVALID_ARG		1
771 #define	SMB_NIC_NOT_FOUND		2
772 #define	SMB_NIC_NO_HOST			3
773 #define	SMB_NIC_NO_MEMORY		4
774 #define	SMB_NIC_DB_ERROR		5
775 #define	SMB_NIC_DBINIT_ERROR		6
776 #define	SMB_NIC_BAD_DATA		7
777 #define	SMB_NIC_NO_MORE			8
778 #define	SMB_NIC_DBOPEN_FAILED		9
779 #define	SMB_NIC_DBEXEC_FAILED		10
780 #define	SMB_NIC_DBINIT_FAILED		11
781 #define	SMB_NIC_INSERT_FAILED		12
782 #define	SMB_NIC_DELETE_FAILED		13
783 #define	SMB_NIC_SOCK			14
784 #define	SMB_NIC_IOCTL			15
785 #define	SMB_NIC_CHANGED			16
786 
787 /*
788  * Well-known account structure
789  *
790  * A security identifier (SID) is a unique value of variable length that
791  * is used to identify a security principal or security group in
792  * Windows. Well-known SIDs are a group of SIDs that identify generic
793  * users or generic groups. Their values remain constant across all
794  * operating systems.
795  *
796  * This structure is defined to store these SIDs and other related
797  * information about them (e.g. account and domain names) in a
798  * predefined table.
799  */
800 typedef struct smb_wka {
801 	uint8_t		wka_domidx;
802 	char		*wka_sid;
803 	char		*wka_name;
804 	uint16_t	wka_type;
805 	uint16_t	wka_flags;
806 	char		*wka_desc;
807 	smb_sid_t	*wka_binsid;
808 } smb_wka_t;
809 
810 /*
811  * Defined values for smb_wka.wka_flags
812  *
813  * SMB_WKAFLG_LGRP_ENABLE		Can be added as local group
814  */
815 #define	SMB_WKAFLG_LGRP_ENABLE	0x1
816 
817 /*
818  * Well-known account interfaces
819  */
820 smb_wka_t *smb_wka_lookup_builtin(const char *);
821 smb_wka_t *smb_wka_lookup_name(const char *);
822 smb_wka_t *smb_wka_lookup_sid(smb_sid_t *);
823 smb_sid_t *smb_wka_get_sid(const char *);
824 char *smb_wka_get_domain(int);
825 uint32_t smb_wka_token_groups(uint32_t, smb_ids_t *);
826 
827 /*
828  * In memory account representation
829  */
830 typedef struct smb_account {
831 	char		*a_name;
832 	char		*a_domain;
833 	uint16_t	a_type;
834 	smb_sid_t	*a_sid;
835 	smb_sid_t	*a_domsid;
836 	uint32_t	a_rid;
837 } smb_account_t;
838 
839 uint32_t smb_sam_lookup_name(char *, char *, uint16_t, smb_account_t *);
840 uint32_t smb_sam_lookup_sid(smb_sid_t *, smb_account_t *);
841 int smb_sam_usr_cnt(void);
842 uint32_t smb_sam_usr_groups(smb_sid_t *, smb_ids_t *);
843 int smb_sam_grp_cnt(smb_domain_type_t);
844 void smb_account_free(smb_account_t *);
845 boolean_t smb_account_validate(smb_account_t *);
846 
847 /*
848  * Security Descriptor functions.
849  */
850 uint32_t smb_sd_read(char *path, smb_sd_t *, uint32_t);
851 uint32_t smb_sd_write(char *path, smb_sd_t *, uint32_t);
852 uint32_t smb_sd_fromfs(smb_fssd_t *, smb_sd_t *);
853 
854 /* Kernel Module Interface */
855 int smb_kmod_bind(void);
856 boolean_t smb_kmod_isbound(void);
857 int smb_kmod_setcfg(smb_kmod_cfg_t *);
858 int smb_kmod_setgmtoff(int32_t);
859 int smb_kmod_start(int, int, int);
860 void smb_kmod_stop(void);
861 int smb_kmod_event_notify(uint32_t);
862 void smb_kmod_unbind(void);
863 int smb_kmod_share(nvlist_t *);
864 int smb_kmod_unshare(nvlist_t *);
865 int smb_kmod_shareinfo(char *, boolean_t *);
866 int smb_kmod_get_open_num(smb_opennum_t *);
867 int smb_kmod_enum(smb_netsvc_t *);
868 smb_netsvc_t *smb_kmod_enum_init(smb_svcenum_t *);
869 void smb_kmod_enum_fini(smb_netsvc_t *);
870 int smb_kmod_session_close(const char *, const char *);
871 int smb_kmod_file_close(uint32_t);
872 int smb_kmod_get_spool_doc(uint32_t *, char *, char *, smb_inaddr_t *);
873 
874 void smb_name_parse(char *, char **, char **);
875 uint32_t smb_name_validate_share(const char *);
876 uint32_t smb_name_validate_account(const char *);
877 uint32_t smb_name_validate_domain(const char *);
878 uint32_t smb_name_validate_nbdomain(const char *);
879 uint32_t smb_name_validate_workgroup(const char *);
880 uint32_t smb_name_validate_rpath(const char *);
881 
882 /*
883  * Interposer library validation
884  */
885 #define	SMBEX_VERSION	1
886 #define	SMBEX_KEY	"82273fdc-e32a-18c3-3f78-827929dc23ea"
887 typedef struct smbex_version {
888 	uint32_t v_version;
889 	uuid_t v_uuid;
890 } smbex_version_t;
891 void *smb_dlopen(void);
892 void smb_dlclose(void *);
893 
894 /*
895  * General purpose multi-thread safe cache based on
896  * AVL tree
897  */
898 typedef struct smb_cache {
899 	avl_tree_t	ch_cache;
900 	rwlock_t	ch_cache_lck;
901 	uint32_t	ch_state;
902 	uint32_t	ch_nops;
903 	uint32_t	ch_wait;
904 	uint32_t	ch_sequence;
905 	size_t		ch_datasz;
906 	mutex_t		ch_mtx;
907 	cond_t		ch_cv;
908 	void		(*ch_free)(void *);
909 	void		(*ch_copy)(const void *, void *, size_t);
910 } smb_cache_t;
911 
912 typedef struct smb_cache_node {
913 	avl_node_t	cn_link;
914 	void		*cn_data;
915 } smb_cache_node_t;
916 
917 typedef struct smb_cache_cursor {
918 	void		*cc_next;
919 	uint32_t	cc_sequence;
920 } smb_cache_cursor_t;
921 
922 /*
923  * flags used with smb_cache_add()
924  *
925  * SMB_CACHE_ADD	If object doesn't exist add, otherwise fail
926  * SMB_CACHE_REPLACE	If object doesn't exist add, otherwise replace
927  */
928 #define	SMB_CACHE_ADD		1
929 #define	SMB_CACHE_REPLACE	2
930 
931 void smb_cache_create(smb_cache_t *, uint32_t,
932     int (*cmpfn) (const void *, const void *), void (*freefn)(void *),
933     void (*copyfn)(const void *, void *, size_t), size_t);
934 void smb_cache_destroy(smb_cache_t *);
935 void smb_cache_flush(smb_cache_t *);
936 uint32_t smb_cache_num(smb_cache_t *);
937 int smb_cache_refreshing(smb_cache_t *);
938 void smb_cache_ready(smb_cache_t *);
939 int smb_cache_add(smb_cache_t *, const void *, int);
940 void smb_cache_remove(smb_cache_t *, const void *);
941 void smb_cache_iterinit(smb_cache_t *, smb_cache_cursor_t *);
942 boolean_t smb_cache_iterate(smb_cache_t *, smb_cache_cursor_t *, void *);
943 
944 /*
945  * Values returned by smb_reparse_stat()
946  */
947 #define	SMB_REPARSE_NOTFOUND	1	/* object does not exist */
948 #define	SMB_REPARSE_NOTREPARSE	2	/* object is NOT a reparse point */
949 #define	SMB_REPARSE_ISREPARSE	3	/* object is a reparse point */
950 
951 /*
952  * Reparse Point API
953  */
954 int smb_reparse_stat(const char *, uint32_t *);
955 int smb_reparse_svcadd(const char *, const char *, const char *);
956 int smb_reparse_svcdel(const char *, const char *);
957 int smb_reparse_svcget(const char *, const char *, char **);
958 
959 uint32_t smb_get_txid(void);
960 
961 void smb_syslog(int, const char *, ...);
962 void smb_vsyslog(int, const char *, va_list ap);
963 char *smb_syslog_fmt_m(char *, int, const char *, int);
964 
965 #ifdef	__cplusplus
966 }
967 #endif
968 
969 #endif	/* _LIBSMB_H */
970