cmdline.c

   1 /*
   2  * cmdline.c - command-line parsing shared between many of the
   3  * PuTTY applications
   4  */
   5
   6 #include <stdio.h>
   7 #include <assert.h>
   8 #include <stdlib.h>
   9 #include "putty.h"
  10
  11 /*
  12  * Some command-line parameters need to be saved up until after
  13  * we've loaded the saved session which will form the basis of our
  14  * eventual running configuration. For this we use the macro
  15  * SAVEABLE, which notices if the `need_save' parameter is set and
  16  * saves the parameter and value on a list.
  17  *
  18  * We also assign priorities to saved parameters, just to slightly
  19  * ameliorate silly ordering problems. For example, if you specify
  20  * a saved session to load, it will be loaded _before_ all your
  21  * local modifications such as -L are evaluated; and if you specify
  22  * a protocol and a port, the protocol is set up first so that the
  23  * port can override its choice of port number.
  24  *
  25  * (In fact -load is not saved at all, since in at least Plink the
  26  * processing of further command-line options depends on whether or
  27  * not the loaded session contained a hostname. So it must be
  28  * executed immediately.)
  29  */
  30
  31 #define NPRIORITIES 2
  32
  33 struct cmdline_saved_param {
  34     char *p, *value;
  35 };
  36 struct cmdline_saved_param_set {
  37     struct cmdline_saved_param *params;
  38     int nsaved, savesize;
  39 };
  40
  41 /*
  42  * C guarantees this structure will be initialised to all zero at
  43  * program start, which is exactly what we want.
  44  */
  45 static struct cmdline_saved_param_set saves[NPRIORITIES];
  46
  47 static void cmdline_save_param(char *p, char *value, int pri)
  48 {
  49     if (saves[pri].nsaved >= saves[pri].savesize) {
  50         saves[pri].savesize = saves[pri].nsaved + 32;
  51         saves[pri].params = sresize(saves[pri].params, saves[pri].savesize,
  52                                     struct cmdline_saved_param);
  53     }
  54     saves[pri].params[saves[pri].nsaved].p = p;
  55     saves[pri].params[saves[pri].nsaved].value = value;
  56     saves[pri].nsaved++;
  57 }
  58
  59 void cmdline_cleanup(void)
  60 {
  61     int pri;
  62
  63     for (pri = 0; pri < NPRIORITIES; pri++)
  64         sfree(saves[pri].params);
  65 }
  66
  67 #define SAVEABLE(pri) do { \
  68     if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
  69 } while (0)
  70
  71 static char *cmdline_password = NULL;
  72
  73 /*
  74  * Similar interface to get_userpass_input(), except that here a -1
  75  * return means that we aren't capable of processing the prompt and
  76  * someone else should do it.
  77  */
  78 int cmdline_get_passwd_input(prompts_t *p, unsigned char *in, int inlen) {
  79
  80     static int tried_once = 0;
  81
  82     /*
  83      * We only handle prompts which don't echo (which we assume to be
  84      * passwords), and (currently) we only cope with a password prompt
  85      * that comes in a prompt-set on its own.
  86      */
  87     if (!cmdline_password || in || p->n_prompts != 1 || p->prompts[0]->echo) {
  88         return -1;
  89     }
  90
  91     /*
  92      * If we've tried once, return utter failure (no more passwords left
  93      * to try).
  94      */
  95     if (tried_once)
  96         return 0;
  97
  98     strncpy(p->prompts[0]->result, cmdline_password,
  99             p->prompts[0]->result_len);
 100     p->prompts[0]->result[p->prompts[0]->result_len-1] = '\0';
 101     memset(cmdline_password, 0, strlen(cmdline_password));
 102     tried_once = 1;
 103     return 1;
 104
 105 }
 106
 107 /*
 108  * Here we have a flags word which describes the capabilities of
 109  * the particular tool on whose behalf we're running. We will
 110  * refuse certain command-line options if a particular tool
 111  * inherently can't do anything sensible. For example, the file
 112  * transfer tools (psftp, pscp) can't do a great deal with protocol
 113  * selections (ever tried running scp over telnet?) or with port
 114  * forwarding (even if it wasn't a hideously bad idea, they don't
 115  * have the select() infrastructure to make them work).
 116  */
 117 int cmdline_tooltype = 0;
 118
 119 static int cmdline_check_unavailable(int flag, char *p)
 120 {
 121     if (cmdline_tooltype & flag) {
 122         cmdline_error("option \"%s\" not available in this tool", p);
 123         return 1;
 124     }
 125     return 0;
 126 }
 127
 128 #define UNAVAILABLE_IN(flag) do { \
 129     if (cmdline_check_unavailable(flag, p)) return ret; \
 130 } while (0)
 131
 132 /*
 133  * Process a standard command-line parameter. `p' is the parameter
 134  * in question; `value' is the subsequent element of argv, which
 135  * may or may not be required as an operand to the parameter.
 136  * If `need_save' is 1, arguments which need to be saved as
 137  * described at this top of this file are, for later execution;
 138  * if 0, they are processed normally. (-1 is a special value used
 139  * by pterm to count arguments for a preliminary pass through the
 140  * argument list; it causes immediate return with an appropriate
 141  * value with no action taken.)
 142  * Return value is 2 if both arguments were used; 1 if only p was
 143  * used; 0 if the parameter wasn't one we recognised; -2 if it
 144  * should have been 2 but value was NULL.
 145  */
 146
 147 #define RETURN(x) do { \
 148     if ((x) == 2 && !value) return -2; \
 149     ret = x; \
 150     if (need_save < 0) return x; \
 151 } while (0)
 152
 153 int cmdline_process_param(char *p, char *value, int need_save, Config *cfg)
 154 {
 155     int ret = 0;
 156
 157     if (!strcmp(p, "-load")) {
 158         RETURN(2);
 159         /* This parameter must be processed immediately rather than being
 160          * saved. */
 161         do_defaults(value, cfg);
 162         loaded_session = TRUE;
 163         return 2;
 164     }
 165     if (!strcmp(p, "-ssh")) {
 166         RETURN(1);
 167         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 168         SAVEABLE(0);
 169         default_protocol = cfg->protocol = PROT_SSH;
 170         default_port = cfg->port = 22;
 171         return 1;
 172     }
 173     if (!strcmp(p, "-telnet")) {
 174         RETURN(1);
 175         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 176         SAVEABLE(0);
 177         default_protocol = cfg->protocol = PROT_TELNET;
 178         default_port = cfg->port = 23;
 179         return 1;
 180     }
 181     if (!strcmp(p, "-rlogin")) {
 182         RETURN(1);
 183         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 184         SAVEABLE(0);
 185         default_protocol = cfg->protocol = PROT_RLOGIN;
 186         default_port = cfg->port = 513;
 187         return 1;
 188     }
 189     if (!strcmp(p, "-raw")) {
 190         RETURN(1);
 191         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 192         SAVEABLE(0);
 193         default_protocol = cfg->protocol = PROT_RAW;
 194     }
 195     if (!strcmp(p, "-serial")) {
 196         RETURN(1);
 197         /* Serial is not NONNETWORK in an odd sense of the word */
 198         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 199         SAVEABLE(0);
 200         default_protocol = cfg->protocol = PROT_SERIAL;
 201         /* The host parameter will already be loaded into cfg->host, so copy it across */
 202         strncpy(cfg->serline, cfg->host, sizeof(cfg->serline) - 1);
 203         cfg->serline[sizeof(cfg->serline) - 1] = '\0';
 204     }
 205     if (!strcmp(p, "-v")) {
 206         RETURN(1);
 207         flags |= FLAG_VERBOSE;
 208     }
 209     if (!strcmp(p, "-l")) {
 210         RETURN(2);
 211         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 212         SAVEABLE(0);
 213         strncpy(cfg->username, value, sizeof(cfg->username));
 214         cfg->username[sizeof(cfg->username) - 1] = '\0';
 215     }
 216     if (!strcmp(p, "-loghost")) {
 217         RETURN(2);
 218         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 219         SAVEABLE(0);
 220         strncpy(cfg->loghost, value, sizeof(cfg->loghost));
 221         cfg->loghost[sizeof(cfg->loghost) - 1] = '\0';
 222     }
 223     if ((!strcmp(p, "-L") || !strcmp(p, "-R") || !strcmp(p, "-D"))) {
 224         char *fwd, *ptr, *q, *qq;
 225         int dynamic, i=0;
 226         RETURN(2);
 227         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 228         SAVEABLE(0);
 229         dynamic = !strcmp(p, "-D");
 230         fwd = value;
 231         ptr = cfg->portfwd;
 232         /* if existing forwards, find end of list */
 233         while (*ptr) {
 234             while (*ptr)
 235                 ptr++;
 236             ptr++;
 237         }
 238         i = ptr - cfg->portfwd;
 239         ptr[0] = p[1];  /* insert a 'L', 'R' or 'D' at the start */
 240         ptr++;
 241         if (1 + strlen(fwd) + 2 > sizeof(cfg->portfwd) - i) {
 242             cmdline_error("out of space for port forwardings");
 243             return ret;
 244         }
 245         strncpy(ptr, fwd, sizeof(cfg->portfwd) - i - 2);
 246         if (!dynamic) {
 247             /*
 248              * We expect _at least_ two colons in this string. The
 249              * possible formats are `sourceport:desthost:destport',
 250              * or `sourceip:sourceport:desthost:destport' if you're
 251              * specifying a particular loopback address. We need to
 252              * replace the one between source and dest with a \t;
 253              * this means we must find the second-to-last colon in
 254              * the string.
 255              */
 256             q = qq = strchr(ptr, ':');
 257             while (qq) {
 258                 char *qqq = strchr(qq+1, ':');
 259                 if (qqq)
 260                     q = qq;
 261                 qq = qqq;
 262             }
 263             if (q) *q = '\t';          /* replace second-last colon with \t */
 264         }
 265         cfg->portfwd[sizeof(cfg->portfwd) - 1] = '\0';
 266         cfg->portfwd[sizeof(cfg->portfwd) - 2] = '\0';
 267         ptr[strlen(ptr)+1] = '\000';    /* append 2nd '\000' */
 268     }
 269     if ((!strcmp(p, "-nc"))) {
 270         char *host, *portp;
 271
 272         RETURN(2);
 273         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 274         SAVEABLE(0);
 275
 276         host = portp = value;
 277         while (*portp && *portp != ':')
 278             portp++;
 279         if (*portp) {
 280             unsigned len = portp - host;
 281             if (len >= sizeof(cfg->ssh_nc_host))
 282                 len = sizeof(cfg->ssh_nc_host) - 1;
 283             memcpy(cfg->ssh_nc_host, value, len);
 284             cfg->ssh_nc_host[len] = '\0';
 285             cfg->ssh_nc_port = atoi(portp+1);
 286         } else {
 287             cmdline_error("-nc expects argument of form 'host:port'");
 288             return ret;
 289         }
 290     }
 291     if (!strcmp(p, "-m")) {
 292         char *filename, *command;
 293         int cmdlen, cmdsize;
 294         FILE *fp;
 295         int c, d;
 296
 297         RETURN(2);
 298         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 299         SAVEABLE(0);
 300
 301         filename = value;
 302
 303         cmdlen = cmdsize = 0;
 304         command = NULL;
 305         fp = fopen(filename, "r");
 306         if (!fp) {
 307             cmdline_error("unable to open command "
 308                           "file \"%s\"", filename);
 309             return ret;
 310         }
 311         do {
 312             c = fgetc(fp);
 313             d = c;
 314             if (c == EOF)
 315                 d = 0;
 316             if (cmdlen >= cmdsize) {
 317                 cmdsize = cmdlen + 512;
 318                 command = sresize(command, cmdsize, char);
 319             }
 320             command[cmdlen++] = d;
 321         } while (c != EOF);
 322         cfg->remote_cmd_ptr = command;
 323         cfg->remote_cmd_ptr2 = NULL;
 324         cfg->nopty = TRUE;      /* command => no terminal */
 325     }
 326     if (!strcmp(p, "-P")) {
 327         RETURN(2);
 328         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 329         SAVEABLE(1);                   /* lower priority than -ssh,-telnet */
 330         cfg->port = atoi(value);
 331     }
 332     if (!strcmp(p, "-pw")) {
 333         RETURN(2);
 334         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 335         SAVEABLE(1);
 336         /* We delay evaluating this until after the protocol is decided,
 337          * so that we can warn if it's of no use with the selected protocol */
 338         if (cfg->protocol != PROT_SSH)
 339             cmdline_error("the -pw option can only be used with the "
 340                           "SSH protocol");
 341         else {
 342             cmdline_password = dupstr(value);
 343             /* Assuming that `value' is directly from argv, make a good faith
 344              * attempt to trample it, to stop it showing up in `ps' output
 345              * on Unix-like systems. Not guaranteed, of course. */
 346             memset(value, 0, strlen(value));
 347         }
 348     }
 349
 350     if (!strcmp(p, "-agent") || !strcmp(p, "-pagent") ||
 351         !strcmp(p, "-pageant")) {
 352         RETURN(1);
 353         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 354         SAVEABLE(0);
 355         cfg->tryagent = TRUE;
 356     }
 357     if (!strcmp(p, "-noagent") || !strcmp(p, "-nopagent") ||
 358         !strcmp(p, "-nopageant")) {
 359         RETURN(1);
 360         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 361         SAVEABLE(0);
 362         cfg->tryagent = FALSE;
 363     }
 364
 365     if (!strcmp(p, "-A")) {
 366         RETURN(1);
 367         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 368         SAVEABLE(0);
 369         cfg->agentfwd = 1;
 370     }
 371     if (!strcmp(p, "-a")) {
 372         RETURN(1);
 373         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 374         SAVEABLE(0);
 375         cfg->agentfwd = 0;
 376     }
 377
 378     if (!strcmp(p, "-X")) {
 379         RETURN(1);
 380         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 381         SAVEABLE(0);
 382         cfg->x11_forward = 1;
 383     }
 384     if (!strcmp(p, "-x")) {
 385         RETURN(1);
 386         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 387         SAVEABLE(0);
 388         cfg->x11_forward = 0;
 389     }
 390
 391     if (!strcmp(p, "-t")) {
 392         RETURN(1);
 393         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 394         SAVEABLE(1);    /* lower priority than -m */
 395         cfg->nopty = 0;
 396     }
 397     if (!strcmp(p, "-T")) {
 398         RETURN(1);
 399         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 400         SAVEABLE(1);
 401         cfg->nopty = 1;
 402     }
 403
 404     if (!strcmp(p, "-N")) {
 405         RETURN(1);
 406         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 407         SAVEABLE(0);
 408         cfg->ssh_no_shell = 1;
 409     }
 410
 411     if (!strcmp(p, "-C")) {
 412         RETURN(1);
 413         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 414         SAVEABLE(0);
 415         cfg->compression = 1;
 416     }
 417
 418     if (!strcmp(p, "-1")) {
 419         RETURN(1);
 420         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 421         SAVEABLE(0);
 422         cfg->sshprot = 0;              /* ssh protocol 1 only */
 423     }
 424     if (!strcmp(p, "-2")) {
 425         RETURN(1);
 426         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 427         SAVEABLE(0);
 428         cfg->sshprot = 3;              /* ssh protocol 2 only */
 429     }
 430
 431     if (!strcmp(p, "-i")) {
 432         RETURN(2);
 433         UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
 434         SAVEABLE(0);
 435         cfg->keyfile = filename_from_str(value);
 436     }
 437
 438     if (!strcmp(p, "-4") || !strcmp(p, "-ipv4")) {
 439         RETURN(1);
 440         SAVEABLE(1);
 441         cfg->addressfamily = ADDRTYPE_IPV4;
 442     }
 443     if (!strcmp(p, "-6") || !strcmp(p, "-ipv6")) {
 444         RETURN(1);
 445         SAVEABLE(1);
 446         cfg->addressfamily = ADDRTYPE_IPV6;
 447     }
 448     if (!strcmp(p, "-sercfg")) {
 449         char* nextitem;
 450         RETURN(2);
 451         UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
 452         SAVEABLE(1);
 453         if (cfg->protocol != PROT_SERIAL)
 454             cmdline_error("the -sercfg option can only be used with the "
 455                           "serial protocol");
 456         /* Value[0] contains one or more , separated values, like 19200,8,n,1,X */
 457         nextitem = value;
 458         while (nextitem[0] != '\0') {
 459             int length, skip;
 460             char *end = strchr(nextitem, ',');
 461             if (!end) {
 462                 length = strlen(nextitem);
 463                 skip = 0;
 464             } else {
 465                 length = end - nextitem;
 466                 nextitem[length] = '\0';
 467                 skip = 1;
 468             }
 469             if (length == 1) {
 470                 switch (*nextitem) {
 471                   case '1':
 472                     cfg->serstopbits = 2;
 473                     break;
 474                   case '2':
 475                     cfg->serstopbits = 4;
 476                     break;
 477
 478                   case '5':
 479                     cfg->serdatabits = 5;
 480                     break;
 481                   case '6':
 482                     cfg->serdatabits = 6;
 483                     break;
 484                   case '7':
 485                     cfg->serdatabits = 7;
 486                     break;
 487                   case '8':
 488                     cfg->serdatabits = 8;
 489                     break;
 490                   case '9':
 491                     cfg->serdatabits = 9;
 492                     break;
 493
 494                   case 'n':
 495                     cfg->serparity = SER_PAR_NONE;
 496                     break;
 497                   case 'o':
 498                     cfg->serparity = SER_PAR_ODD;
 499                     break;
 500                   case 'e':
 501                     cfg->serparity = SER_PAR_EVEN;
 502                     break;
 503                   case 'm':
 504                     cfg->serparity = SER_PAR_MARK;
 505                     break;
 506                   case 's':
 507                     cfg->serparity = SER_PAR_SPACE;
 508                     break;
 509
 510                   case 'N':
 511                     cfg->serflow = SER_FLOW_NONE;
 512                     break;
 513                   case 'X':
 514                     cfg->serflow = SER_FLOW_XONXOFF;
 515                     break;
 516                   case 'R':
 517                     cfg->serflow = SER_FLOW_RTSCTS;
 518                     break;
 519                   case 'D':
 520                     cfg->serflow = SER_FLOW_DSRDTR;
 521                     break;
 522
 523                   default:
 524                     cmdline_error("Unrecognised suboption \"-sercfg %c\"",
 525                                   *nextitem);
 526                 }
 527             } else if (length == 3 && !strncmp(nextitem,"1.5",3)) {
 528                 /* Messy special case */
 529                 cfg->serstopbits = 3;
 530             } else {
 531                 int serspeed = atoi(nextitem);
 532                 if (serspeed != 0) {
 533                     cfg->serspeed = serspeed;
 534                 } else {
 535                     cmdline_error("Unrecognised suboption \"-sercfg %s\"",
 536                                   nextitem);
 537                 }
 538             }
 539             nextitem += length + skip;
 540         }
 541     }
 542     return ret;                        /* unrecognised */
 543 }
 544
 545 void cmdline_run_saved(Config *cfg)
 546 {
 547     int pri, i;
 548     for (pri = 0; pri < NPRIORITIES; pri++)
 549         for (i = 0; i < saves[pri].nsaved; i++)
 550             cmdline_process_param(saves[pri].params[i].p,
 551                                   saves[pri].params[i].value, 0, cfg);
 552 }