xref: /netbsd-src/crypto/external/bsd/openssh/dist/pathnames.h (revision 796c32c94f6e154afc9de0f63da35c91bb739b45)
1 /*	$NetBSD: pathnames.h,v 1.13 2017/10/07 19:39:19 christos Exp $	*/
2 /* $OpenBSD: pathnames.h,v 1.27 2017/05/05 10:42:49 naddy 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_DH_MODULI			ETCDIR "/moduli"
39 
40 #define _PATH_SSH_PROGRAM		"/usr/bin/ssh"
41 
42 /*
43  * The process id of the daemon listening for connections is saved here to
44  * make it easier to kill the correct daemon when necessary.
45  */
46 #define _PATH_SSH_DAEMON_PID_FILE	_PATH_SSH_PIDDIR "/sshd.pid"
47 
48 /*
49  * The directory in user's home directory in which the files reside. The
50  * directory should be world-readable (though not all files are).
51  */
52 #define _PATH_SSH_USER_DIR		".ssh"
53 
54 /*
55  * Per-user file containing host keys of known hosts.  This file need not be
56  * readable by anyone except the user him/herself, though this does not
57  * contain anything particularly secret.
58  */
59 #define _PATH_SSH_USER_HOSTFILE		"~/" _PATH_SSH_USER_DIR "/known_hosts"
60 /* backward compat for protocol 2 */
61 #define _PATH_SSH_USER_HOSTFILE2	"~/" _PATH_SSH_USER_DIR "/known_hosts2"
62 
63 /*
64  * Name of the default file containing client-side authentication key. This
65  * file should only be readable by the user him/herself.
66  */
67 #define _PATH_SSH_CLIENT_ID_DSA		_PATH_SSH_USER_DIR "/id_dsa"
68 #define _PATH_SSH_CLIENT_ID_ECDSA	_PATH_SSH_USER_DIR "/id_ecdsa"
69 #define _PATH_SSH_CLIENT_ID_RSA		_PATH_SSH_USER_DIR "/id_rsa"
70 #define _PATH_SSH_CLIENT_ID_ED25519	_PATH_SSH_USER_DIR "/id_ed25519"
71 
72 /*
73  * Configuration file in user's home directory.  This file need not be
74  * readable by anyone but the user him/herself, but does not contain anything
75  * particularly secret.  If the user's home directory resides on an NFS
76  * volume where root is mapped to nobody, this may need to be world-readable.
77  */
78 #define _PATH_SSH_USER_CONFFILE		_PATH_SSH_USER_DIR "/config"
79 
80 /*
81  * File containing a list of those rsa keys that permit logging in as this
82  * user.  This file need not be readable by anyone but the user him/herself,
83  * but does not contain anything particularly secret.  If the user's home
84  * directory resides on an NFS volume where root is mapped to nobody, this
85  * may need to be world-readable.  (This file is read by the daemon which is
86  * running as root.)
87  */
88 #define _PATH_SSH_USER_PERMITTED_KEYS	_PATH_SSH_USER_DIR "/authorized_keys"
89 
90 /* backward compat for protocol v2 */
91 #define _PATH_SSH_USER_PERMITTED_KEYS2	_PATH_SSH_USER_DIR "/authorized_keys2"
92 
93 /*
94  * Per-user and system-wide ssh "rc" files.  These files are executed with
95  * /bin/sh before starting the shell or command if they exist.  They will be
96  * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
97  * use.  xauth will be run if neither of these exists.
98  */
99 #define _PATH_SSH_USER_RC		_PATH_SSH_USER_DIR "/rc"
100 #define _PATH_SSH_SYSTEM_RC		SSHDIR "/sshrc"
101 
102 /*
103  * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
104  * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
105  */
106 #define _PATH_SSH_HOSTS_EQUIV		ETCDIR "/shosts.equiv"
107 #define _PATH_RHOSTS_EQUIV		"/etc/hosts.equiv"
108 
109 /*
110  * X11 base directory
111  */
112 #ifndef X11BASE
113 #define X11BASE				"/usr/X11R6"
114 #endif
115 
116 /*
117  * Default location of askpass
118  */
119 #define _PATH_SSH_ASKPASS_DEFAULT	X11BASE "/bin/ssh-askpass"
120 
121 /* Location of ssh-keysign for hostbased authentication */
122 #define _PATH_SSH_KEY_SIGN		"/usr/libexec/ssh-keysign"
123 
124 /* Location of ssh-pkcs11-helper to support keys in tokens */
125 #define _PATH_SSH_PKCS11_HELPER		"/usr/libexec/ssh-pkcs11-helper"
126 
127 /* xauth for X11 forwarding */
128 #define _PATH_XAUTH			X11BASE "/bin/xauth"
129 
130 /* UNIX domain socket for X11 server; displaynum will replace %u */
131 #define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
132 
133 /* for scp */
134 #define _PATH_CP			"cp"
135 
136 /* for sftp */
137 #define _PATH_SFTP_SERVER		"/usr/libexec/sftp-server"
138 #define _PATH_LS			"ls"
139 
140 /* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
141 #ifdef __OpenBSD__
142 #define _PATH_PRIVSEP_CHROOT_DIR	"/var/empty"
143 #else
144 #define _PATH_PRIVSEP_CHROOT_DIR	"/var/chroot/sshd"
145 #endif
146 
147 #define _PATH_URANDOM			"/dev/urandom"
148 
149 /* for passwd change */
150 #define _PATH_PASSWD_PROG		"/usr/bin/passwd"
151