openenvutils/telnetserver/inc/telnet.h
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     1 /*
       
     2  * Copyright (c) 1983, 1993
       
     3  *	The Regents of the University of California.  All rights reserved.
       
     4  *
       
     5  * Redistribution and use in source and binary forms, with or without
       
     6  * modification, are permitted provided that the following conditions
       
     7  * are met:
       
     8  * 1. Redistributions of source code must retain the above copyright
       
     9  *    notice, this list of conditions and the following disclaimer.
       
    10  * 2. Redistributions in binary form must reproduce the above copyright
       
    11  *    notice, this list of conditions and the following disclaimer in the
       
    12  *    documentation and/or other materials provided with the distribution.
       
    13  * 3. All advertising materials mentioning features or use of this software
       
    14  *    must display the following acknowledgement:
       
    15  *	This product includes software developed by the University of
       
    16  *	California, Berkeley and its contributors.
       
    17  * 4. Neither the name of the University nor the names of its contributors
       
    18  *    may be used to endorse or promote products derived from this software
       
    19  *    without specific prior written permission.
       
    20  *
       
    21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
       
    22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
       
    23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
       
    24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
       
    25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
       
    26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
       
    27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
       
    28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
       
    29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
       
    30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
       
    31  * SUCH DAMAGE.
       
    32  *
       
    33  *	@(#)telnet.h	8.2 (Berkeley) 12/15/93
       
    34  */
       
    35 
       
    36 #ifndef _ARPA_TELNET_H_
       
    37 #define	_ARPA_TELNET_H_
       
    38 
       
    39 /**
       
    40 Definitions for the TELNET protocol.
       
    41 */
       
    42 #define	IAC	255		/* interpret as command: */
       
    43 #define	DONT	254		/* you are not to use option */
       
    44 #define	DO	253		/* please, you use option */
       
    45 #define	WONT	252		/* I won't use option */
       
    46 #define	WILL	251		/* I will use option */
       
    47 #define	SB	250		/* interpret as subnegotiation */
       
    48 #define	GA	249		/* you may reverse the line */
       
    49 #define	EL	248		/* erase the current line */
       
    50 #define	EC	247		/* erase the current character */
       
    51 #define	AYT	246		/* are you there */
       
    52 #define	AO	245		/* abort output--but let prog finish */
       
    53 #define	IP	244		/* interrupt process--permanently */
       
    54 #define	BREAK	243		/* break */
       
    55 #define	DM	242		/* data mark--for connect. cleaning */
       
    56 #define	NOP	241		/* nop */
       
    57 #define	SE	240		/* end sub negotiation */
       
    58 #define EOR     239             /* end of record (transparent mode) */
       
    59 #define	ABORT	238		/* Abort process */
       
    60 #define	SUSP	237		/* Suspend process */
       
    61 #define	xEOF	236		/* End of file: EOF is already used... */
       
    62 
       
    63 #define SYNCH	242		/* for telfunc calls */
       
    64 
       
    65 #ifdef TELCMDS
       
    66 char *telcmds[] = {
       
    67 	"EOF", "SUSP", "ABORT", "EOR",
       
    68 	"SE", "NOP", "DMARK", "BRK", "IP", "AO", "AYT", "EC",
       
    69 	"EL", "GA", "SB", "WILL", "WONT", "DO", "DONT", "IAC",
       
    70 	0
       
    71 };
       
    72 #else
       
    73 extern char *telcmds[];
       
    74 #endif
       
    75 
       
    76 #define	TELCMD_FIRST	xEOF
       
    77 #define	TELCMD_LAST	IAC
       
    78 #define	TELCMD_OK(x)	((unsigned int)(x) <= TELCMD_LAST && \
       
    79 			 (unsigned int)(x) >= TELCMD_FIRST)
       
    80 #define	TELCMD(x)	telcmds[(x)-TELCMD_FIRST]
       
    81 
       
    82 /**
       
    83 telnet options 
       
    84 */
       
    85 #define TELOPT_BINARY	0	/* 8-bit data path */
       
    86 #define TELOPT_ECHO	1	/* echo */
       
    87 #define	TELOPT_RCP	2	/* prepare to reconnect */
       
    88 #define	TELOPT_SGA	3	/* suppress go ahead */
       
    89 #define	TELOPT_NAMS	4	/* approximate message size */
       
    90 #define	TELOPT_STATUS	5	/* give status */
       
    91 #define	TELOPT_TM	6	/* timing mark */
       
    92 #define	TELOPT_RCTE	7	/* remote controlled transmission and echo */
       
    93 #define TELOPT_NAOL 	8	/* negotiate about output line width */
       
    94 #define TELOPT_NAOP 	9	/* negotiate about output page size */
       
    95 #define TELOPT_NAOCRD	10	/* negotiate about CR disposition */
       
    96 #define TELOPT_NAOHTS	11	/* negotiate about horizontal tabstops */
       
    97 #define TELOPT_NAOHTD	12	/* negotiate about horizontal tab disposition */
       
    98 #define TELOPT_NAOFFD	13	/* negotiate about formfeed disposition */
       
    99 #define TELOPT_NAOVTS	14	/* negotiate about vertical tab stops */
       
   100 #define TELOPT_NAOVTD	15	/* negotiate about vertical tab disposition */
       
   101 #define TELOPT_NAOLFD	16	/* negotiate about output LF disposition */
       
   102 #define TELOPT_XASCII	17	/* extended ascic character set */
       
   103 #define	TELOPT_LOGOUT	18	/* force logout */
       
   104 #define	TELOPT_BM	19	/* byte macro */
       
   105 #define	TELOPT_DET	20	/* data entry terminal */
       
   106 #define	TELOPT_SUPDUP	21	/* supdup protocol */
       
   107 #define	TELOPT_SUPDUPOUTPUT 22	/* supdup output */
       
   108 #define	TELOPT_SNDLOC	23	/* send location */
       
   109 #define	TELOPT_TTYPE	24	/* terminal type */
       
   110 #define	TELOPT_EOR	25	/* end or record */
       
   111 #define	TELOPT_TUID	26	/* TACACS user identification */
       
   112 #define	TELOPT_OUTMRK	27	/* output marking */
       
   113 #define	TELOPT_TTYLOC	28	/* terminal location number */
       
   114 #define	TELOPT_3270REGIME 29	/* 3270 regime */
       
   115 #define	TELOPT_X3PAD	30	/* X.3 PAD */
       
   116 #define	TELOPT_NAWS	31	/* window size */
       
   117 #define	TELOPT_TSPEED	32	/* terminal speed */
       
   118 #define	TELOPT_LFLOW	33	/* remote flow control */
       
   119 #define TELOPT_LINEMODE	34	/* Linemode option */
       
   120 #define TELOPT_XDISPLOC	35	/* X Display Location */
       
   121 #define TELOPT_OLD_ENVIRON 36	/* Old - Environment variables */
       
   122 #define	TELOPT_AUTHENTICATION 37/* Authenticate */
       
   123 #define	TELOPT_ENCRYPT	38	/* Encryption option */
       
   124 #define TELOPT_NEW_ENVIRON 39	/* New - Environment variables */
       
   125 #define	TELOPT_EXOPL	255	/* extended-options-list */
       
   126 
       
   127 #define	NTELOPTS	(1+TELOPT_NEW_ENVIRON)
       
   128 #ifdef TELOPTS
       
   129 char *telopts[NTELOPTS+1] = {
       
   130 	"BINARY", "ECHO", "RCP", "SUPPRESS GO AHEAD", "NAME",
       
   131 	"STATUS", "TIMING MARK", "RCTE", "NAOL", "NAOP",
       
   132 	"NAOCRD", "NAOHTS", "NAOHTD", "NAOFFD", "NAOVTS",
       
   133 	"NAOVTD", "NAOLFD", "EXTEND ASCII", "LOGOUT", "BYTE MACRO",
       
   134 	"DATA ENTRY TERMINAL", "SUPDUP", "SUPDUP OUTPUT",
       
   135 	"SEND LOCATION", "TERMINAL TYPE", "END OF RECORD",
       
   136 	"TACACS UID", "OUTPUT MARKING", "TTYLOC",
       
   137 	"3270 REGIME", "X.3 PAD", "NAWS", "TSPEED", "LFLOW",
       
   138 	"LINEMODE", "XDISPLOC", "OLD-ENVIRON", "AUTHENTICATION",
       
   139 	"ENCRYPT", "NEW-ENVIRON",
       
   140 	0
       
   141 };
       
   142 
       
   143 #define	TELOPT_FIRST	TELOPT_BINARY
       
   144 #define	TELOPT_LAST	TELOPT_NEW_ENVIRON
       
   145 #define	TELOPT_OK(x)	((unsigned int)(x) <= TELOPT_LAST)
       
   146 #define	TELOPT(x)	telopts[(x)-TELOPT_FIRST]
       
   147 #endif
       
   148 
       
   149 /** 
       
   150 sub-option qualifiers 
       
   151 */
       
   152 #define	TELQUAL_IS	0	/* option is... */
       
   153 #define	TELQUAL_SEND	1	/* send option */
       
   154 #define	TELQUAL_INFO	2	/* ENVIRON: informational version of IS */
       
   155 #define	TELQUAL_REPLY	2	/* AUTHENTICATION: client version of IS */
       
   156 #define	TELQUAL_NAME	3	/* AUTHENTICATION: client version of IS */
       
   157 
       
   158 #define	LFLOW_OFF		0	/* Disable remote flow control */
       
   159 #define	LFLOW_ON		1	/* Enable remote flow control */
       
   160 #define	LFLOW_RESTART_ANY	2	/* Restart output on any char */
       
   161 #define	LFLOW_RESTART_XON	3	/* Restart output only on XON */
       
   162 
       
   163 /**
       
   164 LINEMODE suboptions
       
   165 */
       
   166 #define	LM_MODE		1
       
   167 #define	LM_FORWARDMASK	2
       
   168 #define	LM_SLC		3
       
   169 
       
   170 #define	MODE_EDIT	0x01
       
   171 #define	MODE_TRAPSIG	0x02
       
   172 #define	MODE_ACK	0x04
       
   173 #define MODE_SOFT_TAB	0x08
       
   174 #define MODE_LIT_ECHO	0x10
       
   175 
       
   176 #define	MODE_MASK	0x1f
       
   177 
       
   178 /** 
       
   179 Not part of protocol, but needed to simplify things... 
       
   180 */
       
   181 #define MODE_FLOW		0x0100
       
   182 #define MODE_ECHO		0x0200
       
   183 #define MODE_INBIN		0x0400
       
   184 #define MODE_OUTBIN		0x0800
       
   185 #define MODE_FORCE		0x1000
       
   186 
       
   187 #define	SLC_SYNCH	1
       
   188 #define	SLC_BRK		2
       
   189 #define	SLC_IP		3
       
   190 #define	SLC_AO		4
       
   191 #define	SLC_AYT		5
       
   192 #define	SLC_EOR		6
       
   193 #define	SLC_ABORT	7
       
   194 #define	SLC_EOF		8
       
   195 #define	SLC_SUSP	9
       
   196 #define	SLC_EC		10
       
   197 #define	SLC_EL		11
       
   198 #define	SLC_EW		12
       
   199 #define	SLC_RP		13
       
   200 #define	SLC_LNEXT	14
       
   201 #define	SLC_XON		15
       
   202 #define	SLC_XOFF	16
       
   203 #define	SLC_FORW1	17
       
   204 #define	SLC_FORW2	18
       
   205 #define SLC_MCL         19
       
   206 #define SLC_MCR         20
       
   207 #define SLC_MCWL        21
       
   208 #define SLC_MCWR        22
       
   209 #define SLC_MCBOL       23
       
   210 #define SLC_MCEOL       24
       
   211 #define SLC_INSRT       25
       
   212 #define SLC_OVER        26
       
   213 #define SLC_ECR         27
       
   214 #define SLC_EWR         28
       
   215 #define SLC_EBOL        29
       
   216 #define SLC_EEOL        30
       
   217 
       
   218 #define	NSLC		30
       
   219 
       
   220 /**
       
   221 For backwards compatability, we define SLC_NAMES to be the
       
   222 list of names if SLC_NAMES is not defined.
       
   223 */
       
   224 #define	SLC_NAMELIST	"0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR",	\
       
   225 			"ABORT", "EOF", "SUSP", "EC", "EL", "EW", "RP",	\
       
   226 			"LNEXT", "XON", "XOFF", "FORW1", "FORW2",	\
       
   227 			"MCL", "MCR", "MCWL", "MCWR", "MCBOL",		\
       
   228 			"MCEOL", "INSRT", "OVER", "ECR", "EWR",		\
       
   229 			"EBOL", "EEOL",					\
       
   230 			0
       
   231 
       
   232 #ifdef	SLC_NAMES
       
   233 char *slc_names[] = {
       
   234 	SLC_NAMELIST
       
   235 };
       
   236 #else
       
   237 extern char *slc_names[];
       
   238 #define	SLC_NAMES SLC_NAMELIST
       
   239 #endif
       
   240 
       
   241 #define	SLC_NAME_OK(x)	((unsigned int)(x) <= NSLC)
       
   242 #define SLC_NAME(x)	slc_names[x]
       
   243 
       
   244 #define	SLC_NOSUPPORT	0
       
   245 #define	SLC_CANTCHANGE	1
       
   246 #define	SLC_VARIABLE	2
       
   247 #define	SLC_DEFAULT	3
       
   248 #define	SLC_LEVELBITS	0x03
       
   249 
       
   250 #define	SLC_FUNC	0
       
   251 #define	SLC_FLAGS	1
       
   252 #define	SLC_VALUE	2
       
   253 
       
   254 #define	SLC_ACK		0x80
       
   255 #define	SLC_FLUSHIN	0x40
       
   256 #define	SLC_FLUSHOUT	0x20
       
   257 
       
   258 #define	OLD_ENV_VAR	1
       
   259 #define	OLD_ENV_VALUE	0
       
   260 #define	NEW_ENV_VAR	0
       
   261 #define	NEW_ENV_VALUE	1
       
   262 #define	ENV_ESC		2
       
   263 #define ENV_USERVAR	3
       
   264 
       
   265 /*
       
   266  * AUTHENTICATION suboptions
       
   267  */
       
   268 
       
   269 /**
       
   270 Who is authenticating who ...
       
   271 */
       
   272 #define	AUTH_WHO_CLIENT		0	/* Client authenticating server */
       
   273 #define	AUTH_WHO_SERVER		1	/* Server authenticating client */
       
   274 #define	AUTH_WHO_MASK		1
       
   275 
       
   276 /**
       
   277 amount of authentication done
       
   278 */
       
   279 #define	AUTH_HOW_ONE_WAY	0
       
   280 #define	AUTH_HOW_MUTUAL		2
       
   281 #define	AUTH_HOW_MASK		2
       
   282 
       
   283 #define	AUTHTYPE_NULL		0
       
   284 #define	AUTHTYPE_KERBEROS_V4	1
       
   285 #define	AUTHTYPE_KERBEROS_V5	2
       
   286 #define	AUTHTYPE_SPX		3
       
   287 #define	AUTHTYPE_MINK		4
       
   288 #define	AUTHTYPE_CNT		5
       
   289 
       
   290 #define	AUTHTYPE_TEST		99
       
   291 
       
   292 #ifdef	AUTH_NAMES
       
   293 char *authtype_names[] = {
       
   294 	"NULL", "KERBEROS_V4", "KERBEROS_V5", "SPX", "MINK",
       
   295 	0
       
   296 };
       
   297 #else
       
   298 extern char *authtype_names[];
       
   299 #endif
       
   300 
       
   301 #define	AUTHTYPE_NAME_OK(x)	((unsigned int)(x) < AUTHTYPE_CNT)
       
   302 #define	AUTHTYPE_NAME(x)	authtype_names[x]
       
   303 
       
   304 /**
       
   305 ENCRYPTion suboptions
       
   306 */
       
   307 #define	ENCRYPT_IS		0	/* I pick encryption type ... */
       
   308 #define	ENCRYPT_SUPPORT		1	/* I support encryption types ... */
       
   309 #define	ENCRYPT_REPLY		2	/* Initial setup response */
       
   310 #define	ENCRYPT_START		3	/* Am starting to send encrypted */
       
   311 #define	ENCRYPT_END		4	/* Am ending encrypted */
       
   312 #define	ENCRYPT_REQSTART	5	/* Request you start encrypting */
       
   313 #define	ENCRYPT_REQEND		6	/* Request you end encrypting */
       
   314 #define	ENCRYPT_ENC_KEYID	7
       
   315 #define	ENCRYPT_DEC_KEYID	8
       
   316 #define	ENCRYPT_CNT		9
       
   317 #define	ENCTYPE_ANY		0
       
   318 #define	ENCTYPE_DES_CFB64	1
       
   319 #define	ENCTYPE_DES_OFB64	2
       
   320 #define	ENCTYPE_CNT		3
       
   321 
       
   322 #ifdef	ENCRYPT_NAMES
       
   323 char *encrypt_names[] = {
       
   324 	"IS", "SUPPORT", "REPLY", "START", "END",
       
   325 	"REQUEST-START", "REQUEST-END", "ENC-KEYID", "DEC-KEYID",
       
   326 	0
       
   327 };
       
   328 char *enctype_names[] = {
       
   329 	"ANY", "DES_CFB64",  "DES_OFB64",
       
   330 	0
       
   331 };
       
   332 #else
       
   333 extern char *encrypt_names[];
       
   334 extern char *enctype_names[];
       
   335 #endif
       
   336 
       
   337 #define	ENCRYPT_NAME_OK(x)	((unsigned int)(x) < ENCRYPT_CNT)
       
   338 #define	ENCRYPT_NAME(x)		encrypt_names[x]
       
   339 
       
   340 #define	ENCTYPE_NAME_OK(x)	((unsigned int)(x) < ENCTYPE_CNT)
       
   341 #define	ENCTYPE_NAME(x)		enctype_names[x]
       
   342 
       
   343 #endif /* !_TELNET_H_ */