1 /* $OpenBSD: readconf.c,v 1.179 2009/10/28 16:38:18 reyk Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * Functions for reading the configuration files.
8 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
17 #include <sys/types.h>
19 #include <sys/socket.h>
21 #include <netinet/in.h>
36 #include "pathnames.h"
46 /* Format of the configuration file:
48 # Configuration data is parsed as follows:
49 # 1. command line options
50 # 2. user-specific file
52 # Any configuration value is only changed the first time it is set.
53 # Thus, host-specific definitions should be at the beginning of the
54 # configuration file, and defaults at the end.
56 # Host-specific declarations. These may override anything above. A single
57 # host may match multiple declarations; these are processed in the order
58 # that they are given in.
64 HostName another.host.name.real.org
71 RemoteForward 9999 shadows.cs.hut.fi:9999
77 PasswordAuthentication no
81 ProxyCommand ssh-proxy %h %p
84 PublicKeyAuthentication no
88 PasswordAuthentication no
94 # Defaults for various options
98 PasswordAuthentication yes
100 RhostsRSAAuthentication yes
101 StrictHostKeyChecking yes
103 IdentityFile ~/.ssh/identity
109 /* Keyword tokens. */
113 oForwardAgent
, oForwardX11
, oForwardX11Trusted
, oGatewayPorts
,
114 oExitOnForwardFailure
,
115 oPasswordAuthentication
, oRSAAuthentication
,
116 oChallengeResponseAuthentication
, oXAuthLocation
,
117 oIdentityFile
, oHostName
, oPort
, oCipher
, oRemoteForward
, oLocalForward
,
118 oUser
, oHost
, oEscapeChar
, oRhostsRSAAuthentication
, oProxyCommand
,
119 oGlobalKnownHostsFile
, oUserKnownHostsFile
, oConnectionAttempts
,
120 oBatchMode
, oCheckHostIP
, oStrictHostKeyChecking
, oCompression
,
121 oCompressionLevel
, oTCPKeepAlive
, oNumberOfPasswordPrompts
,
122 oUsePrivilegedPort
, oLogLevel
, oCiphers
, oProtocol
, oMacs
,
123 oGlobalKnownHostsFile2
, oUserKnownHostsFile2
, oPubkeyAuthentication
,
124 oKbdInteractiveAuthentication
, oKbdInteractiveDevices
, oHostKeyAlias
,
125 oDynamicForward
, oPreferredAuthentications
, oHostbasedAuthentication
,
126 oHostKeyAlgorithms
, oBindAddress
, oSmartcardDevice
,
127 oClearAllForwardings
, oNoHostAuthenticationForLocalhost
,
128 oEnableSSHKeysign
, oRekeyLimit
, oVerifyHostKeyDNS
, oConnectTimeout
,
129 oAddressFamily
, oGssAuthentication
, oGssDelegateCreds
,
130 oServerAliveInterval
, oServerAliveCountMax
, oIdentitiesOnly
,
131 oSendEnv
, oControlPath
, oControlMaster
, oHashKnownHosts
,
132 oTunnel
, oTunnelDevice
, oLocalCommand
, oPermitLocalCommand
,
133 oVisualHostKey
, oUseRoaming
, oRDomain
,
134 oZeroKnowledgePasswordAuthentication
, oDeprecated
, oUnsupported
137 /* Textual representations of the tokens. */
143 { "forwardagent", oForwardAgent
},
144 { "forwardx11", oForwardX11
},
145 { "forwardx11trusted", oForwardX11Trusted
},
146 { "exitonforwardfailure", oExitOnForwardFailure
},
147 { "xauthlocation", oXAuthLocation
},
148 { "gatewayports", oGatewayPorts
},
149 { "useprivilegedport", oUsePrivilegedPort
},
150 { "rhostsauthentication", oDeprecated
},
151 { "passwordauthentication", oPasswordAuthentication
},
152 { "kbdinteractiveauthentication", oKbdInteractiveAuthentication
},
153 { "kbdinteractivedevices", oKbdInteractiveDevices
},
154 { "rsaauthentication", oRSAAuthentication
},
155 { "pubkeyauthentication", oPubkeyAuthentication
},
156 { "dsaauthentication", oPubkeyAuthentication
}, /* alias */
157 { "rhostsrsaauthentication", oRhostsRSAAuthentication
},
158 { "hostbasedauthentication", oHostbasedAuthentication
},
159 { "challengeresponseauthentication", oChallengeResponseAuthentication
},
160 { "skeyauthentication", oChallengeResponseAuthentication
}, /* alias */
161 { "tisauthentication", oChallengeResponseAuthentication
}, /* alias */
162 { "kerberosauthentication", oUnsupported
},
163 { "kerberostgtpassing", oUnsupported
},
164 { "afstokenpassing", oUnsupported
},
166 { "gssapiauthentication", oGssAuthentication
},
167 { "gssapidelegatecredentials", oGssDelegateCreds
},
169 { "gssapiauthentication", oUnsupported
},
170 { "gssapidelegatecredentials", oUnsupported
},
172 { "fallbacktorsh", oDeprecated
},
173 { "usersh", oDeprecated
},
174 { "identityfile", oIdentityFile
},
175 { "identityfile2", oIdentityFile
}, /* obsolete */
176 { "identitiesonly", oIdentitiesOnly
},
177 { "hostname", oHostName
},
178 { "hostkeyalias", oHostKeyAlias
},
179 { "proxycommand", oProxyCommand
},
181 { "cipher", oCipher
},
182 { "ciphers", oCiphers
},
184 { "protocol", oProtocol
},
185 { "remoteforward", oRemoteForward
},
186 { "localforward", oLocalForward
},
189 { "escapechar", oEscapeChar
},
190 { "globalknownhostsfile", oGlobalKnownHostsFile
},
191 { "globalknownhostsfile2", oGlobalKnownHostsFile2
}, /* obsolete */
192 { "userknownhostsfile", oUserKnownHostsFile
},
193 { "userknownhostsfile2", oUserKnownHostsFile2
}, /* obsolete */
194 { "connectionattempts", oConnectionAttempts
},
195 { "batchmode", oBatchMode
},
196 { "checkhostip", oCheckHostIP
},
197 { "stricthostkeychecking", oStrictHostKeyChecking
},
198 { "compression", oCompression
},
199 { "compressionlevel", oCompressionLevel
},
200 { "tcpkeepalive", oTCPKeepAlive
},
201 { "keepalive", oTCPKeepAlive
}, /* obsolete */
202 { "numberofpasswordprompts", oNumberOfPasswordPrompts
},
203 { "loglevel", oLogLevel
},
204 { "dynamicforward", oDynamicForward
},
205 { "preferredauthentications", oPreferredAuthentications
},
206 { "hostkeyalgorithms", oHostKeyAlgorithms
},
207 { "bindaddress", oBindAddress
},
209 { "smartcarddevice", oSmartcardDevice
},
211 { "smartcarddevice", oUnsupported
},
213 { "clearallforwardings", oClearAllForwardings
},
214 { "enablesshkeysign", oEnableSSHKeysign
},
215 { "verifyhostkeydns", oVerifyHostKeyDNS
},
216 { "nohostauthenticationforlocalhost", oNoHostAuthenticationForLocalhost
},
217 { "rekeylimit", oRekeyLimit
},
218 { "connecttimeout", oConnectTimeout
},
219 { "addressfamily", oAddressFamily
},
220 { "serveraliveinterval", oServerAliveInterval
},
221 { "serveralivecountmax", oServerAliveCountMax
},
222 { "sendenv", oSendEnv
},
223 { "controlpath", oControlPath
},
224 { "controlmaster", oControlMaster
},
225 { "hashknownhosts", oHashKnownHosts
},
226 { "tunnel", oTunnel
},
227 { "tunneldevice", oTunnelDevice
},
228 { "localcommand", oLocalCommand
},
229 { "permitlocalcommand", oPermitLocalCommand
},
230 { "visualhostkey", oVisualHostKey
},
231 { "useroaming", oUseRoaming
},
232 { "rdomain", oRDomain
},
234 { "zeroknowledgepasswordauthentication",
235 oZeroKnowledgePasswordAuthentication
},
237 { "zeroknowledgepasswordauthentication", oUnsupported
},
244 * Adds a local TCP/IP port forward to options. Never returns if there is an
249 add_local_forward(Options
*options
, const Forward
*newfwd
)
252 #ifndef NO_IPPORT_RESERVED_CONCEPT
253 extern uid_t original_real_uid
;
254 if (newfwd
->listen_port
< IPPORT_RESERVED
&& original_real_uid
!= 0)
255 fatal("Privileged ports can only be forwarded by root.");
257 if (options
->num_local_forwards
>= SSH_MAX_FORWARDS_PER_DIRECTION
)
258 fatal("Too many local forwards (max %d).", SSH_MAX_FORWARDS_PER_DIRECTION
);
259 fwd
= &options
->local_forwards
[options
->num_local_forwards
++];
261 fwd
->listen_host
= newfwd
->listen_host
;
262 fwd
->listen_port
= newfwd
->listen_port
;
263 fwd
->connect_host
= newfwd
->connect_host
;
264 fwd
->connect_port
= newfwd
->connect_port
;
268 * Adds a remote TCP/IP port forward to options. Never returns if there is
273 add_remote_forward(Options
*options
, const Forward
*newfwd
)
276 if (options
->num_remote_forwards
>= SSH_MAX_FORWARDS_PER_DIRECTION
)
277 fatal("Too many remote forwards (max %d).",
278 SSH_MAX_FORWARDS_PER_DIRECTION
);
279 fwd
= &options
->remote_forwards
[options
->num_remote_forwards
++];
281 fwd
->listen_host
= newfwd
->listen_host
;
282 fwd
->listen_port
= newfwd
->listen_port
;
283 fwd
->connect_host
= newfwd
->connect_host
;
284 fwd
->connect_port
= newfwd
->connect_port
;
288 clear_forwardings(Options
*options
)
292 for (i
= 0; i
< options
->num_local_forwards
; i
++) {
293 if (options
->local_forwards
[i
].listen_host
!= NULL
)
294 xfree(options
->local_forwards
[i
].listen_host
);
295 xfree(options
->local_forwards
[i
].connect_host
);
297 options
->num_local_forwards
= 0;
298 for (i
= 0; i
< options
->num_remote_forwards
; i
++) {
299 if (options
->remote_forwards
[i
].listen_host
!= NULL
)
300 xfree(options
->remote_forwards
[i
].listen_host
);
301 xfree(options
->remote_forwards
[i
].connect_host
);
303 options
->num_remote_forwards
= 0;
304 options
->tun_open
= SSH_TUNMODE_NO
;
308 * Returns the number of the token pointed to by cp or oBadOption.
312 parse_token(const char *cp
, const char *filename
, int linenum
)
316 for (i
= 0; keywords
[i
].name
; i
++)
317 if (strcasecmp(cp
, keywords
[i
].name
) == 0)
318 return keywords
[i
].opcode
;
320 error("%s: line %d: Bad configuration option: %s",
321 filename
, linenum
, cp
);
326 * Processes a single option line as used in the configuration files. This
327 * only sets those values that have not already been set.
329 #define WHITESPACE " \t\r\n"
332 process_config_line(Options
*options
, const char *host
,
333 char *line
, const char *filename
, int linenum
,
336 char *s
, **charptr
, *endofnumber
, *keyword
, *arg
, *arg2
, fwdarg
[256];
337 int opcode
, *intptr
, value
, value2
, scale
;
338 LogLevel
*log_level_ptr
;
339 long long orig
, val64
;
343 /* Strip trailing whitespace */
344 for (len
= strlen(line
) - 1; len
> 0; len
--) {
345 if (strchr(WHITESPACE
, line
[len
]) == NULL
)
351 /* Get the keyword. (Each line is supposed to begin with a keyword). */
352 if ((keyword
= strdelim(&s
)) == NULL
)
354 /* Ignore leading whitespace. */
355 if (*keyword
== '\0')
356 keyword
= strdelim(&s
);
357 if (keyword
== NULL
|| !*keyword
|| *keyword
== '\n' || *keyword
== '#')
360 opcode
= parse_token(keyword
, filename
, linenum
);
364 /* don't panic, but count bad options */
367 case oConnectTimeout
:
368 intptr
= &options
->connection_timeout
;
371 if (!arg
|| *arg
== '\0')
372 fatal("%s line %d: missing time value.",
374 if ((value
= convtime(arg
)) == -1)
375 fatal("%s line %d: invalid time value.",
377 if (*activep
&& *intptr
== -1)
382 intptr
= &options
->forward_agent
;
385 if (!arg
|| *arg
== '\0')
386 fatal("%.200s line %d: Missing yes/no argument.", filename
, linenum
);
387 value
= 0; /* To avoid compiler warning... */
388 if (strcmp(arg
, "yes") == 0 || strcmp(arg
, "true") == 0)
390 else if (strcmp(arg
, "no") == 0 || strcmp(arg
, "false") == 0)
393 fatal("%.200s line %d: Bad yes/no argument.", filename
, linenum
);
394 if (*activep
&& *intptr
== -1)
399 intptr
= &options
->forward_x11
;
402 case oForwardX11Trusted
:
403 intptr
= &options
->forward_x11_trusted
;
407 intptr
= &options
->gateway_ports
;
410 case oExitOnForwardFailure
:
411 intptr
= &options
->exit_on_forward_failure
;
414 case oUsePrivilegedPort
:
415 intptr
= &options
->use_privileged_port
;
418 case oPasswordAuthentication
:
419 intptr
= &options
->password_authentication
;
422 case oZeroKnowledgePasswordAuthentication
:
423 intptr
= &options
->zero_knowledge_password_authentication
;
426 case oKbdInteractiveAuthentication
:
427 intptr
= &options
->kbd_interactive_authentication
;
430 case oKbdInteractiveDevices
:
431 charptr
= &options
->kbd_interactive_devices
;
434 case oPubkeyAuthentication
:
435 intptr
= &options
->pubkey_authentication
;
438 case oRSAAuthentication
:
439 intptr
= &options
->rsa_authentication
;
442 case oRhostsRSAAuthentication
:
443 intptr
= &options
->rhosts_rsa_authentication
;
446 case oHostbasedAuthentication
:
447 intptr
= &options
->hostbased_authentication
;
450 case oChallengeResponseAuthentication
:
451 intptr
= &options
->challenge_response_authentication
;
454 case oGssAuthentication
:
455 intptr
= &options
->gss_authentication
;
458 case oGssDelegateCreds
:
459 intptr
= &options
->gss_deleg_creds
;
463 intptr
= &options
->batch_mode
;
467 intptr
= &options
->check_host_ip
;
470 case oVerifyHostKeyDNS
:
471 intptr
= &options
->verify_host_key_dns
;
474 case oStrictHostKeyChecking
:
475 intptr
= &options
->strict_host_key_checking
;
478 if (!arg
|| *arg
== '\0')
479 fatal("%.200s line %d: Missing yes/no/ask argument.",
481 value
= 0; /* To avoid compiler warning... */
482 if (strcmp(arg
, "yes") == 0 || strcmp(arg
, "true") == 0)
484 else if (strcmp(arg
, "no") == 0 || strcmp(arg
, "false") == 0)
486 else if (strcmp(arg
, "ask") == 0)
489 fatal("%.200s line %d: Bad yes/no/ask argument.", filename
, linenum
);
490 if (*activep
&& *intptr
== -1)
495 intptr
= &options
->compression
;
499 intptr
= &options
->tcp_keep_alive
;
502 case oNoHostAuthenticationForLocalhost
:
503 intptr
= &options
->no_host_authentication_for_localhost
;
506 case oNumberOfPasswordPrompts
:
507 intptr
= &options
->number_of_password_prompts
;
510 case oCompressionLevel
:
511 intptr
= &options
->compression_level
;
516 if (!arg
|| *arg
== '\0')
517 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
518 if (arg
[0] < '0' || arg
[0] > '9')
519 fatal("%.200s line %d: Bad number.", filename
, linenum
);
520 orig
= val64
= strtoll(arg
, &endofnumber
, 10);
521 if (arg
== endofnumber
)
522 fatal("%.200s line %d: Bad number.", filename
, linenum
);
523 switch (toupper(*endofnumber
)) {
537 fatal("%.200s line %d: Invalid RekeyLimit suffix",
541 /* detect integer wrap and too-large limits */
542 if ((val64
/ scale
) != orig
|| val64
> UINT_MAX
)
543 fatal("%.200s line %d: RekeyLimit too large",
546 fatal("%.200s line %d: RekeyLimit too small",
548 if (*activep
&& options
->rekey_limit
== -1)
549 options
->rekey_limit
= (u_int32_t
)val64
;
554 if (!arg
|| *arg
== '\0')
555 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
557 intptr
= &options
->num_identity_files
;
558 if (*intptr
>= SSH_MAX_IDENTITY_FILES
)
559 fatal("%.200s line %d: Too many identity files specified (max %d).",
560 filename
, linenum
, SSH_MAX_IDENTITY_FILES
);
561 charptr
= &options
->identity_files
[*intptr
];
562 *charptr
= xstrdup(arg
);
563 *intptr
= *intptr
+ 1;
568 charptr
=&options
->xauth_location
;
572 charptr
= &options
->user
;
575 if (!arg
|| *arg
== '\0')
576 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
577 if (*activep
&& *charptr
== NULL
)
578 *charptr
= xstrdup(arg
);
581 case oGlobalKnownHostsFile
:
582 charptr
= &options
->system_hostfile
;
585 case oUserKnownHostsFile
:
586 charptr
= &options
->user_hostfile
;
589 case oGlobalKnownHostsFile2
:
590 charptr
= &options
->system_hostfile2
;
593 case oUserKnownHostsFile2
:
594 charptr
= &options
->user_hostfile2
;
598 charptr
= &options
->hostname
;
602 charptr
= &options
->host_key_alias
;
605 case oPreferredAuthentications
:
606 charptr
= &options
->preferred_authentications
;
610 charptr
= &options
->bind_address
;
613 case oSmartcardDevice
:
614 charptr
= &options
->smartcard_device
;
618 charptr
= &options
->proxy_command
;
621 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
622 len
= strspn(s
, WHITESPACE
"=");
623 if (*activep
&& *charptr
== NULL
)
624 *charptr
= xstrdup(s
+ len
);
628 intptr
= &options
->port
;
631 if (!arg
|| *arg
== '\0')
632 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
633 if (arg
[0] < '0' || arg
[0] > '9')
634 fatal("%.200s line %d: Bad number.", filename
, linenum
);
636 /* Octal, decimal, or hex format? */
637 value
= strtol(arg
, &endofnumber
, 0);
638 if (arg
== endofnumber
)
639 fatal("%.200s line %d: Bad number.", filename
, linenum
);
640 if (*activep
&& *intptr
== -1)
644 case oConnectionAttempts
:
645 intptr
= &options
->connection_attempts
;
649 intptr
= &options
->cipher
;
651 if (!arg
|| *arg
== '\0')
652 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
653 value
= cipher_number(arg
);
655 fatal("%.200s line %d: Bad cipher '%s'.",
656 filename
, linenum
, arg
? arg
: "<NONE>");
657 if (*activep
&& *intptr
== -1)
663 if (!arg
|| *arg
== '\0')
664 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
665 if (!ciphers_valid(arg
))
666 fatal("%.200s line %d: Bad SSH2 cipher spec '%s'.",
667 filename
, linenum
, arg
? arg
: "<NONE>");
668 if (*activep
&& options
->ciphers
== NULL
)
669 options
->ciphers
= xstrdup(arg
);
674 if (!arg
|| *arg
== '\0')
675 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
677 fatal("%.200s line %d: Bad SSH2 Mac spec '%s'.",
678 filename
, linenum
, arg
? arg
: "<NONE>");
679 if (*activep
&& options
->macs
== NULL
)
680 options
->macs
= xstrdup(arg
);
683 case oHostKeyAlgorithms
:
685 if (!arg
|| *arg
== '\0')
686 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
687 if (!key_names_valid2(arg
))
688 fatal("%.200s line %d: Bad protocol 2 host key algorithms '%s'.",
689 filename
, linenum
, arg
? arg
: "<NONE>");
690 if (*activep
&& options
->hostkeyalgorithms
== NULL
)
691 options
->hostkeyalgorithms
= xstrdup(arg
);
695 intptr
= &options
->protocol
;
697 if (!arg
|| *arg
== '\0')
698 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
699 value
= proto_spec(arg
);
700 if (value
== SSH_PROTO_UNKNOWN
)
701 fatal("%.200s line %d: Bad protocol spec '%s'.",
702 filename
, linenum
, arg
? arg
: "<NONE>");
703 if (*activep
&& *intptr
== SSH_PROTO_UNKNOWN
)
708 log_level_ptr
= &options
->log_level
;
710 value
= log_level_number(arg
);
711 if (value
== SYSLOG_LEVEL_NOT_SET
)
712 fatal("%.200s line %d: unsupported log level '%s'",
713 filename
, linenum
, arg
? arg
: "<NONE>");
714 if (*activep
&& *log_level_ptr
== SYSLOG_LEVEL_NOT_SET
)
715 *log_level_ptr
= (LogLevel
) value
;
720 case oDynamicForward
:
722 if (arg
== NULL
|| *arg
== '\0')
723 fatal("%.200s line %d: Missing port argument.",
726 if (opcode
== oLocalForward
||
727 opcode
== oRemoteForward
) {
729 if (arg2
== NULL
|| *arg2
== '\0')
730 fatal("%.200s line %d: Missing target argument.",
733 /* construct a string for parse_forward */
734 snprintf(fwdarg
, sizeof(fwdarg
), "%s:%s", arg
, arg2
);
735 } else if (opcode
== oDynamicForward
) {
736 strlcpy(fwdarg
, arg
, sizeof(fwdarg
));
739 if (parse_forward(&fwd
, fwdarg
,
740 opcode
== oDynamicForward
? 1 : 0,
741 opcode
== oRemoteForward
? 1 : 0) == 0)
742 fatal("%.200s line %d: Bad forwarding specification.",
746 if (opcode
== oLocalForward
||
747 opcode
== oDynamicForward
)
748 add_local_forward(options
, &fwd
);
749 else if (opcode
== oRemoteForward
)
750 add_remote_forward(options
, &fwd
);
754 case oClearAllForwardings
:
755 intptr
= &options
->clear_forwardings
;
760 while ((arg
= strdelim(&s
)) != NULL
&& *arg
!= '\0')
761 if (match_pattern(host
, arg
)) {
762 debug("Applying options for %.100s", arg
);
766 /* Avoid garbage check below, as strdelim is done. */
770 intptr
= &options
->escape_char
;
772 if (!arg
|| *arg
== '\0')
773 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
774 if (arg
[0] == '^' && arg
[2] == 0 &&
775 (u_char
) arg
[1] >= 64 && (u_char
) arg
[1] < 128)
776 value
= (u_char
) arg
[1] & 31;
777 else if (strlen(arg
) == 1)
778 value
= (u_char
) arg
[0];
779 else if (strcmp(arg
, "none") == 0)
780 value
= SSH_ESCAPECHAR_NONE
;
782 fatal("%.200s line %d: Bad escape character.",
785 value
= 0; /* Avoid compiler warning. */
787 if (*activep
&& *intptr
== -1)
793 if (!arg
|| *arg
== '\0')
794 fatal("%s line %d: missing address family.",
796 intptr
= &options
->address_family
;
797 if (strcasecmp(arg
, "inet") == 0)
799 else if (strcasecmp(arg
, "inet6") == 0)
801 else if (strcasecmp(arg
, "any") == 0)
804 fatal("Unsupported AddressFamily \"%s\"", arg
);
805 if (*activep
&& *intptr
== -1)
809 case oEnableSSHKeysign
:
810 intptr
= &options
->enable_ssh_keysign
;
813 case oIdentitiesOnly
:
814 intptr
= &options
->identities_only
;
817 case oServerAliveInterval
:
818 intptr
= &options
->server_alive_interval
;
821 case oServerAliveCountMax
:
822 intptr
= &options
->server_alive_count_max
;
826 while ((arg
= strdelim(&s
)) != NULL
&& *arg
!= '\0') {
827 if (strchr(arg
, '=') != NULL
)
828 fatal("%s line %d: Invalid environment name.",
832 if (options
->num_send_env
>= MAX_SEND_ENV
)
833 fatal("%s line %d: too many send env.",
835 options
->send_env
[options
->num_send_env
++] =
841 charptr
= &options
->control_path
;
845 intptr
= &options
->control_master
;
847 if (!arg
|| *arg
== '\0')
848 fatal("%.200s line %d: Missing ControlMaster argument.",
850 value
= 0; /* To avoid compiler warning... */
851 if (strcmp(arg
, "yes") == 0 || strcmp(arg
, "true") == 0)
852 value
= SSHCTL_MASTER_YES
;
853 else if (strcmp(arg
, "no") == 0 || strcmp(arg
, "false") == 0)
854 value
= SSHCTL_MASTER_NO
;
855 else if (strcmp(arg
, "auto") == 0)
856 value
= SSHCTL_MASTER_AUTO
;
857 else if (strcmp(arg
, "ask") == 0)
858 value
= SSHCTL_MASTER_ASK
;
859 else if (strcmp(arg
, "autoask") == 0)
860 value
= SSHCTL_MASTER_AUTO_ASK
;
862 fatal("%.200s line %d: Bad ControlMaster argument.",
864 if (*activep
&& *intptr
== -1)
868 case oHashKnownHosts
:
869 intptr
= &options
->hash_known_hosts
;
873 intptr
= &options
->tun_open
;
875 if (!arg
|| *arg
== '\0')
876 fatal("%s line %d: Missing yes/point-to-point/"
877 "ethernet/no argument.", filename
, linenum
);
878 value
= 0; /* silence compiler */
879 if (strcasecmp(arg
, "ethernet") == 0)
880 value
= SSH_TUNMODE_ETHERNET
;
881 else if (strcasecmp(arg
, "point-to-point") == 0)
882 value
= SSH_TUNMODE_POINTOPOINT
;
883 else if (strcasecmp(arg
, "yes") == 0)
884 value
= SSH_TUNMODE_DEFAULT
;
885 else if (strcasecmp(arg
, "no") == 0)
886 value
= SSH_TUNMODE_NO
;
888 fatal("%s line %d: Bad yes/point-to-point/ethernet/"
889 "no argument: %s", filename
, linenum
, arg
);
896 if (!arg
|| *arg
== '\0')
897 fatal("%.200s line %d: Missing argument.", filename
, linenum
);
898 value
= a2tun(arg
, &value2
);
899 if (value
== SSH_TUNID_ERR
)
900 fatal("%.200s line %d: Bad tun device.", filename
, linenum
);
902 options
->tun_local
= value
;
903 options
->tun_remote
= value2
;
908 charptr
= &options
->local_command
;
911 case oPermitLocalCommand
:
912 intptr
= &options
->permit_local_command
;
916 intptr
= &options
->visual_host_key
;
920 intptr
= &options
->use_roaming
;
925 if (!arg
|| *arg
== '\0')
926 fatal("%.200s line %d: Missing argument.",
930 fatal("%.200s line %d: Bad rdomain.",
933 options
->rdomain
= value
;
937 debug("%s line %d: Deprecated option \"%s\"",
938 filename
, linenum
, keyword
);
942 error("%s line %d: Unsupported option \"%s\"",
943 filename
, linenum
, keyword
);
947 fatal("process_config_line: Unimplemented opcode %d", opcode
);
950 /* Check that there is no garbage at end of line. */
951 if ((arg
= strdelim(&s
)) != NULL
&& *arg
!= '\0') {
952 fatal("%.200s line %d: garbage at end of line; \"%.200s\".",
953 filename
, linenum
, arg
);
960 * Reads the config file and modifies the options accordingly. Options
961 * should already be initialized before this call. This never returns if
962 * there is an error. If the file does not exist, this returns 0.
966 read_config_file(const char *filename
, const char *host
, Options
*options
,
974 if ((f
= fopen(filename
, "r")) == NULL
)
980 if (fstat(fileno(f
), &sb
) == -1)
981 fatal("fstat %s: %s", filename
, strerror(errno
));
982 if (((sb
.st_uid
!= 0 && sb
.st_uid
!= getuid()) ||
983 (sb
.st_mode
& 022) != 0))
984 fatal("Bad owner or permissions on %s", filename
);
987 debug("Reading configuration data %.200s", filename
);
990 * Mark that we are now processing the options. This flag is turned
991 * on/off by Host specifications.
995 while (fgets(line
, sizeof(line
), f
)) {
996 /* Update line number counter. */
998 if (process_config_line(options
, host
, line
, filename
, linenum
, &active
) != 0)
1002 if (bad_options
> 0)
1003 fatal("%s: terminating, %d bad configuration options",
1004 filename
, bad_options
);
1009 * Initializes options to special values that indicate that they have not yet
1010 * been set. Read_config_file will only set options with this value. Options
1011 * are processed in the following order: command line, user config file,
1012 * system config file. Last, fill_default_options is called.
1016 initialize_options(Options
* options
)
1018 memset(options
, 'X', sizeof(*options
));
1019 options
->forward_agent
= -1;
1020 options
->forward_x11
= -1;
1021 options
->forward_x11_trusted
= -1;
1022 options
->exit_on_forward_failure
= -1;
1023 options
->xauth_location
= NULL
;
1024 options
->gateway_ports
= -1;
1025 options
->use_privileged_port
= -1;
1026 options
->rsa_authentication
= -1;
1027 options
->pubkey_authentication
= -1;
1028 options
->challenge_response_authentication
= -1;
1029 options
->gss_authentication
= -1;
1030 options
->gss_deleg_creds
= -1;
1031 options
->password_authentication
= -1;
1032 options
->kbd_interactive_authentication
= -1;
1033 options
->kbd_interactive_devices
= NULL
;
1034 options
->rhosts_rsa_authentication
= -1;
1035 options
->hostbased_authentication
= -1;
1036 options
->batch_mode
= -1;
1037 options
->check_host_ip
= -1;
1038 options
->strict_host_key_checking
= -1;
1039 options
->compression
= -1;
1040 options
->tcp_keep_alive
= -1;
1041 options
->compression_level
= -1;
1043 options
->address_family
= -1;
1044 options
->connection_attempts
= -1;
1045 options
->connection_timeout
= -1;
1046 options
->number_of_password_prompts
= -1;
1047 options
->cipher
= -1;
1048 options
->ciphers
= NULL
;
1049 options
->macs
= NULL
;
1050 options
->hostkeyalgorithms
= NULL
;
1051 options
->protocol
= SSH_PROTO_UNKNOWN
;
1052 options
->num_identity_files
= 0;
1053 options
->hostname
= NULL
;
1054 options
->host_key_alias
= NULL
;
1055 options
->proxy_command
= NULL
;
1056 options
->user
= NULL
;
1057 options
->escape_char
= -1;
1058 options
->system_hostfile
= NULL
;
1059 options
->user_hostfile
= NULL
;
1060 options
->system_hostfile2
= NULL
;
1061 options
->user_hostfile2
= NULL
;
1062 options
->num_local_forwards
= 0;
1063 options
->num_remote_forwards
= 0;
1064 options
->clear_forwardings
= -1;
1065 options
->log_level
= SYSLOG_LEVEL_NOT_SET
;
1066 options
->preferred_authentications
= NULL
;
1067 options
->bind_address
= NULL
;
1068 options
->smartcard_device
= NULL
;
1069 options
->enable_ssh_keysign
= - 1;
1070 options
->no_host_authentication_for_localhost
= - 1;
1071 options
->identities_only
= - 1;
1072 options
->rekey_limit
= - 1;
1073 options
->verify_host_key_dns
= -1;
1074 options
->server_alive_interval
= -1;
1075 options
->server_alive_count_max
= -1;
1076 options
->num_send_env
= 0;
1077 options
->control_path
= NULL
;
1078 options
->control_master
= -1;
1079 options
->hash_known_hosts
= -1;
1080 options
->tun_open
= -1;
1081 options
->tun_local
= -1;
1082 options
->tun_remote
= -1;
1083 options
->local_command
= NULL
;
1084 options
->permit_local_command
= -1;
1085 options
->use_roaming
= -1;
1086 options
->rdomain
= -1;
1087 options
->visual_host_key
= -1;
1088 options
->zero_knowledge_password_authentication
= -1;
1092 * Called after processing other sources of option data, this fills those
1093 * options for which no value has been specified with their default values.
1097 fill_default_options(Options
* options
)
1101 if (options
->forward_agent
== -1)
1102 options
->forward_agent
= 0;
1103 if (options
->forward_x11
== -1)
1104 options
->forward_x11
= 0;
1105 if (options
->forward_x11_trusted
== -1)
1106 options
->forward_x11_trusted
= 0;
1107 if (options
->exit_on_forward_failure
== -1)
1108 options
->exit_on_forward_failure
= 0;
1109 if (options
->xauth_location
== NULL
)
1110 options
->xauth_location
= _PATH_XAUTH
;
1111 if (options
->gateway_ports
== -1)
1112 options
->gateway_ports
= 0;
1113 if (options
->use_privileged_port
== -1)
1114 options
->use_privileged_port
= 0;
1115 if (options
->rsa_authentication
== -1)
1116 options
->rsa_authentication
= 1;
1117 if (options
->pubkey_authentication
== -1)
1118 options
->pubkey_authentication
= 1;
1119 if (options
->challenge_response_authentication
== -1)
1120 options
->challenge_response_authentication
= 1;
1121 if (options
->gss_authentication
== -1)
1122 options
->gss_authentication
= 0;
1123 if (options
->gss_deleg_creds
== -1)
1124 options
->gss_deleg_creds
= 0;
1125 if (options
->password_authentication
== -1)
1126 options
->password_authentication
= 1;
1127 if (options
->kbd_interactive_authentication
== -1)
1128 options
->kbd_interactive_authentication
= 1;
1129 if (options
->rhosts_rsa_authentication
== -1)
1130 options
->rhosts_rsa_authentication
= 0;
1131 if (options
->hostbased_authentication
== -1)
1132 options
->hostbased_authentication
= 0;
1133 if (options
->batch_mode
== -1)
1134 options
->batch_mode
= 0;
1135 if (options
->check_host_ip
== -1)
1136 options
->check_host_ip
= 1;
1137 if (options
->strict_host_key_checking
== -1)
1138 options
->strict_host_key_checking
= 2; /* 2 is default */
1139 if (options
->compression
== -1)
1140 options
->compression
= 0;
1141 if (options
->tcp_keep_alive
== -1)
1142 options
->tcp_keep_alive
= 1;
1143 if (options
->compression_level
== -1)
1144 options
->compression_level
= 6;
1145 if (options
->port
== -1)
1146 options
->port
= 0; /* Filled in ssh_connect. */
1147 if (options
->address_family
== -1)
1148 options
->address_family
= AF_UNSPEC
;
1149 if (options
->connection_attempts
== -1)
1150 options
->connection_attempts
= 1;
1151 if (options
->number_of_password_prompts
== -1)
1152 options
->number_of_password_prompts
= 3;
1153 /* Selected in ssh_login(). */
1154 if (options
->cipher
== -1)
1155 options
->cipher
= SSH_CIPHER_NOT_SET
;
1156 /* options->ciphers, default set in myproposals.h */
1157 /* options->macs, default set in myproposals.h */
1158 /* options->hostkeyalgorithms, default set in myproposals.h */
1159 if (options
->protocol
== SSH_PROTO_UNKNOWN
)
1160 options
->protocol
= SSH_PROTO_2
;
1161 if (options
->num_identity_files
== 0) {
1162 if (options
->protocol
& SSH_PROTO_1
) {
1163 len
= 2 + strlen(_PATH_SSH_CLIENT_IDENTITY
) + 1;
1164 options
->identity_files
[options
->num_identity_files
] =
1166 snprintf(options
->identity_files
[options
->num_identity_files
++],
1167 len
, "~/%.100s", _PATH_SSH_CLIENT_IDENTITY
);
1169 if (options
->protocol
& SSH_PROTO_2
) {
1170 len
= 2 + strlen(_PATH_SSH_CLIENT_ID_RSA
) + 1;
1171 options
->identity_files
[options
->num_identity_files
] =
1173 snprintf(options
->identity_files
[options
->num_identity_files
++],
1174 len
, "~/%.100s", _PATH_SSH_CLIENT_ID_RSA
);
1176 len
= 2 + strlen(_PATH_SSH_CLIENT_ID_DSA
) + 1;
1177 options
->identity_files
[options
->num_identity_files
] =
1179 snprintf(options
->identity_files
[options
->num_identity_files
++],
1180 len
, "~/%.100s", _PATH_SSH_CLIENT_ID_DSA
);
1183 if (options
->escape_char
== -1)
1184 options
->escape_char
= '~';
1185 if (options
->system_hostfile
== NULL
)
1186 options
->system_hostfile
= _PATH_SSH_SYSTEM_HOSTFILE
;
1187 if (options
->user_hostfile
== NULL
)
1188 options
->user_hostfile
= _PATH_SSH_USER_HOSTFILE
;
1189 if (options
->system_hostfile2
== NULL
)
1190 options
->system_hostfile2
= _PATH_SSH_SYSTEM_HOSTFILE2
;
1191 if (options
->user_hostfile2
== NULL
)
1192 options
->user_hostfile2
= _PATH_SSH_USER_HOSTFILE2
;
1193 if (options
->log_level
== SYSLOG_LEVEL_NOT_SET
)
1194 options
->log_level
= SYSLOG_LEVEL_INFO
;
1195 if (options
->clear_forwardings
== 1)
1196 clear_forwardings(options
);
1197 if (options
->no_host_authentication_for_localhost
== - 1)
1198 options
->no_host_authentication_for_localhost
= 0;
1199 if (options
->identities_only
== -1)
1200 options
->identities_only
= 0;
1201 if (options
->enable_ssh_keysign
== -1)
1202 options
->enable_ssh_keysign
= 0;
1203 if (options
->rekey_limit
== -1)
1204 options
->rekey_limit
= 0;
1205 if (options
->verify_host_key_dns
== -1)
1206 options
->verify_host_key_dns
= 0;
1207 if (options
->server_alive_interval
== -1)
1208 options
->server_alive_interval
= 0;
1209 if (options
->server_alive_count_max
== -1)
1210 options
->server_alive_count_max
= 3;
1211 if (options
->control_master
== -1)
1212 options
->control_master
= 0;
1213 if (options
->hash_known_hosts
== -1)
1214 options
->hash_known_hosts
= 0;
1215 if (options
->tun_open
== -1)
1216 options
->tun_open
= SSH_TUNMODE_NO
;
1217 if (options
->tun_local
== -1)
1218 options
->tun_local
= SSH_TUNID_ANY
;
1219 if (options
->tun_remote
== -1)
1220 options
->tun_remote
= SSH_TUNID_ANY
;
1221 if (options
->permit_local_command
== -1)
1222 options
->permit_local_command
= 0;
1223 if (options
->use_roaming
== -1)
1224 options
->use_roaming
= 1;
1225 if (options
->visual_host_key
== -1)
1226 options
->visual_host_key
= 0;
1227 if (options
->zero_knowledge_password_authentication
== -1)
1228 options
->zero_knowledge_password_authentication
= 0;
1229 /* options->local_command should not be set by default */
1230 /* options->proxy_command should not be set by default */
1231 /* options->user will be set in the main program if appropriate */
1232 /* options->hostname will be set in the main program if appropriate */
1233 /* options->host_key_alias should not be set by default */
1234 /* options->preferred_authentications will be set in ssh */
1235 /* options->rdomain should not be set by default */
1240 * parses a string containing a port forwarding specification of the form:
1242 * [listenhost:]listenport:connecthost:connectport
1244 * [listenhost:]listenport
1245 * returns number of arguments parsed or zero on error
1248 parse_forward(Forward
*fwd
, const char *fwdspec
, int dynamicfwd
, int remotefwd
)
1251 char *p
, *cp
, *fwdarg
[4];
1253 memset(fwd
, '\0', sizeof(*fwd
));
1255 cp
= p
= xstrdup(fwdspec
);
1257 /* skip leading spaces */
1258 while (isspace(*cp
))
1261 for (i
= 0; i
< 4; ++i
)
1262 if ((fwdarg
[i
] = hpdelim(&cp
)) == NULL
)
1265 /* Check for trailing garbage */
1267 i
= 0; /* failure */
1271 fwd
->listen_host
= NULL
;
1272 fwd
->listen_port
= a2port(fwdarg
[0]);
1273 fwd
->connect_host
= xstrdup("socks");
1277 fwd
->listen_host
= xstrdup(cleanhostname(fwdarg
[0]));
1278 fwd
->listen_port
= a2port(fwdarg
[1]);
1279 fwd
->connect_host
= xstrdup("socks");
1283 fwd
->listen_host
= NULL
;
1284 fwd
->listen_port
= a2port(fwdarg
[0]);
1285 fwd
->connect_host
= xstrdup(cleanhostname(fwdarg
[1]));
1286 fwd
->connect_port
= a2port(fwdarg
[2]);
1290 fwd
->listen_host
= xstrdup(cleanhostname(fwdarg
[0]));
1291 fwd
->listen_port
= a2port(fwdarg
[1]);
1292 fwd
->connect_host
= xstrdup(cleanhostname(fwdarg
[2]));
1293 fwd
->connect_port
= a2port(fwdarg
[3]);
1296 i
= 0; /* failure */
1302 if (!(i
== 1 || i
== 2))
1305 if (!(i
== 3 || i
== 4))
1307 if (fwd
->connect_port
<= 0)
1311 if (fwd
->listen_port
< 0 || (!remotefwd
&& fwd
->listen_port
== 0))
1314 if (fwd
->connect_host
!= NULL
&&
1315 strlen(fwd
->connect_host
) >= NI_MAXHOST
)
1317 if (fwd
->listen_host
!= NULL
&&
1318 strlen(fwd
->listen_host
) >= NI_MAXHOST
)
1325 if (fwd
->connect_host
!= NULL
) {
1326 xfree(fwd
->connect_host
);
1327 fwd
->connect_host
= NULL
;
1329 if (fwd
->listen_host
!= NULL
) {
1330 xfree(fwd
->listen_host
);
1331 fwd
->listen_host
= NULL
;