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