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