[openssh.git] / pathnames.h

/*	$OpenBSD: pathnames.h,v 1.7 2001/06/22 21:27:08 provos 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".
 */

#ifndef ETCDIR
#define ETCDIR				"/etc"
#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	ETCDIR "/ssh_known_hosts"
#define _PATH_SSH_SYSTEM_HOSTFILE2	ETCDIR "/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	ETCDIR "/sshd_config"
#define _PATH_HOST_CONFIG_FILE		ETCDIR "/ssh_config"
#define _PATH_HOST_KEY_FILE		ETCDIR "/ssh_host_key"
#define _PATH_HOST_DSA_KEY_FILE		ETCDIR "/ssh_host_dsa_key"
#define _PATH_HOST_RSA_KEY_FILE		ETCDIR "/ssh_host_rsa_key"
#define _PATH_DH_MODULI			ETCDIR "/moduli"
/* Backwards compatibility */
#define _PATH_DH_PRIMES			ETCDIR "/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"
#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"
#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		ETCDIR "/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		ETCDIR "/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

/* 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
#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 */

/*
 * Relevant only when using builtin PRNG.
 */
#ifndef SSH_PRNG_SEED_FILE
# define SSH_PRNG_SEED_FILE      _PATH_SSH_USER_DIR"/prng_seed"
#endif /* SSH_PRNG_SEED_FILE */
#ifndef SSH_PRNG_COMMAND_FILE
# define SSH_PRNG_COMMAND_FILE   ETCDIR "/ssh_prng_cmds"
#endif /* SSH_PRNG_COMMAND_FILE */
Commit	Line	Data
e2854364	1	/* $OpenBSD: pathnames.h,v 1.7 2001/06/22 21:27:08 provos 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
	15	#ifndef ETCDIR
	16	#define ETCDIR "/etc"
	17	#endif
	18
	19	#ifndef _PATH_SSH_PIDDIR
	20	#define _PATH_SSH_PIDDIR "/var/run"
	21	#endif
	22
	23	/*
	24	* System-wide file containing host keys of known hosts. This file should be
	25	* world-readable.
	26	*/
	27	#define _PATH_SSH_SYSTEM_HOSTFILE ETCDIR "/ssh_known_hosts"
	28	#define _PATH_SSH_SYSTEM_HOSTFILE2 ETCDIR "/ssh_known_hosts2"
	29
	30	/*
	31	* Of these, ssh_host_key must be readable only by root, whereas ssh_config
	32	* should be world-readable.
	33	*/
