7 * Some command-line parameters need to be saved up until after
8 * we've loaded the saved session which will form the basis of our
9 * eventual running configuration. For this we use the macro
10 * SAVEABLE, which notices if the `need_save' parameter is set and
11 * saves the parameter and value on a list.
13 * We also assign priorities to saved parameters, just to slightly
14 * ameliorate silly ordering problems. For example, if you specify
15 * a saved session to load, it will be loaded _before_ all your
16 * local modifications such as -L are evaluated; and if you specify
17 * a protocol and a port, the protocol is set up first so that the
18 * port can override its choice of port number.
20 * (In fact -load is not saved at all, since in at least Plink the
21 * processing of further command-line options depends on whether or
22 * not the loaded session contained a hostname. So it must be
23 * executed immediately.)
28 struct cmdline_saved_param
{
31 struct cmdline_saved_param_set
{
32 struct cmdline_saved_param
*params
;
37 * C guarantees this structure will be initialised to all zero at
38 * program start, which is exactly what we want.
40 static struct cmdline_saved_param_set saves
[NPRIORITIES
];
42 static void cmdline_save_param(char *p
, char *value
, int pri
)
44 if (saves
[pri
].nsaved
>= saves
[pri
].savesize
) {
45 saves
[pri
].savesize
= saves
[pri
].nsaved
+ 32;
46 saves
[pri
].params
= sresize(saves
[pri
].params
, saves
[pri
].savesize
,
47 struct cmdline_saved_param
);
49 saves
[pri
].params
[saves
[pri
].nsaved
].p
= p
;
50 saves
[pri
].params
[saves
[pri
].nsaved
].value
= value
;
54 #define SAVEABLE(pri) do { \
55 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
58 char *cmdline_password
= NULL
;
60 static int cmdline_get_line(const char *prompt
, char *str
,
61 int maxlen
, int is_pw
)
63 static int tried_once
= 0;
65 assert(is_pw
&& cmdline_password
);
70 strncpy(str
, cmdline_password
, maxlen
);
71 str
[maxlen
- 1] = '\0';
78 * Here we have a flags word which describes the capabilities of
79 * the particular tool on whose behalf we're running. We will
80 * refuse certain command-line options if a particular tool
81 * inherently can't do anything sensible. For example, the file
82 * transfer tools (psftp, pscp) can't do a great deal with protocol
83 * selections (ever tried running scp over telnet?) or with port
84 * forwarding (even if it wasn't a hideously bad idea, they don't
85 * have the select() infrastructure to make them work).
87 int cmdline_tooltype
= 0;
89 static int cmdline_check_unavailable(int flag
, char *p
)
91 if (cmdline_tooltype
& flag
) {
92 cmdline_error("option \"%s\" not available in this tool", p
);
98 #define UNAVAILABLE_IN(flag) do { \
99 if (cmdline_check_unavailable(flag, p)) return ret; \
103 * Process a standard command-line parameter. `p' is the parameter
104 * in question; `value' is the subsequent element of argv, which
105 * may or may not be required as an operand to the parameter.
106 * Return value is 2 if both arguments were used; 1 if only p was
107 * used; 0 if the parameter wasn't one we recognised; -2 if it
108 * should have been 2 but value was NULL.
111 #define RETURN(x) do { \
112 if ((x) == 2 && !value) return -2; \
116 int cmdline_process_param(char *p
, char *value
, int need_save
, Config
*cfg
)
120 if (!strcmp(p
, "-load")) {
122 /* This parameter must be processed immediately rather than being
124 do_defaults(value
, cfg
);
127 if (!strcmp(p
, "-ssh")) {
129 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
131 default_protocol
= cfg
->protocol
= PROT_SSH
;
132 default_port
= cfg
->port
= 22;
135 if (!strcmp(p
, "-telnet")) {
137 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
139 default_protocol
= cfg
->protocol
= PROT_TELNET
;
140 default_port
= cfg
->port
= 23;
143 if (!strcmp(p
, "-rlogin")) {
145 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
147 default_protocol
= cfg
->protocol
= PROT_RLOGIN
;
148 default_port
= cfg
->port
= 513;
151 if (!strcmp(p
, "-raw")) {
153 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
155 default_protocol
= cfg
->protocol
= PROT_RAW
;
157 if (!strcmp(p
, "-v")) {
159 flags
|= FLAG_VERBOSE
;
161 if (!strcmp(p
, "-l")) {
164 strncpy(cfg
->username
, value
, sizeof(cfg
->username
));
165 cfg
->username
[sizeof(cfg
->username
) - 1] = '\0';
167 if ((!strcmp(p
, "-L") || !strcmp(p
, "-R"))) {
168 char *fwd
, *ptr
, *q
, *qq
;
171 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
175 /* if multiple forwards, find end of list */
176 if (ptr
[0]=='R' || ptr
[0]=='L') {
177 for (i
= 0; i
< sizeof(cfg
->portfwd
) - 2; i
++)
178 if (ptr
[i
]=='\000' && ptr
[i
+1]=='\000')
180 ptr
= ptr
+ i
+ 1; /* point to next forward slot */
182 ptr
[0] = p
[1]; /* insert a 'L' or 'R' at the start */
183 if (strlen(fwd
) > sizeof(cfg
->portfwd
) - i
- 2) {
184 cmdline_error("out of space for port forwardings");
187 strncpy(ptr
+1, fwd
, sizeof(cfg
->portfwd
) - i
);
189 * We expect _at least_ two colons in this string. The
190 * possible formats are `sourceport:desthost:destport', or
191 * `sourceip:sourceport:desthost:destport' if you're
192 * specifying a particular loopback address. We need to
193 * replace the one between source and dest with a \t; this
194 * means we must find the second-to-last colon in the
197 q
= qq
= strchr(ptr
, ':');
199 char *qqq
= strchr(qq
+1, ':');
204 if (q
) *q
= '\t'; /* replace second-last colon with \t */
205 cfg
->portfwd
[sizeof(cfg
->portfwd
) - 1] = '\0';
206 cfg
->portfwd
[sizeof(cfg
->portfwd
) - 2] = '\0';
207 ptr
[strlen(ptr
)+1] = '\000'; /* append two '\000' */
209 if (!strcmp(p
, "-m")) {
210 char *filename
, *command
;
216 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
221 cmdlen
= cmdsize
= 0;
223 fp
= fopen(filename
, "r");
225 cmdline_error("unable to open command "
226 "file \"%s\"", filename
);
234 if (cmdlen
>= cmdsize
) {
235 cmdsize
= cmdlen
+ 512;
236 command
= sresize(command
, cmdsize
, char);
238 command
[cmdlen
++] = d
;
240 cfg
->remote_cmd_ptr
= command
;
241 cfg
->remote_cmd_ptr2
= NULL
;
242 cfg
->nopty
= TRUE
; /* command => no terminal */
244 if (!strcmp(p
, "-P")) {
246 SAVEABLE(1); /* lower priority than -ssh,-telnet */
247 cfg
->port
= atoi(value
);
249 if (!strcmp(p
, "-pw")) {
251 cmdline_password
= value
;
252 ssh_get_line
= cmdline_get_line
;
253 ssh_getline_pw_only
= TRUE
;
256 if (!strcmp(p
, "-A")) {
258 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
262 if (!strcmp(p
, "-a")) {
264 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
269 if (!strcmp(p
, "-X")) {
271 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
273 cfg
->x11_forward
= 1;
275 if (!strcmp(p
, "-x")) {
277 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
279 cfg
->x11_forward
= 0;
282 if (!strcmp(p
, "-t")) {
284 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
288 if (!strcmp(p
, "-T")) {
290 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER
);
295 if (!strcmp(p
, "-C")) {
298 cfg
->compression
= 1;
301 if (!strcmp(p
, "-1")) {
304 cfg
->sshprot
= 0; /* ssh protocol 1 only */
306 if (!strcmp(p
, "-2")) {
309 cfg
->sshprot
= 3; /* ssh protocol 2 only */
312 if (!strcmp(p
, "-i")) {
315 cfg
->keyfile
= filename_from_str(value
);
318 return ret
; /* unrecognised */
321 void cmdline_run_saved(Config
*cfg
)
324 for (pri
= 0; pri
< NPRIORITIES
; pri
++)
325 for (i
= 0; i
< saves
[pri
].nsaved
; i
++)
326 cmdline_process_param(saves
[pri
].params
[i
].p
,
327 saves
[pri
].params
[i
].value
, 0, cfg
);