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