pathnames.h revision 323129
1/* $OpenBSD: pathnames.h,v 1.25 2016/03/31 05:24:06 dtucker Exp $ */
2/* $FreeBSD: stable/11/crypto/openssh/pathnames.h 323129 2017-09-02 14:25:20Z des $ */
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_KEY_FILE		SSHDIR "/ssh_host_key"
41#define _PATH_HOST_DSA_KEY_FILE		SSHDIR "/ssh_host_dsa_key"
42#define _PATH_HOST_ECDSA_KEY_FILE	SSHDIR "/ssh_host_ecdsa_key"
43#define _PATH_HOST_ED25519_KEY_FILE	SSHDIR "/ssh_host_ed25519_key"
44#define _PATH_HOST_RSA_KEY_FILE		SSHDIR "/ssh_host_rsa_key"
45#define _PATH_DH_MODULI			SSHDIR "/moduli"
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		"~/" _PATH_SSH_USER_DIR "/known_hosts"
69/* backward compat for protocol 2 */
70#define _PATH_SSH_USER_HOSTFILE2	"~/" _PATH_SSH_USER_DIR "/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	_PATH_SSH_USER_DIR "/identity"
77#define _PATH_SSH_CLIENT_ID_DSA		_PATH_SSH_USER_DIR "/id_dsa"
78#define _PATH_SSH_CLIENT_ID_ECDSA	_PATH_SSH_USER_DIR "/id_ecdsa"
79#define _PATH_SSH_CLIENT_ID_RSA		_PATH_SSH_USER_DIR "/id_rsa"
80#define _PATH_SSH_CLIENT_ID_ED25519	_PATH_SSH_USER_DIR "/id_ed25519"
81
82/*
83 * Configuration file in user's home directory.  This file need not be
84 * readable by anyone but the user him/herself, but does not contain anything
85 * particularly secret.  If the user's home directory resides on an NFS
86 * volume where root is mapped to nobody, this may need to be world-readable.
87 */
88#define _PATH_SSH_USER_CONFFILE		_PATH_SSH_USER_DIR "/config"
89
90/*
91 * File containing a list of those rsa keys that permit logging in as this
92 * user.  This file need not be readable by anyone but the user him/herself,
93 * but does not contain anything particularly secret.  If the user's home
94 * directory resides on an NFS volume where root is mapped to nobody, this
95 * may need to be world-readable.  (This file is read by the daemon which is
96 * running as root.)
97 */
98#define _PATH_SSH_USER_PERMITTED_KEYS	_PATH_SSH_USER_DIR "/authorized_keys"
99
100/* backward compat for protocol v2 */
101#define _PATH_SSH_USER_PERMITTED_KEYS2	_PATH_SSH_USER_DIR "/authorized_keys2"
102
103/*
104 * Per-user and system-wide ssh "rc" files.  These files are executed with
105 * /bin/sh before starting the shell or command if they exist.  They will be
106 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
107 * use.  xauth will be run if neither of these exists.
108 */
109#define _PATH_SSH_USER_RC		_PATH_SSH_USER_DIR "/rc"
110#define _PATH_SSH_SYSTEM_RC		SSHDIR "/sshrc"
111
112/*
113 * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
114 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
115 */
116#define _PATH_SSH_HOSTS_EQUIV		SSHDIR "/shosts.equiv"
117#define _PATH_RHOSTS_EQUIV		"/etc/hosts.equiv"
118
119/*
120 * Default location of askpass
121 */
122#ifndef _PATH_SSH_ASKPASS_DEFAULT
123#define _PATH_SSH_ASKPASS_DEFAULT	"/usr/local/bin/ssh-askpass"
124#endif
125
126/* Location of ssh-keysign for hostbased authentication */
127#ifndef _PATH_SSH_KEY_SIGN
128#define _PATH_SSH_KEY_SIGN		"/usr/libexec/ssh-keysign"
129#endif
130
131/* Location of ssh-pkcs11-helper to support keys in tokens */
132#ifndef _PATH_SSH_PKCS11_HELPER
133#define _PATH_SSH_PKCS11_HELPER		"/usr/libexec/ssh-pkcs11-helper"
134#endif
135
136/* xauth for X11 forwarding */
137#ifndef _PATH_XAUTH
138#define _PATH_XAUTH			"/usr/local/bin/xauth"
139#endif
140
141/* UNIX domain socket for X11 server; displaynum will replace %u */
142#ifndef _PATH_UNIX_X
143#define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
144#endif
145
146/* for scp */
147#ifndef _PATH_CP
148#define _PATH_CP			"cp"
149#endif
150
151/* for sftp */
152#ifndef _PATH_SFTP_SERVER
153#define _PATH_SFTP_SERVER		"/usr/libexec/sftp-server"
154#endif
155
156/* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
157#ifndef _PATH_PRIVSEP_CHROOT_DIR
158#define _PATH_PRIVSEP_CHROOT_DIR	"/var/empty"
159#endif
160
161/* for passwd change */
162#ifndef _PATH_PASSWD_PROG
163#define _PATH_PASSWD_PROG             "/usr/bin/passwd"
164#endif
165
166#ifndef _PATH_LS
167#define _PATH_LS			"ls"
168#endif
169
170/* path to login program */
171#ifndef LOGIN_PROGRAM
172# ifdef LOGIN_PROGRAM_FALLBACK
173#  define LOGIN_PROGRAM         LOGIN_PROGRAM_FALLBACK
174# else
175#  define LOGIN_PROGRAM         "/usr/bin/login"
176# endif
177#endif /* LOGIN_PROGRAM */
178
179/* Askpass program define */
180#ifndef ASKPASS_PROGRAM
181#define ASKPASS_PROGRAM         "/usr/lib/ssh/ssh-askpass"
182#endif /* ASKPASS_PROGRAM */
183