[openssh.git] / pathnames.h

/* $OpenBSD: pathnames.h,v 1.17 2008/12/29 02:23:26 stevesk Exp $ */

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */

#define ETCDIR				"/etc"

#ifndef SSHDIR
#define SSHDIR				ETCDIR "/ssh"
#endif

#ifndef _PATH_SSH_PIDDIR
#define _PATH_SSH_PIDDIR		"/var/run"
#endif

/*
 * System-wide file containing host keys of known hosts.  This file should be
 * world-readable.
 */
#define _PATH_SSH_SYSTEM_HOSTFILE	SSHDIR "/ssh_known_hosts"
/* backward compat for protocol 2 */
#define _PATH_SSH_SYSTEM_HOSTFILE2	SSHDIR "/ssh_known_hosts2"

/*
 * Of these, ssh_host_key must be readable only by root, whereas ssh_config
 * should be world-readable.
 */
#define _PATH_SERVER_CONFIG_FILE	SSHDIR "/sshd_config"
#define _PATH_HOST_CONFIG_FILE		SSHDIR "/ssh_config"
#define _PATH_HOST_KEY_FILE		SSHDIR "/ssh_host_key"
#define _PATH_HOST_DSA_KEY_FILE		SSHDIR "/ssh_host_dsa_key"
#define _PATH_HOST_RSA_KEY_FILE		SSHDIR "/ssh_host_rsa_key"
#define _PATH_DH_MODULI			SSHDIR "/moduli"
/* Backwards compatibility */
#define _PATH_DH_PRIMES			SSHDIR "/primes"

#ifndef _PATH_SSH_PROGRAM
#define _PATH_SSH_PROGRAM		"/usr/bin/ssh"
#endif

/*
 * The process id of the daemon listening for connections is saved here to
 * make it easier to kill the correct daemon when necessary.
 */
#define _PATH_SSH_DAEMON_PID_FILE	_PATH_SSH_PIDDIR "/sshd.pid"

/*
 * The directory in user's home directory in which the files reside. The
 * directory should be world-readable (though not all files are).
 */
#define _PATH_SSH_USER_DIR		".ssh"

/*
 * Per-user file containing host keys of known hosts.  This file need not be
 * readable by anyone except the user him/herself, though this does not
 * contain anything particularly secret.
 */
#define _PATH_SSH_USER_HOSTFILE		"~/.ssh/known_hosts"
/* backward compat for protocol 2 */
#define _PATH_SSH_USER_HOSTFILE2	"~/.ssh/known_hosts2"

/*
 * Name of the default file containing client-side authentication key. This
 * file should only be readable by the user him/herself.
 */
#define _PATH_SSH_CLIENT_IDENTITY	".ssh/identity"
#define _PATH_SSH_CLIENT_ID_DSA		".ssh/id_dsa"
#define _PATH_SSH_CLIENT_ID_RSA		".ssh/id_rsa"

/*
 * Configuration file in user's home directory.  This file need not be
 * readable by anyone but the user him/herself, but does not contain anything
 * particularly secret.  If the user's home directory resides on an NFS
 * volume where root is mapped to nobody, this may need to be world-readable.
 */
#define _PATH_SSH_USER_CONFFILE		".ssh/config"

/*
 * File containing a list of those rsa keys that permit logging in as this
 * user.  This file need not be readable by anyone but the user him/herself,
 * but does not contain anything particularly secret.  If the user's home
 * directory resides on an NFS volume where root is mapped to nobody, this
 * may need to be world-readable.  (This file is read by the daemon which is
 * running as root.)
 */
#define _PATH_SSH_USER_PERMITTED_KEYS	".ssh/authorized_keys"

/* backward compat for protocol v2 */
#define _PATH_SSH_USER_PERMITTED_KEYS2	".ssh/authorized_keys2"

/*
 * Per-user and system-wide ssh "rc" files.  These files are executed with
 * /bin/sh before starting the shell or command if they exist.  They will be
 * passed "proto cookie" as arguments if X11 forwarding with spoofing is in
 * use.  xauth will be run if neither of these exists.
 */
#define _PATH_SSH_USER_RC		".ssh/rc"
#define _PATH_SSH_SYSTEM_RC		SSHDIR "/sshrc"

/*
 * Ssh-only version of /etc/hosts.equiv.  Additionally, the daemon may use
 * ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
 */
#define _PATH_SSH_HOSTS_EQUIV		SSHDIR "/shosts.equiv"
#define _PATH_RHOSTS_EQUIV		"/etc/hosts.equiv"

