xref: /openbsd/usr.bin/ssh/pathnames.h (revision 9e6efb0a)
1 /* $OpenBSD: pathnames.h,v 1.32 2024/05/17 00:30:24 djm 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 /* Binary paths for the sshd components */
43 #define _PATH_SSHD_SESSION		"/usr/libexec/sshd-session"
44 
45 /*
46  * The process id of the daemon listening for connections is saved here to
47  * make it easier to kill the correct daemon when necessary.
48  */
49 #define _PATH_SSH_DAEMON_PID_FILE	_PATH_SSH_PIDDIR "/sshd.pid"
50 
51 /*
52  * The directory in user's home directory in which the files reside. The
53  * directory should be world-readable (though not all files are).
54  */
55 #define _PATH_SSH_USER_DIR		".ssh"
56 
57 /*
58  * Per-user file containing host keys of known hosts.  This file need not be
59  * readable by anyone except the user him/herself, though this does not
60  * contain anything particularly secret.
61  */
62 #define _PATH_SSH_USER_HOSTFILE		"~/" _PATH_SSH_USER_DIR "/known_hosts"
63 /* backward compat for protocol 2 */
64 #define _PATH_SSH_USER_HOSTFILE2	"~/" _PATH_SSH_USER_DIR "/known_hosts2"
65 
66 /*
67  * Name of the default file containing client-side authentication key. This
68  * file should only be readable by the user him/herself.
69  */
70 #define _PATH_SSH_CLIENT_ID_DSA		_PATH_SSH_USER_DIR "/id_dsa"
71 #define _PATH_SSH_CLIENT_ID_ECDSA	_PATH_SSH_USER_DIR "/id_ecdsa"
72 #define _PATH_SSH_CLIENT_ID_RSA		_PATH_SSH_USER_DIR "/id_rsa"
73 #define _PATH_SSH_CLIENT_ID_ED25519	_PATH_SSH_USER_DIR "/id_ed25519"
74 #define _PATH_SSH_CLIENT_ID_XMSS	_PATH_SSH_USER_DIR "/id_xmss"
75 #define _PATH_SSH_CLIENT_ID_ECDSA_SK	_PATH_SSH_USER_DIR "/id_ecdsa_sk"
76 #define _PATH_SSH_CLIENT_ID_ED25519_SK	_PATH_SSH_USER_DIR "/id_ed25519_sk"
77 
78 /*
79  * Configuration file in user's home directory.  This file need not be
80  * readable by anyone but the user him/herself, but does not contain anything
81  * particularly secret.  If the user's home directory resides on an NFS
82  * volume where root is mapped to nobody, this may need to be world-readable.
83  */
84 #define _PATH_SSH_USER_CONFFILE		_PATH_SSH_USER_DIR "/config"
85 
86 /*
87  * File containing a list of those rsa keys that permit logging in as this
88  * user.  This file need not be readable by anyone but the user him/herself,
89  * but does not contain anything particularly secret.  If the user's home
90  * directory resides on an NFS volume where root is mapped to nobody, this
91  * may need to be world-readable.  (This file is read by the daemon which is
92  * running as root.)
93  */
94 #define _PATH_SSH_USER_PERMITTED_KEYS	_PATH_SSH_USER_DIR "/authorized_keys"
95 
96 /* backward compat for protocol v2 */
97 #define _PATH_SSH_USER_PERMITTED_KEYS2	_PATH_SSH_USER_DIR "/authorized_keys2"
98 
99 /*
100  * Per-user and system-wide ssh "rc" files.  These files are executed with
101  * /bin/sh before starting the shell or command if they exist.  They will be
102  * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
103  * use.  xauth will be run if neither of these exists.
104  */
105 #define _PATH_SSH_USER_RC		_PATH_SSH_USER_DIR "/rc"
106 #define _PATH_SSH_SYSTEM_RC		SSHDIR "/sshrc"
107 
108 /*
109  * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
110  * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
111  */
112 #define _PATH_SSH_HOSTS_EQUIV		ETCDIR "/shosts.equiv"
113 #define _PATH_RHOSTS_EQUIV		"/etc/hosts.equiv"
114 
115 /*
116  * Default location of askpass
117  */
118 #define _PATH_SSH_ASKPASS_DEFAULT	"/usr/X11R6/bin/ssh-askpass"
119 
120 /* Location of ssh-keysign for hostbased authentication */
121 #define _PATH_SSH_KEY_SIGN		"/usr/libexec/ssh-keysign"
122 
123 /* Location of ssh-pkcs11-helper to support keys in tokens */
124 #define _PATH_SSH_PKCS11_HELPER		"/usr/libexec/ssh-pkcs11-helper"
125 
126 /* Location of ssh-sk-helper to support keys in security keys */
127 #ifndef _PATH_SSH_SK_HELPER
128 #define _PATH_SSH_SK_HELPER		"/usr/libexec/ssh-sk-helper"
129 #endif
130 
131 /* xauth for X11 forwarding */
132 #define _PATH_XAUTH			"/usr/X11R6/bin/xauth"
133 
134 /* UNIX domain socket for X11 server; displaynum will replace %u */
135 #define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
136 
137 /* for scp */
138 #define _PATH_CP			"cp"
139 
140 /* for sftp */
141 #define _PATH_SFTP_SERVER		"/usr/libexec/sftp-server"
142 #define _PATH_LS			"ls"
143 
144 /* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
145 #define _PATH_PRIVSEP_CHROOT_DIR	"/var/empty"
146 
147 /* for passwd change */
148 #define _PATH_PASSWD_PROG		"/usr/bin/passwd"
149