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