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 memset(cmdline_password, 0, 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 strncpy(p->prompts[0]->result, cmdline_password,
109 p->prompts[0]->result_len);
110 p->prompts[0]->result[p->prompts[0]->result_len-1] = '\0';
111 memset(cmdline_password, 0, strlen(cmdline_password));
112 sfree(cmdline_password);
113 cmdline_password = NULL;
120 * Here we have a flags word which describes the capabilities of
121 * the particular tool on whose behalf we're running. We will
122 * refuse certain command-line options if a particular tool
123 * inherently can't do anything sensible. For example, the file
124 * transfer tools (psftp, pscp) can't do a great deal with protocol
125 * selections (ever tried running scp over telnet?) or with port
126 * forwarding (even if it wasn't a hideously bad idea, they don't
127 * have the select() infrastructure to make them work).
129 int cmdline_tooltype = 0;
131 static int cmdline_check_unavailable(int flag, char *p)
133 if (cmdline_tooltype & flag) {
134 cmdline_error("option \"%s\" not available in this tool", p);
140 #define UNAVAILABLE_IN(flag) do { \
141 if (cmdline_check_unavailable(flag, p)) return ret; \
145 * Process a standard command-line parameter. `p' is the parameter
146 * in question; `value' is the subsequent element of argv, which
147 * may or may not be required as an operand to the parameter.
148 * If `need_save' is 1, arguments which need to be saved as
149 * described at this top of this file are, for later execution;
150 * if 0, they are processed normally. (-1 is a special value used
151 * by pterm to count arguments for a preliminary pass through the
152 * argument list; it causes immediate return with an appropriate
153 * value with no action taken.)
154 * Return value is 2 if both arguments were used; 1 if only p was
155 * used; 0 if the parameter wasn't one we recognised; -2 if it
156 * should have been 2 but value was NULL.
159 #define RETURN(x) do { \
160 if ((x) == 2 && !value) return -2; \
162 if (need_save < 0) return x; \
165 int cmdline_process_param(char *p, char *value, int need_save, Config *cfg)
169 if (!strcmp(p, "-load")) {
171 /* This parameter must be processed immediately rather than being
173 do_defaults(value, cfg);
174 loaded_session = TRUE;
177 if (!strcmp(p, "-ssh")) {
179 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
181 default_protocol = cfg->protocol = PROT_SSH;
182 default_port = cfg->port = 22;
185 if (!strcmp(p, "-telnet")) {
187 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
189 default_protocol = cfg->protocol = PROT_TELNET;
190 default_port = cfg->port = 23;
193 if (!strcmp(p, "-rlogin")) {
195 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
197 default_protocol = cfg->protocol = PROT_RLOGIN;
198 default_port = cfg->port = 513;
201 if (!strcmp(p, "-raw")) {
203 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
205 default_protocol = cfg->protocol = PROT_RAW;
207 if (!strcmp(p, "-serial")) {
209 /* Serial is not NONNETWORK in an odd sense of the word */
210 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
212 default_protocol = cfg->protocol = PROT_SERIAL;
213 /* The host parameter will already be loaded into cfg->host, so copy it across */
214 strncpy(cfg->serline, cfg->host, sizeof(cfg->serline) - 1);
215 cfg->serline[sizeof(cfg->serline) - 1] = '\0';
217 if (!strcmp(p, "-v")) {
219 flags |= FLAG_VERBOSE;
221 if (!strcmp(p, "-l")) {
223 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
225 strncpy(cfg->username, value, sizeof(cfg->username));
226 cfg->username[sizeof(cfg->username) - 1] = '\0';
228 if (!strcmp(p, "-loghost")) {
230 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
232 strncpy(cfg->loghost, value, sizeof(cfg->loghost));
233 cfg->loghost[sizeof(cfg->loghost) - 1] = '\0';
235 if ((!strcmp(p, "-L") || !strcmp(p, "-R") || !strcmp(p, "-D"))) {
236 char *fwd, *ptr, *q, *qq;
239 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
241 dynamic = !strcmp(p, "-D");
244 /* if existing forwards, find end of list */
250 i = ptr - cfg->portfwd;
251 ptr[0] = p[1]; /* insert a 'L', 'R' or 'D' at the start */
253 if (1 + strlen(fwd) + 2 > sizeof(cfg->portfwd) - i) {
254 cmdline_error("out of space for port forwardings");
257 strncpy(ptr, fwd, sizeof(cfg->portfwd) - i - 2);
260 * We expect _at least_ two colons in this string. The
261 * possible formats are `sourceport:desthost:destport',
262 * or `sourceip:sourceport:desthost:destport' if you're
263 * specifying a particular loopback address. We need to
264 * replace the one between source and dest with a \t;
265 * this means we must find the second-to-last colon in
268 q = qq = strchr(ptr, ':');
270 char *qqq = strchr(qq+1, ':');
275 if (q) *q = '\t'; /* replace second-last colon with \t */
277 cfg->portfwd[sizeof(cfg->portfwd) - 1] = '\0';
278 cfg->portfwd[sizeof(cfg->portfwd) - 2] = '\0';
279 ptr[strlen(ptr)+1] = '\000'; /* append 2nd '\000' */
281 if ((!strcmp(p, "-nc"))) {
285 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
288 host = portp = value;
289 while (*portp && *portp != ':')
292 unsigned len = portp - host;
293 if (len >= sizeof(cfg->ssh_nc_host))
294 len = sizeof(cfg->ssh_nc_host) - 1;
295 memcpy(cfg->ssh_nc_host, value, len);
296 cfg->ssh_nc_host[len] = '\0';
297 cfg->ssh_nc_port = atoi(portp+1);
299 cmdline_error("-nc expects argument of form 'host:port'");
303 if (!strcmp(p, "-m")) {
304 char *filename, *command;
310 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
315 cmdlen = cmdsize = 0;
317 fp = fopen(filename, "r");
319 cmdline_error("unable to open command "
320 "file \"%s\"", filename);
328 if (cmdlen >= cmdsize) {
329 cmdsize = cmdlen + 512;
330 command = sresize(command, cmdsize, char);
332 command[cmdlen++] = d;
334 cfg->remote_cmd_ptr = command;
335 cfg->remote_cmd_ptr2 = NULL;
336 cfg->nopty = TRUE; /* command => no terminal */
339 if (!strcmp(p, "-P")) {
341 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
342 SAVEABLE(1); /* lower priority than -ssh,-telnet */
343 cfg->port = atoi(value);
345 if (!strcmp(p, "-pw")) {
347 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
349 /* We delay evaluating this until after the protocol is decided,
350 * so that we can warn if it's of no use with the selected protocol */
351 if (cfg->protocol != PROT_SSH)
352 cmdline_error("the -pw option can only be used with the "
355 cmdline_password = dupstr(value);
356 /* Assuming that `value' is directly from argv, make a good faith
357 * attempt to trample it, to stop it showing up in `ps' output
358 * on Unix-like systems. Not guaranteed, of course. */
359 memset(value, 0, strlen(value));
363 if (!strcmp(p, "-agent") || !strcmp(p, "-pagent") ||
364 !strcmp(p, "-pageant")) {
366 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
368 cfg->tryagent = TRUE;
370 if (!strcmp(p, "-noagent") || !strcmp(p, "-nopagent") ||
371 !strcmp(p, "-nopageant")) {
373 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
375 cfg->tryagent = FALSE;
378 if (!strcmp(p, "-A")) {
380 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
384 if (!strcmp(p, "-a")) {
386 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
391 if (!strcmp(p, "-X")) {
393 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
395 cfg->x11_forward = 1;
397 if (!strcmp(p, "-x")) {
399 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
401 cfg->x11_forward = 0;
404 if (!strcmp(p, "-t")) {
406 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
407 SAVEABLE(1); /* lower priority than -m */
410 if (!strcmp(p, "-T")) {
412 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
417 if (!strcmp(p, "-N")) {
419 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
421 cfg->ssh_no_shell = 1;
424 if (!strcmp(p, "-C")) {
426 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
428 cfg->compression = 1;
431 if (!strcmp(p, "-1")) {
433 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
435 cfg->sshprot = 0; /* ssh protocol 1 only */
437 if (!strcmp(p, "-2")) {
439 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
441 cfg->sshprot = 3; /* ssh protocol 2 only */
444 if (!strcmp(p, "-i")) {
446 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
448 cfg->keyfile = filename_from_str(value);
451 if (!strcmp(p, "-4") || !strcmp(p, "-ipv4")) {
454 cfg->addressfamily = ADDRTYPE_IPV4;
456 if (!strcmp(p, "-6") || !strcmp(p, "-ipv6")) {
459 cfg->addressfamily = ADDRTYPE_IPV6;
461 if (!strcmp(p, "-sercfg")) {
464 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
466 if (cfg->protocol != PROT_SERIAL)
467 cmdline_error("the -sercfg option can only be used with the "
469 /* Value[0] contains one or more , separated values, like 19200,8,n,1,X */
471 while (nextitem[0] != '\0') {
473 char *end = strchr(nextitem, ',');
475 length = strlen(nextitem);
478 length = end - nextitem;
479 nextitem[length] = '\0';
485 cfg->serstopbits = 2;
488 cfg->serstopbits = 4;
492 cfg->serdatabits = 5;
495 cfg->serdatabits = 6;
498 cfg->serdatabits = 7;
501 cfg->serdatabits = 8;
504 cfg->serdatabits = 9;
508 cfg->serparity = SER_PAR_NONE;
511 cfg->serparity = SER_PAR_ODD;
514 cfg->serparity = SER_PAR_EVEN;
517 cfg->serparity = SER_PAR_MARK;
520 cfg->serparity = SER_PAR_SPACE;
524 cfg->serflow = SER_FLOW_NONE;
527 cfg->serflow = SER_FLOW_XONXOFF;
530 cfg->serflow = SER_FLOW_RTSCTS;
533 cfg->serflow = SER_FLOW_DSRDTR;
537 cmdline_error("Unrecognised suboption \"-sercfg %c\"",
540 } else if (length == 3 && !strncmp(nextitem,"1.5",3)) {
541 /* Messy special case */
542 cfg->serstopbits = 3;
544 int serspeed = atoi(nextitem);
546 cfg->serspeed = serspeed;
548 cmdline_error("Unrecognised suboption \"-sercfg %s\"",
552 nextitem += length + skip;
555 return ret; /* unrecognised */
558 void cmdline_run_saved(Config *cfg)
561 for (pri = 0; pri < NPRIORITIES; pri++)
562 for (i = 0; i < saves[pri].nsaved; i++)
563 cmdline_process_param(saves[pri].params[i].p,
564 saves[pri].params[i].value, 0, cfg);