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 /* 23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright 2016 Syneto S.R.L. All rights reserved. 25 * Copyright 2017 Nexenta Systems, Inc. All rights reserved. 26 */ 27 28 /* 29 * Function prototypes for the SMB module. 30 */ 31 32 #ifndef _SMB_KPROTO_H_ 33 #define _SMB_KPROTO_H_ 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #include <sys/types.h> 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 #include <sys/debug.h> 43 #include <sys/kmem.h> 44 #include <sys/socket.h> 45 #include <sys/ksocket.h> 46 #include <sys/cred.h> 47 #include <sys/nbmlock.h> 48 #include <sys/sunddi.h> 49 #include <sys/atomic.h> 50 #include <smbsrv/smb.h> 51 #include <smbsrv/string.h> 52 #include <smbsrv/smb_vops.h> 53 #include <smbsrv/smb_xdr.h> 54 #include <smbsrv/smb_token.h> 55 #include <smbsrv/smb_ktypes.h> 56 #include <smbsrv/smb_ioctl.h> 57 58 extern int smb_maxbufsize; 59 extern int smb_flush_required; 60 extern int smb_dirsymlink_enable; 61 extern int smb_oplock_levelII; 62 extern int smb_oplock_timeout; 63 extern int smb_oplock_min_timeout; 64 extern int smb_shortnames; 65 extern int smb_sign_debug; 66 extern uint_t smb_audit_flags; 67 extern int smb_ssetup_threshold; 68 extern int smb_tcon_threshold; 69 extern int smb_opipe_threshold; 70 extern int smb_ssetup_timeout; 71 extern int smb_tcon_timeout; 72 extern int smb_opipe_timeout; 73 extern int smb_allow_advisory_locks; 74 extern const uint32_t smb_vop_dosattr_settable; 75 76 /* Thread priorities - see smb_init.c */ 77 extern int smbsrv_base_pri; 78 extern int smbsrv_listen_pri; 79 extern int smbsrv_receive_pri; 80 extern int smbsrv_worker_pri; 81 extern int smbsrv_notify_pri; 82 extern int smbsrv_timer_pri; 83 84 extern kmem_cache_t *smb_cache_request; 85 extern kmem_cache_t *smb_cache_session; 86 extern kmem_cache_t *smb_cache_user; 87 extern kmem_cache_t *smb_cache_tree; 88 extern kmem_cache_t *smb_cache_ofile; 89 extern kmem_cache_t *smb_cache_odir; 90 extern kmem_cache_t *smb_cache_opipe; 91 extern kmem_cache_t *smb_cache_event; 92 extern kmem_cache_t *smb_cache_lock; 93 94 extern kmem_cache_t *smb_kshare_cache_vfs; 95 96 time_t smb_get_boottime(void); 97 int smb_server_lookup(smb_server_t **); 98 void smb_server_release(smb_server_t *); 99 100 /* 101 * SMB request handers called from the dispatcher. Each SMB request 102 * is handled in three phases: pre, com (command) and post. 103 * 104 * The pre-handler is primarily to set things up for the DTrace start 105 * probe. Typically, the SMB request is unmarshalled so that request 106 * specific context can be traced. This is also a useful place to 107 * allocate memory that will be used throughout the processing of the 108 * command. 109 * 110 * The com-handler performs the requested operation: request validation, 111 * bulk (write) incoming data decode, implementation of the appropriate 112 * algorithm and transmission of a response (as appropriate). 113 * 114 * The post-handler is always called, regardless of success or failure 115 * of the pre or com functions, to trigger the DTrace done probe and 116 * deallocate memory allocated in the pre-handler. 117 */ 118 #define SMB_SDT_OPS(NAME) \ 119 smb_pre_##NAME, \ 120 smb_com_##NAME, \ 121 smb_post_##NAME 122 123 #define SMB_COM_DECL(NAME) \ 124 smb_sdrc_t smb_pre_##NAME(smb_request_t *); \ 125 smb_sdrc_t smb_com_##NAME(smb_request_t *); \ 126 void smb_post_##NAME(smb_request_t *) 127 128 SMB_COM_DECL(check_directory); 129 SMB_COM_DECL(close); 130 SMB_COM_DECL(close_and_tree_disconnect); 131 SMB_COM_DECL(close_print_file); 132 SMB_COM_DECL(create); 133 SMB_COM_DECL(create_directory); 134 SMB_COM_DECL(create_new); 135 SMB_COM_DECL(create_temporary); 136 SMB_COM_DECL(delete); 137 SMB_COM_DECL(delete_directory); 138 SMB_COM_DECL(echo); 139 SMB_COM_DECL(find); 140 SMB_COM_DECL(find_close); 141 SMB_COM_DECL(find_close2); 142 SMB_COM_DECL(find_unique); 143 SMB_COM_DECL(flush); 144 SMB_COM_DECL(get_print_queue); 145 SMB_COM_DECL(invalid); 146 SMB_COM_DECL(ioctl); 147 SMB_COM_DECL(lock_and_read); 148 SMB_COM_DECL(lock_byte_range); 149 SMB_COM_DECL(locking_andx); 150 SMB_COM_DECL(logoff_andx); 151 SMB_COM_DECL(negotiate); 152 SMB_COM_DECL(nt_cancel); 153 SMB_COM_DECL(nt_create_andx); 154 SMB_COM_DECL(nt_rename); 155 SMB_COM_DECL(nt_transact); 156 SMB_COM_DECL(nt_transact_secondary); 157 SMB_COM_DECL(open); 158 SMB_COM_DECL(open_andx); 159 SMB_COM_DECL(open_print_file); 160 SMB_COM_DECL(process_exit); 161 SMB_COM_DECL(query_information); 162 SMB_COM_DECL(query_information2); 163 SMB_COM_DECL(query_information_disk); 164 SMB_COM_DECL(read); 165 SMB_COM_DECL(read_andx); 166 SMB_COM_DECL(read_raw); 167 SMB_COM_DECL(rename); 168 SMB_COM_DECL(search); 169 SMB_COM_DECL(seek); 170 SMB_COM_DECL(session_setup_andx); 171 SMB_COM_DECL(set_information); 172 SMB_COM_DECL(set_information2); 173 SMB_COM_DECL(transaction); 174 SMB_COM_DECL(transaction2); 175 SMB_COM_DECL(transaction2_secondary); 176 SMB_COM_DECL(transaction_secondary); 177 SMB_COM_DECL(tree_connect); 178 SMB_COM_DECL(tree_connect_andx); 179 SMB_COM_DECL(tree_disconnect); 180 SMB_COM_DECL(unlock_byte_range); 181 SMB_COM_DECL(write); 182 SMB_COM_DECL(write_and_close); 183 SMB_COM_DECL(write_and_unlock); 184 SMB_COM_DECL(write_andx); 185 SMB_COM_DECL(write_print_file); 186 SMB_COM_DECL(write_raw); 187 188 #define SMB_NT_TRANSACT_DECL(NAME) \ 189 smb_sdrc_t smb_pre_##NAME(smb_request_t *, smb_xa_t *); \ 190 smb_sdrc_t smb_##NAME(smb_request_t *, smb_xa_t *); \ 191 void smb_post_##NAME(smb_request_t *, smb_xa_t *) 192 193 SMB_NT_TRANSACT_DECL(nt_transact_create); 194 195 smb_sdrc_t smb_nt_transact_notify_change(smb_request_t *, smb_xa_t *); 196 smb_sdrc_t smb_nt_transact_query_security_info(smb_request_t *, smb_xa_t *); 197 smb_sdrc_t smb_nt_transact_set_security_info(smb_request_t *, smb_xa_t *); 198 smb_sdrc_t smb_nt_transact_ioctl(smb_request_t *, smb_xa_t *); 199 smb_sdrc_t smb_nt_transact_rename(smb_request_t *, smb_xa_t *); 200 smb_sdrc_t smb_nt_transact_query_quota(smb_request_t *, smb_xa_t *); 201 smb_sdrc_t smb_nt_transact_set_quota(smb_request_t *, smb_xa_t *); 202 203 smb_sdrc_t smb_com_trans2_open2(smb_request_t *, smb_xa_t *); 204 smb_sdrc_t smb_com_trans2_create_directory(smb_request_t *, smb_xa_t *); 205 smb_sdrc_t smb_com_trans2_find_first2(smb_request_t *, smb_xa_t *); 206 smb_sdrc_t smb_com_trans2_find_next2(smb_request_t *, smb_xa_t *); 207 smb_sdrc_t smb_com_trans2_query_fs_information(smb_request_t *, smb_xa_t *); 208 smb_sdrc_t smb_com_trans2_set_fs_information(smb_request_t *, smb_xa_t *); 209 smb_sdrc_t smb_com_trans2_query_path_information(smb_request_t *, smb_xa_t *); 210 smb_sdrc_t smb_com_trans2_query_file_information(smb_request_t *, smb_xa_t *); 211 smb_sdrc_t smb_com_trans2_set_path_information(smb_request_t *, smb_xa_t *); 212 smb_sdrc_t smb_com_trans2_set_file_information(smb_request_t *, smb_xa_t *); 213 smb_sdrc_t smb_com_trans2_get_dfs_referral(smb_request_t *, smb_xa_t *); 214 215 uint32_t smb_query_stream_info(smb_request_t *, mbuf_chain_t *, 216 smb_queryinfo_t *); 217 int smb_fssize(smb_request_t *, smb_fssize_t *); 218 219 /* smb_quota.c */ 220 uint32_t smb_quota_query_user_quota(smb_request_t *, uid_t, smb_quota_t *); 221 int smb_quota_query(smb_server_t *, smb_quota_query_t *, 222 smb_quota_response_t *); 223 int smb_quota_set(smb_server_t *, smb_quota_set_t *, uint32_t *); 224 uint32_t smb_quota_init_sids(mbuf_chain_t *, smb_quota_query_t *, 225 smb_ofile_t *); 226 uint32_t smb_quota_decode_sids(mbuf_chain_t *, list_t *); 227 void smb_quota_free_sids(smb_quota_query_t *); 228 void smb_quota_max_quota(mbuf_chain_t *, smb_quota_query_t *); 229 uint32_t smb_quota_decode_quotas(mbuf_chain_t *, list_t *); 230 uint32_t smb_quota_encode_quotas(mbuf_chain_t *, smb_quota_query_t *, 231 smb_quota_response_t *, smb_ofile_t *); 232 void smb_quota_free_quotas(list_t *); 233 234 void smb_query_shortname(smb_node_t *, smb_queryinfo_t *); 235 236 uint32_t smb_dfs_get_referrals(smb_request_t *, smb_fsctl_t *); 237 238 int smb1_newrq_negotiate(smb_request_t *); 239 smb_sdrc_t smb1_negotiate_smb2(smb_request_t *sr); 240 241 uint32_t smb_set_basic_info(smb_request_t *, smb_setinfo_t *); 242 uint32_t smb_set_eof_info(smb_request_t *, smb_setinfo_t *); 243 uint32_t smb_set_alloc_info(smb_request_t *, smb_setinfo_t *); 244 uint32_t smb_set_disposition_info(smb_request_t *, smb_setinfo_t *); 245 246 uint32_t smb_setinfo_rename(smb_request_t *, smb_node_t *, char *, int); 247 uint32_t smb_common_rename(smb_request_t *, smb_fqi_t *, smb_fqi_t *); 248 249 uint32_t smb_setinfo_link(smb_request_t *, smb_node_t *, char *, int); 250 uint32_t smb_make_link(smb_request_t *, smb_fqi_t *, smb_fqi_t *); 251 252 253 /* 254 * Logging functions 255 */ 256 void smb_log_flush(void); 257 void smb_correct_keep_alive_values(uint32_t new_keep_alive); 258 void smb_close_all_connections(void); 259 260 int smb_net_id(uint32_t); 261 262 /* 263 * oplock functions - node operations 264 */ 265 void smb_oplock_acquire(smb_request_t *sr, smb_node_t *, smb_ofile_t *); 266 void smb_oplock_release(smb_node_t *, smb_ofile_t *); 267 int smb_oplock_break(smb_request_t *, smb_node_t *, uint32_t); 268 void smb_oplock_break_levelII(smb_node_t *); 269 void smb_oplock_ack(smb_node_t *, smb_ofile_t *, uint8_t); 270 void smb_oplock_broadcast(smb_node_t *); 271 272 void smb1_oplock_break_notification(smb_request_t *, uint8_t); 273 void smb2_oplock_break_notification(smb_request_t *, uint8_t); 274 275 /* 276 * range lock functions - node operations 277 */ 278 uint32_t smb_lock_get_lock_count(smb_node_t *, smb_ofile_t *); 279 uint32_t smb_unlock_range(smb_request_t *, uint64_t, uint64_t, uint32_t); 280 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t, 281 uint32_t, uint32_t); 282 uint32_t smb_lock_range_cancel(smb_request_t *, uint64_t, uint64_t, uint32_t); 283 void smb_lock_range_error(smb_request_t *, uint32_t); 284 285 int smb_lock_range_access(smb_request_t *, smb_node_t *, 286 uint64_t, uint64_t, boolean_t); 287 288 DWORD smb_nbl_conflict(smb_node_t *, uint64_t, uint64_t, nbl_op_t); 289 290 void smb_mangle(const char *, ino64_t, char *, size_t); 291 int smb_unmangle(smb_node_t *, char *, char *, int, uint32_t); 292 boolean_t smb_needs_mangled(const char *); 293 boolean_t smb_maybe_mangled(char *); 294 boolean_t smb_is_reserved_dos_name(const char *); 295 boolean_t smb_is_invalid_filename(const char *); 296 297 void smbsr_cleanup(smb_request_t *sr); 298 299 int smbsr_connect_tree(smb_request_t *); 300 301 int smb_common_create_directory(smb_request_t *); 302 303 void smb_convert_wildcards(char *); 304 boolean_t smb_contains_wildcards(const char *); 305 int smb_ascii_or_unicode_strlen(smb_request_t *, char *); 306 int smb_ascii_or_unicode_strlen_null(smb_request_t *, char *); 307 int smb_ascii_or_unicode_null_len(smb_request_t *); 308 309 int smb_search(smb_request_t *); 310 311 uint32_t smb_common_create(smb_request_t *); 312 uint32_t smb_common_open(smb_request_t *); 313 int smb_common_write(smb_request_t *, smb_rw_param_t *); 314 315 void smb_pathname_init(smb_request_t *, smb_pathname_t *, char *); 316 boolean_t smb_pathname_validate(smb_request_t *, smb_pathname_t *); 317 boolean_t smb_validate_dirname(smb_request_t *, smb_pathname_t *); 318 boolean_t smb_validate_object_name(smb_request_t *, smb_pathname_t *); 319 boolean_t smb_validate_stream_name(smb_request_t *, smb_pathname_t *); 320 boolean_t smb_is_stream_name(char *); 321 void smb_stream_parse_name(char *, char *, char *); 322 323 324 uint32_t smb_omode_to_amask(uint32_t desired_access); 325 326 void sshow_distribution_info(char *); 327 328 uint32_t smb2sr_go_async(smb_request_t *sr, 329 smb_sdrc_t (*async_func)(smb_request_t *)); 330 331 void smb_dispatch_stats_init(smb_server_t *); 332 void smb_dispatch_stats_fini(smb_server_t *); 333 void smb_dispatch_stats_update(smb_server_t *, 334 smb_kstat_req_t *, int, int); 335 336 int smb1sr_newrq(smb_request_t *); 337 int smb1sr_newrq_cancel(smb_request_t *); 338 void smb1sr_work(smb_request_t *); 339 340 int smbsr_encode_empty_result(smb_request_t *); 341 void smbsr_lookup_file(smb_request_t *); 342 void smbsr_release_file(smb_request_t *); 343 344 int smbsr_decode_vwv(smb_request_t *sr, const char *, ...); 345 int smbsr_decode_data(smb_request_t *sr, const char *, ...); 346 boolean_t smbsr_decode_data_avail(smb_request_t *); 347 int smbsr_encode_result(smb_request_t *, int, int, const char *, ...); 348 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr); 349 void smbsr_send_reply(smb_request_t *); 350 351 uint32_t smb_errno2status(int); 352 uint16_t smb_status2doserr(uint32_t); 353 void smbsr_map_errno(int, smb_error_t *); 354 void smbsr_set_error(smb_request_t *, smb_error_t *); 355 void smbsr_errno(smb_request_t *, int); 356 void smbsr_status(smb_request_t *, DWORD, uint16_t, uint16_t); 357 #define smbsr_error(SR, ST, CL, CO) \ 358 smbsr_status(SR, ST, CL, CO) 359 #define smbsr_warn(SR, ST, CL, CO) \ 360 smbsr_status(SR, ST, CL, CO) 361 void smbsr_status_smb2(smb_request_t *, DWORD); 362 363 int clock_get_milli_uptime(void); 364 365 int smb_mbc_vencodef(mbuf_chain_t *, const char *, va_list); 366 int smb_mbc_vdecodef(mbuf_chain_t *, const char *, va_list); 367 int smb_mbc_decodef(mbuf_chain_t *, const char *, ...); 368 int smb_mbc_encodef(mbuf_chain_t *, const char *, ...); 369 int smb_mbc_peek(mbuf_chain_t *, int, const char *, ...); 370 int smb_mbc_poke(mbuf_chain_t *, int, const char *, ...); 371 int smb_mbc_put_mem(mbuf_chain_t *, void *, int); 372 int smb_mbc_copy(mbuf_chain_t *, const mbuf_chain_t *, int, int); 373 374 void smbsr_encode_header(smb_request_t *sr, int wct, 375 int bcc, const char *fmt, ...); 376 377 void smb_encode_sd(mbuf_chain_t *, smb_sd_t *, uint32_t); 378 void smb_encode_sid(mbuf_chain_t *, smb_sid_t *); 379 smb_sid_t *smb_decode_sid(mbuf_chain_t *, uint32_t); 380 uint32_t smb_decode_sd(mbuf_chain_t *, smb_sd_t *); 381 382 uint32_t smb_pad_align(uint32_t, uint32_t); 383 384 /* 385 * Socket functions 386 */ 387 ksocket_t smb_socreate(int domain, int type, int protocol); 388 void smb_soshutdown(ksocket_t so); 389 void smb_sodestroy(ksocket_t so); 390 int smb_sorecv(ksocket_t so, void *msg, size_t len); 391 void smb_net_txl_constructor(smb_txlst_t *); 392 void smb_net_txl_destructor(smb_txlst_t *); 393 int smb_net_send_uio(smb_session_t *, struct uio *); 394 395 /* 396 * SMB RPC interface 397 */ 398 void smb_opipe_dealloc(smb_opipe_t *); 399 int smb_opipe_open(smb_request_t *, uint32_t); 400 void smb_opipe_close(smb_ofile_t *); 401 int smb_opipe_read(smb_request_t *, struct uio *); 402 int smb_opipe_write(smb_request_t *, struct uio *); 403 int smb_opipe_getattr(smb_ofile_t *, smb_attr_t *); 404 int smb_opipe_getname(smb_ofile_t *, char *, size_t); 405 uint32_t smb_opipe_fsctl(smb_request_t *, smb_fsctl_t *); 406 407 void smb_kdoor_init(smb_server_t *); 408 void smb_kdoor_fini(smb_server_t *); 409 int smb_kdoor_open(smb_server_t *, int); 410 void smb_kdoor_close(smb_server_t *); 411 int smb_kdoor_upcall(smb_server_t *, uint32_t, 412 void *, xdrproc_t, void *, xdrproc_t); 413 void fksmb_kdoor_open(smb_server_t *, void *); 414 415 /* 416 * SMB server functions (file smb_server.c) 417 */ 418 int smb_server_get_count(void); 419 int smb_server_g_init(void); 420 void smb_server_g_fini(void); 421 int smb_server_create(void); 422 int smb_server_delete(void); 423 int smb_server_configure(smb_ioc_cfg_t *); 424 int smb_server_start(smb_ioc_start_t *); 425 int smb_server_stop(void); 426 boolean_t smb_server_is_stopping(smb_server_t *); 427 void smb_server_cancel_event(smb_server_t *, uint32_t); 428 int smb_server_notify_event(smb_ioc_event_t *); 429 uint32_t smb_server_get_session_count(smb_server_t *); 430 int smb_server_set_gmtoff(smb_ioc_gmt_t *); 431 int smb_server_numopen(smb_ioc_opennum_t *); 432 int smb_server_enum(smb_ioc_svcenum_t *); 433 int smb_server_session_close(smb_ioc_session_t *); 434 int smb_server_file_close(smb_ioc_fileid_t *); 435 int smb_server_sharevp(smb_server_t *, const char *, vnode_t **); 436 int smb_server_unshare(const char *); 437 438 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *); 439 440 int smb_server_spooldoc(smb_ioc_spooldoc_t *); 441 int smb_spool_add_doc(smb_tree_t *, smb_kspooldoc_t *); 442 void smb_spool_add_fid(smb_server_t *, uint16_t); 443 444 void smb_server_inc_nbt_sess(smb_server_t *); 445 void smb_server_dec_nbt_sess(smb_server_t *); 446 void smb_server_inc_tcp_sess(smb_server_t *); 447 void smb_server_dec_tcp_sess(smb_server_t *); 448 void smb_server_inc_users(smb_server_t *); 449 void smb_server_dec_users(smb_server_t *); 450 void smb_server_inc_trees(smb_server_t *); 451 void smb_server_dec_trees(smb_server_t *); 452 void smb_server_inc_files(smb_server_t *); 453 void smb_server_dec_files(smb_server_t *); 454 void smb_server_inc_pipes(smb_server_t *); 455 void smb_server_dec_pipes(smb_server_t *); 456 void smb_server_add_rxb(smb_server_t *, int64_t); 457 void smb_server_add_txb(smb_server_t *, int64_t); 458 void smb_server_inc_req(smb_server_t *); 459 460 smb_event_t *smb_event_create(smb_server_t *, int); 461 void smb_event_destroy(smb_event_t *); 462 uint32_t smb_event_txid(smb_event_t *); 463 int smb_event_wait(smb_event_t *); 464 void smb_event_notify(smb_server_t *, uint32_t); 465 466 /* 467 * SMB node functions (file smb_node.c) 468 */ 469 void smb_node_init(void); 470 void smb_node_fini(void); 471 smb_node_t *smb_node_lookup(smb_request_t *, smb_arg_open_t *, 472 cred_t *, vnode_t *, char *, smb_node_t *, smb_node_t *); 473 smb_node_t *smb_stream_node_lookup(smb_request_t *, cred_t *, 474 smb_node_t *, vnode_t *, vnode_t *, char *); 475 476 void smb_node_ref(smb_node_t *); 477 void smb_node_release(smb_node_t *); 478 void smb_node_rename(smb_node_t *, smb_node_t *, smb_node_t *, char *); 479 int smb_node_root_init(smb_server_t *, smb_node_t **); 480 void smb_node_add_lock(smb_node_t *, smb_lock_t *); 481 void smb_node_destroy_lock(smb_node_t *, smb_lock_t *); 482 void smb_node_destroy_lock_by_ofile(smb_node_t *, smb_ofile_t *); 483 void smb_node_start_crit(smb_node_t *, krw_t); 484 void smb_node_end_crit(smb_node_t *); 485 int smb_node_in_crit(smb_node_t *); 486 void smb_node_rdlock(smb_node_t *); 487 void smb_node_wrlock(smb_node_t *); 488 void smb_node_unlock(smb_node_t *); 489 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *); 490 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *); 491 void smb_node_inc_open_ofiles(smb_node_t *); 492 uint32_t smb_node_dec_open_ofiles(smb_node_t *); 493 void smb_node_inc_opening_count(smb_node_t *); 494 void smb_node_dec_opening_count(smb_node_t *); 495 boolean_t smb_node_is_file(smb_node_t *); 496 boolean_t smb_node_is_dir(smb_node_t *); 497 boolean_t smb_node_is_symlink(smb_node_t *); 498 boolean_t smb_node_is_dfslink(smb_node_t *); 499 boolean_t smb_node_is_reparse(smb_node_t *); 500 boolean_t smb_node_is_vfsroot(smb_node_t *); 501 boolean_t smb_node_is_system(smb_node_t *); 502 503 uint32_t smb_node_open_check(smb_node_t *, uint32_t, uint32_t); 504 DWORD smb_node_rename_check(smb_node_t *); 505 DWORD smb_node_delete_check(smb_node_t *); 506 boolean_t smb_node_share_check(smb_node_t *); 507 508 void smb_node_fcn_subscribe(smb_node_t *); 509 void smb_node_fcn_unsubscribe(smb_node_t *); 510 void smb_node_notify_change(smb_node_t *, uint_t, const char *); 511 512 int smb_node_getattr(smb_request_t *, smb_node_t *, cred_t *, 513 smb_ofile_t *, smb_attr_t *); 514 int smb_node_setattr(smb_request_t *, smb_node_t *, cred_t *, 515 smb_ofile_t *, smb_attr_t *); 516 uint32_t smb_node_set_delete_on_close(smb_node_t *, cred_t *, uint32_t); 517 void smb_node_reset_delete_on_close(smb_node_t *); 518 void smb_node_delete_on_close(smb_node_t *); 519 boolean_t smb_node_file_is_readonly(smb_node_t *); 520 int smb_node_getpath(smb_node_t *, vnode_t *, char *, uint32_t); 521 int smb_node_getmntpath(smb_node_t *, char *, uint32_t); 522 int smb_node_getshrpath(smb_node_t *, smb_tree_t *, char *, uint32_t); 523 524 /* 525 * Pathname functions 526 */ 527 528 int smb_pathname_reduce(smb_request_t *, cred_t *, 529 const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *); 530 531 int smb_pathname(smb_request_t *, char *, int, smb_node_t *, 532 smb_node_t *, smb_node_t **, smb_node_t **, cred_t *); 533 534 /* 535 * smb_vfs functions 536 */ 537 538 int smb_vfs_hold(smb_export_t *, vfs_t *); 539 void smb_vfs_rele(smb_export_t *, vfs_t *); 540 void smb_vfs_rele_all(smb_export_t *); 541 542 /* 543 * smb_notify.c 544 */ 545 uint32_t smb_notify_act1(smb_request_t *, uint32_t, uint32_t); 546 uint32_t smb_notify_act2(smb_request_t *); 547 uint32_t smb_notify_act3(smb_request_t *); 548 void smb_notify_ofile(smb_ofile_t *, uint_t, const char *); 549 void smb_nt_transact_notify_finish(void *); 550 void smb2_change_notify_finish(void *); 551 552 int smb_fem_fcn_install(smb_node_t *); 553 void smb_fem_fcn_uninstall(smb_node_t *); 554 int smb_fem_oplock_install(smb_node_t *); 555 void smb_fem_oplock_uninstall(smb_node_t *); 556 557 /* FEM */ 558 559 int smb_fem_init(void); 560 void smb_fem_fini(void); 561 562 int smb_try_grow(smb_request_t *sr, int64_t new_size); 563 564 unsigned short smb_worker_getnum(); 565 566 /* SMB signing routines smb_signing.c */ 567 void smb_sign_begin(smb_request_t *, smb_token_t *); 568 int smb_sign_check_request(smb_request_t *); 569 int smb_sign_check_secondary(smb_request_t *, unsigned int); 570 void smb_sign_reply(smb_request_t *, mbuf_chain_t *); 571 /* SMB2, but here because it's called from common code. */ 572 void smb2_sign_begin(smb_request_t *, smb_token_t *); 573 574 boolean_t smb_sattr_check(uint16_t, uint16_t); 575 576 void smb_request_cancel(smb_request_t *); 577 void smb_request_wait(smb_request_t *); 578 579 /* 580 * authentication support (smb_authenticate.c) 581 */ 582 int smb_authenticate_ext(smb_request_t *); 583 int smb_authenticate_old(smb_request_t *); 584 void smb_authsock_close(smb_user_t *, ksocket_t); 585 586 /* 587 * session functions (file smb_session.c) 588 */ 589 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int); 590 void smb_session_receiver(smb_session_t *); 591 void smb_session_disconnect(smb_session_t *); 592 void smb_session_timers(smb_llist_t *); 593 void smb_session_delete(smb_session_t *session); 594 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *, 595 smb_request_t *); 596 void smb_session_config(smb_session_t *session); 597 void smb_session_disconnect_from_share(smb_llist_t *, char *); 598 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *); 599 smb_user_t *smb_session_lookup_uid(smb_session_t *, uint16_t); 600 smb_user_t *smb_session_lookup_uid_st(smb_session_t *session, 601 uint16_t uid, smb_user_state_t st); 602 void smb_session_post_user(smb_session_t *, smb_user_t *); 603 void smb_session_post_tree(smb_session_t *, smb_tree_t *); 604 smb_tree_t *smb_session_lookup_tree(smb_session_t *, uint16_t); 605 smb_tree_t *smb_session_lookup_share(smb_session_t *, const char *, 606 smb_tree_t *); 607 smb_tree_t *smb_session_lookup_volume(smb_session_t *, const char *, 608 smb_tree_t *); 609 void smb_session_close_pid(smb_session_t *, uint32_t); 610 void smb_session_disconnect_owned_trees(smb_session_t *, smb_user_t *); 611 void smb_session_disconnect_trees(smb_session_t *); 612 void smb_session_disconnect_share(smb_session_t *, const char *); 613 void smb_session_getclient(smb_session_t *, char *, size_t); 614 boolean_t smb_session_isclient(smb_session_t *, const char *); 615 void smb_session_correct_keep_alive_values(smb_llist_t *, uint32_t); 616 void smb_session_oplock_break(smb_request_t *, uint8_t); 617 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *); 618 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *); 619 boolean_t smb_session_oplocks_enable(smb_session_t *); 620 boolean_t smb_session_levelII_oplocks(smb_session_t *); 621 622 #define SMB_SESSION_GET_ID(s) ((s)->s_kid) 623 624 smb_request_t *smb_request_alloc(smb_session_t *, int); 625 void smb_request_free(smb_request_t *); 626 627 /* 628 * ofile functions (file smb_ofile.c) 629 */ 630 smb_ofile_t *smb_ofile_lookup_by_fid(smb_request_t *, uint16_t); 631 smb_ofile_t *smb_ofile_lookup_by_uniqid(smb_tree_t *, uint32_t); 632 boolean_t smb_ofile_disallow_fclose(smb_ofile_t *); 633 smb_ofile_t *smb_ofile_open(smb_request_t *, smb_node_t *, 634 smb_arg_open_t *, uint16_t, uint32_t, smb_error_t *); 635 void smb_ofile_close(smb_ofile_t *, int32_t); 636 void smb_ofile_delete(void *); 637 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t); 638 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *); 639 void smb_ofile_flush(smb_request_t *, smb_ofile_t *); 640 boolean_t smb_ofile_hold(smb_ofile_t *); 641 void smb_ofile_release(smb_ofile_t *); 642 void smb_ofile_request_complete(smb_ofile_t *); 643 void smb_ofile_close_all(smb_tree_t *); 644 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t); 645 void smb_ofile_set_flags(smb_ofile_t *, uint32_t); 646 boolean_t smb_ofile_is_open(smb_ofile_t *); 647 int smb_ofile_enum(smb_ofile_t *, smb_svcenum_t *); 648 uint32_t smb_ofile_open_check(smb_ofile_t *, uint32_t, uint32_t); 649 uint32_t smb_ofile_rename_check(smb_ofile_t *); 650 uint32_t smb_ofile_delete_check(smb_ofile_t *); 651 boolean_t smb_ofile_share_check(smb_ofile_t *); 652 cred_t *smb_ofile_getcred(smb_ofile_t *); 653 void smb_ofile_set_delete_on_close(smb_ofile_t *); 654 void smb_delayed_write_timer(smb_llist_t *); 655 void smb_ofile_set_quota_resume(smb_ofile_t *, char *); 656 void smb_ofile_get_quota_resume(smb_ofile_t *, char *, int); 657 658 #define SMB_OFILE_GET_SESSION(of) ((of)->f_session) 659 #define SMB_OFILE_GET_TREE(of) ((of)->f_tree) 660 #define SMB_OFILE_GET_FID(of) ((of)->f_fid) 661 #define SMB_OFILE_GET_NODE(of) ((of)->f_node) 662 663 #define smb_ofile_granted_access(_of_) ((_of_)->f_granted_access) 664 665 /* 666 * odir functions (file smb_odir.c) 667 */ 668 uint32_t smb_odir_openpath(smb_request_t *, char *, uint16_t, uint32_t, 669 smb_odir_t **); 670 uint32_t smb_odir_openfh(smb_request_t *, const char *, uint16_t, 671 smb_odir_t **); 672 uint32_t smb_odir_openat(smb_request_t *, smb_node_t *, smb_odir_t **); 673 void smb_odir_reopen(smb_odir_t *, const char *, uint16_t); 674 void smb_odir_close(smb_odir_t *); 675 boolean_t smb_odir_hold(smb_odir_t *); 676 void smb_odir_release(smb_odir_t *); 677 void smb_odir_delete(void *); 678 679 int smb_odir_read(smb_request_t *, smb_odir_t *, 680 smb_odirent_t *, boolean_t *); 681 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *, 682 smb_fileinfo_t *, uint16_t *); 683 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *, 684 smb_streaminfo_t *, boolean_t *); 685 686 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie); 687 void smb_odir_save_fname(smb_odir_t *, uint32_t, const char *); 688 689 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *); 690 691 /* 692 * SMB user functions (file smb_user.c) 693 */ 694 smb_user_t *smb_user_new(smb_session_t *); 695 int smb_user_logon(smb_user_t *, cred_t *, 696 char *, char *, uint32_t, uint32_t, uint32_t); 697 void smb_user_logoff(smb_user_t *); 698 void smb_user_delete(void *); 699 void smb_user_auth_tmo(void *); 700 701 boolean_t smb_user_is_admin(smb_user_t *); 702 boolean_t smb_user_namecmp(smb_user_t *, const char *); 703 int smb_user_enum(smb_user_t *, smb_svcenum_t *); 704 boolean_t smb_user_hold(smb_user_t *); 705 void smb_user_hold_internal(smb_user_t *); 706 void smb_user_release(smb_user_t *); 707 cred_t *smb_user_getcred(smb_user_t *); 708 cred_t *smb_user_getprivcred(smb_user_t *); 709 void smb_user_netinfo_init(smb_user_t *, smb_netuserinfo_t *); 710 void smb_user_netinfo_fini(smb_netuserinfo_t *); 711 int smb_user_netinfo_encode(smb_user_t *, uint8_t *, size_t, uint32_t *); 712 smb_token_t *smb_get_token(smb_session_t *, smb_logon_t *); 713 cred_t *smb_cred_create(smb_token_t *); 714 void smb_user_setcred(smb_user_t *, cred_t *, uint32_t); 715 716 /* 717 * SMB tree functions (file smb_tree.c) 718 */ 719 uint32_t smb_tree_connect(smb_request_t *); 720 void smb_tree_disconnect(smb_tree_t *, boolean_t); 721 void smb_tree_dealloc(void *); 722 void smb_tree_post_ofile(smb_tree_t *, smb_ofile_t *); 723 void smb_tree_post_odir(smb_tree_t *, smb_odir_t *); 724 void smb_tree_close_pid(smb_tree_t *, uint32_t); 725 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t); 726 int smb_tree_enum(smb_tree_t *, smb_svcenum_t *); 727 int smb_tree_fclose(smb_tree_t *, uint32_t); 728 boolean_t smb_tree_hold(smb_tree_t *); 729 void smb_tree_hold_internal(smb_tree_t *); 730 void smb_tree_release(smb_tree_t *); 731 smb_odir_t *smb_tree_lookup_odir(smb_request_t *, uint16_t); 732 boolean_t smb_tree_is_connected(smb_tree_t *); 733 #define SMB_TREE_GET_TID(tree) ((tree)->t_tid) 734 735 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr, 736 uint32_t total_parameter_count, uint32_t total_data_count, 737 uint32_t max_parameter_count, uint32_t max_data_count, 738 uint32_t max_setup_count, uint32_t setup_word_count); 739 void smb_xa_delete(smb_xa_t *xa); 740 smb_xa_t *smb_xa_hold(smb_xa_t *xa); 741 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa); 742 int smb_xa_open(smb_xa_t *xa); 743 void smb_xa_close(smb_xa_t *xa); 744 int smb_xa_complete(smb_xa_t *xa); 745 smb_xa_t *smb_xa_find(smb_session_t *session, uint32_t pid, uint16_t mid); 746 747 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes); 748 struct mbuf *smb_mbuf_allocate(struct uio *uio); 749 void smb_mbuf_trim(struct mbuf *mhead, int nbytes); 750 751 int32_t smb_time_gmt_to_local(smb_request_t *, int32_t); 752 int32_t smb_time_local_to_gmt(smb_request_t *, int32_t); 753 int32_t smb_time_dos_to_unix(int16_t, int16_t); 754 void smb_time_unix_to_dos(int32_t, int16_t *, int16_t *); 755 void smb_time_nt_to_unix(uint64_t nt_time, timestruc_t *unix_time); 756 uint64_t smb_time_unix_to_nt(timestruc_t *); 757 758 int netbios_name_isvalid(char *in, char *out); 759 760 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n); 761 762 /* 763 * Pool ID function prototypes 764 */ 765 int smb_idpool_constructor(smb_idpool_t *pool); 766 void smb_idpool_destructor(smb_idpool_t *pool); 767 int smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id); 768 void smb_idpool_free(smb_idpool_t *pool, uint16_t id); 769 770 /* 771 * SMB locked list function prototypes 772 */ 773 void smb_llist_init(void); 774 void smb_llist_fini(void); 775 void smb_llist_constructor(smb_llist_t *, size_t, size_t); 776 void smb_llist_destructor(smb_llist_t *); 777 void smb_llist_exit(smb_llist_t *); 778 void smb_llist_post(smb_llist_t *, void *, smb_dtorproc_t); 779 void smb_llist_flush(smb_llist_t *); 780 void smb_llist_insert_head(smb_llist_t *ll, void *obj); 781 void smb_llist_insert_tail(smb_llist_t *ll, void *obj); 782 void smb_llist_remove(smb_llist_t *ll, void *obj); 783 int smb_llist_upgrade(smb_llist_t *ll); 784 uint32_t smb_llist_get_count(smb_llist_t *ll); 785 #define smb_llist_enter(ll, mode) rw_enter(&(ll)->ll_lock, mode) 786 #define smb_llist_head(ll) list_head(&(ll)->ll_list) 787 #define smb_llist_next(ll, obj) list_next(&(ll)->ll_list, obj) 788 int smb_account_connected(smb_user_t *user); 789 790 /* 791 * SMB Synchronized list function prototypes 792 */ 793 void smb_slist_constructor(smb_slist_t *, size_t, size_t); 794 void smb_slist_destructor(smb_slist_t *); 795 void smb_slist_insert_head(smb_slist_t *sl, void *obj); 796 void smb_slist_insert_tail(smb_slist_t *sl, void *obj); 797 void smb_slist_remove(smb_slist_t *sl, void *obj); 798 void smb_slist_wait_for_empty(smb_slist_t *sl); 799 void smb_slist_exit(smb_slist_t *sl); 800 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl); 801 void smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj); 802 #define smb_slist_enter(sl) mutex_enter(&(sl)->sl_mutex) 803 #define smb_slist_head(sl) list_head(&(sl)->sl_list) 804 #define smb_slist_next(sl, obj) list_next(&(sl)->sl_list, obj) 805 806 void smb_rwx_init(smb_rwx_t *rwx); 807 void smb_rwx_destroy(smb_rwx_t *rwx); 808 #define smb_rwx_rwenter(rwx, mode) rw_enter(&(rwx)->rwx_lock, mode) 809 void smb_rwx_rwexit(smb_rwx_t *rwx); 810 int smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout); 811 #define smb_rwx_xenter(rwx) mutex_enter(&(rwx)->rwx_mutex) 812 #define smb_rwx_xexit(rwx) mutex_exit(&(rwx)->rwx_mutex) 813 krw_t smb_rwx_rwupgrade(smb_rwx_t *rwx); 814 void smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode); 815 816 void smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, 817 void *, pri_t); 818 void smb_thread_destroy(smb_thread_t *); 819 int smb_thread_start(smb_thread_t *); 820 void smb_thread_stop(smb_thread_t *); 821 void smb_thread_signal(smb_thread_t *); 822 boolean_t smb_thread_continue(smb_thread_t *); 823 boolean_t smb_thread_continue_nowait(smb_thread_t *); 824 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */); 825 826 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname); 827 uint32_t smb_ofun_to_crdisposition(uint16_t ofun); 828 829 /* 100's of ns between 1/1/1970 and 1/1/1601 */ 830 #define NT_TIME_BIAS (134774LL * 24LL * 60LL * 60LL * 10000000LL) 831 832 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t); 833 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t); 834 835 acl_t *smb_fsacl_inherit(acl_t *, int, int, cred_t *); 836 acl_t *smb_fsacl_merge(acl_t *, acl_t *); 837 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int); 838 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t); 839 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *); 840 841 boolean_t smb_ace_is_generic(int); 842 boolean_t smb_ace_is_access(int); 843 boolean_t smb_ace_is_audit(int); 844 845 uint32_t smb_vss_enum_snapshots(smb_request_t *, smb_fsctl_t *); 846 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *, 847 char *, smb_node_t **, smb_node_t **); 848 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *); 849 850 void smb_panic(char *, const char *, int); 851 #pragma does_not_return(smb_panic) 852 #define SMB_PANIC() smb_panic(__FILE__, __func__, __LINE__) 853 854 void smb_latency_init(smb_latency_t *); 855 void smb_latency_destroy(smb_latency_t *); 856 void smb_latency_add_sample(smb_latency_t *, hrtime_t); 857 void smb_srqueue_init(smb_srqueue_t *); 858 void smb_srqueue_destroy(smb_srqueue_t *); 859 void smb_srqueue_waitq_enter(smb_srqueue_t *); 860 void smb_srqueue_runq_exit(smb_srqueue_t *); 861 void smb_srqueue_waitq_to_runq(smb_srqueue_t *); 862 void smb_srqueue_update(smb_srqueue_t *, smb_kstat_utilization_t *); 863 864 void *smb_mem_alloc(size_t); 865 void *smb_mem_zalloc(size_t); 866 void *smb_mem_realloc(void *, size_t); 867 void *smb_mem_rezalloc(void *, size_t); 868 void smb_mem_free(void *); 869 void smb_mem_zfree(void *); 870 char *smb_mem_strdup(const char *); 871 void smb_srm_init(smb_request_t *); 872 void smb_srm_fini(smb_request_t *); 873 void *smb_srm_alloc(smb_request_t *, size_t); 874 void *smb_srm_zalloc(smb_request_t *, size_t); 875 void *smb_srm_realloc(smb_request_t *, void *, size_t); 876 void *smb_srm_rezalloc(smb_request_t *, void *, size_t); 877 char *smb_srm_strdup(smb_request_t *, const char *); 878 879 void smb_export_start(smb_server_t *); 880 void smb_export_stop(smb_server_t *); 881 882 #ifdef _KERNEL 883 struct __door_handle; 884 struct __door_handle *smb_kshare_door_init(int); 885 void smb_kshare_door_fini(struct __door_handle *); 886 int smb_kshare_upcall(struct __door_handle *, void *, boolean_t); 887 #endif /* _KERNEL */ 888 889 void smb_kshare_g_init(void); 890 void smb_kshare_g_fini(void); 891 void smb_kshare_init(smb_server_t *); 892 void smb_kshare_fini(smb_server_t *); 893 int smb_kshare_start(smb_server_t *); 894 void smb_kshare_stop(smb_server_t *); 895 896 int smb_kshare_export_list(smb_ioc_share_t *); 897 int smb_kshare_unexport_list(smb_ioc_share_t *); 898 int smb_kshare_info(smb_ioc_shareinfo_t *); 899 void smb_kshare_enum(smb_server_t *, smb_enumshare_info_t *); 900 smb_kshare_t *smb_kshare_lookup(smb_server_t *, const char *); 901 void smb_kshare_release(smb_server_t *, smb_kshare_t *); 902 int smb_kshare_exec(smb_server_t *, smb_shr_execinfo_t *); 903 uint32_t smb_kshare_hostaccess(smb_kshare_t *, smb_session_t *); 904 905 906 void smb_avl_create(smb_avl_t *, size_t, size_t, const smb_avl_nops_t *); 907 void smb_avl_destroy(smb_avl_t *); 908 int smb_avl_add(smb_avl_t *, void *); 909 void smb_avl_remove(smb_avl_t *, void *); 910 void *smb_avl_lookup(smb_avl_t *, void *); 911 void smb_avl_release(smb_avl_t *, void *); 912 void smb_avl_iterinit(smb_avl_t *, smb_avl_cursor_t *); 913 void *smb_avl_iterate(smb_avl_t *, smb_avl_cursor_t *); 914 915 void smb_threshold_init(smb_cmd_threshold_t *, 916 char *, uint_t, uint_t); 917 void smb_threshold_fini(smb_cmd_threshold_t *); 918 int smb_threshold_enter(smb_cmd_threshold_t *); 919 void smb_threshold_exit(smb_cmd_threshold_t *); 920 void smb_threshold_wake_all(smb_cmd_threshold_t *); 921 922 #ifdef __cplusplus 923 } 924 #endif 925 926 #endif /* _SMB_KPROTO_H_ */ 927