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 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 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 <sys/door.h> 53 #include <sys/extdirent.h> 54 #include <smbsrv/smb.h> 55 #include <smbsrv/smbinfo.h> 56 #include <smbsrv/mbuf.h> 57 #include <smbsrv/smb_sid.h> 58 #include <smbsrv/smb_xdr.h> 59 #include <smbsrv/netbios.h> 60 #include <smbsrv/smb_vops.h> 61 #include <smbsrv/ntifs.h> 62 63 struct smb_disp_entry; 64 struct smb_request; 65 struct smb_server; 66 67 int smb_noop(void *, size_t, int); 68 69 #define SMB_AUDIT_STACK_DEPTH 16 70 #define SMB_AUDIT_BUF_MAX_REC 16 71 #define SMB_AUDIT_NODE 0x00000001 72 73 /* 74 * Maximum number of records returned in SMBsearch, SMBfind 75 * and SMBfindunique response. Value set to 10 for compatibility 76 * with Windows. 77 */ 78 #define SMB_MAX_SEARCH 10 79 80 #define SMB_SEARCH_ATTRIBUTES \ 81 (FILE_ATTRIBUTE_HIDDEN | \ 82 FILE_ATTRIBUTE_SYSTEM | \ 83 FILE_ATTRIBUTE_DIRECTORY) 84 85 #define SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN) 86 #define SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM) 87 #define SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY) 88 #define SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES) 89 90 typedef struct { 91 uint32_t anr_refcnt; 92 int anr_depth; 93 pc_t anr_stack[SMB_AUDIT_STACK_DEPTH]; 94 } smb_audit_record_node_t; 95 96 typedef struct { 97 int anb_index; 98 int anb_max_index; 99 smb_audit_record_node_t anb_records[SMB_AUDIT_BUF_MAX_REC]; 100 } smb_audit_buf_node_t; 101 102 #define SMB_WORKER_PRIORITY 99 103 /* 104 * Thread State Machine 105 * -------------------- 106 * 107 * T5 T0 108 * smb_thread_destroy() <-------+ +------- smb_thread_init() 109 * | | 110 * | v 111 * +-----------------------------+ 112 * | SMB_THREAD_STATE_EXITED |<---+ 113 * +-----------------------------+ | 114 * | T1 | 115 * v | 116 * +-----------------------------+ | 117 * | SMB_THREAD_STATE_STARTING | | 118 * +-----------------------------+ | 119 * | T2 | T4 120 * v | 121 * +-----------------------------+ | 122 * | SMB_THREAD_STATE_RUNNING | | 123 * +-----------------------------+ | 124 * | T3 | 125 * v | 126 * +-----------------------------+ | 127 * | SMB_THREAD_STATE_EXITING |----+ 128 * +-----------------------------+ 129 * 130 * Transition T0 131 * 132 * This transition is executed in smb_thread_init(). 133 * 134 * Transition T1 135 * 136 * This transition is executed in smb_thread_start(). 137 * 138 * Transition T2 139 * 140 * This transition is executed by the thread itself when it starts running. 141 * 142 * Transition T3 143 * 144 * This transition is executed by the thread itself in 145 * smb_thread_entry_point() just before calling thread_exit(). 146 * 147 * 148 * Transition T4 149 * 150 * This transition is executed in smb_thread_stop(). 151 * 152 * Transition T5 153 * 154 * This transition is executed in smb_thread_destroy(). 155 * 156 * Comments 157 * -------- 158 * 159 * The field smb_thread_aw_t contains a function pointer that knows how to 160 * awake the thread. It is a temporary solution to work around the fact that 161 * kernel threads (not part of a userspace process) cannot be signaled. 162 */ 163 typedef enum smb_thread_state { 164 SMB_THREAD_STATE_STARTING = 0, 165 SMB_THREAD_STATE_RUNNING, 166 SMB_THREAD_STATE_EXITING, 167 SMB_THREAD_STATE_EXITED 168 } smb_thread_state_t; 169 170 struct _smb_thread; 171 172 typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg); 173 typedef void (*smb_thread_aw_t)(struct _smb_thread *, void *aw_arg); 174 175 #define SMB_THREAD_MAGIC 0x534D4254 /* SMBT */ 176 177 typedef struct _smb_thread { 178 uint32_t sth_magic; 179 char sth_name[16]; 180 smb_thread_state_t sth_state; 181 kthread_t *sth_th; 182 kt_did_t sth_did; 183 smb_thread_ep_t sth_ep; 184 void *sth_ep_arg; 185 smb_thread_aw_t sth_aw; 186 void *sth_aw_arg; 187 boolean_t sth_kill; 188 kmutex_t sth_mtx; 189 kcondvar_t sth_cv; 190 } smb_thread_t; 191 192 /* 193 * Pool of IDs 194 * ----------- 195 * 196 * A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap. 197 * A bit set to '1' indicates that that particular value has been allocated. 198 * The allocation process is done shifting a bit through the whole bitmap. 199 * The current position of that index bit is kept in the smb_idpool_t 200 * structure and represented by a byte index (0 to buffer size minus 1) and 201 * a bit index (0 to 7). 202 * 203 * The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs 204 * out of IDs its current size is doubled until it reaches its maximum size 205 * (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which 206 * means that a pool can have a maximum number of 65534 IDs available. 207 */ 208 #define SMB_IDPOOL_MAGIC 0x4944504C /* IDPL */ 209 #define SMB_IDPOOL_MIN_SIZE 64 /* Number of IDs to begin with */ 210 #define SMB_IDPOOL_MAX_SIZE 64 * 1024 211 212 typedef struct smb_idpool { 213 uint32_t id_magic; 214 kmutex_t id_mutex; 215 uint8_t *id_pool; 216 uint32_t id_size; 217 uint8_t id_bit; 218 uint8_t id_bit_idx; 219 uint32_t id_idx; 220 uint32_t id_idx_msk; 221 uint32_t id_free_counter; 222 uint32_t id_max_free_counter; 223 } smb_idpool_t; 224 225 /* 226 * Maximum size of a Transport Data Unit when CAP_LARGE_READX and 227 * CAP_LARGE_WRITEX are not set. CAP_LARGE_READX/CAP_LARGE_WRITEX 228 * allow the payload to exceed the negotiated buffer size. 229 * 4 --> NBT/TCP Transport Header. 230 * 32 --> SMB Header 231 * 1 --> Word Count byte 232 * 510 --> Maximum Number of bytes of the Word Table (2 * 255) 233 * 2 --> Byte count of the data 234 * 65535 --> Maximum size of the data 235 * ----- 236 * 66084 237 */ 238 #define SMB_REQ_MAX_SIZE 66560 /* 65KB */ 239 #define SMB_XPRT_MAX_SIZE (SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ) 240 241 #define SMB_TXREQ_MAGIC 0X54524251 /* 'TREQ' */ 242 typedef struct { 243 uint32_t tr_magic; 244 list_node_t tr_lnd; 245 int tr_len; 246 uint8_t tr_buf[SMB_XPRT_MAX_SIZE]; 247 } smb_txreq_t; 248 249 #define SMB_TXLST_MAGIC 0X544C5354 /* 'TLST' */ 250 typedef struct { 251 uint32_t tl_magic; 252 kmutex_t tl_mutex; 253 boolean_t tl_active; 254 list_t tl_list; 255 } smb_txlst_t; 256 257 /* 258 * Maximum buffer size for NT is 37KB. If all clients are Windows 2000, this 259 * can be changed to 64KB. 37KB must be used with a mix of NT/Windows 2000 260 * clients because NT loses directory entries when values greater than 37KB are 261 * used. 262 * 263 * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to 264 * account for the NBT header. 265 */ 266 #define NBT_MAXBUF 8 267 #define SMB_NT_MAXBUF (37 * 1024) 268 269 #define OUTBUFSIZE (65 * 1024) 270 #define SMBHEADERSIZE 32 271 #define SMBND_HASH_MASK (0xFF) 272 #define MAX_IOVEC 512 273 #define MAX_READREF (8 * 1024) 274 275 #define SMB_WORKER_MIN 4 276 #define SMB_WORKER_DEFAULT 64 277 #define SMB_WORKER_MAX 1024 278 279 /* 280 * Fix align a pointer or offset appropriately so that fields will not 281 * cross word boundaries. 282 */ 283 #define PTRALIGN(x) \ 284 (((uintptr_t)(x) + (uintptr_t)(_POINTER_ALIGNMENT) - 1l) & \ 285 ~((uintptr_t)(_POINTER_ALIGNMENT) - 1l)) 286 287 /* 288 * native os types are defined in win32/smbinfo.h 289 */ 290 291 /* 292 * All 4 different time / date formats that will bee seen in SMB 293 */ 294 typedef struct { 295 uint16_t Day : 5; 296 uint16_t Month : 4; 297 uint16_t Year : 7; 298 } SMB_DATE; 299 300 typedef struct { 301 uint16_t TwoSeconds : 5; 302 uint16_t Minutes : 6; 303 uint16_t Hours : 5; 304 } SMB_TIME; 305 306 307 typedef uint32_t UTIME; /* seconds since Jan 1 1970 */ 308 309 typedef struct smb_malloc_list { 310 struct smb_malloc_list *forw; 311 struct smb_malloc_list *back; 312 } smb_malloc_list; 313 314 typedef struct smb_llist { 315 krwlock_t ll_lock; 316 list_t ll_list; 317 uint32_t ll_count; 318 uint64_t ll_wrop; 319 } smb_llist_t; 320 321 typedef struct smb_slist { 322 kmutex_t sl_mutex; 323 kcondvar_t sl_cv; 324 list_t sl_list; 325 uint32_t sl_count; 326 boolean_t sl_waiting; 327 } smb_slist_t; 328 329 typedef struct smb_session_list { 330 krwlock_t se_lock; 331 uint64_t se_wrop; 332 struct { 333 list_t lst; 334 uint32_t count; 335 } se_rdy; 336 struct { 337 list_t lst; 338 uint32_t count; 339 } se_act; 340 } smb_session_list_t; 341 342 typedef struct { 343 kcondvar_t rwx_cv; 344 kmutex_t rwx_mutex; 345 krwlock_t rwx_lock; 346 boolean_t rwx_waiting; 347 } smb_rwx_t; 348 349 /* NOTIFY CHANGE */ 350 351 typedef struct smb_notify_change_req { 352 list_node_t nc_lnd; 353 struct smb_node *nc_node; 354 uint32_t nc_reply_type; 355 uint32_t nc_flags; 356 } smb_notify_change_req_t; 357 358 /* 359 * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly 360 * over TCP, which is also known as direct hosted NetBIOS-less SMB 361 * or SMB-over-TCP. 362 * 363 * NBT messages have a 4-byte header that defines the message type 364 * (8-bits), a 7-bit flags field and a 17-bit length. 365 * 366 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 367 * | TYPE | FLAGS |E| LENGTH | 368 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 369 * 370 * 8-bit type Defined in RFC 1002 371 * 7-bit flags Bits 0-6 reserved (must be 0) 372 * Bit 7: Length extension bit (E) 373 * 17-bit length Includes bit 7 of the flags byte 374 * 375 * 376 * SMB-over-TCP is defined to use a modified version of the NBT header 377 * containing an 8-bit message type and 24-bit message length. 378 * 379 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 380 * | TYPE | LENGTH | 381 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 382 * 383 * 8-bit type Must be 0 384 * 24-bit length 385 * 386 * The following structure is used to represent a generic, in-memory 387 * SMB transport header; it is not intended to map directly to either 388 * of the over-the-wire formats. 389 */ 390 typedef struct { 391 uint8_t xh_type; 392 uint32_t xh_length; 393 } smb_xprt_t; 394 395 int MBC_LENGTH(struct mbuf_chain *); 396 int MBC_MAXBYTES(struct mbuf_chain *); 397 void MBC_SETUP(struct mbuf_chain *, uint32_t); 398 void MBC_INIT(struct mbuf_chain *, uint32_t); 399 void MBC_FLUSH(struct mbuf_chain *); 400 void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *); 401 void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *); 402 void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN); 403 int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC, 404 int OFF, int LEN); 405 406 #define MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes) 407 408 /* 409 * ol_sess_id: 410 * 411 * ID of the session holding the oplock (if an oplock was granted). 412 * 413 * ol_xthread: 414 * 415 * Worker thread treating the command that was granted the oplock. Until 416 * that thread is done with that command and has submitted the response 417 * to the network stack, all the other threads will be suspended in 418 * smb_oplock_enter(). They will be awaken when the worker thread 419 * referenced in 'ol_xthread' calls smb_oplock_broadcast(). 420 * 421 * The purpose of this mechanism is to prevent another thread from 422 * triggering a oplock break before the response conveying the grant 423 * has been sent. 424 * 425 * ol_ofile 426 * 427 * Open file that was granted the oplock. 428 * 429 * ol_waiters_count 430 * 431 * Number of threads waiting for a call to smb_oplock_broadcast(). 432 * 433 * ol_level 434 * 435 * Level of the oplock granted. 436 */ 437 typedef struct smb_oplock { 438 uint64_t ol_sess_id; 439 kcondvar_t ol_cv; 440 kthread_t *ol_xthread; 441 struct smb_ofile *ol_ofile; 442 uint8_t ol_level; 443 } smb_oplock_t; 444 445 #define DOS_ATTR_VALID 0x80000000 446 447 #define SMB_VFS_MAGIC 0x534D4256 /* 'SMBV' */ 448 449 typedef struct smb_vfs { 450 uint32_t sv_magic; 451 list_node_t sv_lnd; 452 uint32_t sv_refcnt; 453 vfs_t *sv_vfsp; 454 vnode_t *sv_rootvp; 455 } smb_vfs_t; 456 457 typedef struct smb_unexport { 458 list_node_t ux_lnd; 459 char ux_sharename[MAXNAMELEN]; 460 } smb_unexport_t; 461 462 #define SMB_NODE_MAGIC 0x4E4F4445 /* 'NODE' */ 463 #define SMB_NODE_VALID(p) ASSERT((p)->n_magic == SMB_NODE_MAGIC) 464 465 typedef enum { 466 SMB_NODE_STATE_AVAILABLE = 0, 467 SMB_NODE_STATE_OPLOCK_GRANTED, 468 SMB_NODE_STATE_OPLOCK_BREAKING, 469 SMB_NODE_STATE_DESTROYING 470 } smb_node_state_t; 471 472 typedef struct smb_node { 473 uint32_t n_magic; 474 krwlock_t n_lock; 475 kmutex_t n_mutex; 476 list_node_t n_lnd; 477 smb_node_state_t n_state; 478 uint32_t n_refcnt; 479 uint32_t n_hashkey; 480 smb_llist_t *n_hash_bucket; 481 uint32_t n_orig_uid; 482 uint32_t n_open_count; 483 smb_llist_t n_ofile_list; 484 smb_llist_t n_lock_list; 485 struct smb_ofile *readonly_creator; 486 volatile int flags; /* FILE_NOTIFY_CHANGE_* */ 487 volatile int waiting_event; /* # of clients requesting FCN */ 488 smb_attr_t attr; 489 unsigned int what; 490 u_offset_t n_size; 491 smb_oplock_t n_oplock; 492 struct smb_node *dir_snode; /* Directory of node */ 493 struct smb_node *unnamed_stream_node; /* set in stream nodes */ 494 /* Credentials for delayed delete */ 495 cred_t *delete_on_close_cred; 496 uint32_t n_delete_on_close_flags; 497 char od_name[MAXNAMELEN]; 498 vnode_t *vp; 499 smb_audit_buf_node_t *n_audit_buf; 500 } smb_node_t; 501 502 #define NODE_FLAGS_NOTIFY_CHANGE 0x10000fff 503 #define NODE_OPLOCKS_IN_FORCE 0x0000f000 504 #define NODE_OPLOCK_NONE 0x00000000 505 #define NODE_EXCLUSIVE_OPLOCK 0x00001000 506 #define NODE_BATCH_OPLOCK 0x00002000 507 #define NODE_LEVEL_II_OPLOCK 0x00003000 508 #define NODE_CAP_LEVEL_II 0x00010000 509 #define NODE_PROTOCOL_LOCK 0x00020000 510 #define NODE_FLAGS_WRITE_THROUGH 0x00100000 511 #define NODE_FLAGS_SYNCATIME 0x00200000 512 #define NODE_FLAGS_LOCKED 0x00400000 513 #define NODE_FLAGS_ATTR_VALID 0x00800000 514 #define NODE_XATTR_DIR 0x01000000 515 #define NODE_FLAGS_CREATED 0x04000000 516 #define NODE_FLAGS_CHANGED 0x08000000 517 #define NODE_FLAGS_WATCH_TREE 0x10000000 518 #define NODE_FLAGS_SET_SIZE 0x20000000 519 #define NODE_FLAGS_DELETE_ON_CLOSE 0x40000000 520 #define NODE_FLAGS_EXECUTABLE 0x80000000 521 522 #define OPLOCK_TYPE(n) ((n)->flags & NODE_OPLOCKS_IN_FORCE) 523 #define OPLOCKS_IN_FORCE(n) (OPLOCK_TYPE(n) != NODE_OPLOCK_NONE) 524 #define EXCLUSIVE_OPLOCK_IN_FORCE(n) \ 525 (OPLOCK_TYPE(n) == NODE_EXCLUSIVE_OPLOCK) 526 #define BATCH_OPLOCK_IN_FORCE(n) (OPLOCK_TYPE(n) == NODE_BATCH_OPLOCK) 527 #define LEVEL_II_OPLOCK_IN_FORCE(n) (OPLOCK_TYPE(n) == NODE_LEVEL_II_OPLOCK) 528 529 #define SMB_NODE_VFS(node) ((node)->vp->v_vfsp) 530 #define SMB_NODE_FSID(node) ((node)->vp->v_vfsp->vfs_fsid) 531 532 /* 533 * Based on section 2.6.1.2 (Connection Management) of the June 13, 534 * 1996 CIFS spec, a server may terminate the transport connection 535 * due to inactivity. The client software is expected to be able to 536 * automatically reconnect to the server if this happens. Like much 537 * of the useful background information, this section appears to 538 * have been dropped from later revisions of the document. 539 * 540 * Each session has an activity timestamp that's updated whenever a 541 * request is dispatched. If the session is idle, i.e. receives no 542 * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be 543 * closed. 544 * 545 * Each session has an I/O semaphore to serialize communication with 546 * the client. For example, after receiving a raw-read request, the 547 * server is not allowed to send an oplock break to the client until 548 * after it has sent the raw-read data. 549 */ 550 #define SMB_SESSION_INACTIVITY_TIMEOUT (15 * 60) 551 552 #define SMB_SESSION_OFILE_MAX (16 * 1024) 553 554 /* 555 * When a connection is set up we need to remember both the client 556 * (peer) IP address and the local IP address used to establish the 557 * connection. When a client connects with a vc number of zero, we 558 * are supposed to abort any existing connections with that client 559 * (see notes in smb_negotiate.c and smb_session_setup_andx.c). For 560 * servers with multiple network interfaces or IP aliases, however, 561 * each interface has to be managed independently since the client 562 * is not aware of the server configuration. We have to allow the 563 * client to establish a connection on each interface with a vc 564 * number of zero without aborting the other connections. 565 * 566 * ipaddr: the client (peer) IP address for the session. 567 * local_ipaddr: the local IP address used to connect to the server. 568 */ 569 570 #define SMB_MAC_KEYSZ 512 571 572 struct smb_sign { 573 unsigned int seqnum; 574 unsigned int mackey_len; 575 unsigned int flags; 576 unsigned char mackey[SMB_MAC_KEYSZ]; 577 }; 578 579 #define SMB_SIGNING_ENABLED 1 580 #define SMB_SIGNING_CHECK 2 581 582 /* 583 * Session State Machine 584 * --------------------- 585 * 586 * +-----------------------------+ +------------------------------+ 587 * | SMB_SESSION_STATE_CONNECTED | | SMB_SESSION_STATE_TERMINATED | 588 * +-----------------------------+ +------------------------------+ 589 * T0| ^ 590 * +--------------------+ |T13 591 * v |T14 | 592 * +-------------------------------+ | +--------------------------------+ 593 * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED | 594 * +-------------------------------+ +--------------------------------+ 595 * T1| ^ ^ ^ ^ 596 * +----------+ |T9 | | | 597 * v | | | | 598 * +------------------------------+ | | | 599 * | SMB_SESSION_STATE_NEGOTIATED | | | | 600 * +------------------------------+ | | | 601 * ^| ^| | ^ | | | 602 * +----------------+| || | | | | | 603 * |+----------------+ || T7| |T8 | | | 604 * || || | | | | | 605 * || +----------------+| | | | | | 606 * || |+----------------+ | | | | | 607 * || || v | | | | 608 * || || +-----------------------------------+ T10| | | 609 * || || | SMB_SESSION_STATE_OPLOCK_BREAKING |----+ | | 610 * || || +-----------------------------------+ | | 611 * || ||T5 | | 612 * || |+-->+-----------------------------------+ T11| | 613 * || |T6 | SMB_SESSION_STATE_READ_RAW_ACTIVE |------+ | 614 * || +----+-----------------------------------+ | 615 * ||T3 | 616 * |+------->+------------------------------------+ T12| 617 * |T4 | SMB_SESSION_STATE_WRITE_RAW_ACTIVE |-------+ 618 * +---------+------------------------------------+ 619 * 620 * Transition T0 621 * 622 * 623 * 624 * Transition T1 625 * 626 * 627 * 628 * Transition T2 629 * 630 * 631 * 632 * Transition T3 633 * 634 * 635 * 636 * Transition T4 637 * 638 * 639 * 640 * Transition T5 641 * 642 * 643 * 644 * Transition T6 645 * 646 * 647 * 648 * Transition T7 649 * 650 * 651 * 652 * Transition T8 653 * 654 * 655 * 656 * Transition T9 657 * 658 * 659 * 660 * Transition T10 661 * 662 * 663 * 664 * Transition T11 665 * 666 * 667 * 668 * Transition T12 669 * 670 * 671 * 672 * Transition T13 673 * 674 * 675 * 676 * Transition T14 677 * 678 * 679 * 680 */ 681 #define SMB_SESSION_MAGIC 0x53455353 /* 'SESS' */ 682 #define SMB_SESSION_VALID(p) ASSERT((p)->s_magic == SMB_SESSION_MAGIC) 683 684 typedef enum { 685 SMB_SESSION_STATE_INITIALIZED = 0, 686 SMB_SESSION_STATE_DISCONNECTED, 687 SMB_SESSION_STATE_CONNECTED, 688 SMB_SESSION_STATE_ESTABLISHED, 689 SMB_SESSION_STATE_NEGOTIATED, 690 SMB_SESSION_STATE_OPLOCK_BREAKING, 691 SMB_SESSION_STATE_WRITE_RAW_ACTIVE, 692 SMB_SESSION_STATE_READ_RAW_ACTIVE, 693 SMB_SESSION_STATE_TERMINATED, 694 SMB_SESSION_STATE_SENTINEL 695 } smb_session_state_t; 696 697 typedef struct smb_session { 698 uint32_t s_magic; 699 smb_rwx_t s_lock; 700 list_node_t s_lnd; 701 uint64_t s_kid; 702 smb_session_state_t s_state; 703 uint32_t s_flags; 704 int s_write_raw_status; 705 kthread_t *s_thread; 706 kt_did_t s_ktdid; 707 smb_kmod_cfg_t s_cfg; 708 kmem_cache_t *s_cache; 709 kmem_cache_t *s_cache_request; 710 struct smb_server *s_server; 711 int32_t s_gmtoff; 712 uint32_t keep_alive; 713 uint64_t opentime; 714 uint16_t vcnumber; 715 uint16_t s_local_port; 716 smb_inaddr_t ipaddr; 717 smb_inaddr_t local_ipaddr; 718 char workstation[SMB_PI_MAX_HOST]; 719 int dialect; 720 int native_os; 721 uint32_t capabilities; 722 struct smb_sign signing; 723 724 ksocket_t sock; 725 726 smb_slist_t s_req_list; 727 smb_llist_t s_xa_list; 728 smb_llist_t s_user_list; 729 smb_idpool_t s_uid_pool; 730 smb_txlst_t s_txlst; 731 732 volatile uint32_t s_tree_cnt; 733 volatile uint32_t s_file_cnt; 734 volatile uint32_t s_dir_cnt; 735 736 uint16_t secmode; 737 uint32_t sesskey; 738 uint32_t challenge_len; 739 unsigned char challenge_key[8]; 740 unsigned char MAC_key[44]; 741 int64_t activity_timestamp; 742 /* 743 * Maximum negotiated buffer size between SMB client and server 744 * in SMB_SESSION_SETUP_ANDX 745 */ 746 uint16_t smb_msg_size; 747 uchar_t *outpipe_data; 748 int outpipe_datalen; 749 int outpipe_cookie; 750 list_t s_oplock_brkreqs; 751 } smb_session_t; 752 753 #define SMB_USER_MAGIC 0x55534552 /* 'USER' */ 754 755 #define SMB_USER_FLAG_GUEST SMB_ATF_GUEST 756 #define SMB_USER_FLAG_IPC SMB_ATF_ANON 757 #define SMB_USER_FLAG_ADMIN SMB_ATF_ADMIN 758 #define SMB_USER_FLAG_POWER_USER SMB_ATF_POWERUSER 759 #define SMB_USER_FLAG_BACKUP_OPERATOR SMB_ATF_BACKUPOP 760 761 #define SMB_USER_PRIV_TAKE_OWNERSHIP 0x00000001 762 #define SMB_USER_PRIV_BACKUP 0x00000002 763 #define SMB_USER_PRIV_RESTORE 0x00000004 764 #define SMB_USER_PRIV_SECURITY 0x00000008 765 766 767 typedef enum { 768 SMB_USER_STATE_LOGGED_IN = 0, 769 SMB_USER_STATE_LOGGING_OFF, 770 SMB_USER_STATE_LOGGED_OFF, 771 SMB_USER_STATE_SENTINEL 772 } smb_user_state_t; 773 774 typedef struct smb_user { 775 uint32_t u_magic; 776 list_node_t u_lnd; 777 kmutex_t u_mutex; 778 smb_user_state_t u_state; 779 780 struct smb_server *u_server; 781 smb_session_t *u_session; 782 uint16_t u_name_len; 783 char *u_name; 784 uint16_t u_domain_len; 785 char *u_domain; 786 time_t u_logon_time; 787 cred_t *u_cred; 788 cred_t *u_privcred; 789 790 smb_llist_t u_tree_list; 791 smb_idpool_t u_tid_pool; 792 793 uint32_t u_refcnt; 794 uint32_t u_flags; 795 uint32_t u_privileges; 796 uint16_t u_uid; 797 uint32_t u_audit_sid; 798 } smb_user_t; 799 800 #define SMB_TREE_MAGIC 0x54524545 /* 'TREE' */ 801 802 #define SMB_TYPENAMELEN _ST_FSTYPSZ 803 #define SMB_VOLNAMELEN 32 804 805 #define SMB_TREE_READONLY 0x00000001 806 #define SMB_TREE_SUPPORTS_ACLS 0x00000002 807 #define SMB_TREE_STREAMS 0x00000004 808 #define SMB_TREE_CASEINSENSITIVE 0x00000008 809 #define SMB_TREE_NO_CASESENSITIVE 0x00000010 810 #define SMB_TREE_NO_EXPORT 0x00000020 811 #define SMB_TREE_NO_OPLOCKS 0x00000040 812 #define SMB_TREE_NO_ATIME 0x00000080 813 #define SMB_TREE_XVATTR 0x00000100 814 #define SMB_TREE_DIRENTFLAGS 0x00000200 815 #define SMB_TREE_ACLONCREATE 0x00000400 816 #define SMB_TREE_ACEMASKONACCESS 0x00000800 817 #define SMB_TREE_NFS_MOUNTED 0x00001000 818 #define SMB_TREE_UNICODE_ON_DISK 0x00002000 819 #define SMB_TREE_CATIA 0x00004000 820 821 typedef enum { 822 SMB_TREE_STATE_CONNECTED = 0, 823 SMB_TREE_STATE_DISCONNECTING, 824 SMB_TREE_STATE_DISCONNECTED, 825 SMB_TREE_STATE_SENTINEL 826 } smb_tree_state_t; 827 828 typedef struct smb_tree { 829 uint32_t t_magic; 830 kmutex_t t_mutex; 831 list_node_t t_lnd; 832 smb_tree_state_t t_state; 833 834 struct smb_server *t_server; 835 smb_session_t *t_session; 836 smb_user_t *t_user; 837 smb_node_t *t_snode; 838 839 smb_llist_t t_ofile_list; 840 smb_idpool_t t_fid_pool; 841 842 smb_llist_t t_odir_list; 843 smb_idpool_t t_odid_pool; 844 845 uint32_t t_refcnt; 846 uint32_t t_flags; 847 int32_t t_res_type; 848 uint16_t t_tid; 849 uint16_t t_umask; 850 char t_sharename[MAXNAMELEN]; 851 char t_resource[MAXPATHLEN]; 852 char t_typename[SMB_TYPENAMELEN]; 853 char t_volume[SMB_VOLNAMELEN]; 854 acl_type_t t_acltype; 855 uint32_t t_access; 856 uint32_t t_shr_flags; 857 } smb_tree_t; 858 859 #define SMB_TREE_VFS(tree) ((tree)->t_snode->vp->v_vfsp) 860 #define SMB_TREE_FSID(tree) ((tree)->t_snode->vp->v_vfsp->vfs_fsid) 861 862 #define SMB_TREE_IS_READONLY(sr) \ 863 ((sr) != NULL && (sr)->tid_tree != NULL && \ 864 !((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS)) 865 866 #define SMB_TREE_IS_CASEINSENSITIVE(sr) \ 867 (((sr) && (sr)->tid_tree) ? \ 868 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0) 869 870 #define SMB_TREE_HAS_ACCESS(sr, acemask) \ 871 ((sr) == NULL ? ACE_ALL_PERMS : ( \ 872 (((sr) && (sr)->tid_tree) ? \ 873 (((sr)->tid_tree->t_access) & (acemask)) : 0))) 874 875 #define SMB_TREE_SUPPORTS_CATIA(sr) \ 876 (((sr) && (sr)->tid_tree) ? \ 877 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0) 878 879 /* 880 * SMB_TREE_CONTAINS_NODE is used to check that a node is in the same 881 * file system as the tree. 882 */ 883 #define SMB_TREE_CONTAINS_NODE(sr, node) \ 884 (((sr) && (sr)->tid_tree) ? \ 885 (SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node)) : 1) 886 887 /* 888 * SMB_NODE_IS_READONLY(node) 889 * 890 * This macro indicates whether the DOS readonly bit is set in the node's 891 * attribute cache. The cache reflects what is on-disk. 892 */ 893 894 #define SMB_NODE_IS_READONLY(node) \ 895 ((node) && (node)->attr.sa_dosattr & FILE_ATTRIBUTE_READONLY) 896 897 /* 898 * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not. 899 * The macro takes into account 900 * - the tree readonly state 901 * - the node readonly state 902 * - whether the specified ofile is the readonly creator 903 * The readonly creator has write permission until the ofile is closed. 904 */ 905 906 #define SMB_OFILE_IS_READONLY(of) \ 907 (((of)->f_flags & SMB_OFLAGS_READONLY) || \ 908 SMB_NODE_IS_READONLY((of)->f_node) || \ 909 (((of)->f_node->readonly_creator) && \ 910 ((of)->f_node->readonly_creator != (of)))) 911 912 /* 913 * SMB_PATHFILE_IS_READONLY indicates whether or not a file is 914 * readonly when the caller has a path rather than an ofile. Unlike 915 * SMB_OFILE_IS_READONLY, the caller cannot be the readonly creator, 916 * since that requires an ofile. 917 */ 918 919 #define SMB_PATHFILE_IS_READONLY(sr, node) \ 920 (SMB_TREE_IS_READONLY((sr)) || \ 921 SMB_NODE_IS_READONLY((node)) || \ 922 ((node)->readonly_creator)) 923 924 #define PIPE_STATE_AUTH_VERIFY 0x00000001 925 926 /* 927 * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used 928 * at the interface between SMB and NDR RPC. 929 */ 930 typedef struct smb_opipe { 931 kmutex_t p_mutex; 932 kcondvar_t p_cv; 933 char *p_name; 934 uint32_t p_busy; 935 smb_opipe_hdr_t p_hdr; 936 smb_opipe_context_t p_context; 937 uint8_t *p_doorbuf; 938 uint8_t *p_data; 939 } smb_opipe_t; 940 941 /* 942 * The of_ftype of an open file should contain the SMB_FTYPE value 943 * (cifs.h) returned when the file/pipe was opened. The following 944 * assumptions are currently made: 945 * 946 * File Type Node PipeInfo 947 * --------- -------- -------- 948 * SMB_FTYPE_DISK Valid Null 949 * SMB_FTYPE_BYTE_PIPE Undefined Undefined 950 * SMB_FTYPE_MESG_PIPE Null Valid 951 * SMB_FTYPE_PRINTER Undefined Undefined 952 * SMB_FTYPE_UNKNOWN Undefined Undefined 953 */ 954 955 /* 956 * Some flags for ofile structure 957 * 958 * SMB_OFLAGS_SET_DELETE_ON_CLOSE 959 * Set this flag when the corresponding open operation whose 960 * DELETE_ON_CLOSE bit of the CreateOptions is set. If any 961 * open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE 962 * will be set for the file node upon close. 963 */ 964 965 #define SMB_OFLAGS_READONLY 0x0001 966 #define SMB_OFLAGS_EXECONLY 0x0002 967 #define SMB_OFLAGS_SET_DELETE_ON_CLOSE 0x0004 968 #define SMB_OFLAGS_LLF_POS_VALID 0x0008 969 970 #define SMB_OFILE_MAGIC 0x4F464C45 /* 'OFLE' */ 971 #define SMB_OFILE_VALID(p) ASSERT((p)->f_magic == SMB_OFILE_MAGIC) 972 973 typedef enum { 974 SMB_OFILE_STATE_OPEN = 0, 975 SMB_OFILE_STATE_CLOSING, 976 SMB_OFILE_STATE_CLOSED, 977 SMB_OFILE_STATE_SENTINEL 978 } smb_ofile_state_t; 979 980 typedef struct smb_ofile { 981 uint32_t f_magic; 982 kmutex_t f_mutex; 983 list_node_t f_lnd; 984 list_node_t f_nnd; 985 smb_ofile_state_t f_state; 986 987 struct smb_server *f_server; 988 smb_session_t *f_session; 989 smb_user_t *f_user; 990 smb_tree_t *f_tree; 991 smb_node_t *f_node; 992 smb_opipe_t *f_pipe; 993 994 uint32_t f_uniqid; 995 uint32_t f_refcnt; 996 uint64_t f_seek_pos; 997 uint32_t f_flags; 998 uint32_t f_granted_access; 999 uint32_t f_share_access; 1000 uint32_t f_create_options; 1001 uint16_t f_fid; 1002 uint16_t f_opened_by_pid; 1003 uint16_t f_ftype; 1004 uint64_t f_llf_pos; 1005 int f_mode; 1006 cred_t *f_cr; 1007 pid_t f_pid; 1008 boolean_t f_oplock_granted; 1009 boolean_t f_oplock_exit; 1010 } smb_ofile_t; 1011 1012 #define SMB_ODIR_MAGIC 0x4F444952 /* 'ODIR' */ 1013 #define SMB_ODIR_BUFSIZE (8 * 1024) 1014 1015 #define SMB_ODIR_FLAG_WILDCARDS 0x0001 1016 #define SMB_ODIR_FLAG_IGNORE_CASE 0x0002 1017 #define SMB_ODIR_FLAG_XATTR 0x0004 1018 #define SMB_ODIR_FLAG_EDIRENT 0x0008 1019 #define SMB_ODIR_FLAG_CATIA 0x0010 1020 1021 typedef enum { 1022 SMB_ODIR_STATE_OPEN = 0, 1023 SMB_ODIR_STATE_IN_USE, 1024 SMB_ODIR_STATE_CLOSING, 1025 SMB_ODIR_STATE_CLOSED, 1026 SMB_ODIR_STATE_SENTINEL 1027 } smb_odir_state_t; 1028 1029 typedef enum { 1030 SMB_ODIR_RESUME_IDX, 1031 SMB_ODIR_RESUME_COOKIE, 1032 SMB_ODIR_RESUME_FNAME 1033 } smb_odir_resume_type_t; 1034 1035 typedef struct smb_odir_resume { 1036 smb_odir_resume_type_t or_type; 1037 int or_idx; 1038 uint32_t or_cookie; 1039 char *or_fname; 1040 } smb_odir_resume_t; 1041 1042 /* 1043 * Flags used when opening an odir 1044 */ 1045 #define SMB_ODIR_OPENF_BACKUP_INTENT 0x01 1046 1047 typedef struct smb_odir { 1048 uint32_t d_magic; 1049 kmutex_t d_mutex; 1050 list_node_t d_lnd; 1051 smb_odir_state_t d_state; 1052 smb_session_t *d_session; 1053 smb_tree_t *d_tree; 1054 smb_node_t *d_dnode; 1055 cred_t *d_cred; 1056 uint16_t d_odid; 1057 uint16_t d_opened_by_pid; 1058 uint16_t d_sattr; 1059 uint32_t d_refcnt; 1060 uint32_t d_flags; 1061 boolean_t d_eof; 1062 int d_bufsize; 1063 uint64_t d_offset; 1064 union { 1065 char *u_bufptr; 1066 edirent_t *u_edp; 1067 dirent64_t *u_dp; 1068 } d_u; 1069 uint32_t d_cookies[SMB_MAX_SEARCH]; 1070 char d_pattern[MAXNAMELEN]; 1071 char d_buf[SMB_ODIR_BUFSIZE]; 1072 } smb_odir_t; 1073 #define d_bufptr d_u.u_bufptr 1074 #define d_edp d_u.u_edp 1075 #define d_dp d_u.u_dp 1076 1077 typedef struct smb_odirent { 1078 char od_name[MAXNAMELEN]; /* on disk name */ 1079 ino64_t od_ino; 1080 uint32_t od_eflags; 1081 } smb_odirent_t; 1082 1083 typedef struct smb_fileinfo { 1084 char fi_name[MAXNAMELEN]; 1085 char fi_name83[SMB_SHORTNAMELEN]; 1086 char fi_shortname[SMB_SHORTNAMELEN]; 1087 uint32_t fi_cookie; 1088 uint32_t fi_dosattr; /* DOS attributes */ 1089 uint64_t fi_nodeid; /* file system node id */ 1090 uint64_t fi_size; /* file size in bytes */ 1091 uint64_t fi_alloc_size; /* allocation size in bytes */ 1092 timestruc_t fi_atime; /* last access */ 1093 timestruc_t fi_mtime; /* last modification */ 1094 timestruc_t fi_ctime; /* last status change */ 1095 timestruc_t fi_crtime; /* file creation */ 1096 } smb_fileinfo_t; 1097 1098 typedef struct smb_streaminfo { 1099 uint64_t si_size; 1100 char si_name[MAXPATHLEN]; 1101 } smb_streaminfo_t; 1102 1103 #define SMB_LOCK_MAGIC 0x4C4F434B /* 'LOCK' */ 1104 1105 typedef struct smb_lock { 1106 uint32_t l_magic; 1107 kmutex_t l_mutex; 1108 list_node_t l_lnd; 1109 kcondvar_t l_cv; 1110 1111 list_node_t l_conflict_lnd; 1112 smb_slist_t l_conflict_list; 1113 1114 smb_session_t *l_session; 1115 smb_ofile_t *l_file; 1116 struct smb_request *l_sr; 1117 1118 uint32_t l_flags; 1119 uint64_t l_session_kid; 1120 struct smb_lock *l_blocked_by; /* Debug info only */ 1121 1122 uint16_t l_pid; 1123 uint16_t l_uid; 1124 uint32_t l_type; 1125 uint64_t l_start; 1126 uint64_t l_length; 1127 clock_t l_end_time; 1128 } smb_lock_t; 1129 1130 #define SMB_LOCK_FLAG_INDEFINITE 0x0004 1131 #define SMB_LOCK_INDEFINITE_WAIT(lock) \ 1132 ((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE) 1133 1134 #define SMB_LOCK_TYPE_READWRITE 101 1135 #define SMB_LOCK_TYPE_READONLY 102 1136 1137 typedef struct vardata_block { 1138 uint8_t vdb_tag; 1139 uint32_t vdb_len; 1140 struct uio vdb_uio; 1141 struct iovec vdb_iovec[MAX_IOVEC]; 1142 } smb_vdb_t; 1143 1144 #define SMB_RW_MAGIC 0x52445257 /* 'RDRW' */ 1145 1146 typedef struct smb_rw_param { 1147 uint32_t rw_magic; 1148 smb_vdb_t rw_vdb; 1149 uint64_t rw_offset; 1150 uint32_t rw_last_write; 1151 uint16_t rw_mode; 1152 uint32_t rw_count; 1153 uint16_t rw_mincnt; 1154 uint16_t rw_dsoff; /* SMB data offset */ 1155 uint8_t rw_andx; /* SMB secondary andx command */ 1156 } smb_rw_param_t; 1157 1158 typedef struct smb_pathname { 1159 char *pn_path; 1160 char *pn_pname; 1161 char *pn_fname; 1162 char *pn_sname; 1163 char *pn_stype; 1164 } smb_pathname_t; 1165 1166 /* 1167 * fs_query_info 1168 */ 1169 typedef struct smb_fqi { 1170 smb_pathname_t fq_path; 1171 uint16_t fq_sattr; 1172 smb_node_t *fq_dnode; 1173 smb_node_t *fq_fnode; 1174 smb_attr_t fq_fattr; 1175 char fq_last_comp[MAXNAMELEN]; 1176 char fq_od_name[MAXNAMELEN]; 1177 } smb_fqi_t; 1178 1179 #define SMB_NULL_FQI_NODES(fqi) \ 1180 (fqi).fq_fnode = NULL; \ 1181 (fqi).fq_dnode = NULL; 1182 1183 #define FQM_DIR_MUST_EXIST 1 1184 #define FQM_PATH_MUST_EXIST 2 1185 #define FQM_PATH_MUST_NOT_EXIST 3 1186 1187 #define OPLOCK_MIN_TIMEOUT (5 * 1000) 1188 #define OPLOCK_STD_TIMEOUT (15 * 1000) 1189 #define OPLOCK_RETRIES 2 1190 1191 typedef struct { 1192 uint32_t severity; 1193 uint32_t status; 1194 uint16_t errcls; 1195 uint16_t errcode; 1196 } smb_error_t; 1197 1198 typedef struct open_param { 1199 smb_fqi_t fqi; 1200 uint16_t omode; 1201 uint16_t ofun; 1202 uint32_t nt_flags; 1203 uint32_t timeo; 1204 uint32_t dattr; 1205 timestruc_t crtime; 1206 timestruc_t mtime; 1207 uint64_t dsize; 1208 uint32_t desired_access; 1209 uint32_t share_access; 1210 uint32_t create_options; 1211 uint32_t create_disposition; 1212 boolean_t created_readonly; 1213 uint32_t ftype; 1214 uint32_t devstate; 1215 uint32_t action_taken; 1216 uint64_t fileid; 1217 uint32_t rootdirfid; 1218 /* This is only set by NTTransactCreate */ 1219 struct smb_sd *sd; 1220 uint8_t op_oplock_level; 1221 } open_param_t; 1222 1223 #define SMB_OPLOCK_NONE 0 1224 #define SMB_OPLOCK_EXCLUSIVE 1 1225 #define SMB_OPLOCK_BATCH 2 1226 #define SMB_OPLOCK_LEVEL_II 3 1227 1228 /* 1229 * SMB Request State Machine 1230 * ------------------------- 1231 * 1232 * T4 +------+ T0 1233 * +--------------------------->| FREE |---------------------------+ 1234 * | +------+ | 1235 * +-----------+ | 1236 * | COMPLETED | | 1237 * +-----------+ 1238 * ^ | 1239 * | T15 +----------+ v 1240 * +------------+ T6 | | +--------------+ 1241 * | CLEANED_UP |<-----------------| CANCELED | | INITIALIZING | 1242 * +------------+ | | +--------------+ 1243 * | ^ +----------+ | 1244 * | | ^ ^ ^ ^ | 1245 * | | +-------------+ | | | | 1246 * | | T3 | | | | T13 | T1 1247 * | +-------------------------+ | | +----------------------+ | 1248 * +----------------------------+ | | | | | 1249 * T16 | | | | +-----------+ | | 1250 * | \/ | | T5 | | v 1251 * +-----------------+ | T12 +--------+ | T2 +-----------+ 1252 * | EVENT_OCCURRED |------------->| ACTIVE |<--------------------| SUBMITTED | 1253 * +-----------------+ | +--------+ | +-----------+ 1254 * ^ | | ^ | | 1255 * | | T8 | | | T7 | 1256 * | T10 T9 | +----------+ | +-------+ | T11 1257 * | | | +-------+ | | 1258 * | | | T14 | | | 1259 * | | v | v | 1260 * +----------------------+ +--------------+ 1261 * | WAITING_EVENT | | WAITING_LOCK | 1262 * +----------------------+ +--------------+ 1263 * 1264 * 1265 * 1266 * 1267 * 1268 * Transition T0 1269 * 1270 * This transition occurs when the request is allocated and is still under the 1271 * control of the session thread. 1272 * 1273 * Transition T1 1274 * 1275 * This transition occurs when the session thread dispatches a task to treat the 1276 * request. 1277 * 1278 * Transition T2 1279 * 1280 * 1281 * 1282 * Transition T3 1283 * 1284 * A request completes and smbsr_cleanup is called to release resources 1285 * associated with the request (but not the smb_request_t itself). This 1286 * includes references on smb_ofile_t, smb_node_t, and other structures. 1287 * CLEANED_UP state exists to detect if we attempt to cleanup a request 1288 * multiple times and to allow us to detect that we are accessing a 1289 * request that has already been cleaned up. 1290 * 1291 * Transition T4 1292 * 1293 * 1294 * 1295 * Transition T5 1296 * 1297 * 1298 * 1299 * Transition T6 1300 * 1301 * 1302 * 1303 * Transition T7 1304 * 1305 * 1306 * 1307 * Transition T8 1308 * 1309 * 1310 * 1311 * Transition T9 1312 * 1313 * 1314 * 1315 * Transition T10 1316 * 1317 * 1318 * 1319 * Transition T11 1320 * 1321 * 1322 * 1323 * Transition T12 1324 * 1325 * 1326 * 1327 * Transition T13 1328 * 1329 * 1330 * 1331 * Transition T14 1332 * 1333 * 1334 * 1335 * Transition T15 1336 * 1337 * Request processing is completed (control returns from smb_dispatch) 1338 * 1339 * Transition T16 1340 * 1341 * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx" 1342 * sections remain to be processed. 1343 * 1344 */ 1345 1346 #define SMB_REQ_MAGIC 0x534D4252 /* 'SMBR' */ 1347 #define SMB_REQ_VALID(p) ASSERT((p)->sr_magic == SMB_REQ_MAGIC) 1348 1349 typedef enum smb_req_state { 1350 SMB_REQ_STATE_FREE = 0, 1351 SMB_REQ_STATE_INITIALIZING, 1352 SMB_REQ_STATE_SUBMITTED, 1353 SMB_REQ_STATE_ACTIVE, 1354 SMB_REQ_STATE_WAITING_EVENT, 1355 SMB_REQ_STATE_EVENT_OCCURRED, 1356 SMB_REQ_STATE_WAITING_LOCK, 1357 SMB_REQ_STATE_COMPLETED, 1358 SMB_REQ_STATE_CANCELED, 1359 SMB_REQ_STATE_CLEANED_UP, 1360 SMB_REQ_STATE_SENTINEL 1361 } smb_req_state_t; 1362 1363 typedef struct smb_request { 1364 uint32_t sr_magic; 1365 kmutex_t sr_mutex; 1366 list_node_t sr_session_lnd; 1367 smb_req_state_t sr_state; 1368 boolean_t sr_keep; 1369 kmem_cache_t *sr_cache; 1370 struct smb_server *sr_server; 1371 pid_t *sr_pid; 1372 int32_t sr_gmtoff; 1373 smb_session_t *session; 1374 smb_kmod_cfg_t *sr_cfg; 1375 smb_notify_change_req_t sr_ncr; 1376 1377 /* Info from session service header */ 1378 uint32_t sr_req_length; /* Excluding NBT header */ 1379 1380 /* Request buffer excluding NBT header */ 1381 void *sr_request_buf; 1382 1383 /* Fields for raw writes */ 1384 uint32_t sr_raw_data_length; 1385 void *sr_raw_data_buf; 1386 1387 smb_lock_t *sr_awaiting; 1388 struct mbuf_chain command; 1389 struct mbuf_chain reply; 1390 struct mbuf_chain raw_data; 1391 smb_malloc_list request_storage; 1392 struct smb_xa *r_xa; 1393 int andx_prev_wct; 1394 int cur_reply_offset; 1395 int orig_request_hdr; 1396 unsigned int reply_seqnum; /* reply sequence number */ 1397 unsigned char first_smb_com; /* command code */ 1398 unsigned char smb_com; /* command code */ 1399 1400 uint8_t smb_rcls; /* error code class */ 1401 uint8_t smb_reh; /* rsvd (AH DOS INT-24 ERR) */ 1402 uint16_t smb_err; /* error code */ 1403 smb_error_t smb_error; 1404 1405 uint8_t smb_flg; /* flags */ 1406 uint16_t smb_flg2; /* flags */ 1407 uint16_t smb_pid_high; /* high part of pid */ 1408 unsigned char smb_sig[8]; /* signiture */ 1409 uint16_t smb_tid; /* tree id # */ 1410 uint16_t smb_pid; /* caller's process id # */ 1411 uint16_t smb_uid; /* user id # */ 1412 uint16_t smb_mid; /* mutiplex id # */ 1413 unsigned char smb_wct; /* count of parameter words */ 1414 uint16_t smb_bcc; /* data byte count */ 1415 1416 /* Parameters */ 1417 struct mbuf_chain smb_vwv; /* variable width value */ 1418 1419 /* Data */ 1420 struct mbuf_chain smb_data; 1421 1422 uint16_t smb_fid; /* not in hdr, but common */ 1423 1424 unsigned char andx_com; 1425 uint16_t andx_off; 1426 1427 struct smb_tree *tid_tree; 1428 struct smb_ofile *fid_ofile; 1429 smb_user_t *uid_user; 1430 1431 union { 1432 struct tcon { 1433 char *path; 1434 char *service; 1435 int pwdlen; 1436 char *password; 1437 uint16_t flags; 1438 uint16_t optional_support; 1439 } tcon; 1440 1441 struct dirop { 1442 smb_fqi_t fqi; 1443 smb_fqi_t dst_fqi; 1444 } dirop; 1445 1446 open_param_t open; 1447 smb_rw_param_t *rw; 1448 uint32_t timestamp; 1449 } arg; 1450 1451 cred_t *user_cr; 1452 kthread_t *sr_worker; 1453 } smb_request_t; 1454 1455 #define SMB_READ_PROTOCOL(smb_nh_ptr) \ 1456 LE_IN32(((smb_nethdr_t *)(smb_nh_ptr))->sh_protocol) 1457 1458 #define SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \ 1459 (SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC) 1460 1461 #define SMB_READ_COMMAND(smb_nh_ptr) \ 1462 (((smb_nethdr_t *)(smb_nh_ptr))->sh_command) 1463 1464 #define SMB_IS_WRITERAW(rd_sr) \ 1465 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_WRITE_RAW) 1466 1467 1468 #define SR_FLG_OFFSET 9 1469 1470 #define MAX_TRANS_NAME 64 1471 1472 #define SMB_XA_FLAG_OPEN 0x0001 1473 #define SMB_XA_FLAG_CLOSE 0x0002 1474 #define SMB_XA_FLAG_COMPLETE 0x0004 1475 #define SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN)) 1476 1477 #define SMB_XA_MAGIC 0x534D4258 /* 'SMBX' */ 1478 1479 typedef struct smb_xa { 1480 uint32_t xa_magic; 1481 kmutex_t xa_mutex; 1482 list_node_t xa_lnd; 1483 1484 uint32_t xa_refcnt; 1485 uint32_t xa_flags; 1486 1487 struct smb_session *xa_session; 1488 1489 unsigned char smb_com; /* which TRANS type */ 1490 unsigned char smb_flg; /* flags */ 1491 uint16_t smb_flg2; /* flags */ 1492 uint16_t smb_tid; /* tree id number */ 1493 uint16_t smb_pid; /* caller's process id number */ 1494 uint16_t smb_uid; /* user id number */ 1495 uint32_t smb_func; /* NT_TRANS function */ 1496 1497 uint16_t xa_smb_mid; /* mutiplex id number */ 1498 uint16_t xa_smb_fid; /* TRANS2 secondary */ 1499 1500 unsigned int reply_seqnum; /* reply sequence number */ 1501 1502 uint32_t smb_tpscnt; /* total parameter bytes being sent */ 1503 uint32_t smb_tdscnt; /* total data bytes being sent */ 1504 uint32_t smb_mprcnt; /* max parameter bytes to return */ 1505 uint32_t smb_mdrcnt; /* max data bytes to return */ 1506 uint32_t smb_msrcnt; /* max setup words to return */ 1507 uint32_t smb_flags; /* additional information: */ 1508 /* bit 0 - if set, disconnect TID in smb_tid */ 1509 /* bit 1 - if set, transaction is one way */ 1510 /* (no final response) */ 1511 int32_t smb_timeout; /* number of milliseconds to await completion */ 1512 uint32_t smb_suwcnt; /* set up word count */ 1513 1514 1515 char *xa_smb_trans_name; 1516 1517 int req_disp_param; 1518 int req_disp_data; 1519 1520 struct mbuf_chain req_setup_mb; 1521 struct mbuf_chain req_param_mb; 1522 struct mbuf_chain req_data_mb; 1523 1524 struct mbuf_chain rep_setup_mb; 1525 struct mbuf_chain rep_param_mb; 1526 struct mbuf_chain rep_data_mb; 1527 } smb_xa_t; 1528 1529 1530 #define SDDF_NO_FLAGS 0 1531 #define SDDF_SUPPRESS_TID 0x0001 1532 #define SDDF_SUPPRESS_UID 0x0002 1533 1534 /* 1535 * SMB dispatch return codes. 1536 */ 1537 typedef enum { 1538 SDRC_SUCCESS = 0, 1539 SDRC_ERROR, 1540 SDRC_DROP_VC, 1541 SDRC_NO_REPLY, 1542 SDRC_SR_KEPT, 1543 SDRC_NOT_IMPLEMENTED 1544 } smb_sdrc_t; 1545 1546 #define VAR_BCC ((short)-1) 1547 1548 #define SMB_SERVER_MAGIC 0x53534552 /* 'SSER' */ 1549 1550 typedef struct { 1551 kstat_named_t open_files; 1552 kstat_named_t open_trees; 1553 kstat_named_t open_users; 1554 } smb_server_stats_t; 1555 1556 typedef struct { 1557 kthread_t *ld_kth; 1558 kt_did_t ld_ktdid; 1559 ksocket_t ld_so; 1560 struct sockaddr_in ld_sin; 1561 struct sockaddr_in6 ld_sin6; 1562 smb_session_list_t ld_session_list; 1563 } smb_listener_daemon_t; 1564 1565 typedef enum smb_server_state { 1566 SMB_SERVER_STATE_CREATED = 0, 1567 SMB_SERVER_STATE_CONFIGURED, 1568 SMB_SERVER_STATE_RUNNING, 1569 SMB_SERVER_STATE_DELETING, 1570 SMB_SERVER_STATE_SENTINEL 1571 } smb_server_state_t; 1572 1573 typedef struct smb_server { 1574 uint32_t sv_magic; 1575 kcondvar_t sv_cv; 1576 kmutex_t sv_mutex; 1577 list_node_t sv_lnd; 1578 smb_server_state_t sv_state; 1579 uint32_t sv_refcnt; 1580 pid_t sv_pid; 1581 zoneid_t sv_zid; 1582 smb_listener_daemon_t sv_nbt_daemon; 1583 smb_listener_daemon_t sv_tcp_daemon; 1584 krwlock_t sv_cfg_lock; 1585 smb_kmod_cfg_t sv_cfg; 1586 smb_session_t *sv_session; 1587 1588 kstat_t *sv_ksp; 1589 kmutex_t sv_ksp_mutex; 1590 char sv_ksp_name[KSTAT_STRLEN]; 1591 smb_server_stats_t sv_ks_data; 1592 1593 door_handle_t sv_lmshrd; 1594 1595 int32_t si_gmtoff; 1596 1597 smb_thread_t si_thread_timers; 1598 smb_thread_t si_thread_unexport; 1599 1600 taskq_t *sv_thread_pool; 1601 1602 kmem_cache_t *si_cache_unexport; 1603 kmem_cache_t *si_cache_vfs; 1604 kmem_cache_t *si_cache_request; 1605 kmem_cache_t *si_cache_session; 1606 kmem_cache_t *si_cache_user; 1607 kmem_cache_t *si_cache_tree; 1608 kmem_cache_t *si_cache_ofile; 1609 kmem_cache_t *si_cache_odir; 1610 1611 volatile uint32_t sv_open_trees; 1612 volatile uint32_t sv_open_files; 1613 volatile uint32_t sv_open_users; 1614 1615 smb_node_t *si_root_smb_node; 1616 smb_llist_t sv_vfs_list; 1617 smb_slist_t sv_unexport_list; 1618 } smb_server_t; 1619 1620 #define SMB_INFO_NETBIOS_SESSION_SVC_RUNNING 0x0001 1621 #define SMB_INFO_NETBIOS_SESSION_SVC_FAILED 0x0002 1622 #define SMB_INFO_USER_LEVEL_SECURITY 0x40000000 1623 #define SMB_INFO_ENCRYPT_PASSWORDS 0x80000000 1624 1625 #define SMB_NEW_KID() atomic_inc_64_nv(&smb_kids) 1626 #define SMB_UNIQ_FID() atomic_inc_32_nv(&smb_fids) 1627 1628 /* 1629 * This is to be used by Trans2SetFileInfo 1630 * and Trans2SetPathInfo 1631 */ 1632 typedef struct smb_trans2_setinfo { 1633 uint16_t level; 1634 struct smb_xa *ts_xa; 1635 struct smb_node *node; 1636 char *path; 1637 char name[MAXNAMELEN]; 1638 } smb_trans2_setinfo_t; 1639 1640 #define SMB_IS_STREAM(node) ((node)->unnamed_stream_node) 1641 1642 typedef struct smb_tsd { 1643 void (*proc)(); 1644 void *arg; 1645 char name[100]; 1646 } smb_tsd_t; 1647 1648 typedef struct smb_disp_entry { 1649 smb_sdrc_t (*sdt_pre_op)(smb_request_t *); 1650 smb_sdrc_t (*sdt_function)(smb_request_t *); 1651 void (*sdt_post_op)(smb_request_t *); 1652 char sdt_dialect; 1653 unsigned char sdt_flags; 1654 kstat_named_t sdt_dispatch_stats; /* invocations */ 1655 } smb_disp_entry_t; 1656 1657 #ifdef __cplusplus 1658 } 1659 #endif 1660 1661 #endif /* _SMBSRV_SMB_KTYPES_H */ 1662