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
;
175 cmdline_session_name
= dupstr(value
);
178 if (!strcmp(p
, "-ssh")) {
180 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
182 default_protocol
= cfg
->protocol
= PROT_SSH
;
183 default_port
= cfg
->port
= 22;
186 if (!strcmp(p
, "-telnet")) {
188 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
190 default_protocol
= cfg
->protocol
= PROT_TELNET
;
191 default_port
= cfg
->port
= 23;
194 if (!strcmp(p
, "-rlogin")) {
196 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
198 default_protocol
= cfg
->protocol
= PROT_RLOGIN
;
199 default_port
= cfg
->port
= 513;
202 if (!strcmp(p
, "-raw")) {
204 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
206 default_protocol
= cfg
->protocol
= PROT_RAW
;
208 if (!strcmp(p
, "-serial")) {
210 /* Serial is not NONNETWORK in an odd sense of the word */
211 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
213 default_protocol
= cfg
->protocol
= PROT_SERIAL
;
214 /* The host parameter will already be loaded into cfg->host, so copy it across */
215 strncpy(cfg
->serline
, cfg
->host
, sizeof(cfg
->serline
) - 1);
216 cfg
->serline
[sizeof(cfg
->serline
) - 1] = '\0';
218 if (!strcmp(p
, "-v")) {
220 flags
|= FLAG_VERBOSE
;
222 if (!strcmp(p
, "-l")) {
224 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
226 strncpy(cfg
->username
, value
, sizeof(cfg
->username
));
227 cfg
->username
[sizeof(cfg
->username
) - 1] = '\0';
229 if (!strcmp(p
, "-loghost")) {
231 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
233 strncpy(cfg
->loghost
, value
, sizeof(cfg
->loghost
));
234 cfg
->loghost
[sizeof(cfg
->loghost
) - 1] = '\0';
236 if ((!strcmp(p
, "-L") || !strcmp(p
, "-R") || !strcmp(p
, "-D"))) {
237 char *fwd
, *ptr
, *q
, *qq
;
240 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
242 dynamic
= !strcmp(p
, "-D");
245 /* if existing forwards, find end of list */
251 i
= ptr
- cfg
->portfwd
;
252 ptr
[0] = p
[1]; /* insert a 'L', 'R' or 'D' at the start */
254 if (1 + strlen(fwd
) + 2 > sizeof(cfg
->portfwd
) - i
) {
255 cmdline_error("out of space for port forwardings");
258 strncpy(ptr
, fwd
, sizeof(cfg
->portfwd
) - i
- 2);
261 * We expect _at least_ two colons in this string. The
262 * possible formats are `sourceport:desthost:destport',
263 * or `sourceip:sourceport:desthost:destport' if you're
264 * specifying a particular loopback address. We need to
265 * replace the one between source and dest with a \t;
266 * this means we must find the second-to-last colon in
269 q
= qq
= strchr(ptr
, ':');
271 char *qqq
= strchr(qq
+1, ':');
276 if (q
) *q
= '\t'; /* replace second-last colon with \t */
278 cfg
->portfwd
[sizeof(cfg
->portfwd
) - 1] = '\0';
279 cfg
->portfwd
[sizeof(cfg
->portfwd
) - 2] = '\0';
280 ptr
[strlen(ptr
)+1] = '\000'; /* append 2nd '\000' */
282 if ((!strcmp(p
, "-nc"))) {
286 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
289 host
= portp
= value
;
290 while (*portp
&& *portp
!= ':')
293 unsigned len
= portp
- host
;
294 if (len
>= sizeof(cfg
->ssh_nc_host
))
295 len
= sizeof(cfg
->ssh_nc_host
) - 1;
296 memcpy(cfg
->ssh_nc_host
, value
, len
);
297 cfg
->ssh_nc_host
[len
] = '\0';
298 cfg
->ssh_nc_port
= atoi(portp
+1);
300 cmdline_error("-nc expects argument of form 'host:port'");
304 if (!strcmp(p
, "-m")) {
305 char *filename
, *command
;
311 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
316 cmdlen
= cmdsize
= 0;
318 fp
= fopen(filename
, "r");
320 cmdline_error("unable to open command "
321 "file \"%s\"", filename
);
329 if (cmdlen
>= cmdsize
) {
330 cmdsize
= cmdlen
+ 512;
331 command
= sresize(command
, cmdsize
, char);
333 command
[cmdlen
++] = d
;
335 cfg
->remote_cmd_ptr
= command
;
336 cfg
->remote_cmd_ptr2
= NULL
;
337 cfg
->nopty
= TRUE
; /* command => no terminal */
340 if (!strcmp(p
, "-P")) {
342 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
343 SAVEABLE(1); /* lower priority than -ssh,-telnet */
344 cfg
->port
= atoi(value
);
346 if (!strcmp(p
, "-pw")) {
348 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
350 /* We delay evaluating this until after the protocol is decided,
351 * so that we can warn if it's of no use with the selected protocol */
352 if (cfg
->protocol
!= PROT_SSH
)
353 cmdline_error("the -pw option can only be used with the "
356 cmdline_password
= dupstr(value
);
357 /* Assuming that `value' is directly from argv, make a good faith
358 * attempt to trample it, to stop it showing up in `ps' output
359 * on Unix-like systems. Not guaranteed, of course. */
360 memset(value
, 0, strlen(value
));
364 if (!strcmp(p
, "-agent") || !strcmp(p
, "-pagent") ||
365 !strcmp(p
, "-pageant")) {
367 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
369 cfg
->tryagent
= TRUE
;
371 if (!strcmp(p
, "-noagent") || !strcmp(p
, "-nopagent") ||
372 !strcmp(p
, "-nopageant")) {
374 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
376 cfg
->tryagent
= FALSE
;
379 if (!strcmp(p
, "-A")) {
381 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
385 if (!strcmp(p
, "-a")) {
387 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
392 if (!strcmp(p
, "-X")) {
394 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
396 cfg
->x11_forward
= 1;
398 if (!strcmp(p
, "-x")) {
400 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
402 cfg
->x11_forward
= 0;
405 if (!strcmp(p
, "-t")) {
407 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
408 SAVEABLE(1); /* lower priority than -m */
411 if (!strcmp(p
, "-T")) {
413 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
418 if (!strcmp(p
, "-N")) {
420 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
422 cfg
->ssh_no_shell
= 1;
425 if (!strcmp(p
, "-C")) {
427 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
429 cfg
->compression
= 1;
432 if (!strcmp(p
, "-1")) {
434 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
436 cfg
->sshprot
= 0; /* ssh protocol 1 only */
438 if (!strcmp(p
, "-2")) {
440 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
442 cfg
->sshprot
= 3; /* ssh protocol 2 only */
445 if (!strcmp(p
, "-i")) {
447 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
449 cfg
->keyfile
= filename_from_str(value
);
452 if (!strcmp(p
, "-4") || !strcmp(p
, "-ipv4")) {
455 cfg
->addressfamily
= ADDRTYPE_IPV4
;
457 if (!strcmp(p
, "-6") || !strcmp(p
, "-ipv6")) {
460 cfg
->addressfamily
= ADDRTYPE_IPV6
;
462 if (!strcmp(p
, "-sercfg")) {
465 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
467 if (cfg
->protocol
!= PROT_SERIAL
)
468 cmdline_error("the -sercfg option can only be used with the "
470 /* Value[0] contains one or more , separated values, like 19200,8,n,1,X */
472 while (nextitem
[0] != '\0') {
474 char *end
= strchr(nextitem
, ',');
476 length
= strlen(nextitem
);
479 length
= end
- nextitem
;
480 nextitem
[length
] = '\0';
486 cfg
->serstopbits
= 2;
489 cfg
->serstopbits
= 4;
493 cfg
->serdatabits
= 5;
496 cfg
->serdatabits
= 6;
499 cfg
->serdatabits
= 7;
502 cfg
->serdatabits
= 8;
505 cfg
->serdatabits
= 9;
509 cfg
->serparity
= SER_PAR_NONE
;
512 cfg
->serparity
= SER_PAR_ODD
;
515 cfg
->serparity
= SER_PAR_EVEN
;
518 cfg
->serparity
= SER_PAR_MARK
;
521 cfg
->serparity
= SER_PAR_SPACE
;
525 cfg
->serflow
= SER_FLOW_NONE
;
528 cfg
->serflow
= SER_FLOW_XONXOFF
;
531 cfg
->serflow
= SER_FLOW_RTSCTS
;
534 cfg
->serflow
= SER_FLOW_DSRDTR
;
538 cmdline_error("Unrecognised suboption \"-sercfg %c\"",
541 } else if (length
== 3 && !strncmp(nextitem
,"1.5",3)) {
542 /* Messy special case */
543 cfg
->serstopbits
= 3;
545 int serspeed
= atoi(nextitem
);
547 cfg
->serspeed
= serspeed
;
549 cmdline_error("Unrecognised suboption \"-sercfg %s\"",
553 nextitem
+= length
+ skip
;
556 return ret
; /* unrecognised */
559 void cmdline_run_saved(Config
*cfg
)
562 for (pri
= 0; pri
< NPRIORITIES
; pri
++)
563 for (i
= 0; i
< saves
[pri
].nsaved
; i
++)
564 cmdline_process_param(saves
[pri
].params
[i
].p
,
565 saves
[pri
].params
[i
].value
, 0, cfg
);