pathnames.h

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