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