telnet.h revision 183004
1149423Spjd/* 2149423Spjd * Copyright (c) 1983, 1993 3149423Spjd * The Regents of the University of California. All rights reserved. 4149423Spjd * 5149423Spjd * Redistribution and use in source and binary forms, with or without 6149423Spjd * modification, are permitted provided that the following conditions 7149423Spjd * are met: 8149423Spjd * 1. Redistributions of source code must retain the above copyright 9149423Spjd * notice, this list of conditions and the following disclaimer. 10149423Spjd * 2. Redistributions in binary form must reproduce the above copyright 11149423Spjd * notice, this list of conditions and the following disclaimer in the 12149423Spjd * documentation and/or other materials provided with the distribution. 13149423Spjd * 3. All advertising materials mentioning features or use of this software 14149423Spjd * must display the following acknowledgement: 15149423Spjd * This product includes software developed by the University of 16149423Spjd * California, Berkeley and its contributors. 17149423Spjd * 4. Neither the name of the University nor the names of its contributors 18149423Spjd * may be used to endorse or promote products derived from this software 19149423Spjd * without specific prior written permission. 20149423Spjd * 21149423Spjd * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22149423Spjd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23149423Spjd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24149423Spjd * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25149423Spjd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26149423Spjd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27149423Spjd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28149423Spjd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29149423Spjd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30149423Spjd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31149423Spjd * SUCH DAMAGE. 32149423Spjd * 33149423Spjd * @(#)telnet.h 8.2 (Berkeley) 12/15/93 34149423Spjd * $FreeBSD: head/contrib/telnet/arpa/telnet.h 183004 2008-09-13 17:46:50Z antoine $ 35149423Spjd */ 36149423Spjd 37171706Sdes#ifndef _ARPA_TELNET_H_ 38149423Spjd#define _ARPA_TELNET_H_ 39172577Skib 40171706Sdes/* 41171706Sdes * Definitions for the TELNET protocol. 42149423Spjd */ 43149423Spjd#define IAC 255 /* interpret as command: */ 44149423Spjd#define DONT 254 /* you are not to use option */ 45149423Spjd#define DO 253 /* please, you use option */ 46149423Spjd#define WONT 252 /* I won't use option */ 47149423Spjd#define WILL 251 /* I will use option */ 48149423Spjd#define SB 250 /* interpret as subnegotiation */ 49149423Spjd#define GA 249 /* you may reverse the line */ 50149423Spjd#define EL 248 /* erase the current line */ 51149423Spjd#define EC 247 /* erase the current character */ 52149423Spjd#define AYT 246 /* are you there */ 53149423Spjd#define AO 245 /* abort output--but let prog finish */ 54149423Spjd#define IP 244 /* interrupt process--permanently */ 55149423Spjd#define BREAK 243 /* break */ 56149423Spjd#define DM 242 /* data mark--for connect. cleaning */ 57149423Spjd#define NOP 241 /* nop */ 58149423Spjd#define SE 240 /* end sub negotiation */ 59149423Spjd#define EOR 239 /* end of record (transparent mode) */ 60149423Spjd#define ABORT 238 /* Abort process */ 61149423Spjd#define SUSP 237 /* Suspend process */ 62149423Spjd#define xEOF 236 /* End of file: EOF is already used... */ 63149423Spjd 64149423Spjd#define SYNCH 242 /* for telfunc calls */ 65149423Spjd 66149423Spjd#ifdef TELCMDS 67149423Spjdconst char *telcmds[] = { 68149423Spjd "EOF", "SUSP", "ABORT", "EOR", 69149423Spjd "SE", "NOP", "DMARK", "BRK", "IP", "AO", "AYT", "EC", 70149423Spjd "EL", "GA", "SB", "WILL", "WONT", "DO", "DONT", "IAC", 71149423Spjd 0 72149423Spjd}; 73149423Spjd#else 74149423Spjdextern char *telcmds[]; 75149423Spjd#endif 76149423Spjd 77149423Spjd#define TELCMD_FIRST xEOF 78172577Skib#define TELCMD_LAST IAC 79172577Skib#define TELCMD_OK(x) ((unsigned int)(x) <= TELCMD_LAST && \ 80149423Spjd (unsigned int)(x) >= TELCMD_FIRST) 81149423Spjd#define TELCMD(x) telcmds[(x)-TELCMD_FIRST] 82149423Spjd 83149423Spjd/* telnet options */ 84149423Spjd#define TELOPT_BINARY 0 /* 8-bit data path */ 85149423Spjd#define TELOPT_ECHO 1 /* echo */ 86149423Spjd#define TELOPT_RCP 2 /* prepare to reconnect */ 87149423Spjd#define TELOPT_SGA 3 /* suppress go ahead */ 88149423Spjd#define TELOPT_NAMS 4 /* approximate message size */ 89149423Spjd#define TELOPT_STATUS 5 /* give status */ 90149423Spjd#define TELOPT_TM 6 /* timing mark */ 91149423Spjd#define TELOPT_RCTE 7 /* remote controlled transmission and echo */ 92149423Spjd#define TELOPT_NAOL 8 /* negotiate about output line width */ 93149423Spjd#define TELOPT_NAOP 9 /* negotiate about output page size */ 94172577Skib#define TELOPT_NAOCRD 10 /* negotiate about CR disposition */ 95172577Skib#define TELOPT_NAOHTS 11 /* negotiate about horizontal tabstops */ 96149423Spjd#define TELOPT_NAOHTD 12 /* negotiate about horizontal tab disposition */ 97149423Spjd#define TELOPT_NAOFFD 13 /* negotiate about formfeed disposition */ 98149423Spjd#define TELOPT_NAOVTS 14 /* negotiate about vertical tab stops */ 99149423Spjd#define TELOPT_NAOVTD 15 /* negotiate about vertical tab disposition */ 100149423Spjd#define TELOPT_NAOLFD 16 /* negotiate about output LF disposition */ 101169468Sdes#define TELOPT_XASCII 17 /* extended ascic character set */ 102169468Sdes#define TELOPT_LOGOUT 18 /* force logout */ 103169468Sdes#define TELOPT_BM 19 /* byte macro */ 104169468Sdes#define TELOPT_DET 20 /* data entry terminal */ 105169468Sdes#define TELOPT_SUPDUP 21 /* supdup protocol */ 106169468Sdes#define TELOPT_SUPDUPOUTPUT 22 /* supdup output */ 107169468Sdes#define TELOPT_SNDLOC 23 /* send location */ 108149423Spjd#define TELOPT_TTYPE 24 /* terminal type */ 109149423Spjd#define TELOPT_EOR 25 /* end or record */ 110149423Spjd#define TELOPT_TUID 26 /* TACACS user identification */ 111149423Spjd#define TELOPT_OUTMRK 27 /* output marking */ 112149423Spjd#define TELOPT_TTYLOC 28 /* terminal location number */ 113149423Spjd#define TELOPT_3270REGIME 29 /* 3270 regime */ 114149423Spjd#define TELOPT_X3PAD 30 /* X.3 PAD */ 115149423Spjd#define TELOPT_NAWS 31 /* window size */ 116149423Spjd#define TELOPT_TSPEED 32 /* terminal speed */ 117149423Spjd#define TELOPT_LFLOW 33 /* remote flow control */ 118149423Spjd#define TELOPT_LINEMODE 34 /* Linemode option */ 119169448Sdes#define TELOPT_XDISPLOC 35 /* X Display Location */ 120169448Sdes#define TELOPT_OLD_ENVIRON 36 /* Old - Environment variables */ 121149423Spjd#define TELOPT_AUTHENTICATION 37/* Authenticate */ 122172577Skib#define TELOPT_ENCRYPT 38 /* Encryption option */ 123172577Skib#define TELOPT_NEW_ENVIRON 39 /* New - Environment variables */ 124172577Skib#define TELOPT_TN3270E 40 /* RFC2355 - TN3270 Enhancements */ 125149423Spjd#define TELOPT_CHARSET 42 /* RFC2066 - Charset */ 126172577Skib#define TELOPT_COMPORT 44 /* RFC2217 - Com Port Control */ 127149423Spjd#define TELOPT_KERMIT 47 /* RFC2840 - Kermit */ 128149423Spjd#define TELOPT_EXOPL 255 /* extended-options-list */ 129149423Spjd 130172577Skib 131172577Skib#define NTELOPTS (1+TELOPT_KERMIT) 132172577Skib#ifdef TELOPTS 133172577Skibconst char *telopts[NTELOPTS+1] = { 134172577Skib "BINARY", "ECHO", "RCP", "SUPPRESS GO AHEAD", "NAME", 135172577Skib "STATUS", "TIMING MARK", "RCTE", "NAOL", "NAOP", 136149423Spjd "NAOCRD", "NAOHTS", "NAOHTD", "NAOFFD", "NAOVTS", 137149423Spjd "NAOVTD", "NAOLFD", "EXTEND ASCII", "LOGOUT", "BYTE MACRO", 138149423Spjd "DATA ENTRY TERMINAL", "SUPDUP", "SUPDUP OUTPUT", 139149423Spjd "SEND LOCATION", "TERMINAL TYPE", "END OF RECORD", 140149423Spjd "TACACS UID", "OUTPUT MARKING", "TTYLOC", 141149423Spjd "3270 REGIME", "X.3 PAD", "NAWS", "TSPEED", "LFLOW", 142149423Spjd "LINEMODE", "XDISPLOC", "OLD-ENVIRON", "AUTHENTICATION", 143149423Spjd "ENCRYPT", "NEW-ENVIRON", "TN3270E", "XAUTH", "CHARSET", 144149423Spjd "RSP", "COM-PORT", "SLE", "STARTTLS", "KERMIT", 145149423Spjd 0 146149423Spjd}; 147149423Spjd#define TELOPT_FIRST TELOPT_BINARY 148149423Spjd#define TELOPT_LAST TELOPT_KERMIT 149149423Spjd#define TELOPT_OK(x) ((unsigned int)(x) <= TELOPT_LAST) 150149423Spjd#define TELOPT(x) telopts[(x)-TELOPT_FIRST] 151149423Spjd#endif 152149423Spjd 153149423Spjd/* sub-option qualifiers */ 154149423Spjd#define TELQUAL_IS 0 /* option is... */ 155149423Spjd#define TELQUAL_SEND 1 /* send option */ 156149423Spjd#define TELQUAL_INFO 2 /* ENVIRON: informational version of IS */ 157149423Spjd#define TELQUAL_REPLY 2 /* AUTHENTICATION: client version of IS */ 158149423Spjd#define TELQUAL_NAME 3 /* AUTHENTICATION: client version of IS */ 159149423Spjd 160149423Spjd#define LFLOW_OFF 0 /* Disable remote flow control */ 161149423Spjd#define LFLOW_ON 1 /* Enable remote flow control */ 162149423Spjd#define LFLOW_RESTART_ANY 2 /* Restart output on any char */ 163149423Spjd#define LFLOW_RESTART_XON 3 /* Restart output only on XON */ 164149423Spjd 165149423Spjd/* 166149423Spjd * LINEMODE suboptions 167149423Spjd */ 168149423Spjd 169149423Spjd#define LM_MODE 1 170149423Spjd#define LM_FORWARDMASK 2 171149423Spjd#define LM_SLC 3 172149423Spjd 173149423Spjd#define MODE_EDIT 0x01 174149423Spjd#define MODE_TRAPSIG 0x02 175149423Spjd#define MODE_ACK 0x04 176149423Spjd#define MODE_SOFT_TAB 0x08 177149423Spjd#define MODE_LIT_ECHO 0x10 178149423Spjd 179149423Spjd#define MODE_MASK 0x1f 180149423Spjd 181149423Spjd/* Not part of protocol, but needed to simplify things... */ 182149423Spjd#define MODE_FLOW 0x0100 183149423Spjd#define MODE_ECHO 0x0200 184149423Spjd#define MODE_INBIN 0x0400 185149423Spjd#define MODE_OUTBIN 0x0800 186149423Spjd#define MODE_FORCE 0x1000 187149423Spjd 188149423Spjd#define SLC_SYNCH 1 189149423Spjd#define SLC_BRK 2 190157671Sjmg#define SLC_IP 3 191149423Spjd#define SLC_AO 4 192149423Spjd#define SLC_AYT 5 193149423Spjd#define SLC_EOR 6 194149423Spjd#define SLC_ABORT 7 195149423Spjd#define SLC_EOF 8 196149423Spjd#define SLC_SUSP 9 197149423Spjd#define SLC_EC 10 198149423Spjd#define SLC_EL 11 199149423Spjd#define SLC_EW 12 200149423Spjd#define SLC_RP 13 201149423Spjd#define SLC_LNEXT 14 202149423Spjd#define SLC_XON 15 203149423Spjd#define SLC_XOFF 16 204149423Spjd#define SLC_FORW1 17 205149423Spjd#define SLC_FORW2 18 206149423Spjd#define SLC_MCL 19 207149423Spjd#define SLC_MCR 20 208149423Spjd#define SLC_MCWL 21 209149423Spjd#define SLC_MCWR 22 210149423Spjd#define SLC_MCBOL 23 211149423Spjd#define SLC_MCEOL 24 212149423Spjd#define SLC_INSRT 25 213149423Spjd#define SLC_OVER 26 214149423Spjd#define SLC_ECR 27 215149423Spjd#define SLC_EWR 28 216149423Spjd#define SLC_EBOL 29 217149423Spjd#define SLC_EEOL 30 218149423Spjd 219149423Spjd#define NSLC 30 220149423Spjd 221149423Spjd/* 222149423Spjd * For backwards compatibility, we define SLC_NAMES to be the 223149423Spjd * list of names if SLC_NAMES is not defined. 224149423Spjd */ 225149423Spjd#define SLC_NAMELIST "0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR", \ 226149423Spjd "ABORT", "EOF", "SUSP", "EC", "EL", "EW", "RP", \ 227149423Spjd "LNEXT", "XON", "XOFF", "FORW1", "FORW2", \ 228149423Spjd "MCL", "MCR", "MCWL", "MCWR", "MCBOL", \ 229149423Spjd "MCEOL", "INSRT", "OVER", "ECR", "EWR", \ 230149423Spjd "EBOL", "EEOL", \ 231149423Spjd 0 232149423Spjd 233149423Spjd#ifdef SLC_NAMES 234171706Sdesconst char *slc_names[] = { 235149423Spjd SLC_NAMELIST 236149423Spjd}; 237149423Spjd#else 238149423Spjdextern char *slc_names[]; 239149423Spjd#define SLC_NAMES SLC_NAMELIST 240149423Spjd#endif 241149423Spjd 242149423Spjd#define SLC_NAME_OK(x) ((unsigned int)(x) <= NSLC) 243149423Spjd#define SLC_NAME(x) slc_names[x] 244149423Spjd 245149423Spjd#define SLC_NOSUPPORT 0 246149423Spjd#define SLC_CANTCHANGE 1 247149423Spjd#define SLC_VARIABLE 2 248149423Spjd#define SLC_DEFAULT 3 249149423Spjd#define SLC_LEVELBITS 0x03 250149423Spjd 251149423Spjd#define SLC_FUNC 0 252149423Spjd#define SLC_FLAGS 1 253149423Spjd#define SLC_VALUE 2 254149423Spjd 255149423Spjd#define SLC_ACK 0x80 256149423Spjd#define SLC_FLUSHIN 0x40 257149423Spjd#define SLC_FLUSHOUT 0x20 258149423Spjd 259#define OLD_ENV_VAR 1 260#define OLD_ENV_VALUE 0 261#define NEW_ENV_VAR 0 262#define NEW_ENV_VALUE 1 263#define ENV_ESC 2 264#define ENV_USERVAR 3 265 266/* 267 * AUTHENTICATION suboptions 268 */ 269 270/* 271 * Who is authenticating who ... 272 */ 273#define AUTH_WHO_CLIENT 0 /* Client authenticating server */ 274#define AUTH_WHO_SERVER 1 /* Server authenticating client */ 275#define AUTH_WHO_MASK 1 276 277/* 278 * amount of authentication done 279 */ 280#define AUTH_HOW_ONE_WAY 0 281#define AUTH_HOW_MUTUAL 2 282#define AUTH_HOW_MASK 2 283 284#define AUTHTYPE_NULL 0 285#define AUTHTYPE_KERBEROS_V4 1 286#define AUTHTYPE_KERBEROS_V5 2 287#define AUTHTYPE_SPX 3 288#define AUTHTYPE_MINK 4 289#define AUTHTYPE_SRA 6 290#define AUTHTYPE_CNT 7 291 292#define AUTHTYPE_TEST 99 293 294#ifdef AUTH_NAMES 295const char *authtype_names[] = { 296 "NULL", "KERBEROS_V4", "KERBEROS_V5", "SPX", "MINK", NULL, "SRA", 297 0 298}; 299#else 300extern char *authtype_names[]; 301#endif 302 303#define AUTHTYPE_NAME_OK(x) ((unsigned int)(x) < AUTHTYPE_CNT) 304#define AUTHTYPE_NAME(x) authtype_names[x] 305 306/* 307 * ENCRYPTion suboptions 308 */ 309#define ENCRYPT_IS 0 /* I pick encryption type ... */ 310#define ENCRYPT_SUPPORT 1 /* I support encryption types ... */ 311#define ENCRYPT_REPLY 2 /* Initial setup response */ 312#define ENCRYPT_START 3 /* Am starting to send encrypted */ 313#define ENCRYPT_END 4 /* Am ending encrypted */ 314#define ENCRYPT_REQSTART 5 /* Request you start encrypting */ 315#define ENCRYPT_REQEND 6 /* Request you end encrypting */ 316#define ENCRYPT_ENC_KEYID 7 317#define ENCRYPT_DEC_KEYID 8 318#define ENCRYPT_CNT 9 319 320#define ENCTYPE_ANY 0 321#define ENCTYPE_DES_CFB64 1 322#define ENCTYPE_DES_OFB64 2 323#define ENCTYPE_CNT 3 324 325#ifdef ENCRYPT_NAMES 326const char *encrypt_names[] = { 327 "IS", "SUPPORT", "REPLY", "START", "END", 328 "REQUEST-START", "REQUEST-END", "ENC-KEYID", "DEC-KEYID", 329 0 330}; 331const char *enctype_names[] = { 332 "ANY", "DES_CFB64", "DES_OFB64", 333 0 334}; 335#else 336extern char *encrypt_names[]; 337extern char *enctype_names[]; 338#endif 339 340 341#define ENCRYPT_NAME_OK(x) ((unsigned int)(x) < ENCRYPT_CNT) 342#define ENCRYPT_NAME(x) encrypt_names[x] 343 344#define ENCTYPE_NAME_OK(x) ((unsigned int)(x) < ENCTYPE_CNT) 345#define ENCTYPE_NAME(x) enctype_names[x] 346 347#endif /* !_TELNET_H_ */ 348