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