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 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright 2011-2022 Tintri by DDN, Inc. All rights reserved. 24 * Copyright 2017-2023 RackTop Systems, Inc. 25 */ 26 27 /* 28 * Structures and type definitions for the SMB module. 29 */ 30 31 #ifndef _SMBSRV_SMB_KTYPES_H 32 #define _SMBSRV_SMB_KTYPES_H 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 #include <sys/note.h> 39 #include <sys/systm.h> 40 #include <sys/param.h> 41 #include <sys/types.h> 42 #include <sys/synch.h> 43 #include <sys/taskq.h> 44 #include <sys/socket.h> 45 #include <sys/acl.h> 46 #include <sys/sdt.h> 47 #include <sys/stat.h> 48 #include <sys/vnode.h> 49 #include <sys/cred.h> 50 #include <netinet/in.h> 51 #include <sys/ksocket.h> 52 #include <sys/fem.h> 53 #include <smbsrv/smb.h> 54 #include <smbsrv/smb2.h> 55 #include <smbsrv/smbinfo.h> 56 #include <smbsrv/mbuf.h> 57 #include <smbsrv/smb_sid.h> 58 #include <smbsrv/smb_xdr.h> 59 #include <smbsrv/netbios.h> 60 #include <smbsrv/smb_vops.h> 61 #include <smbsrv/smb_kstat.h> 62 63 struct __door_handle; /* <sys/door.h> */ 64 struct edirent; /* <sys/extdirent.h> */ 65 struct nvlist; 66 67 struct smb_disp_entry; 68 struct smb_request; 69 struct smb_server; 70 struct smb_event; 71 struct smb_export; 72 73 /* 74 * Accumulated time and queue length statistics. 75 * 76 * Accumulated time statistics are kept as a running sum of "active" time. 77 * Queue length statistics are kept as a running sum of the product of queue 78 * length and elapsed time at that length -- i.e., a Riemann sum for queue 79 * length integrated against time. (You can also think of the active time as a 80 * Riemann sum, for the boolean function (queue_length > 0) integrated against 81 * time, or you can think of it as the Lebesgue measure of the set on which 82 * queue_length > 0.) 83 * 84 * ^ 85 * | _________ 86 * 8 | i4 | 87 * | | | 88 * Queue 6 | | 89 * Length | _________ | | 90 * 4 | i2 |_______| | 91 * | | i3 | 92 * 2_______| | 93 * | i1 | 94 * |_______________________________| 95 * Time-> t1 t2 t3 t4 96 * 97 * At each change of state (entry or exit from the queue), we add the elapsed 98 * time (since the previous state change) to the active time if the queue length 99 * was non-zero during that interval; and we add the product of the elapsed time 100 * times the queue length to the running length*time sum. 101 * 102 * This method is generalizable to measuring residency in any defined system: 103 * instead of queue lengths, think of "outstanding RPC calls to server X". 104 * 105 * A large number of I/O subsystems have at least two basic "lists" of 106 * transactions they manage: one for transactions that have been accepted for 107 * processing but for which processing has yet to begin, and one for 108 * transactions which are actively being processed (but not done). For this 109 * reason, two cumulative time statistics are defined here: wait (pre-service) 110 * time, and run (service) time. 111 * 112 * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime(). 113 * 114 * The units of cumulative busy time are accumulated nanoseconds. The units of 115 * cumulative length*time products are elapsed time times queue length. 116 * 117 * Updates to the fields below are performed implicitly by calls to 118 * these functions: 119 * 120 * smb_srqueue_init() 121 * smb_srqueue_destroy() 122 * smb_srqueue_waitq_enter() 123 * smb_srqueue_runq_exit() 124 * smb_srqueue_waitq_to_runq() 125 * smb_srqueue_update() 126 * 127 * These fields should never be updated by any other means. 128 */ 129 typedef struct smb_srqueue { 130 kmutex_t srq_mutex; 131 hrtime_t srq_wlastupdate; 132 hrtime_t srq_wtime; 133 hrtime_t srq_wlentime; 134 hrtime_t srq_rlastupdate; 135 hrtime_t srq_rtime; 136 hrtime_t srq_rlentime; 137 uint32_t srq_wcnt; 138 uint32_t srq_rcnt; 139 } smb_srqueue_t; 140 141 /* 142 * The fields with the prefix 'ly_a' contain the statistics collected since the 143 * server was last started ('a' for 'aggregated'). The fields with the prefix 144 * 'ly_d' contain the statistics collected since the last snapshot ('d' for 145 * 'delta'). 146 */ 147 typedef struct smb_latency { 148 kmutex_t ly_mutex; 149 uint64_t ly_a_nreq; 150 hrtime_t ly_a_sum; 151 hrtime_t ly_a_mean; 152 hrtime_t ly_a_stddev; 153 uint64_t ly_d_nreq; 154 hrtime_t ly_d_sum; 155 hrtime_t ly_d_mean; 156 hrtime_t ly_d_stddev; 157 } smb_latency_t; 158 159 typedef struct smb_disp_stats { 160 volatile uint64_t sdt_txb; 161 volatile uint64_t sdt_rxb; 162 smb_latency_t sdt_lat; 163 } smb_disp_stats_t; 164 165 int smb_noop(void *, size_t, int); 166 167 #define SMB_AUDIT_STACK_DEPTH 16 168 #define SMB_AUDIT_BUF_MAX_REC 16 169 #define SMB_AUDIT_NODE 0x00000001 170 171 /* 172 * Maximum number of records returned in SMBsearch, SMBfind 173 * and SMBfindunique response. Value set to 10 for compatibility 174 * with Windows. 175 */ 176 #define SMB_MAX_SEARCH 10 177 178 #define SMB_SEARCH_ATTRIBUTES \ 179 (FILE_ATTRIBUTE_HIDDEN | \ 180 FILE_ATTRIBUTE_SYSTEM | \ 181 FILE_ATTRIBUTE_DIRECTORY) 182 183 #define SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN) 184 #define SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM) 185 #define SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY) 186 #define SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES) 187 188 typedef struct { 189 uint32_t anr_refcnt; 190 int anr_depth; 191 pc_t anr_stack[SMB_AUDIT_STACK_DEPTH]; 192 } smb_audit_record_node_t; 193 194 typedef struct { 195 int anb_index; 196 int anb_max_index; 197 smb_audit_record_node_t anb_records[SMB_AUDIT_BUF_MAX_REC]; 198 } smb_audit_buf_node_t; 199 200 /* 201 * Thread State Machine 202 * -------------------- 203 * 204 * T5 T0 205 * smb_thread_destroy() <-------+ +------- smb_thread_init() 206 * | | 207 * | v 208 * +-----------------------------+ 209 * | SMB_THREAD_STATE_EXITED |<---+ 210 * +-----------------------------+ | 211 * | T1 | 212 * v | 213 * +-----------------------------+ | 214 * | SMB_THREAD_STATE_STARTING | | 215 * +-----------------------------+ | 216 * | T2 | T4 217 * v | 218 * +-----------------------------+ | 219 * | SMB_THREAD_STATE_RUNNING | | 220 * +-----------------------------+ | 221 * | T3 | 222 * v | 223 * +-----------------------------+ | 224 * | SMB_THREAD_STATE_EXITING |----+ 225 * +-----------------------------+ 226 * 227 * Transition T0 228 * 229 * This transition is executed in smb_thread_init(). 230 * 231 * Transition T1 232 * 233 * This transition is executed in smb_thread_start(). 234 * 235 * Transition T2 236 * 237 * This transition is executed by the thread itself when it starts running. 238 * 239 * Transition T3 240 * 241 * This transition is executed by the thread itself in 242 * smb_thread_entry_point() just before calling thread_exit(). 243 * 244 * 245 * Transition T4 246 * 247 * This transition is executed in smb_thread_stop(). 248 * 249 * Transition T5 250 * 251 * This transition is executed in smb_thread_destroy(). 252 */ 253 typedef enum smb_thread_state { 254 SMB_THREAD_STATE_STARTING = 0, 255 SMB_THREAD_STATE_RUNNING, 256 SMB_THREAD_STATE_EXITING, 257 SMB_THREAD_STATE_EXITED, 258 SMB_THREAD_STATE_FAILED 259 } smb_thread_state_t; 260 261 struct _smb_thread; 262 263 typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg); 264 265 #define SMB_THREAD_MAGIC 0x534D4254 /* SMBT */ 266 267 typedef struct _smb_thread { 268 uint32_t sth_magic; 269 char sth_name[32]; 270 smb_thread_state_t sth_state; 271 struct smb_server *sth_server; 272 kthread_t *sth_th; 273 kt_did_t sth_did; 274 smb_thread_ep_t sth_ep; 275 void *sth_ep_arg; 276 pri_t sth_pri; 277 boolean_t sth_kill; 278 kmutex_t sth_mtx; 279 kcondvar_t sth_cv; 280 } smb_thread_t; 281 282 /* 283 * Pool of IDs 284 * ----------- 285 * 286 * A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap. 287 * A bit set to '1' indicates that that particular value has been allocated. 288 * The allocation process is done shifting a bit through the whole bitmap. 289 * The current position of that index bit is kept in the smb_idpool_t 290 * structure and represented by a byte index (0 to buffer size minus 1) and 291 * a bit index (0 to 7). 292 * 293 * The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs 294 * out of IDs its current size is doubled until it reaches its maximum size 295 * (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which 296 * means that a pool can have a maximum number of 65534 IDs available. 297 */ 298 #define SMB_IDPOOL_MAGIC 0x4944504C /* IDPL */ 299 #define SMB_IDPOOL_MIN_SIZE 64 /* Number of IDs to begin with */ 300 #define SMB_IDPOOL_MAX_SIZE 64 * 1024 301 302 typedef struct smb_idpool { 303 uint32_t id_magic; 304 kmutex_t id_mutex; 305 uint8_t *id_pool; 306 uint32_t id_size; 307 uint32_t id_maxsize; 308 uint8_t id_bit; 309 uint8_t id_bit_idx; 310 uint32_t id_idx; 311 uint32_t id_idx_msk; 312 uint32_t id_free_counter; 313 uint32_t id_max_free_counter; 314 } smb_idpool_t; 315 316 /* 317 * Maximum size of a Transport Data Unit when CAP_LARGE_READX and 318 * CAP_LARGE_WRITEX are not set. CAP_LARGE_READX/CAP_LARGE_WRITEX 319 * allow the payload to exceed the negotiated buffer size. 320 * 4 --> NBT/TCP Transport Header. 321 * 32 --> SMB Header 322 * 1 --> Word Count byte 323 * 510 --> Maximum Number of bytes of the Word Table (2 * 255) 324 * 2 --> Byte count of the data 325 * 65535 --> Maximum size of the data 326 * ----- 327 * 66084 328 */ 329 #define SMB_REQ_MAX_SIZE 66560 /* 65KB */ 330 #define SMB_XPRT_MAX_SIZE (SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ) 331 332 #define SMB_TXREQ_MAGIC 0X54524251 /* 'TREQ' */ 333 typedef struct { 334 list_node_t tr_lnd; 335 uint32_t tr_magic; 336 int tr_len; 337 uint8_t tr_buf[SMB_XPRT_MAX_SIZE]; 338 } smb_txreq_t; 339 340 #define SMB_TXLST_MAGIC 0X544C5354 /* 'TLST' */ 341 typedef struct { 342 uint32_t tl_magic; 343 kmutex_t tl_mutex; 344 kcondvar_t tl_wait_cv; 345 boolean_t tl_active; 346 } smb_txlst_t; 347 348 /* 349 * Maximum buffer size for NT is 37KB. If all clients are Windows 2000, this 350 * can be changed to 64KB. 37KB must be used with a mix of NT/Windows 2000 351 * clients because NT loses directory entries when values greater than 37KB are 352 * used. 353 * 354 * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to 355 * account for the NBT header. 356 */ 357 #define NBT_MAXBUF 8 358 #define SMB_NT_MAXBUF (37 * 1024) 359 360 #define OUTBUFSIZE (65 * 1024) 361 #define SMBHEADERSIZE 32 362 #define SMBND_HASH_MASK (0xFF) 363 #define MAX_IOVEC 512 364 #define MAX_READREF (8 * 1024) 365 366 #define SMB_WORKER_MIN 4 367 #define SMB_WORKER_DEFAULT 64 368 #define SMB_WORKER_MAX 1024 369 370 /* 371 * Destructor object used in the locked-list delete queue. 372 */ 373 #define SMB_DTOR_MAGIC 0x44544F52 /* DTOR */ 374 #define SMB_DTOR_VALID(d) \ 375 ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC)) 376 377 typedef void (*smb_dtorproc_t)(void *); 378 379 typedef struct smb_dtor { 380 list_node_t dt_lnd; 381 uint32_t dt_magic; 382 void *dt_object; 383 smb_dtorproc_t dt_proc; 384 } smb_dtor_t; 385 386 typedef struct smb_lavl { 387 krwlock_t la_lock; 388 avl_tree_t la_tree; 389 uint64_t la_wrop; 390 kmutex_t la_mutex; 391 list_t la_deleteq; 392 uint32_t la_deleteq_count; 393 boolean_t la_flushing; 394 } smb_lavl_t; 395 396 typedef struct smb_llist { 397 krwlock_t ll_lock; 398 list_t ll_list; 399 uint32_t ll_count; 400 uint64_t ll_wrop; 401 kmutex_t ll_mutex; 402 list_t ll_deleteq; 403 uint32_t ll_deleteq_count; 404 boolean_t ll_flushing; 405 } smb_llist_t; 406 407 typedef struct smb_bucket { 408 smb_llist_t b_list; 409 uint32_t b_max_seen; 410 } smb_bucket_t; 411 412 typedef struct smb_hash { 413 uint32_t rshift; 414 uint32_t num_buckets; 415 smb_bucket_t *buckets; 416 } smb_hash_t; 417 418 typedef struct smb_slist { 419 kmutex_t sl_mutex; 420 kcondvar_t sl_cv; 421 list_t sl_list; 422 uint32_t sl_count; 423 boolean_t sl_waiting; 424 } smb_slist_t; 425 426 /* 427 * smb_avl_t State Machine 428 * -------------------- 429 * 430 * +-----------------------------+ 431 * | SMB_AVL_STATE_START | 432 * +-----------------------------+ 433 * | T0 434 * v 435 * +-----------------------------+ 436 * | SMB_AVL_STATE_READY | 437 * +-----------------------------+ 438 * | T1 439 * v 440 * +-----------------------------+ 441 * | SMB_AVL_STATE_DESTROYING | 442 * +-----------------------------+ 443 * 444 * Transition T0 445 * 446 * This transition is executed in smb_avl_create(). 447 * 448 * Transition T1 449 * 450 * This transition is executed in smb_avl_destroy(). 451 * 452 */ 453 typedef enum { 454 SMB_AVL_STATE_START = 0, 455 SMB_AVL_STATE_READY, 456 SMB_AVL_STATE_DESTROYING 457 } smb_avl_state_t; 458 459 typedef struct smb_avl_nops { 460 int (*avln_cmp) (const void *, const void *); 461 void (*avln_hold)(const void *); 462 boolean_t (*avln_rele)(const void *); 463 void (*avln_destroy)(void *); 464 } smb_avl_nops_t; 465 466 typedef struct smb_avl_cursor { 467 void *avlc_next; 468 uint32_t avlc_sequence; 469 } smb_avl_cursor_t; 470 471 typedef struct smb_avl { 472 krwlock_t avl_lock; 473 avl_tree_t avl_tree; 474 kmutex_t avl_mutex; 475 kcondvar_t avl_cv; 476 smb_avl_state_t avl_state; 477 uint32_t avl_refcnt; 478 uint32_t avl_sequence; 479 const smb_avl_nops_t *avl_nops; 480 } smb_avl_t; 481 482 typedef struct { 483 kcondvar_t rwx_cv; 484 kmutex_t rwx_mutex; 485 krwlock_t rwx_lock; 486 boolean_t rwx_waiting; 487 } smb_rwx_t; 488 489 typedef struct smb_export { 490 kmutex_t e_mutex; 491 boolean_t e_ready; 492 smb_avl_t e_share_avl; 493 smb_slist_t e_unexport_list; 494 smb_thread_t e_unexport_thread; 495 } smb_export_t; 496 497 /* 498 * NOTIFY CHANGE, a.k.a. File Change Notification (FCN) 499 */ 500 501 /* 502 * These FCN filter mask values are not from MS-FSCC, but 503 * must not overlap with any FILE_NOTIFY_VALID_MASK values. 504 */ 505 #define FILE_NOTIFY_CHANGE_EV_SUBDIR 0x00010000 506 #define FILE_NOTIFY_CHANGE_EV_DELETE 0x00020000 507 #define FILE_NOTIFY_CHANGE_EV_CLOSED 0x00040000 508 #define FILE_NOTIFY_CHANGE_EV_OVERFLOW 0x00080000 509 510 /* 511 * Note: These FCN action values are not from MS-FSCC, but must 512 * follow in sequence from FILE_ACTION_MODIFIED_STREAM. 513 * 514 * FILE_ACTION_SUBDIR_CHANGED is used internally for 515 * "watch tree" support, posted to all parents of a 516 * directory that had one of the changes above. 517 * 518 * FILE_ACTION_DELETE_PENDING is used internally to tell 519 * notify change requests when the "delete-on-close" flag 520 * has been set on the directory being watched. 521 * 522 * FILE_ACTION_HANDLE_CLOSED is used to wakeup notify change 523 * requests when the watched directory handle is closed. 524 */ 525 #define FILE_ACTION_SUBDIR_CHANGED 0x00000009 526 #define FILE_ACTION_DELETE_PENDING 0x0000000a 527 #define FILE_ACTION_HANDLE_CLOSED 0x0000000b 528 529 /* 530 * Sub-struct within smb_ofile_t 531 */ 532 typedef struct smb_notify { 533 list_t nc_waiters; /* Waiting SRs */ 534 mbuf_chain_t nc_buffer; 535 uint32_t nc_filter; 536 uint32_t nc_events; 537 int nc_last_off; 538 boolean_t nc_subscribed; 539 } smb_notify_t; 540 541 /* 542 * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly 543 * over TCP, which is also known as direct hosted NetBIOS-less SMB 544 * or SMB-over-TCP. 545 * 546 * NBT messages have a 4-byte header that defines the message type 547 * (8-bits), a 7-bit flags field and a 17-bit length. 548 * 549 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 550 * | TYPE | FLAGS |E| LENGTH | 551 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 552 * 553 * 8-bit type Defined in RFC 1002 554 * 7-bit flags Bits 0-6 reserved (must be 0) 555 * Bit 7: Length extension bit (E) 556 * 17-bit length Includes bit 7 of the flags byte 557 * 558 * 559 * SMB-over-TCP is defined to use a modified version of the NBT header 560 * containing an 8-bit message type and 24-bit message length. 561 * 562 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 563 * | TYPE | LENGTH | 564 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 565 * 566 * 8-bit type Must be 0 567 * 24-bit length 568 * 569 * The following structure is used to represent a generic, in-memory 570 * SMB transport header; it is not intended to map directly to either 571 * of the over-the-wire formats. 572 */ 573 typedef struct { 574 uint8_t xh_type; 575 uint32_t xh_length; 576 } smb_xprt_t; 577 578 int MBC_LENGTH(struct mbuf_chain *); 579 int MBC_MAXBYTES(struct mbuf_chain *); 580 void MBC_SETUP(struct mbuf_chain *, uint32_t); 581 void MBC_INIT(struct mbuf_chain *, uint32_t); 582 void MBC_FLUSH(struct mbuf_chain *); 583 void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *); 584 void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *); 585 void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN); 586 int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC, 587 int OFF, int LEN); 588 589 #define MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes) 590 591 /* 592 * Per smb_node oplock state 593 */ 594 typedef struct smb_oplock { 595 kmutex_t ol_mutex; 596 boolean_t ol_fem; /* fem monitor installed? */ 597 struct smb_ofile *excl_open; 598 uint32_t ol_state; 599 int32_t cnt_II; 600 int32_t cnt_R; 601 int32_t cnt_RH; 602 int32_t cnt_RHBQ; 603 int32_t waiters; 604 kcondvar_t WaitingOpenCV; 605 } smb_oplock_t; 606 607 /* 608 * Per smb_ofile oplock state 609 */ 610 typedef struct smb_oplock_grant { 611 /* smb protocol-level state */ 612 uint32_t og_state; /* what client has now */ 613 uint32_t og_breakto; /* level breaking to */ 614 boolean_t og_breaking; 615 uint16_t og_dialect; /* how to send breaks */ 616 kcondvar_t og_ack_cv; /* Wait for ACK */ 617 /* File-system level state */ 618 uint8_t onlist_II; 619 uint8_t onlist_R; 620 uint8_t onlist_RH; 621 uint8_t onlist_RHBQ; 622 uint8_t BreakingToRead; 623 } smb_oplock_grant_t; 624 625 #define SMB_LEASE_KEY_SZ 16 626 627 typedef struct smb_lease { 628 list_node_t ls_lnd; /* sv_lease_ht */ 629 kmutex_t ls_mutex; /* for ls_refcnt */ 630 smb_llist_t *ls_bucket; 631 struct smb_node *ls_node; 632 /* 633 * With a lease, just one ofile has the oplock. 634 * This (used only for comparison) identifies which. 635 */ 636 void *ls_oplock_ofile; 637 uint32_t ls_refcnt; 638 uint32_t ls_state; /* what client has now */ 639 uint32_t ls_breakto; /* level breaking to */ 640 uint16_t ls_epoch; 641 uint16_t ls_version; 642 boolean_t ls_breaking; 643 kcondvar_t ls_ack_cv; /* Wait for ACK */ 644 uint8_t ls_key[SMB_LEASE_KEY_SZ]; 645 uint8_t ls_clnt[SMB_LEASE_KEY_SZ]; 646 } smb_lease_t; 647 648 #define SMB_NODE_MAGIC 0x4E4F4445 /* 'NODE' */ 649 #define SMB_NODE_VALID(p) ASSERT((p)->n_magic == SMB_NODE_MAGIC) 650 651 typedef enum { 652 SMB_NODE_STATE_AVAILABLE = 0, 653 SMB_NODE_STATE_DESTROYING 654 } smb_node_state_t; 655 656 /* 657 * waiting_event # of clients requesting FCN 658 * n_timestamps cached timestamps 659 * n_allocsz cached file allocation size 660 * n_dnode directory node 661 * n_unode unnamed stream node 662 * delete_on_close_cred credentials for delayed delete 663 */ 664 typedef struct smb_node { 665 list_node_t n_lnd; 666 uint32_t n_magic; 667 krwlock_t n_lock; 668 kmutex_t n_mutex; 669 smb_node_state_t n_state; 670 uint32_t n_refcnt; 671 uint32_t n_hashkey; 672 smb_llist_t *n_hash_bucket; 673 uint32_t n_open_count; 674 uint32_t n_opening_count; 675 smb_llist_t n_ofile_list; 676 /* If entering both, go in order n_lock_list, n_wlock_list */ 677 smb_llist_t n_lock_list; /* active locks */ 678 smb_llist_t n_wlock_list; /* waiting locks */ 679 volatile int flags; 680 u_offset_t n_allocsz; 681 uint32_t n_fcn_count; 682 smb_oplock_t n_oplock; 683 struct smb_node *n_dnode; 684 struct smb_node *n_unode; 685 cred_t *delete_on_close_cred; 686 uint32_t n_delete_on_close_flags; 687 char od_name[MAXNAMELEN]; 688 vnode_t *vp; 689 smb_audit_buf_node_t *n_audit_buf; 690 } smb_node_t; 691 692 #define NODE_FLAGS_REPARSE 0x00001000 693 #define NODE_FLAGS_DFSLINK 0x00002000 694 #define NODE_FLAGS_VFSROOT 0x00004000 695 #define NODE_FLAGS_SYSTEM 0x00008000 696 #define NODE_FLAGS_WRITE_THROUGH 0x00100000 697 #define NODE_XATTR_DIR 0x01000000 698 #define NODE_FLAGS_DELETE_COMMITTED 0x20000000 699 #define NODE_FLAGS_DELETE_ON_CLOSE 0x40000000 700 #define NODE_FLAGS_EXECUTABLE 0x80000000 701 702 #define SMB_NODE_VFS(node) ((node)->vp->v_vfsp) 703 #define SMB_NODE_FSID(node) ((node)->vp->v_vfsp->vfs_fsid) 704 705 /* Maximum buffer size for encryption key */ 706 #define SMB_ENCRYPT_KEY_MAXLEN 32 707 708 #define SMB_SHARE_MAGIC 0x4B534852 /* KSHR */ 709 710 typedef struct smb_kshare { 711 uint32_t shr_magic; 712 avl_node_t shr_link; 713 kmutex_t shr_mutex; 714 kcondvar_t shr_cv; 715 char *shr_name; 716 char *shr_path; 717 char *shr_cmnt; 718 char *shr_container; 719 char *shr_oemname; 720 uint32_t shr_flags; 721 uint32_t shr_type; 722 uint32_t shr_refcnt; 723 uint32_t shr_autocnt; 724 uid_t shr_uid; 725 gid_t shr_gid; 726 char *shr_access_none; 727 char *shr_access_ro; 728 char *shr_access_rw; 729 smb_node_t *shr_root_node; 730 smb_node_t *shr_ca_dir; 731 void *shr_import_busy; 732 smb_cfg_val_t shr_encrypt; /* Share.EncryptData */ 733 } smb_kshare_t; 734 735 736 typedef struct smb_arg_negotiate { 737 char *ni_name; 738 int ni_dialect; 739 int ni_index; 740 uint32_t ni_capabilities; 741 uint16_t ni_maxmpxcount; 742 int16_t ni_tzcorrection; 743 uint8_t ni_keylen; 744 uint8_t ni_key[SMB_ENCRYPT_KEY_MAXLEN]; 745 timestruc_t ni_servertime; 746 } smb_arg_negotiate_t; 747 748 typedef enum { 749 SMB_SSNSETUP_PRE_NTLM012 = 1, 750 SMB_SSNSETUP_NTLM012_NOEXT, 751 SMB_SSNSETUP_NTLM012_EXTSEC 752 } smb_ssnsetup_type_t; 753 754 typedef struct smb_arg_sessionsetup { 755 smb_ssnsetup_type_t ssi_type; 756 char *ssi_user; 757 char *ssi_domain; 758 /* LM password hash, f.k.a. case-insensitive p/w */ 759 uint16_t ssi_lmpwlen; 760 uint8_t *ssi_lmpwd; 761 /* NT password hash, f.k.a. case-sensitive p/w */ 762 uint16_t ssi_ntpwlen; 763 uint8_t *ssi_ntpwd; 764 /* Incoming security blob */ 765 uint16_t ssi_iseclen; 766 uint8_t *ssi_isecblob; 767 /* Incoming security blob */ 768 uint16_t ssi_oseclen; 769 uint8_t *ssi_osecblob; 770 /* parameters */ 771 uint16_t ssi_maxbufsize; 772 uint16_t ssi_maxmpxcount; 773 uint32_t ssi_capabilities; 774 int ssi_native_os; 775 int ssi_native_lm; 776 } smb_arg_sessionsetup_t; 777 778 typedef struct tcon { 779 char *name; 780 char *path; 781 char *service; 782 int pwdlen; 783 char *password; 784 uint16_t flags; 785 uint16_t optional_support; 786 smb_kshare_t *si; 787 } smb_arg_tcon_t; 788 789 /* 790 * Based on section 2.6.1.2 (Connection Management) of the June 13, 791 * 1996 CIFS spec, a server may terminate the transport connection 792 * due to inactivity. The client software is expected to be able to 793 * automatically reconnect to the server if this happens. Like much 794 * of the useful background information, this section appears to 795 * have been dropped from later revisions of the document. 796 * 797 * Each session has an activity timestamp that's updated whenever a 798 * request is dispatched. If the session is idle, i.e. receives no 799 * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be 800 * closed. 801 * 802 * Each session has an I/O semaphore to serialize communication with 803 * the client. For example, after receiving a raw-read request, the 804 * server is not allowed to send an oplock break to the client until 805 * after it has sent the raw-read data. 806 */ 807 #define SMB_SESSION_INACTIVITY_TIMEOUT (15 * 60) 808 809 /* SMB1 signing */ 810 struct smb_sign { 811 unsigned int flags; 812 uint32_t seqnum; 813 uint_t mackey_len; 814 uint8_t *mackey; 815 }; 816 817 /* 818 * SMB2 signing 819 */ 820 struct smb_key { 821 uint_t len; 822 uint8_t key[32]; /* fit AES-256 key */ 823 }; 824 825 #define SMB_SIGNING_ENABLED 1 826 #define SMB_SIGNING_CHECK 2 827 828 /* 829 * Locking notes: 830 * If you hold the mutex/lock on an object, don't flush the deleteq 831 * of the objects directly below it in the logical hierarchy 832 * (i.e. via smb_llist_exit()). I.e. don't drop s_tree_list when 833 * you hold u_mutex, because deleted trees need u_mutex to 834 * lower the refcnt. 835 * 836 * Note that this also applies to u_mutex and t_ofile_list. 837 */ 838 839 /* 840 * The "session" object. 841 * 842 * Note that the smb_session_t object here corresponds to what MS-SMB2 843 * calls a "connection". Adding to the confusion, what MS calls a 844 * "session" corresponds to our smb_user_t (below). 845 */ 846 847 /* 848 * Session State Machine 849 * --------------------- 850 * 851 * 852 * +-----------------------------+ +----------------------------+ 853 * | SMB_SESSION_STATE_CONNECTED | | SMB_SESSION_STATE_SHUTDOWN | 854 * +-----------------------------+ +----------------------------+ 855 * | ^ 856 * | |T6 857 * | +------------------------------+ 858 * | | SMB_SESSION_STATE_TERMINATED | 859 * T0| +------------------------------+ 860 * +--------------------+ ^ 861 * v |T4 |T5 862 * +-------------------------------+ | +--------------------------------+ 863 * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED | 864 * +-------------------------------+ +--------------------------------+ 865 * T1| ^ 866 * +----------+ |T3 867 * v | 868 * +------------------------------+ 869 * | SMB_SESSION_STATE_NEGOTIATED | 870 * +------------------------------+ 871 * 872 * 873 * Transition T0 874 * 875 * 876 * 877 * Transition T1 878 * 879 * 880 * 881 * Transition T2 882 * 883 * 884 * 885 * Transition T3 886 * 887 * 888 * 889 * Transition T4 890 * 891 * 892 * 893 * Transition T5 894 * 895 * 896 * 897 * Transition T6 898 * 899 * 900 * 901 */ 902 #define SMB_SESSION_MAGIC 0x53455353 /* 'SESS' */ 903 #define SMB_SESSION_VALID(p) \ 904 ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC)) 905 906 #define SMB_CHALLENGE_SZ 8 907 #define SMB3_PREAUTH_HASHVAL_SZ 64 908 909 typedef enum { 910 SMB_SESSION_STATE_INITIALIZED = 0, 911 SMB_SESSION_STATE_DISCONNECTED, 912 SMB_SESSION_STATE_CONNECTED, 913 SMB_SESSION_STATE_ESTABLISHED, 914 SMB_SESSION_STATE_NEGOTIATED, 915 SMB_SESSION_STATE_TERMINATED, 916 SMB_SESSION_STATE_SHUTDOWN, 917 SMB_SESSION_STATE_SENTINEL 918 } smb_session_state_t; 919 920 /* Bits in s_flags below */ 921 #define SMB_SSN_AAPL_CCEXT 1 /* Saw "AAPL" create ctx. ext. */ 922 #define SMB_SSN_AAPL_READDIR 2 /* Wants MacOS ext. readdir */ 923 924 typedef struct smb_session { 925 list_node_t s_lnd; 926 uint32_t s_magic; 927 smb_rwx_t s_lock; 928 uint64_t s_kid; 929 smb_session_state_t s_state; 930 uint32_t s_flags; 931 kthread_t *s_thread; 932 kt_did_t s_ktdid; 933 int (*newrq_func)(struct smb_request *); 934 struct smb_server *s_server; 935 smb_kmod_cfg_t s_cfg; 936 int32_t s_gmtoff; 937 uint32_t keep_alive; 938 uint64_t opentime; 939 uint16_t s_local_port; 940 uint16_t s_remote_port; 941 smb_inaddr_t ipaddr; 942 smb_inaddr_t local_ipaddr; 943 int dialect; 944 int native_os; 945 int native_lm; 946 947 kmutex_t s_credits_mutex; 948 uint16_t s_cur_credits; 949 uint16_t s_max_credits; 950 951 uint32_t capabilities; 952 uint32_t srv_cap; 953 954 struct smb_sign signing; /* SMB1 */ 955 void *sign_mech; /* mechanism info */ 956 void *enc_mech; 957 void *preauth_mech; 958 959 /* SMB2/SMB3 signing support */ 960 int (*sign_calc)(struct smb_request *, 961 struct mbuf_chain *, uint8_t *); 962 void (*sign_fini)(struct smb_session *); 963 964 ksocket_t sock; 965 966 smb_slist_t s_req_list; 967 smb_llist_t s_xa_list; 968 smb_llist_t s_user_list; 969 smb_llist_t s_tree_list; 970 smb_idpool_t s_uid_pool; 971 smb_idpool_t s_tid_pool; 972 smb_txlst_t s_txlst; 973 974 volatile uint32_t s_tree_cnt; 975 volatile uint32_t s_file_cnt; 976 volatile uint32_t s_dir_cnt; 977 978 uint16_t cli_secmode; 979 uint16_t srv_secmode; 980 uint32_t sesskey; 981 uint32_t challenge_len; 982 unsigned char challenge_key[SMB_CHALLENGE_SZ]; 983 int64_t activity_timestamp; 984 timeout_id_t s_auth_tmo; 985 986 /* 987 * Maximum negotiated buffer sizes between SMB client and server 988 * in SMB_SESSION_SETUP_ANDX 989 */ 990 int cmd_max_bytes; 991 int reply_max_bytes; 992 uint16_t smb_msg_size; 993 uint16_t smb_max_mpx; 994 smb_srqueue_t *s_srqueue; 995 uint64_t start_time; 996 997 uint16_t smb31_enc_cipherid; 998 uint16_t smb31_preauth_hashid; 999 uint8_t smb31_preauth_hashval[SMB3_PREAUTH_HASHVAL_SZ]; 1000 1001 unsigned char MAC_key[44]; 1002 char ip_addr_str[INET6_ADDRSTRLEN]; 1003 uint8_t clnt_uuid[16]; 1004 char workstation[SMB_PI_MAX_HOST]; 1005 } smb_session_t; 1006 1007 /* 1008 * The "user" object. 1009 * 1010 * Note that smb_user_t object here corresponds to what MS-SMB2 calls 1011 * a "session". (Our smb_session_t is something else -- see above). 1012 */ 1013 1014 #define SMB_USER_MAGIC 0x55534552 /* 'USER' */ 1015 #define SMB_USER_VALID(u) \ 1016 ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC)) 1017 1018 /* These flags are all <= 0x00000010 */ 1019 #define SMB_USER_FLAG_GUEST SMB_ATF_GUEST 1020 #define SMB_USER_FLAG_ANON SMB_ATF_ANON 1021 #define SMB_USER_FLAG_ADMIN SMB_ATF_ADMIN 1022 #define SMB_USER_FLAG_POWER_USER SMB_ATF_POWERUSER 1023 #define SMB_USER_FLAG_BACKUP_OPERATOR SMB_ATF_BACKUPOP 1024 1025 #define SMB_USER_IS_ADMIN(U) (((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0) 1026 #define SMB_USER_IS_GUEST(U) (((U)->u_flags & SMB_USER_FLAG_GUEST) != 0) 1027 1028 /* 1029 * Internal privilege flags derived from smb_privilege.h numbers 1030 * Would rather not include that in this file. 1031 */ 1032 #define SMB_USER_PRIV_SECURITY (1<<8) /* SE_SECURITY_LUID */ 1033 #define SMB_USER_PRIV_TAKE_OWNERSHIP (1<<9) /* SE_TAKE_OWNERSHIP_LUID */ 1034 #define SMB_USER_PRIV_BACKUP (1<<17) /* SE_BACKUP_LUID */ 1035 #define SMB_USER_PRIV_RESTORE (1<<18) /* SE_RESTORE_LUID */ 1036 #define SMB_USER_PRIV_CHANGE_NOTIFY (1<<23) /* SE_CHANGE_NOTIFY_LUID */ 1037 #define SMB_USER_PRIV_READ_FILE (1<<25) /* SE_READ_FILE_LUID */ 1038 #define SMB_USER_PRIV_WRITE_FILE (1<<26) /* SE_WRITE_FILE_LUID */ 1039 1040 /* 1041 * See the long "User State Machine" comment in smb_user.c 1042 */ 1043 typedef enum { 1044 SMB_USER_STATE_LOGGING_ON = 0, 1045 SMB_USER_STATE_LOGGED_ON, 1046 SMB_USER_STATE_LOGGING_OFF, 1047 SMB_USER_STATE_LOGGED_OFF, 1048 SMB_USER_STATE_SENTINEL 1049 } smb_user_state_t; 1050 1051 typedef enum { 1052 SMB2_DH_PRESERVE_NONE = 0, 1053 SMB2_DH_PRESERVE_SOME, 1054 SMB2_DH_PRESERVE_ALL 1055 } smb_preserve_type_t; 1056 1057 typedef struct smb_user { 1058 list_node_t u_lnd; 1059 uint32_t u_magic; 1060 kmutex_t u_mutex; 1061 smb_user_state_t u_state; 1062 1063 struct smb_server *u_server; 1064 smb_session_t *u_session; 1065 ksocket_t u_authsock; 1066 timeout_id_t u_auth_tmo; 1067 uint16_t u_name_len; 1068 char *u_name; 1069 uint16_t u_domain_len; 1070 char *u_domain; 1071 time_t u_logon_time; 1072 cred_t *u_cred; 1073 cred_t *u_privcred; 1074 1075 uint64_t u_ssnid; /* unique server-wide */ 1076 uint32_t u_refcnt; 1077 uint32_t u_flags; 1078 smb_preserve_type_t preserve_opens; 1079 uint32_t u_privileges; 1080 uint16_t u_uid; /* unique per-session */ 1081 uint32_t u_audit_sid; 1082 uint32_t u_owned_tree_cnt; 1083 kcondvar_t u_owned_tree_cv; 1084 1085 uint32_t u_sign_flags; 1086 struct smb_key u_sign_key; /* SMB2 signing */ 1087 1088 struct smb_key u_enc_key; 1089 struct smb_key u_dec_key; 1090 volatile uint64_t u_nonce_cnt; 1091 uint8_t u_nonce_fixed[4]; 1092 uint64_t u_salt; 1093 smb_cfg_val_t u_encrypt; 1094 1095 /* SMB 3.1.1 preauth session hashval */ 1096 uint8_t u_preauth_hashval[SMB3_PREAUTH_HASHVAL_SZ]; 1097 } smb_user_t; 1098 1099 #define SMB_TREE_MAGIC 0x54524545 /* 'TREE' */ 1100 #define SMB_TREE_VALID(p) \ 1101 ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC)) 1102 1103 #define SMB_TYPENAMELEN _ST_FSTYPSZ 1104 #define SMB_VOLNAMELEN 32 1105 1106 #define SMB_TREE_READONLY 0x00000001 1107 #define SMB_TREE_SUPPORTS_ACLS 0x00000002 1108 #define SMB_TREE_STREAMS 0x00000004 1109 #define SMB_TREE_CASEINSENSITIVE 0x00000008 1110 #define SMB_TREE_NO_CASESENSITIVE 0x00000010 1111 #define SMB_TREE_NO_EXPORT 0x00000020 1112 #define SMB_TREE_OPLOCKS 0x00000040 1113 #define SMB_TREE_SHORTNAMES 0x00000080 1114 #define SMB_TREE_XVATTR 0x00000100 1115 #define SMB_TREE_DIRENTFLAGS 0x00000200 1116 #define SMB_TREE_ACLONCREATE 0x00000400 1117 #define SMB_TREE_ACEMASKONACCESS 0x00000800 1118 #define SMB_TREE_NFS_MOUNTED 0x00001000 1119 #define SMB_TREE_UNICODE_ON_DISK 0x00002000 1120 #define SMB_TREE_CATIA 0x00004000 1121 #define SMB_TREE_ABE 0x00008000 1122 #define SMB_TREE_QUOTA 0x00010000 1123 #define SMB_TREE_DFSROOT 0x00020000 1124 #define SMB_TREE_SPARSE 0x00040000 1125 #define SMB_TREE_TRAVERSE_MOUNTS 0x00080000 1126 #define SMB_TREE_FORCE_L2_OPLOCK 0x00100000 1127 #define SMB_TREE_CA 0x00200000 1128 /* Note: SMB_TREE_... in the mdb module too. */ 1129 1130 /* 1131 * See the long "Tree State Machine" comment in smb_tree.c 1132 */ 1133 typedef enum { 1134 SMB_TREE_STATE_CONNECTED = 0, 1135 SMB_TREE_STATE_DISCONNECTING, 1136 SMB_TREE_STATE_DISCONNECTED, 1137 SMB_TREE_STATE_SENTINEL 1138 } smb_tree_state_t; 1139 1140 typedef struct smb_tree { 1141 list_node_t t_lnd; 1142 uint32_t t_magic; 1143 kmutex_t t_mutex; 1144 smb_tree_state_t t_state; 1145 1146 struct smb_server *t_server; 1147 smb_session_t *t_session; 1148 /* 1149 * user whose uid was in the tree connect message 1150 * ("owner" in MS-CIFS parlance, see section 2.2.1.6 definition of FID) 1151 */ 1152 smb_user_t *t_owner; 1153 smb_node_t *t_snode; 1154 1155 smb_lavl_t t_ofile_list; 1156 smb_idpool_t t_fid_pool; 1157 1158 smb_llist_t t_odir_list; 1159 smb_idpool_t t_odid_pool; 1160 1161 uint32_t t_refcnt; 1162 uint32_t t_flags; 1163 int32_t t_res_type; 1164 uint16_t t_tid; 1165 uint16_t t_umask; 1166 char t_sharename[MAXNAMELEN]; 1167 char t_resource[MAXPATHLEN]; 1168 char t_typename[SMB_TYPENAMELEN]; 1169 char t_volume[SMB_VOLNAMELEN]; 1170 acl_type_t t_acltype; 1171 uint32_t t_access; 1172 uint32_t t_execflags; 1173 time_t t_connect_time; 1174 volatile uint32_t t_open_files; 1175 smb_cfg_val_t t_encrypt; /* Share.EncryptData */ 1176 timestruc_t t_create_time; 1177 } smb_tree_t; 1178 1179 #define SMB_TREE_VFS(tree) ((tree)->t_snode->vp->v_vfsp) 1180 #define SMB_TREE_FSID(tree) ((tree)->t_snode->vp->v_vfsp->vfs_fsid) 1181 1182 #define SMB_TREE_IS_READONLY(sr) \ 1183 ((sr) != NULL && (sr)->tid_tree != NULL && \ 1184 !((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS)) 1185 1186 #define SMB_TREE_IS_CASEINSENSITIVE(sr) \ 1187 (((sr) && (sr)->tid_tree) ? \ 1188 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0) 1189 1190 #define SMB_TREE_HAS_ACCESS(sr, acemask) \ 1191 ((sr) == NULL ? ACE_ALL_PERMS : ( \ 1192 (((sr) && (sr)->tid_tree) ? \ 1193 (((sr)->tid_tree->t_access) & (acemask)) : 0))) 1194 1195 #define SMB_TREE_SUPPORTS_CATIA(sr) \ 1196 (((sr) && (sr)->tid_tree) ? \ 1197 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0) 1198 1199 #define SMB_TREE_SUPPORTS_ABE(sr) \ 1200 (((sr) && (sr)->tid_tree) ? \ 1201 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0) 1202 1203 #define SMB_TREE_IS_DFSROOT(sr) \ 1204 (((sr) && (sr)->tid_tree) ? \ 1205 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0) 1206 1207 #define SMB_TREE_SUPPORTS_SHORTNAMES(sr) \ 1208 (((sr) && (sr)->tid_tree) ? \ 1209 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0) 1210 1211 /* 1212 * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same 1213 * file system as the tree's root filesystem, or if mount point traversal 1214 * should be allowed. Note that this is also called in some cases with 1215 * sr=NULL, where it is expected to evaluate to TRUE. 1216 */ 1217 1218 #define SMB_TREE_CONTAINS_NODE(sr, node) \ 1219 ((sr) == NULL || (sr)->tid_tree == NULL || \ 1220 SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) || \ 1221 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS)) 1222 1223 /* 1224 * SMB_PATHFILE_IS_READONLY indicates whether or not a file is 1225 * readonly when the caller has a path rather than an ofile. 1226 */ 1227 #define SMB_PATHFILE_IS_READONLY(sr, node) \ 1228 (SMB_TREE_IS_READONLY((sr)) || \ 1229 smb_node_file_is_readonly((node))) 1230 1231 #define SMB_ODIR_MAGIC 0x4F444952 /* 'ODIR' */ 1232 #define SMB_ODIR_VALID(p) \ 1233 ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC)) 1234 1235 #define SMB_ODIR_BUFSIZE (8 * 1024) 1236 1237 /* smb_odir_t d_flags */ 1238 #define SMB_ODIR_FLAG_WILDCARDS 0x0001 1239 #define SMB_ODIR_FLAG_IGNORE_CASE 0x0002 1240 #define SMB_ODIR_FLAG_XATTR 0x0004 1241 #define SMB_ODIR_FLAG_EDIRENT 0x0008 1242 #define SMB_ODIR_FLAG_CATIA 0x0010 1243 #define SMB_ODIR_FLAG_ABE 0x0020 1244 #define SMB_ODIR_FLAG_SHORTNAMES 0x0040 1245 #define SMB_ODIR_FLAG_RESTRICTED 0x0080 1246 #define SMB_ODIR_FLAG_ACEACCESS 0x0100 1247 1248 typedef enum { 1249 SMB_ODIR_STATE_OPEN = 0, 1250 SMB_ODIR_STATE_IN_USE, 1251 SMB_ODIR_STATE_CLOSING, 1252 SMB_ODIR_STATE_CLOSED, 1253 SMB_ODIR_STATE_SENTINEL 1254 } smb_odir_state_t; 1255 1256 typedef enum { 1257 SMB_ODIR_RESUME_CONT, 1258 SMB_ODIR_RESUME_IDX, 1259 SMB_ODIR_RESUME_COOKIE, 1260 SMB_ODIR_RESUME_FNAME 1261 } smb_odir_resume_type_t; 1262 1263 typedef struct smb_odir_resume { 1264 smb_odir_resume_type_t or_type; 1265 int or_idx; 1266 uint32_t or_cookie; 1267 char *or_fname; 1268 } smb_odir_resume_t; 1269 1270 /* 1271 * Flags used when opening an odir 1272 */ 1273 #define SMB_ODIR_OPENF_BACKUP_INTENT 0x01 1274 1275 typedef struct smb_odir { 1276 list_node_t d_lnd; 1277 uint32_t d_magic; 1278 kmutex_t d_mutex; 1279 smb_odir_state_t d_state; 1280 smb_session_t *d_session; 1281 smb_user_t *d_user; 1282 smb_tree_t *d_tree; 1283 smb_node_t *d_dnode; 1284 cred_t *d_cred; 1285 uint32_t d_opened_by_pid; 1286 uint16_t d_odid; 1287 uint16_t d_sattr; 1288 uint32_t d_refcnt; 1289 uint32_t d_flags; 1290 boolean_t d_eof; 1291 int d_bufsize; 1292 uint64_t d_offset; 1293 union { 1294 char *u_bufptr; 1295 struct edirent *u_edp; 1296 struct dirent64 *u_dp; 1297 } d_u; 1298 uint32_t d_last_cookie; 1299 uint32_t d_cookies[SMB_MAX_SEARCH]; 1300 char d_pattern[MAXNAMELEN]; 1301 char d_buf[SMB_ODIR_BUFSIZE]; 1302 char d_last_name[MAXNAMELEN]; 1303 } smb_odir_t; 1304 #define d_bufptr d_u.u_bufptr 1305 #define d_edp d_u.u_edp 1306 #define d_dp d_u.u_dp 1307 1308 typedef struct smb_odirent { 1309 char od_name[MAXNAMELEN]; /* on disk name */ 1310 ino64_t od_ino; 1311 uint32_t od_eflags; 1312 } smb_odirent_t; 1313 1314 #define SMB_OPIPE_MAGIC 0x50495045 /* 'PIPE' */ 1315 #define SMB_OPIPE_VALID(p) \ 1316 ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC) 1317 #define SMB_OPIPE_MAXNAME 32 1318 1319 /* 1320 * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used 1321 * at the interface between SMB and NDR RPC. 1322 */ 1323 typedef struct smb_opipe { 1324 uint32_t p_magic; 1325 kmutex_t p_mutex; 1326 kcondvar_t p_cv; 1327 struct smb_ofile *p_ofile; 1328 struct smb_server *p_server; 1329 uint32_t p_refcnt; 1330 ksocket_t p_socket; 1331 /* This is the "flat" name, without path prefix */ 1332 char p_name[SMB_OPIPE_MAXNAME]; 1333 } smb_opipe_t; 1334 1335 /* 1336 * The of_ftype of an open file should contain the SMB_FTYPE value 1337 * returned when the file/pipe was opened. The following 1338 * assumptions are currently made: 1339 * 1340 * File Type Node PipeInfo 1341 * --------- -------- -------- 1342 * SMB_FTYPE_DISK Valid Null 1343 * SMB_FTYPE_BYTE_PIPE Undefined Undefined 1344 * SMB_FTYPE_MESG_PIPE Null Valid 1345 * SMB_FTYPE_PRINTER Undefined Undefined 1346 * SMB_FTYPE_UNKNOWN Undefined Undefined 1347 */ 1348 1349 /* 1350 * Some flags for ofile structure 1351 * 1352 * SMB_OFLAGS_SET_DELETE_ON_CLOSE 1353 * Set this flag when the corresponding open operation whose 1354 * DELETE_ON_CLOSE bit of the CreateOptions is set. If any 1355 * open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE 1356 * will be set for the file node upon close. 1357 */ 1358 1359 /* SMB_OFLAGS_READONLY 0x0001 (obsolete) */ 1360 #define SMB_OFLAGS_EXECONLY 0x0002 1361 #define SMB_OFLAGS_SET_DELETE_ON_CLOSE 0x0004 1362 #define SMB_OFLAGS_LLF_POS_VALID 0x0008 1363 1364 #define SMB_OFILE_MAGIC 0x4F464C45 /* 'OFLE' */ 1365 #define SMB_OFILE_VALID(p) \ 1366 ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC)) 1367 1368 /* 1369 * This is the size of the per-handle "Lock Sequence" array. 1370 * See LockSequenceIndex in [MS-SMB2] 2.2.26, and smb2_lock.c 1371 */ 1372 #define SMB_OFILE_LSEQ_MAX 64 1373 1374 /* {arg_open,ofile}->dh_vers values */ 1375 typedef enum { 1376 SMB2_NOT_DURABLE = 0, 1377 SMB2_DURABLE_V1, 1378 SMB2_DURABLE_V2, 1379 SMB2_RESILIENT, 1380 } smb_dh_vers_t; 1381 1382 /* 1383 * See the long "Ofile State Machine" comment in smb_ofile.c 1384 */ 1385 typedef enum { 1386 SMB_OFILE_STATE_ALLOC = 0, 1387 SMB_OFILE_STATE_OPEN, 1388 SMB_OFILE_STATE_SAVE_DH, 1389 SMB_OFILE_STATE_SAVING, 1390 SMB_OFILE_STATE_CLOSING, 1391 SMB_OFILE_STATE_CLOSED, 1392 SMB_OFILE_STATE_ORPHANED, 1393 SMB_OFILE_STATE_RECONNECT, 1394 SMB_OFILE_STATE_EXPIRED, 1395 SMB_OFILE_STATE_SENTINEL 1396 } smb_ofile_state_t; 1397 1398 typedef struct smb_ofile { 1399 uint16_t f_fid; /* keep first */ 1400 uint16_t f_ftype; 1401 uint32_t f_magic; 1402 avl_node_t f_tree_lnd; /* t_ofile_list */ 1403 list_node_t f_node_lnd; /* n_ofile_list */ 1404 list_node_t f_dh_lnd; /* sv_persistid_ht */ 1405 kmutex_t f_mutex; 1406 smb_ofile_state_t f_state; 1407 1408 struct smb_server *f_server; 1409 smb_session_t *f_session; 1410 smb_user_t *f_user; 1411 smb_tree_t *f_tree; 1412 smb_node_t *f_node; 1413 smb_odir_t *f_odir; 1414 smb_opipe_t *f_pipe; 1415 1416 kcondvar_t f_cv; 1417 /* 1418 * Note: f_persistid == 0 means this ofile has no persistid 1419 * (same interpretation at the protocol level). IFF non-zero, 1420 * this ofile is linked in the sv_persistid_ht hash table. 1421 */ 1422 uint64_t f_persistid; 1423 uint32_t f_uniqid; 1424 uint32_t f_refcnt; 1425 uint64_t f_seek_pos; 1426 uint32_t f_flags; 1427 uint32_t f_granted_access; 1428 uint32_t f_share_access; 1429 uint32_t f_create_options; 1430 uint32_t f_opened_by_pid; 1431 uint64_t f_llf_pos; 1432 int f_mode; 1433 cred_t *f_cr; 1434 pid_t f_pid; 1435 smb_attr_t f_pending_attr; 1436 boolean_t f_written; 1437 smb_oplock_grant_t f_oplock; 1438 boolean_t f_oplock_closing; 1439 uint8_t TargetOplockKey[SMB_LEASE_KEY_SZ]; 1440 uint8_t ParentOplockKey[SMB_LEASE_KEY_SZ]; 1441 struct smb_lease *f_lease; 1442 1443 smb_notify_t f_notify; 1444 1445 smb_dh_vers_t dh_vers; 1446 hrtime_t dh_timeout_offset; /* time offset for timeout */ 1447 hrtime_t dh_expire_time; /* time the handle expires */ 1448 boolean_t dh_persist; 1449 kmutex_t dh_nvlock; 1450 struct nvlist *dh_nvlist; 1451 smb_node_t *dh_nvfile; 1452 1453 uint8_t dh_create_guid[16]; 1454 char f_quota_resume[SMB_SID_STRSZ]; 1455 uint8_t f_lock_seq[SMB_OFILE_LSEQ_MAX]; 1456 } smb_ofile_t; 1457 1458 typedef struct smb_fileinfo { 1459 char fi_name[MAXNAMELEN]; 1460 char fi_shortname[SMB_SHORTNAMELEN]; 1461 uint32_t fi_cookie; /* Dir offset (of next entry) */ 1462 uint32_t fi_dosattr; /* DOS attributes */ 1463 uint64_t fi_nodeid; /* file system node id */ 1464 uint64_t fi_size; /* file size in bytes */ 1465 uint64_t fi_alloc_size; /* allocation size in bytes */ 1466 timestruc_t fi_atime; /* last access */ 1467 timestruc_t fi_mtime; /* last modification */ 1468 timestruc_t fi_ctime; /* last status change */ 1469 timestruc_t fi_crtime; /* file creation */ 1470 } smb_fileinfo_t; 1471 1472 typedef struct smb_streaminfo { 1473 uint64_t si_size; 1474 uint64_t si_alloc_size; 1475 char si_name[MAXPATHLEN]; 1476 } smb_streaminfo_t; 1477 1478 #define SMB_LOCK_MAGIC 0x4C4F434B /* 'LOCK' */ 1479 1480 typedef struct smb_lock { 1481 list_node_t l_lnd; 1482 uint32_t l_magic; 1483 kmutex_t l_mutex; 1484 kcondvar_t l_cv; 1485 1486 smb_ofile_t *l_file; 1487 1488 struct smb_lock *l_blocked_by; /* Debug info only */ 1489 1490 uint32_t l_conflicts; 1491 uint32_t l_flags; 1492 uint32_t l_pid; 1493 uint32_t l_type; 1494 uint64_t l_start; 1495 uint64_t l_length; 1496 clock_t l_end_time; 1497 } smb_lock_t; 1498 1499 #define SMB_LOCK_FLAG_INDEFINITE 0x0004 1500 #define SMB_LOCK_FLAG_CLOSED 0x0008 1501 #define SMB_LOCK_FLAG_CANCELLED 0x0010 1502 1503 #define SMB_LOCK_TYPE_READWRITE 101 1504 #define SMB_LOCK_TYPE_READONLY 102 1505 1506 typedef struct vardata_block { 1507 uint8_t vdb_tag; 1508 uint32_t vdb_len; 1509 struct uio vdb_uio; 1510 struct iovec vdb_iovec[MAX_IOVEC]; 1511 } smb_vdb_t; 1512 1513 #define SMB_WRMODE_WRITE_THRU 0x0001 1514 #define SMB_WRMODE_IS_STABLE(M) ((M) & SMB_WRMODE_WRITE_THRU) 1515 1516 #define SMB_RW_MAGIC 0x52445257 /* 'RDRW' */ 1517 1518 typedef struct smb_rw_param { 1519 uint32_t rw_magic; 1520 smb_vdb_t rw_vdb; 1521 uint64_t rw_offset; 1522 uint32_t rw_last_write; 1523 uint16_t rw_mode; 1524 uint32_t rw_count; /* bytes in this request */ 1525 uint16_t rw_mincnt; 1526 uint32_t rw_total; /* total bytes (write-raw) */ 1527 uint16_t rw_dsoff; /* SMB data offset */ 1528 uint8_t rw_andx; /* SMB secondary andx command */ 1529 } smb_rw_param_t; 1530 1531 typedef struct smb_pathname { 1532 char *pn_path; 1533 char *pn_pname; 1534 char *pn_fname; 1535 char *pn_sname; 1536 char *pn_stype; 1537 } smb_pathname_t; 1538 1539 /* 1540 * fs_query_info 1541 */ 1542 typedef struct smb_fqi { 1543 smb_pathname_t fq_path; 1544 uint16_t fq_sattr; 1545 smb_node_t *fq_dnode; 1546 smb_node_t *fq_fnode; 1547 smb_attr_t fq_fattr; 1548 char fq_last_comp[MAXNAMELEN]; 1549 } smb_fqi_t; 1550 1551 typedef struct dirop { 1552 smb_fqi_t fqi; 1553 smb_fqi_t dst_fqi; 1554 uint16_t info_level; 1555 uint16_t flags; 1556 } smb_arg_dirop_t; 1557 1558 typedef struct smb_queryinfo { 1559 smb_node_t *qi_node; /* NULL for pipes */ 1560 uint8_t qi_InfoType; 1561 uint8_t qi_InfoClass; 1562 uint8_t qi_delete_on_close; 1563 uint8_t qi_isdir; 1564 uint32_t qi_AddlInfo; 1565 uint32_t qi_Flags; 1566 mbuf_chain_t in_data; 1567 smb_attr_t qi_attr; 1568 uint32_t qi_namelen; 1569 char qi_shortname[SMB_SHORTNAMELEN]; 1570 char qi_name[MAXPATHLEN]; 1571 } smb_queryinfo_t; 1572 1573 typedef struct smb_setinfo { 1574 smb_node_t *si_node; 1575 mbuf_chain_t si_data; 1576 smb_attr_t si_attr; 1577 } smb_setinfo_t; 1578 1579 /* 1580 * smb_fssize_t 1581 * volume_units and volume avail are the total allocated and 1582 * available units on the volume. 1583 * caller_units and caller_avail are the allocated and available 1584 * units on the volume for the user associated with the calling 1585 * thread. 1586 */ 1587 typedef struct smb_fssize { 1588 uint64_t fs_volume_units; 1589 uint64_t fs_volume_avail; 1590 uint64_t fs_caller_units; 1591 uint64_t fs_caller_avail; 1592 uint32_t fs_sectors_per_unit; 1593 uint32_t fs_bytes_per_sector; 1594 } smb_fssize_t; 1595 1596 /* 1597 * SMB FsCtl operations (SMB2 Ioctl, and some SMB1 trans calls) 1598 */ 1599 typedef struct { 1600 uint32_t CtlCode; 1601 uint32_t InputCount; 1602 uint32_t OutputCount; 1603 uint32_t MaxOutputResp; 1604 mbuf_chain_t *in_mbc; 1605 mbuf_chain_t *out_mbc; 1606 } smb_fsctl_t; 1607 1608 typedef struct { 1609 uint64_t persistent; 1610 uint64_t temporal; 1611 } smb2fid_t; 1612 1613 typedef struct { 1614 uint32_t status; 1615 uint16_t errcls; 1616 uint16_t errcode; 1617 } smb_error_t; 1618 1619 typedef struct open_param { 1620 smb_fqi_t fqi; 1621 uint16_t omode; 1622 uint16_t ofun; 1623 uint32_t nt_flags; 1624 uint32_t timeo; 1625 uint32_t dattr; 1626 timestruc_t crtime; 1627 timestruc_t mtime; 1628 timestruc_t timewarp; 1629 /* 1630 * Careful: dsize is the desired (allocation) size before the 1631 * common open function, and the actual size afterwards. 1632 */ 1633 uint64_t dsize; /* alloc size, actual size */ 1634 uint32_t desired_access; 1635 uint32_t maximum_access; 1636 uint32_t share_access; 1637 uint32_t create_options; 1638 uint32_t create_disposition; 1639 boolean_t create_timewarp; 1640 boolean_t created_readonly; 1641 uint32_t ftype; 1642 uint32_t devstate; 1643 uint32_t action_taken; 1644 uint64_t fileid; 1645 uint32_t rootdirfid; 1646 fsid_t op_fsid; 1647 smb_ofile_t *dir; 1648 smb_opipe_t *pipe; /* for smb_opipe_open */ 1649 struct smb_sd *sd; /* for NTTransactCreate */ 1650 void *create_ctx; 1651 1652 uint8_t op_oplock_level; /* requested/granted level */ 1653 uint32_t op_oplock_state; /* internal type+level */ 1654 uint32_t lease_state; /* SMB2_LEASE_... */ 1655 uint32_t lease_flags; 1656 uint16_t lease_epoch; 1657 uint16_t lease_version; /* 1 or 2 */ 1658 uint8_t lease_key[SMB_LEASE_KEY_SZ]; /* from client */ 1659 uint8_t parent_lease_key[SMB_LEASE_KEY_SZ]; /* for V2 */ 1660 1661 smb_dh_vers_t dh_vers; 1662 smb2fid_t dh_fileid; /* for durable reconnect */ 1663 uint8_t create_guid[16]; 1664 uint32_t dh_v2_flags; 1665 uint32_t dh_timeout; 1666 } smb_arg_open_t; 1667 1668 typedef struct smb_arg_lock { 1669 void *lvec; 1670 uint32_t lcnt; 1671 uint32_t lseq; 1672 } smb_arg_lock_t; 1673 1674 typedef struct smb_arg_olbrk { 1675 uint32_t NewLevel; 1676 uint32_t OldLevel; 1677 boolean_t AckRequired; 1678 uint8_t LeaseKey[SMB_LEASE_KEY_SZ]; 1679 } smb_arg_olbrk_t; 1680 1681 /* 1682 * SMB Request State Machine 1683 * ------------------------- 1684 * 1685 * T4 +------+ T0 1686 * +--------------------------->| FREE |---------------------------+ 1687 * | +------+ | 1688 * +-----------+ | 1689 * | COMPLETED | | 1690 * +-----------+ 1691 * ^ | 1692 * | T15 +-----------+ v 1693 * +------------+ T6 | | +--------------+ 1694 * | CLEANED_UP |<-----------------| CANCELLED | | INITIALIZING | 1695 * +------------+ | | +--------------+ 1696 * | ^ +-----------+ | 1697 * | | ^ ^ ^ ^ | 1698 * | | +-------------+ | | | | 1699 * | | T3 | | | | T13 | T1 1700 * | +-------------------------+ | | +----------------------+ | 1701 * +----------------------------+ | | | | | 1702 * T16 | | | | +-----------+ | | 1703 * | \/ | | T5 | | v 1704 * +-----------------+ | T12 +--------+ | T2 +-----------+ 1705 * | EVENT_OCCURRED |------------->| ACTIVE |<--------------------| SUBMITTED | 1706 * +-----------------+ | +--------+ | +-----------+ 1707 * ^ | | ^ | | 1708 * | | T8 | | | T7 | 1709 * | T10 T9 | +----------+ | +-------+ | T11 1710 * | | | +-------+ | | 1711 * | | | T14 | | | 1712 * | | v | v | 1713 * +----------------------+ +--------------+ 1714 * | WAITING_EVENT | | WAITING_LOCK | 1715 * +----------------------+ +--------------+ 1716 * 1717 * 1718 * 1719 * 1720 * 1721 * Transition T0 1722 * 1723 * This transition occurs when the request is allocated and is still under the 1724 * control of the session thread. 1725 * 1726 * Transition T1 1727 * 1728 * This transition occurs when the session thread dispatches a task to treat the 1729 * request. 1730 * 1731 * Transition T2 1732 * 1733 * 1734 * 1735 * Transition T3 1736 * 1737 * A request completes and smbsr_cleanup is called to release resources 1738 * associated with the request (but not the smb_request_t itself). This 1739 * includes references on smb_ofile_t, smb_node_t, and other structures. 1740 * CLEANED_UP state exists to detect if we attempt to cleanup a request 1741 * multiple times and to allow us to detect that we are accessing a 1742 * request that has already been cleaned up. 1743 * 1744 * Transition T4 1745 * 1746 * 1747 * 1748 * Transition T5 1749 * 1750 * 1751 * 1752 * Transition T6 1753 * 1754 * 1755 * 1756 * Transition T7 1757 * 1758 * 1759 * 1760 * Transition T8 1761 * 1762 * 1763 * 1764 * Transition T9 1765 * 1766 * 1767 * 1768 * Transition T10 1769 * 1770 * 1771 * 1772 * Transition T11 1773 * 1774 * 1775 * 1776 * Transition T12 1777 * 1778 * 1779 * 1780 * Transition T13 1781 * 1782 * 1783 * 1784 * Transition T14 1785 * 1786 * 1787 * 1788 * Transition T15 1789 * 1790 * Request processing is completed (control returns from smb_dispatch) 1791 * 1792 * Transition T16 1793 * 1794 * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx" 1795 * sections remain to be processed. 1796 * 1797 */ 1798 1799 #define SMB_REQ_MAGIC 0x534D4252 /* 'SMBR' */ 1800 #define SMB_REQ_VALID(p) ASSERT((p)->sr_magic == SMB_REQ_MAGIC) 1801 1802 typedef enum smb_req_state { 1803 SMB_REQ_STATE_FREE = 0, 1804 SMB_REQ_STATE_INITIALIZING, 1805 SMB_REQ_STATE_SUBMITTED, 1806 SMB_REQ_STATE_ACTIVE, 1807 SMB_REQ_STATE_WAITING_AUTH, 1808 SMB_REQ_STATE_WAITING_FCN1, 1809 SMB_REQ_STATE_WAITING_FCN2, 1810 SMB_REQ_STATE_WAITING_LOCK, 1811 SMB_REQ_STATE_WAITING_PIPE, 1812 SMB_REQ_STATE_WAITING_OLBRK, 1813 SMB_REQ_STATE_COMPLETED, 1814 SMB_REQ_STATE_CANCEL_PENDING, 1815 SMB_REQ_STATE_CANCELLED, 1816 SMB_REQ_STATE_CLEANED_UP, 1817 SMB_REQ_STATE_SENTINEL 1818 } smb_req_state_t; 1819 1820 typedef struct smb_request { 1821 list_node_t sr_session_lnd; 1822 uint32_t sr_magic; 1823 kmutex_t sr_mutex; 1824 smb_req_state_t sr_state; 1825 struct smb_server *sr_server; 1826 pid_t *sr_pid; 1827 int32_t sr_gmtoff; 1828 smb_session_t *session; 1829 smb_kmod_cfg_t *sr_cfg; 1830 void (*cancel_method)(struct smb_request *); 1831 void *cancel_arg2; 1832 1833 /* Queue used by smb_request_append_postwork. */ 1834 struct smb_request *sr_postwork; 1835 1836 list_node_t sr_waiters; /* smb_notify.c */ 1837 1838 struct mbuf_chain command; 1839 struct mbuf_chain reply; 1840 struct mbuf_chain raw_data; 1841 list_t sr_storage; 1842 struct smb_xa *r_xa; 1843 int andx_prev_wct; 1844 int cur_reply_offset; 1845 int orig_request_hdr; 1846 unsigned int reply_seqnum; /* reply sequence number */ 1847 unsigned char first_smb_com; /* command code */ 1848 unsigned char smb_com; /* command code */ 1849 1850 uint8_t smb_rcls; /* error code class */ 1851 uint8_t smb_reh; /* rsvd (AH DOS INT-24 ERR) */ 1852 uint16_t smb_err; /* error code */ 1853 smb_error_t smb_error; 1854 1855 uint8_t smb_flg; /* flags */ 1856 uint16_t smb_flg2; /* flags */ 1857 unsigned char smb_sig[8]; /* signiture */ 1858 uint16_t smb_tid; /* tree id # */ 1859 uint32_t smb_pid; /* caller's process id # */ 1860 uint16_t smb_uid; /* local (smb1) user id # */ 1861 uint16_t smb_mid; /* mutiplex id # */ 1862 unsigned char smb_wct; /* count of parameter words */ 1863 uint16_t smb_bcc; /* data byte count */ 1864 1865 /* 1866 * Beginning offsets (in the mbuf chain) for the 1867 * command and reply headers, and the next reply. 1868 */ 1869 uint32_t smb2_cmd_hdr; 1870 uint32_t smb2_reply_hdr; 1871 uint32_t smb2_next_reply; 1872 1873 /* 1874 * SMB2 header fields. [MS-SMB2 2.2.1.2] 1875 * XXX: Later do a union w smb1 members 1876 */ 1877 uint16_t smb2_credit_charge; 1878 uint16_t smb2_chan_seq; /* cmd only */ 1879 uint32_t smb2_status; 1880 uint16_t smb2_cmd_code; 1881 uint16_t smb2_credit_request; 1882 uint16_t smb2_credit_response; 1883 uint16_t smb2_total_credits; /* in compound */ 1884 uint32_t smb2_hdr_flags; 1885 uint32_t smb2_next_command; 1886 uint64_t smb2_messageid; 1887 uint64_t smb2_first_msgid; 1888 /* uint32_t smb2_pid; use smb_pid */ 1889 /* uint32_t smb2_tid; use smb_tid */ 1890 uint64_t smb2_ssnid; /* See u_ssnid */ 1891 uint8_t smb2_sig[16]; /* signature */ 1892 1893 /* 1894 * SMB3 transform header fields. [MS-SMB2 2.2.41] 1895 */ 1896 uint64_t th_ssnid; 1897 smb_user_t *th_sid_user; 1898 uint32_t th_msglen; 1899 uint8_t th_nonce[16]; 1900 1901 boolean_t encrypted; 1902 boolean_t dh_nvl_dirty; 1903 1904 boolean_t smb2_async; 1905 uint64_t smb2_async_id; 1906 /* Parameters */ 1907 struct mbuf_chain smb_vwv; /* variable width value */ 1908 1909 /* Data */ 1910 struct mbuf_chain smb_data; 1911 1912 uint16_t smb_fid; /* not in hdr, but common */ 1913 1914 unsigned char andx_com; 1915 uint16_t andx_off; 1916 1917 struct smb_tree *tid_tree; 1918 struct smb_ofile *fid_ofile; 1919 smb_user_t *uid_user; 1920 1921 cred_t *user_cr; 1922 kthread_t *sr_worker; 1923 hrtime_t sr_time_submitted; 1924 hrtime_t sr_time_active; 1925 hrtime_t sr_time_start; 1926 int32_t sr_txb; 1927 uint32_t sr_seqnum; 1928 1929 union { 1930 smb_arg_negotiate_t *negprot; 1931 smb_arg_sessionsetup_t *ssetup; 1932 smb_arg_tcon_t tcon; 1933 smb_arg_dirop_t dirop; 1934 smb_arg_open_t open; 1935 smb_arg_lock_t lock; 1936 smb_arg_olbrk_t olbrk; /* for async oplock break */ 1937 smb_rw_param_t *rw; 1938 int32_t timestamp; 1939 void *other; 1940 } arg; 1941 } smb_request_t; 1942 1943 #define sr_ssetup arg.ssetup 1944 #define sr_negprot arg.negprot 1945 #define sr_tcon arg.tcon 1946 #define sr_dirop arg.dirop 1947 #define sr_open arg.open 1948 #define sr_rw arg.rw 1949 #define sr_timestamp arg.timestamp 1950 1951 #define SMB_READ_PROTOCOL(hdr) \ 1952 LE_IN32(((smb_hdr_t *)(hdr))->protocol) 1953 1954 #define SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \ 1955 (SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC) 1956 1957 #define SMB_READ_COMMAND(hdr) \ 1958 (((smb_hdr_t *)(hdr))->command) 1959 1960 #define SMB_IS_NT_CANCEL(rd_sr) \ 1961 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL) 1962 1963 #define SMB_IS_SESSION_SETUP_ANDX(rd_sr) \ 1964 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \ 1965 SMB_COM_SESSION_SETUP_ANDX) 1966 1967 #define SMB_IS_NT_NEGOTIATE(rd_sr) \ 1968 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE) 1969 1970 #define SMB_IS_TREE_CONNECT_ANDX(rd_sr) \ 1971 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX) 1972 1973 #define SMB_XA_FLAG_OPEN 0x0001 1974 #define SMB_XA_FLAG_CLOSE 0x0002 1975 #define SMB_XA_FLAG_COMPLETE 0x0004 1976 #define SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN)) 1977 1978 #define SMB_XA_MAGIC 0x534D4258 /* 'SMBX' */ 1979 1980 typedef struct smb_xa { 1981 list_node_t xa_lnd; 1982 uint32_t xa_magic; 1983 kmutex_t xa_mutex; 1984 1985 uint32_t xa_refcnt; 1986 uint32_t xa_flags; 1987 1988 struct smb_session *xa_session; 1989 1990 unsigned char smb_com; /* which TRANS type */ 1991 unsigned char smb_flg; /* flags */ 1992 uint16_t smb_flg2; /* flags */ 1993 uint16_t smb_tid; /* tree id number */ 1994 uint32_t smb_pid; /* caller's process id */ 1995 uint16_t smb_uid; /* user id number */ 1996 uint32_t smb_func; /* NT_TRANS function */ 1997 1998 uint16_t xa_smb_mid; /* mutiplex id number */ 1999 uint16_t xa_smb_fid; /* TRANS2 secondary */ 2000 2001 unsigned int reply_seqnum; /* reply sequence number */ 2002 2003 uint32_t smb_tpscnt; /* total parameter bytes being sent */ 2004 uint32_t smb_tdscnt; /* total data bytes being sent */ 2005 uint32_t smb_mprcnt; /* max parameter bytes to return */ 2006 uint32_t smb_mdrcnt; /* max data bytes to return */ 2007 uint32_t smb_msrcnt; /* max setup words to return */ 2008 uint32_t smb_flags; /* additional information: */ 2009 /* bit 0 - if set, disconnect TID in smb_tid */ 2010 /* bit 1 - if set, transaction is one way */ 2011 /* (no final response) */ 2012 int32_t smb_timeout; /* number of milliseconds to await completion */ 2013 uint32_t smb_suwcnt; /* set up word count */ 2014 2015 char *xa_pipe_name; 2016 2017 /* 2018 * These are the param and data count received so far, 2019 * used to decide if the whole trans is here yet. 2020 */ 2021 int req_disp_param; 2022 int req_disp_data; 2023 2024 struct mbuf_chain req_setup_mb; 2025 struct mbuf_chain req_param_mb; 2026 struct mbuf_chain req_data_mb; 2027 2028 struct mbuf_chain rep_setup_mb; 2029 struct mbuf_chain rep_param_mb; 2030 struct mbuf_chain rep_data_mb; 2031 } smb_xa_t; 2032 2033 2034 #define SDDF_NO_FLAGS 0 2035 #define SDDF_SUPPRESS_TID 0x0001 2036 #define SDDF_SUPPRESS_UID 0x0002 2037 2038 /* 2039 * SMB dispatch return codes. 2040 */ 2041 typedef enum { 2042 SDRC_SUCCESS = 0, 2043 SDRC_ERROR, 2044 SDRC_DROP_VC, 2045 SDRC_NO_REPLY, 2046 SDRC_SR_KEPT, 2047 SDRC_NOT_IMPLEMENTED 2048 } smb_sdrc_t; 2049 2050 #define VAR_BCC ((short)-1) 2051 2052 #define SMB_SERVER_MAGIC 0x53534552 /* 'SSER' */ 2053 #define SMB_SERVER_VALID(s) \ 2054 ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC)) 2055 2056 #define SMB_LISTENER_MAGIC 0x4C53544E /* 'LSTN' */ 2057 #define SMB_LISTENER_VALID(ld) \ 2058 ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC)) 2059 2060 typedef struct { 2061 uint32_t ld_magic; 2062 struct smb_server *ld_sv; 2063 smb_thread_t ld_thread; 2064 ksocket_t ld_so; 2065 in_port_t ld_port; 2066 int ld_family; 2067 struct sockaddr_in ld_sin; 2068 struct sockaddr_in6 ld_sin6; 2069 clock_t ld_quiet; 2070 } smb_listener_daemon_t; 2071 2072 #define SMB_SSETUP_CMD "authentication" 2073 #define SMB_TCON_CMD "share mapping" 2074 #define SMB_OPIPE_CMD "pipe open" 2075 #define SMB_THRESHOLD_REPORT_THROTTLE 50 2076 typedef struct smb_cmd_threshold { 2077 char *ct_cmd; 2078 kmutex_t ct_mutex; 2079 volatile uint32_t ct_active_cnt; 2080 volatile uint32_t ct_blocked_cnt; 2081 uint32_t ct_threshold; 2082 uint32_t ct_timeout; /* milliseconds */ 2083 kcondvar_t ct_cond; 2084 } smb_cmd_threshold_t; 2085 2086 typedef struct { 2087 kstat_named_t ls_files; 2088 kstat_named_t ls_trees; 2089 kstat_named_t ls_users; 2090 } smb_server_legacy_kstat_t; 2091 2092 typedef enum smb_server_state { 2093 SMB_SERVER_STATE_CREATED = 0, 2094 SMB_SERVER_STATE_CONFIGURED, 2095 SMB_SERVER_STATE_RUNNING, 2096 SMB_SERVER_STATE_STOPPING, 2097 SMB_SERVER_STATE_DELETING, 2098 SMB_SERVER_STATE_SENTINEL 2099 } smb_server_state_t; 2100 2101 typedef struct { 2102 /* protected by sv_mutex */ 2103 kcondvar_t sp_cv; 2104 uint32_t sp_cnt; 2105 smb_llist_t sp_list; 2106 smb_llist_t sp_fidlist; 2107 } smb_spool_t; 2108 2109 #define SMB_SERVER_STATE_VALID(S) \ 2110 ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \ 2111 ((S) == SMB_SERVER_STATE_CONFIGURED) || \ 2112 ((S) == SMB_SERVER_STATE_RUNNING) || \ 2113 ((S) == SMB_SERVER_STATE_STOPPING) || \ 2114 ((S) == SMB_SERVER_STATE_DELETING)) 2115 2116 typedef struct smb_server { 2117 list_node_t sv_lnd; 2118 uint32_t sv_magic; 2119 kcondvar_t sv_cv; 2120 kmutex_t sv_mutex; 2121 smb_server_state_t sv_state; 2122 uint32_t sv_refcnt; 2123 pid_t sv_pid; 2124 zoneid_t sv_zid; 2125 smb_listener_daemon_t sv_nbt_daemon; 2126 smb_listener_daemon_t sv_tcp_daemon; 2127 krwlock_t sv_cfg_lock; 2128 smb_kmod_cfg_t sv_cfg; 2129 2130 kmutex_t sv_proc_lock; 2131 kcondvar_t sv_proc_cv; 2132 smb_thread_state_t sv_proc_state; 2133 uint64_t sv_proc_did; 2134 struct proc *sv_proc_p; 2135 2136 smb_session_t *sv_session; 2137 smb_user_t *sv_rootuser; 2138 smb_llist_t sv_session_list; 2139 smb_hash_t *sv_persistid_ht; 2140 smb_hash_t *sv_lease_ht; 2141 2142 smb_export_t sv_export; 2143 struct __door_handle *sv_lmshrd; 2144 2145 /* Internal door for up-calls to smbd */ 2146 struct __door_handle *sv_kdoor_hd; 2147 int sv_kdoor_id; /* init -1 */ 2148 uint64_t sv_kdoor_ncall; 2149 kmutex_t sv_kdoor_mutex; 2150 kcondvar_t sv_kdoor_cv; 2151 2152 int32_t si_gmtoff; 2153 2154 smb_thread_t si_thread_timers; 2155 2156 taskq_t *sv_notify_pool; 2157 taskq_t *sv_worker_pool; 2158 taskq_t *sv_receiver_pool; 2159 2160 smb_node_t *si_root_smb_node; 2161 smb_llist_t sv_opipe_list; 2162 smb_llist_t sv_event_list; 2163 2164 /* Statistics */ 2165 hrtime_t sv_start_time; 2166 kstat_t *sv_ksp; 2167 volatile uint32_t sv_nbt_sess; 2168 volatile uint32_t sv_tcp_sess; 2169 volatile uint32_t sv_users; 2170 volatile uint32_t sv_trees; 2171 volatile uint32_t sv_files; 2172 volatile uint32_t sv_pipes; 2173 volatile uint64_t sv_txb; 2174 volatile uint64_t sv_rxb; 2175 volatile uint64_t sv_nreq; 2176 smb_srqueue_t sv_srqueue; 2177 smb_spool_t sp_info; 2178 smb_cmd_threshold_t sv_ssetup_ct; 2179 smb_cmd_threshold_t sv_tcon_ct; 2180 smb_cmd_threshold_t sv_opipe_ct; 2181 kstat_t *sv_legacy_ksp; 2182 kmutex_t sv_legacy_ksmtx; 2183 smb_disp_stats_t *sv_disp_stats1; 2184 smb_disp_stats_t *sv_disp_stats2; 2185 } smb_server_t; 2186 2187 #define SMB_EVENT_MAGIC 0x45564E54 /* EVNT */ 2188 #define SMB_EVENT_TIMEOUT 45 /* seconds */ 2189 #define SMB_EVENT_VALID(e) \ 2190 ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC)) 2191 typedef struct smb_event { 2192 list_node_t se_lnd; 2193 uint32_t se_magic; 2194 kmutex_t se_mutex; 2195 kcondvar_t se_cv; 2196 smb_server_t *se_server; 2197 uint32_t se_txid; 2198 boolean_t se_notified; 2199 int se_waittime; 2200 int se_timeout; 2201 int se_errno; 2202 } smb_event_t; 2203 2204 typedef struct smb_kspooldoc { 2205 list_node_t sd_lnd; 2206 uint32_t sd_magic; 2207 smb_inaddr_t sd_ipaddr; 2208 uint32_t sd_spool_num; 2209 uint16_t sd_fid; 2210 char sd_username[MAXNAMELEN]; 2211 char sd_path[MAXPATHLEN]; 2212 } smb_kspooldoc_t; 2213 2214 typedef struct smb_spoolfid { 2215 list_node_t sf_lnd; 2216 uint32_t sf_magic; 2217 uint16_t sf_fid; 2218 } smb_spoolfid_t; 2219 2220 #define SMB_INFO_NETBIOS_SESSION_SVC_RUNNING 0x0001 2221 #define SMB_INFO_NETBIOS_SESSION_SVC_FAILED 0x0002 2222 #define SMB_INFO_USER_LEVEL_SECURITY 0x40000000 2223 #define SMB_INFO_ENCRYPT_PASSWORDS 0x80000000 2224 2225 #define SMB_IS_STREAM(node) ((node)->n_unode) 2226 2227 typedef struct smb_tsd { 2228 void (*proc)(); 2229 void *arg; 2230 char name[100]; 2231 } smb_tsd_t; 2232 2233 typedef struct smb_disp_entry { 2234 char sdt_name[KSTAT_STRLEN]; 2235 smb_sdrc_t (*sdt_pre_op)(smb_request_t *); 2236 smb_sdrc_t (*sdt_function)(smb_request_t *); 2237 void (*sdt_post_op)(smb_request_t *); 2238 uint8_t sdt_com; 2239 char sdt_dialect; 2240 uint8_t sdt_flags; 2241 } smb_disp_entry_t; 2242 2243 typedef struct smb_xlate { 2244 int code; 2245 char *str; 2246 } smb_xlate_t; 2247 2248 /* 2249 * This structure is a helper for building RAP NetShareEnum response 2250 * 2251 * es_posix_uid UID of the user requesting the shares list which 2252 * is used to detect if the user has any autohome 2253 * es_bufsize size of the response buffer 2254 * es_buf pointer to the response buffer 2255 * es_ntotal total number of shares exported by server which 2256 * their OEM names is less then 13 chars 2257 * es_nsent number of shares that can fit in the specified buffer 2258 * es_datasize actual data size (share's data) which was encoded 2259 * in the response buffer 2260 */ 2261 typedef struct smb_enumshare_info { 2262 uid_t es_posix_uid; 2263 uint16_t es_bufsize; 2264 char *es_buf; 2265 uint16_t es_ntotal; 2266 uint16_t es_nsent; 2267 uint16_t es_datasize; 2268 } smb_enumshare_info_t; 2269 2270 /* 2271 * SMB 3.1.1 error id for error ctxs 2272 */ 2273 enum smb2_error_id { 2274 SMB2_ERROR_ID_DEFAULT = 0, 2275 SMB2_ERROR_ID_SHARE_REDIRECT = 0x72645253 /* not used */ 2276 }; 2277 2278 #ifdef __cplusplus 2279 } 2280 #endif 2281 2282 #endif /* _SMBSRV_SMB_KTYPES_H */ 2283