source3/torture/vfstest.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    VFS module tester
   4
   5    Copyright (C) Simo Sorce 2002
   6    Copyright (C) Eric Lorimer 2002
   7    Copyright (C) Jelmer Vernooij 2002,2003
   8
   9    Most of this code was ripped off of rpcclient.
  10    Copyright (C) Tim Potter 2000-2001
  11
  12    This program is free software; you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation; either version 3 of the License, or
  15    (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 #include "includes.h"
  27 #include "smbd/smbd.h"
  28 #include "smbd/globals.h"
  29 #include "popt_common.h"
  30 #include "vfstest.h"
  31 #include "../libcli/smbreadline/smbreadline.h"
  32 #include "auth.h"
  33 #include "serverid.h"
  34 #include "messages.h"
  35 #include "libcli/security/security.h"
  36 #include "lib/smbd_shim.h"
  37 #include "system/filesys.h"
  38
  39 /* List to hold groups of commands */
  40 static struct cmd_list {
  41         struct cmd_list *prev, *next;
  42         struct cmd_set *cmd_set;
  43 } *cmd_list;
  44
  45 /****************************************************************************
  46 handle completion of commands for readline
  47 ****************************************************************************/
  48 static char **completion_fn(const char *text, int start, int end)
  49 {
  50 #define MAX_COMPLETIONS 100
  51         char **matches;
  52         int i, count=0;
  53         struct cmd_list *commands = cmd_list;
  54
  55         if (start)
  56                 return NULL;
  57
  58         /* make sure we have a list of valid commands */
  59         if (!commands)
  60                 return NULL;
  61
  62         matches = SMB_MALLOC_ARRAY(char *, MAX_COMPLETIONS);
  63         if (!matches) return NULL;
  64
  65         matches[count++] = SMB_STRDUP(text);
  66         if (!matches[0]) return NULL;
  67
  68         while (commands && count < MAX_COMPLETIONS-1)
  69         {
  70                 if (!commands->cmd_set)
  71                         break;
  72
  73                 for (i=0; commands->cmd_set[i].name; i++)
  74                 {
  75                         if ((strncmp(text, commands->cmd_set[i].name, strlen(text)) == 0) &&
  76                                 commands->cmd_set[i].fn)
  77                         {
  78                                 matches[count] = SMB_STRDUP(commands->cmd_set[i].name);
  79                                 if (!matches[count])
  80                                         return NULL;
  81                                 count++;
  82                         }
  83                 }
  84
  85                 commands = commands->next;
  86         }
  87
  88         if (count == 2) {
  89                 SAFE_FREE(matches[0]);
  90                 matches[0] = SMB_STRDUP(matches[1]);
  91         }
  92         matches[count] = NULL;
  93         return matches;
  94 }
  95
  96 static char *next_command(TALLOC_CTX *ctx, char **cmdstr)
  97 {
  98         char *command;
  99         char *p;
 100
 101         if (!cmdstr || !(*cmdstr))
 102                 return NULL;
 103
 104         p = strchr_m(*cmdstr, ';');
 105         if (p)
 106                 *p = '\0';
 107         command = talloc_strdup(ctx, *cmdstr);
 108         *cmdstr = p;
 109
 110         return command;
 111 }
 112
 113 /* Load specified configuration file */
 114 static NTSTATUS cmd_conf(struct vfs_state *vfs, TALLOC_CTX *mem_ctx,
 115                         int argc, const char **argv)
 116 {
 117         if (argc != 2) {
 118                 printf("Usage: %s <smb.conf>\n", argv[0]);
 119                 return NT_STATUS_OK;
 120         }
 121
 122         if (!lp_load(argv[1], False, True, False, True)) {
 123                 printf("Error loading \"%s\"\n", argv[1]);
 124                 return NT_STATUS_OK;
 125         }
 126
 127         printf("\"%s\" successfully loaded\n", argv[1]);
 128         return NT_STATUS_OK;
 129 }
 130
 131 /* Display help on commands */
 132 static NTSTATUS cmd_help(struct vfs_state *vfs, TALLOC_CTX *mem_ctx,
 133                          int argc, const char **argv)
 134 {
 135         struct cmd_list *tmp;
 136         struct cmd_set *tmp_set;
 137
 138         /* Usage */
 139         if (argc > 2) {
 140                 printf("Usage: %s [command]\n", argv[0]);
 141                 return NT_STATUS_OK;
 142         }
 143
 144         /* Help on one command */
 145
 146         if (argc == 2) {
 147                 for (tmp = cmd_list; tmp; tmp = tmp->next) {
 148
 149                         tmp_set = tmp->cmd_set;
 150
 151                         while(tmp_set->name) {
 152                                 if (strequal(argv[1], tmp_set->name)) {
 153                                         if (tmp_set->usage &&
 154                                             tmp_set->usage[0])
 155                                                 printf("%s\n", tmp_set->usage);
 156                                         else
 157                                                 printf("No help for %s\n", tmp_set->name);
 158
 159                                         return NT_STATUS_OK;
 160                                 }
 161
 162                                 tmp_set++;
 163                         }
 164                 }
 165
 166                 printf("No such command: %s\n", argv[1]);
 167                 return NT_STATUS_OK;
 168         }
 169
 170         /* List all commands */
 171
 172         for (tmp = cmd_list; tmp; tmp = tmp->next) {
 173
 174                 tmp_set = tmp->cmd_set;
 175
 176                 while(tmp_set->name) {
 177
 178                         printf("%15s\t\t%s\n", tmp_set->name,
 179                                tmp_set->description ? tmp_set->description:
 180                                "");
 181
 182                         tmp_set++;
 183                 }
 184         }
 185
 186         return NT_STATUS_OK;
 187 }
 188
 189 /* Change the debug level */
 190 static NTSTATUS cmd_debuglevel(struct vfs_state *vfs, TALLOC_CTX *mem_ctx, int argc, const char **argv)
 191 {
 192         if (argc > 2) {
 193                 printf("Usage: %s [debuglevel]\n", argv[0]);
 194                 return NT_STATUS_OK;
 195         }
 196
 197         if (argc == 2) {
 198                 lp_set_cmdline("log level", argv[1]);
 199         }
 200
 201         printf("debuglevel is %d\n", DEBUGLEVEL);
 202
 203         return NT_STATUS_OK;
 204 }
 205
 206 static NTSTATUS cmd_freemem(struct vfs_state *vfs, TALLOC_CTX *mem_ctx, int argc, const char **argv)
 207 {
 208         /* Cleanup */
 209         talloc_destroy(mem_ctx);
 210         mem_ctx = NULL;
 211         vfs->data = NULL;
 212         vfs->data_size = 0;
 213         return NT_STATUS_OK;
 214 }
 215
 216 static NTSTATUS cmd_quit(struct vfs_state *vfs, TALLOC_CTX *mem_ctx, int argc, const char **argv)
 217 {
 218         /* Cleanup */
 219         talloc_destroy(mem_ctx);
 220
 221         exit(0);
 222         return NT_STATUS_OK; /* NOTREACHED */
 223 }
 224
 225 static struct cmd_set vfstest_commands[] = {
 226
 227         { "GENERAL OPTIONS" },
 228
 229         { "conf",       cmd_conf,       "Load smb configuration file", "conf <smb.conf>" },
 230         { "help",       cmd_help,       "Get help on commands", "" },
 231         { "?",          cmd_help,       "Get help on commands", "" },
 232         { "debuglevel", cmd_debuglevel, "Set debug level", "" },
 233         { "freemem",    cmd_freemem,    "Free currently allocated buffers", "" },
 234         { "exit",       cmd_quit,       "Exit program", "" },
 235         { "quit",       cmd_quit,       "Exit program", "" },
 236
 237         { NULL }
 238 };
 239
 240 static struct cmd_set separator_command[] = {
 241         { "---------------", NULL,      "----------------------" },
 242         { NULL }
 243 };
 244
 245
 246 extern struct cmd_set vfs_commands[];
 247 static struct cmd_set *vfstest_command_list[] = {
 248         vfstest_commands,
 249         vfs_commands,
 250         NULL
 251 };
 252
 253 static void add_command_set(struct cmd_set *cmd_set)
 254 {
 255         struct cmd_list *entry;
 256
 257         if (!(entry = SMB_MALLOC_P(struct cmd_list))) {
 258                 DEBUG(0, ("out of memory\n"));
 259                 return;
 260         }
 261
 262         ZERO_STRUCTP(entry);
 263
 264         entry->cmd_set = cmd_set;
 265         DLIST_ADD(cmd_list, entry);
 266 }
 267
 268 static NTSTATUS do_cmd(struct vfs_state *vfs, struct cmd_set *cmd_entry, char *cmd)
 269 {
 270         const char *p = cmd;
 271         char **argv = NULL;
 272         NTSTATUS result = NT_STATUS_UNSUCCESSFUL;
 273         char *buf;
 274         TALLOC_CTX *mem_ctx = talloc_stackframe();
 275         int argc = 0, i;
 276
 277         /* Count number of arguments first time through the loop then
 278            allocate memory and strdup them. */
 279
 280  again:
 281         while(next_token_talloc(mem_ctx, &p, &buf, " ")) {
 282                 if (argv) {
 283                         argv[argc] = SMB_STRDUP(buf);
 284                 }
 285                 argc++;
 286         }
 287
 288         if (!argv) {
 289                 /* Create argument list */
 290
 291                 argv = SMB_MALLOC_ARRAY(char *, argc);
 292                 memset(argv, 0, sizeof(char *) * argc);
 293
 294                 if (!argv) {
 295                         fprintf(stderr, "out of memory\n");
 296                         result = NT_STATUS_NO_MEMORY;
 297                         goto done;
 298                 }
 299
 300                 p = cmd;
 301                 argc = 0;
 302
 303                 goto again;
 304         }
 305
 306         /* Call the function */
 307
 308         if (cmd_entry->fn) {
 309                 /* Run command */
 310                 result = cmd_entry->fn(vfs, mem_ctx, argc, (const char **)argv);
 311         } else {
 312                 fprintf (stderr, "Invalid command\n");
 313                 goto done;
 314         }
 315
 316  done:
 317
 318         /* Cleanup */
 319
 320         if (argv) {
 321                 for (i = 0; i < argc; i++)
 322                         SAFE_FREE(argv[i]);
 323
 324                 SAFE_FREE(argv);
 325         }
 326
 327         TALLOC_FREE(mem_ctx);
 328         return result;
 329 }
 330
 331 /* Process a command entered at the prompt or as part of -c */
 332 static NTSTATUS process_cmd(struct vfs_state *vfs, char *cmd)
 333 {
 334         struct cmd_list *temp_list;
 335         bool found = False;
 336         char *buf;
 337         const char *p = cmd;
 338         NTSTATUS result = NT_STATUS_OK;
 339         TALLOC_CTX *mem_ctx = talloc_stackframe();
 340         int len = 0;
 341
 342         if (cmd[strlen(cmd) - 1] == '\n')
 343                 cmd[strlen(cmd) - 1] = '\0';
 344
 345         if (!next_token_talloc(mem_ctx, &p, &buf, " ")) {
 346                 TALLOC_FREE(mem_ctx);
 347                 return NT_STATUS_OK;
 348         }
 349
 350         /* Strip the trailing \n if it exists */
 351         len = strlen(buf);
 352         if (buf[len-1] == '\n')
 353                 buf[len-1] = '\0';
 354
 355         /* Search for matching commands */
 356
 357         for (temp_list = cmd_list; temp_list; temp_list = temp_list->next) {
 358                 struct cmd_set *temp_set = temp_list->cmd_set;
 359
 360                 while(temp_set->name) {
 361                         if (strequal(buf, temp_set->name)) {
 362                                 found = True;
 363                                 result = do_cmd(vfs, temp_set, cmd);
 364
 365                                 goto done;
 366                         }
 367                         temp_set++;
 368                 }
 369         }
 370
 371  done:
 372         if (!found && buf[0]) {
 373                 printf("command not found: %s\n", buf);
 374                 TALLOC_FREE(mem_ctx);
 375                 return NT_STATUS_OK;
 376         }
 377
 378         if (!NT_STATUS_IS_OK(result)) {
 379                 printf("result was %s\n", nt_errstr(result));
 380         }
 381
 382         TALLOC_FREE(mem_ctx);
 383         return result;
 384 }
 385
 386 static void process_file(struct vfs_state *pvfs, char *filename) {
 387         FILE *file;
 388         char command[3 * PATH_MAX];
 389
 390         if (*filename == '-') {
 391                 file = stdin;
 392         } else {
 393                 file = fopen(filename, "r");
 394                 if (file == NULL) {
 395                         printf("vfstest: error reading file (%s)!", filename);
 396                         printf("errno n.%d: %s", errno, strerror(errno));
 397                         exit(-1);
 398                 }
 399         }
 400
 401         while (fgets(command, 3 * PATH_MAX, file) != NULL) {
 402                 process_cmd(pvfs, command);
 403         }
 404
 405         if (file != stdin) {
 406                 fclose(file);
 407         }
 408 }
 409
 410 static void vfstest_exit_server(const char * const reason)
 411 {
 412         DEBUG(3,("Server exit (%s)\n", (reason ? reason : "")));
 413         exit(0);
 414 }
 415
 416 static void vfstest_exit_server_cleanly(const char * const reason)
 417 {
 418         vfstest_exit_server("normal exit");
 419 }
 420
 421 struct smb_request *vfstest_get_smbreq(TALLOC_CTX *mem_ctx,
 422                                        struct vfs_state *vfs)
 423 {
 424         struct smb_request *result;
 425
 426         result = talloc_zero(mem_ctx, struct smb_request);
 427         if (result == NULL) {
 428                 return NULL;
 429         }
 430         result->sconn = vfs->conn->sconn;
 431         result->mid = ++vfs->mid;
 432
 433         result->inbuf = talloc_array(result, uint8_t, smb_size);
 434         if (result->inbuf == NULL) {
 435                 goto fail;
 436         }
 437         SSVAL(result->inbuf, smb_mid, result->mid);
 438         smb_setlen(result->inbuf, smb_size-4);
 439         return result;
 440 fail:
 441         TALLOC_FREE(result);
 442         return NULL;
 443 }
 444
 445 /* Main function */
 446
 447 int main(int argc, char *argv[])
 448 {
 449         char *cmdstr = NULL;
 450         struct cmd_set  **cmd_set;
 451         struct vfs_state *vfs;
 452         int i;
 453         char *filename = NULL;
 454         char cwd[MAXPATHLEN];
 455         TALLOC_CTX *frame = talloc_stackframe();
 456         struct tevent_context *ev = tevent_context_init(NULL);
 457         struct auth_session_info *session_info = NULL;
 458         NTSTATUS status = NT_STATUS_OK;
 459
 460         /* make sure the vars that get altered (4th field) are in
 461            a fixed location or certain compilers complain */
 462         poptContext pc;
 463         struct poptOption long_options[] = {
 464                 POPT_AUTOHELP
 465                 {"file",        'f', POPT_ARG_STRING,   &filename, 0, },
 466                 {"command",     'c', POPT_ARG_STRING,   &cmdstr, 0, "Execute specified list of commands" },
 467                 POPT_COMMON_SAMBA
 468                 POPT_TABLEEND
 469         };
 470         static const struct smbd_shim vfstest_shim_fns =
 471         {
 472                 .exit_server = vfstest_exit_server,
 473                 .exit_server_cleanly = vfstest_exit_server_cleanly,
 474         };
 475
 476         load_case_tables();
 477
 478         setlinebuf(stdout);
 479
 480         pc = poptGetContext("vfstest", argc, (const char **) argv,
 481                             long_options, 0);
 482
 483         while(poptGetNextOpt(pc) != -1);
 484
 485
 486         poptFreeContext(pc);
 487
 488         /* we want total control over the permissions on created files,
 489            so set our umask to 0 */
 490         umask(0);
 491
 492         lp_load_initial_only(get_dyn_CONFIGFILE());
 493
 494         /* TODO: check output */
 495         reload_services(NULL, NULL, false);
 496
 497         /* the following functions are part of the Samba debugging
 498            facilities.  See lib/debug.c */
 499         setup_logging("vfstest", DEBUG_STDOUT);
 500
 501         set_smbd_shim(&vfstest_shim_fns);
 502
 503         /* Load command lists */
 504
 505         cmd_set = vfstest_command_list;
 506
 507         while(*cmd_set) {
 508                 add_command_set(*cmd_set);
 509                 add_command_set(separator_command);
 510                 cmd_set++;
 511         }
 512
 513         /* some basic initialization stuff */
 514         sec_init();
 515         init_guest_info();
 516         locking_init();
 517         serverid_parent_init(NULL);
 518         vfs = talloc_zero(NULL, struct vfs_state);
 519         if (vfs == NULL) {
 520                 return 1;
 521         }
 522         status = make_session_info_guest(vfs, &session_info);
 523         if (!NT_STATUS_IS_OK(status)) {
 524                 return 1;
 525         }
 526
 527         status = create_conn_struct(vfs,
 528                                 ev,
 529                                 messaging_init(vfs, ev),
 530                                 &vfs->conn,
 531                                 -1,
 532                                 getcwd(cwd, sizeof(cwd)),
 533                                 session_info);
 534         if (!NT_STATUS_IS_OK(status)) {
 535                 return 1;
 536         }
 537
 538         vfs->conn->share_access = FILE_GENERIC_ALL;
 539         vfs->conn->read_only = false;
 540
 541         serverid_register(messaging_server_id(vfs->conn->sconn->msg_ctx), 0);
 542         file_init(vfs->conn->sconn);
 543         for (i=0; i < 1024; i++)
 544                 vfs->files[i] = NULL;
 545
 546         if (!posix_locking_init(false)) {
 547                 return 1;
 548         }
 549
 550         /* Do we have a file input? */
 551         if (filename && filename[0]) {
 552                 process_file(vfs, filename);
 553                 return 0;
 554         }
 555
 556         /* Do anything specified with -c */
 557         if (cmdstr && cmdstr[0]) {
 558                 char    *cmd;
 559                 char    *p = cmdstr;
 560
 561                 while((cmd=next_command(frame, &p)) != NULL) {
 562                         status = process_cmd(vfs, cmd);
 563                 }
 564
 565                 TALLOC_FREE(cmd);
 566                 return NT_STATUS_IS_OK(status) ? 0 : 1;
 567         }
 568
 569         /* Loop around accepting commands */
 570
 571         while(1) {
 572                 char *line = NULL;
 573
 574                 line = smb_readline("vfstest $> ", NULL, completion_fn);
 575
 576                 if (line == NULL) {
 577                         break;
 578                 }
 579
 580                 if (line[0] != '\n') {
 581                         status = process_cmd(vfs, line);
 582                 }
 583                 SAFE_FREE(line);
 584         }
 585
 586         TALLOC_FREE(vfs);
 587         TALLOC_FREE(frame);
 588         return NT_STATUS_IS_OK(status) ? 0 : 1;
 589 }