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