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