[openssh.git] / ssh.h

/* $OpenBSD: ssh.h,v 1.78 2006/08/03 03:34:42 deraadt 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".
 */

/* Cipher used for encrypting authentication files. */
#define SSH_AUTHFILE_CIPHER	SSH_CIPHER_3DES

/* Default port number. */
#define SSH_DEFAULT_PORT	22

/* Maximum number of TCP/IP ports forwarded per direction. */
#define SSH_MAX_FORWARDS_PER_DIRECTION	100

/*
 * Maximum number of RSA authentication identity files that can be specified
 * in configuration files or on the command line.
 */
#define SSH_MAX_IDENTITY_FILES		100

/*
 * Maximum length of lines in authorized_keys file.
 * Current value permits 16kbit RSA and RSA1 keys and 8kbit DSA keys, with
 * some room for options and comments.
 */
#define SSH_MAX_PUBKEY_BYTES		8192

/*
 * Major protocol version.  Different version indicates major incompatibility
 * that prevents communication.
 *
 * Minor protocol version.  Different version indicates minor incompatibility
 * that does not prevent interoperation.
 */
#define PROTOCOL_MAJOR_1	1
#define PROTOCOL_MINOR_1	5

/* We support both SSH1 and SSH2 */
#define PROTOCOL_MAJOR_2	2
#define PROTOCOL_MINOR_2	0

/*
 * Name for the service.  The port named by this service overrides the
 * default port if present.
 */
#define SSH_SERVICE_NAME	"ssh"

/*
 * Name of the environment variable containing the process ID of the
 * authentication agent.
 */
#define SSH_AGENTPID_ENV_NAME	"SSH_AGENT_PID"

/*
 * Name of the environment variable containing the pathname of the
 * authentication socket.
 */
#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"

/*
 * Environment variable for overwriting the default location of askpass
 */
#define SSH_ASKPASS_ENV		"SSH_ASKPASS"

/*
 * Force host key length and server key length to differ by at least this
 * many bits.  This is to make double encryption with rsaref work.
 */
#define SSH_KEY_BITS_RESERVED		128

/*
 * Length of the session key in bytes.  (Specified as 256 bits in the
 * protocol.)
 */
#define SSH_SESSION_KEY_LENGTH		32

/* Used to identify ``EscapeChar none'' */
#define SSH_ESCAPECHAR_NONE		-2

/*
 * unprivileged user when UsePrivilegeSeparation=yes;
 * sshd will change its privileges to this user and its
 * primary group.
 */
#ifndef SSH_PRIVSEP_USER
#define SSH_PRIVSEP_USER		"sshd"
#endif

/* Minimum modulus size (n) for RSA keys. */
#define SSH_RSA_MINIMUM_MODULUS_SIZE	768

/* Listen backlog for sshd, ssh-agent and forwarding sockets */
#define SSH_LISTEN_BACKLOG		128
Commit	Line	Data
31652869	1	/* $OpenBSD: ssh.h,v 1.78 2006/08/03 03:34:42 deraadt Exp $ */
93c3b6de	2
8efc0c15	3	/*
5260325f	4	* Author: Tatu Ylonen <ylo@cs.hut.fi>
5260325f	5	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5260325f	6	* All rights reserved
6ae2364d	7	*
bcbf86ec	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".
5260325f	13	*/
8efc0c15	14
8efc0c15	15	/* Cipher used for encrypting authentication files. */
	16	#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
	17
	18	/* Default port number. */
	19	#define SSH_DEFAULT_PORT 22
	20
	21	/* Maximum number of TCP/IP ports forwarded per direction. */
	22	#define SSH_MAX_FORWARDS_PER_DIRECTION 100
	23
aa3378df	24	/*
	25	* Maximum number of RSA authentication identity files that can be specified
	26	* in configuration files or on the command line.
	27	*/
8efc0c15	28	#define SSH_MAX_IDENTITY_FILES 100
8efc0c15	29
ea067773	30	/*
	31	* Maximum length of lines in authorized_keys file.
	32	* Current value permits 16kbit RSA and RSA1 keys and 8kbit DSA keys, with
	33	* some room for options and comments.
	34	*/
	35	#define SSH_MAX_PUBKEY_BYTES 8192
	36
aa3378df	37	/*
7f056bc5	38	* Major protocol version. Different version indicates major incompatibility
aa3378df	39	* that prevents communication.
a8be9f80	40	*
aa3378df	41	* Minor protocol version. Different version indicates minor incompatibility
	42	* that does not prevent interoperation.
	43	*/
a8be9f80	44	#define PROTOCOL_MAJOR_1 1
	45	#define PROTOCOL_MINOR_1 5
	46
	47	/* We support both SSH1 and SSH2 */
	48	#define PROTOCOL_MAJOR_2 2
	49	#define PROTOCOL_MINOR_2 0
8efc0c15	50
aa3378df	51	/*
	52	* Name for the service. The port named by this service overrides the
	53	* default port if present.
	54	*/
8efc0c15	55	#define SSH_SERVICE_NAME "ssh"
8efc0c15	56
aa3378df	57	/*
a8bbdc75	58	* Name of the environment variable containing the process ID of the
a8bbdc75	59	* authentication agent.
aa3378df	60	*/
b705bea0	61	#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
8efc0c15	62
aa3378df	63	/*
	64	* Name of the environment variable containing the pathname of the
	65	* authentication socket.
	66	*/
42f11eb2	67	#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
50da1126	68
57112b5a	69	/*
42f11eb2	70	* Environment variable for overwriting the default location of askpass
57112b5a	71	*/
57112b5a	72	#define SSH_ASKPASS_ENV "SSH_ASKPASS"
57112b5a	73
aa3378df	74	/*
	75	* Force host key length and server key length to differ by at least this
	76	* many bits. This is to make double encryption with rsaref work.
	77	*/
8efc0c15	78	#define SSH_KEY_BITS_RESERVED 128
8efc0c15	79
aa3378df	80	/*
	81	* Length of the session key in bytes. (Specified as 256 bits in the
	82	* protocol.)
	83	*/
8efc0c15	84	#define SSH_SESSION_KEY_LENGTH 32
8efc0c15	85
4bf9c10e	86	/* Used to identify ``EscapeChar none'' */
	87	#define SSH_ESCAPECHAR_NONE -2
	88
2ea6de2b	89	/*
2ea6de2b	90	* unprivileged user when UsePrivilegeSeparation=yes;
5de727d6	91	* sshd will change its privileges to this user and its
2ea6de2b	92	* primary group.
2ea6de2b	93	*/
9a0fbcb3	94	#ifndef SSH_PRIVSEP_USER
897fecd3	95	#define SSH_PRIVSEP_USER "sshd"
9a0fbcb3	96	#endif
2ea6de2b	97
82b00264	98	/* Minimum modulus size (n) for RSA keys. */
	99	#define SSH_RSA_MINIMUM_MODULUS_SIZE 768
	100
fce39749	101	/* Listen backlog for sshd, ssh-agent and forwarding sockets */
fce39749	102	#define SSH_LISTEN_BACKLOG 128