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