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