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