source4/torture/smb2/util.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    helper functions for SMB2 test suite
   5
   6    Copyright (C) Andrew Tridgell 2005
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "libcli/security/security_descriptor.h"
  24 #include "libcli/smb2/smb2.h"
  25 #include "libcli/smb2/smb2_calls.h"
  26 #include "lib/cmdline/popt_common.h"
  27 #include "system/time.h"
  28 #include "librpc/gen_ndr/ndr_security.h"
  29 #include "param/param.h"
  30 #include "libcli/resolve/resolve.h"
  31
  32 #include "torture/torture.h"
  33 #include "torture/smb2/proto.h"
  34
  35
  36 /*
  37   write to a file on SMB2
  38 */
  39 NTSTATUS smb2_util_write(struct smb2_tree *tree,
  40                          struct smb2_handle handle,
  41                          const void *buf, off_t offset, size_t size)
  42 {
  43         struct smb2_write w;
  44
  45         ZERO_STRUCT(w);
  46         w.in.file.handle = handle;
  47         w.in.offset      = offset;
  48         w.in.data        = data_blob_const(buf, size);
  49
  50         return smb2_write(tree, &w);
  51 }
  52
  53 /*
  54   create a complex file/dir using the SMB2 protocol
  55 */
  56 static NTSTATUS smb2_create_complex(struct smb2_tree *tree, const char *fname,
  57                                          struct smb2_handle *handle, bool dir)
  58 {
  59         TALLOC_CTX *tmp_ctx = talloc_new(tree);
  60         char buf[7] = "abc";
  61         struct smb2_create io;
  62         union smb_setfileinfo setfile;
  63         union smb_fileinfo fileinfo;
  64         time_t t = (time(NULL) & ~1);
  65         NTSTATUS status;
  66
  67         smb2_util_unlink(tree, fname);
  68         ZERO_STRUCT(io);
  69         io.in.desired_access = SEC_FLAG_MAXIMUM_ALLOWED;
  70         io.in.file_attributes   = FILE_ATTRIBUTE_NORMAL;
  71         io.in.create_disposition = NTCREATEX_DISP_OVERWRITE_IF;
  72         io.in.share_access =
  73                 NTCREATEX_SHARE_ACCESS_DELETE|
  74                 NTCREATEX_SHARE_ACCESS_READ|
  75                 NTCREATEX_SHARE_ACCESS_WRITE;
  76         io.in.create_options = 0;
  77         io.in.fname = fname;
  78         if (dir) {
  79                 io.in.create_options = NTCREATEX_OPTIONS_DIRECTORY;
  80                 io.in.share_access &= ~NTCREATEX_SHARE_ACCESS_DELETE;
  81                 io.in.file_attributes   = FILE_ATTRIBUTE_DIRECTORY;
  82                 io.in.create_disposition = NTCREATEX_DISP_CREATE;
  83         }
  84
  85         /* it seems vista is now fussier about alignment? */
  86         if (strchr(fname, ':') == NULL) {
  87                 /* setup some EAs */
  88                 io.in.eas.num_eas = 2;
  89                 io.in.eas.eas = talloc_array(tmp_ctx, struct ea_struct, 2);
  90                 io.in.eas.eas[0].flags = 0;
  91                 io.in.eas.eas[0].name.s = "EAONE";
  92                 io.in.eas.eas[0].value = data_blob_talloc(tmp_ctx, "VALUE1", 6);
  93                 io.in.eas.eas[1].flags = 0;
  94                 io.in.eas.eas[1].name.s = "SECONDEA";
  95                 io.in.eas.eas[1].value = data_blob_talloc(tmp_ctx, "ValueTwo", 8);
  96         }
  97
  98         status = smb2_create(tree, tmp_ctx, &io);
  99         talloc_free(tmp_ctx);
 100         NT_STATUS_NOT_OK_RETURN(status);
 101
 102         *handle = io.out.file.handle;
 103
 104         if (!dir) {
 105                 status = smb2_util_write(tree, *handle, buf, 0, sizeof(buf));
 106                 NT_STATUS_NOT_OK_RETURN(status);
 107         }
 108
 109         /* make sure all the timestamps aren't the same, and are also
 110            in different DST zones*/
 111         setfile.generic.level = RAW_SFILEINFO_BASIC_INFORMATION;
 112         setfile.generic.in.file.handle = *handle;
 113
 114         unix_to_nt_time(&setfile.basic_info.in.create_time, t + 9*30*24*60*60);
 115         unix_to_nt_time(&setfile.basic_info.in.access_time, t + 6*30*24*60*60);
 116         unix_to_nt_time(&setfile.basic_info.in.write_time,  t + 3*30*24*60*60);
 117         unix_to_nt_time(&setfile.basic_info.in.change_time, t + 1*30*24*60*60);
 118         setfile.basic_info.in.attrib      = FILE_ATTRIBUTE_NORMAL;
 119
 120         status = smb2_setinfo_file(tree, &setfile);
 121         if (!NT_STATUS_IS_OK(status)) {
 122                 printf("Failed to setup file times - %s\n", nt_errstr(status));
 123                 return status;
 124         }
 125
 126         /* make sure all the timestamps aren't the same */
 127         fileinfo.generic.level = RAW_FILEINFO_SMB2_ALL_INFORMATION;
 128         fileinfo.generic.in.file.handle = *handle;
 129
 130         status = smb2_getinfo_file(tree, tree, &fileinfo);
 131         if (!NT_STATUS_IS_OK(status)) {
 132                 printf("Failed to query file times - %s\n", nt_errstr(status));
 133                 return status;
 134
 135         }
 136
 137 #define CHECK_TIME(field) do {\
 138         if (setfile.basic_info.in.field != fileinfo.all_info2.out.field) { \
 139                 printf("(%s) " #field " not setup correctly: %s(%llu) => %s(%llu)\n", \
 140                         __location__, \
 141                         nt_time_string(tree, setfile.basic_info.in.field), \
 142                         (unsigned long long)setfile.basic_info.in.field, \
 143                         nt_time_string(tree, fileinfo.basic_info.out.field), \
 144                         (unsigned long long)fileinfo.basic_info.out.field); \
 145                 status = NT_STATUS_INVALID_PARAMETER; \
 146         } \
 147 } while (0)
 148
 149         CHECK_TIME(create_time);
 150         CHECK_TIME(access_time);
 151         CHECK_TIME(write_time);
 152         CHECK_TIME(change_time);
 153
 154         return status;
 155 }
 156
 157 /*
 158   create a complex file using the SMB2 protocol
 159 */
 160 NTSTATUS smb2_create_complex_file(struct smb2_tree *tree, const char *fname,
 161                                          struct smb2_handle *handle)
 162 {
 163         return smb2_create_complex(tree, fname, handle, false);
 164 }
 165
 166 /*
 167   create a complex dir using the SMB2 protocol
 168 */
 169 NTSTATUS smb2_create_complex_dir(struct smb2_tree *tree, const char *fname,
 170                                  struct smb2_handle *handle)
 171 {
 172         return smb2_create_complex(tree, fname, handle, true);
 173 }
 174
 175 /*
 176   show lots of information about a file
 177 */
 178 void torture_smb2_all_info(struct smb2_tree *tree, struct smb2_handle handle)
 179 {
 180         NTSTATUS status;
 181         TALLOC_CTX *tmp_ctx = talloc_new(tree);
 182         union smb_fileinfo io;
 183
 184         io.generic.level = RAW_FILEINFO_SMB2_ALL_INFORMATION;
 185         io.generic.in.file.handle = handle;
 186
 187         status = smb2_getinfo_file(tree, tmp_ctx, &io);
 188         if (!NT_STATUS_IS_OK(status)) {
 189                 DEBUG(0,("getinfo failed - %s\n", nt_errstr(status)));
 190                 talloc_free(tmp_ctx);
 191                 return;
 192         }
 193
 194         d_printf("all_info for '%s'\n", io.all_info2.out.fname.s);
 195         d_printf("\tcreate_time:    %s\n", nt_time_string(tmp_ctx, io.all_info2.out.create_time));
 196         d_printf("\taccess_time:    %s\n", nt_time_string(tmp_ctx, io.all_info2.out.access_time));
 197         d_printf("\twrite_time:     %s\n", nt_time_string(tmp_ctx, io.all_info2.out.write_time));
 198         d_printf("\tchange_time:    %s\n", nt_time_string(tmp_ctx, io.all_info2.out.change_time));
 199         d_printf("\tattrib:         0x%x\n", io.all_info2.out.attrib);
 200         d_printf("\tunknown1:       0x%x\n", io.all_info2.out.unknown1);
 201         d_printf("\talloc_size:     %llu\n", (long long)io.all_info2.out.alloc_size);
 202         d_printf("\tsize:           %llu\n", (long long)io.all_info2.out.size);
 203         d_printf("\tnlink:          %u\n", io.all_info2.out.nlink);
 204         d_printf("\tdelete_pending: %u\n", io.all_info2.out.delete_pending);
 205         d_printf("\tdirectory:      %u\n", io.all_info2.out.directory);
 206         d_printf("\tfile_id:        %llu\n", (long long)io.all_info2.out.file_id);
 207         d_printf("\tea_size:        %u\n", io.all_info2.out.ea_size);
 208         d_printf("\taccess_mask:    0x%08x\n", io.all_info2.out.access_mask);
 209         d_printf("\tposition:       0x%llx\n", (long long)io.all_info2.out.position);
 210         d_printf("\tmode:           0x%llx\n", (long long)io.all_info2.out.mode);
 211
 212         /* short name, if any */
 213         io.generic.level = RAW_FILEINFO_ALT_NAME_INFORMATION;
 214         status = smb2_getinfo_file(tree, tmp_ctx, &io);
 215         if (NT_STATUS_IS_OK(status)) {
 216                 d_printf("\tshort name:     '%s'\n", io.alt_name_info.out.fname.s);
 217         }
 218
 219         /* the EAs, if any */
 220         io.generic.level = RAW_FILEINFO_SMB2_ALL_EAS;
 221         status = smb2_getinfo_file(tree, tmp_ctx, &io);
 222         if (NT_STATUS_IS_OK(status)) {
 223                 int i;
 224                 for (i=0;i<io.all_eas.out.num_eas;i++) {
 225                         d_printf("\tEA[%d] flags=%d len=%d '%s'\n", i,
 226                                  io.all_eas.out.eas[i].flags,
 227                                  (int)io.all_eas.out.eas[i].value.length,
 228                                  io.all_eas.out.eas[i].name.s);
 229                 }
 230         }
 231
 232         /* streams, if available */
 233         io.generic.level = RAW_FILEINFO_STREAM_INFORMATION;
 234         status = smb2_getinfo_file(tree, tmp_ctx, &io);
 235         if (NT_STATUS_IS_OK(status)) {
 236                 int i;
 237                 for (i=0;i<io.stream_info.out.num_streams;i++) {
 238                         d_printf("\tstream %d:\n", i);
 239                         d_printf("\t\tsize       %ld\n",
 240                                  (long)io.stream_info.out.streams[i].size);
 241                         d_printf("\t\talloc size %ld\n",
 242                                  (long)io.stream_info.out.streams[i].alloc_size);
 243                         d_printf("\t\tname       %s\n", io.stream_info.out.streams[i].stream_name.s);
 244                 }
 245         }
 246
 247         if (DEBUGLVL(1)) {
 248                 /* the security descriptor */
 249                 io.query_secdesc.level = RAW_FILEINFO_SEC_DESC;
 250                 io.query_secdesc.in.secinfo_flags =
 251                         SECINFO_OWNER|SECINFO_GROUP|
 252                         SECINFO_DACL;
 253                 status = smb2_getinfo_file(tree, tmp_ctx, &io);
 254                 if (NT_STATUS_IS_OK(status)) {
 255                         NDR_PRINT_DEBUG(security_descriptor, io.query_secdesc.out.sd);
 256                 }
 257         }
 258
 259         talloc_free(tmp_ctx);
 260 }
 261
 262
 263 /*
 264   open a smb2 connection
 265 */
 266 bool torture_smb2_connection(struct torture_context *tctx, struct smb2_tree **tree)
 267 {
 268         NTSTATUS status;
 269         const char *host = torture_setting_string(tctx, "host", NULL);
 270         const char *share = torture_setting_string(tctx, "share", NULL);
 271         struct cli_credentials *credentials = cmdline_credentials;
 272         struct smbcli_options options;
 273
 274         lpcfg_smbcli_options(tctx->lp_ctx, &options);
 275
 276         status = smb2_connect(tctx,
 277                               host,
 278                               lpcfg_smb_ports(tctx->lp_ctx),
 279                               share,
 280                               lpcfg_resolve_context(tctx->lp_ctx),
 281                               credentials,
 282                               tree,
 283                               tctx->ev,
 284                               &options,
 285                               lpcfg_socket_options(tctx->lp_ctx),
 286                               lpcfg_gensec_settings(tctx, tctx->lp_ctx)
 287                               );
 288         if (!NT_STATUS_IS_OK(status)) {
 289                 printf("Failed to connect to SMB2 share \\\\%s\\%s - %s\n",
 290                        host, share, nt_errstr(status));
 291                 return false;
 292         }
 293         return true;
 294 }
 295
 296
 297 /*
 298   create and return a handle to a test file
 299 */
 300 NTSTATUS torture_smb2_testfile(struct smb2_tree *tree, const char *fname,
 301                                struct smb2_handle *handle)
 302 {
 303         struct smb2_create io;
 304         NTSTATUS status;
 305
 306         ZERO_STRUCT(io);
 307         io.in.oplock_level = 0;
 308         io.in.desired_access = SEC_RIGHTS_FILE_ALL;
 309         io.in.file_attributes   = FILE_ATTRIBUTE_NORMAL;
 310         io.in.create_disposition = NTCREATEX_DISP_OPEN_IF;
 311         io.in.share_access =
 312                 NTCREATEX_SHARE_ACCESS_DELETE|
 313                 NTCREATEX_SHARE_ACCESS_READ|
 314                 NTCREATEX_SHARE_ACCESS_WRITE;
 315         io.in.create_options = 0;
 316         io.in.fname = fname;
 317
 318         status = smb2_create(tree, tree, &io);
 319         NT_STATUS_NOT_OK_RETURN(status);
 320
 321         *handle = io.out.file.handle;
 322
 323         return NT_STATUS_OK;
 324 }
 325
 326 /*
 327   create and return a handle to a test directory
 328 */
 329 NTSTATUS torture_smb2_testdir(struct smb2_tree *tree, const char *fname,
 330                               struct smb2_handle *handle)
 331 {
 332         struct smb2_create io;
 333         NTSTATUS status;
 334
 335         ZERO_STRUCT(io);
 336         io.in.oplock_level = 0;
 337         io.in.desired_access = SEC_RIGHTS_DIR_ALL;
 338         io.in.file_attributes   = FILE_ATTRIBUTE_DIRECTORY;
 339         io.in.create_disposition = NTCREATEX_DISP_OPEN_IF;
 340         io.in.share_access = NTCREATEX_SHARE_ACCESS_READ|NTCREATEX_SHARE_ACCESS_WRITE|NTCREATEX_SHARE_ACCESS_DELETE;
 341         io.in.create_options = NTCREATEX_OPTIONS_DIRECTORY;
 342         io.in.fname = fname;
 343
 344         status = smb2_create(tree, tree, &io);
 345         NT_STATUS_NOT_OK_RETURN(status);
 346
 347         *handle = io.out.file.handle;
 348
 349         return NT_STATUS_OK;
 350 }
 351
 352
 353 /*
 354   create a complex file using SMB2, to make it easier to
 355   find fields in SMB2 getinfo levels
 356 */
 357 NTSTATUS torture_setup_complex_file(struct smb2_tree *tree, const char *fname)
 358 {
 359         struct smb2_handle handle;
 360         NTSTATUS status = smb2_create_complex_file(tree, fname, &handle);
 361         NT_STATUS_NOT_OK_RETURN(status);
 362         return smb2_util_close(tree, handle);
 363 }
 364
 365
 366 /*
 367   create a complex dir using SMB2, to make it easier to
 368   find fields in SMB2 getinfo levels
 369 */
 370 NTSTATUS torture_setup_complex_dir(struct smb2_tree *tree, const char *fname)
 371 {
 372         struct smb2_handle handle;
 373         NTSTATUS status = smb2_create_complex_dir(tree, fname, &handle);
 374         NT_STATUS_NOT_OK_RETURN(status);
 375         return smb2_util_close(tree, handle);
 376 }
 377
 378
 379 /*
 380   return a handle to the root of the share
 381 */
 382 NTSTATUS smb2_util_roothandle(struct smb2_tree *tree, struct smb2_handle *handle)
 383 {
 384         struct smb2_create io;
 385         NTSTATUS status;
 386
 387         ZERO_STRUCT(io);
 388         io.in.oplock_level = 0;
 389         io.in.desired_access = SEC_STD_SYNCHRONIZE | SEC_DIR_READ_ATTRIBUTE | SEC_DIR_LIST;
 390         io.in.file_attributes   = 0;
 391         io.in.create_disposition = NTCREATEX_DISP_OPEN;
 392         io.in.share_access = NTCREATEX_SHARE_ACCESS_READ|NTCREATEX_SHARE_ACCESS_DELETE;
 393         io.in.create_options = NTCREATEX_OPTIONS_ASYNC_ALERT;
 394         io.in.fname = NULL;
 395
 396         status = smb2_create(tree, tree, &io);
 397         NT_STATUS_NOT_OK_RETURN(status);
 398
 399         *handle = io.out.file.handle;
 400
 401         return NT_STATUS_OK;
 402 }
 403
 404 /* Comparable to torture_setup_dir, but for SMB2. */
 405 bool smb2_util_setup_dir(struct torture_context *tctx, struct smb2_tree *tree,
 406     const char *dname)
 407 {
 408         NTSTATUS status;
 409
 410         /* XXX: smb_raw_exit equivalent?
 411         smb_raw_exit(cli->session); */
 412         if (smb2_deltree(tree, dname) == -1) {
 413                 torture_result(tctx, TORTURE_ERROR, "Unable to deltree when setting up %s.\n", dname);
 414                 return false;
 415         }
 416
 417         status = smb2_util_mkdir(tree, dname);
 418         if (NT_STATUS_IS_ERR(status)) {
 419                 torture_result(tctx, TORTURE_ERROR, "Unable to mkdir when setting up %s - %s\n", dname,
 420                     nt_errstr(status));
 421                 return false;
 422         }
 423
 424         return true;
 425 }
 426
 427 #define CHECK_STATUS(status, correct) do { \
 428         if (!NT_STATUS_EQUAL(status, correct)) { \
 429                 torture_result(tctx, TORTURE_FAIL, "(%s) Incorrect status %s - should be %s\n", \
 430                        __location__, nt_errstr(status), nt_errstr(correct)); \
 431                 ret = false; \
 432                 goto done; \
 433         }} while (0)
 434
 435 /*
 436  * Helper function to verify a security descriptor, by querying
 437  * and comparing against the passed in sd.
 438  */
 439 bool smb2_util_verify_sd(TALLOC_CTX *tctx, struct smb2_tree *tree,
 440     struct smb2_handle handle, struct security_descriptor *sd)
 441 {
 442         NTSTATUS status;
 443         bool ret = true;
 444         union smb_fileinfo q = {};
 445
 446         q.query_secdesc.level = RAW_FILEINFO_SEC_DESC;
 447         q.query_secdesc.in.file.handle = handle;
 448         q.query_secdesc.in.secinfo_flags =
 449             SECINFO_OWNER |
 450             SECINFO_GROUP |
 451             SECINFO_DACL;
 452         status = smb2_getinfo_file(tree, tctx, &q);
 453         CHECK_STATUS(status, NT_STATUS_OK);
 454
 455         if (!security_acl_equal(
 456             q.query_secdesc.out.sd->dacl, sd->dacl)) {
 457                 torture_warning(tctx, "%s: security descriptors don't match!\n",
 458                     __location__);
 459                 torture_warning(tctx, "got:\n");
 460                 NDR_PRINT_DEBUG(security_descriptor,
 461                     q.query_secdesc.out.sd);
 462                 torture_warning(tctx, "expected:\n");
 463                 NDR_PRINT_DEBUG(security_descriptor, sd);
 464                 ret = false;
 465         }
 466
 467  done:
 468         return ret;
 469 }
 470
 471 /*
 472  * Helper function to verify attributes, by querying
 473  * and comparing against the passed in attrib.
 474  */
 475 bool smb2_util_verify_attrib(TALLOC_CTX *tctx, struct smb2_tree *tree,
 476     struct smb2_handle handle, uint32_t attrib)
 477 {
 478         NTSTATUS status;
 479         bool ret = true;
 480         union smb_fileinfo q = {};
 481
 482         q.standard.level = RAW_FILEINFO_SMB2_ALL_INFORMATION;
 483         q.standard.in.file.handle = handle;
 484         status = smb2_getinfo_file(tree, tctx, &q);
 485         CHECK_STATUS(status, NT_STATUS_OK);
 486
 487         q.all_info2.out.attrib &= ~FILE_ATTRIBUTE_ARCHIVE;
 488
 489         if (q.all_info2.out.attrib != attrib) {
 490                 torture_warning(tctx, "%s: attributes don't match! "
 491                     "got %x, expected %x\n", __location__,
 492                     (uint32_t)q.standard.out.attrib,
 493                     (uint32_t)attrib);
 494                 ret = false;
 495         }
 496
 497  done:
 498         return ret;
 499 }
 500
 501
 502 uint32_t smb2_util_lease_state(const char *ls)
 503 {
 504         uint32_t val = 0;
 505         int i;
 506
 507         for (i = 0; i < strlen(ls); i++) {
 508                 switch (ls[i]) {
 509                 case 'R':
 510                         val |= SMB2_LEASE_READ;
 511                         break;
 512                 case 'H':
 513                         val |= SMB2_LEASE_HANDLE;
 514                         break;
 515                 case 'W':
 516                         val |= SMB2_LEASE_WRITE;
 517                         break;
 518                 }
 519         }
 520
 521         return val;
 522 }
 523