2 * cmdline.c - command-line parsing shared between many of the
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.
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.
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.)
33 struct cmdline_saved_param {
36 struct cmdline_saved_param_set {
37 struct cmdline_saved_param *params;
42 * C guarantees this structure will be initialised to all zero at
43 * program start, which is exactly what we want.
45 static struct cmdline_saved_param_set saves[NPRIORITIES];
47 static void cmdline_save_param(char *p, char *value, int pri)
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);
54 saves[pri].params[saves[pri].nsaved].p = p;
55 saves[pri].params[saves[pri].nsaved].value = value;
59 static char *cmdline_password = NULL;
61 void cmdline_cleanup(void)
65 if (cmdline_password) {
66 smemclr(cmdline_password, strlen(cmdline_password));
67 sfree(cmdline_password);
68 cmdline_password = NULL;
71 for (pri = 0; pri < NPRIORITIES; pri++) {
72 sfree(saves[pri].params);
73 saves[pri].params = NULL;
74 saves[pri].savesize = 0;
75 saves[pri].nsaved = 0;
79 #define SAVEABLE(pri) do { \
80 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
84 * Similar interface to get_userpass_input(), except that here a -1
85 * return means that we aren't capable of processing the prompt and
86 * someone else should do it.
88 int cmdline_get_passwd_input(prompts_t *p, unsigned char *in, int inlen) {
90 static int tried_once = 0;
93 * We only handle prompts which don't echo (which we assume to be
94 * passwords), and (currently) we only cope with a password prompt
95 * that comes in a prompt-set on its own.
97 if (!cmdline_password || in || p->n_prompts != 1 || p->prompts[0]->echo) {
102 * If we've tried once, return utter failure (no more passwords left
108 prompt_set_result(p->prompts[0], cmdline_password);
109 smemclr(cmdline_password, strlen(cmdline_password));
110 sfree(cmdline_password);
111 cmdline_password = NULL;
117 * Here we have a flags word which describes the capabilities of
118 * the particular tool on whose behalf we're running. We will
119 * refuse certain command-line options if a particular tool
120 * inherently can't do anything sensible. For example, the file
121 * transfer tools (psftp, pscp) can't do a great deal with protocol
122 * selections (ever tried running scp over telnet?) or with port
123 * forwarding (even if it wasn't a hideously bad idea, they don't
124 * have the select() infrastructure to make them work).
126 int cmdline_tooltype = 0;
128 static int cmdline_check_unavailable(int flag, char *p)
130 if (cmdline_tooltype & flag) {
131 cmdline_error("option \"%s\" not available in this tool", p);
137 #define UNAVAILABLE_IN(flag) do { \
138 if (cmdline_check_unavailable(flag, p)) return ret; \
142 * Process a standard command-line parameter. `p' is the parameter
143 * in question; `value' is the subsequent element of argv, which
144 * may or may not be required as an operand to the parameter.
145 * If `need_save' is 1, arguments which need to be saved as
146 * described at this top of this file are, for later execution;
147 * if 0, they are processed normally. (-1 is a special value used
148 * by pterm to count arguments for a preliminary pass through the
149 * argument list; it causes immediate return with an appropriate
150 * value with no action taken.)
151 * Return value is 2 if both arguments were used; 1 if only p was
152 * used; 0 if the parameter wasn't one we recognised; -2 if it
153 * should have been 2 but value was NULL.
156 #define RETURN(x) do { \
157 if ((x) == 2 && !value) return -2; \
159 if (need_save < 0) return x; \
162 int cmdline_process_param(char *p, char *value, int need_save, Conf *conf)
166 if (!strcmp(p, "-load")) {
168 /* This parameter must be processed immediately rather than being
170 do_defaults(value, conf);
171 loaded_session = TRUE;
172 cmdline_session_name = dupstr(value);
175 if (!strcmp(p, "-ssh")) {
177 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
179 default_protocol = PROT_SSH;
181 conf_set_int(conf, CONF_protocol, default_protocol);
182 conf_set_int(conf, CONF_port, default_port);
185 if (!strcmp(p, "-telnet")) {
187 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
189 default_protocol = PROT_TELNET;
191 conf_set_int(conf, CONF_protocol, default_protocol);
192 conf_set_int(conf, CONF_port, default_port);
195 if (!strcmp(p, "-rlogin")) {
197 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
199 default_protocol = PROT_RLOGIN;
201 conf_set_int(conf, CONF_protocol, default_protocol);
202 conf_set_int(conf, CONF_port, default_port);
205 if (!strcmp(p, "-raw")) {
207 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
209 default_protocol = PROT_RAW;
210 conf_set_int(conf, CONF_protocol, default_protocol);
212 if (!strcmp(p, "-serial")) {
214 /* Serial is not NONNETWORK in an odd sense of the word */
215 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
217 default_protocol = PROT_SERIAL;
218 conf_set_int(conf, CONF_protocol, default_protocol);
219 /* The host parameter will already be loaded into CONF_host,
220 * so copy it across */
221 conf_set_str(conf, CONF_serline, conf_get_str(conf, CONF_host));
223 if (!strcmp(p, "-v")) {
225 flags |= FLAG_VERBOSE;
227 if (!strcmp(p, "-l")) {
229 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
231 conf_set_str(conf, CONF_username, value);
233 if (!strcmp(p, "-loghost")) {
235 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
237 conf_set_str(conf, CONF_loghost, value);
239 if ((!strcmp(p, "-L") || !strcmp(p, "-R") || !strcmp(p, "-D"))) {
240 char type, *q, *qq, *key, *val;
242 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
244 if (strcmp(p, "-D")) {
246 * For -L or -R forwarding types:
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
256 * (This looks like a foolish way of doing it given the
257 * existence of strrchr, but it's more efficient than
258 * two strrchrs - not to mention that the second strrchr
259 * would require us to modify the input string!)
262 type = p[1]; /* 'L' or 'R' */
264 q = qq = strchr(value, ':');
266 char *qqq = strchr(qq+1, ':');
273 cmdline_error("-%c expects at least two colons in its"
278 key = dupprintf("%c%.*s", type, q - value, value);
282 * Dynamic port forwardings are entered under the same key
283 * as if they were local (because they occupy the same
284 * port space - a local and a dynamic forwarding on the
285 * same local port are mutually exclusive), with the
286 * special value "D" (which can be distinguished from
287 * anything in the ordinary -L case by containing no
290 key = dupprintf("L%s", value);
293 conf_set_str_str(conf, CONF_portfwd, key, val);
297 if ((!strcmp(p, "-nc"))) {
301 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
304 portp = strchr(value, ':');
306 cmdline_error("-nc expects argument of form 'host:port'");
310 host = dupprintf("%.*s", portp - value, value);
311 conf_set_str(conf, CONF_ssh_nc_host, host);
312 conf_set_int(conf, CONF_ssh_nc_port, atoi(portp + 1));
315 if (!strcmp(p, "-m")) {
316 char *filename, *command;
322 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
327 cmdlen = cmdsize = 0;
329 fp = fopen(filename, "r");
331 cmdline_error("unable to open command file \"%s\"", filename);
339 if (cmdlen >= cmdsize) {
340 cmdsize = cmdlen + 512;
341 command = sresize(command, cmdsize, char);
343 command[cmdlen++] = d;
346 conf_set_str(conf, CONF_remote_cmd, command);
347 conf_set_str(conf, CONF_remote_cmd2, "");
348 conf_set_int(conf, CONF_nopty, TRUE); /* command => no terminal */
351 if (!strcmp(p, "-P")) {
353 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
354 SAVEABLE(1); /* lower priority than -ssh,-telnet */
355 conf_set_int(conf, CONF_port, atoi(value));
357 if (!strcmp(p, "-pw")) {
359 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
361 /* We delay evaluating this until after the protocol is decided,
362 * so that we can warn if it's of no use with the selected protocol */
363 if (conf_get_int(conf, CONF_protocol) != PROT_SSH)
364 cmdline_error("the -pw option can only be used with the "
367 cmdline_password = dupstr(value);
368 /* Assuming that `value' is directly from argv, make a good faith
369 * attempt to trample it, to stop it showing up in `ps' output
370 * on Unix-like systems. Not guaranteed, of course. */
371 smemclr(value, strlen(value));
375 if (!strcmp(p, "-agent") || !strcmp(p, "-pagent") ||
376 !strcmp(p, "-pageant")) {
378 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
380 conf_set_int(conf, CONF_tryagent, TRUE);
382 if (!strcmp(p, "-noagent") || !strcmp(p, "-nopagent") ||
383 !strcmp(p, "-nopageant")) {
385 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
387 conf_set_int(conf, CONF_tryagent, FALSE);
390 if (!strcmp(p, "-A")) {
392 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
394 conf_set_int(conf, CONF_agentfwd, 1);
396 if (!strcmp(p, "-a")) {
398 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
400 conf_set_int(conf, CONF_agentfwd, 0);
403 if (!strcmp(p, "-X")) {
405 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
407 conf_set_int(conf, CONF_x11_forward, 1);
409 if (!strcmp(p, "-x")) {
411 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
413 conf_set_int(conf, CONF_x11_forward, 0);
416 if (!strcmp(p, "-t")) {
418 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
419 SAVEABLE(1); /* lower priority than -m */
420 conf_set_int(conf, CONF_nopty, 0);
422 if (!strcmp(p, "-T")) {
424 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
426 conf_set_int(conf, CONF_nopty, 1);
429 if (!strcmp(p, "-N")) {
431 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
433 conf_set_int(conf, CONF_ssh_no_shell, 1);
436 if (!strcmp(p, "-C")) {
438 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
440 conf_set_int(conf, CONF_compression, 1);
443 if (!strcmp(p, "-1")) {
445 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
447 conf_set_int(conf, CONF_sshprot, 0); /* ssh protocol 1 only */
449 if (!strcmp(p, "-2")) {
451 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
453 conf_set_int(conf, CONF_sshprot, 3); /* ssh protocol 2 only */
456 if (!strcmp(p, "-i")) {
459 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
461 fn = filename_from_str(value);
462 conf_set_filename(conf, CONF_keyfile, fn);
466 if (!strcmp(p, "-4") || !strcmp(p, "-ipv4")) {
469 conf_set_int(conf, CONF_addressfamily, ADDRTYPE_IPV4);
471 if (!strcmp(p, "-6") || !strcmp(p, "-ipv6")) {
474 conf_set_int(conf, CONF_addressfamily, ADDRTYPE_IPV6);
476 if (!strcmp(p, "-sercfg")) {
479 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
481 if (conf_get_int(conf, CONF_protocol) != PROT_SERIAL)
482 cmdline_error("the -sercfg option can only be used with the "
484 /* Value[0] contains one or more , separated values, like 19200,8,n,1,X */
486 while (nextitem[0] != '\0') {
488 char *end = strchr(nextitem, ',');
490 length = strlen(nextitem);
493 length = end - nextitem;
494 nextitem[length] = '\0';
501 conf_set_int(conf, CONF_serstopbits, 2 * (*nextitem-'0'));
509 conf_set_int(conf, CONF_serdatabits, *nextitem-'0');
513 conf_set_int(conf, CONF_serparity, SER_PAR_NONE);
516 conf_set_int(conf, CONF_serparity, SER_PAR_ODD);
519 conf_set_int(conf, CONF_serparity, SER_PAR_EVEN);
522 conf_set_int(conf, CONF_serparity, SER_PAR_MARK);
525 conf_set_int(conf, CONF_serparity, SER_PAR_SPACE);
529 conf_set_int(conf, CONF_serflow, SER_FLOW_NONE);
532 conf_set_int(conf, CONF_serflow, SER_FLOW_XONXOFF);
535 conf_set_int(conf, CONF_serflow, SER_FLOW_RTSCTS);
538 conf_set_int(conf, CONF_serflow, SER_FLOW_DSRDTR);
542 cmdline_error("Unrecognised suboption \"-sercfg %c\"",
545 } else if (length == 3 && !strncmp(nextitem,"1.5",3)) {
546 /* Messy special case */
547 conf_set_int(conf, CONF_serstopbits, 3);
549 int serspeed = atoi(nextitem);
551 conf_set_int(conf, CONF_serspeed, serspeed);
553 cmdline_error("Unrecognised suboption \"-sercfg %s\"",
557 nextitem += length + skip;
560 return ret; /* unrecognised */
563 void cmdline_run_saved(Conf *conf)
566 for (pri = 0; pri < NPRIORITIES; pri++)
567 for (i = 0; i < saves[pri].nsaved; i++)
568 cmdline_process_param(saves[pri].params[i].p,
569 saves[pri].params[i].value, 0, conf);