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