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