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