5 * Author: Tatu Ylonen <ylo@cs.hut.fi>
7 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
10 * Created: Sat Apr 22 00:03:10 1995 ylo
12 * Functions for reading the configuration files.
26 /* Format of the configuration file:
28 # Configuration data is parsed as follows:
29 # 1. command line options
30 # 2. user-specific file
32 # Any configuration value is only changed the first time it is set.
33 # Thus, host-specific definitions should be at the beginning of the
34 # configuration file, and defaults at the end.
36 # Host-specific declarations. These may override anything above. A single
37 # host may match multiple declarations; these are processed in the order
38 # that they are given in.
44 HostName another.host.name.real.org
51 RemoteForward 9999 shadows.cs.hut.fi:9999
57 RhostsAuthentication no
58 PasswordAuthentication no
62 ProxyCommand ssh-proxy %h %p
69 PasswordAuthentication no
71 # Defaults for various options
75 RhostsAuthentication yes
76 PasswordAuthentication yes
78 RhostsRSAAuthentication yes
81 StrictHostKeyChecking yes
83 IdentityFile ~/.ssh/identity
93 oForwardAgent, oForwardX11, oGatewayPorts, oRhostsAuthentication,
94 oPasswordAuthentication, oRSAAuthentication, oFallBackToRsh, oUseRsh,
97 oKerberosAuthentication,
100 oKerberosTgtPassing, oAFSTokenPassing,
102 oIdentityFile, oHostName, oPort, oCipher, oRemoteForward, oLocalForward,
103 oUser, oHost, oEscapeChar, oRhostsRSAAuthentication, oProxyCommand,
104 oGlobalKnownHostsFile, oUserKnownHostsFile, oConnectionAttempts,
105 oBatchMode, oCheckHostIP, oStrictHostKeyChecking, oCompression,
106 oCompressionLevel, oKeepAlives, oNumberOfPasswordPrompts, oTISAuthentication,
107 oUsePrivilegedPort, oLogLevel, oCiphers, oProtocol, oIdentityFile2,
108 oGlobalKnownHostsFile2, oUserKnownHostsFile2, oDSAAuthentication
111 /* Textual representations of the tokens. */
117 { "forwardagent", oForwardAgent },
118 { "forwardx11", oForwardX11 },
119 { "gatewayports", oGatewayPorts },
120 { "useprivilegedport", oUsePrivilegedPort },
121 { "rhostsauthentication", oRhostsAuthentication },
122 { "passwordauthentication", oPasswordAuthentication },
123 { "rsaauthentication", oRSAAuthentication },
124 { "dsaauthentication", oDSAAuthentication },
125 { "skeyauthentication", oSkeyAuthentication },
127 { "kerberosauthentication", oKerberosAuthentication },
130 { "kerberostgtpassing", oKerberosTgtPassing },
131 { "afstokenpassing", oAFSTokenPassing },
133 { "fallbacktorsh", oFallBackToRsh },
134 { "usersh", oUseRsh },
135 { "identityfile", oIdentityFile },
136 { "identityfile2", oIdentityFile2 },
137 { "hostname", oHostName },
138 { "proxycommand", oProxyCommand },
140 { "cipher", oCipher },
141 { "ciphers", oCiphers },
142 { "protocol", oProtocol },
143 { "remoteforward", oRemoteForward },
144 { "localforward", oLocalForward },
147 { "escapechar", oEscapeChar },
148 { "rhostsrsaauthentication", oRhostsRSAAuthentication },
149 { "globalknownhostsfile", oGlobalKnownHostsFile },
150 { "userknownhostsfile", oUserKnownHostsFile },
151 { "globalknownhostsfile2", oGlobalKnownHostsFile2 },
152 { "userknownhostsfile2", oUserKnownHostsFile2 },
153 { "connectionattempts", oConnectionAttempts },
154 { "batchmode", oBatchMode },
155 { "checkhostip", oCheckHostIP },
156 { "stricthostkeychecking", oStrictHostKeyChecking },
157 { "compression", oCompression },
158 { "compressionlevel", oCompressionLevel },
159 { "keepalive", oKeepAlives },
160 { "numberofpasswordprompts", oNumberOfPasswordPrompts },
161 { "tisauthentication", oTISAuthentication },
162 { "loglevel", oLogLevel },
166 /* Characters considered whitespace in strtok calls. */
167 #define WHITESPACE " \t\r\n"
171 * Adds a local TCP/IP port forward to options. Never returns if there is an
176 add_local_forward(Options *options, u_short port, const char *host,
180 extern uid_t original_real_uid;
181 if (port < IPPORT_RESERVED && original_real_uid != 0)
182 fatal("Privileged ports can only be forwarded by root.\n");
183 if (options->num_local_forwards >= SSH_MAX_FORWARDS_PER_DIRECTION)
184 fatal("Too many local forwards (max %d).", SSH_MAX_FORWARDS_PER_DIRECTION);
185 fwd = &options->local_forwards[options->num_local_forwards++];
187 fwd->host = xstrdup(host);
188 fwd->host_port = host_port;
192 * Adds a remote TCP/IP port forward to options. Never returns if there is
197 add_remote_forward(Options *options, u_short port, const char *host,
201 if (options->num_remote_forwards >= SSH_MAX_FORWARDS_PER_DIRECTION)
202 fatal("Too many remote forwards (max %d).",
203 SSH_MAX_FORWARDS_PER_DIRECTION);
204 fwd = &options->remote_forwards[options->num_remote_forwards++];
206 fwd->host = xstrdup(host);
207 fwd->host_port = host_port;
211 * Returns the number of the token pointed to by cp of length len. Never
212 * returns if the token is not known.
216 parse_token(const char *cp, const char *filename, int linenum)
220 for (i = 0; keywords[i].name; i++)
221 if (strcasecmp(cp, keywords[i].name) == 0)
222 return keywords[i].opcode;
224 fprintf(stderr, "%s: line %d: Bad configuration option: %s\n",
225 filename, linenum, cp);
230 * Processes a single option line as used in the configuration files. This
231 * only sets those values that have not already been set.
235 process_config_line(Options *options, const char *host,
236 char *line, const char *filename, int linenum,
239 char buf[256], *cp, *string, **charptr, *cp2;
240 int opcode, *intptr, value;
241 u_short fwd_port, fwd_host_port;
243 /* Skip leading whitespace. */
244 cp = line + strspn(line, WHITESPACE);
245 if (!*cp || *cp == '\n' || *cp == '#')
248 /* Get the keyword. (Each line is supposed to begin with a keyword). */
249 cp = strtok(cp, WHITESPACE);
250 opcode = parse_token(cp, filename, linenum);
254 /* don't panic, but count bad options */
258 intptr = &options->forward_agent;
260 cp = strtok(NULL, WHITESPACE);
262 fatal("%.200s line %d: Missing yes/no argument.", filename, linenum);
263 value = 0; /* To avoid compiler warning... */
264 if (strcmp(cp, "yes") == 0 || strcmp(cp, "true") == 0)
266 else if (strcmp(cp, "no") == 0 || strcmp(cp, "false") == 0)
269 fatal("%.200s line %d: Bad yes/no argument.", filename, linenum);
270 if (*activep && *intptr == -1)
275 intptr = &options->forward_x11;
279 intptr = &options->gateway_ports;
282 case oUsePrivilegedPort:
283 intptr = &options->use_privileged_port;
286 case oRhostsAuthentication:
287 intptr = &options->rhosts_authentication;
290 case oPasswordAuthentication:
291 intptr = &options->password_authentication;
294 case oDSAAuthentication:
295 intptr = &options->dsa_authentication;
298 case oRSAAuthentication:
299 intptr = &options->rsa_authentication;
302 case oRhostsRSAAuthentication:
303 intptr = &options->rhosts_rsa_authentication;
306 case oTISAuthentication:
307 /* fallthrough, there is no difference on the client side */
308 case oSkeyAuthentication:
309 intptr = &options->skey_authentication;
313 case oKerberosAuthentication:
314 intptr = &options->kerberos_authentication;
319 case oKerberosTgtPassing:
320 intptr = &options->kerberos_tgt_passing;
323 case oAFSTokenPassing:
324 intptr = &options->afs_token_passing;
329 intptr = &options->fallback_to_rsh;
333 intptr = &options->use_rsh;
337 intptr = &options->batch_mode;
341 intptr = &options->check_host_ip;
344 case oStrictHostKeyChecking:
345 intptr = &options->strict_host_key_checking;
346 cp = strtok(NULL, WHITESPACE);
348 fatal("%.200s line %d: Missing yes/no argument.",
350 value = 0; /* To avoid compiler warning... */
351 if (strcmp(cp, "yes") == 0 || strcmp(cp, "true") == 0)
353 else if (strcmp(cp, "no") == 0 || strcmp(cp, "false") == 0)
355 else if (strcmp(cp, "ask") == 0)
358 fatal("%.200s line %d: Bad yes/no/ask argument.", filename, linenum);
359 if (*activep && *intptr == -1)
364 intptr = &options->compression;
368 intptr = &options->keepalives;
371 case oNumberOfPasswordPrompts:
372 intptr = &options->number_of_password_prompts;
375 case oCompressionLevel:
376 intptr = &options->compression_level;
381 cp = strtok(NULL, WHITESPACE);
383 fatal("%.200s line %d: Missing argument.", filename, linenum);
385 intptr = (opcode == oIdentityFile) ?
386 &options->num_identity_files :
387 &options->num_identity_files2;
388 if (*intptr >= SSH_MAX_IDENTITY_FILES)
389 fatal("%.200s line %d: Too many identity files specified (max %d).",
390 filename, linenum, SSH_MAX_IDENTITY_FILES);
391 charptr = (opcode == oIdentityFile) ?
392 &options->identity_files[*intptr] :
393 &options->identity_files2[*intptr];
394 *charptr = xstrdup(cp);
395 *intptr = *intptr + 1;
400 charptr = &options->user;
402 cp = strtok(NULL, WHITESPACE);
404 fatal("%.200s line %d: Missing argument.", filename, linenum);
405 if (*activep && *charptr == NULL)
406 *charptr = xstrdup(cp);
409 case oGlobalKnownHostsFile:
410 charptr = &options->system_hostfile;
413 case oUserKnownHostsFile:
414 charptr = &options->user_hostfile;
417 case oGlobalKnownHostsFile2:
418 charptr = &options->system_hostfile2;
421 case oUserKnownHostsFile2:
422 charptr = &options->user_hostfile2;
426 charptr = &options->hostname;
430 charptr = &options->proxy_command;
431 string = xstrdup("");
432 while ((cp = strtok(NULL, WHITESPACE)) != NULL) {
433 string = xrealloc(string, strlen(string) + strlen(cp) + 2);
437 if (*activep && *charptr == NULL)
444 intptr = &options->port;
446 cp = strtok(NULL, WHITESPACE);
448 fatal("%.200s line %d: Missing argument.", filename, linenum);
449 if (cp[0] < '0' || cp[0] > '9')
450 fatal("%.200s line %d: Bad number.", filename, linenum);
452 /* Octal, decimal, or hex format? */
453 value = strtol(cp, &cp2, 0);
455 fatal("%.200s line %d: Bad number.", filename, linenum);
456 if (*activep && *intptr == -1)
460 case oConnectionAttempts:
461 intptr = &options->connection_attempts;
465 intptr = &options->cipher;
466 cp = strtok(NULL, WHITESPACE);
467 value = cipher_number(cp);
469 fatal("%.200s line %d: Bad cipher '%s'.",
470 filename, linenum, cp ? cp : "<NONE>");
471 if (*activep && *intptr == -1)
476 cp = strtok(NULL, WHITESPACE);
477 if (!ciphers_valid(cp))
478 fatal("%.200s line %d: Bad SSH2 cipher spec '%s'.",
479 filename, linenum, cp ? cp : "<NONE>");
480 if (*activep && options->ciphers == NULL)
481 options->ciphers = xstrdup(cp);
485 intptr = &options->protocol;
486 cp = strtok(NULL, WHITESPACE);
487 value = proto_spec(cp);
488 if (value == SSH_PROTO_UNKNOWN)
489 fatal("%.200s line %d: Bad protocol spec '%s'.",
490 filename, linenum, cp ? cp : "<NONE>");
491 if (*activep && *intptr == SSH_PROTO_UNKNOWN)
496 intptr = (int *) &options->log_level;
497 cp = strtok(NULL, WHITESPACE);
498 value = log_level_number(cp);
499 if (value == (LogLevel) - 1)
500 fatal("%.200s line %d: unsupported log level '%s'\n",
501 filename, linenum, cp ? cp : "<NONE>");
502 if (*activep && (LogLevel) * intptr == -1)
503 *intptr = (LogLevel) value;
507 cp = strtok(NULL, WHITESPACE);
509 fatal("%.200s line %d: Missing argument.", filename, linenum);
510 if (cp[0] < '0' || cp[0] > '9')
511 fatal("%.200s line %d: Badly formatted port number.",
514 cp = strtok(NULL, WHITESPACE);
516 fatal("%.200s line %d: Missing second argument.",
518 if (sscanf(cp, "%255[^:]:%hu", buf, &fwd_host_port) != 2)
519 fatal("%.200s line %d: Badly formatted host:port.",
522 add_remote_forward(options, fwd_port, buf, fwd_host_port);
526 cp = strtok(NULL, WHITESPACE);
528 fatal("%.200s line %d: Missing argument.", filename, linenum);
529 if (cp[0] < '0' || cp[0] > '9')
530 fatal("%.200s line %d: Badly formatted port number.",
533 cp = strtok(NULL, WHITESPACE);
535 fatal("%.200s line %d: Missing second argument.",
537 if (sscanf(cp, "%255[^:]:%hu", buf, &fwd_host_port) != 2)
538 fatal("%.200s line %d: Badly formatted host:port.",
541 add_local_forward(options, fwd_port, buf, fwd_host_port);
546 while ((cp = strtok(NULL, WHITESPACE)) != NULL)
547 if (match_pattern(host, cp)) {
548 debug("Applying options for %.100s", cp);
552 /* Avoid garbage check below, as strtok already returned NULL. */
556 intptr = &options->escape_char;
557 cp = strtok(NULL, WHITESPACE);
559 fatal("%.200s line %d: Missing argument.", filename, linenum);
560 if (cp[0] == '^' && cp[2] == 0 &&
561 (unsigned char) cp[1] >= 64 && (unsigned char) cp[1] < 128)
562 value = (unsigned char) cp[1] & 31;
563 else if (strlen(cp) == 1)
564 value = (unsigned char) cp[0];
565 else if (strcmp(cp, "none") == 0)
568 fatal("%.200s line %d: Bad escape character.",
571 value = 0; /* Avoid compiler warning. */
573 if (*activep && *intptr == -1)
578 fatal("process_config_line: Unimplemented opcode %d", opcode);
581 /* Check that there is no garbage at end of line. */
582 if (strtok(NULL, WHITESPACE) != NULL)
583 fatal("%.200s line %d: garbage at end of line.",
590 * Reads the config file and modifies the options accordingly. Options
591 * should already be initialized before this call. This never returns if
592 * there is an error. If the file does not exist, this returns immediately.
596 read_config_file(const char *filename, const char *host, Options *options)
604 f = fopen(filename, "r");
608 debug("Reading configuration data %.200s", filename);
611 * Mark that we are now processing the options. This flag is turned
612 * on/off by Host specifications.
616 while (fgets(line, sizeof(line), f)) {
617 /* Update line number counter. */
619 if (process_config_line(options, host, line, filename, linenum, &active) != 0)
624 fatal("%s: terminating, %d bad configuration options\n",
625 filename, bad_options);
629 * Initializes options to special values that indicate that they have not yet
630 * been set. Read_config_file will only set options with this value. Options
631 * are processed in the following order: command line, user config file,
632 * system config file. Last, fill_default_options is called.
636 initialize_options(Options * options)
638 memset(options, 'X', sizeof(*options));
639 options->forward_agent = -1;
640 options->forward_x11 = -1;
641 options->gateway_ports = -1;
642 options->use_privileged_port = -1;
643 options->rhosts_authentication = -1;
644 options->rsa_authentication = -1;
645 options->dsa_authentication = -1;
646 options->skey_authentication = -1;
648 options->kerberos_authentication = -1;
651 options->kerberos_tgt_passing = -1;
652 options->afs_token_passing = -1;
654 options->password_authentication = -1;
655 options->rhosts_rsa_authentication = -1;
656 options->fallback_to_rsh = -1;
657 options->use_rsh = -1;
658 options->batch_mode = -1;
659 options->check_host_ip = -1;
660 options->strict_host_key_checking = -1;
661 options->compression = -1;
662 options->keepalives = -1;
663 options->compression_level = -1;
665 options->connection_attempts = -1;
666 options->number_of_password_prompts = -1;
667 options->cipher = -1;
668 options->ciphers = NULL;
669 options->protocol = SSH_PROTO_UNKNOWN;
670 options->num_identity_files = 0;
671 options->num_identity_files2 = 0;
672 options->hostname = NULL;
673 options->proxy_command = NULL;
674 options->user = NULL;
675 options->escape_char = -1;
676 options->system_hostfile = NULL;
677 options->user_hostfile = NULL;
678 options->system_hostfile2 = NULL;
679 options->user_hostfile2 = NULL;
680 options->num_local_forwards = 0;
681 options->num_remote_forwards = 0;
682 options->log_level = (LogLevel) - 1;
686 * Called after processing other sources of option data, this fills those
687 * options for which no value has been specified with their default values.
691 fill_default_options(Options * options)
693 if (options->forward_agent == -1)
694 options->forward_agent = 1;
695 if (options->forward_x11 == -1)
696 options->forward_x11 = 0;
697 if (options->gateway_ports == -1)
698 options->gateway_ports = 0;
699 if (options->use_privileged_port == -1)
700 options->use_privileged_port = 1;
701 if (options->rhosts_authentication == -1)
702 options->rhosts_authentication = 1;
703 if (options->rsa_authentication == -1)
704 options->rsa_authentication = 1;
705 if (options->dsa_authentication == -1)
706 options->dsa_authentication = 1;
707 if (options->skey_authentication == -1)
708 options->skey_authentication = 0;
710 if (options->kerberos_authentication == -1)
711 options->kerberos_authentication = 1;
714 if (options->kerberos_tgt_passing == -1)
715 options->kerberos_tgt_passing = 1;
716 if (options->afs_token_passing == -1)
717 options->afs_token_passing = 1;
719 if (options->password_authentication == -1)
720 options->password_authentication = 1;
721 if (options->rhosts_rsa_authentication == -1)
722 options->rhosts_rsa_authentication = 1;
723 if (options->fallback_to_rsh == -1)
724 options->fallback_to_rsh = 1;
725 if (options->use_rsh == -1)
726 options->use_rsh = 0;
727 if (options->batch_mode == -1)
728 options->batch_mode = 0;
729 if (options->check_host_ip == -1)
730 options->check_host_ip = 1;
731 if (options->strict_host_key_checking == -1)
732 options->strict_host_key_checking = 2; /* 2 is default */
733 if (options->compression == -1)
734 options->compression = 0;
735 if (options->keepalives == -1)
736 options->keepalives = 1;
737 if (options->compression_level == -1)
738 options->compression_level = 6;
739 if (options->port == -1)
740 options->port = 0; /* Filled in ssh_connect. */
741 if (options->connection_attempts == -1)
742 options->connection_attempts = 4;
743 if (options->number_of_password_prompts == -1)
744 options->number_of_password_prompts = 3;
745 /* Selected in ssh_login(). */
746 if (options->cipher == -1)
747 options->cipher = SSH_CIPHER_NOT_SET;
748 /* options->ciphers, default set in myproposals.h */
749 if (options->protocol == SSH_PROTO_UNKNOWN)
750 options->protocol = SSH_PROTO_1|SSH_PROTO_2|SSH_PROTO_1_PREFERRED;
751 if (options->num_identity_files == 0) {
752 options->identity_files[0] =
753 xmalloc(2 + strlen(SSH_CLIENT_IDENTITY) + 1);
754 sprintf(options->identity_files[0], "~/%.100s", SSH_CLIENT_IDENTITY);
755 options->num_identity_files = 1;
757 if (options->num_identity_files2 == 0) {
758 options->identity_files2[0] =
759 xmalloc(2 + strlen(SSH_CLIENT_ID_DSA) + 1);
760 sprintf(options->identity_files2[0], "~/%.100s", SSH_CLIENT_ID_DSA);
761 options->num_identity_files2 = 1;
763 if (options->escape_char == -1)
764 options->escape_char = '~';
765 if (options->system_hostfile == NULL)
766 options->system_hostfile = SSH_SYSTEM_HOSTFILE;
767 if (options->user_hostfile == NULL)
768 options->user_hostfile = SSH_USER_HOSTFILE;
769 if (options->system_hostfile2 == NULL)
770 options->system_hostfile2 = SSH_SYSTEM_HOSTFILE2;
771 if (options->user_hostfile2 == NULL)
772 options->user_hostfile2 = SSH_USER_HOSTFILE2;
773 if (options->log_level == (LogLevel) - 1)
774 options->log_level = SYSLOG_LEVEL_INFO;
775 /* options->proxy_command should not be set by default */
776 /* options->user will be set in the main program if appropriate */
777 /* options->hostname will be set in the main program if appropriate */