42f11eb2	34	#define _PATH_SERVER_CONFIG_FILE ETCDIR "/sshd_config"
42f11eb2	35	#define _PATH_HOST_CONFIG_FILE ETCDIR "/ssh_config"
8002af61	36	#define _PATH_HOST_KEY_FILE ETCDIR "/ssh_host_key"
42f11eb2	37	#define _PATH_HOST_DSA_KEY_FILE ETCDIR "/ssh_host_dsa_key"
8002af61	38	#define _PATH_HOST_RSA_KEY_FILE ETCDIR "/ssh_host_rsa_key"
e2854364	39	#define _PATH_DH_MODULI ETCDIR "/moduli"
e2854364	40	/* Backwards compatibility */
42f11eb2	41	#define _PATH_DH_PRIMES ETCDIR "/primes"
42f11eb2	42
c9606e03	43	#ifndef _PATH_SSH_PROGRAM
42f11eb2	44	#define _PATH_SSH_PROGRAM "/usr/bin/ssh"
c9606e03	45	#endif
42f11eb2	46
	47	/*
	48	* The process id of the daemon listening for connections is saved here to
	49	* make it easier to kill the correct daemon when necessary.
	50	*/
	51	#define _PATH_SSH_DAEMON_PID_FILE _PATH_SSH_PIDDIR "/sshd.pid"
	52
	53	/*
	54	* The directory in user\'s home directory in which the files reside. The
	55	* directory should be world-readable (though not all files are).
	56	*/
	57	#define _PATH_SSH_USER_DIR ".ssh"
	58
	59	/*
	60	* Per-user file containing host keys of known hosts. This file need not be
	61	* readable by anyone except the user him/herself, though this does not
	62	* contain anything particularly secret.
	63	*/
	64	#define _PATH_SSH_USER_HOSTFILE "~/.ssh/known_hosts"
	65	#define _PATH_SSH_USER_HOSTFILE2 "~/.ssh/known_hosts2"
	66
	67	/*
	68	* Name of the default file containing client-side authentication key. This
	69	* file should only be readable by the user him/herself.
	70	*/
	71	#define _PATH_SSH_CLIENT_IDENTITY ".ssh/identity"
	72	#define _PATH_SSH_CLIENT_ID_DSA ".ssh/id_dsa"
	73	#define _PATH_SSH_CLIENT_ID_RSA ".ssh/id_rsa"
	74
	75	/*
	76	* Configuration file in user\'s home directory. This file need not be
	77	* readable by anyone but the user him/herself, but does not contain anything
	78	* particularly secret. If the user\'s home directory resides on an NFS
	79	* volume where root is mapped to nobody, this may need to be world-readable.
	80	*/
	81	#define _PATH_SSH_USER_CONFFILE ".ssh/config"
	82
	83	/*
	84	* File containing a list of those rsa keys that permit logging in as this
	85	* user. This file need not be readable by anyone but the user him/herself,
	86	* but does not contain anything particularly secret. If the user\'s home
	87	* directory resides on an NFS volume where root is mapped to nobody, this
	88	* may need to be world-readable. (This file is read by the daemon which is
	89	* running as root.)
	90	*/
	91	#define _PATH_SSH_USER_PERMITTED_KEYS ".ssh/authorized_keys"
	92	#define _PATH_SSH_USER_PERMITTED_KEYS2 ".ssh/authorized_keys2"
	93
	94	/*
	95	* Per-user and system-wide ssh "rc" files. These files are executed with
	96	* /bin/sh before starting the shell or command if they exist. They will be
	97	* passed "proto cookie" as arguments if X11 forwarding with spoofing is in
	98	* use. xauth will be run if neither of these exists.
	99	*/
	100	#define _PATH_SSH_USER_RC ".ssh/rc"
	101	#define _PATH_SSH_SYSTEM_RC ETCDIR "/sshrc"
	102
	103	/*
	104	* Ssh-only version of /etc/hosts.equiv. Additionally, the daemon may use
	105	* ~/.rhosts and /etc/hosts.equiv if rhosts authentication is enabled.
	106	*/
	107	#define _PATH_SSH_HOSTS_EQUIV ETCDIR "/shosts.equiv"
	108	#define _PATH_RHOSTS_EQUIV "/etc/hosts.equiv"
	109
110	/*
111	* Default location of askpass
112	*/
effa6591	113	#ifndef _PATH_SSH_ASKPASS_DEFAULT
42f11eb2	114	#define _PATH_SSH_ASKPASS_DEFAULT "/usr/X11R6/bin/ssh-askpass"
effa6591	115	#endif
42f11eb2	116
	117	/* for scp */
	118	#ifndef _PATH_CP
	119	#define _PATH_CP "cp"
	120	#endif
	121
0426a3b4	122	/* for sftp */
	123	#ifndef _PATH_SFTP_SERVER
	124	#define _PATH_SFTP_SERVER "/usr/libexec/sftp-server"
	125	#endif
a0aede1b	126	#ifndef _PATH_LS
0426a3b4	127	#define _PATH_LS "ls"
a0aede1b	128	#endif
0426a3b4	129
42f11eb2	130	/* path to login program */
	131	#ifndef LOGIN_PROGRAM
	132	# ifdef LOGIN_PROGRAM_FALLBACK
	133	# define LOGIN_PROGRAM LOGIN_PROGRAM_FALLBACK
	134	# else
	135	# define LOGIN_PROGRAM "/usr/bin/login"
	136	# endif
	137	#endif /* LOGIN_PROGRAM */
	138
	139	/* Askpass program define */
	140	#ifndef ASKPASS_PROGRAM
	141	#define ASKPASS_PROGRAM "/usr/lib/ssh/ssh-askpass"
	142	#endif /* ASKPASS_PROGRAM */
	143
	144	/*
	145	* Relevant only when using builtin PRNG.
	146	*/
	147	#ifndef SSH_PRNG_SEED_FILE
effa6591	148	# define SSH_PRNG_SEED_FILE _PATH_SSH_USER_DIR"/prng_seed"
42f11eb2	149	#endif /* SSH_PRNG_SEED_FILE */
	150	#ifndef SSH_PRNG_COMMAND_FILE
	151	# define SSH_PRNG_COMMAND_FILE ETCDIR "/ssh_prng_cmds"
	152	#endif /* SSH_PRNG_COMMAND_FILE */
	153