2 Unix SMB/CIFS implementation.
3 NT transaction handling
4 Copyright (C) Andrew Tridgell 2003
5 Copyright (C) James J Myers 2003 <myersjj@samba.org>
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/>.
21 This file handles the parsing of transact2 requests
25 #include "smb_server/smb_server.h"
26 #include "ntvfs/ntvfs.h"
27 #include "libcli/raw/libcliraw.h"
28 #include "librpc/gen_ndr/ndr_security.h"
29 #include "param/param.h"
32 hold the state of a nttrans op while in progress. Needed to allow for async backend
36 struct smb_nttrans *trans;
37 NTSTATUS (*send_fn)(struct nttrans_op *);
42 /* setup a nttrans reply, given the data and params sizes */
43 static NTSTATUS nttrans_setup_reply(struct nttrans_op *op,
44 struct smb_nttrans *trans,
45 uint32_t param_size, uint32_t data_size,
48 trans->out.setup_count = setup_count;
49 if (setup_count != 0) {
50 trans->out.setup = talloc_zero_array(op, uint8_t, setup_count*2);
51 NT_STATUS_HAVE_NO_MEMORY(trans->out.setup);
53 trans->out.params = data_blob_talloc(op, NULL, param_size);
54 if (param_size != 0) {
55 NT_STATUS_HAVE_NO_MEMORY(trans->out.params.data);
57 trans->out.data = data_blob_talloc(op, NULL, data_size);
59 NT_STATUS_HAVE_NO_MEMORY(trans->out.data.data);
65 send a nttrans create reply
67 static NTSTATUS nttrans_create_send(struct nttrans_op *op)
69 union smb_open *io = talloc_get_type(op->op_info, union smb_open);
73 status = nttrans_setup_reply(op, op->trans, 69, 0, 0);
74 NT_STATUS_NOT_OK_RETURN(status);
75 params = op->trans->out.params.data;
77 SSVAL(params, 0, io->ntcreatex.out.oplock_level);
78 smbsrv_push_fnum(params, 2, io->ntcreatex.out.file.ntvfs);
79 SIVAL(params, 4, io->ntcreatex.out.create_action);
80 SIVAL(params, 8, 0); /* ea error offset */
81 push_nttime(params, 12, io->ntcreatex.out.create_time);
82 push_nttime(params, 20, io->ntcreatex.out.access_time);
83 push_nttime(params, 28, io->ntcreatex.out.write_time);
84 push_nttime(params, 36, io->ntcreatex.out.change_time);
85 SIVAL(params, 44, io->ntcreatex.out.attrib);
86 SBVAL(params, 48, io->ntcreatex.out.alloc_size);
87 SBVAL(params, 56, io->ntcreatex.out.size);
88 SSVAL(params, 64, io->ntcreatex.out.file_type);
89 SSVAL(params, 66, io->ntcreatex.out.ipc_state);
90 SCVAL(params, 68, io->ntcreatex.out.is_directory);
96 parse NTTRANS_CREATE request
98 static NTSTATUS nttrans_create(struct smbsrv_request *req,
99 struct nttrans_op *op)
101 struct smb_nttrans *trans = op->trans;
104 uint32_t sd_length, ea_length;
107 enum ndr_err_code ndr_err;
109 if (trans->in.params.length < 54) {
110 return NT_STATUS_INVALID_PARAMETER;
113 /* parse the request */
114 io = talloc(op, union smb_open);
115 NT_STATUS_HAVE_NO_MEMORY(io);
117 io->ntcreatex.level = RAW_OPEN_NTTRANS_CREATE;
119 params = trans->in.params.data;
121 io->ntcreatex.in.flags = IVAL(params, 0);
122 io->ntcreatex.in.root_fid = IVAL(params, 4);
123 io->ntcreatex.in.access_mask = IVAL(params, 8);
124 io->ntcreatex.in.alloc_size = BVAL(params, 12);
125 io->ntcreatex.in.file_attr = IVAL(params, 20);
126 io->ntcreatex.in.share_access = IVAL(params, 24);
127 io->ntcreatex.in.open_disposition = IVAL(params, 28);
128 io->ntcreatex.in.create_options = IVAL(params, 32);
129 sd_length = IVAL(params, 36);
130 ea_length = IVAL(params, 40);
131 fname_len = IVAL(params, 44);
132 io->ntcreatex.in.impersonation = IVAL(params, 48);
133 io->ntcreatex.in.security_flags = CVAL(params, 52);
134 io->ntcreatex.in.sec_desc = NULL;
135 io->ntcreatex.in.ea_list = NULL;
137 req_pull_string(req, &io->ntcreatex.in.fname,
139 MIN(fname_len+1, trans->in.params.length - 53),
140 STR_NO_RANGE_CHECK | STR_TERMINATE);
141 if (!io->ntcreatex.in.fname) {
142 return NT_STATUS_INVALID_PARAMETER;
145 if (sd_length > trans->in.data.length ||
146 ea_length > trans->in.data.length ||
147 (sd_length+ea_length) > trans->in.data.length) {
148 return NT_STATUS_INVALID_PARAMETER;
151 /* this call has an optional security descriptor */
152 if (sd_length != 0) {
154 blob.data = trans->in.data.data;
155 blob.length = sd_length;
156 io->ntcreatex.in.sec_desc = talloc(io, struct security_descriptor);
157 if (io->ntcreatex.in.sec_desc == NULL) {
158 return NT_STATUS_NO_MEMORY;
160 ndr_err = ndr_pull_struct_blob(&blob, io, NULL,
161 io->ntcreatex.in.sec_desc,
162 (ndr_pull_flags_fn_t)ndr_pull_security_descriptor);
163 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
164 return ndr_map_error2ntstatus(ndr_err);
168 /* and an optional ea_list */
171 blob.data = trans->in.data.data + sd_length;
172 blob.length = ea_length;
173 io->ntcreatex.in.ea_list = talloc(io, struct smb_ea_list);
174 if (io->ntcreatex.in.ea_list == NULL) {
175 return NT_STATUS_NO_MEMORY;
178 status = ea_pull_list_chained(&blob, io,
179 &io->ntcreatex.in.ea_list->num_eas,
180 &io->ntcreatex.in.ea_list->eas);
181 if (!NT_STATUS_IS_OK(status)) {
186 op->send_fn = nttrans_create_send;
189 return ntvfs_open(req->ntvfs, io);
194 send NTTRANS_QUERY_SEC_DESC reply
196 static NTSTATUS nttrans_query_sec_desc_send(struct nttrans_op *op)
198 union smb_fileinfo *io = talloc_get_type(op->op_info, union smb_fileinfo);
201 enum ndr_err_code ndr_err;
203 status = nttrans_setup_reply(op, op->trans, 4, 0, 0);
204 NT_STATUS_NOT_OK_RETURN(status);
205 params = op->trans->out.params.data;
207 ndr_err = ndr_push_struct_blob(&op->trans->out.data, op, NULL,
208 io->query_secdesc.out.sd,
209 (ndr_push_flags_fn_t)ndr_push_security_descriptor);
210 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
211 return ndr_map_error2ntstatus(ndr_err);
214 SIVAL(params, 0, op->trans->out.data.length);
220 parse NTTRANS_QUERY_SEC_DESC request
222 static NTSTATUS nttrans_query_sec_desc(struct smbsrv_request *req,
223 struct nttrans_op *op)
225 struct smb_nttrans *trans = op->trans;
226 union smb_fileinfo *io;
228 if (trans->in.params.length < 8) {
229 return NT_STATUS_INVALID_PARAMETER;
232 /* parse the request */
233 io = talloc(op, union smb_fileinfo);
234 NT_STATUS_HAVE_NO_MEMORY(io);
236 io->query_secdesc.level = RAW_FILEINFO_SEC_DESC;
237 io->query_secdesc.in.file.ntvfs = smbsrv_pull_fnum(req, trans->in.params.data, 0);
238 io->query_secdesc.in.secinfo_flags = IVAL(trans->in.params.data, 4);
241 op->send_fn = nttrans_query_sec_desc_send;
243 SMBSRV_CHECK_FILE_HANDLE_NTSTATUS(io->query_secdesc.in.file.ntvfs);
244 return ntvfs_qfileinfo(req->ntvfs, io);
249 parse NTTRANS_SET_SEC_DESC request
251 static NTSTATUS nttrans_set_sec_desc(struct smbsrv_request *req,
252 struct nttrans_op *op)
254 struct smb_nttrans *trans = op->trans;
255 union smb_setfileinfo *io;
256 enum ndr_err_code ndr_err;
258 if (trans->in.params.length < 8) {
259 return NT_STATUS_INVALID_PARAMETER;
262 /* parse the request */
263 io = talloc(req, union smb_setfileinfo);
264 NT_STATUS_HAVE_NO_MEMORY(io);
266 io->set_secdesc.level = RAW_SFILEINFO_SEC_DESC;
267 io->set_secdesc.in.file.ntvfs = smbsrv_pull_fnum(req, trans->in.params.data, 0);
268 io->set_secdesc.in.secinfo_flags = IVAL(trans->in.params.data, 4);
270 io->set_secdesc.in.sd = talloc(io, struct security_descriptor);
271 NT_STATUS_HAVE_NO_MEMORY(io->set_secdesc.in.sd);
273 ndr_err = ndr_pull_struct_blob(&trans->in.data, req, NULL,
274 io->set_secdesc.in.sd,
275 (ndr_pull_flags_fn_t)ndr_pull_security_descriptor);
276 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
277 return ndr_map_error2ntstatus(ndr_err);
280 SMBSRV_CHECK_FILE_HANDLE_NTSTATUS(io->set_secdesc.in.file.ntvfs);
281 return ntvfs_setfileinfo(req->ntvfs, io);
285 /* parse NTTRANS_RENAME request
287 static NTSTATUS nttrans_rename(struct smbsrv_request *req,
288 struct nttrans_op *op)
290 return NT_STATUS_NOT_IMPLEMENTED;
294 parse NTTRANS_IOCTL send
296 static NTSTATUS nttrans_ioctl_send(struct nttrans_op *op)
298 union smb_ioctl *info = talloc_get_type(op->op_info, union smb_ioctl);
302 * we pass 0 as data_count here,
303 * because we reuse the DATA_BLOB from the smb_ioctl
306 status = nttrans_setup_reply(op, op->trans, 0, 0, 1);
307 NT_STATUS_NOT_OK_RETURN(status);
309 op->trans->out.setup[0] = 0;
310 op->trans->out.data = info->ntioctl.out.blob;
317 parse NTTRANS_IOCTL request
319 static NTSTATUS nttrans_ioctl(struct smbsrv_request *req,
320 struct nttrans_op *op)
322 struct smb_nttrans *trans = op->trans;
325 /* should have at least 4 setup words */
326 if (trans->in.setup_count != 4) {
327 return NT_STATUS_INVALID_PARAMETER;
330 nt = talloc(op, union smb_ioctl);
331 NT_STATUS_HAVE_NO_MEMORY(nt);
333 nt->ntioctl.level = RAW_IOCTL_NTIOCTL;
334 nt->ntioctl.in.function = IVAL(trans->in.setup, 0);
335 nt->ntioctl.in.file.ntvfs = smbsrv_pull_fnum(req, (uint8_t *)trans->in.setup, 4);
336 nt->ntioctl.in.fsctl = CVAL(trans->in.setup, 6);
337 nt->ntioctl.in.filter = CVAL(trans->in.setup, 7);
338 nt->ntioctl.in.max_data = trans->in.max_data;
339 nt->ntioctl.in.blob = trans->in.data;
342 op->send_fn = nttrans_ioctl_send;
344 SMBSRV_CHECK_FILE_HANDLE_NTSTATUS(nt->ntioctl.in.file.ntvfs);
345 return ntvfs_ioctl(req->ntvfs, nt);
350 send NTTRANS_NOTIFY_CHANGE reply
352 static NTSTATUS nttrans_notify_change_send(struct nttrans_op *op)
354 union smb_notify *info = talloc_get_type(op->op_info, union smb_notify);
359 #define MAX_BYTES_PER_CHAR 3
361 /* work out how big the reply buffer could be */
362 for (i=0;i<info->nttrans.out.num_changes;i++) {
363 size += 12 + 3 + (1+strlen(info->nttrans.out.changes[i].name.s)) * MAX_BYTES_PER_CHAR;
366 status = nttrans_setup_reply(op, op->trans, size, 0, 0);
367 NT_STATUS_NOT_OK_RETURN(status);
368 p = op->trans->out.params.data;
370 /* construct the changes buffer */
371 for (i=0;i<info->nttrans.out.num_changes;i++) {
375 SIVAL(p, 4, info->nttrans.out.changes[i].action);
376 len = push_string(lp_iconv_convenience(global_loadparm), p + 12, info->nttrans.out.changes[i].name.s,
377 op->trans->out.params.length -
378 (p+12 - op->trans->out.params.data), STR_UNICODE);
384 int pad = 4 - (ofs & 3);
385 memset(p+ofs, 0, pad);
389 if (i == info->nttrans.out.num_changes-1) {
398 op->trans->out.params.length = p - op->trans->out.params.data;
404 parse NTTRANS_NOTIFY_CHANGE request
406 static NTSTATUS nttrans_notify_change(struct smbsrv_request *req,
407 struct nttrans_op *op)
409 struct smb_nttrans *trans = op->trans;
410 union smb_notify *info;
412 /* should have at least 4 setup words */
413 if (trans->in.setup_count != 4) {
414 return NT_STATUS_INVALID_PARAMETER;
417 info = talloc(op, union smb_notify);
418 NT_STATUS_HAVE_NO_MEMORY(info);
420 info->nttrans.level = RAW_NOTIFY_NTTRANS;
421 info->nttrans.in.completion_filter = IVAL(trans->in.setup, 0);
422 info->nttrans.in.file.ntvfs = smbsrv_pull_fnum(req, (uint8_t *)trans->in.setup, 4);
423 info->nttrans.in.recursive = SVAL(trans->in.setup, 6);
424 info->nttrans.in.buffer_size = trans->in.max_param;
427 op->send_fn = nttrans_notify_change_send;
429 SMBSRV_CHECK_FILE_HANDLE_NTSTATUS(info->nttrans.in.file.ntvfs);
430 return ntvfs_notify(req->ntvfs, info);
434 backend for nttrans requests
436 static NTSTATUS nttrans_backend(struct smbsrv_request *req,
437 struct nttrans_op *op)
439 /* the nttrans command is in function */
440 switch (op->trans->in.function) {
441 case NT_TRANSACT_CREATE:
442 return nttrans_create(req, op);
443 case NT_TRANSACT_IOCTL:
444 return nttrans_ioctl(req, op);
445 case NT_TRANSACT_RENAME:
446 return nttrans_rename(req, op);
447 case NT_TRANSACT_QUERY_SECURITY_DESC:
448 return nttrans_query_sec_desc(req, op);
449 case NT_TRANSACT_SET_SECURITY_DESC:
450 return nttrans_set_sec_desc(req, op);
451 case NT_TRANSACT_NOTIFY_CHANGE:
452 return nttrans_notify_change(req, op);
455 /* an unknown nttrans command */
456 return NT_STATUS_DOS(ERRSRV, ERRerror);
460 static void reply_nttrans_send(struct ntvfs_request *ntvfs)
462 struct smbsrv_request *req;
463 uint16_t params_left, data_left;
464 uint8_t *params, *data;
465 struct smb_nttrans *trans;
466 struct nttrans_op *op;
468 SMBSRV_CHECK_ASYNC_STATUS(op, struct nttrans_op);
472 /* if this function needs work to form the nttrans reply buffer, then
474 if (op->send_fn != NULL) {
476 status = op->send_fn(op);
477 if (!NT_STATUS_IS_OK(status)) {
478 smbsrv_send_error(req, status);
483 smbsrv_setup_reply(req, 18 + trans->out.setup_count, 0);
485 /* note that we don't check the max_setup count (matching w2k3
488 if (trans->out.params.length > trans->in.max_param) {
489 smbsrv_setup_error(req, NT_STATUS_BUFFER_TOO_SMALL);
490 trans->out.params.length = trans->in.max_param;
492 if (trans->out.data.length > trans->in.max_data) {
493 smbsrv_setup_error(req, NT_STATUS_BUFFER_TOO_SMALL);
494 trans->out.data.length = trans->in.max_data;
497 params_left = trans->out.params.length;
498 data_left = trans->out.data.length;
499 params = trans->out.params.data;
500 data = trans->out.data.data;
502 /* we need to divide up the reply into chunks that fit into
503 the negotiated buffer size */
505 uint16_t this_data, this_param, max_bytes;
506 uint_t align1 = 1, align2 = (params_left ? 2 : 0);
507 struct smbsrv_request *this_req;
509 max_bytes = req_max_data(req) - (align1 + align2);
511 this_param = params_left;
512 if (this_param > max_bytes) {
513 this_param = max_bytes;
515 max_bytes -= this_param;
517 this_data = data_left;
518 if (this_data > max_bytes) {
519 this_data = max_bytes;
522 /* don't destroy unless this is the last chunk */
523 if (params_left - this_param != 0 ||
524 data_left - this_data != 0) {
525 this_req = smbsrv_setup_secondary_request(req);
530 req_grow_data(this_req, this_param + this_data + (align1 + align2));
532 SSVAL(this_req->out.vwv, 0, 0); /* reserved */
533 SCVAL(this_req->out.vwv, 2, 0); /* reserved */
534 SIVAL(this_req->out.vwv, 3, trans->out.params.length);
535 SIVAL(this_req->out.vwv, 7, trans->out.data.length);
537 SIVAL(this_req->out.vwv, 11, this_param);
538 SIVAL(this_req->out.vwv, 15, align1 + PTR_DIFF(this_req->out.data, this_req->out.hdr));
539 SIVAL(this_req->out.vwv, 19, PTR_DIFF(params, trans->out.params.data));
541 SIVAL(this_req->out.vwv, 23, this_data);
542 SIVAL(this_req->out.vwv, 27, align1 + align2 +
543 PTR_DIFF(this_req->out.data + this_param, this_req->out.hdr));
544 SIVAL(this_req->out.vwv, 31, PTR_DIFF(data, trans->out.data.data));
546 SCVAL(this_req->out.vwv, 35, trans->out.setup_count);
547 memcpy((char *)(this_req->out.vwv) + VWV(18), trans->out.setup,
548 sizeof(uint16_t) * trans->out.setup_count);
549 memset(this_req->out.data, 0, align1);
550 if (this_param != 0) {
551 memcpy(this_req->out.data + align1, params, this_param);
553 memset(this_req->out.data+this_param+align1, 0, align2);
554 if (this_data != 0) {
555 memcpy(this_req->out.data+this_param+align1+align2,
559 params_left -= this_param;
560 data_left -= this_data;
561 params += this_param;
564 smbsrv_send_reply(this_req);
565 } while (params_left != 0 || data_left != 0);
569 /****************************************************************************
570 Reply to an SMBnttrans request
571 ****************************************************************************/
572 void smbsrv_reply_nttrans(struct smbsrv_request *req)
574 struct nttrans_op *op;
575 struct smb_nttrans *trans;
576 uint16_t param_ofs, data_ofs;
577 uint16_t param_count, data_count;
578 uint16_t param_total, data_total;
581 if (req->in.wct < 19) {
582 smbsrv_send_error(req, NT_STATUS_FOOBAR);
586 SMBSRV_TALLOC_IO_PTR(op, struct nttrans_op);
587 SMBSRV_SETUP_NTVFS_REQUEST(reply_nttrans_send, NTVFS_ASYNC_STATE_MAY_ASYNC);
589 trans = talloc(op, struct smb_nttrans);
591 smbsrv_send_error(req, NT_STATUS_NO_MEMORY);
599 trans->in.max_setup = CVAL(req->in.vwv, 0);
600 param_total = IVAL(req->in.vwv, 3);
601 data_total = IVAL(req->in.vwv, 7);
602 trans->in.max_param = IVAL(req->in.vwv, 11);
603 trans->in.max_data = IVAL(req->in.vwv, 15);
604 param_count = IVAL(req->in.vwv, 19);
605 param_ofs = IVAL(req->in.vwv, 23);
606 data_count = IVAL(req->in.vwv, 27);
607 data_ofs = IVAL(req->in.vwv, 31);
608 trans->in.setup_count= CVAL(req->in.vwv, 35);
609 trans->in.function = SVAL(req->in.vwv, 36);
611 if (req->in.wct != 19 + trans->in.setup_count) {
612 smbsrv_send_error(req, NT_STATUS_DOS(ERRSRV, ERRerror));
616 /* parse out the setup words */
617 trans->in.setup = talloc_array(req, uint8_t, trans->in.setup_count*2);
618 if (!trans->in.setup) {
619 smbsrv_send_error(req, NT_STATUS_NO_MEMORY);
622 memcpy(trans->in.setup, (char *)(req->in.vwv) + VWV(19),
623 sizeof(uint16_t) * trans->in.setup_count);
625 if (!req_pull_blob(req, req->in.hdr + param_ofs, param_count, &trans->in.params) ||
626 !req_pull_blob(req, req->in.hdr + data_ofs, data_count, &trans->in.data)) {
627 smbsrv_send_error(req, NT_STATUS_FOOBAR);
631 /* is it a partial request? if so, then send a 'send more' message */
632 if (param_total > param_count ||
633 data_total > data_count) {
634 DEBUG(0,("REWRITE: not handling partial nttrans requests!\n"));
635 smbsrv_send_error(req, NT_STATUS_FOOBAR);
639 ZERO_STRUCT(trans->out);
640 SMBSRV_CALL_NTVFS_BACKEND(nttrans_backend(req, op));
644 /****************************************************************************
645 Reply to an SMBnttranss request
646 ****************************************************************************/
647 void smbsrv_reply_nttranss(struct smbsrv_request *req)
649 smbsrv_send_error(req, NT_STATUS_FOOBAR);