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