/*
 * Default location of askpass
 */
#ifndef _PATH_SSH_ASKPASS_DEFAULT
#define _PATH_SSH_ASKPASS_DEFAULT	"/usr/X11R6/bin/ssh-askpass"
#endif

/* Location of ssh-keysign for hostbased authentication */
#ifndef _PATH_SSH_KEY_SIGN
#define _PATH_SSH_KEY_SIGN		"/usr/libexec/ssh-keysign"
#endif

/* xauth for X11 forwarding */
#ifndef _PATH_XAUTH
#define _PATH_XAUTH			"/usr/X11R6/bin/xauth"
#endif

/* UNIX domain socket for X11 server; displaynum will replace %u */
#ifndef _PATH_UNIX_X
#define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
#endif

/* for scp */
#ifndef _PATH_CP
#define _PATH_CP			"cp"
#endif

/* for sftp */
#ifndef _PATH_SFTP_SERVER
#define _PATH_SFTP_SERVER		"/usr/libexec/sftp-server"
#endif

/* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
#ifndef _PATH_PRIVSEP_CHROOT_DIR
#define _PATH_PRIVSEP_CHROOT_DIR	"/var/empty"
#endif

/* for passwd change */
#ifndef _PATH_PASSWD_PROG
#define _PATH_PASSWD_PROG             "/usr/bin/passwd"
#endif

#ifndef _PATH_LS
#define _PATH_LS			"ls"
#endif

/* path to login program */
#ifndef LOGIN_PROGRAM
# ifdef LOGIN_PROGRAM_FALLBACK
#  define LOGIN_PROGRAM         LOGIN_PROGRAM_FALLBACK
# else
#  define LOGIN_PROGRAM         "/usr/bin/login"
# endif
#endif /* LOGIN_PROGRAM */

/* Askpass program define */
#ifndef ASKPASS_PROGRAM
#define ASKPASS_PROGRAM         "/usr/lib/ssh/ssh-askpass"
#endif /* ASKPASS_PROGRAM */
Commit	Line	Data
040d6b1f	1	/* $OpenBSD: pathnames.h,v 1.17 2008/12/29 02:23:26 stevesk Exp $ */
23c2a7a5	2
42f11eb2	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
42f11eb2	15	#define ETCDIR "/etc"
2a8a6488	16
	17	#ifndef SSHDIR
	18	#define SSHDIR ETCDIR "/ssh"
42f11eb2	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	*/
2a8a6488	29	#define _PATH_SSH_SYSTEM_HOSTFILE SSHDIR "/ssh_known_hosts"
f49bc4f7	30	/* backward compat for protocol 2 */
2a8a6488	31	#define _PATH_SSH_SYSTEM_HOSTFILE2 SSHDIR "/ssh_known_hosts2"
42f11eb2	32
	33	/*
	34	* Of these, ssh_host_key must be readable only by root, whereas ssh_config
	35	* should be world-readable.
	36	*/
2a8a6488	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_RSA_KEY_FILE SSHDIR "/ssh_host_rsa_key"
	42	#define _PATH_DH_MODULI SSHDIR "/moduli"
e2854364	43	/* Backwards compatibility */
2a8a6488	44	#define _PATH_DH_PRIMES SSHDIR "/primes"
42f11eb2	45
c9606e03	46	#ifndef _PATH_SSH_PROGRAM
42f11eb2	47	#define _PATH_SSH_PROGRAM "/usr/bin/ssh"
c9606e03	48	#endif
42f11eb2	49
	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	/*
040d6b1f	57	* The directory in user's home directory in which the files reside. The
42f11eb2	58	* 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	*/
	67	#define _PATH_SSH_USER_HOSTFILE "~/.ssh/known_hosts"
