xref: /freebsd/include/arpa/telnet.h (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
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 /* telnet options */
83 #define TELOPT_BINARY	0	/* 8-bit data path */
84 #define TELOPT_ECHO	1	/* echo */
85 #define	TELOPT_RCP	2	/* prepare to reconnect */
86 #define	TELOPT_SGA	3	/* suppress go ahead */
87 #define	TELOPT_NAMS	4	/* approximate message size */
88 #define	TELOPT_STATUS	5	/* give status */
89 #define	TELOPT_TM	6	/* timing mark */
90 #define	TELOPT_RCTE	7	/* remote controlled transmission and echo */
91 #define TELOPT_NAOL 	8	/* negotiate about output line width */
92 #define TELOPT_NAOP 	9	/* negotiate about output page size */
93 #define TELOPT_NAOCRD	10	/* negotiate about CR disposition */
94 #define TELOPT_NAOHTS	11	/* negotiate about horizontal tabstops */
95 #define TELOPT_NAOHTD	12	/* negotiate about horizontal tab disposition */
96 #define TELOPT_NAOFFD	13	/* negotiate about formfeed disposition */
97 #define TELOPT_NAOVTS	14	/* negotiate about vertical tab stops */
98 #define TELOPT_NAOVTD	15	/* negotiate about vertical tab disposition */
99 #define TELOPT_NAOLFD	16	/* negotiate about output LF disposition */
100 #define TELOPT_XASCII	17	/* extended ascic character set */
101 #define	TELOPT_LOGOUT	18	/* force logout */
102 #define	TELOPT_BM	19	/* byte macro */
103 #define	TELOPT_DET	20	/* data entry terminal */
104 #define	TELOPT_SUPDUP	21	/* supdup protocol */
105 #define	TELOPT_SUPDUPOUTPUT 22	/* supdup output */
106 #define	TELOPT_SNDLOC	23	/* send location */
107 #define	TELOPT_TTYPE	24	/* terminal type */
108 #define	TELOPT_EOR	25	/* end or record */
109 #define	TELOPT_TUID	26	/* TACACS user identification */
110 #define	TELOPT_OUTMRK	27	/* output marking */
111 #define	TELOPT_TTYLOC	28	/* terminal location number */
112 #define	TELOPT_3270REGIME 29	/* 3270 regime */
113 #define	TELOPT_X3PAD	30	/* X.3 PAD */
114 #define	TELOPT_NAWS	31	/* window size */
115 #define	TELOPT_TSPEED	32	/* terminal speed */
116 #define	TELOPT_LFLOW	33	/* remote flow control */
117 #define TELOPT_LINEMODE	34	/* Linemode option */
118 #define TELOPT_XDISPLOC	35	/* X Display Location */
119 #define TELOPT_OLD_ENVIRON 36	/* Old - Environment variables */
120 #define	TELOPT_AUTHENTICATION 37/* Authenticate */
121 #define	TELOPT_ENCRYPT	38	/* Encryption option */
122 #define TELOPT_NEW_ENVIRON 39	/* New - Environment variables */
123 #define	TELOPT_EXOPL	255	/* extended-options-list */
124 
125 
126 #define	NTELOPTS	(1+TELOPT_NEW_ENVIRON)
127 #ifdef TELOPTS
128 char *telopts[NTELOPTS+1] = {
129 	"BINARY", "ECHO", "RCP", "SUPPRESS GO AHEAD", "NAME",
130 	"STATUS", "TIMING MARK", "RCTE", "NAOL", "NAOP",
131 	"NAOCRD", "NAOHTS", "NAOHTD", "NAOFFD", "NAOVTS",
132 	"NAOVTD", "NAOLFD", "EXTEND ASCII", "LOGOUT", "BYTE MACRO",
133 	"DATA ENTRY TERMINAL", "SUPDUP", "SUPDUP OUTPUT",
134 	"SEND LOCATION", "TERMINAL TYPE", "END OF RECORD",
135 	"TACACS UID", "OUTPUT MARKING", "TTYLOC",
136 	"3270 REGIME", "X.3 PAD", "NAWS", "TSPEED", "LFLOW",
137 	"LINEMODE", "XDISPLOC", "OLD-ENVIRON", "AUTHENTICATION",
138 	"ENCRYPT", "NEW-ENVIRON",
139 	0
140 };
141 #define	TELOPT_FIRST	TELOPT_BINARY
142 #define	TELOPT_LAST	TELOPT_NEW_ENVIRON
143 #define	TELOPT_OK(x)	((unsigned int)(x) <= TELOPT_LAST)
144 #define	TELOPT(x)	telopts[(x)-TELOPT_FIRST]
145 #endif
146 
147 /* sub-option qualifiers */
148 #define	TELQUAL_IS	0	/* option is... */
149 #define	TELQUAL_SEND	1	/* send option */
150 #define	TELQUAL_INFO	2	/* ENVIRON: informational version of IS */
151 #define	TELQUAL_REPLY	2	/* AUTHENTICATION: client version of IS */
152 #define	TELQUAL_NAME	3	/* AUTHENTICATION: client version of IS */
153 
154 #define	LFLOW_OFF		0	/* Disable remote flow control */
155 #define	LFLOW_ON		1	/* Enable remote flow control */
156 #define	LFLOW_RESTART_ANY	2	/* Restart output on any char */
157 #define	LFLOW_RESTART_XON	3	/* Restart output only on XON */
158 
159 /*
160  * LINEMODE suboptions
161  */
162 
163 #define	LM_MODE		1
164 #define	LM_FORWARDMASK	2
165 #define	LM_SLC		3
166 
167 #define	MODE_EDIT	0x01
168 #define	MODE_TRAPSIG	0x02
169 #define	MODE_ACK	0x04
170 #define MODE_SOFT_TAB	0x08
171 #define MODE_LIT_ECHO	0x10
172 
173 #define	MODE_MASK	0x1f
174 
175 /* Not part of protocol, but needed to simplify things... */
176 #define MODE_FLOW		0x0100
177 #define MODE_ECHO		0x0200
178 #define MODE_INBIN		0x0400
179 #define MODE_OUTBIN		0x0800
180 #define MODE_FORCE		0x1000
181 
182 #define	SLC_SYNCH	1
183 #define	SLC_BRK		2
184 #define	SLC_IP		3
185 #define	SLC_AO		4
186 #define	SLC_AYT		5
187 #define	SLC_EOR		6
188 #define	SLC_ABORT	7
189 #define	SLC_EOF		8
190 #define	SLC_SUSP	9
191 #define	SLC_EC		10
192 #define	SLC_EL		11
193 #define	SLC_EW		12
194 #define	SLC_RP		13
195 #define	SLC_LNEXT	14
196 #define	SLC_XON		15
197 #define	SLC_XOFF	16
198 #define	SLC_FORW1	17
199 #define	SLC_FORW2	18
200 #define SLC_MCL         19
201 #define SLC_MCR         20
202 #define SLC_MCWL        21
203 #define SLC_MCWR        22
204 #define SLC_MCBOL       23
205 #define SLC_MCEOL       24
206 #define SLC_INSRT       25
207 #define SLC_OVER        26
208 #define SLC_ECR         27
209 #define SLC_EWR         28
210 #define SLC_EBOL        29
211 #define SLC_EEOL        30
212 
213 #define	NSLC		30
214 
215 /*
216  * For backwards compatability, we define SLC_NAMES to be the
217  * list of names if SLC_NAMES is not defined.
218  */
219 #define	SLC_NAMELIST	"0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR",	\
220 			"ABORT", "EOF", "SUSP", "EC", "EL", "EW", "RP",	\
221 			"LNEXT", "XON", "XOFF", "FORW1", "FORW2",	\
222 			"MCL", "MCR", "MCWL", "MCWR", "MCBOL",		\
223 			"MCEOL", "INSRT", "OVER", "ECR", "EWR",		\
224 			"EBOL", "EEOL",					\
225 			0
226 
227 #ifdef	SLC_NAMES
228 char *slc_names[] = {
229 	SLC_NAMELIST
230 };
231 #else
232 extern char *slc_names[];
233 #define	SLC_NAMES SLC_NAMELIST
234 #endif
235 
236 #define	SLC_NAME_OK(x)	((unsigned int)(x) <= NSLC)
237 #define SLC_NAME(x)	slc_names[x]
238 
239 #define	SLC_NOSUPPORT	0
240 #define	SLC_CANTCHANGE	1
241 #define	SLC_VARIABLE	2
242 #define	SLC_DEFAULT	3
243 #define	SLC_LEVELBITS	0x03
244 
245 #define	SLC_FUNC	0
246 #define	SLC_FLAGS	1
247 #define	SLC_VALUE	2
248 
249 #define	SLC_ACK		0x80
250 #define	SLC_FLUSHIN	0x40
251 #define	SLC_FLUSHOUT	0x20
252 
253 #define	OLD_ENV_VAR	1
254 #define	OLD_ENV_VALUE	0
255 #define	NEW_ENV_VAR	0
256 #define	NEW_ENV_VALUE	1
257 #define	ENV_ESC		2
258 #define ENV_USERVAR	3
259 
260 /*
261  * AUTHENTICATION suboptions
262  */
263 
264 /*
265  * Who is authenticating who ...
266  */
267 #define	AUTH_WHO_CLIENT		0	/* Client authenticating server */
268 #define	AUTH_WHO_SERVER		1	/* Server authenticating client */
269 #define	AUTH_WHO_MASK		1
270 
271 /*
272  * amount of authentication done
273  */
274 #define	AUTH_HOW_ONE_WAY	0
275 #define	AUTH_HOW_MUTUAL		2
276 #define	AUTH_HOW_MASK		2
277 
278 #define	AUTHTYPE_NULL		0
279 #define	AUTHTYPE_KERBEROS_V4	1
280 #define	AUTHTYPE_KERBEROS_V5	2
281 #define	AUTHTYPE_SPX		3
282 #define	AUTHTYPE_MINK		4
283 #define	AUTHTYPE_CNT		5
284 
285 #define	AUTHTYPE_TEST		99
286 
287 #ifdef	AUTH_NAMES
288 char *authtype_names[] = {
289 	"NULL", "KERBEROS_V4", "KERBEROS_V5", "SPX", "MINK",
290 	0
291 };
292 #else
293 extern char *authtype_names[];
294 #endif
295 
296 #define	AUTHTYPE_NAME_OK(x)	((unsigned int)(x) < AUTHTYPE_CNT)
297 #define	AUTHTYPE_NAME(x)	authtype_names[x]
298 
299 /*
300  * ENCRYPTion suboptions
301  */
302 #define	ENCRYPT_IS		0	/* I pick encryption type ... */
303 #define	ENCRYPT_SUPPORT		1	/* I support encryption types ... */
304 #define	ENCRYPT_REPLY		2	/* Initial setup response */
305 #define	ENCRYPT_START		3	/* Am starting to send encrypted */
306 #define	ENCRYPT_END		4	/* Am ending encrypted */
307 #define	ENCRYPT_REQSTART	5	/* Request you start encrypting */
308 #define	ENCRYPT_REQEND		6	/* Request you end encrypting */
309 #define	ENCRYPT_ENC_KEYID	7
310 #define	ENCRYPT_DEC_KEYID	8
311 #define	ENCRYPT_CNT		9
312 
313 #define	ENCTYPE_ANY		0
314 #define	ENCTYPE_DES_CFB64	1
315 #define	ENCTYPE_DES_OFB64	2
316 #define	ENCTYPE_CNT		3
317 
318 #ifdef	ENCRYPT_NAMES
319 char *encrypt_names[] = {
320 	"IS", "SUPPORT", "REPLY", "START", "END",
321 	"REQUEST-START", "REQUEST-END", "ENC-KEYID", "DEC-KEYID",
322 	0
323 };
324 char *enctype_names[] = {
325 	"ANY", "DES_CFB64",  "DES_OFB64",
326 	0
327 };
328 #else
329 extern char *encrypt_names[];
330 extern char *enctype_names[];
331 #endif
332 
333 
334 #define	ENCRYPT_NAME_OK(x)	((unsigned int)(x) < ENCRYPT_CNT)
335 #define	ENCRYPT_NAME(x)		encrypt_names[x]
336 
337 #define	ENCTYPE_NAME_OK(x)	((unsigned int)(x) < ENCTYPE_CNT)
338 #define	ENCTYPE_NAME(x)		enctype_names[x]
339 
340 #endif /* !_TELNET_H_ */
341