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