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 2017 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/inttypes.h>
36 #include <sys/list.h>
37 #include <sys/avl.h>
38 #include <arpa/inet.h>
39 #include <net/if.h>	/* LIFNAMSIZ */
40 #include <netdb.h>
41 #include <stdlib.h>
42 #include <libscf.h>
43 #include <libshare.h>
44 #include <uuid/uuid.h>
45 #include <synch.h>
46 #include <stdarg.h>
47 
48 #include <smb/nterror.h>
49 #include <smb/ntstatus.h>
50 #include <smb/wintypes.h>
51 
52 #include <smbsrv/string.h>
53 #include <smbsrv/smb_idmap.h>
54 #include <smbsrv/netbios.h>
55 #include <smbsrv/smb_share.h>
56 #include <smbsrv/smb_door.h>
57 #include <smbsrv/alloc.h>
58 #include <smbsrv/hash_table.h>
59 #include <smbsrv/msgbuf.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_NETBIOS_ENABLE,
135 	SMB_CI_NBSCOPE,
136 	SMB_CI_SYS_CMNT,
137 	SMB_CI_LM_LEVEL,
138 
139 	SMB_CI_ADS_SITE,
140 
141 	SMB_CI_DYNDNS_ENABLE,
142 
143 	SMB_CI_MACHINE_PASSWD,
144 	SMB_CI_MACHINE_UUID,
145 	SMB_CI_KPASSWD_SRV,
146 	SMB_CI_KPASSWD_DOMAIN,
147 	SMB_CI_KPASSWD_SEQNUM,
148 	SMB_CI_NETLOGON_SEQNUM,
149 	SMB_CI_IPV6_ENABLE,
150 	SMB_CI_PRINT_ENABLE,
151 	SMB_CI_MAP,
152 	SMB_CI_UNMAP,
153 	SMB_CI_DISPOSITION,
154 	SMB_CI_DFS_STDROOT_NUM,
155 	SMB_CI_TRAVERSE_MOUNTS,
156 	SMB_CI_SMB2_ENABLE_OLD, /* obsolete */
157 	SMB_CI_INITIAL_CREDITS,
158 	SMB_CI_MAXIMUM_CREDITS,
159 	SMB_CI_MAX_PROTOCOL,
160 	SMB_CI_ENCRYPT,
161 	SMB_CI_MIN_PROTOCOL,
162 	SMB_CI_BYPASS_TRAVERSE_CHECKING,
163 
164 	SMB_CI_MAX
165 } smb_cfg_id_t;
166 
167 /* SMF helper functions */
168 extern smb_scfhandle_t *smb_smf_scf_init(char *);
169 extern void smb_smf_scf_fini(smb_scfhandle_t *);
170 extern int smb_smf_start_transaction(smb_scfhandle_t *);
171 extern int smb_smf_end_transaction(smb_scfhandle_t *);
172 extern int smb_smf_set_string_property(smb_scfhandle_t *, char *, char *);
173 extern int smb_smf_get_string_property(smb_scfhandle_t *, char *,
174     char *, size_t);
175 extern int smb_smf_set_integer_property(smb_scfhandle_t *, char *, int64_t);
176 extern int smb_smf_get_integer_property(smb_scfhandle_t *, char *, int64_t *);
177 extern int smb_smf_set_boolean_property(smb_scfhandle_t *, char *, uint8_t);
178 extern int smb_smf_get_boolean_property(smb_scfhandle_t *, char *, uint8_t *);
179 extern int smb_smf_set_opaque_property(smb_scfhandle_t *, char *,
180     void *, size_t);
181 extern int smb_smf_get_opaque_property(smb_scfhandle_t *, char *,
182     void *, size_t);
183 extern int smb_smf_create_service_pgroup(smb_scfhandle_t *, char *);
184 extern int smb_smf_delete_property(smb_scfhandle_t *, char *);
185 extern int smb_smf_restart_service(void);
186 extern int smb_smf_maintenance_mode(void);
187 
188 /* ZFS interface */
189 int smb_getdataset(const char *, char *, size_t);
190 
191 /* Configuration management functions  */
192 extern int smb_config_get(smb_cfg_id_t, char *, int);
193 extern char *smb_config_getname(smb_cfg_id_t);
194 extern int smb_config_getstr(smb_cfg_id_t, char *, int);
195 extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
196 extern boolean_t smb_config_getbool(smb_cfg_id_t);
197 
198 extern int smb_config_set(smb_cfg_id_t, char *);
199 extern int smb_config_setstr(smb_cfg_id_t, char *);
200 extern int smb_config_setnum(smb_cfg_id_t, int64_t);
201 extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
202 
203 extern boolean_t smb_config_get_ads_enable(void);
204 extern int smb_config_get_debug(void);
205 extern uint8_t smb_config_get_fg_flag(void);
206 extern char *smb_config_get_localsid(void);
207 extern int smb_config_get_localuuid(uuid_t);
208 extern int smb_config_secmode_fromstr(char *);
209 extern char *smb_config_secmode_tostr(int);
210 extern int smb_config_get_secmode(void);
211 extern int smb_config_set_secmode(int);
212 extern int smb_config_set_idmap_domain(char *);
213 extern int smb_config_refresh_idmap(void);
214 extern int smb_config_getip(smb_cfg_id_t, smb_inaddr_t *);
215 extern void smb_config_get_version(smb_version_t *);
216 uint32_t smb_config_get_execinfo(char *, char *, size_t);
217 extern void smb_config_get_negtok(uchar_t *, uint32_t *);
218 
219 extern int smb_config_check_protocol(char *);
220 extern uint32_t smb_config_get_max_protocol(void);
221 extern uint32_t smb_config_get_min_protocol(void);
222 extern void smb_config_upgrade(void);
223 
224 extern smb_cfg_val_t smb_config_get_require(smb_cfg_id_t);
225 
226 extern void smb_load_kconfig(smb_kmod_cfg_t *kcfg);
227 extern uint32_t smb_crc_gen(uint8_t *, size_t);
228 
229 extern boolean_t smb_match_netlogon_seqnum(void);
230 extern int smb_setdomainprops(char *, char *, char *);
231 extern void smb_update_netlogon_seqnum(void);
232 
233 /* maximum password length on Windows 2000 and above */
234 #define	SMB_PASSWD_MAXLEN	127
235 #define	SMB_USERNAME_MAXLEN	40
236 
237 /* See also: smb_joininfo_xdr() */
238 typedef struct smb_joininfo {
239 	char domain_name[MAXHOSTNAMELEN];
240 	char domain_username[SMB_USERNAME_MAXLEN + 1];
241 	char domain_passwd[SMB_PASSWD_MAXLEN + 1];
242 	uint32_t mode;
243 } smb_joininfo_t;
244 
245 /* See also: smb_joinres_xdr() */
246 typedef struct smb_joinres {
247 	uint32_t status;
248 	int join_err;
249 	char dc_name[MAXHOSTNAMELEN];
250 } smb_joinres_t;
251 
252 /* APIs to communicate with SMB daemon via door calls */
253 int smb_join(smb_joininfo_t *, smb_joinres_t *info);
254 bool_t smb_joininfo_xdr(XDR *, smb_joininfo_t *);
255 bool_t smb_joinres_xdr(XDR *, smb_joinres_t *);
256 boolean_t smb_find_ads_server(char *, char *, int);
257 void smb_notify_dc_changed(void);
258 
259 extern void smb_config_getdomaininfo(char *, char *, char *, char *, char *);
260 extern void smb_config_setdomaininfo(char *, char *, char *, char *, char *);
261 extern uint32_t smb_get_dcinfo(char *, uint32_t, smb_inaddr_t *);
262 
263 /*
264  * buffer context structure. This is used to keep track of the buffer
265  * context.
266  *
267  * basep:  points to the beginning of the buffer
268  * curp:   points to the current offset
269  * endp:   points to the limit of the buffer
270  */
271 typedef struct {
272 	unsigned char *basep;
273 	unsigned char *curp;
274 	unsigned char *endp;
275 } smb_ctxbuf_t;
276 
277 extern int smb_ctxbuf_init(smb_ctxbuf_t *ctx, unsigned char *buf,
278     size_t buflen);
279 extern int smb_ctxbuf_len(smb_ctxbuf_t *ctx);
280 extern int smb_ctxbuf_printf(smb_ctxbuf_t *ctx, const char *fmt, ...);
281 
282 void smb_idmap_check(const char *, idmap_stat);
283 
284 /* Miscellaneous functions */
285 extern void hexdump(unsigned char *, int);
286 extern size_t bintohex(const char *, size_t, char *, size_t);
287 extern size_t hextobin(const char *, size_t, char *, size_t);
288 extern char *strstrip(char *, const char *);
289 extern char *strtrim(char *, const char *);
290 extern char *trim_whitespace(char *);
291 extern void randomize(char *, unsigned);
292 extern void rand_hash(unsigned char *, size_t, unsigned char *, size_t);
293 
294 extern int smb_getdomainname(char *, size_t);
295 extern int smb_getfqdomainname(char *, size_t);
296 
297 typedef enum smb_caseconv {
298 	SMB_CASE_PRESERVE = 0,
299 	SMB_CASE_UPPER,
300 	SMB_CASE_LOWER
301 } smb_caseconv_t;
302 
303 extern int smb_gethostname(char *, size_t, smb_caseconv_t);
304 extern int smb_getfqhostname(char *, size_t);
305 extern int smb_getnetbiosname(char *, size_t);
306 extern struct hostent *smb_gethostbyname(const char *, int *);
307 extern struct hostent *smb_gethostbyaddr(const char *, int, int, int *);
308 
309 #define	SMB_SAMACCT_MAXLEN	(NETBIOS_NAME_SZ + 1)
310 extern int smb_getsamaccount(char *, size_t);
311 
312 extern int smb_get_nameservers(smb_inaddr_t *, int);
313 extern void smb_tonetbiosname(char *, char *, char);
314 
315 extern int smb_chk_hostaccess(smb_inaddr_t *, char *);
316 
317 extern int smb_getnameinfo(smb_inaddr_t *, char *, int, int);
318 
319 void smb_trace(const char *s);
320 void smb_tracef(const char *fmt, ...);
321 
322 const char *xlate_nt_status(unsigned int);
323 
324 void libsmb_redirect_syslog(__FILE_TAG *fp, int priority);
325 
326 /*
327  * Authentication
328  */
329 
330 #define	SMBAUTH_LM_MAGIC_STR	"KGS!@#$%"
331 
332 #define	SMBAUTH_HASH_SZ		16	/* also LM/NTLM/NTLMv2 Hash size */
333 #define	SMBAUTH_LM_RESP_SZ	24	/* also NTLM Response size */
334 #define	SMBAUTH_LM_PWD_SZ	14	/* LM password size */
335 #define	SMBAUTH_CHAL_SZ		 8	/* both LMv2 and NTLMv2 */
336 #define	SMBAUTH_SESSION_KEY_SZ	SMBAUTH_HASH_SZ
337 #define	SMBAUTH_HEXHASH_SZ	(SMBAUTH_HASH_SZ * 2)
338 
339 #define	SMBAUTH_FAILURE		1
340 #define	SMBAUTH_SUCCESS		0
341 #define	MD_DIGEST_LEN		16
342 
343 /*
344  * Name Types
345  *
346  * The list of names near the end of the data blob (i.e. the ndb_names
347  * field of the smb_auth_data_blob_t data structure) can be classify into
348  * the following types:
349  *
350  * 0x0000 Indicates the end of the list.
351  * 0x0001 The name is a NetBIOS machine name (e.g. server name)
352  * 0x0002 The name is an NT Domain NetBIOS name.
353  * 0x0003 The name is the server's DNS hostname.
354  * 0x0004 The name is a W2K Domain name (a DNS name).
355  */
356 #define	SMBAUTH_NAME_TYPE_LIST_END		0x0000
357 #define	SMBAUTH_NAME_TYPE_SERVER_NETBIOS	0x0001
358 #define	SMBAUTH_NAME_TYPE_DOMAIN_NETBIOS	0x0002
359 #define	SMBAUTH_NAME_TYPE_SERVER_DNS		0x0003
360 #define	SMBAUTH_NAME_TYPE_DOMAIN_DNS		0x0004
361 
362 /*
363  * smb_auth_name_entry_t
364  *
365  * Each name entry in the data blob consists of the following 3 fields:
366  *
367  * nne_type - name type
368  * nne_len  - the length of the name
369  * nne_name - the name, in uppercase UCS-2LE Unicode format
370  */
371 typedef struct smb_auth_name_entry {
372 	unsigned short nne_type;
373 	unsigned short nne_len;
374 	smb_wchar_t nne_name[SMB_PI_MAX_DOMAIN * 2];
375 } smb_auth_name_entry_t;
376 
377 /*
378  * smb_auth_data_blob
379  *
380  * The format of this NTLMv2 data blob structure is as follow:
381  *
382  *	- Blob Signature 0x01010000 (4 bytes)
383  * - Reserved (0x00000000) (4 bytes)
384  * - Timestamp Little-endian, 64-bit signed value representing
385  *   the number of tenths of a microsecond since January 1, 1601.
386  *   (8 bytes)
387  * - Client Challenge (8 bytes)
388  * - Unknown1 (4 bytes)
389  * - List of Target Information (variable length)
390  * - Unknown2 (4 bytes)
391  */
392 typedef struct smb_auth_data_blob {
393 	unsigned char ndb_signature[4];
394 	unsigned char ndb_reserved[4];
395 	uint64_t ndb_timestamp;
396 	unsigned char ndb_clnt_challenge[SMBAUTH_CHAL_SZ];
397 	unsigned char ndb_unknown[4];
398 	smb_auth_name_entry_t ndb_names[2];
399 	unsigned char ndb_unknown2[4];
400 } smb_auth_data_blob_t;
401 
402 #define	SMBAUTH_BLOB_MAXLEN (sizeof (smb_auth_data_blob_t))
403 #define	SMBAUTH_CI_MAXLEN   SMBAUTH_LM_RESP_SZ
404 #define	SMBAUTH_CS_MAXLEN   (SMBAUTH_BLOB_MAXLEN + SMBAUTH_HASH_SZ)
405 
406 /*
407  * smb_auth_info_t
408  *
409  * The structure contains all the authentication information
410  * needed for the preparaton of the SMBSessionSetupAndx request
411  * and the user session key.
412  *
413  * hash      - NTLM hash
414  * hash_v2   - NTLMv2 hash
415  * ci_len    - the length of the case-insensitive password
416  * ci        - case-insensitive password
417  *             (If NTLMv2 authentication mechanism is used, it
418  *              represents the LMv2 response. Otherwise, it
419  *              is empty.)
420  * cs_len    - the length of the case-sensitive password
421  * cs        - case-sensitive password
422  *             (If NTLMv2 authentication mechanism is used, it
423  *              represents the NTLMv2 response. Otherwise, it
424  *              represents the NTLM response.)
425  * data_blob - NTLMv2 data blob
426  */
427 typedef struct smb_auth_info {
428 	unsigned char hash[SMBAUTH_HASH_SZ];
429 	unsigned char hash_v2[SMBAUTH_HASH_SZ];
430 	unsigned short ci_len;
431 	unsigned char ci[SMBAUTH_CI_MAXLEN];
432 	unsigned short cs_len;
433 	unsigned char cs[SMBAUTH_CS_MAXLEN];
434 	int lmcompatibility_lvl;
435 	smb_auth_data_blob_t data_blob;
436 } smb_auth_info_t;
437 
438 /*
439  * SMB password management
440  */
441 
442 #define	SMB_PWF_LM	0x01	/* LM hash is present */
443 #define	SMB_PWF_NT	0x02	/* NT hash is present */
444 #define	SMB_PWF_DISABLE	0x04	/* Account is disabled */
445 
446 typedef struct smb_passwd {
447 	uid_t		pw_uid;
448 	uint32_t	pw_flags;
449 	char		pw_name[SMB_USERNAME_MAXLEN];
450 	uint8_t		pw_lmhash[SMBAUTH_HASH_SZ];
451 	uint8_t		pw_nthash[SMBAUTH_HASH_SZ];
452 } smb_passwd_t;
453 
454 /*
455  * Control flags passed to smb_pwd_setcntl
456  */
457 #define	SMB_PWC_DISABLE	0x01
458 #define	SMB_PWC_ENABLE	0x02
459 #define	SMB_PWC_NOLM	0x04
460 
461 #define	SMB_PWE_SUCCESS		0
462 #define	SMB_PWE_USER_UNKNOWN	1
463 #define	SMB_PWE_USER_DISABLE	2
464 #define	SMB_PWE_CLOSE_FAILED	3
465 #define	SMB_PWE_OPEN_FAILED	4
466 #define	SMB_PWE_WRITE_FAILED	6
467 #define	SMB_PWE_UPDATE_FAILED	7
468 #define	SMB_PWE_STAT_FAILED	8
469 #define	SMB_PWE_BUSY		9
470 #define	SMB_PWE_DENIED		10
471 #define	SMB_PWE_SYSTEM_ERROR	11
472 #define	SMB_PWE_INVALID_PARAM	12
473 #define	SMB_PWE_NO_MEMORY	13
474 #define	SMB_PWE_MAX		14
475 
476 typedef struct smb_pwditer {
477 	void *spi_next;
478 } smb_pwditer_t;
479 
480 typedef struct smb_luser {
481 	char *su_name;
482 	char *su_fullname;
483 	char *su_desc;
484 	uint32_t su_rid;
485 	uint32_t su_ctrl;
486 } smb_luser_t;
487 
488 extern void smb_pwd_init(boolean_t);
489 extern void smb_pwd_fini(void);
490 extern smb_passwd_t *smb_pwd_getpwnam(const char *, smb_passwd_t *);
491 extern smb_passwd_t *smb_pwd_getpwuid(uid_t, smb_passwd_t *);
492 extern int smb_pwd_setpasswd(const char *, const char *);
493 extern int smb_pwd_setcntl(const char *, int);
494 
495 extern int smb_pwd_iteropen(smb_pwditer_t *);
496 extern smb_luser_t *smb_pwd_iterate(smb_pwditer_t *);
497 extern void smb_pwd_iterclose(smb_pwditer_t *);
498 
499 extern int smb_auth_qnd_unicode(smb_wchar_t *, const char *, int);
500 extern int smb_auth_hmac_md5(unsigned char *, int, unsigned char *, int,
501     unsigned char *);
502 
503 /*
504  * A variation on HMAC-MD5 known as HMACT64 is used by Windows systems.
505  * The HMACT64() function is the same as the HMAC-MD5() except that
506  * it truncates the input key to 64 bytes rather than hashing it down
507  * to 16 bytes using the MD5() function.
508  */
509 #define	SMBAUTH_HMACT64(D, Ds, K, Ks, digest) \
510 	smb_auth_hmac_md5(D, Ds, K, (Ks > 64) ? 64 : Ks, digest)
511 
512 extern int smb_auth_DES(unsigned char *, int, unsigned char *, int,
513     unsigned char *, int);
514 extern int smb_auth_RC4(unsigned char *, int, unsigned char *, int,
515     unsigned char *, int);
516 
517 extern int smb_auth_md4(unsigned char *, unsigned char *, int);
518 extern int smb_auth_lm_hash(const char *, unsigned char *);
519 extern int smb_auth_ntlm_hash(const char *, unsigned char *);
520 extern void smb_auth_ntlm2_mkchallenge(char *, const char *, const char *);
521 extern void smb_auth_ntlm2_kxkey(unsigned char *, const char *, const char *,
522     unsigned char *);
523 
524 extern int smb_auth_set_info(char *, char *,
525     unsigned char *, char *, unsigned char *,
526     int, int, smb_auth_info_t *);
527 
528 extern int smb_auth_ntlmv2_hash(unsigned char *,
529 	char *, char *, unsigned char *);
530 
531 boolean_t smb_auth_validate(smb_passwd_t *, char *, char *,
532     uchar_t *, uint_t, uchar_t *, uint_t, uchar_t *, uint_t, uchar_t *);
533 
534 int smb_gen_random_passwd(char *passwd, size_t bufsz);
535 
536 /*
537  * SMB authenticated IPC
538  */
539 extern void smb_ipc_commit(void);
540 extern void smb_ipc_get_user(char *, size_t);
541 extern void smb_ipc_get_passwd(uint8_t *, size_t);
542 extern void smb_ipc_init(void);
543 extern void smb_ipc_rollback(void);
544 extern void smb_ipc_set(char *, uint8_t *);
545 
546 /*
547  * Signing flags:
548  *
549  * SMB_SCF_ENABLE                 Signing is enabled.
550  *
551  * SMB_SCF_REQUIRED               Signing is enabled and required.
552  *                                This flag shouldn't be set if
553  *                                SMB_SCF_ENABLE isn't set.
554  *
555  * SMB_SCF_STARTED                Signing will start after receiving
556  *                                the first non-anonymous SessionSetup
557  *                                request.
558  *
559  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
560  *                                been set for this logon. (prior to
561  *                                sending the SMBSessionSetup request)
562  *
563  */
564 #define	SMB_SCF_ENABLE		0x01
565 #define	SMB_SCF_REQUIRED	0x02
566 #define	SMB_SCF_STARTED		0x04
567 #define	SMB_SCF_KEY_ISSET_THIS_LOGON	0x08
568 
569 /*
570  * Each domain is categorized using the enum values below.
571  * The local domain refers to the local machine and is named
572  * after the local hostname. The primary domain is the domain
573  * that the system joined. All other domains are either
574  * trusted or untrusted, as defined by the primary domain PDC.
575  */
576 typedef enum smb_domain_type {
577 	SMB_DOMAIN_NULL,
578 	SMB_DOMAIN_BUILTIN,
579 	SMB_DOMAIN_LOCAL,
580 	SMB_DOMAIN_PRIMARY,
581 	SMB_DOMAIN_ACCOUNT,
582 	SMB_DOMAIN_TRUSTED,
583 	SMB_DOMAIN_UNTRUSTED,
584 	SMB_DOMAIN_NUM_TYPES
585 } smb_domain_type_t;
586 
587 /*
588  * Information specific to trusted domains
589  */
590 typedef struct smb_domain_trust {
591 	uint32_t		dti_trust_direction;
592 	uint32_t		dti_trust_type;
593 	uint32_t		dti_trust_attrs;
594 } smb_domain_trust_t;
595 
596 /*
597  * DNS information for domain types that this info is
598  * obtained/available. Currently this is only obtained
599  * for the primary domain.
600  */
601 typedef struct smb_domain_dns {
602 	char			ddi_forest[MAXHOSTNAMELEN];
603 	char			ddi_guid[UUID_PRINTABLE_STRING_LENGTH];
604 } smb_domain_dns_t;
605 
606 /*
607  * This is the information that is held about each domain.
608  */
609 typedef struct smb_domain {
610 	list_node_t		di_lnd;
611 	smb_domain_type_t	di_type;
612 	char			di_sid[SMB_SID_STRSZ];
613 	char			di_nbname[NETBIOS_NAME_SZ];
614 	char			di_fqname[MAXHOSTNAMELEN];
615 	smb_sid_t		*di_binsid;
616 	union {
617 		smb_domain_dns_t	di_dns;
618 		smb_domain_trust_t	di_trust;
619 	} di_u;
620 } smb_domain_t;
621 
622 typedef struct smb_trusted_domains {
623 	uint32_t	td_num;
624 	smb_domain_t	*td_domains;
625 } smb_trusted_domains_t;
626 
627 #define	SMB_DOMAIN_SUCCESS		0
628 #define	SMB_DOMAIN_NOMACHINE_SID	1
629 #define	SMB_DOMAIN_NODOMAIN_SID		2
630 #define	SMB_DOMAIN_NODOMAIN_NAME	3
631 #define	SMB_DOMAIN_INTERNAL_ERR		4
632 #define	SMB_DOMAIN_INVALID_ARG		5
633 #define	SMB_DOMAIN_NO_MEMORY		6
634 #define	SMB_DOMAIN_NO_CACHE		7
635 
636 typedef struct smb_dcinfo {
637 	char			dc_name[MAXHOSTNAMELEN];
638 	smb_inaddr_t		dc_addr;
639 } smb_dcinfo_t;
640 
641 /*
642  * This structure could contain information about
643  * the primary domain the name of selected domain controller
644  * for the primary domain and a list of trusted domains if
645  * any. The "ex" in the structure name stands for extended.
646  * This is to differentiate this structure from smb_domain_t
647  * which only contains information about a single domain.
648  */
649 typedef struct smb_domainex {
650 	smb_dcinfo_t		d_dci;
651 	smb_domain_t		d_primary;
652 	smb_trusted_domains_t	d_trusted;
653 } smb_domainex_t;
654 
655 int smb_domain_init(uint32_t);
656 void smb_domain_fini(void);
657 void smb_domain_show(void);
658 void smb_domain_save(void);
659 boolean_t smb_domain_lookup_name(char *, smb_domain_t *);
660 boolean_t smb_domain_lookup_sid(smb_sid_t *, smb_domain_t *);
661 boolean_t smb_domain_lookup_type(smb_domain_type_t, smb_domain_t *);
662 boolean_t smb_domain_getinfo(smb_domainex_t *);
663 void smb_domain_update(smb_domainex_t *);
664 uint32_t smb_domain_start_update(void);
665 void smb_domain_end_update(void);
666 void smb_domain_set_basic_info(char *, char *, char *, smb_domain_t *);
667 void smb_domain_set_dns_info(char *, char *, char *, char *, char *,
668     smb_domain_t *);
669 void smb_domain_set_trust_info(char *, char *, char *,
670     uint32_t, uint32_t, uint32_t, smb_domain_t *);
671 void smb_domain_current_dc(smb_dcinfo_t *);
672 void smb_domain_bad_dc(void);
673 
674 typedef struct smb_gsid {
675 	smb_sid_t *gs_sid;
676 	uint16_t gs_type;
677 } smb_gsid_t;
678 
679 struct sqlite_vm;
680 struct sqlite;
681 
682 typedef struct smb_giter {
683 	struct sqlite_vm	*sgi_vm;
684 	struct 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 void smb_syslog(int, const char *, ...);
995 void smb_vsyslog(int, const char *, va_list ap);
996 char *smb_syslog_fmt_m(char *, int, const char *, int);
997 
998 #ifdef	__cplusplus
999 }
1000 #endif
1001 
1002 #endif	/* _LIBSMB_H */
1003