williamr@2: /* TELNET.H
williamr@2:  * 
williamr@4:  * Portions Copyright (c) 1993-1999 Nokia Corporation and/or its subsidiary(-ies).
williamr@4:  * All rights reserved.
williamr@2:  */
williamr@2: 
williamr@2: /** @file
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: 
williamr@2: /*
williamr@2:  * Copyright (c) 1983, 1993
williamr@2:  *	The Regents of the University of California.  All rights reserved.
williamr@2:  *
williamr@2:  * Redistribution and use in source and binary forms, with or without
williamr@2:  * modification, are permitted provided that the following conditions
williamr@2:  * are met:
williamr@2:  * 1. Redistributions of source code must retain the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer.
williamr@2:  * 2. Redistributions in binary form must reproduce the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer in the
williamr@2:  *    documentation and/or other materials provided with the distribution.
williamr@2:  * 3. All advertising materials mentioning features or use of this software
williamr@2:  *    must display the following acknowledgement:
williamr@2:  *	This product includes software developed by the University of
williamr@2:  *	California, Berkeley and its contributors.
williamr@2:  * 4. Neither the name of the University nor the names of its contributors
williamr@2:  *    may be used to endorse or promote products derived from this software
williamr@2:  *    without specific prior written permission.
williamr@2:  *
williamr@2:  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
williamr@2:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
williamr@2:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
williamr@2:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
williamr@2:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
williamr@2:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
williamr@2:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
williamr@2:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
williamr@2:  * SUCH DAMAGE.
williamr@2:  *
williamr@2:  *	@(#)telnet.h	8.2 (Berkeley) 12/15/93
williamr@2:  */
williamr@2: 
williamr@2: #ifndef _ARPA_TELNET_H_
williamr@2: #define	_ARPA_TELNET_H_
williamr@2: 
williamr@2: /**
williamr@2: Definitions for the TELNET protocol.
williamr@2: */
williamr@2: #define	IAC	255		/* interpret as command: */
williamr@2: #define	DONT	254		/* you are not to use option */
williamr@2: #define	DO	253		/* please, you use option */
williamr@2: #define	WONT	252		/* I won't use option */
williamr@2: #define	WILL	251		/* I will use option */
williamr@2: #define	SB	250		/* interpret as subnegotiation */
williamr@2: #define	GA	249		/* you may reverse the line */
williamr@2: #define	EL	248		/* erase the current line */
williamr@2: #define	EC	247		/* erase the current character */
williamr@2: #define	AYT	246		/* are you there */
williamr@2: #define	AO	245		/* abort output--but let prog finish */
williamr@2: #define	IP	244		/* interrupt process--permanently */
williamr@2: #define	BREAK	243		/* break */
williamr@2: #define	DM	242		/* data mark--for connect. cleaning */
williamr@2: #define	NOP	241		/* nop */
williamr@2: #define	SE	240		/* end sub negotiation */
williamr@2: #define EOR     239             /* end of record (transparent mode) */
williamr@2: #define	ABORT	238		/* Abort process */
williamr@2: #define	SUSP	237		/* Suspend process */
williamr@2: #define	xEOF	236		/* End of file: EOF is already used... */
williamr@2: 
williamr@2: #define SYNCH	242		/* for telfunc calls */
williamr@2: 
williamr@2: #ifdef TELCMDS
williamr@2: char *telcmds[] = {
williamr@2: 	"EOF", "SUSP", "ABORT", "EOR",
williamr@2: 	"SE", "NOP", "DMARK", "BRK", "IP", "AO", "AYT", "EC",
williamr@2: 	"EL", "GA", "SB", "WILL", "WONT", "DO", "DONT", "IAC",
williamr@2: 	0
williamr@2: };
williamr@2: #else
williamr@2: extern char *telcmds[];
williamr@2: #endif
williamr@2: 
williamr@2: #define	TELCMD_FIRST	xEOF
williamr@2: #define	TELCMD_LAST	IAC
williamr@2: #define	TELCMD_OK(x)	((unsigned int)(x) <= TELCMD_LAST && \
williamr@2: 			 (unsigned int)(x) >= TELCMD_FIRST)
williamr@2: #define	TELCMD(x)	telcmds[(x)-TELCMD_FIRST]
williamr@2: 
williamr@2: /**
williamr@2: telnet options 
williamr@2: */
williamr@2: #define TELOPT_BINARY	0	/* 8-bit data path */
williamr@2: #define TELOPT_ECHO	1	/* echo */
williamr@2: #define	TELOPT_RCP	2	/* prepare to reconnect */
williamr@2: #define	TELOPT_SGA	3	/* suppress go ahead */
williamr@2: #define	TELOPT_NAMS	4	/* approximate message size */
williamr@2: #define	TELOPT_STATUS	5	/* give status */
williamr@2: #define	TELOPT_TM	6	/* timing mark */
williamr@2: #define	TELOPT_RCTE	7	/* remote controlled transmission and echo */
williamr@2: #define TELOPT_NAOL 	8	/* negotiate about output line width */
williamr@2: #define TELOPT_NAOP 	9	/* negotiate about output page size */
williamr@2: #define TELOPT_NAOCRD	10	/* negotiate about CR disposition */
williamr@2: #define TELOPT_NAOHTS	11	/* negotiate about horizontal tabstops */
williamr@2: #define TELOPT_NAOHTD	12	/* negotiate about horizontal tab disposition */
williamr@2: #define TELOPT_NAOFFD	13	/* negotiate about formfeed disposition */
williamr@2: #define TELOPT_NAOVTS	14	/* negotiate about vertical tab stops */
williamr@2: #define TELOPT_NAOVTD	15	/* negotiate about vertical tab disposition */
williamr@2: #define TELOPT_NAOLFD	16	/* negotiate about output LF disposition */
williamr@2: #define TELOPT_XASCII	17	/* extended ascic character set */
williamr@2: #define	TELOPT_LOGOUT	18	/* force logout */
williamr@2: #define	TELOPT_BM	19	/* byte macro */
williamr@2: #define	TELOPT_DET	20	/* data entry terminal */
williamr@2: #define	TELOPT_SUPDUP	21	/* supdup protocol */
williamr@2: #define	TELOPT_SUPDUPOUTPUT 22	/* supdup output */
williamr@2: #define	TELOPT_SNDLOC	23	/* send location */
williamr@2: #define	TELOPT_TTYPE	24	/* terminal type */
williamr@2: #define	TELOPT_EOR	25	/* end or record */
williamr@2: #define	TELOPT_TUID	26	/* TACACS user identification */
williamr@2: #define	TELOPT_OUTMRK	27	/* output marking */
williamr@2: #define	TELOPT_TTYLOC	28	/* terminal location number */
williamr@2: #define	TELOPT_3270REGIME 29	/* 3270 regime */
williamr@2: #define	TELOPT_X3PAD	30	/* X.3 PAD */
williamr@2: #define	TELOPT_NAWS	31	/* window size */
williamr@2: #define	TELOPT_TSPEED	32	/* terminal speed */
williamr@2: #define	TELOPT_LFLOW	33	/* remote flow control */
williamr@2: #define TELOPT_LINEMODE	34	/* Linemode option */
williamr@2: #define TELOPT_XDISPLOC	35	/* X Display Location */
williamr@2: #define TELOPT_OLD_ENVIRON 36	/* Old - Environment variables */
williamr@2: #define	TELOPT_AUTHENTICATION 37/* Authenticate */
williamr@2: #define	TELOPT_ENCRYPT	38	/* Encryption option */
williamr@2: #define TELOPT_NEW_ENVIRON 39	/* New - Environment variables */
williamr@2: #define	TELOPT_EXOPL	255	/* extended-options-list */
williamr@2: 
williamr@2: #define	NTELOPTS	(1+TELOPT_NEW_ENVIRON)
williamr@2: #ifdef TELOPTS
williamr@2: char *telopts[NTELOPTS+1] = {
williamr@2: 	"BINARY", "ECHO", "RCP", "SUPPRESS GO AHEAD", "NAME",
williamr@2: 	"STATUS", "TIMING MARK", "RCTE", "NAOL", "NAOP",
williamr@2: 	"NAOCRD", "NAOHTS", "NAOHTD", "NAOFFD", "NAOVTS",
williamr@2: 	"NAOVTD", "NAOLFD", "EXTEND ASCII", "LOGOUT", "BYTE MACRO",
williamr@2: 	"DATA ENTRY TERMINAL", "SUPDUP", "SUPDUP OUTPUT",
williamr@2: 	"SEND LOCATION", "TERMINAL TYPE", "END OF RECORD",
williamr@2: 	"TACACS UID", "OUTPUT MARKING", "TTYLOC",
williamr@2: 	"3270 REGIME", "X.3 PAD", "NAWS", "TSPEED", "LFLOW",
williamr@2: 	"LINEMODE", "XDISPLOC", "OLD-ENVIRON", "AUTHENTICATION",
williamr@2: 	"ENCRYPT", "NEW-ENVIRON",
williamr@2: 	0
williamr@2: };
williamr@2: 
williamr@2: #define	TELOPT_FIRST	TELOPT_BINARY
williamr@2: #define	TELOPT_LAST	TELOPT_NEW_ENVIRON
williamr@2: #define	TELOPT_OK(x)	((unsigned int)(x) <= TELOPT_LAST)
williamr@2: #define	TELOPT(x)	telopts[(x)-TELOPT_FIRST]
williamr@2: #endif
williamr@2: 
williamr@2: /** 
williamr@2: sub-option qualifiers 
williamr@2: */
williamr@2: #define	TELQUAL_IS	0	/* option is... */
williamr@2: #define	TELQUAL_SEND	1	/* send option */
williamr@2: #define	TELQUAL_INFO	2	/* ENVIRON: informational version of IS */
williamr@2: #define	TELQUAL_REPLY	2	/* AUTHENTICATION: client version of IS */
williamr@2: #define	TELQUAL_NAME	3	/* AUTHENTICATION: client version of IS */
williamr@2: 
williamr@2: #define	LFLOW_OFF		0	/* Disable remote flow control */
williamr@2: #define	LFLOW_ON		1	/* Enable remote flow control */
williamr@2: #define	LFLOW_RESTART_ANY	2	/* Restart output on any char */
williamr@2: #define	LFLOW_RESTART_XON	3	/* Restart output only on XON */
williamr@2: 
williamr@2: /**
williamr@2: LINEMODE suboptions
williamr@2: */
williamr@2: #define	LM_MODE		1
williamr@2: #define	LM_FORWARDMASK	2
williamr@2: #define	LM_SLC		3
williamr@2: 
williamr@2: #define	MODE_EDIT	0x01
williamr@2: #define	MODE_TRAPSIG	0x02
williamr@2: #define	MODE_ACK	0x04
williamr@2: #define MODE_SOFT_TAB	0x08
williamr@2: #define MODE_LIT_ECHO	0x10
williamr@2: 
williamr@2: #define	MODE_MASK	0x1f
williamr@2: 
williamr@2: /** 
williamr@2: Not part of protocol, but needed to simplify things... 
williamr@2: */
williamr@2: #define MODE_FLOW		0x0100
williamr@2: #define MODE_ECHO		0x0200
williamr@2: #define MODE_INBIN		0x0400
williamr@2: #define MODE_OUTBIN		0x0800
williamr@2: #define MODE_FORCE		0x1000
williamr@2: 
williamr@2: #define	SLC_SYNCH	1
williamr@2: #define	SLC_BRK		2
williamr@2: #define	SLC_IP		3
williamr@2: #define	SLC_AO		4
williamr@2: #define	SLC_AYT		5
williamr@2: #define	SLC_EOR		6
williamr@2: #define	SLC_ABORT	7
williamr@2: #define	SLC_EOF		8
williamr@2: #define	SLC_SUSP	9
williamr@2: #define	SLC_EC		10
williamr@2: #define	SLC_EL		11
williamr@2: #define	SLC_EW		12
williamr@2: #define	SLC_RP		13
williamr@2: #define	SLC_LNEXT	14
williamr@2: #define	SLC_XON		15
williamr@2: #define	SLC_XOFF	16
williamr@2: #define	SLC_FORW1	17
williamr@2: #define	SLC_FORW2	18
williamr@2: #define SLC_MCL         19
williamr@2: #define SLC_MCR         20
williamr@2: #define SLC_MCWL        21
williamr@2: #define SLC_MCWR        22
williamr@2: #define SLC_MCBOL       23
williamr@2: #define SLC_MCEOL       24
williamr@2: #define SLC_INSRT       25
williamr@2: #define SLC_OVER        26
williamr@2: #define SLC_ECR         27
williamr@2: #define SLC_EWR         28
williamr@2: #define SLC_EBOL        29
williamr@2: #define SLC_EEOL        30
williamr@2: 
williamr@2: #define	NSLC		30
williamr@2: 
williamr@2: /**
williamr@2: For backwards compatability, we define SLC_NAMES to be the
williamr@2: list of names if SLC_NAMES is not defined.
williamr@2: */
williamr@2: #define	SLC_NAMELIST	"0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR",	\
williamr@2: 			"ABORT", "EOF", "SUSP", "EC", "EL", "EW", "RP",	\
williamr@2: 			"LNEXT", "XON", "XOFF", "FORW1", "FORW2",	\
williamr@2: 			"MCL", "MCR", "MCWL", "MCWR", "MCBOL",		\
williamr@2: 			"MCEOL", "INSRT", "OVER", "ECR", "EWR",		\
williamr@2: 			"EBOL", "EEOL",					\
williamr@2: 			0
williamr@2: 
williamr@2: #ifdef	SLC_NAMES
williamr@2: char *slc_names[] = {
williamr@2: 	SLC_NAMELIST
williamr@2: };
williamr@2: #else
williamr@2: extern char *slc_names[];
williamr@2: #define	SLC_NAMES SLC_NAMELIST
williamr@2: #endif
williamr@2: 
williamr@2: #define	SLC_NAME_OK(x)	((unsigned int)(x) <= NSLC)
williamr@2: #define SLC_NAME(x)	slc_names[x]
williamr@2: 
williamr@2: #define	SLC_NOSUPPORT	0
williamr@2: #define	SLC_CANTCHANGE	1
williamr@2: #define	SLC_VARIABLE	2
williamr@2: #define	SLC_DEFAULT	3
williamr@2: #define	SLC_LEVELBITS	0x03
williamr@2: 
williamr@2: #define	SLC_FUNC	0
williamr@2: #define	SLC_FLAGS	1
williamr@2: #define	SLC_VALUE	2
williamr@2: 
williamr@2: #define	SLC_ACK		0x80
williamr@2: #define	SLC_FLUSHIN	0x40
williamr@2: #define	SLC_FLUSHOUT	0x20
williamr@2: 
williamr@2: #define	OLD_ENV_VAR	1
williamr@2: #define	OLD_ENV_VALUE	0
williamr@2: #define	NEW_ENV_VAR	0
williamr@2: #define	NEW_ENV_VALUE	1
williamr@2: #define	ENV_ESC		2
williamr@2: #define ENV_USERVAR	3
williamr@2: 
williamr@2: /*
williamr@2:  * AUTHENTICATION suboptions
williamr@2:  */
williamr@2: 
williamr@2: /**
williamr@2: Who is authenticating who ...
williamr@2: */
williamr@2: #define	AUTH_WHO_CLIENT		0	/* Client authenticating server */
williamr@2: #define	AUTH_WHO_SERVER		1	/* Server authenticating client */
williamr@2: #define	AUTH_WHO_MASK		1
williamr@2: 
williamr@2: /**
williamr@2: amount of authentication done
williamr@2: */
williamr@2: #define	AUTH_HOW_ONE_WAY	0
williamr@2: #define	AUTH_HOW_MUTUAL		2
williamr@2: #define	AUTH_HOW_MASK		2
williamr@2: 
williamr@2: #define	AUTHTYPE_NULL		0
williamr@2: #define	AUTHTYPE_KERBEROS_V4	1
williamr@2: #define	AUTHTYPE_KERBEROS_V5	2
williamr@2: #define	AUTHTYPE_SPX		3
williamr@2: #define	AUTHTYPE_MINK		4
williamr@2: #define	AUTHTYPE_CNT		5
williamr@2: 
williamr@2: #define	AUTHTYPE_TEST		99
williamr@2: 
williamr@2: #ifdef	AUTH_NAMES
williamr@2: char *authtype_names[] = {
williamr@2: 	"NULL", "KERBEROS_V4", "KERBEROS_V5", "SPX", "MINK",
williamr@2: 	0
williamr@2: };
williamr@2: #else
williamr@2: extern char *authtype_names[];
williamr@2: #endif
williamr@2: 
williamr@2: #define	AUTHTYPE_NAME_OK(x)	((unsigned int)(x) < AUTHTYPE_CNT)
williamr@2: #define	AUTHTYPE_NAME(x)	authtype_names[x]
williamr@2: 
williamr@2: /**
williamr@2: ENCRYPTion suboptions
williamr@2: */
williamr@2: #define	ENCRYPT_IS		0	/* I pick encryption type ... */
williamr@2: #define	ENCRYPT_SUPPORT		1	/* I support encryption types ... */
williamr@2: #define	ENCRYPT_REPLY		2	/* Initial setup response */
williamr@2: #define	ENCRYPT_START		3	/* Am starting to send encrypted */
williamr@2: #define	ENCRYPT_END		4	/* Am ending encrypted */
williamr@2: #define	ENCRYPT_REQSTART	5	/* Request you start encrypting */
williamr@2: #define	ENCRYPT_REQEND		6	/* Request you end encrypting */
williamr@2: #define	ENCRYPT_ENC_KEYID	7
williamr@2: #define	ENCRYPT_DEC_KEYID	8
williamr@2: #define	ENCRYPT_CNT		9
williamr@2: #define	ENCTYPE_ANY		0
williamr@2: #define	ENCTYPE_DES_CFB64	1
williamr@2: #define	ENCTYPE_DES_OFB64	2
williamr@2: #define	ENCTYPE_CNT		3
williamr@2: 
williamr@2: #ifdef	ENCRYPT_NAMES
williamr@2: char *encrypt_names[] = {
williamr@2: 	"IS", "SUPPORT", "REPLY", "START", "END",
williamr@2: 	"REQUEST-START", "REQUEST-END", "ENC-KEYID", "DEC-KEYID",
williamr@2: 	0
williamr@2: };
williamr@2: char *enctype_names[] = {
williamr@2: 	"ANY", "DES_CFB64",  "DES_OFB64",
williamr@2: 	0
williamr@2: };
williamr@2: #else
williamr@2: extern char *encrypt_names[];
williamr@2: extern char *enctype_names[];
williamr@2: #endif
williamr@2: 
williamr@2: #define	ENCRYPT_NAME_OK(x)	((unsigned int)(x) < ENCRYPT_CNT)
williamr@2: #define	ENCRYPT_NAME(x)		encrypt_names[x]
williamr@2: 
williamr@2: #define	ENCTYPE_NAME_OK(x)	((unsigned int)(x) < ENCTYPE_CNT)
williamr@2: #define	ENCTYPE_NAME(x)		enctype_names[x]
williamr@2: 
williamr@2: #endif /* !_TELNET_H_ */