blob: f7ca5a75a0d2ec763c5863c33dae13445816dfad [file] [log] [blame]
markus@openbsd.org2c557442019-11-12 19:33:08 +00001/* $OpenBSD: pathnames.h,v 1.31 2019/11/12 19:33:08 markus Exp $ */
Ben Lindstrom36579d32001-01-29 07:39:26 +00002
Ben Lindstrom226cfa02001-01-22 05:34:40 +00003/*
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
Ben Lindstrom226cfa02001-01-22 05:34:40 +000015#define ETCDIR "/etc"
Damien Miller05eda432002-02-10 18:32:28 +110016
17#ifndef SSHDIR
18#define SSHDIR ETCDIR "/ssh"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000019#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 */
Damien Miller05eda432002-02-10 18:32:28 +110029#define _PATH_SSH_SYSTEM_HOSTFILE SSHDIR "/ssh_known_hosts"
Ben Lindstromd6481ea2001-06-25 04:37:41 +000030/* backward compat for protocol 2 */
Damien Miller05eda432002-02-10 18:32:28 +110031#define _PATH_SSH_SYSTEM_HOSTFILE2 SSHDIR "/ssh_known_hosts2"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000032
33/*
34 * Of these, ssh_host_key must be readable only by root, whereas ssh_config
35 * should be world-readable.
36 */
Damien Miller05eda432002-02-10 18:32:28 +110037#define _PATH_SERVER_CONFIG_FILE SSHDIR "/sshd_config"
38#define _PATH_HOST_CONFIG_FILE SSHDIR "/ssh_config"
Damien Miller05eda432002-02-10 18:32:28 +110039#define _PATH_HOST_DSA_KEY_FILE SSHDIR "/ssh_host_dsa_key"
Damien Millereb8b60e2010-08-31 22:41:14 +100040#define _PATH_HOST_ECDSA_KEY_FILE SSHDIR "/ssh_host_ecdsa_key"
Damien Miller5be9d9e2013-12-07 11:24:01 +110041#define _PATH_HOST_ED25519_KEY_FILE SSHDIR "/ssh_host_ed25519_key"
markus@openbsd.org1b11ea72018-02-23 15:58:37 +000042#define _PATH_HOST_XMSS_KEY_FILE SSHDIR "/ssh_host_xmss_key"
Damien Miller05eda432002-02-10 18:32:28 +110043#define _PATH_HOST_RSA_KEY_FILE SSHDIR "/ssh_host_rsa_key"
44#define _PATH_DH_MODULI SSHDIR "/moduli"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000045
Ben Lindstrom27eebe62001-01-25 23:04:22 +000046#ifndef _PATH_SSH_PROGRAM
Ben Lindstrom226cfa02001-01-22 05:34:40 +000047#define _PATH_SSH_PROGRAM "/usr/bin/ssh"
Ben Lindstrom27eebe62001-01-25 23:04:22 +000048#endif
Ben Lindstrom226cfa02001-01-22 05:34:40 +000049
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/*
Damien Millera70ac762009-01-28 16:19:52 +110057 * The directory in user's home directory in which the files reside. The
Ben Lindstrom226cfa02001-01-22 05:34:40 +000058 * 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 */
Damien Miller9f12b5d2013-04-23 15:19:11 +100067#define _PATH_SSH_USER_HOSTFILE "~/" _PATH_SSH_USER_DIR "/known_hosts"
Ben Lindstromd6481ea2001-06-25 04:37:41 +000068/* backward compat for protocol 2 */
Damien Miller9f12b5d2013-04-23 15:19:11 +100069#define _PATH_SSH_USER_HOSTFILE2 "~/" _PATH_SSH_USER_DIR "/known_hosts2"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000070
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 */
Damien Miller9f12b5d2013-04-23 15:19:11 +100075#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"
Damien Miller5be9d9e2013-12-07 11:24:01 +110078#define _PATH_SSH_CLIENT_ID_ED25519 _PATH_SSH_USER_DIR "/id_ed25519"
markus@openbsd.org1b11ea72018-02-23 15:58:37 +000079#define _PATH_SSH_CLIENT_ID_XMSS _PATH_SSH_USER_DIR "/id_xmss"
djm@openbsd.org02bb0762019-10-31 21:15:14 +000080#define _PATH_SSH_CLIENT_ID_ECDSA_SK _PATH_SSH_USER_DIR "/id_ecdsa_sk"
markus@openbsd.org2c557442019-11-12 19:33:08 +000081#define _PATH_SSH_CLIENT_ID_ED25519_SK _PATH_SSH_USER_DIR "/id_ed25519_sk"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000082
83/*
Damien Millera70ac762009-01-28 16:19:52 +110084 * Configuration file in user's home directory. This file need not be
Ben Lindstrom226cfa02001-01-22 05:34:40 +000085 * readable by anyone but the user him/herself, but does not contain anything
Damien Millera70ac762009-01-28 16:19:52 +110086 * particularly secret. If the user's home directory resides on an NFS
Ben Lindstrom226cfa02001-01-22 05:34:40 +000087 * volume where root is mapped to nobody, this may need to be world-readable.
88 */
Damien Miller9f12b5d2013-04-23 15:19:11 +100089#define _PATH_SSH_USER_CONFFILE _PATH_SSH_USER_DIR "/config"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000090
91/*
92 * File containing a list of those rsa keys that permit logging in as this
93 * user. This file need not be readable by anyone but the user him/herself,
Damien Millera70ac762009-01-28 16:19:52 +110094 * but does not contain anything particularly secret. If the user's home
Ben Lindstrom226cfa02001-01-22 05:34:40 +000095 * directory resides on an NFS volume where root is mapped to nobody, this
96 * may need to be world-readable. (This file is read by the daemon which is
97 * running as root.)
98 */
Damien Miller9f12b5d2013-04-23 15:19:11 +100099#define _PATH_SSH_USER_PERMITTED_KEYS _PATH_SSH_USER_DIR "/authorized_keys"
Ben Lindstromf96704d2001-06-25 04:17:12 +0000100
Damien Millerd8478b62011-05-29 21:39:36 +1000101/* backward compat for protocol v2 */
Damien Miller9f12b5d2013-04-23 15:19:11 +1000102#define _PATH_SSH_USER_PERMITTED_KEYS2 _PATH_SSH_USER_DIR "/authorized_keys2"
Damien Millerd8478b62011-05-29 21:39:36 +1000103
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000104/*
105 * Per-user and system-wide ssh "rc" files. These files are executed with
106 * /bin/sh before starting the shell or command if they exist. They will be
107 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
108 * use. xauth will be run if neither of these exists.
109 */
Damien Miller9f12b5d2013-04-23 15:19:11 +1000110#define _PATH_SSH_USER_RC _PATH_SSH_USER_DIR "/rc"
Damien Miller05eda432002-02-10 18:32:28 +1100111#define _PATH_SSH_SYSTEM_RC SSHDIR "/sshrc"
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000112
113/*
114 * Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
115 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
116 */
Damien Miller05eda432002-02-10 18:32:28 +1100117#define _PATH_SSH_HOSTS_EQUIV SSHDIR "/shosts.equiv"
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000118#define _PATH_RHOSTS_EQUIV "/etc/hosts.equiv"
119
120/*
121 * Default location of askpass
122 */
Ben Lindstromcb577332001-01-22 21:06:19 +0000123#ifndef _PATH_SSH_ASKPASS_DEFAULT
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000124#define _PATH_SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
Ben Lindstromcb577332001-01-22 21:06:19 +0000125#endif
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000126
Ben Lindstrom1bad2562002-06-06 19:57:33 +0000127/* Location of ssh-keysign for hostbased authentication */
128#ifndef _PATH_SSH_KEY_SIGN
Darren Tuckerfc959702004-07-17 16:12:08 +1000129#define _PATH_SSH_KEY_SIGN "/usr/libexec/ssh-keysign"
Ben Lindstrom1bad2562002-06-06 19:57:33 +0000130#endif
131
Damien Millera80f1402010-02-24 17:17:58 +1100132/* Location of ssh-pkcs11-helper to support keys in tokens */
Damien Miller7ea845e2010-02-12 09:21:02 +1100133#ifndef _PATH_SSH_PKCS11_HELPER
134#define _PATH_SSH_PKCS11_HELPER "/usr/libexec/ssh-pkcs11-helper"
135#endif
136
djm@openbsd.org07da39f2019-10-31 21:22:01 +0000137/* Location of ssh-sk-helper to support keys in security keys */
138#ifndef _PATH_SSH_SK_HELPER
139#define _PATH_SSH_SK_HELPER "/usr/libexec/ssh-sk-helper"
140#endif
141
Kevin Steves37a777e2001-06-28 00:13:48 +0000142/* xauth for X11 forwarding */
143#ifndef _PATH_XAUTH
144#define _PATH_XAUTH "/usr/X11R6/bin/xauth"
145#endif
146
Damien Miller3afe3752001-12-21 12:39:51 +1100147/* UNIX domain socket for X11 server; displaynum will replace %u */
148#ifndef _PATH_UNIX_X
149#define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
150#endif
151
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000152/* for scp */
153#ifndef _PATH_CP
154#define _PATH_CP "cp"
155#endif
156
Damien Millerd7686fd2001-02-10 00:40:03 +1100157/* for sftp */
158#ifndef _PATH_SFTP_SERVER
159#define _PATH_SFTP_SERVER "/usr/libexec/sftp-server"
160#endif
Ben Lindstrom7a7edf72002-03-22 02:42:37 +0000161
162/* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
Damien Millerf58c6722002-05-13 13:15:42 +1000163#ifndef _PATH_PRIVSEP_CHROOT_DIR
Ben Lindstrom7a7edf72002-03-22 02:42:37 +0000164#define _PATH_PRIVSEP_CHROOT_DIR "/var/empty"
Damien Millerf58c6722002-05-13 13:15:42 +1000165#endif
166
Darren Tucker23bc8d02004-02-06 16:24:31 +1100167/* for passwd change */
168#ifndef _PATH_PASSWD_PROG
169#define _PATH_PASSWD_PROG "/usr/bin/passwd"
170#endif
171
Damien Miller896b88a2001-02-27 14:42:48 +1100172#ifndef _PATH_LS
Damien Millerd7686fd2001-02-10 00:40:03 +1100173#define _PATH_LS "ls"
Damien Miller896b88a2001-02-27 14:42:48 +1100174#endif
Damien Millerd7686fd2001-02-10 00:40:03 +1100175
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000176/* Askpass program define */
177#ifndef ASKPASS_PROGRAM
178#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
179#endif /* ASKPASS_PROGRAM */