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 void cmdline_cleanup(void)
63 for (pri
= 0; pri
< NPRIORITIES
; pri
++)
64 sfree(saves
[pri
].params
);
67 #define SAVEABLE(pri) do { \
68 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
71 static char *cmdline_password
= NULL
;
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.
78 int cmdline_get_passwd_input(prompts_t
*p
, unsigned char *in
, int inlen
) {
80 static int tried_once
= 0;
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.
87 if (!cmdline_password
|| in
|| p
->n_prompts
!= 1 || p
->prompts
[0]->echo
) {
92 * If we've tried once, return utter failure (no more passwords left
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
));
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).
117 int cmdline_tooltype
= 0;
119 static int cmdline_check_unavailable(int flag
, char *p
)
121 if (cmdline_tooltype
& flag
) {
122 cmdline_error("option \"%s\" not available in this tool", p
);
128 #define UNAVAILABLE_IN(flag) do { \
129 if (cmdline_check_unavailable(flag, p)) return ret; \
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.
147 #define RETURN(x) do { \
148 if ((x) == 2 && !value) return -2; \
150 if (need_save < 0) return x; \
153 int cmdline_process_param(char *p
, char *value
, int need_save
, Config
*cfg
)
157 if (!strcmp(p
, "-load")) {
159 /* This parameter must be processed immediately rather than being
161 do_defaults(value
, cfg
);
162 loaded_session
= TRUE
;
165 if (!strcmp(p
, "-ssh")) {
167 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
169 default_protocol
= cfg
->protocol
= PROT_SSH
;
170 default_port
= cfg
->port
= 22;
173 if (!strcmp(p
, "-telnet")) {
175 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
177 default_protocol
= cfg
->protocol
= PROT_TELNET
;
178 default_port
= cfg
->port
= 23;
181 if (!strcmp(p
, "-rlogin")) {
183 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
185 default_protocol
= cfg
->protocol
= PROT_RLOGIN
;
186 default_port
= cfg
->port
= 513;
189 if (!strcmp(p
, "-raw")) {
191 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
193 default_protocol
= cfg
->protocol
= PROT_RAW
;
195 if (!strcmp(p
, "-v")) {
197 flags
|= FLAG_VERBOSE
;
199 if (!strcmp(p
, "-l")) {
201 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
203 strncpy(cfg
->username
, value
, sizeof(cfg
->username
));
204 cfg
->username
[sizeof(cfg
->username
) - 1] = '\0';
206 if ((!strcmp(p
, "-L") || !strcmp(p
, "-R") || !strcmp(p
, "-D"))) {
207 char *fwd
, *ptr
, *q
, *qq
;
210 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
212 dynamic
= !strcmp(p
, "-D");
215 /* if existing forwards, find end of list */
221 i
= ptr
- cfg
->portfwd
;
222 ptr
[0] = p
[1]; /* insert a 'L', 'R' or 'D' at the start */
224 if (1 + strlen(fwd
) + 2 > sizeof(cfg
->portfwd
) - i
) {
225 cmdline_error("out of space for port forwardings");
228 strncpy(ptr
, fwd
, sizeof(cfg
->portfwd
) - i
- 2);
231 * We expect _at least_ two colons in this string. The
232 * possible formats are `sourceport:desthost:destport',
233 * or `sourceip:sourceport:desthost:destport' if you're
234 * specifying a particular loopback address. We need to
235 * replace the one between source and dest with a \t;
236 * this means we must find the second-to-last colon in
239 q
= qq
= strchr(ptr
, ':');
241 char *qqq
= strchr(qq
+1, ':');
246 if (q
) *q
= '\t'; /* replace second-last colon with \t */
248 cfg
->portfwd
[sizeof(cfg
->portfwd
) - 1] = '\0';
249 cfg
->portfwd
[sizeof(cfg
->portfwd
) - 2] = '\0';
250 ptr
[strlen(ptr
)+1] = '\000'; /* append 2nd '\000' */
252 if ((!strcmp(p
, "-nc"))) {
256 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
259 host
= portp
= value
;
260 while (*portp
&& *portp
!= ':')
263 unsigned len
= portp
- host
;
264 if (len
>= sizeof(cfg
->ssh_nc_host
))
265 len
= sizeof(cfg
->ssh_nc_host
) - 1;
266 strncpy(cfg
->ssh_nc_host
, value
, len
);
267 cfg
->ssh_nc_host
[sizeof(cfg
->ssh_nc_host
) - 1] = '\0';
268 cfg
->ssh_nc_port
= atoi(portp
+1);
270 cmdline_error("-nc expects argument of form 'host:port'");
274 if (!strcmp(p
, "-m")) {
275 char *filename
, *command
;
281 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
286 cmdlen
= cmdsize
= 0;
288 fp
= fopen(filename
, "r");
290 cmdline_error("unable to open command "
291 "file \"%s\"", filename
);
299 if (cmdlen
>= cmdsize
) {
300 cmdsize
= cmdlen
+ 512;
301 command
= sresize(command
, cmdsize
, char);
303 command
[cmdlen
++] = d
;
305 cfg
->remote_cmd_ptr
= command
;
306 cfg
->remote_cmd_ptr2
= NULL
;
307 cfg
->nopty
= TRUE
; /* command => no terminal */
309 if (!strcmp(p
, "-P")) {
311 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
312 SAVEABLE(1); /* lower priority than -ssh,-telnet */
313 cfg
->port
= atoi(value
);
315 if (!strcmp(p
, "-pw")) {
317 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
319 /* We delay evaluating this until after the protocol is decided,
320 * so that we can warn if it's of no use with the selected protocol */
321 if (cfg
->protocol
!= PROT_SSH
)
322 cmdline_error("The -pw option can only be used with the "
325 cmdline_password
= value
;
328 if (!strcmp(p
, "-agent") || !strcmp(p
, "-pagent") ||
329 !strcmp(p
, "-pageant")) {
331 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
333 cfg
->tryagent
= TRUE
;
335 if (!strcmp(p
, "-noagent") || !strcmp(p
, "-nopagent") ||
336 !strcmp(p
, "-nopageant")) {
338 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
340 cfg
->tryagent
= FALSE
;
343 if (!strcmp(p
, "-A")) {
345 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
349 if (!strcmp(p
, "-a")) {
351 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
356 if (!strcmp(p
, "-X")) {
358 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
360 cfg
->x11_forward
= 1;
362 if (!strcmp(p
, "-x")) {
364 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
366 cfg
->x11_forward
= 0;
369 if (!strcmp(p
, "-t")) {
371 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
375 if (!strcmp(p
, "-T")) {
377 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
382 if (!strcmp(p
, "-N")) {
384 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
| TOOLTYPE_NONNETWORK
);
386 cfg
->ssh_no_shell
= 1;
389 if (!strcmp(p
, "-C")) {
391 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
393 cfg
->compression
= 1;
396 if (!strcmp(p
, "-1")) {
398 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
400 cfg
->sshprot
= 0; /* ssh protocol 1 only */
402 if (!strcmp(p
, "-2")) {
404 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
406 cfg
->sshprot
= 3; /* ssh protocol 2 only */
409 if (!strcmp(p
, "-i")) {
411 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK
);
413 cfg
->keyfile
= filename_from_str(value
);
416 if (!strcmp(p
, "-4") || !strcmp(p
, "-ipv4")) {
419 cfg
->addressfamily
= ADDRTYPE_IPV4
;
421 if (!strcmp(p
, "-6") || !strcmp(p
, "-ipv6")) {
424 cfg
->addressfamily
= ADDRTYPE_IPV6
;
427 return ret
; /* unrecognised */
430 void cmdline_run_saved(Config
*cfg
)
433 for (pri
= 0; pri
< NPRIORITIES
; pri
++)
434 for (i
= 0; i
< saves
[pri
].nsaved
; i
++)
435 cmdline_process_param(saves
[pri
].params
[i
].p
,
436 saves
[pri
].params
[i
].value
, 0, cfg
);