2 Unix SMB2 implementation.
4 Copyright (C) Andrew Tridgell 2005
5 Copyright (C) Stefan Metzmacher 2005
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "system/time.h"
23 #include "libcli/smb2/smb2.h"
24 #include "libcli/smb2/smb2_calls.h"
25 #include "smb_server/smb_server.h"
26 #include "smb_server/smb2/smb2_server.h"
27 #include "smbd/service_stream.h"
28 #include "lib/stream/packet.h"
29 #include "ntvfs/ntvfs.h"
30 #include "param/param.h"
31 #include "auth/auth.h"
34 /* fill in the bufinfo */
35 void smb2srv_setup_bufinfo(struct smb2srv_request *req)
37 req->in.bufinfo.mem_ctx = req;
38 req->in.bufinfo.flags = BUFINFO_FLAG_UNICODE | BUFINFO_FLAG_SMB2;
39 req->in.bufinfo.align_base = req->in.buffer;
40 if (req->in.dynamic) {
41 req->in.bufinfo.data = req->in.dynamic;
42 req->in.bufinfo.data_size = req->in.body_size - req->in.body_fixed;
44 req->in.bufinfo.data = NULL;
45 req->in.bufinfo.data_size = 0;
49 static int smb2srv_request_destructor(struct smb2srv_request *req)
51 DLIST_REMOVE(req->smb_conn->requests2.list, req);
52 if (req->pending_id) {
53 idr_remove(req->smb_conn->requests2.idtree_req, req->pending_id);
58 static int smb2srv_request_deny_destructor(struct smb2srv_request *req)
63 struct smb2srv_request *smb2srv_init_request(struct smbsrv_connection *smb_conn)
65 struct smb2srv_request *req;
67 req = talloc_zero(smb_conn, struct smb2srv_request);
68 if (!req) return NULL;
70 req->smb_conn = smb_conn;
72 req->chained_session_id = UINT64_MAX;
73 req->chained_tree_id = UINT32_MAX;
75 talloc_set_destructor(req, smb2srv_request_destructor);
80 NTSTATUS smb2srv_setup_reply(struct smb2srv_request *req, uint16_t body_fixed_size,
81 bool body_dynamic_present, uint32_t body_dynamic_size)
83 uint32_t flags = IVAL(req->in.hdr, SMB2_HDR_FLAGS);
84 uint32_t pid = IVAL(req->in.hdr, SMB2_HDR_PID);
85 uint32_t tid = IVAL(req->in.hdr, SMB2_HDR_TID);
86 uint16_t credits = SVAL(req->in.hdr, SMB2_HDR_CREDIT);
92 flags |= SMB2_HDR_FLAG_REDIRECT;
94 if (req->pending_id) {
95 flags |= SMB2_HDR_FLAG_ASYNC;
96 pid = req->pending_id;
101 if (body_dynamic_present) {
102 if (body_dynamic_size == 0) {
103 body_dynamic_size = 1;
106 body_dynamic_size = 0;
109 req->out.size = SMB2_HDR_BODY+NBT_HDR_SIZE+body_fixed_size;
111 req->out.allocated = req->out.size + body_dynamic_size;
112 req->out.buffer = talloc_array(req, uint8_t,
114 NT_STATUS_HAVE_NO_MEMORY(req->out.buffer);
116 req->out.hdr = req->out.buffer + NBT_HDR_SIZE;
117 req->out.body = req->out.hdr + SMB2_HDR_BODY;
118 req->out.body_fixed = body_fixed_size;
119 req->out.body_size = body_fixed_size;
120 req->out.dynamic = (body_dynamic_size ? req->out.body + body_fixed_size : NULL);
122 SIVAL(req->out.hdr, 0, SMB2_MAGIC);
123 SSVAL(req->out.hdr, SMB2_HDR_LENGTH, SMB2_HDR_BODY);
124 SSVAL(req->out.hdr, SMB2_HDR_CREDIT_CHARGE,
125 SVAL(req->in.hdr, SMB2_HDR_CREDIT_CHARGE));
126 SIVAL(req->out.hdr, SMB2_HDR_STATUS, NT_STATUS_V(req->status));
127 SSVAL(req->out.hdr, SMB2_HDR_OPCODE, SVAL(req->in.hdr, SMB2_HDR_OPCODE));
128 SSVAL(req->out.hdr, SMB2_HDR_CREDIT, credits);
129 SIVAL(req->out.hdr, SMB2_HDR_FLAGS, flags);
130 SIVAL(req->out.hdr, SMB2_HDR_NEXT_COMMAND, 0);
131 SBVAL(req->out.hdr, SMB2_HDR_MESSAGE_ID, req->seqnum);
132 SIVAL(req->out.hdr, SMB2_HDR_PID, pid);
133 SIVAL(req->out.hdr, SMB2_HDR_TID, tid);
134 SBVAL(req->out.hdr, SMB2_HDR_SESSION_ID, BVAL(req->in.hdr, SMB2_HDR_SESSION_ID));
135 memcpy(req->out.hdr+SMB2_HDR_SIGNATURE,
136 req->in.hdr+SMB2_HDR_SIGNATURE, 16);
138 /* set the length of the fixed body part and +1 if there's a dynamic part also */
139 SSVAL(req->out.body, 0, body_fixed_size + (body_dynamic_size?1:0));
142 * if we have a dynamic part, make sure the first byte
143 * which is always be part of the packet is initialized
145 if (body_dynamic_size) {
147 SCVAL(req->out.dynamic, 0, 0);
153 static NTSTATUS smb2srv_reply(struct smb2srv_request *req);
155 static void smb2srv_chain_reply(struct smb2srv_request *p_req)
158 struct smbsrv_connection *smb_conn = p_req->smb_conn;
159 struct smb2srv_request *req;
160 uint32_t chain_offset;
161 uint32_t protocol_version;
162 uint16_t buffer_code;
163 uint32_t dynamic_size;
165 uint32_t last_hdr_offset;
167 last_hdr_offset = p_req->in.hdr - p_req->in.buffer;
169 chain_offset = p_req->chain_offset;
170 p_req->chain_offset = 0;
172 if (p_req->in.size < (last_hdr_offset + chain_offset + SMB2_MIN_SIZE_NO_BODY)) {
173 DEBUG(2,("Invalid SMB2 chained packet at offset 0x%X from last hdr 0x%X\n",
174 chain_offset, last_hdr_offset));
175 smbsrv_terminate_connection(smb_conn, "Invalid SMB2 chained packet");
179 protocol_version = IVAL(p_req->in.buffer, last_hdr_offset + chain_offset);
180 if (protocol_version != SMB2_MAGIC) {
181 DEBUG(2,("Invalid SMB chained packet: protocol prefix: 0x%08X\n",
183 smbsrv_terminate_connection(smb_conn, "NON-SMB2 chained packet");
187 req = smb2srv_init_request(smb_conn);
189 smbsrv_terminate_connection(smb_conn, "SMB2 chained packet - no memory");
193 req->in.buffer = talloc_steal(req, p_req->in.buffer);
194 req->in.size = p_req->in.size;
195 req->request_time = p_req->request_time;
196 req->in.allocated = req->in.size;
198 req->in.hdr = req->in.buffer+ last_hdr_offset + chain_offset;
199 req->in.body = req->in.hdr + SMB2_HDR_BODY;
200 req->in.body_size = req->in.size - (last_hdr_offset+ chain_offset + SMB2_HDR_BODY);
201 req->in.dynamic = NULL;
203 req->seqnum = BVAL(req->in.hdr, SMB2_HDR_MESSAGE_ID);
205 if (req->in.body_size < 2) {
206 /* error handling for this is different for negprot to
207 other packet types */
208 uint16_t opcode = SVAL(req->in.hdr, SMB2_HDR_OPCODE);
209 if (opcode == SMB2_OP_NEGPROT) {
210 smbsrv_terminate_connection(smb_conn, "Bad body size in SMB2 negprot");
212 smb2srv_send_error(req, NT_STATUS_INVALID_PARAMETER);
216 buffer_code = SVAL(req->in.body, 0);
217 req->in.body_fixed = (buffer_code & ~1);
218 dynamic_size = req->in.body_size - req->in.body_fixed;
220 if (dynamic_size != 0 && (buffer_code & 1)) {
221 req->in.dynamic = req->in.body + req->in.body_fixed;
222 if (smb2_oob(&req->in, req->in.dynamic, dynamic_size)) {
223 DEBUG(1,("SMB2 chained request invalid dynamic size 0x%x\n",
225 smb2srv_send_error(req, NT_STATUS_INVALID_PARAMETER);
230 smb2srv_setup_bufinfo(req);
232 flags = IVAL(req->in.hdr, SMB2_HDR_FLAGS);
233 if (flags & SMB2_HDR_FLAG_CHAINED) {
234 if (p_req->chained_file_handle) {
235 memcpy(req->_chained_file_handle,
236 p_req->_chained_file_handle,
237 sizeof(req->_chained_file_handle));
238 req->chained_file_handle = req->_chained_file_handle;
240 req->chained_session_id = p_req->chained_session_id;
241 req->chained_tree_id = p_req->chained_tree_id;
242 req->chain_status = p_req->chain_status;
246 * TODO: - make sure the length field is 64
247 * - make sure it's a request
250 status = smb2srv_reply(req);
251 if (!NT_STATUS_IS_OK(status)) {
252 smbsrv_terminate_connection(smb_conn, nt_errstr(status));
258 void smb2srv_send_reply(struct smb2srv_request *req)
263 if (req->smb_conn->connection->event.fde == NULL) {
264 /* the socket has been destroyed - no point trying to send a reply! */
269 if (req->out.size > NBT_HDR_SIZE) {
270 _smb_setlen_tcp(req->out.buffer, req->out.size - NBT_HDR_SIZE);
273 /* if signing is active on the session then sign the packet */
274 if (req->is_signed) {
275 status = smb2_sign_message(&req->out,
276 req->session->session_info->session_key);
277 if (!NT_STATUS_IS_OK(status)) {
278 smbsrv_terminate_connection(req->smb_conn, nt_errstr(status));
284 blob = data_blob_const(req->out.buffer, req->out.size);
285 status = packet_send(req->smb_conn->packet, blob);
286 if (!NT_STATUS_IS_OK(status)) {
287 smbsrv_terminate_connection(req->smb_conn, nt_errstr(status));
289 if (req->chain_offset) {
290 smb2srv_chain_reply(req);
296 void smb2srv_send_error(struct smb2srv_request *req, NTSTATUS error)
300 if (req->smb_conn->connection->event.fde == NULL) {
301 /* the socket has been destroyed - no point trying to send an error! */
306 status = smb2srv_setup_reply(req, 8, true, 0);
307 if (!NT_STATUS_IS_OK(status)) {
308 smbsrv_terminate_connection(req->smb_conn, nt_errstr(status));
313 SIVAL(req->out.hdr, SMB2_HDR_STATUS, NT_STATUS_V(error));
315 SSVAL(req->out.body, 0x02, 0);
316 SIVAL(req->out.body, 0x04, 0);
318 req->chain_status = NT_STATUS_INVALID_PARAMETER;
320 smb2srv_send_reply(req);
323 static NTSTATUS smb2srv_reply(struct smb2srv_request *req)
330 if (SVAL(req->in.hdr, SMB2_HDR_LENGTH) != SMB2_HDR_BODY) {
331 smbsrv_terminate_connection(req->smb_conn, "Invalid SMB2 header length");
332 return NT_STATUS_INVALID_PARAMETER;
334 opcode = SVAL(req->in.hdr, SMB2_HDR_OPCODE);
335 req->chain_offset = IVAL(req->in.hdr, SMB2_HDR_NEXT_COMMAND);
336 req->seqnum = BVAL(req->in.hdr, SMB2_HDR_MESSAGE_ID);
337 tid = IVAL(req->in.hdr, SMB2_HDR_TID);
338 uid = BVAL(req->in.hdr, SMB2_HDR_SESSION_ID);
339 flags = IVAL(req->in.hdr, SMB2_HDR_FLAGS);
341 if (opcode != SMB2_OP_CANCEL &&
342 req->smb_conn->highest_smb2_seqnum != 0 &&
343 req->seqnum <= req->smb_conn->highest_smb2_seqnum) {
344 smbsrv_terminate_connection(req->smb_conn, "Invalid SMB2 sequence number");
345 return NT_STATUS_INVALID_PARAMETER;
347 if (opcode != SMB2_OP_CANCEL) {
348 req->smb_conn->highest_smb2_seqnum = req->seqnum;
351 if (flags & SMB2_HDR_FLAG_CHAINED) {
352 uid = req->chained_session_id;
353 tid = req->chained_tree_id;
356 req->session = smbsrv_session_find(req->smb_conn, uid, req->request_time);
357 req->tcon = smbsrv_smb2_tcon_find(req->session, tid, req->request_time);
359 req->chained_session_id = uid;
360 req->chained_tree_id = tid;
364 /* supporting signing is mandatory in SMB2, and is per-packet. So we
365 should check the signature on any incoming packet that is signed, and
366 should give a signed reply to any signed request */
367 if (flags & SMB2_HDR_FLAG_SIGNED) {
370 if (!req->session) goto nosession;
372 req->is_signed = true;
373 status = smb2_check_signature(&req->in,
374 req->session->session_info->session_key);
375 if (!NT_STATUS_IS_OK(status)) {
376 smb2srv_send_error(req, status);
379 } else if (req->session && req->session->smb2_signing.active) {
380 /* we require signing and this request was not signed */
381 smb2srv_send_error(req, NT_STATUS_ACCESS_DENIED);
385 if (!NT_STATUS_IS_OK(req->chain_status)) {
386 smb2srv_send_error(req, req->chain_status);
391 case SMB2_OP_NEGPROT:
392 smb2srv_negprot_recv(req);
394 case SMB2_OP_SESSSETUP:
395 smb2srv_sesssetup_recv(req);
398 if (!req->session) goto nosession;
399 smb2srv_logoff_recv(req);
402 if (!req->session) goto nosession;
403 smb2srv_tcon_recv(req);
406 if (!req->session) goto nosession;
407 if (!req->tcon) goto notcon;
408 smb2srv_tdis_recv(req);
411 if (!req->session) goto nosession;
412 if (!req->tcon) goto notcon;
413 smb2srv_create_recv(req);
416 if (!req->session) goto nosession;
417 if (!req->tcon) goto notcon;
418 smb2srv_close_recv(req);
421 if (!req->session) goto nosession;
422 if (!req->tcon) goto notcon;
423 smb2srv_flush_recv(req);
426 if (!req->session) goto nosession;
427 if (!req->tcon) goto notcon;
428 smb2srv_read_recv(req);
431 if (!req->session) goto nosession;
432 if (!req->tcon) goto notcon;
433 smb2srv_write_recv(req);
436 if (!req->session) goto nosession;
437 if (!req->tcon) goto notcon;
438 smb2srv_lock_recv(req);
441 if (!req->session) goto nosession;
442 if (!req->tcon) goto notcon;
443 smb2srv_ioctl_recv(req);
446 smb2srv_cancel_recv(req);
448 case SMB2_OP_KEEPALIVE:
449 smb2srv_keepalive_recv(req);
452 if (!req->session) goto nosession;
453 if (!req->tcon) goto notcon;
454 smb2srv_find_recv(req);
457 if (!req->session) goto nosession;
458 if (!req->tcon) goto notcon;
459 smb2srv_notify_recv(req);
461 case SMB2_OP_GETINFO:
462 if (!req->session) goto nosession;
463 if (!req->tcon) goto notcon;
464 smb2srv_getinfo_recv(req);
466 case SMB2_OP_SETINFO:
467 if (!req->session) goto nosession;
468 if (!req->tcon) goto notcon;
469 smb2srv_setinfo_recv(req);
472 if (!req->session) goto nosession;
473 if (!req->tcon) goto notcon;
474 smb2srv_break_recv(req);
478 DEBUG(1,("Invalid SMB2 opcode: 0x%04X\n", opcode));
479 smbsrv_terminate_connection(req->smb_conn, "Invalid SMB2 opcode");
483 smb2srv_send_error(req, NT_STATUS_USER_SESSION_DELETED);
486 smb2srv_send_error(req, NT_STATUS_NETWORK_NAME_DELETED);
490 NTSTATUS smbsrv_recv_smb2_request(void *private_data, DATA_BLOB blob)
492 struct smbsrv_connection *smb_conn = talloc_get_type(private_data, struct smbsrv_connection);
493 struct smb2srv_request *req;
494 struct timeval cur_time = timeval_current();
495 uint32_t protocol_version;
496 uint16_t buffer_code;
497 uint32_t dynamic_size;
500 smb_conn->statistics.last_request_time = cur_time;
502 /* see if its a special NBT packet */
503 if (CVAL(blob.data,0) != 0) {
504 DEBUG(2,("Special NBT packet on SMB2 connection"));
505 smbsrv_terminate_connection(smb_conn, "Special NBT packet on SMB2 connection");
509 if (blob.length < (NBT_HDR_SIZE + SMB2_MIN_SIZE_NO_BODY)) {
510 DEBUG(2,("Invalid SMB2 packet length count %ld\n", (long)blob.length));
511 smbsrv_terminate_connection(smb_conn, "Invalid SMB2 packet");
515 protocol_version = IVAL(blob.data, NBT_HDR_SIZE);
516 if (protocol_version != SMB2_MAGIC) {
517 DEBUG(2,("Invalid SMB packet: protocol prefix: 0x%08X\n",
519 smbsrv_terminate_connection(smb_conn, "NON-SMB2 packet");
523 req = smb2srv_init_request(smb_conn);
524 NT_STATUS_HAVE_NO_MEMORY(req);
526 req->in.buffer = talloc_steal(req, blob.data);
527 req->in.size = blob.length;
528 req->request_time = cur_time;
529 req->in.allocated = req->in.size;
531 req->in.hdr = req->in.buffer+ NBT_HDR_SIZE;
532 req->in.body = req->in.hdr + SMB2_HDR_BODY;
533 req->in.body_size = req->in.size - (SMB2_HDR_BODY+NBT_HDR_SIZE);
534 req->in.dynamic = NULL;
536 req->seqnum = BVAL(req->in.hdr, SMB2_HDR_MESSAGE_ID);
538 if (req->in.body_size < 2) {
539 /* error handling for this is different for negprot to
540 other packet types */
541 uint16_t opcode = SVAL(req->in.hdr, SMB2_HDR_OPCODE);
542 if (opcode == SMB2_OP_NEGPROT) {
543 smbsrv_terminate_connection(req->smb_conn, "Bad body size in SMB2 negprot");
546 smb2srv_send_error(req, NT_STATUS_INVALID_PARAMETER);
551 buffer_code = SVAL(req->in.body, 0);
552 req->in.body_fixed = (buffer_code & ~1);
553 dynamic_size = req->in.body_size - req->in.body_fixed;
555 if (dynamic_size != 0 && (buffer_code & 1)) {
556 req->in.dynamic = req->in.body + req->in.body_fixed;
557 if (smb2_oob(&req->in, req->in.dynamic, dynamic_size)) {
558 DEBUG(1,("SMB2 request invalid dynamic size 0x%x\n",
560 smb2srv_send_error(req, NT_STATUS_INVALID_PARAMETER);
565 smb2srv_setup_bufinfo(req);
568 * TODO: - make sure the length field is 64
569 * - make sure it's a request
572 flags = IVAL(req->in.hdr, SMB2_HDR_FLAGS);
573 /* the first request should never have the related flag set */
574 if (flags & SMB2_HDR_FLAG_CHAINED) {
575 req->chain_status = NT_STATUS_INVALID_PARAMETER;
578 return smb2srv_reply(req);
581 static NTSTATUS smb2srv_init_pending(struct smbsrv_connection *smb_conn)
583 smb_conn->requests2.idtree_req = idr_init(smb_conn);
584 NT_STATUS_HAVE_NO_MEMORY(smb_conn->requests2.idtree_req);
585 smb_conn->requests2.idtree_limit = 0x00FFFFFF & (UINT32_MAX - 1);
586 smb_conn->requests2.list = NULL;
591 NTSTATUS smb2srv_queue_pending(struct smb2srv_request *req)
594 bool signing_used = false;
596 uint16_t credits = SVAL(req->in.hdr, SMB2_HDR_CREDIT);
602 if (req->pending_id) {
603 return NT_STATUS_INTERNAL_ERROR;
606 if (req->smb_conn->connection->event.fde == NULL) {
607 /* the socket has been destroyed - no point trying to send an error! */
608 return NT_STATUS_REMOTE_DISCONNECT;
611 id = idr_get_new_above(req->smb_conn->requests2.idtree_req, req,
612 1, req->smb_conn->requests2.idtree_limit);
614 return NT_STATUS_INSUFFICIENT_RESOURCES;
617 DLIST_ADD_END(req->smb_conn->requests2.list, req, struct smb2srv_request *);
618 req->pending_id = id;
620 talloc_set_destructor(req, smb2srv_request_deny_destructor);
622 status = smb2srv_setup_reply(req, 8, true, 0);
623 if (!NT_STATUS_IS_OK(status)) {
627 SIVAL(req->out.hdr, SMB2_HDR_STATUS, NT_STATUS_V(STATUS_PENDING));
628 SSVAL(req->out.hdr, SMB2_HDR_CREDIT, credits);
630 SSVAL(req->out.body, 0x02, 0);
631 SIVAL(req->out.body, 0x04, 0);
633 /* if the real reply will be signed set the signed flags, but don't sign */
634 if (req->is_signed) {
635 SIVAL(req->out.hdr, SMB2_HDR_FLAGS, IVAL(req->out.hdr, SMB2_HDR_FLAGS) | SMB2_HDR_FLAG_SIGNED);
636 signing_used = req->is_signed;
637 req->is_signed = false;
640 smb2srv_send_reply(req);
642 req->is_signed = signing_used;
644 talloc_set_destructor(req, smb2srv_request_destructor);
648 void smb2srv_cancel_recv(struct smb2srv_request *req)
653 struct smb2srv_request *r;
655 if (!req->session) goto done;
657 flags = IVAL(req->in.hdr, SMB2_HDR_FLAGS);
658 pending_id = IVAL(req->in.hdr, SMB2_HDR_PID);
660 if (!(flags & SMB2_HDR_FLAG_ASYNC)) {
661 /* TODO: what to do here? */
665 p = idr_find(req->smb_conn->requests2.idtree_req, pending_id);
668 r = talloc_get_type(p, struct smb2srv_request);
671 if (!r->ntvfs) goto done;
673 ntvfs_cancel(r->ntvfs);
676 /* we never generate a reply for a SMB2 Cancel */
681 * init the SMB2 protocol related stuff
683 NTSTATUS smbsrv_init_smb2_connection(struct smbsrv_connection *smb_conn)
687 /* now initialise a few default values associated with this smb socket */
688 smb_conn->negotiate.max_send = 0xFFFF;
690 /* this is the size that w2k uses, and it appears to be important for
692 smb_conn->negotiate.max_recv = lpcfg_max_xmit(smb_conn->lp_ctx);
694 smb_conn->negotiate.zone_offset = get_time_zone(time(NULL));
696 smb_conn->config.nt_status_support = true;
698 status = smbsrv_init_sessions(smb_conn, UINT64_MAX);
699 NT_STATUS_NOT_OK_RETURN(status);
701 status = smb2srv_init_pending(smb_conn);
702 NT_STATUS_NOT_OK_RETURN(status);