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 /* 463 * Solaris file systems handle timestamps differently from NTFS. 464 * In order to provide a more similar view of an open file's 465 * timestamps, we cache the timestamps in the node and manipulate 466 * them in a manner more consistent with windows. 467 * t_cached is B_TRUE when timestamps are cached. 468 * Timestamps remain cached while there are open ofiles for the node. 469 * This includes open ofiles for named streams. t_open_ofiles is a 470 * count of open ofiles on the node, including named streams' ofiles, 471 * n_open_ofiles cannot be used as it doesn't include ofiles opened 472 * for the node's named streams. 473 */ 474 typedef struct smb_times { 475 uint32_t t_open_ofiles; 476 boolean_t t_cached; 477 timestruc_t t_atime; 478 timestruc_t t_mtime; 479 timestruc_t t_ctime; 480 timestruc_t t_crtime; 481 } smb_times_t; 482 483 #define SMB_NODE_MAGIC 0x4E4F4445 /* 'NODE' */ 484 #define SMB_NODE_VALID(p) ASSERT((p)->n_magic == SMB_NODE_MAGIC) 485 486 typedef enum { 487 SMB_NODE_STATE_AVAILABLE = 0, 488 SMB_NODE_STATE_OPLOCK_GRANTED, 489 SMB_NODE_STATE_OPLOCK_BREAKING, 490 SMB_NODE_STATE_DESTROYING 491 } smb_node_state_t; 492 493 typedef struct smb_node { 494 uint32_t n_magic; 495 krwlock_t n_lock; 496 kmutex_t n_mutex; 497 list_node_t n_lnd; 498 smb_node_state_t n_state; 499 uint32_t n_refcnt; 500 uint32_t n_hashkey; 501 smb_llist_t *n_hash_bucket; 502 uint32_t n_orig_uid; 503 uint32_t n_open_count; 504 smb_llist_t n_ofile_list; 505 smb_llist_t n_lock_list; 506 struct smb_ofile *readonly_creator; 507 volatile int flags; /* FILE_NOTIFY_CHANGE_* */ 508 volatile int waiting_event; /* # of clients requesting FCN */ 509 smb_times_t n_timestamps; /* cached timestamps */ 510 unsigned int what; 511 smb_oplock_t n_oplock; 512 struct smb_node *dir_snode; /* Directory of node */ 513 struct smb_node *unnamed_stream_node; /* set in stream nodes */ 514 /* Credentials for delayed delete */ 515 cred_t *delete_on_close_cred; 516 uint32_t n_delete_on_close_flags; 517 char od_name[MAXNAMELEN]; 518 vnode_t *vp; 519 smb_audit_buf_node_t *n_audit_buf; 520 } smb_node_t; 521 522 #define NODE_FLAGS_NOTIFY_CHANGE 0x10000fff 523 #define NODE_OPLOCKS_IN_FORCE 0x0000f000 524 #define NODE_OPLOCK_NONE 0x00000000 525 #define NODE_EXCLUSIVE_OPLOCK 0x00001000 526 #define NODE_BATCH_OPLOCK 0x00002000 527 #define NODE_LEVEL_II_OPLOCK 0x00003000 528 #define NODE_CAP_LEVEL_II 0x00010000 529 #define NODE_PROTOCOL_LOCK 0x00020000 530 #define NODE_FLAGS_WRITE_THROUGH 0x00100000 531 #define NODE_FLAGS_SYNCATIME 0x00200000 532 #define NODE_FLAGS_LOCKED 0x00400000 533 #define NODE_XATTR_DIR 0x01000000 534 #define NODE_FLAGS_CREATED 0x04000000 535 #define NODE_FLAGS_CHANGED 0x08000000 536 #define NODE_FLAGS_WATCH_TREE 0x10000000 537 #define NODE_FLAGS_SET_SIZE 0x20000000 538 #define NODE_FLAGS_DELETE_ON_CLOSE 0x40000000 539 #define NODE_FLAGS_EXECUTABLE 0x80000000 540 541 #define OPLOCK_TYPE(n) ((n)->flags & NODE_OPLOCKS_IN_FORCE) 542 #define OPLOCKS_IN_FORCE(n) (OPLOCK_TYPE(n) != NODE_OPLOCK_NONE) 543 #define EXCLUSIVE_OPLOCK_IN_FORCE(n) \ 544 (OPLOCK_TYPE(n) == NODE_EXCLUSIVE_OPLOCK) 545 #define BATCH_OPLOCK_IN_FORCE(n) (OPLOCK_TYPE(n) == NODE_BATCH_OPLOCK) 546 #define LEVEL_II_OPLOCK_IN_FORCE(n) (OPLOCK_TYPE(n) == NODE_LEVEL_II_OPLOCK) 547 548 #define SMB_NODE_VFS(node) ((node)->vp->v_vfsp) 549 #define SMB_NODE_FSID(node) ((node)->vp->v_vfsp->vfs_fsid) 550 551 /* 552 * Based on section 2.6.1.2 (Connection Management) of the June 13, 553 * 1996 CIFS spec, a server may terminate the transport connection 554 * due to inactivity. The client software is expected to be able to 555 * automatically reconnect to the server if this happens. Like much 556 * of the useful background information, this section appears to 557 * have been dropped from later revisions of the document. 558 * 559 * Each session has an activity timestamp that's updated whenever a 560 * request is dispatched. If the session is idle, i.e. receives no 561 * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be 562 * closed. 563 * 564 * Each session has an I/O semaphore to serialize communication with 565 * the client. For example, after receiving a raw-read request, the 566 * server is not allowed to send an oplock break to the client until 567 * after it has sent the raw-read data. 568 */ 569 #define SMB_SESSION_INACTIVITY_TIMEOUT (15 * 60) 570 571 #define SMB_SESSION_OFILE_MAX (16 * 1024) 572 573 /* 574 * When a connection is set up we need to remember both the client 575 * (peer) IP address and the local IP address used to establish the 576 * connection. When a client connects with a vc number of zero, we 577 * are supposed to abort any existing connections with that client 578 * (see notes in smb_negotiate.c and smb_session_setup_andx.c). For 579 * servers with multiple network interfaces or IP aliases, however, 580 * each interface has to be managed independently since the client 581 * is not aware of the server configuration. We have to allow the 582 * client to establish a connection on each interface with a vc 583 * number of zero without aborting the other connections. 584 * 585 * ipaddr: the client (peer) IP address for the session. 586 * local_ipaddr: the local IP address used to connect to the server. 587 */ 588 589 #define SMB_MAC_KEYSZ 512 590 591 struct smb_sign { 592 unsigned int seqnum; 593 unsigned int mackey_len; 594 unsigned int flags; 595 unsigned char mackey[SMB_MAC_KEYSZ]; 596 }; 597 598 #define SMB_SIGNING_ENABLED 1 599 #define SMB_SIGNING_CHECK 2 600 601 /* 602 * Session State Machine 603 * --------------------- 604 * 605 * +-----------------------------+ +------------------------------+ 606 * | SMB_SESSION_STATE_CONNECTED | | SMB_SESSION_STATE_TERMINATED | 607 * +-----------------------------+ +------------------------------+ 608 * T0| ^ 609 * +--------------------+ |T13 610 * v |T14 | 611 * +-------------------------------+ | +--------------------------------+ 612 * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED | 613 * +-------------------------------+ +--------------------------------+ 614 * T1| ^ ^ ^ ^ 615 * +----------+ |T9 | | | 616 * v | | | | 617 * +------------------------------+ | | | 618 * | SMB_SESSION_STATE_NEGOTIATED | | | | 619 * +------------------------------+ | | | 620 * ^| ^| | ^ | | | 621 * +----------------+| || | | | | | 622 * |+----------------+ || T7| |T8 | | | 623 * || || | | | | | 624 * || +----------------+| | | | | | 625 * || |+----------------+ | | | | | 626 * || || v | | | | 627 * || || +-----------------------------------+ T10| | | 628 * || || | SMB_SESSION_STATE_OPLOCK_BREAKING |----+ | | 629 * || || +-----------------------------------+ | | 630 * || ||T5 | | 631 * || |+-->+-----------------------------------+ T11| | 632 * || |T6 | SMB_SESSION_STATE_READ_RAW_ACTIVE |------+ | 633 * || +----+-----------------------------------+ | 634 * ||T3 | 635 * |+------->+------------------------------------+ T12| 636 * |T4 | SMB_SESSION_STATE_WRITE_RAW_ACTIVE |-------+ 637 * +---------+------------------------------------+ 638 * 639 * Transition T0 640 * 641 * 642 * 643 * Transition T1 644 * 645 * 646 * 647 * Transition T2 648 * 649 * 650 * 651 * Transition T3 652 * 653 * 654 * 655 * Transition T4 656 * 657 * 658 * 659 * Transition T5 660 * 661 * 662 * 663 * Transition T6 664 * 665 * 666 * 667 * Transition T7 668 * 669 * 670 * 671 * Transition T8 672 * 673 * 674 * 675 * Transition T9 676 * 677 * 678 * 679 * Transition T10 680 * 681 * 682 * 683 * Transition T11 684 * 685 * 686 * 687 * Transition T12 688 * 689 * 690 * 691 * Transition T13 692 * 693 * 694 * 695 * Transition T14 696 * 697 * 698 * 699 */ 700 #define SMB_SESSION_MAGIC 0x53455353 /* 'SESS' */ 701 #define SMB_SESSION_VALID(p) ASSERT((p)->s_magic == SMB_SESSION_MAGIC) 702 703 typedef enum { 704 SMB_SESSION_STATE_INITIALIZED = 0, 705 SMB_SESSION_STATE_DISCONNECTED, 706 SMB_SESSION_STATE_CONNECTED, 707 SMB_SESSION_STATE_ESTABLISHED, 708 SMB_SESSION_STATE_NEGOTIATED, 709 SMB_SESSION_STATE_OPLOCK_BREAKING, 710 SMB_SESSION_STATE_WRITE_RAW_ACTIVE, 711 SMB_SESSION_STATE_READ_RAW_ACTIVE, 712 SMB_SESSION_STATE_TERMINATED, 713 SMB_SESSION_STATE_SENTINEL 714 } smb_session_state_t; 715 716 typedef struct smb_session { 717 uint32_t s_magic; 718 smb_rwx_t s_lock; 719 list_node_t s_lnd; 720 uint64_t s_kid; 721 smb_session_state_t s_state; 722 uint32_t s_flags; 723 int s_write_raw_status; 724 kthread_t *s_thread; 725 kt_did_t s_ktdid; 726 smb_kmod_cfg_t s_cfg; 727 kmem_cache_t *s_cache; 728 kmem_cache_t *s_cache_request; 729 struct smb_server *s_server; 730 int32_t s_gmtoff; 731 uint32_t keep_alive; 732 uint64_t opentime; 733 uint16_t vcnumber; 734 uint16_t s_local_port; 735 smb_inaddr_t ipaddr; 736 smb_inaddr_t local_ipaddr; 737 char workstation[SMB_PI_MAX_HOST]; 738 int dialect; 739 int native_os; 740 uint32_t capabilities; 741 struct smb_sign signing; 742 743 ksocket_t sock; 744 745 smb_slist_t s_req_list; 746 smb_llist_t s_xa_list; 747 smb_llist_t s_user_list; 748 smb_idpool_t s_uid_pool; 749 smb_txlst_t s_txlst; 750 751 volatile uint32_t s_tree_cnt; 752 volatile uint32_t s_file_cnt; 753 volatile uint32_t s_dir_cnt; 754 755 uint16_t secmode; 756 uint32_t sesskey; 757 uint32_t challenge_len; 758 unsigned char challenge_key[8]; 759 unsigned char MAC_key[44]; 760 int64_t activity_timestamp; 761 /* 762 * Maximum negotiated buffer size between SMB client and server 763 * in SMB_SESSION_SETUP_ANDX 764 */ 765 uint16_t smb_msg_size; 766 uchar_t *outpipe_data; 767 int outpipe_datalen; 768 int outpipe_cookie; 769 list_t s_oplock_brkreqs; 770 } smb_session_t; 771 772 #define SMB_USER_MAGIC 0x55534552 /* 'USER' */ 773 774 #define SMB_USER_FLAG_GUEST SMB_ATF_GUEST 775 #define SMB_USER_FLAG_IPC SMB_ATF_ANON 776 #define SMB_USER_FLAG_ADMIN SMB_ATF_ADMIN 777 #define SMB_USER_FLAG_POWER_USER SMB_ATF_POWERUSER 778 #define SMB_USER_FLAG_BACKUP_OPERATOR SMB_ATF_BACKUPOP 779 780 #define SMB_USER_PRIV_TAKE_OWNERSHIP 0x00000001 781 #define SMB_USER_PRIV_BACKUP 0x00000002 782 #define SMB_USER_PRIV_RESTORE 0x00000004 783 #define SMB_USER_PRIV_SECURITY 0x00000008 784 785 786 typedef enum { 787 SMB_USER_STATE_LOGGED_IN = 0, 788 SMB_USER_STATE_LOGGING_OFF, 789 SMB_USER_STATE_LOGGED_OFF, 790 SMB_USER_STATE_SENTINEL 791 } smb_user_state_t; 792 793 typedef struct smb_user { 794 uint32_t u_magic; 795 list_node_t u_lnd; 796 kmutex_t u_mutex; 797 smb_user_state_t u_state; 798 799 struct smb_server *u_server; 800 smb_session_t *u_session; 801 uint16_t u_name_len; 802 char *u_name; 803 uint16_t u_domain_len; 804 char *u_domain; 805 time_t u_logon_time; 806 cred_t *u_cred; 807 cred_t *u_privcred; 808 809 smb_llist_t u_tree_list; 810 smb_idpool_t u_tid_pool; 811 812 uint32_t u_refcnt; 813 uint32_t u_flags; 814 uint32_t u_privileges; 815 uint16_t u_uid; 816 uint32_t u_audit_sid; 817 } smb_user_t; 818 819 #define SMB_TREE_MAGIC 0x54524545 /* 'TREE' */ 820 821 #define SMB_TYPENAMELEN _ST_FSTYPSZ 822 #define SMB_VOLNAMELEN 32 823 824 #define SMB_TREE_READONLY 0x00000001 825 #define SMB_TREE_SUPPORTS_ACLS 0x00000002 826 #define SMB_TREE_STREAMS 0x00000004 827 #define SMB_TREE_CASEINSENSITIVE 0x00000008 828 #define SMB_TREE_NO_CASESENSITIVE 0x00000010 829 #define SMB_TREE_NO_EXPORT 0x00000020 830 #define SMB_TREE_NO_OPLOCKS 0x00000040 831 #define SMB_TREE_NO_ATIME 0x00000080 832 #define SMB_TREE_XVATTR 0x00000100 833 #define SMB_TREE_DIRENTFLAGS 0x00000200 834 #define SMB_TREE_ACLONCREATE 0x00000400 835 #define SMB_TREE_ACEMASKONACCESS 0x00000800 836 #define SMB_TREE_NFS_MOUNTED 0x00001000 837 #define SMB_TREE_UNICODE_ON_DISK 0x00002000 838 #define SMB_TREE_CATIA 0x00004000 839 840 typedef enum { 841 SMB_TREE_STATE_CONNECTED = 0, 842 SMB_TREE_STATE_DISCONNECTING, 843 SMB_TREE_STATE_DISCONNECTED, 844 SMB_TREE_STATE_SENTINEL 845 } smb_tree_state_t; 846 847 typedef struct smb_tree { 848 uint32_t t_magic; 849 kmutex_t t_mutex; 850 list_node_t t_lnd; 851 smb_tree_state_t t_state; 852 853 struct smb_server *t_server; 854 smb_session_t *t_session; 855 smb_user_t *t_user; 856 smb_node_t *t_snode; 857 858 smb_llist_t t_ofile_list; 859 smb_idpool_t t_fid_pool; 860 861 smb_llist_t t_odir_list; 862 smb_idpool_t t_odid_pool; 863 864 uint32_t t_refcnt; 865 uint32_t t_flags; 866 int32_t t_res_type; 867 uint16_t t_tid; 868 uint16_t t_umask; 869 char t_sharename[MAXNAMELEN]; 870 char t_resource[MAXPATHLEN]; 871 char t_typename[SMB_TYPENAMELEN]; 872 char t_volume[SMB_VOLNAMELEN]; 873 acl_type_t t_acltype; 874 uint32_t t_access; 875 uint32_t t_shr_flags; 876 } smb_tree_t; 877 878 #define SMB_TREE_VFS(tree) ((tree)->t_snode->vp->v_vfsp) 879 #define SMB_TREE_FSID(tree) ((tree)->t_snode->vp->v_vfsp->vfs_fsid) 880 881 #define SMB_TREE_IS_READONLY(sr) \ 882 ((sr) != NULL && (sr)->tid_tree != NULL && \ 883 !((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS)) 884 885 #define SMB_TREE_IS_CASEINSENSITIVE(sr) \ 886 (((sr) && (sr)->tid_tree) ? \ 887 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0) 888 889 #define SMB_TREE_HAS_ACCESS(sr, acemask) \ 890 ((sr) == NULL ? ACE_ALL_PERMS : ( \ 891 (((sr) && (sr)->tid_tree) ? \ 892 (((sr)->tid_tree->t_access) & (acemask)) : 0))) 893 894 #define SMB_TREE_SUPPORTS_CATIA(sr) \ 895 (((sr) && (sr)->tid_tree) ? \ 896 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0) 897 898 /* 899 * SMB_TREE_CONTAINS_NODE is used to check that a node is in the same 900 * file system as the tree. 901 */ 902 #define SMB_TREE_CONTAINS_NODE(sr, node) \ 903 (((sr) && (sr)->tid_tree) ? \ 904 (SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node)) : 1) 905 906 /* 907 * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not. 908 * The macro takes into account 909 * - the tree readonly state 910 * - the node readonly state 911 * - whether the specified ofile is the readonly creator 912 * The readonly creator has write permission until the ofile is closed. 913 */ 914 915 #define SMB_OFILE_IS_READONLY(of) \ 916 (((of)->f_flags & SMB_OFLAGS_READONLY) || \ 917 smb_node_file_is_readonly((of)->f_node) || \ 918 (((of)->f_node->readonly_creator) && \ 919 ((of)->f_node->readonly_creator != (of)))) 920 921 /* 922 * SMB_PATHFILE_IS_READONLY indicates whether or not a file is 923 * readonly when the caller has a path rather than an ofile. Unlike 924 * SMB_OFILE_IS_READONLY, the caller cannot be the readonly creator, 925 * since that requires an ofile. 926 */ 927 928 #define SMB_PATHFILE_IS_READONLY(sr, node) \ 929 (SMB_TREE_IS_READONLY((sr)) || \ 930 smb_node_file_is_readonly((node)) || \ 931 ((node)->readonly_creator)) 932 933 #define PIPE_STATE_AUTH_VERIFY 0x00000001 934 935 /* 936 * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used 937 * at the interface between SMB and NDR RPC. 938 */ 939 typedef struct smb_opipe { 940 kmutex_t p_mutex; 941 kcondvar_t p_cv; 942 char *p_name; 943 uint32_t p_busy; 944 smb_opipe_hdr_t p_hdr; 945 smb_opipe_context_t p_context; 946 uint8_t *p_doorbuf; 947 uint8_t *p_data; 948 } smb_opipe_t; 949 950 /* 951 * The of_ftype of an open file should contain the SMB_FTYPE value 952 * (cifs.h) returned when the file/pipe was opened. The following 953 * assumptions are currently made: 954 * 955 * File Type Node PipeInfo 956 * --------- -------- -------- 957 * SMB_FTYPE_DISK Valid Null 958 * SMB_FTYPE_BYTE_PIPE Undefined Undefined 959 * SMB_FTYPE_MESG_PIPE Null Valid 960 * SMB_FTYPE_PRINTER Undefined Undefined 961 * SMB_FTYPE_UNKNOWN Undefined Undefined 962 */ 963 964 /* 965 * Some flags for ofile structure 966 * 967 * SMB_OFLAGS_SET_DELETE_ON_CLOSE 968 * Set this flag when the corresponding open operation whose 969 * DELETE_ON_CLOSE bit of the CreateOptions is set. If any 970 * open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE 971 * will be set for the file node upon close. 972 * 973 * SMB_OFLAGS_TIMESTAMPS_PENDING 974 * This flag gets set when a write operation is performed on the 975 * ofile. The timestamps will be updated, and the flags cleared, 976 * when the ofile gets closed or a setattr is performed on the ofile. 977 */ 978 979 #define SMB_OFLAGS_READONLY 0x0001 980 #define SMB_OFLAGS_EXECONLY 0x0002 981 #define SMB_OFLAGS_SET_DELETE_ON_CLOSE 0x0004 982 #define SMB_OFLAGS_LLF_POS_VALID 0x0008 983 #define SMB_OFLAGS_TIMESTAMPS_PENDING 0x0010 984 985 #define SMB_OFILE_MAGIC 0x4F464C45 /* 'OFLE' */ 986 #define SMB_OFILE_VALID(p) ASSERT((p)->f_magic == SMB_OFILE_MAGIC) 987 988 typedef enum { 989 SMB_OFILE_STATE_OPEN = 0, 990 SMB_OFILE_STATE_CLOSING, 991 SMB_OFILE_STATE_CLOSED, 992 SMB_OFILE_STATE_SENTINEL 993 } smb_ofile_state_t; 994 995 typedef struct smb_ofile { 996 uint32_t f_magic; 997 kmutex_t f_mutex; 998 list_node_t f_lnd; 999 list_node_t f_nnd; 1000 smb_ofile_state_t f_state; 1001 1002 struct smb_server *f_server; 1003 smb_session_t *f_session; 1004 smb_user_t *f_user; 1005 smb_tree_t *f_tree; 1006 smb_node_t *f_node; 1007 smb_opipe_t *f_pipe; 1008 1009 uint32_t f_uniqid; 1010 uint32_t f_refcnt; 1011 uint64_t f_seek_pos; 1012 uint32_t f_flags; 1013 uint32_t f_granted_access; 1014 uint32_t f_share_access; 1015 uint32_t f_create_options; 1016 uint16_t f_fid; 1017 uint16_t f_opened_by_pid; 1018 uint16_t f_ftype; 1019 uint64_t f_llf_pos; 1020 int f_mode; 1021 cred_t *f_cr; 1022 pid_t f_pid; 1023 boolean_t f_oplock_granted; 1024 boolean_t f_oplock_exit; 1025 uint32_t f_explicit_times; 1026 1027 } smb_ofile_t; 1028 1029 #define SMB_ODIR_MAGIC 0x4F444952 /* 'ODIR' */ 1030 #define SMB_ODIR_BUFSIZE (8 * 1024) 1031 1032 #define SMB_ODIR_FLAG_WILDCARDS 0x0001 1033 #define SMB_ODIR_FLAG_IGNORE_CASE 0x0002 1034 #define SMB_ODIR_FLAG_XATTR 0x0004 1035 #define SMB_ODIR_FLAG_EDIRENT 0x0008 1036 #define SMB_ODIR_FLAG_CATIA 0x0010 1037 1038 typedef enum { 1039 SMB_ODIR_STATE_OPEN = 0, 1040 SMB_ODIR_STATE_IN_USE, 1041 SMB_ODIR_STATE_CLOSING, 1042 SMB_ODIR_STATE_CLOSED, 1043 SMB_ODIR_STATE_SENTINEL 1044 } smb_odir_state_t; 1045 1046 typedef enum { 1047 SMB_ODIR_RESUME_IDX, 1048 SMB_ODIR_RESUME_COOKIE, 1049 SMB_ODIR_RESUME_FNAME 1050 } smb_odir_resume_type_t; 1051 1052 typedef struct smb_odir_resume { 1053 smb_odir_resume_type_t or_type; 1054 int or_idx; 1055 uint32_t or_cookie; 1056 char *or_fname; 1057 } smb_odir_resume_t; 1058 1059 /* 1060 * Flags used when opening an odir 1061 */ 1062 #define SMB_ODIR_OPENF_BACKUP_INTENT 0x01 1063 1064 typedef struct smb_odir { 1065 uint32_t d_magic; 1066 kmutex_t d_mutex; 1067 list_node_t d_lnd; 1068 smb_odir_state_t d_state; 1069 smb_session_t *d_session; 1070 smb_tree_t *d_tree; 1071 smb_node_t *d_dnode; 1072 cred_t *d_cred; 1073 uint16_t d_odid; 1074 uint16_t d_opened_by_pid; 1075 uint16_t d_sattr; 1076 uint32_t d_refcnt; 1077 uint32_t d_flags; 1078 boolean_t d_eof; 1079 int d_bufsize; 1080 uint64_t d_offset; 1081 union { 1082 char *u_bufptr; 1083 edirent_t *u_edp; 1084 dirent64_t *u_dp; 1085 } d_u; 1086 uint32_t d_cookies[SMB_MAX_SEARCH]; 1087 char d_pattern[MAXNAMELEN]; 1088 char d_buf[SMB_ODIR_BUFSIZE]; 1089 } smb_odir_t; 1090 #define d_bufptr d_u.u_bufptr 1091 #define d_edp d_u.u_edp 1092 #define d_dp d_u.u_dp 1093 1094 typedef struct smb_odirent { 1095 char od_name[MAXNAMELEN]; /* on disk name */ 1096 ino64_t od_ino; 1097 uint32_t od_eflags; 1098 } smb_odirent_t; 1099 1100 typedef struct smb_fileinfo { 1101 char fi_name[MAXNAMELEN]; 1102 char fi_name83[SMB_SHORTNAMELEN]; 1103 char fi_shortname[SMB_SHORTNAMELEN]; 1104 uint32_t fi_cookie; 1105 uint32_t fi_dosattr; /* DOS attributes */ 1106 uint64_t fi_nodeid; /* file system node id */ 1107 uint64_t fi_size; /* file size in bytes */ 1108 uint64_t fi_alloc_size; /* allocation size in bytes */ 1109 timestruc_t fi_atime; /* last access */ 1110 timestruc_t fi_mtime; /* last modification */ 1111 timestruc_t fi_ctime; /* last status change */ 1112 timestruc_t fi_crtime; /* file creation */ 1113 } smb_fileinfo_t; 1114 1115 typedef struct smb_streaminfo { 1116 uint64_t si_size; 1117 uint64_t si_alloc_size; 1118 char si_name[MAXPATHLEN]; 1119 } smb_streaminfo_t; 1120 1121 #define SMB_LOCK_MAGIC 0x4C4F434B /* 'LOCK' */ 1122 1123 typedef struct smb_lock { 1124 uint32_t l_magic; 1125 kmutex_t l_mutex; 1126 list_node_t l_lnd; 1127 kcondvar_t l_cv; 1128 1129 list_node_t l_conflict_lnd; 1130 smb_slist_t l_conflict_list; 1131 1132 smb_session_t *l_session; 1133 smb_ofile_t *l_file; 1134 struct smb_request *l_sr; 1135 1136 uint32_t l_flags; 1137 uint64_t l_session_kid; 1138 struct smb_lock *l_blocked_by; /* Debug info only */ 1139 1140 uint16_t l_pid; 1141 uint16_t l_uid; 1142 uint32_t l_type; 1143 uint64_t l_start; 1144 uint64_t l_length; 1145 clock_t l_end_time; 1146 } smb_lock_t; 1147 1148 #define SMB_LOCK_FLAG_INDEFINITE 0x0004 1149 #define SMB_LOCK_INDEFINITE_WAIT(lock) \ 1150 ((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE) 1151 1152 #define SMB_LOCK_TYPE_READWRITE 101 1153 #define SMB_LOCK_TYPE_READONLY 102 1154 1155 typedef struct vardata_block { 1156 uint8_t vdb_tag; 1157 uint32_t vdb_len; 1158 struct uio vdb_uio; 1159 struct iovec vdb_iovec[MAX_IOVEC]; 1160 } smb_vdb_t; 1161 1162 #define SMB_RW_MAGIC 0x52445257 /* 'RDRW' */ 1163 1164 typedef struct smb_rw_param { 1165 uint32_t rw_magic; 1166 smb_vdb_t rw_vdb; 1167 uint64_t rw_offset; 1168 uint32_t rw_last_write; 1169 uint16_t rw_mode; 1170 uint32_t rw_count; 1171 uint16_t rw_mincnt; 1172 uint16_t rw_dsoff; /* SMB data offset */ 1173 uint8_t rw_andx; /* SMB secondary andx command */ 1174 } smb_rw_param_t; 1175 1176 typedef struct smb_pathname { 1177 char *pn_path; 1178 char *pn_pname; 1179 char *pn_fname; 1180 char *pn_sname; 1181 char *pn_stype; 1182 } smb_pathname_t; 1183 1184 /* 1185 * fs_query_info 1186 */ 1187 typedef struct smb_fqi { 1188 smb_pathname_t fq_path; 1189 uint16_t fq_sattr; 1190 smb_node_t *fq_dnode; 1191 smb_node_t *fq_fnode; 1192 smb_attr_t fq_fattr; 1193 char fq_last_comp[MAXNAMELEN]; 1194 char fq_od_name[MAXNAMELEN]; 1195 } smb_fqi_t; 1196 1197 #define SMB_NULL_FQI_NODES(fqi) \ 1198 (fqi).fq_fnode = NULL; \ 1199 (fqi).fq_dnode = NULL; 1200 1201 #define FQM_DIR_MUST_EXIST 1 1202 #define FQM_PATH_MUST_EXIST 2 1203 #define FQM_PATH_MUST_NOT_EXIST 3 1204 1205 #define OPLOCK_MIN_TIMEOUT (5 * 1000) 1206 #define OPLOCK_STD_TIMEOUT (15 * 1000) 1207 #define OPLOCK_RETRIES 2 1208 1209 typedef struct { 1210 uint32_t severity; 1211 uint32_t status; 1212 uint16_t errcls; 1213 uint16_t errcode; 1214 } smb_error_t; 1215 1216 typedef struct open_param { 1217 smb_fqi_t fqi; 1218 uint16_t omode; 1219 uint16_t ofun; 1220 uint32_t nt_flags; 1221 uint32_t timeo; 1222 uint32_t dattr; 1223 timestruc_t crtime; 1224 timestruc_t mtime; 1225 uint64_t dsize; 1226 uint32_t desired_access; 1227 uint32_t share_access; 1228 uint32_t create_options; 1229 uint32_t create_disposition; 1230 boolean_t created_readonly; 1231 uint32_t ftype; 1232 uint32_t devstate; 1233 uint32_t action_taken; 1234 uint64_t fileid; 1235 uint32_t rootdirfid; 1236 /* This is only set by NTTransactCreate */ 1237 struct smb_sd *sd; 1238 uint8_t op_oplock_level; 1239 } open_param_t; 1240 1241 #define SMB_OPLOCK_NONE 0 1242 #define SMB_OPLOCK_EXCLUSIVE 1 1243 #define SMB_OPLOCK_BATCH 2 1244 #define SMB_OPLOCK_LEVEL_II 3 1245 1246 /* 1247 * SMB Request State Machine 1248 * ------------------------- 1249 * 1250 * T4 +------+ T0 1251 * +--------------------------->| FREE |---------------------------+ 1252 * | +------+ | 1253 * +-----------+ | 1254 * | COMPLETED | | 1255 * +-----------+ 1256 * ^ | 1257 * | T15 +----------+ v 1258 * +------------+ T6 | | +--------------+ 1259 * | CLEANED_UP |<-----------------| CANCELED | | INITIALIZING | 1260 * +------------+ | | +--------------+ 1261 * | ^ +----------+ | 1262 * | | ^ ^ ^ ^ | 1263 * | | +-------------+ | | | | 1264 * | | T3 | | | | T13 | T1 1265 * | +-------------------------+ | | +----------------------+ | 1266 * +----------------------------+ | | | | | 1267 * T16 | | | | +-----------+ | | 1268 * | \/ | | T5 | | v 1269 * +-----------------+ | T12 +--------+ | T2 +-----------+ 1270 * | EVENT_OCCURRED |------------->| ACTIVE |<--------------------| SUBMITTED | 1271 * +-----------------+ | +--------+ | +-----------+ 1272 * ^ | | ^ | | 1273 * | | T8 | | | T7 | 1274 * | T10 T9 | +----------+ | +-------+ | T11 1275 * | | | +-------+ | | 1276 * | | | T14 | | | 1277 * | | v | v | 1278 * +----------------------+ +--------------+ 1279 * | WAITING_EVENT | | WAITING_LOCK | 1280 * +----------------------+ +--------------+ 1281 * 1282 * 1283 * 1284 * 1285 * 1286 * Transition T0 1287 * 1288 * This transition occurs when the request is allocated and is still under the 1289 * control of the session thread. 1290 * 1291 * Transition T1 1292 * 1293 * This transition occurs when the session thread dispatches a task to treat the 1294 * request. 1295 * 1296 * Transition T2 1297 * 1298 * 1299 * 1300 * Transition T3 1301 * 1302 * A request completes and smbsr_cleanup is called to release resources 1303 * associated with the request (but not the smb_request_t itself). This 1304 * includes references on smb_ofile_t, smb_node_t, and other structures. 1305 * CLEANED_UP state exists to detect if we attempt to cleanup a request 1306 * multiple times and to allow us to detect that we are accessing a 1307 * request that has already been cleaned up. 1308 * 1309 * Transition T4 1310 * 1311 * 1312 * 1313 * Transition T5 1314 * 1315 * 1316 * 1317 * Transition T6 1318 * 1319 * 1320 * 1321 * Transition T7 1322 * 1323 * 1324 * 1325 * Transition T8 1326 * 1327 * 1328 * 1329 * Transition T9 1330 * 1331 * 1332 * 1333 * Transition T10 1334 * 1335 * 1336 * 1337 * Transition T11 1338 * 1339 * 1340 * 1341 * Transition T12 1342 * 1343 * 1344 * 1345 * Transition T13 1346 * 1347 * 1348 * 1349 * Transition T14 1350 * 1351 * 1352 * 1353 * Transition T15 1354 * 1355 * Request processing is completed (control returns from smb_dispatch) 1356 * 1357 * Transition T16 1358 * 1359 * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx" 1360 * sections remain to be processed. 1361 * 1362 */ 1363 1364 #define SMB_REQ_MAGIC 0x534D4252 /* 'SMBR' */ 1365 #define SMB_REQ_VALID(p) ASSERT((p)->sr_magic == SMB_REQ_MAGIC) 1366 1367 typedef enum smb_req_state { 1368 SMB_REQ_STATE_FREE = 0, 1369 SMB_REQ_STATE_INITIALIZING, 1370 SMB_REQ_STATE_SUBMITTED, 1371 SMB_REQ_STATE_ACTIVE, 1372 SMB_REQ_STATE_WAITING_EVENT, 1373 SMB_REQ_STATE_EVENT_OCCURRED, 1374 SMB_REQ_STATE_WAITING_LOCK, 1375 SMB_REQ_STATE_COMPLETED, 1376 SMB_REQ_STATE_CANCELED, 1377 SMB_REQ_STATE_CLEANED_UP, 1378 SMB_REQ_STATE_SENTINEL 1379 } smb_req_state_t; 1380 1381 typedef struct smb_request { 1382 uint32_t sr_magic; 1383 kmutex_t sr_mutex; 1384 list_node_t sr_session_lnd; 1385 smb_req_state_t sr_state; 1386 boolean_t sr_keep; 1387 kmem_cache_t *sr_cache; 1388 struct smb_server *sr_server; 1389 pid_t *sr_pid; 1390 int32_t sr_gmtoff; 1391 smb_session_t *session; 1392 smb_kmod_cfg_t *sr_cfg; 1393 smb_notify_change_req_t sr_ncr; 1394 1395 /* Info from session service header */ 1396 uint32_t sr_req_length; /* Excluding NBT header */ 1397 1398 /* Request buffer excluding NBT header */ 1399 void *sr_request_buf; 1400 1401 /* Fields for raw writes */ 1402 uint32_t sr_raw_data_length; 1403 void *sr_raw_data_buf; 1404 1405 smb_lock_t *sr_awaiting; 1406 struct mbuf_chain command; 1407 struct mbuf_chain reply; 1408 struct mbuf_chain raw_data; 1409 smb_malloc_list request_storage; 1410 struct smb_xa *r_xa; 1411 int andx_prev_wct; 1412 int cur_reply_offset; 1413 int orig_request_hdr; 1414 unsigned int reply_seqnum; /* reply sequence number */ 1415 unsigned char first_smb_com; /* command code */ 1416 unsigned char smb_com; /* command code */ 1417 1418 uint8_t smb_rcls; /* error code class */ 1419 uint8_t smb_reh; /* rsvd (AH DOS INT-24 ERR) */ 1420 uint16_t smb_err; /* error code */ 1421 smb_error_t smb_error; 1422 1423 uint8_t smb_flg; /* flags */ 1424 uint16_t smb_flg2; /* flags */ 1425 uint16_t smb_pid_high; /* high part of pid */ 1426 unsigned char smb_sig[8]; /* signiture */ 1427 uint16_t smb_tid; /* tree id # */ 1428 uint16_t smb_pid; /* caller's process id # */ 1429 uint16_t smb_uid; /* user id # */ 1430 uint16_t smb_mid; /* mutiplex id # */ 1431 unsigned char smb_wct; /* count of parameter words */ 1432 uint16_t smb_bcc; /* data byte count */ 1433 1434 /* Parameters */ 1435 struct mbuf_chain smb_vwv; /* variable width value */ 1436 1437 /* Data */ 1438 struct mbuf_chain smb_data; 1439 1440 uint16_t smb_fid; /* not in hdr, but common */ 1441 1442 unsigned char andx_com; 1443 uint16_t andx_off; 1444 1445 struct smb_tree *tid_tree; 1446 struct smb_ofile *fid_ofile; 1447 smb_user_t *uid_user; 1448 1449 union { 1450 struct tcon { 1451 char *path; 1452 char *service; 1453 int pwdlen; 1454 char *password; 1455 uint16_t flags; 1456 uint16_t optional_support; 1457 } tcon; 1458 1459 struct dirop { 1460 smb_fqi_t fqi; 1461 smb_fqi_t dst_fqi; 1462 uint16_t info_level; 1463 } dirop; 1464 1465 open_param_t open; 1466 smb_rw_param_t *rw; 1467 uint32_t timestamp; 1468 } arg; 1469 1470 cred_t *user_cr; 1471 kthread_t *sr_worker; 1472 } smb_request_t; 1473 1474 #define SMB_READ_PROTOCOL(smb_nh_ptr) \ 1475 LE_IN32(((smb_nethdr_t *)(smb_nh_ptr))->sh_protocol) 1476 1477 #define SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \ 1478 (SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC) 1479 1480 #define SMB_READ_COMMAND(smb_nh_ptr) \ 1481 (((smb_nethdr_t *)(smb_nh_ptr))->sh_command) 1482 1483 #define SMB_IS_WRITERAW(rd_sr) \ 1484 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_WRITE_RAW) 1485 1486 1487 #define SR_FLG_OFFSET 9 1488 1489 #define MAX_TRANS_NAME 64 1490 1491 #define SMB_XA_FLAG_OPEN 0x0001 1492 #define SMB_XA_FLAG_CLOSE 0x0002 1493 #define SMB_XA_FLAG_COMPLETE 0x0004 1494 #define SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN)) 1495 1496 #define SMB_XA_MAGIC 0x534D4258 /* 'SMBX' */ 1497 1498 typedef struct smb_xa { 1499 uint32_t xa_magic; 1500 kmutex_t xa_mutex; 1501 list_node_t xa_lnd; 1502 1503 uint32_t xa_refcnt; 1504 uint32_t xa_flags; 1505 1506 struct smb_session *xa_session; 1507 1508 unsigned char smb_com; /* which TRANS type */ 1509 unsigned char smb_flg; /* flags */ 1510 uint16_t smb_flg2; /* flags */ 1511 uint16_t smb_tid; /* tree id number */ 1512 uint16_t smb_pid; /* caller's process id number */ 1513 uint16_t smb_uid; /* user id number */ 1514 uint32_t smb_func; /* NT_TRANS function */ 1515 1516 uint16_t xa_smb_mid; /* mutiplex id number */ 1517 uint16_t xa_smb_fid; /* TRANS2 secondary */ 1518 1519 unsigned int reply_seqnum; /* reply sequence number */ 1520 1521 uint32_t smb_tpscnt; /* total parameter bytes being sent */ 1522 uint32_t smb_tdscnt; /* total data bytes being sent */ 1523 uint32_t smb_mprcnt; /* max parameter bytes to return */ 1524 uint32_t smb_mdrcnt; /* max data bytes to return */ 1525 uint32_t smb_msrcnt; /* max setup words to return */ 1526 uint32_t smb_flags; /* additional information: */ 1527 /* bit 0 - if set, disconnect TID in smb_tid */ 1528 /* bit 1 - if set, transaction is one way */ 1529 /* (no final response) */ 1530 int32_t smb_timeout; /* number of milliseconds to await completion */ 1531 uint32_t smb_suwcnt; /* set up word count */ 1532 1533 1534 char *xa_smb_trans_name; 1535 1536 int req_disp_param; 1537 int req_disp_data; 1538 1539 struct mbuf_chain req_setup_mb; 1540 struct mbuf_chain req_param_mb; 1541 struct mbuf_chain req_data_mb; 1542 1543 struct mbuf_chain rep_setup_mb; 1544 struct mbuf_chain rep_param_mb; 1545 struct mbuf_chain rep_data_mb; 1546 } smb_xa_t; 1547 1548 1549 #define SDDF_NO_FLAGS 0 1550 #define SDDF_SUPPRESS_TID 0x0001 1551 #define SDDF_SUPPRESS_UID 0x0002 1552 1553 /* 1554 * SMB dispatch return codes. 1555 */ 1556 typedef enum { 1557 SDRC_SUCCESS = 0, 1558 SDRC_ERROR, 1559 SDRC_DROP_VC, 1560 SDRC_NO_REPLY, 1561 SDRC_SR_KEPT, 1562 SDRC_NOT_IMPLEMENTED 1563 } smb_sdrc_t; 1564 1565 #define VAR_BCC ((short)-1) 1566 1567 #define SMB_SERVER_MAGIC 0x53534552 /* 'SSER' */ 1568 1569 typedef struct { 1570 kstat_named_t open_files; 1571 kstat_named_t open_trees; 1572 kstat_named_t open_users; 1573 } smb_server_stats_t; 1574 1575 typedef struct { 1576 kthread_t *ld_kth; 1577 kt_did_t ld_ktdid; 1578 ksocket_t ld_so; 1579 struct sockaddr_in ld_sin; 1580 struct sockaddr_in6 ld_sin6; 1581 smb_session_list_t ld_session_list; 1582 } smb_listener_daemon_t; 1583 1584 typedef enum smb_server_state { 1585 SMB_SERVER_STATE_CREATED = 0, 1586 SMB_SERVER_STATE_CONFIGURED, 1587 SMB_SERVER_STATE_RUNNING, 1588 SMB_SERVER_STATE_DELETING, 1589 SMB_SERVER_STATE_SENTINEL 1590 } smb_server_state_t; 1591 1592 typedef struct smb_server { 1593 uint32_t sv_magic; 1594 kcondvar_t sv_cv; 1595 kmutex_t sv_mutex; 1596 list_node_t sv_lnd; 1597 smb_server_state_t sv_state; 1598 uint32_t sv_refcnt; 1599 pid_t sv_pid; 1600 zoneid_t sv_zid; 1601 smb_listener_daemon_t sv_nbt_daemon; 1602 smb_listener_daemon_t sv_tcp_daemon; 1603 krwlock_t sv_cfg_lock; 1604 smb_kmod_cfg_t sv_cfg; 1605 smb_session_t *sv_session; 1606 1607 kstat_t *sv_ksp; 1608 kmutex_t sv_ksp_mutex; 1609 char sv_ksp_name[KSTAT_STRLEN]; 1610 smb_server_stats_t sv_ks_data; 1611 1612 door_handle_t sv_lmshrd; 1613 1614 int32_t si_gmtoff; 1615 1616 smb_thread_t si_thread_timers; 1617 smb_thread_t si_thread_unexport; 1618 1619 taskq_t *sv_thread_pool; 1620 1621 kmem_cache_t *si_cache_unexport; 1622 kmem_cache_t *si_cache_vfs; 1623 kmem_cache_t *si_cache_request; 1624 kmem_cache_t *si_cache_session; 1625 kmem_cache_t *si_cache_user; 1626 kmem_cache_t *si_cache_tree; 1627 kmem_cache_t *si_cache_ofile; 1628 kmem_cache_t *si_cache_odir; 1629 1630 volatile uint32_t sv_open_trees; 1631 volatile uint32_t sv_open_files; 1632 volatile uint32_t sv_open_users; 1633 1634 smb_node_t *si_root_smb_node; 1635 smb_llist_t sv_vfs_list; 1636 smb_slist_t sv_unexport_list; 1637 } smb_server_t; 1638 1639 #define SMB_INFO_NETBIOS_SESSION_SVC_RUNNING 0x0001 1640 #define SMB_INFO_NETBIOS_SESSION_SVC_FAILED 0x0002 1641 #define SMB_INFO_USER_LEVEL_SECURITY 0x40000000 1642 #define SMB_INFO_ENCRYPT_PASSWORDS 0x80000000 1643 1644 #define SMB_NEW_KID() atomic_inc_64_nv(&smb_kids) 1645 #define SMB_UNIQ_FID() atomic_inc_32_nv(&smb_fids) 1646 1647 /* 1648 * This is to be used by Trans2SetFileInfo 1649 * and Trans2SetPathInfo 1650 */ 1651 typedef struct smb_trans2_setinfo { 1652 uint16_t level; 1653 struct smb_xa *ts_xa; 1654 struct smb_node *node; 1655 char *path; 1656 char name[MAXNAMELEN]; 1657 } smb_trans2_setinfo_t; 1658 1659 #define SMB_IS_STREAM(node) ((node)->unnamed_stream_node) 1660 1661 typedef struct smb_tsd { 1662 void (*proc)(); 1663 void *arg; 1664 char name[100]; 1665 } smb_tsd_t; 1666 1667 typedef struct smb_disp_entry { 1668 smb_sdrc_t (*sdt_pre_op)(smb_request_t *); 1669 smb_sdrc_t (*sdt_function)(smb_request_t *); 1670 void (*sdt_post_op)(smb_request_t *); 1671 char sdt_dialect; 1672 unsigned char sdt_flags; 1673 kstat_named_t sdt_dispatch_stats; /* invocations */ 1674 } smb_disp_entry_t; 1675 1676 #ifdef __cplusplus 1677 } 1678 #endif 1679 1680 #endif /* _SMBSRV_SMB_KTYPES_H */ 1681