1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org> 4 * Copyright (C) 2018 Samsung Electronics Co., Ltd. 5 */ 6 7 #include "glob.h" 8 #include "oplock.h" 9 #include "misc.h" 10 #include <linux/sched/signal.h> 11 #include <linux/workqueue.h> 12 #include <linux/sysfs.h> 13 #include <linux/module.h> 14 #include <linux/moduleparam.h> 15 16 #include "server.h" 17 #include "smb_common.h" 18 #include "../common/smb2status.h" 19 #include "connection.h" 20 #include "transport_ipc.h" 21 #include "mgmt/user_session.h" 22 #include "crypto_ctx.h" 23 #include "auth.h" 24 #include "misc.h" 25 #include "stats.h" 26 27 int ksmbd_debug_types; 28 29 struct ksmbd_server_config server_conf; 30 31 enum SERVER_CTRL_TYPE { 32 SERVER_CTRL_TYPE_INIT, 33 SERVER_CTRL_TYPE_RESET, 34 }; 35 36 struct server_ctrl_struct { 37 int type; 38 struct work_struct ctrl_work; 39 }; 40 41 static DEFINE_MUTEX(ctrl_lock); 42 43 static int ___server_conf_set(int idx, char *val) 44 { 45 if (idx >= ARRAY_SIZE(server_conf.conf)) 46 return -EINVAL; 47 48 if (!val || val[0] == 0x00) 49 return -EINVAL; 50 51 kfree(server_conf.conf[idx]); 52 server_conf.conf[idx] = kstrdup(val, KSMBD_DEFAULT_GFP); 53 if (!server_conf.conf[idx]) 54 return -ENOMEM; 55 return 0; 56 } 57 58 int ksmbd_set_netbios_name(char *v) 59 { 60 return ___server_conf_set(SERVER_CONF_NETBIOS_NAME, v); 61 } 62 63 int ksmbd_set_server_string(char *v) 64 { 65 return ___server_conf_set(SERVER_CONF_SERVER_STRING, v); 66 } 67 68 int ksmbd_set_work_group(char *v) 69 { 70 return ___server_conf_set(SERVER_CONF_WORK_GROUP, v); 71 } 72 73 char *ksmbd_netbios_name(void) 74 { 75 return server_conf.conf[SERVER_CONF_NETBIOS_NAME]; 76 } 77 78 char *ksmbd_server_string(void) 79 { 80 return server_conf.conf[SERVER_CONF_SERVER_STRING]; 81 } 82 83 char *ksmbd_work_group(void) 84 { 85 return server_conf.conf[SERVER_CONF_WORK_GROUP]; 86 } 87 88 /** 89 * check_conn_state() - check state of server thread connection 90 * @work: smb work containing server thread information 91 * 92 * Return: 0 on valid connection, otherwise 1 to reconnect 93 */ 94 static inline int check_conn_state(struct ksmbd_work *work) 95 { 96 struct smb_hdr *rsp_hdr; 97 98 if (ksmbd_conn_exiting(work->conn) || 99 ksmbd_conn_need_reconnect(work->conn)) { 100 rsp_hdr = smb_get_msg(work->response_buf); 101 rsp_hdr->Status.CifsError = STATUS_CONNECTION_DISCONNECTED; 102 return 1; 103 } 104 return 0; 105 } 106 107 #define SERVER_HANDLER_CONTINUE 0 108 #define SERVER_HANDLER_ABORT 1 109 110 static int __process_request(struct ksmbd_work *work, struct ksmbd_conn *conn, 111 u16 *cmd) 112 { 113 struct smb_version_cmds *cmds; 114 u16 command; 115 int ret; 116 117 if (check_conn_state(work)) 118 return SERVER_HANDLER_CONTINUE; 119 120 if (ksmbd_verify_smb_message(work)) { 121 conn->ops->set_rsp_status(work, STATUS_INVALID_PARAMETER); 122 return SERVER_HANDLER_ABORT; 123 } 124 125 command = conn->ops->get_cmd_val(work); 126 *cmd = command; 127 128 andx_again: 129 if (command >= conn->max_cmds) { 130 conn->ops->set_rsp_status(work, STATUS_INVALID_PARAMETER); 131 return SERVER_HANDLER_ABORT; 132 } 133 134 cmds = &conn->cmds[command]; 135 if (!cmds->proc) { 136 ksmbd_debug(SMB, "*** not implemented yet cmd = %x\n", command); 137 conn->ops->set_rsp_status(work, STATUS_NOT_IMPLEMENTED); 138 return SERVER_HANDLER_ABORT; 139 } 140 141 if (work->sess && conn->ops->is_sign_req(work, command)) { 142 ret = conn->ops->check_sign_req(work); 143 if (!ret) { 144 conn->ops->set_rsp_status(work, STATUS_ACCESS_DENIED); 145 return SERVER_HANDLER_ABORT; 146 } 147 } 148 149 ret = cmds->proc(work); 150 if (conn->ops->inc_reqs) 151 conn->ops->inc_reqs(command); 152 153 if (ret < 0) 154 ksmbd_debug(CONN, "Failed to process %u [%d]\n", command, ret); 155 /* AndX commands - chained request can return positive values */ 156 else if (ret > 0) { 157 command = ret; 158 *cmd = command; 159 goto andx_again; 160 } 161 162 if (work->send_no_response) 163 return SERVER_HANDLER_ABORT; 164 return SERVER_HANDLER_CONTINUE; 165 } 166 167 static void __handle_ksmbd_work(struct ksmbd_work *work, 168 struct ksmbd_conn *conn) 169 { 170 u16 command = 0; 171 int rc; 172 bool is_chained = false; 173 174 if (conn->ops->is_transform_hdr && 175 conn->ops->is_transform_hdr(work->request_buf)) { 176 rc = conn->ops->decrypt_req(work); 177 if (rc < 0) 178 return; 179 work->encrypted = true; 180 } 181 182 if (conn->ops->allocate_rsp_buf(work)) 183 return; 184 185 rc = conn->ops->init_rsp_hdr(work); 186 if (rc) { 187 /* either uid or tid is not correct */ 188 conn->ops->set_rsp_status(work, STATUS_INVALID_HANDLE); 189 goto send; 190 } 191 192 do { 193 if (conn->ops->check_user_session) { 194 rc = conn->ops->check_user_session(work); 195 if (rc < 0) { 196 if (rc == -EINVAL) 197 conn->ops->set_rsp_status(work, 198 STATUS_INVALID_PARAMETER); 199 else 200 conn->ops->set_rsp_status(work, 201 STATUS_USER_SESSION_DELETED); 202 goto send; 203 } else if (rc > 0) { 204 rc = conn->ops->get_ksmbd_tcon(work); 205 if (rc < 0) { 206 if (rc == -EINVAL) 207 conn->ops->set_rsp_status(work, 208 STATUS_INVALID_PARAMETER); 209 else 210 conn->ops->set_rsp_status(work, 211 STATUS_NETWORK_NAME_DELETED); 212 goto send; 213 } 214 } 215 } 216 217 rc = __process_request(work, conn, &command); 218 if (rc == SERVER_HANDLER_ABORT) 219 break; 220 221 /* 222 * Call smb2_set_rsp_credits() function to set number of credits 223 * granted in hdr of smb2 response. 224 */ 225 if (conn->ops->set_rsp_credits) { 226 spin_lock(&conn->credits_lock); 227 rc = conn->ops->set_rsp_credits(work); 228 spin_unlock(&conn->credits_lock); 229 if (rc < 0) { 230 conn->ops->set_rsp_status(work, 231 STATUS_INVALID_PARAMETER); 232 goto send; 233 } 234 } 235 236 is_chained = is_chained_smb2_message(work); 237 238 if (work->sess && 239 (work->sess->sign || smb3_11_final_sess_setup_resp(work) || 240 conn->ops->is_sign_req(work, command))) 241 conn->ops->set_sign_rsp(work); 242 } while (is_chained == true); 243 244 send: 245 if (work->tcon) 246 ksmbd_tree_connect_put(work->tcon); 247 smb3_preauth_hash_rsp(work); 248 if (work->sess && work->sess->enc && work->encrypted && 249 conn->ops->encrypt_resp) { 250 rc = conn->ops->encrypt_resp(work); 251 if (rc < 0) 252 conn->ops->set_rsp_status(work, STATUS_DATA_ERROR); 253 } 254 if (work->sess) 255 ksmbd_user_session_put(work->sess); 256 257 ksmbd_conn_write(work); 258 } 259 260 /** 261 * handle_ksmbd_work() - process pending smb work requests 262 * @wk: smb work containing request command buffer 263 * 264 * called by kworker threads to processing remaining smb work requests 265 */ 266 static void handle_ksmbd_work(struct work_struct *wk) 267 { 268 struct ksmbd_work *work = container_of(wk, struct ksmbd_work, work); 269 struct ksmbd_conn *conn = work->conn; 270 271 atomic64_inc(&conn->stats.request_served); 272 273 __handle_ksmbd_work(work, conn); 274 275 ksmbd_conn_try_dequeue_request(work); 276 ksmbd_free_work_struct(work); 277 ksmbd_conn_r_count_dec(conn); 278 } 279 280 /** 281 * queue_ksmbd_work() - queue a smb request to worker thread queue 282 * for processing smb command and sending response 283 * @conn: connection instance 284 * 285 * read remaining data from socket create and submit work. 286 */ 287 static int queue_ksmbd_work(struct ksmbd_conn *conn) 288 { 289 struct ksmbd_work *work; 290 int err; 291 292 err = ksmbd_init_smb_server(conn); 293 if (err) 294 return 0; 295 296 work = ksmbd_alloc_work_struct(); 297 if (!work) { 298 pr_err("allocation for work failed\n"); 299 return -ENOMEM; 300 } 301 302 work->conn = conn; 303 work->request_buf = conn->request_buf; 304 conn->request_buf = NULL; 305 306 ksmbd_conn_enqueue_request(work); 307 ksmbd_conn_r_count_inc(conn); 308 /* update activity on connection */ 309 conn->last_active = jiffies; 310 INIT_WORK(&work->work, handle_ksmbd_work); 311 ksmbd_queue_work(work); 312 return 0; 313 } 314 315 static int ksmbd_server_process_request(struct ksmbd_conn *conn) 316 { 317 return queue_ksmbd_work(conn); 318 } 319 320 static int ksmbd_server_terminate_conn(struct ksmbd_conn *conn) 321 { 322 ksmbd_sessions_deregister(conn); 323 destroy_lease_table(conn); 324 return 0; 325 } 326 327 static void ksmbd_server_tcp_callbacks_init(void) 328 { 329 struct ksmbd_conn_ops ops; 330 331 ops.process_fn = ksmbd_server_process_request; 332 ops.terminate_fn = ksmbd_server_terminate_conn; 333 334 ksmbd_conn_init_server_callbacks(&ops); 335 } 336 337 static void server_conf_free(void) 338 { 339 int i; 340 341 for (i = 0; i < ARRAY_SIZE(server_conf.conf); i++) { 342 kfree(server_conf.conf[i]); 343 server_conf.conf[i] = NULL; 344 } 345 } 346 347 static int server_conf_init(void) 348 { 349 WRITE_ONCE(server_conf.state, SERVER_STATE_STARTING_UP); 350 server_conf.enforced_signing = 0; 351 server_conf.min_protocol = ksmbd_min_protocol(); 352 server_conf.max_protocol = ksmbd_max_protocol(); 353 server_conf.auth_mechs = KSMBD_AUTH_NTLMSSP; 354 #ifdef CONFIG_SMB_SERVER_KERBEROS5 355 server_conf.auth_mechs |= KSMBD_AUTH_KRB5 | 356 KSMBD_AUTH_MSKRB5; 357 #endif 358 server_conf.max_inflight_req = SMB2_MAX_CREDITS; 359 return 0; 360 } 361 362 static void server_ctrl_handle_init(struct server_ctrl_struct *ctrl) 363 { 364 int ret; 365 366 ksmbd_proc_reset(); 367 ret = ksmbd_conn_transport_init(); 368 if (ret) { 369 server_queue_ctrl_reset_work(); 370 return; 371 } 372 373 pr_info("running\n"); 374 WRITE_ONCE(server_conf.state, SERVER_STATE_RUNNING); 375 } 376 377 static void server_ctrl_handle_reset(struct server_ctrl_struct *ctrl) 378 { 379 ksmbd_ipc_soft_reset(); 380 ksmbd_conn_transport_destroy(); 381 ksmbd_stop_durable_scavenger(); 382 server_conf_free(); 383 server_conf_init(); 384 WRITE_ONCE(server_conf.state, SERVER_STATE_STARTING_UP); 385 } 386 387 static void server_ctrl_handle_work(struct work_struct *work) 388 { 389 struct server_ctrl_struct *ctrl; 390 391 ctrl = container_of(work, struct server_ctrl_struct, ctrl_work); 392 393 mutex_lock(&ctrl_lock); 394 switch (ctrl->type) { 395 case SERVER_CTRL_TYPE_INIT: 396 server_ctrl_handle_init(ctrl); 397 break; 398 case SERVER_CTRL_TYPE_RESET: 399 server_ctrl_handle_reset(ctrl); 400 break; 401 default: 402 pr_err("Unknown server work type: %d\n", ctrl->type); 403 } 404 mutex_unlock(&ctrl_lock); 405 kfree(ctrl); 406 module_put(THIS_MODULE); 407 } 408 409 static int __queue_ctrl_work(int type) 410 { 411 struct server_ctrl_struct *ctrl; 412 413 ctrl = kmalloc(sizeof(struct server_ctrl_struct), KSMBD_DEFAULT_GFP); 414 if (!ctrl) 415 return -ENOMEM; 416 417 __module_get(THIS_MODULE); 418 ctrl->type = type; 419 INIT_WORK(&ctrl->ctrl_work, server_ctrl_handle_work); 420 queue_work(system_long_wq, &ctrl->ctrl_work); 421 return 0; 422 } 423 424 int server_queue_ctrl_init_work(void) 425 { 426 return __queue_ctrl_work(SERVER_CTRL_TYPE_INIT); 427 } 428 429 int server_queue_ctrl_reset_work(void) 430 { 431 return __queue_ctrl_work(SERVER_CTRL_TYPE_RESET); 432 } 433 434 static ssize_t stats_show(const struct class *class, const struct class_attribute *attr, 435 char *buf) 436 { 437 /* 438 * Inc this each time you change stats output format, 439 * so user space will know what to do. 440 */ 441 static int stats_version = 2; 442 static const char * const state[] = { 443 "startup", 444 "running", 445 "reset", 446 "shutdown" 447 }; 448 return sysfs_emit(buf, "%d %s %d %lu\n", stats_version, 449 state[server_conf.state], server_conf.tcp_port, 450 server_conf.ipc_last_active / HZ); 451 } 452 453 static ssize_t kill_server_store(const struct class *class, 454 const struct class_attribute *attr, const char *buf, 455 size_t len) 456 { 457 if (!sysfs_streq(buf, "hard")) 458 return len; 459 460 pr_info("kill command received\n"); 461 mutex_lock(&ctrl_lock); 462 WRITE_ONCE(server_conf.state, SERVER_STATE_RESETTING); 463 __module_get(THIS_MODULE); 464 server_ctrl_handle_reset(NULL); 465 module_put(THIS_MODULE); 466 mutex_unlock(&ctrl_lock); 467 return len; 468 } 469 470 static const char * const debug_type_strings[] = {"smb", "auth", "vfs", 471 "oplock", "ipc", "conn", 472 "rdma"}; 473 474 static ssize_t debug_show(const struct class *class, const struct class_attribute *attr, 475 char *buf) 476 { 477 ssize_t sz = 0; 478 int i, pos = 0; 479 480 for (i = 0; i < ARRAY_SIZE(debug_type_strings); i++) { 481 if ((ksmbd_debug_types >> i) & 1) { 482 pos = sysfs_emit_at(buf, sz, "[%s] ", debug_type_strings[i]); 483 } else { 484 pos = sysfs_emit_at(buf, sz, "%s ", debug_type_strings[i]); 485 } 486 sz += pos; 487 } 488 sz += sysfs_emit_at(buf, sz, "\n"); 489 return sz; 490 } 491 492 static ssize_t debug_store(const struct class *class, const struct class_attribute *attr, 493 const char *buf, size_t len) 494 { 495 int i; 496 497 for (i = 0; i < ARRAY_SIZE(debug_type_strings); i++) { 498 if (sysfs_streq(buf, "all")) { 499 if (ksmbd_debug_types == KSMBD_DEBUG_ALL) 500 ksmbd_debug_types = 0; 501 else 502 ksmbd_debug_types = KSMBD_DEBUG_ALL; 503 break; 504 } 505 506 if (sysfs_streq(buf, debug_type_strings[i])) { 507 if (ksmbd_debug_types & (1 << i)) 508 ksmbd_debug_types &= ~(1 << i); 509 else 510 ksmbd_debug_types |= (1 << i); 511 break; 512 } 513 } 514 515 return len; 516 } 517 518 static CLASS_ATTR_RO(stats); 519 static CLASS_ATTR_WO(kill_server); 520 static CLASS_ATTR_RW(debug); 521 522 static struct attribute *ksmbd_control_class_attrs[] = { 523 &class_attr_stats.attr, 524 &class_attr_kill_server.attr, 525 &class_attr_debug.attr, 526 NULL, 527 }; 528 ATTRIBUTE_GROUPS(ksmbd_control_class); 529 530 static struct class ksmbd_control_class = { 531 .name = "ksmbd-control", 532 .class_groups = ksmbd_control_class_groups, 533 }; 534 535 static int ksmbd_server_shutdown(void) 536 { 537 WRITE_ONCE(server_conf.state, SERVER_STATE_SHUTTING_DOWN); 538 539 ksmbd_proc_cleanup(); 540 class_unregister(&ksmbd_control_class); 541 ksmbd_workqueue_destroy(); 542 ksmbd_ipc_release(); 543 ksmbd_conn_transport_destroy(); 544 ksmbd_crypto_destroy(); 545 ksmbd_free_global_file_table(); 546 destroy_lease_table(NULL); 547 ksmbd_work_pool_destroy(); 548 ksmbd_exit_file_cache(); 549 server_conf_free(); 550 return 0; 551 } 552 553 static int __init ksmbd_server_init(void) 554 { 555 int ret; 556 557 ret = class_register(&ksmbd_control_class); 558 if (ret) { 559 pr_err("Unable to register ksmbd-control class\n"); 560 return ret; 561 } 562 563 ksmbd_proc_init(); 564 create_proc_sessions(); 565 566 ksmbd_server_tcp_callbacks_init(); 567 568 ret = server_conf_init(); 569 if (ret) 570 goto err_unregister; 571 572 ret = ksmbd_work_pool_init(); 573 if (ret) 574 goto err_unregister; 575 576 ret = ksmbd_init_file_cache(); 577 if (ret) 578 goto err_destroy_work_pools; 579 580 ret = ksmbd_ipc_init(); 581 if (ret) 582 goto err_exit_file_cache; 583 584 ret = ksmbd_init_global_file_table(); 585 if (ret) 586 goto err_ipc_release; 587 588 ret = ksmbd_inode_hash_init(); 589 if (ret) 590 goto err_destroy_file_table; 591 592 ret = ksmbd_crypto_create(); 593 if (ret) 594 goto err_release_inode_hash; 595 596 ret = ksmbd_workqueue_init(); 597 if (ret) 598 goto err_crypto_destroy; 599 600 return 0; 601 602 err_crypto_destroy: 603 ksmbd_crypto_destroy(); 604 err_release_inode_hash: 605 ksmbd_release_inode_hash(); 606 err_destroy_file_table: 607 ksmbd_free_global_file_table(); 608 err_ipc_release: 609 ksmbd_ipc_release(); 610 err_exit_file_cache: 611 ksmbd_exit_file_cache(); 612 err_destroy_work_pools: 613 ksmbd_work_pool_destroy(); 614 err_unregister: 615 class_unregister(&ksmbd_control_class); 616 617 return ret; 618 } 619 620 /** 621 * ksmbd_server_exit() - shutdown forker thread and free memory at module exit 622 */ 623 static void __exit ksmbd_server_exit(void) 624 { 625 ksmbd_server_shutdown(); 626 rcu_barrier(); 627 ksmbd_release_inode_hash(); 628 } 629 630 MODULE_AUTHOR("Namjae Jeon <linkinjeon@kernel.org>"); 631 MODULE_DESCRIPTION("Linux kernel CIFS/SMB SERVER"); 632 MODULE_LICENSE("GPL"); 633 MODULE_SOFTDEP("pre: ecb"); 634 MODULE_SOFTDEP("pre: nls"); 635 MODULE_SOFTDEP("pre: aes"); 636 MODULE_SOFTDEP("pre: cmac"); 637 MODULE_SOFTDEP("pre: aead2"); 638 MODULE_SOFTDEP("pre: ccm"); 639 MODULE_SOFTDEP("pre: gcm"); 640 module_init(ksmbd_server_init) 641 module_exit(ksmbd_server_exit) 642