f49bc4f7	68	/* backward compat for protocol 2 */
42f11eb2	69	#define _PATH_SSH_USER_HOSTFILE2 "~/.ssh/known_hosts2"
	70
	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	*/
	75	#define _PATH_SSH_CLIENT_IDENTITY ".ssh/identity"
	76	#define _PATH_SSH_CLIENT_ID_DSA ".ssh/id_dsa"
	77	#define _PATH_SSH_CLIENT_ID_RSA ".ssh/id_rsa"
	78
	79	/*
040d6b1f	80	* Configuration file in user's home directory. This file need not be
42f11eb2	81	* readable by anyone but the user him/herself, but does not contain anything
040d6b1f	82	* particularly secret. If the user's home directory resides on an NFS
42f11eb2	83	* volume where root is mapped to nobody, this may need to be world-readable.
	84	*/
	85	#define _PATH_SSH_USER_CONFFILE ".ssh/config"
	86
	87	/*
	88	* File containing a list of those rsa keys that permit logging in as this
	89	* user. This file need not be readable by anyone but the user him/herself,
040d6b1f	90	* but does not contain anything particularly secret. If the user's home
42f11eb2	91	* directory resides on an NFS volume where root is mapped to nobody, this
	92	* may need to be world-readable. (This file is read by the daemon which is
	93	* running as root.)
	94	*/
	95	#define _PATH_SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
96a7b0cc	96
96a7b0cc	97	/* backward compat for protocol v2 */
42f11eb2	98	#define _PATH_SSH_USER_PERMITTED_KEYS2 ".ssh/authorized_keys2"
	99
	100	/*
	101	* Per-user and system-wide ssh "rc" files. These files are executed with
	102	* /bin/sh before starting the shell or command if they exist. They will be
	103	* passed "proto cookie" as arguments if X11 forwarding with spoofing is in
	104	* use. xauth will be run if neither of these exists.
	105	*/
	106	#define _PATH_SSH_USER_RC ".ssh/rc"
2a8a6488	107	#define _PATH_SSH_SYSTEM_RC SSHDIR "/sshrc"
42f11eb2	108
	109	/*
	110	* Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
	111	* ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
	112	*/
2a8a6488	113	#define _PATH_SSH_HOSTS_EQUIV SSHDIR "/shosts.equiv"
42f11eb2	114	#define _PATH_RHOSTS_EQUIV "/etc/hosts.equiv"
	115
	116	/*
	117	* Default location of askpass
	118	*/
effa6591	119	#ifndef _PATH_SSH_ASKPASS_DEFAULT
42f11eb2	120	#define _PATH_SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
effa6591	121	#endif
42f11eb2	122
39c00dc2	123	/* Location of ssh-keysign for hostbased authentication */
39c00dc2	124	#ifndef _PATH_SSH_KEY_SIGN
f2107e97	125	#define _PATH_SSH_KEY_SIGN "/usr/libexec/ssh-keysign"
39c00dc2	126	#endif
39c00dc2	127
fef01705	128	/* xauth for X11 forwarding */
	129	#ifndef _PATH_XAUTH
	130	#define _PATH_XAUTH "/usr/X11R6/bin/xauth"
	131	#endif
	132
805e659f	133	/* UNIX domain socket for X11 server; displaynum will replace %u */
	134	#ifndef _PATH_UNIX_X
	135	#define _PATH_UNIX_X "/tmp/.X11-unix/X%u"
	136	#endif
	137
42f11eb2	138	/* for scp */
	139	#ifndef _PATH_CP
	140	#define _PATH_CP "cp"
	141	#endif
	142
0426a3b4	143	/* for sftp */
	144	#ifndef _PATH_SFTP_SERVER
	145	#define _PATH_SFTP_SERVER "/usr/libexec/sftp-server"
	146	#endif
1c352e97	147
1c352e97	148	/* chroot directory for unprivileged user when UsePrivilegeSeparation=yes */
ecac8ee5	149	#ifndef _PATH_PRIVSEP_CHROOT_DIR
1c352e97	150	#define _PATH_PRIVSEP_CHROOT_DIR "/var/empty"
ecac8ee5	151	#endif
ecac8ee5	152
37656beb	153	/* for passwd change */
	154	#ifndef _PATH_PASSWD_PROG
	155	#define _PATH_PASSWD_PROG "/usr/bin/passwd"
	156	#endif
	157
a0aede1b	158	#ifndef _PATH_LS
0426a3b4	159	#define _PATH_LS "ls"
a0aede1b	160	#endif
0426a3b4	161
42f11eb2	162	/* path to login program */
	163	#ifndef LOGIN_PROGRAM
	164	# ifdef LOGIN_PROGRAM_FALLBACK
	165	# define LOGIN_PROGRAM LOGIN_PROGRAM_FALLBACK
	166	# else
	167	# define LOGIN_PROGRAM "/usr/bin/login"
	168	# endif
	169	#endif /* LOGIN_PROGRAM */
	170
	171	/* Askpass program define */
	172	#ifndef ASKPASS_PROGRAM
	173	#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
	174	#endif /* ASKPASS_PROGRAM */