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