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