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;
47 srealloc(saves[pri].params,
48 saves[pri].savesize*sizeof(*saves[pri].params));
50 saves[pri].params[saves[pri].nsaved].p = p;
51 saves[pri].params[saves[pri].nsaved].value = value;
55 #define SAVEABLE(pri) do { \
56 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
59 char *cmdline_password = NULL;
61 static int cmdline_get_line(const char *prompt, char *str,
62 int maxlen, int is_pw)
64 static int tried_once = 0;
66 assert(is_pw && cmdline_password);
71 strncpy(str, cmdline_password, maxlen);
72 str[maxlen - 1] = '\0';
79 * Here we have a flags word which describes the capabilities of
80 * the particular tool on whose behalf we're running. We will
81 * refuse certain command-line options if a particular tool
82 * inherently can't do anything sensible. For example, the file
83 * transfer tools (psftp, pscp) can't do a great deal with protocol
84 * selections (ever tried running scp over telnet?) or with port
85 * forwarding (even if it wasn't a hideously bad idea, they don't
86 * have the select() infrastructure to make them work).
88 int cmdline_tooltype = 0;
90 static int cmdline_check_unavailable(int flag, char *p)
92 if (cmdline_tooltype & flag) {
93 cmdline_error("option \"%s\" not available in this tool", p);
99 #define UNAVAILABLE_IN(flag) do { \
100 if (cmdline_check_unavailable(flag, p)) return ret; \
104 * Process a standard command-line parameter. `p' is the parameter
105 * in question; `value' is the subsequent element of argv, which
106 * may or may not be required as an operand to the parameter.
107 * Return value is 2 if both arguments were used; 1 if only p was
108 * used; 0 if the parameter wasn't one we recognised; -2 if it
109 * should have been 2 but value was NULL.
112 #define RETURN(x) do { \
113 if ((x) == 2 && !value) return -2; \
117 int cmdline_process_param(char *p, char *value, int need_save, Config *cfg)
121 if (!strcmp(p, "-load")) {
123 /* This parameter must be processed immediately rather than being
125 do_defaults(value, cfg);
128 if (!strcmp(p, "-ssh")) {
130 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
132 default_protocol = cfg->protocol = PROT_SSH;
133 default_port = cfg->port = 22;
136 if (!strcmp(p, "-telnet")) {
138 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
140 default_protocol = cfg->protocol = PROT_TELNET;
141 default_port = cfg->port = 23;
144 if (!strcmp(p, "-rlogin")) {
146 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
148 default_protocol = cfg->protocol = PROT_RLOGIN;
149 default_port = cfg->port = 513;
152 if (!strcmp(p, "-raw")) {
154 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
156 default_protocol = cfg->protocol = PROT_RAW;
158 if (!strcmp(p, "-v")) {
160 flags |= FLAG_VERBOSE;
162 if (!strcmp(p, "-l")) {
165 strncpy(cfg->username, value, sizeof(cfg->username));
166 cfg->username[sizeof(cfg->username) - 1] = '\0';
168 if ((!strcmp(p, "-L") || !strcmp(p, "-R"))) {
169 char *fwd, *ptr, *q, *qq;
172 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
176 /* if multiple forwards, find end of list */
177 if (ptr[0]=='R' || ptr[0]=='L') {
178 for (i = 0; i < sizeof(cfg->portfwd) - 2; i++)
179 if (ptr[i]=='\000' && ptr[i+1]=='\000')
181 ptr = ptr + i + 1; /* point to next forward slot */
183 ptr[0] = p[1]; /* insert a 'L' or 'R' at the start */
184 if (strlen(fwd) > sizeof(cfg->portfwd) - i - 2) {
185 cmdline_error("out of space for port forwardings");
188 strncpy(ptr+1, fwd, sizeof(cfg->portfwd) - i);
190 * We expect _at least_ two colons in this string. The
191 * possible formats are `sourceport:desthost:destport', or
192 * `sourceip:sourceport:desthost:destport' if you're
193 * specifying a particular loopback address. We need to
194 * replace the one between source and dest with a \t; this
195 * means we must find the second-to-last colon in the
198 q = qq = strchr(ptr, ':');
200 char *qqq = strchr(qq+1, ':');
205 if (q) *q = '\t'; /* replace second-last colon with \t */
206 cfg->portfwd[sizeof(cfg->portfwd) - 1] = '\0';
207 cfg->portfwd[sizeof(cfg->portfwd) - 2] = '\0';
208 ptr[strlen(ptr)+1] = '\000'; /* append two '\000' */
210 if (!strcmp(p, "-m")) {
211 char *filename, *command;
217 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
222 cmdlen = cmdsize = 0;
224 fp = fopen(filename, "r");
226 cmdline_error("unable to open command "
227 "file \"%s\"", filename);
235 if (cmdlen >= cmdsize) {
236 cmdsize = cmdlen + 512;
237 command = srealloc(command, cmdsize);
239 command[cmdlen++] = d;
241 cfg->remote_cmd_ptr = command;
242 cfg->remote_cmd_ptr2 = NULL;
243 cfg->nopty = TRUE; /* command => no terminal */
245 if (!strcmp(p, "-P")) {
247 SAVEABLE(1); /* lower priority than -ssh,-telnet */
248 cfg->port = atoi(value);
250 if (!strcmp(p, "-pw")) {
252 cmdline_password = value;
253 ssh_get_line = cmdline_get_line;
254 ssh_getline_pw_only = TRUE;
257 if (!strcmp(p, "-A")) {
259 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
263 if (!strcmp(p, "-a")) {
265 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
270 if (!strcmp(p, "-X")) {
272 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
274 cfg->x11_forward = 1;
276 if (!strcmp(p, "-x")) {
278 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
280 cfg->x11_forward = 0;
283 if (!strcmp(p, "-t")) {
285 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
289 if (!strcmp(p, "-T")) {
291 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER);
296 if (!strcmp(p, "-C")) {
299 cfg->compression = 1;
302 if (!strcmp(p, "-1")) {
305 cfg->sshprot = 0; /* ssh protocol 1 only */
307 if (!strcmp(p, "-2")) {
310 cfg->sshprot = 3; /* ssh protocol 2 only */
313 if (!strcmp(p, "-i")) {
316 cfg->keyfile = filename_from_str(value);
319 return ret; /* unrecognised */
322 void cmdline_run_saved(Config *cfg)
325 for (pri = 0; pri < NPRIORITIES; pri++)
326 for (i = 0; i < saves[pri].nsaved; i++)
327 cmdline_process_param(saves[pri].params[i].p,
328 saves[pri].params[i].value, 0, cfg);