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