xref: /freebsd/crypto/openssh/pathnames.h (revision 488ab515d6cc02f6f743f0badfc8e94eb553cd30)
1 /* $OpenBSD: pathnames.h,v 1.27 2017/05/05 10:42:49 naddy Exp $ */
2 /* $FreeBSD$ */
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 
18 #ifndef SSHDIR
19 #define SSHDIR				ETCDIR "/ssh"
20 #endif
21 
22 #ifndef _PATH_SSH_PIDDIR
23 #define _PATH_SSH_PIDDIR		"/var/run"
24 #endif
25 
26 /*
27  * System-wide file containing host keys of known hosts.  This file should be
28  * world-readable.
29  */
30 #define _PATH_SSH_SYSTEM_HOSTFILE	SSHDIR "/ssh_known_hosts"
31 /* backward compat for protocol 2 */
32 #define _PATH_SSH_SYSTEM_HOSTFILE2	SSHDIR "/ssh_known_hosts2"
33 
34 /*
35  * Of these, ssh_host_key must be readable only by root, whereas ssh_config
36  * should be world-readable.
37  */
38 #define _PATH_SERVER_CONFIG_FILE	SSHDIR "/sshd_config"
39 #define _PATH_HOST_CONFIG_FILE		SSHDIR "/ssh_config"
40 #define _PATH_HOST_DSA_KEY_FILE		SSHDIR "/ssh_host_dsa_key"
41 #define _PATH_HOST_ECDSA_KEY_FILE	SSHDIR "/ssh_host_ecdsa_key"
42 #define _PATH_HOST_ED25519_KEY_FILE	SSHDIR "/ssh_host_ed25519_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 
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		SSHDIR "/shosts.equiv"
115 #define _PATH_RHOSTS_EQUIV		"/etc/hosts.equiv"
116 
117 /*
118  * Default location of askpass
119  */
120 #ifndef _PATH_SSH_ASKPASS_DEFAULT
121 #define _PATH_SSH_ASKPASS_DEFAULT	"/usr/local/bin/ssh-askpass"
122 #endif
123 
124 /* Location of ssh-keysign for hostbased authentication */
125 #ifndef _PATH_SSH_KEY_SIGN
126 #define _PATH_SSH_KEY_SIGN		"/usr/libexec/ssh-keysign"
127 #endif
128 
129 /* Location of ssh-pkcs11-helper to support keys in tokens */
130 #ifndef _PATH_SSH_PKCS11_HELPER
131 #define _PATH_SSH_PKCS11_HELPER		"/usr/libexec/ssh-pkcs11-helper"
132 #endif
133 
134 /* xauth for X11 forwarding */
135 #ifndef _PATH_XAUTH
136 #define _PATH_XAUTH			"/usr/local/bin/xauth"
137 #endif
138 
139 /* UNIX domain socket for X11 server; displaynum will replace %u */
140 #ifndef _PATH_UNIX_X
141 #define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
142 #endif
143 
144 /* for scp */
145 #ifndef _PATH_CP
146 #define _PATH_CP			"cp"
147 #endif
148 
149 /* for sftp */
150 #ifndef _PATH_SFTP_SERVER
151 #define _PATH_SFTP_SERVER		"/usr/libexec/sftp-server"
152 #endif
153 
154 /* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
155 #ifndef _PATH_PRIVSEP_CHROOT_DIR
156 #define _PATH_PRIVSEP_CHROOT_DIR	"/var/empty"
157 #endif
158 
159 /* for passwd change */
160 #ifndef _PATH_PASSWD_PROG
161 #define _PATH_PASSWD_PROG             "/usr/bin/passwd"
162 #endif
163 
164 #ifndef _PATH_LS
165 #define _PATH_LS			"ls"
166 #endif
167 
168 /* Askpass program define */
169 #ifndef ASKPASS_PROGRAM
170 #define ASKPASS_PROGRAM         "/usr/lib/ssh/ssh-askpass"
171 #endif /* ASKPASS_PROGRAM */
172