Text around -load option "(although Plink still requires an explicitly
[u/mdw/putty] / cmdline.c
CommitLineData
dfe3332b 1#include <stdio.h>
2#include <assert.h>
3#include <stdlib.h>
4#include "putty.h"
5
6/*
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.
12 *
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.
c725e24c 19 *
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.)
dfe3332b 24 */
25
c725e24c 26#define NPRIORITIES 2
dfe3332b 27
28struct cmdline_saved_param {
29 char *p, *value;
30};
31struct cmdline_saved_param_set {
32 struct cmdline_saved_param *params;
33 int nsaved, savesize;
34};
35
36/*
37 * C guarantees this structure will be initialised to all zero at
38 * program start, which is exactly what we want.
39 */
40static struct cmdline_saved_param_set saves[NPRIORITIES];
41
42static void cmdline_save_param(char *p, char *value, int pri)
43{
44 if (saves[pri].nsaved >= saves[pri].savesize) {
45 saves[pri].savesize = saves[pri].nsaved + 32;
3d88e64d 46 saves[pri].params = sresize(saves[pri].params, saves[pri].savesize,
47 struct cmdline_saved_param);
dfe3332b 48 }
49 saves[pri].params[saves[pri].nsaved].p = p;
50 saves[pri].params[saves[pri].nsaved].value = value;
51 saves[pri].nsaved++;
52}
53
679539d7 54void cmdline_cleanup(void)
55{
56 int pri;
57
58 for (pri = 0; pri < NPRIORITIES; pri++)
59 sfree(saves[pri].params);
60}
61
dfe3332b 62#define SAVEABLE(pri) do { \
63 if (need_save) { cmdline_save_param(p, value, pri); return ret; } \
64} while (0)
65
66char *cmdline_password = NULL;
67
68static int cmdline_get_line(const char *prompt, char *str,
69 int maxlen, int is_pw)
70{
71 static int tried_once = 0;
72
73 assert(is_pw && cmdline_password);
74
75 if (tried_once) {
76 return 0;
77 } else {
78 strncpy(str, cmdline_password, maxlen);
79 str[maxlen - 1] = '\0';
80 tried_once = 1;
81 return 1;
82 }
83}
84
85/*
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).
94 */
95int cmdline_tooltype = 0;
96
97static int cmdline_check_unavailable(int flag, char *p)
98{
99 if (cmdline_tooltype & flag) {
100 cmdline_error("option \"%s\" not available in this tool", p);
101 return 1;
102 }
103 return 0;
104}
105
106#define UNAVAILABLE_IN(flag) do { \
107 if (cmdline_check_unavailable(flag, p)) return ret; \
108} while (0)
109
110/*
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.
b552f500 114 * If `need_save' is 1, arguments which need to be saved as
115 * described at this top of this file are, for later execution;
116 * if 0, they are processed normally. (-1 is a special value used
117 * by pterm to count arguments for a preliminary pass through the
118 * argument list; it causes immediate return with an appropriate
119 * value with no action taken.)
dfe3332b 120 * Return value is 2 if both arguments were used; 1 if only p was
121 * used; 0 if the parameter wasn't one we recognised; -2 if it
122 * should have been 2 but value was NULL.
123 */
124
125#define RETURN(x) do { \
126 if ((x) == 2 && !value) return -2; \
127 ret = x; \
46a3419b 128 if (need_save < 0) return x; \
dfe3332b 129} while (0)
130
5555d393 131int cmdline_process_param(char *p, char *value, int need_save, Config *cfg)
dfe3332b 132{
133 int ret = 0;
134
135 if (!strcmp(p, "-load")) {
136 RETURN(2);
c725e24c 137 /* This parameter must be processed immediately rather than being
138 * saved. */
5555d393 139 do_defaults(value, cfg);
dfe3332b 140 return 2;
141 }
142 if (!strcmp(p, "-ssh")) {
143 RETURN(1);
46a3419b 144 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 145 SAVEABLE(0);
5555d393 146 default_protocol = cfg->protocol = PROT_SSH;
147 default_port = cfg->port = 22;
dfe3332b 148 return 1;
149 }
150 if (!strcmp(p, "-telnet")) {
151 RETURN(1);
46a3419b 152 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 153 SAVEABLE(0);
5555d393 154 default_protocol = cfg->protocol = PROT_TELNET;
155 default_port = cfg->port = 23;
dfe3332b 156 return 1;
157 }
158 if (!strcmp(p, "-rlogin")) {
159 RETURN(1);
46a3419b 160 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 161 SAVEABLE(0);
5555d393 162 default_protocol = cfg->protocol = PROT_RLOGIN;
163 default_port = cfg->port = 513;
dfe3332b 164 return 1;
165 }
166 if (!strcmp(p, "-raw")) {
167 RETURN(1);
46a3419b 168 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 169 SAVEABLE(0);
5555d393 170 default_protocol = cfg->protocol = PROT_RAW;
dfe3332b 171 }
172 if (!strcmp(p, "-v")) {
173 RETURN(1);
174 flags |= FLAG_VERBOSE;
175 }
176 if (!strcmp(p, "-l")) {
177 RETURN(2);
46a3419b 178 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 179 SAVEABLE(0);
5555d393 180 strncpy(cfg->username, value, sizeof(cfg->username));
181 cfg->username[sizeof(cfg->username) - 1] = '\0';
dfe3332b 182 }
820ebe3b 183 if ((!strcmp(p, "-L") || !strcmp(p, "-R") || !strcmp(p, "-D"))) {
6ee9b735 184 char *fwd, *ptr, *q, *qq;
820ebe3b 185 int dynamic, i=0;
dfe3332b 186 RETURN(2);
46a3419b 187 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 188 SAVEABLE(0);
820ebe3b 189 dynamic = !strcmp(p, "-D");
dfe3332b 190 fwd = value;
5555d393 191 ptr = cfg->portfwd;
dfe3332b 192 /* if multiple forwards, find end of list */
820ebe3b 193 if (ptr[0]=='R' || ptr[0]=='L' || ptr[0] == 'D') {
5555d393 194 for (i = 0; i < sizeof(cfg->portfwd) - 2; i++)
dfe3332b 195 if (ptr[i]=='\000' && ptr[i+1]=='\000')
196 break;
197 ptr = ptr + i + 1; /* point to next forward slot */
198 }
820ebe3b 199 ptr[0] = p[1]; /* insert a 'L', 'R' or 'D' at the start */
5555d393 200 if (strlen(fwd) > sizeof(cfg->portfwd) - i - 2) {
dfe3332b 201 cmdline_error("out of space for port forwardings");
202 return ret;
203 }
5555d393 204 strncpy(ptr+1, fwd, sizeof(cfg->portfwd) - i);
820ebe3b 205 if (!dynamic) {
206 /*
207 * We expect _at least_ two colons in this string. The
208 * possible formats are `sourceport:desthost:destport',
209 * or `sourceip:sourceport:desthost:destport' if you're
210 * specifying a particular loopback address. We need to
211 * replace the one between source and dest with a \t;
212 * this means we must find the second-to-last colon in
213 * the string.
214 */
215 q = qq = strchr(ptr, ':');
216 while (qq) {
217 char *qqq = strchr(qq+1, ':');
218 if (qqq)
219 q = qq;
220 qq = qqq;
221 }
222 if (q) *q = '\t'; /* replace second-last colon with \t */
6ee9b735 223 }
5555d393 224 cfg->portfwd[sizeof(cfg->portfwd) - 1] = '\0';
225 cfg->portfwd[sizeof(cfg->portfwd) - 2] = '\0';
dfe3332b 226 ptr[strlen(ptr)+1] = '\000'; /* append two '\000' */
227 }
228 if (!strcmp(p, "-m")) {
229 char *filename, *command;
230 int cmdlen, cmdsize;
231 FILE *fp;
232 int c, d;
233
234 RETURN(2);
46a3419b 235 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 236 SAVEABLE(0);
dfe3332b 237
238 filename = value;
239
240 cmdlen = cmdsize = 0;
241 command = NULL;
242 fp = fopen(filename, "r");
243 if (!fp) {
244 cmdline_error("unable to open command "
245 "file \"%s\"", filename);
246 return ret;
247 }
248 do {
249 c = fgetc(fp);
250 d = c;
251 if (c == EOF)
252 d = 0;
253 if (cmdlen >= cmdsize) {
254 cmdsize = cmdlen + 512;
3d88e64d 255 command = sresize(command, cmdsize, char);
dfe3332b 256 }
257 command[cmdlen++] = d;
258 } while (c != EOF);
5555d393 259 cfg->remote_cmd_ptr = command;
260 cfg->remote_cmd_ptr2 = NULL;
261 cfg->nopty = TRUE; /* command => no terminal */
dfe3332b 262 }
263 if (!strcmp(p, "-P")) {
264 RETURN(2);
46a3419b 265 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 266 SAVEABLE(1); /* lower priority than -ssh,-telnet */
5555d393 267 cfg->port = atoi(value);
dfe3332b 268 }
269 if (!strcmp(p, "-pw")) {
270 RETURN(2);
46a3419b 271 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
dfe3332b 272 cmdline_password = value;
273 ssh_get_line = cmdline_get_line;
274 ssh_getline_pw_only = TRUE;
275 }
276
277 if (!strcmp(p, "-A")) {
278 RETURN(1);
46a3419b 279 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 280 SAVEABLE(0);
5555d393 281 cfg->agentfwd = 1;
dfe3332b 282 }
283 if (!strcmp(p, "-a")) {
284 RETURN(1);
46a3419b 285 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 286 SAVEABLE(0);
5555d393 287 cfg->agentfwd = 0;
dfe3332b 288 }
289
290 if (!strcmp(p, "-X")) {
291 RETURN(1);
46a3419b 292 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 293 SAVEABLE(0);
5555d393 294 cfg->x11_forward = 1;
dfe3332b 295 }
296 if (!strcmp(p, "-x")) {
297 RETURN(1);
46a3419b 298 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 299 SAVEABLE(0);
5555d393 300 cfg->x11_forward = 0;
dfe3332b 301 }
302
303 if (!strcmp(p, "-t")) {
304 RETURN(1);
46a3419b 305 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 306 SAVEABLE(0);
5555d393 307 cfg->nopty = 0;
dfe3332b 308 }
309 if (!strcmp(p, "-T")) {
310 RETURN(1);
46a3419b 311 UNAVAILABLE_IN(TOOLTYPE_FILETRANSFER | TOOLTYPE_NONNETWORK);
c725e24c 312 SAVEABLE(0);
5555d393 313 cfg->nopty = 1;
dfe3332b 314 }
315
316 if (!strcmp(p, "-C")) {
317 RETURN(1);
46a3419b 318 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 319 SAVEABLE(0);
5555d393 320 cfg->compression = 1;
dfe3332b 321 }
322
323 if (!strcmp(p, "-1")) {
324 RETURN(1);
46a3419b 325 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 326 SAVEABLE(0);
5555d393 327 cfg->sshprot = 0; /* ssh protocol 1 only */
dfe3332b 328 }
329 if (!strcmp(p, "-2")) {
330 RETURN(1);
46a3419b 331 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 332 SAVEABLE(0);
5555d393 333 cfg->sshprot = 3; /* ssh protocol 2 only */
dfe3332b 334 }
335
336 if (!strcmp(p, "-i")) {
337 RETURN(2);
46a3419b 338 UNAVAILABLE_IN(TOOLTYPE_NONNETWORK);
c725e24c 339 SAVEABLE(0);
9a30e26b 340 cfg->keyfile = filename_from_str(value);
dfe3332b 341 }
342
343 return ret; /* unrecognised */
344}
345
5555d393 346void cmdline_run_saved(Config *cfg)
dfe3332b 347{
348 int pri, i;
349 for (pri = 0; pri < NPRIORITIES; pri++)
350 for (i = 0; i < saves[pri].nsaved; i++)
351 cmdline_process_param(saves[pri].params[i].p,
5555d393 352 saves[pri].params[i].value, 0, cfg);
dfe3332b 353}