blob: a3b2ebbb5620ebd04bb45f11728938ec2caf45c1 [file] [log] [blame]
Darren Tucker3175eb92003-12-09 19:15:11 +11001/* $OpenBSD: ssh.h,v 1.75 2003/12/02 17:01:15 markus Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller4af51302000-04-16 11:18:38 +10007 *
Damien Millere4340be2000-09-16 13:29:08 +11008 * 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".
Damien Miller95def091999-11-25 00:26:21 +110013 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100014
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015#ifndef SSH_H
16#define SSH_H
17
Damien Millerab18c411999-11-11 10:40:23 +110018#include <netinet/in.h> /* For struct sockaddr_in */
19#include <pwd.h> /* For struct pw */
Damien Miller5ce662a1999-11-11 17:57:39 +110020#include <stdarg.h> /* For va_list */
Damien Miller6dbfef62000-11-29 13:51:06 +110021#include <syslog.h> /* For LOG_AUTH and friends */
Damien Miller34132e52000-01-14 15:45:46 +110022#include <sys/socket.h> /* For struct sockaddr_storage */
Damien Miller365199d1999-12-22 00:12:38 +110023#ifdef HAVE_SYS_SELECT_H
24# include <sys/select.h>
25#endif
Ben Lindstrom226cfa02001-01-22 05:34:40 +000026
Damien Millerd4a8b7e1999-10-27 13:42:43 +100027/* Cipher used for encrypting authentication files. */
28#define SSH_AUTHFILE_CIPHER SSH_CIPHER_3DES
29
30/* Default port number. */
31#define SSH_DEFAULT_PORT 22
32
33/* Maximum number of TCP/IP ports forwarded per direction. */
34#define SSH_MAX_FORWARDS_PER_DIRECTION 100
35
Damien Miller5428f641999-11-25 11:54:57 +110036/*
37 * Maximum number of RSA authentication identity files that can be specified
38 * in configuration files or on the command line.
39 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100040#define SSH_MAX_IDENTITY_FILES 100
41
Damien Miller5428f641999-11-25 11:54:57 +110042/*
Ben Lindstrom2e14bc72002-06-06 20:56:07 +000043 * Major protocol version. Different version indicates major incompatibility
Damien Miller5428f641999-11-25 11:54:57 +110044 * that prevents communication.
Damien Miller78928792000-04-12 20:17:38 +100045 *
Damien Miller5428f641999-11-25 11:54:57 +110046 * Minor protocol version. Different version indicates minor incompatibility
47 * that does not prevent interoperation.
48 */
Damien Miller78928792000-04-12 20:17:38 +100049#define PROTOCOL_MAJOR_1 1
50#define PROTOCOL_MINOR_1 5
51
52/* We support both SSH1 and SSH2 */
53#define PROTOCOL_MAJOR_2 2
54#define PROTOCOL_MINOR_2 0
Damien Millerd4a8b7e1999-10-27 13:42:43 +100055
Damien Miller5428f641999-11-25 11:54:57 +110056/*
57 * Name for the service. The port named by this service overrides the
58 * default port if present.
59 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100060#define SSH_SERVICE_NAME "ssh"
61
Damien Miller5428f641999-11-25 11:54:57 +110062/*
Ben Lindstrom5590aa52002-06-23 00:30:30 +000063 * Name of the environment variable containing the process ID of the
64 * authentication agent.
Damien Miller5428f641999-11-25 11:54:57 +110065 */
Kevin Steves28a7f262001-02-05 15:43:59 +000066#define SSH_AGENTPID_ENV_NAME "SSH_AGENT_PID"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100067
Damien Miller5428f641999-11-25 11:54:57 +110068/*
69 * Name of the environment variable containing the pathname of the
70 * authentication socket.
71 */
Ben Lindstrom226cfa02001-01-22 05:34:40 +000072#define SSH_AUTHSOCKET_ENV_NAME "SSH_AUTH_SOCK"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100073
Damien Miller5428f641999-11-25 11:54:57 +110074/*
Ben Lindstrom226cfa02001-01-22 05:34:40 +000075 * Environment variable for overwriting the default location of askpass
Damien Miller5428f641999-11-25 11:54:57 +110076 */
Damien Milleraae6c611999-12-06 11:47:28 +110077#define SSH_ASKPASS_ENV "SSH_ASKPASS"
78
79/*
Damien Miller5428f641999-11-25 11:54:57 +110080 * Force host key length and server key length to differ by at least this
81 * many bits. This is to make double encryption with rsaref work.
82 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083#define SSH_KEY_BITS_RESERVED 128
84
Damien Miller5428f641999-11-25 11:54:57 +110085/*
86 * Length of the session key in bytes. (Specified as 256 bits in the
87 * protocol.)
88 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100089#define SSH_SESSION_KEY_LENGTH 32
90
Ben Lindstrom2b1f71b2001-06-05 20:32:21 +000091/* Used to identify ``EscapeChar none'' */
92#define SSH_ESCAPECHAR_NONE -2
93
Ben Lindstromc7431342002-03-22 03:11:49 +000094/*
95 * unprivileged user when UsePrivilegeSeparation=yes;
Ben Lindstrom966bfda2002-05-15 16:09:57 +000096 * sshd will change its privileges to this user and its
Ben Lindstromc7431342002-03-22 03:11:49 +000097 * primary group.
98 */
Kevin Steves7ff91122002-04-07 19:22:54 +000099#ifndef SSH_PRIVSEP_USER
Ben Lindstrom973be002002-05-15 16:08:48 +0000100#define SSH_PRIVSEP_USER "sshd"
Kevin Steves7ff91122002-04-07 19:22:54 +0000101#endif
Ben Lindstromc7431342002-03-22 03:11:49 +0000102
Ben Lindstrom03f39322002-04-02 20:43:11 +0000103/* Minimum modulus size (n) for RSA keys. */
104#define SSH_RSA_MINIMUM_MODULUS_SIZE 768
105
Darren Tucker3175eb92003-12-09 19:15:11 +1100106/* Listen backlog for sshd, ssh-agent and forwarding sockets */
107#define SSH_LISTEN_BACKLOG 128
108
Damien Miller95def091999-11-25 00:26:21 +1100109#endif /* SSH_H */