xref: /openbsd/usr.bin/ssh/pathnames.h (revision 3cab2bb3)
1 /* $OpenBSD: pathnames.h,v 1.31 2019/11/12 19:33:08 markus Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6  *                    All rights reserved
7  *
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".
13  */
14 
15 #define ETCDIR				"/etc"
16 #define SSHDIR				ETCDIR "/ssh"
17 #define _PATH_SSH_PIDDIR		"/var/run"
18 
19 /*
20  * System-wide file containing host keys of known hosts.  This file should be
21  * world-readable.
22  */
23 #define _PATH_SSH_SYSTEM_HOSTFILE	SSHDIR "/ssh_known_hosts"
24 /* backward compat for protocol 2 */
25 #define _PATH_SSH_SYSTEM_HOSTFILE2	SSHDIR "/ssh_known_hosts2"
26 
27 /*
28  * Of these, ssh_host_key must be readable only by root, whereas ssh_config
29  * should be world-readable.
30  */
31 #define _PATH_SERVER_CONFIG_FILE	SSHDIR "/sshd_config"
32 #define _PATH_HOST_CONFIG_FILE		SSHDIR "/ssh_config"
33 #define _PATH_HOST_DSA_KEY_FILE		SSHDIR "/ssh_host_dsa_key"
34 #define _PATH_HOST_ECDSA_KEY_FILE	SSHDIR "/ssh_host_ecdsa_key"
35 #define _PATH_HOST_RSA_KEY_FILE		SSHDIR "/ssh_host_rsa_key"
36 #define _PATH_HOST_ED25519_KEY_FILE	SSHDIR "/ssh_host_ed25519_key"
37 #define _PATH_HOST_XMSS_KEY_FILE	SSHDIR "/ssh_host_xmss_key"
38 #define _PATH_DH_MODULI			ETCDIR "/moduli"
39 
40 #define _PATH_SSH_PROGRAM		"/usr/bin/ssh"
41 
42 /*
43  * The process id of the daemon listening for connections is saved here to
44  * make it easier to kill the correct daemon when necessary.
45  */
46 #define _PATH_SSH_DAEMON_PID_FILE	_PATH_SSH_PIDDIR "/sshd.pid"
47 
48 /*
49  * The directory in user's home directory in which the files reside. The
50  * directory should be world-readable (though not all files are).
51  */
52 #define _PATH_SSH_USER_DIR		".ssh"
53 
54 /*
55  * Per-user file containing host keys of known hosts.  This file need not be
56  * readable by anyone except the user him/herself, though this does not
57  * contain anything particularly secret.
58  */
59 #define _PATH_SSH_USER_HOSTFILE		"~/" _PATH_SSH_USER_DIR "/known_hosts"
60 /* backward compat for protocol 2 */
61 #define _PATH_SSH_USER_HOSTFILE2	"~/" _PATH_SSH_USER_DIR "/known_hosts2"
62 
63 /*
64  * Name of the default file containing client-side authentication key. This
65  * file should only be readable by the user him/herself.
66  */
67 #define _PATH_SSH_CLIENT_ID_DSA		_PATH_SSH_USER_DIR "/id_dsa"
68 #define _PATH_SSH_CLIENT_ID_ECDSA	_PATH_SSH_USER_DIR "/id_ecdsa"
69 #define _PATH_SSH_CLIENT_ID_RSA		_PATH_SSH_USER_DIR "/id_rsa"
70 #define _PATH_SSH_CLIENT_ID_ED25519	_PATH_SSH_USER_DIR "/id_ed25519"
71 #define _PATH_SSH_CLIENT_ID_XMSS	_PATH_SSH_USER_DIR "/id_xmss"
72 #define _PATH_SSH_CLIENT_ID_ECDSA_SK	_PATH_SSH_USER_DIR "/id_ecdsa_sk"
73 #define _PATH_SSH_CLIENT_ID_ED25519_SK	_PATH_SSH_USER_DIR "/id_ed25519_sk"
74 
75 /*
76  * Configuration file in user's home directory.  This file need not be
77  * readable by anyone but the user him/herself, but does not contain anything
78  * particularly secret.  If the user's home directory resides on an NFS
79  * volume where root is mapped to nobody, this may need to be world-readable.
80  */
81 #define _PATH_SSH_USER_CONFFILE		_PATH_SSH_USER_DIR "/config"
82 
83 /*
84  * File containing a list of those rsa keys that permit logging in as this
85  * user.  This file need not be readable by anyone but the user him/herself,
86  * but does not contain anything particularly secret.  If the user's home
87  * directory resides on an NFS volume where root is mapped to nobody, this
88  * may need to be world-readable.  (This file is read by the daemon which is
89  * running as root.)
90  */
91 #define _PATH_SSH_USER_PERMITTED_KEYS	_PATH_SSH_USER_DIR "/authorized_keys"
92 
93 /* backward compat for protocol v2 */
94 #define _PATH_SSH_USER_PERMITTED_KEYS2	_PATH_SSH_USER_DIR "/authorized_keys2"
95 
96 /*
97  * Per-user and system-wide ssh "rc" files.  These files are executed with
98  * /bin/sh before starting the shell or command if they exist.  They will be
99  * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
100  * use.  xauth will be run if neither of these exists.
101  */
102 #define _PATH_SSH_USER_RC		_PATH_SSH_USER_DIR "/rc"
103 #define _PATH_SSH_SYSTEM_RC		SSHDIR "/sshrc"
104 
105 /*
106  * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
107  * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
108  */
109 #define _PATH_SSH_HOSTS_EQUIV		ETCDIR "/shosts.equiv"
110 #define _PATH_RHOSTS_EQUIV		"/etc/hosts.equiv"
111 
112 /*
113  * Default location of askpass
114  */
115 #define _PATH_SSH_ASKPASS_DEFAULT	"/usr/X11R6/bin/ssh-askpass"
116 
117 /* Location of ssh-keysign for hostbased authentication */
118 #define _PATH_SSH_KEY_SIGN		"/usr/libexec/ssh-keysign"
119 
120 /* Location of ssh-pkcs11-helper to support keys in tokens */
121 #define _PATH_SSH_PKCS11_HELPER		"/usr/libexec/ssh-pkcs11-helper"
122 
123 /* Location of ssh-sk-helper to support keys in security keys */
124 #ifndef _PATH_SSH_SK_HELPER
125 #define _PATH_SSH_SK_HELPER		"/usr/libexec/ssh-sk-helper"
126 #endif
127 
128 /* xauth for X11 forwarding */
129 #define _PATH_XAUTH			"/usr/X11R6/bin/xauth"
130 
131 /* UNIX domain socket for X11 server; displaynum will replace %u */
132 #define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
133 
134 /* for scp */
135 #define _PATH_CP			"cp"
136 
137 /* for sftp */
138 #define _PATH_SFTP_SERVER		"/usr/libexec/sftp-server"
139 #define _PATH_LS			"ls"
140 
141 /* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
142 #define _PATH_PRIVSEP_CHROOT_DIR	"/var/empty"
143 
144 /* for passwd change */
145 #define _PATH_PASSWD_PROG		"/usr/bin/passwd"
146