xref: /titanic_41/usr/src/lib/smbsrv/libsmb/common/libsmb.h (revision 9149877b124dd1e992eeea9c1f34e3fd78abd4af)
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 2011 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 <sqlite/sqlite.h>
46 #include <uuid/uuid.h>
47 #include <synch.h>
48 
49 #include <smbsrv/string.h>
50 #include <smbsrv/smb_idmap.h>
51 #include <smbsrv/netbios.h>
52 #include <smbsrv/smb_share.h>
53 #include <smb/nterror.h>
54 #include <smb/ntstatus.h>
55 #include <smbsrv/smb_door.h>
56 #include <smbsrv/alloc.h>
57 #include <smbsrv/hash_table.h>
58 #include <smbsrv/msgbuf.h>
59 #include <smbsrv/wintypes.h>
60 #include <smbsrv/smb_xdr.h>
61 #include <smbsrv/smbinfo.h>
62 #include <smbsrv/ntifs.h>
63 
64 #define	SMB_VARSMB_DIR "/var/smb"
65 #define	SMB_VARRUN_DIR "/var/run/smb"
66 #define	SMB_CCACHE_FILE "ccache"
67 #define	SMB_CCACHE_PATH SMB_VARRUN_DIR "/" SMB_CCACHE_FILE
68 
69 
70 /* Max value length of all SMB properties */
71 #define	MAX_VALUE_BUFLEN	512
72 
73 #define	SMBD_FMRI_PREFIX		"network/smb/server"
74 #define	SMBD_DEFAULT_INSTANCE_FMRI	"svc:/network/smb/server:default"
75 #define	SMBD_PG_NAME			"smbd"
76 #define	SMBD_PROTECTED_PG_NAME		"read"
77 #define	SMBD_EXEC_PG_NAME		"exec"
78 
79 #define	SMBD_SMF_OK		0
80 #define	SMBD_SMF_NO_MEMORY	1	/* no memory for data structures */
81 #define	SMBD_SMF_SYSTEM_ERR	2	/* system error, use errno */
82 #define	SMBD_SMF_NO_PERMISSION	3	/* no permission for operation */
83 #define	SMBD_SMF_INVALID_ARG	4
84 
85 #define	SCH_STATE_UNINIT	0
86 #define	SCH_STATE_INITIALIZING	1
87 #define	SCH_STATE_INIT		2
88 
89 typedef struct smb_scfhandle {
90 	scf_handle_t		*scf_handle;
91 	int			scf_state;
92 	scf_service_t		*scf_service;
93 	scf_scope_t		*scf_scope;
94 	scf_transaction_t	*scf_trans;
95 	scf_transaction_entry_t	*scf_entry;
96 	scf_propertygroup_t	*scf_pg;
97 	scf_instance_t		*scf_instance;
98 	scf_iter_t		*scf_inst_iter;
99 	scf_iter_t		*scf_pg_iter;
100 } smb_scfhandle_t;
101 
102 /*
103  * CIFS Configuration Management
104  */
105 typedef enum {
106 	SMB_CI_VERSION = 0,
107 	SMB_CI_OPLOCK_ENABLE,
108 
109 	SMB_CI_AUTOHOME_MAP,
110 
111 	SMB_CI_DOMAIN_SID,
112 	SMB_CI_DOMAIN_MEMB,
113 	SMB_CI_DOMAIN_NAME,
114 	SMB_CI_DOMAIN_FQDN,
115 	SMB_CI_DOMAIN_FOREST,
116 	SMB_CI_DOMAIN_GUID,
117 	SMB_CI_DOMAIN_SRV,
118 
119 	SMB_CI_WINS_SRV1,
120 	SMB_CI_WINS_SRV2,
121 	SMB_CI_WINS_EXCL,
122 
123 	SMB_CI_MAX_WORKERS,
124 	SMB_CI_MAX_CONNECTIONS,
125 	SMB_CI_KEEPALIVE,
126 	SMB_CI_RESTRICT_ANON,
127 
128 	SMB_CI_SIGNING_ENABLE,
129 	SMB_CI_SIGNING_REQD,
130 
131 	SMB_CI_SYNC_ENABLE,
132 
133 	SMB_CI_SECURITY,
134 	SMB_CI_NBSCOPE,
135 	SMB_CI_SYS_CMNT,
136 	SMB_CI_LM_LEVEL,
137 
138 	SMB_CI_ADS_SITE,
139 
140 	SMB_CI_DYNDNS_ENABLE,
141 
142 	SMB_CI_MACHINE_PASSWD,
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 	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 extern int smb_smf_restart_service(void);
175 extern int smb_smf_maintenance_mode(void);
176 
177 /* ZFS interface */
178 int smb_getdataset(const char *, char *, size_t);
179 
180 /* Configuration management functions  */
181 extern int smb_config_get(smb_cfg_id_t, char *, int);
182 extern char *smb_config_getname(smb_cfg_id_t);
183 extern int smb_config_getstr(smb_cfg_id_t, char *, int);
184 extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
185 extern boolean_t smb_config_getbool(smb_cfg_id_t);
186 
187 extern int smb_config_set(smb_cfg_id_t, char *);
188 extern int smb_config_setstr(smb_cfg_id_t, char *);
189 extern int smb_config_setnum(smb_cfg_id_t, int64_t);
190 extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
191 
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 
482 extern int smb_auth_md4(unsigned char *, unsigned char *, int);
483 extern int smb_auth_lm_hash(const char *, unsigned char *);
484 extern int smb_auth_ntlm_hash(const char *, unsigned char *);
485 
486 extern int smb_auth_set_info(char *, char *,
487     unsigned char *, char *, unsigned char *,
488     int, int, smb_auth_info_t *);
489 
490 extern int smb_auth_ntlmv2_hash(unsigned char *,
491 	char *, char *, unsigned char *);
492 
493 extern int smb_auth_gen_session_key(smb_auth_info_t *, unsigned char *);
494 
495 boolean_t smb_auth_validate_lm(unsigned char *, uint32_t, smb_passwd_t *,
496     unsigned char *, int, char *, char *);
497 boolean_t smb_auth_validate_nt(unsigned char *, uint32_t, smb_passwd_t *,
498     unsigned char *, int, char *, char *, uchar_t *);
499 
500 /*
501  * SMB authenticated IPC
502  */
503 extern void smb_ipc_commit(void);
504 extern void smb_ipc_get_user(char *, size_t);
505 extern void smb_ipc_get_passwd(uint8_t *, size_t);
506 extern void smb_ipc_init(void);
507 extern void smb_ipc_rollback(void);
508 extern void smb_ipc_set(char *, uint8_t *);
509 
510 /*
511  * SMB MAC Signing
512  */
513 
514 #define	SMB_MAC_KEY_SZ	(SMBAUTH_SESSION_KEY_SZ + SMBAUTH_CS_MAXLEN)
515 #define	SMB_SIG_OFFS	14	/* signature field offset within header */
516 #define	SMB_SIG_SIZE	8	/* SMB signature size */
517 
518 /*
519  * Signing flags:
520  *
521  * SMB_SCF_ENABLE                 Signing is enabled.
522  *
523  * SMB_SCF_REQUIRED               Signing is enabled and required.
524  *                                This flag shouldn't be set if
525  *                                SMB_SCF_ENABLE isn't set.
526  *
527  * SMB_SCF_STARTED                Signing will start after receiving
528  *                                the first non-anonymous SessionSetup
529  *                                request.
530  *
531  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
532  *                                been set for this logon. (prior to
533  *                                sending the SMBSessionSetup request)
534  *
535  */
536 #define	SMB_SCF_ENABLE		0x01
537 #define	SMB_SCF_REQUIRED	0x02
538 #define	SMB_SCF_STARTED		0x04
539 #define	SMB_SCF_KEY_ISSET_THIS_LOGON	0x08
540 
541 /*
542  * smb_sign_ctx
543  *
544  * SMB signing context.
545  *
546  *	ssc_seqnum				sequence number
547  *	ssc_keylen				mac key length
548  *	ssc_mid					multiplex id - reserved
549  *	ssc_flags				flags
550  *	ssc_mackey				mac key
551  *	ssc_sign				mac signature
552  *
553  */
554 typedef struct smb_sign_ctx {
555 	unsigned int ssc_seqnum;
556 	unsigned short ssc_keylen;
557 	unsigned short ssc_mid;
558 	unsigned int ssc_flags;
559 	unsigned char ssc_mackey[SMB_MAC_KEY_SZ];
560 	unsigned char ssc_sign[SMB_SIG_SIZE];
561 } smb_sign_ctx_t;
562 
563 extern int smb_mac_init(smb_sign_ctx_t *sign_ctx, smb_auth_info_t *auth);
564 extern int smb_mac_calc(smb_sign_ctx_t *sign_ctx,
565     const unsigned char *buf, size_t buf_len, unsigned char *mac_sign);
566 extern int smb_mac_chk(smb_sign_ctx_t *sign_ctx,
567     const unsigned char *buf, size_t buf_len);
568 extern int smb_mac_sign(smb_sign_ctx_t *sign_ctx,
569     unsigned char *buf, size_t buf_len);
570 extern void smb_mac_inc_seqnum(smb_sign_ctx_t *sign_ctx);
571 extern void smb_mac_dec_seqnum(smb_sign_ctx_t *sign_ctx);
572 
573 /*
574  * Each domain is categorized using the enum values below.
575  * The local domain refers to the local machine and is named
576  * after the local hostname. The primary domain is the domain
577  * that the system joined. All other domains are either
578  * trusted or untrusted, as defined by the primary domain PDC.
579  */
580 typedef enum smb_domain_type {
581 	SMB_DOMAIN_NULL,
582 	SMB_DOMAIN_BUILTIN,
583 	SMB_DOMAIN_LOCAL,
584 	SMB_DOMAIN_PRIMARY,
585 	SMB_DOMAIN_ACCOUNT,
586 	SMB_DOMAIN_TRUSTED,
587 	SMB_DOMAIN_UNTRUSTED,
588 	SMB_DOMAIN_NUM_TYPES
589 } smb_domain_type_t;
590 
591 /*
592  * Information specific to trusted domains
593  */
594 typedef struct smb_domain_trust {
595 	uint32_t		dti_trust_direction;
596 	uint32_t		dti_trust_type;
597 	uint32_t		dti_trust_attrs;
598 } smb_domain_trust_t;
599 
600 /*
601  * DNS information for domain types that this info is
602  * obtained/available. Currently this is only obtained
603  * for the primary domain.
604  */
605 typedef struct smb_domain_dns {
606 	char			ddi_forest[MAXHOSTNAMELEN];
607 	char			ddi_guid[UUID_PRINTABLE_STRING_LENGTH];
608 } smb_domain_dns_t;
609 
610 /*
611  * This is the information that is held about each domain.
612  */
613 typedef struct smb_domain {
614 	list_node_t		di_lnd;
615 	smb_domain_type_t	di_type;
616 	char			di_sid[SMB_SID_STRSZ];
617 	char			di_nbname[NETBIOS_NAME_SZ];
618 	char			di_fqname[MAXHOSTNAMELEN];
619 	smb_sid_t		*di_binsid;
620 	union {
621 		smb_domain_dns_t	di_dns;
622 		smb_domain_trust_t	di_trust;
623 	} di_u;
624 } smb_domain_t;
625 
626 typedef struct smb_trusted_domains {
627 	uint32_t	td_num;
628 	smb_domain_t	*td_domains;
629 } smb_trusted_domains_t;
630 
631 #define	SMB_DOMAIN_SUCCESS		0
632 #define	SMB_DOMAIN_NOMACHINE_SID	1
633 #define	SMB_DOMAIN_NODOMAIN_SID		2
634 #define	SMB_DOMAIN_NODOMAIN_NAME	3
635 #define	SMB_DOMAIN_INTERNAL_ERR		4
636 #define	SMB_DOMAIN_INVALID_ARG		5
637 #define	SMB_DOMAIN_NO_MEMORY		6
638 #define	SMB_DOMAIN_NO_CACHE		7
639 
640 /*
641  * This structure could contain information about
642  * the primary domain the name of selected domain controller
643  * for the primary domain and a list of trusted domains if
644  * any. The "ex" in the structure name stands for extended.
645  * This is to differentiate this structure from smb_domain_t
646  * which only contains information about a single domain.
647  */
648 typedef struct smb_domainex {
649 	char			d_dc[MAXHOSTNAMELEN];
650 	smb_domain_t		d_primary;
651 	smb_trusted_domains_t	d_trusted;
652 } smb_domainex_t;
653 
654 int smb_domain_init(uint32_t);
655 void smb_domain_fini(void);
656 void smb_domain_show(void);
657 void smb_domain_save(void);
658 boolean_t smb_domain_lookup_name(char *, smb_domain_t *);
659 boolean_t smb_domain_lookup_sid(smb_sid_t *, smb_domain_t *);
660 boolean_t smb_domain_lookup_type(smb_domain_type_t, smb_domain_t *);
661 boolean_t smb_domain_getinfo(smb_domainex_t *);
662 void smb_domain_update(smb_domainex_t *);
663 uint32_t smb_domain_start_update(void);
664 void smb_domain_end_update(void);
665 void smb_domain_set_basic_info(char *, char *, char *, smb_domain_t *);
666 void smb_domain_set_dns_info(char *, char *, char *, char *, char *,
667     smb_domain_t *);
668 void smb_domain_set_trust_info(char *, char *, char *,
669     uint32_t, uint32_t, uint32_t, smb_domain_t *);
670 void smb_domain_current_dc(char *buf, size_t len);
671 
672 typedef struct smb_gsid {
673 	smb_sid_t *gs_sid;
674 	uint16_t gs_type;
675 } smb_gsid_t;
676 
677 typedef struct smb_giter {
678 	sqlite_vm	*sgi_vm;
679 	sqlite		*sgi_db;
680 	uint32_t	sgi_nerr;
681 } smb_giter_t;
682 
683 typedef struct smb_group {
684 	char			*sg_name;
685 	char			*sg_cmnt;
686 	uint32_t		sg_attr;
687 	uint32_t		sg_rid;
688 	smb_gsid_t		sg_id;
689 	smb_domain_type_t	sg_domain;
690 	smb_privset_t		*sg_privs;
691 	uint32_t		sg_nmembers;
692 	smb_gsid_t		*sg_members;
693 } smb_group_t;
694 
695 int smb_lgrp_start(void);
696 void smb_lgrp_stop(void);
697 int smb_lgrp_add(char *, char *);
698 int smb_lgrp_rename(char *, char *);
699 int smb_lgrp_delete(char *);
700 int smb_lgrp_setcmnt(char *, char *);
701 int smb_lgrp_getcmnt(char *, char **);
702 int smb_lgrp_getpriv(char *, uint8_t, boolean_t *);
703 int smb_lgrp_setpriv(char *, uint8_t, boolean_t);
704 int smb_lgrp_add_member(char *, smb_sid_t *, uint16_t);
705 int smb_lgrp_del_member(char *, smb_sid_t *, uint16_t);
706 int smb_lgrp_getbyname(char *, smb_group_t *);
707 int smb_lgrp_getbyrid(uint32_t, smb_domain_type_t, smb_group_t *);
708 void smb_lgrp_free(smb_group_t *);
709 uint32_t smb_lgrp_err_to_ntstatus(uint32_t);
710 boolean_t smb_lgrp_is_member(smb_group_t *, smb_sid_t *);
711 char *smb_lgrp_strerror(int);
712 int smb_lgrp_iteropen(smb_giter_t *);
713 void smb_lgrp_iterclose(smb_giter_t *);
714 boolean_t smb_lgrp_itererror(smb_giter_t *);
715 int smb_lgrp_iterate(smb_giter_t *, smb_group_t *);
716 
717 int smb_lookup_sid(const char *, lsa_account_t *);
718 int smb_lookup_name(const char *, sid_type_t, lsa_account_t *);
719 
720 #define	SMB_LGRP_SUCCESS		0
721 #define	SMB_LGRP_INVALID_ARG		1
722 #define	SMB_LGRP_INVALID_MEMBER		2
723 #define	SMB_LGRP_INVALID_NAME		3
724 #define	SMB_LGRP_NOT_FOUND		4
725 #define	SMB_LGRP_EXISTS			5
726 #define	SMB_LGRP_NO_SID			6
727 #define	SMB_LGRP_NO_LOCAL_SID		7
728 #define	SMB_LGRP_SID_NOTLOCAL		8
729 #define	SMB_LGRP_WKSID			9
730 #define	SMB_LGRP_NO_MEMORY		10
731 #define	SMB_LGRP_DB_ERROR		11
732 #define	SMB_LGRP_DBINIT_ERROR		12
733 #define	SMB_LGRP_INTERNAL_ERROR		13
734 #define	SMB_LGRP_MEMBER_IN_GROUP	14
735 #define	SMB_LGRP_MEMBER_NOT_IN_GROUP	15
736 #define	SMB_LGRP_NO_SUCH_PRIV		16
737 #define	SMB_LGRP_NO_SUCH_DOMAIN		17
738 #define	SMB_LGRP_PRIV_HELD		18
739 #define	SMB_LGRP_PRIV_NOT_HELD		19
740 #define	SMB_LGRP_BAD_DATA		20
741 #define	SMB_LGRP_NO_MORE		21
742 #define	SMB_LGRP_DBOPEN_FAILED		22
743 #define	SMB_LGRP_DBEXEC_FAILED		23
744 #define	SMB_LGRP_DBINIT_FAILED		24
745 #define	SMB_LGRP_DOMLKP_FAILED		25
746 #define	SMB_LGRP_DOMINS_FAILED		26
747 #define	SMB_LGRP_INSERT_FAILED		27
748 #define	SMB_LGRP_DELETE_FAILED		28
749 #define	SMB_LGRP_UPDATE_FAILED		29
750 #define	SMB_LGRP_LOOKUP_FAILED		30
751 #define	SMB_LGRP_NOT_SUPPORTED		31
752 #define	SMB_LGRP_OFFLINE		32
753 #define	SMB_LGRP_POSIXCREATE_FAILED	33
754 
755 #define	SMB_LGRP_COMMENT_MAX	256
756 
757 /*
758  * values for smb_nic_t.smbflags
759  */
760 #define	SMB_NICF_NBEXCL		0x01	/* Excluded from Netbios activities */
761 #define	SMB_NICF_ALIAS		0x02	/* This is an alias */
762 
763 /*
764  * smb_nic_t
765  *     nic_host		actual host name
766  *     nic_nbname	16-byte NetBIOS host name
767  */
768 typedef struct {
769 	char		nic_host[MAXHOSTNAMELEN];
770 	char		nic_nbname[NETBIOS_NAME_SZ];
771 	char		nic_cmnt[SMB_PI_MAX_COMMENT];
772 	char		nic_ifname[LIFNAMSIZ];
773 	smb_inaddr_t	nic_ip;
774 	uint32_t	nic_mask;
775 	uint32_t	nic_bcast;
776 	uint32_t	nic_smbflags;
777 	uint64_t	nic_sysflags;
778 } smb_nic_t;
779 
780 typedef struct smb_niciter {
781 	smb_nic_t ni_nic;
782 	int ni_cookie;
783 	int ni_seqnum;
784 } smb_niciter_t;
785 
786 /* NIC config functions */
787 int smb_nic_init(void);
788 void smb_nic_fini(void);
789 int smb_nic_getnum(char *);
790 int smb_nic_addhost(const char *, const char *, int, const char **);
791 int smb_nic_delhost(const char *);
792 int smb_nic_getfirst(smb_niciter_t *);
793 int smb_nic_getnext(smb_niciter_t *);
794 boolean_t smb_nic_is_local(smb_inaddr_t *);
795 boolean_t smb_nic_is_same_subnet(smb_inaddr_t *);
796 
797 #define	SMB_NIC_SUCCESS			0
798 #define	SMB_NIC_INVALID_ARG		1
799 #define	SMB_NIC_NOT_FOUND		2
800 #define	SMB_NIC_NO_HOST			3
801 #define	SMB_NIC_NO_MEMORY		4
802 #define	SMB_NIC_DB_ERROR		5
803 #define	SMB_NIC_DBINIT_ERROR		6
804 #define	SMB_NIC_BAD_DATA		7
805 #define	SMB_NIC_NO_MORE			8
806 #define	SMB_NIC_DBOPEN_FAILED		9
807 #define	SMB_NIC_DBEXEC_FAILED		10
808 #define	SMB_NIC_DBINIT_FAILED		11
809 #define	SMB_NIC_INSERT_FAILED		12
810 #define	SMB_NIC_DELETE_FAILED		13
811 #define	SMB_NIC_SOCK			14
812 #define	SMB_NIC_IOCTL			15
813 #define	SMB_NIC_CHANGED			16
814 
815 /*
816  * Well-known account structure
817  *
818  * A security identifier (SID) is a unique value of variable length that
819  * is used to identify a security principal or security group in
820  * Windows. Well-known SIDs are a group of SIDs that identify generic
821  * users or generic groups. Their values remain constant across all
822  * operating systems.
823  *
824  * This structure is defined to store these SIDs and other related
825  * information about them (e.g. account and domain names) in a
826  * predefined table.
827  */
828 typedef struct smb_wka {
829 	uint8_t		wka_domidx;
830 	char		*wka_sid;
831 	char		*wka_name;
832 	uint16_t	wka_type;
833 	uint16_t	wka_flags;
834 	char		*wka_desc;
835 	smb_sid_t	*wka_binsid;
836 } smb_wka_t;
837 
838 /*
839  * Defined values for smb_wka.wka_flags
840  *
841  * SMB_WKAFLG_LGRP_ENABLE		Can be added as local group
842  */
843 #define	SMB_WKAFLG_LGRP_ENABLE	0x1
844 
845 /*
846  * Well-known account interfaces
847  */
848 smb_wka_t *smb_wka_lookup_builtin(const char *);
849 smb_wka_t *smb_wka_lookup_name(const char *);
850 smb_wka_t *smb_wka_lookup_sid(smb_sid_t *);
851 smb_sid_t *smb_wka_get_sid(const char *);
852 char *smb_wka_get_domain(int);
853 uint32_t smb_wka_token_groups(uint32_t, smb_ids_t *);
854 
855 /*
856  * In memory account representation
857  */
858 typedef struct smb_account {
859 	char		*a_name;
860 	char		*a_domain;
861 	uint16_t	a_type;
862 	smb_sid_t	*a_sid;
863 	smb_sid_t	*a_domsid;
864 	uint32_t	a_rid;
865 } smb_account_t;
866 
867 uint32_t smb_sam_lookup_name(char *, char *, uint16_t, smb_account_t *);
868 uint32_t smb_sam_lookup_sid(smb_sid_t *, smb_account_t *);
869 int smb_sam_usr_cnt(void);
870 uint32_t smb_sam_usr_groups(smb_sid_t *, smb_ids_t *);
871 int smb_sam_grp_cnt(smb_domain_type_t);
872 void smb_account_free(smb_account_t *);
873 boolean_t smb_account_validate(smb_account_t *);
874 
875 /*
876  * Security Descriptor functions.
877  */
878 uint32_t smb_sd_read(char *path, smb_sd_t *, uint32_t);
879 uint32_t smb_sd_write(char *path, smb_sd_t *, uint32_t);
880 uint32_t smb_sd_fromfs(smb_fssd_t *, smb_sd_t *);
881 
882 /* Kernel Module Interface */
883 int smb_kmod_bind(void);
884 boolean_t smb_kmod_isbound(void);
885 int smb_kmod_setcfg(smb_kmod_cfg_t *);
886 int smb_kmod_setgmtoff(int32_t);
887 int smb_kmod_start(int, int, int);
888 void smb_kmod_stop(void);
889 int smb_kmod_event_notify(uint32_t);
890 void smb_kmod_unbind(void);
891 int smb_kmod_share(nvlist_t *);
892 int smb_kmod_unshare(nvlist_t *);
893 int smb_kmod_shareinfo(char *, boolean_t *);
894 int smb_kmod_get_open_num(smb_opennum_t *);
895 int smb_kmod_enum(smb_netsvc_t *);
896 smb_netsvc_t *smb_kmod_enum_init(smb_svcenum_t *);
897 void smb_kmod_enum_fini(smb_netsvc_t *);
898 int smb_kmod_session_close(const char *, const char *);
899 int smb_kmod_file_close(uint32_t);
900 int smb_kmod_get_spool_doc(uint32_t *, char *, char *, smb_inaddr_t *);
901 
902 void smb_name_parse(char *, char **, char **);
903 uint32_t smb_name_validate_share(const char *);
904 uint32_t smb_name_validate_account(const char *);
905 uint32_t smb_name_validate_domain(const char *);
906 uint32_t smb_name_validate_nbdomain(const char *);
907 uint32_t smb_name_validate_workgroup(const char *);
908 uint32_t smb_name_validate_rpath(const char *);
909 
910 /*
911  * Interposer library validation
912  */
913 #define	SMBEX_VERSION	1
914 #define	SMBEX_KEY	"82273fdc-e32a-18c3-3f78-827929dc23ea"
915 typedef struct smbex_version {
916 	uint32_t v_version;
917 	uuid_t v_uuid;
918 } smbex_version_t;
919 void *smb_dlopen(void);
920 void smb_dlclose(void *);
921 
922 /*
923  * General purpose multi-thread safe cache based on
924  * AVL tree
925  */
926 typedef struct smb_cache {
927 	avl_tree_t	ch_cache;
928 	rwlock_t	ch_cache_lck;
929 	uint32_t	ch_state;
930 	uint32_t	ch_nops;
931 	uint32_t	ch_wait;
932 	uint32_t	ch_sequence;
933 	size_t		ch_datasz;
934 	mutex_t		ch_mtx;
935 	cond_t		ch_cv;
936 	void		(*ch_free)(void *);
937 	void		(*ch_copy)(const void *, void *, size_t);
938 } smb_cache_t;
939 
940 typedef struct smb_cache_node {
941 	avl_node_t	cn_link;
942 	void		*cn_data;
943 } smb_cache_node_t;
944 
945 typedef struct smb_cache_cursor {
946 	void		*cc_next;
947 	uint32_t	cc_sequence;
948 } smb_cache_cursor_t;
949 
950 /*
951  * flags used with smb_cache_add()
952  *
953  * SMB_CACHE_ADD	If object doesn't exist add, otherwise fail
954  * SMB_CACHE_REPLACE	If object doesn't exist add, otherwise replace
955  */
956 #define	SMB_CACHE_ADD		1
957 #define	SMB_CACHE_REPLACE	2
958 
959 void smb_cache_create(smb_cache_t *, uint32_t,
960     int (*cmpfn) (const void *, const void *), void (*freefn)(void *),
961     void (*copyfn)(const void *, void *, size_t), size_t);
962 void smb_cache_destroy(smb_cache_t *);
963 void smb_cache_flush(smb_cache_t *);
964 uint32_t smb_cache_num(smb_cache_t *);
965 int smb_cache_refreshing(smb_cache_t *);
966 void smb_cache_ready(smb_cache_t *);
967 int smb_cache_add(smb_cache_t *, const void *, int);
968 void smb_cache_remove(smb_cache_t *, const void *);
969 void smb_cache_iterinit(smb_cache_t *, smb_cache_cursor_t *);
970 boolean_t smb_cache_iterate(smb_cache_t *, smb_cache_cursor_t *, void *);
971 
972 /*
973  * Values returned by smb_reparse_stat()
974  */
975 #define	SMB_REPARSE_NOTFOUND	1	/* object does not exist */
976 #define	SMB_REPARSE_NOTREPARSE	2	/* object is NOT a reparse point */
977 #define	SMB_REPARSE_ISREPARSE	3	/* object is a reparse point */
978 
979 /*
980  * Reparse Point API
981  */
982 int smb_reparse_stat(const char *, uint32_t *);
983 int smb_reparse_svcadd(const char *, const char *, const char *);
984 int smb_reparse_svcdel(const char *, const char *);
985 int smb_reparse_svcget(const char *, const char *, char **);
986 
987 uint32_t smb_get_txid(void);
988 
989 #define	SMB_LOG_LINE_SZ		256
990 
991 typedef uint32_t	smb_log_hdl_t;
992 
993 typedef struct smb_log_item {
994 	list_node_t	li_lnd;
995 	char		li_msg[SMB_LOG_LINE_SZ];
996 } smb_log_item_t;
997 
998 typedef struct smb_log {
999 	smb_log_hdl_t	l_handle;
1000 	int		l_cnt;
1001 	int		l_max_cnt;
1002 	mutex_t		l_mtx;
1003 	list_t		l_list;
1004 	char		l_file[MAXPATHLEN];
1005 } smb_log_t;
1006 
1007 typedef struct smb_loglist_item {
1008 	list_node_t	lli_lnd;
1009 	smb_log_t	lli_log;
1010 } smb_loglist_item_t;
1011 
1012 typedef struct smb_loglist {
1013 	mutex_t		ll_mtx;
1014 	list_t		ll_list;
1015 } smb_loglist_t;
1016 
1017 smb_log_hdl_t smb_log_create(int, char *);
1018 void smb_log(smb_log_hdl_t, int, const char *, ...);
1019 void smb_log_dumpall(void);
1020 
1021 #ifdef	__cplusplus
1022 }
1023 #endif
1024 
1025 #endif	/* _LIBSMB_H */
1026