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 void cmdline_cleanup(void)
58 for (pri = 0; pri < NPRIORITIES; pri++)
59 sfree(saves[pri].params);
62 #define SAVEABLE(pri) do { \
63 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
66 char *cmdline_password = NULL;
68 static int cmdline_get_line(const char *prompt, char *str,
69 int maxlen, int is_pw)
71 static int tried_once = 0;
73 assert(is_pw && cmdline_password);
78 strncpy(str, cmdline_password, maxlen);
79 str[maxlen - 1] = '\0';
86 * Here we have a flags word which describes the capabilities of
87 * the particular tool on whose behalf we're running. We will
88 * refuse certain command-line options if a particular tool
89 * inherently can't do anything sensible. For example, the file
90 * transfer tools (psftp, pscp) can't do a great deal with protocol
91 * selections (ever tried running scp over telnet?) or with port
92 * forwarding (even if it wasn't a hideously bad idea, they don't
93 * have the select() infrastructure to make them work).
95 int cmdline_tooltype = 0;
97 static int cmdline_check_unavailable(int flag, char *p)
99 if (cmdline_tooltype & flag) {
100 cmdline_error("option \"%s\" not available in this tool", p);
106 #define UNAVAILABLE_IN(flag) do { \
107 if (cmdline_check_unavailable(flag, p)) return ret; \
111 * Process a standard command-line parameter. `p' is the parameter
112 * in question; `value' is the subsequent element of argv, which
113 * may or may not be required as an operand to the parameter.
114 * Return value is 2 if both arguments were used; 1 if only p was
115 * used; 0 if the parameter wasn't one we recognised; -2 if it
116 * should have been 2 but value was NULL.
119 #define RETURN(x) do { \
120 if ((x) == 2 && !value) return -2; \
122 if (need_save < 0) return x; \
125 int cmdline_process_param(char *p, char *value, int need_save, Config *cfg)
129 if (!strcmp(p, "-load")) {
131 /* This parameter must be processed immediately rather than being
133 do_defaults(value, cfg);
136 if (!strcmp(p, "-ssh")) {
138 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
140 default_protocol = cfg->protocol = PROT_SSH;
141 default_port = cfg->port = 22;
144 if (!strcmp(p, "-telnet")) {
146 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
148 default_protocol = cfg->protocol = PROT_TELNET;
149 default_port = cfg->port = 23;
152 if (!strcmp(p, "-rlogin")) {
154 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
156 default_protocol = cfg->protocol = PROT_RLOGIN;
157 default_port = cfg->port = 513;
160 if (!strcmp(p, "-raw")) {
162 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
164 default_protocol = cfg->protocol = PROT_RAW;
166 if (!strcmp(p, "-v")) {
168 flags |= FLAG_VERBOSE;
170 if (!strcmp(p, "-l")) {
172 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
174 strncpy(cfg->username, value, sizeof(cfg->username));
175 cfg->username[sizeof(cfg->username) - 1] = '\0';
177 if ((!strcmp(p, "-L") || !strcmp(p, "-R") || !strcmp(p, "-D"))) {
178 char *fwd, *ptr, *q, *qq;
181 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
183 dynamic = !strcmp(p, "-D");
186 /* if multiple forwards, find end of list */
187 if (ptr[0]=='R' || ptr[0]=='L' || ptr[0] == 'D') {
188 for (i = 0; i < sizeof(cfg->portfwd) - 2; i++)
189 if (ptr[i]=='\000' && ptr[i+1]=='\000')
191 ptr = ptr + i + 1; /* point to next forward slot */
193 ptr[0] = p[1]; /* insert a 'L', 'R' or 'D' at the start */
194 if (strlen(fwd) > sizeof(cfg->portfwd) - i - 2) {
195 cmdline_error("out of space for port forwardings");
198 strncpy(ptr+1, fwd, sizeof(cfg->portfwd) - i);
201 * We expect _at least_ two colons in this string. The
202 * possible formats are `sourceport:desthost:destport',
203 * or `sourceip:sourceport:desthost:destport' if you're
204 * specifying a particular loopback address. We need to
205 * replace the one between source and dest with a \t;
206 * this means we must find the second-to-last colon in
209 q = qq = strchr(ptr, ':');
211 char *qqq = strchr(qq+1, ':');
216 if (q) *q = '\t'; /* replace second-last colon with \t */
218 cfg->portfwd[sizeof(cfg->portfwd) - 1] = '\0';
219 cfg->portfwd[sizeof(cfg->portfwd) - 2] = '\0';
220 ptr[strlen(ptr)+1] = '\000'; /* append two '\000' */
222 if (!strcmp(p, "-m")) {
223 char *filename, *command;
229 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
234 cmdlen = cmdsize = 0;
236 fp = fopen(filename, "r");
238 cmdline_error("unable to open command "
239 "file \"%s\"", filename);
247 if (cmdlen >= cmdsize) {
248 cmdsize = cmdlen + 512;
249 command = sresize(command, cmdsize, char);
251 command[cmdlen++] = d;
253 cfg->remote_cmd_ptr = command;
254 cfg->remote_cmd_ptr2 = NULL;
255 cfg->nopty = TRUE; /* command => no terminal */
257 if (!strcmp(p, "-P")) {
259 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
260 SAVEABLE(1); /* lower priority than -ssh,-telnet */
261 cfg->port = atoi(value);
263 if (!strcmp(p, "-pw")) {
265 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
266 cmdline_password = value;
267 ssh_get_line = cmdline_get_line;
268 ssh_getline_pw_only = TRUE;
271 if (!strcmp(p, "-A")) {
273 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
277 if (!strcmp(p, "-a")) {
279 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
284 if (!strcmp(p, "-X")) {
286 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
288 cfg->x11_forward = 1;
290 if (!strcmp(p, "-x")) {
292 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
294 cfg->x11_forward = 0;
297 if (!strcmp(p, "-t")) {
299 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
303 if (!strcmp(p, "-T")) {
305 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
310 if (!strcmp(p, "-C")) {
312 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
314 cfg->compression = 1;
317 if (!strcmp(p, "-1")) {
319 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
321 cfg->sshprot = 0; /* ssh protocol 1 only */
323 if (!strcmp(p, "-2")) {
325 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
327 cfg->sshprot = 3; /* ssh protocol 2 only */
330 if (!strcmp(p, "-i")) {
332 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
334 cfg->keyfile = filename_from_str(value);
337 return ret; /* unrecognised */
340 void cmdline_run_saved(Config *cfg)
343 for (pri = 0; pri < NPRIORITIES; pri++)
344 for (i = 0; i < saves[pri].nsaved; i++)
345 cmdline_process_param(saves[pri].params[i].p,
346 saves[pri].params[i].value, 0, cfg);