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