telnet.h revision 109467
190075Sobrien/* 2169689Skan * Copyright (c) 1983, 1993 3169689Skan * The Regents of the University of California. All rights reserved. 4169689Skan * 590075Sobrien * Redistribution and use in source and binary forms, with or without 690075Sobrien * modification, are permitted provided that the following conditions 7132718Skan * are met: 890075Sobrien * 1. Redistributions of source code must retain the above copyright 9132718Skan * notice, this list of conditions and the following disclaimer. 10132718Skan * 2. Redistributions in binary form must reproduce the above copyright 11132718Skan * notice, this list of conditions and the following disclaimer in the 12132718Skan * documentation and/or other materials provided with the distribution. 1390075Sobrien * 3. All advertising materials mentioning features or use of this software 14132718Skan * must display the following acknowledgement: 15132718Skan * This product includes software developed by the University of 16132718Skan * California, Berkeley and its contributors. 17132718Skan * 4. Neither the name of the University nor the names of its contributors 1890075Sobrien * may be used to endorse or promote products derived from this software 19132718Skan * without specific prior written permission. 20132718Skan * 21169689Skan * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22169689Skan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2390075Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2490075Sobrien * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2590075Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26132718Skan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27132718Skan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2890075Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2990075Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3090075Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3190075Sobrien * SUCH DAMAGE. 3290075Sobrien * 3390075Sobrien * @(#)telnet.h 8.2 (Berkeley) 12/15/93 3490075Sobrien * $FreeBSD: head/include/arpa/telnet.h 109467 2003-01-18 06:13:57Z billf $ 3590075Sobrien */ 3690075Sobrien 3790075Sobrien#ifndef _ARPA_TELNET_H_ 3890075Sobrien#define _ARPA_TELNET_H_ 3990075Sobrien 4090075Sobrien/* 4190075Sobrien * Definitions for the TELNET protocol. 4290075Sobrien */ 4390075Sobrien#define IAC 255 /* interpret as command: */ 4490075Sobrien#define DONT 254 /* you are not to use option */ 4590075Sobrien#define DO 253 /* please, you use option */ 4690075Sobrien#define WONT 252 /* I won't use option */ 4790075Sobrien#define WILL 251 /* I will use option */ 4890075Sobrien#define SB 250 /* interpret as subnegotiation */ 4990075Sobrien#define GA 249 /* you may reverse the line */ 5090075Sobrien#define EL 248 /* erase the current line */ 5190075Sobrien#define EC 247 /* erase the current character */ 5290075Sobrien#define AYT 246 /* are you there */ 5390075Sobrien#define AO 245 /* abort output--but let prog finish */ 54132718Skan#define IP 244 /* interrupt process--permanently */ 55132718Skan#define BREAK 243 /* break */ 56169689Skan#define DM 242 /* data mark--for connect. cleaning */ 57169689Skan#define NOP 241 /* nop */ 58169689Skan#define SE 240 /* end sub negotiation */ 59169689Skan#define EOR 239 /* end of record (transparent mode) */ 60132718Skan#define ABORT 238 /* Abort process */ 61132718Skan#define SUSP 237 /* Suspend process */ 62132718Skan#define xEOF 236 /* End of file: EOF is already used... */ 63169689Skan 64169689Skan#define SYNCH 242 /* for telfunc calls */ 65169689Skan 6690075Sobrien#ifdef TELCMDS 6790075Sobrienconst char *telcmds[] = { 6890075Sobrien "EOF", "SUSP", "ABORT", "EOR", 6990075Sobrien "SE", "NOP", "DMARK", "BRK", "IP", "AO", "AYT", "EC", 7090075Sobrien "EL", "GA", "SB", "WILL", "WONT", "DO", "DONT", "IAC", 7190075Sobrien 0 7290075Sobrien}; 7390075Sobrien#else 74132718Skanextern char *telcmds[]; 75132718Skan#endif 76132718Skan 77132718Skan#define TELCMD_FIRST xEOF 78132718Skan#define TELCMD_LAST IAC 79132718Skan#define TELCMD_OK(x) ((unsigned int)(x) <= TELCMD_LAST && \ 80132718Skan (unsigned int)(x) >= TELCMD_FIRST) 81132718Skan#define TELCMD(x) telcmds[(x)-TELCMD_FIRST] 82132718Skan 83132718Skan/* telnet options */ 84169689Skan#define TELOPT_BINARY 0 /* 8-bit data path */ 85169689Skan#define TELOPT_ECHO 1 /* echo */ 86132718Skan#define TELOPT_RCP 2 /* prepare to reconnect */ 87132718Skan#define TELOPT_SGA 3 /* suppress go ahead */ 88132718Skan#define TELOPT_NAMS 4 /* approximate message size */ 89132718Skan#define TELOPT_STATUS 5 /* give status */ 90132718Skan#define TELOPT_TM 6 /* timing mark */ 91132718Skan#define TELOPT_RCTE 7 /* remote controlled transmission and echo */ 92132718Skan#define TELOPT_NAOL 8 /* negotiate about output line width */ 93132718Skan#define TELOPT_NAOP 9 /* negotiate about output page size */ 94132718Skan#define TELOPT_NAOCRD 10 /* negotiate about CR disposition */ 95132718Skan#define TELOPT_NAOHTS 11 /* negotiate about horizontal tabstops */ 96132718Skan#define TELOPT_NAOHTD 12 /* negotiate about horizontal tab disposition */ 97132718Skan#define TELOPT_NAOFFD 13 /* negotiate about formfeed disposition */ 98132718Skan#define TELOPT_NAOVTS 14 /* negotiate about vertical tab stops */ 99132718Skan#define TELOPT_NAOVTD 15 /* negotiate about vertical tab disposition */ 100132718Skan#define TELOPT_NAOLFD 16 /* negotiate about output LF disposition */ 101132718Skan#define TELOPT_XASCII 17 /* extended ascic character set */ 102132718Skan#define TELOPT_LOGOUT 18 /* force logout */ 103132718Skan#define TELOPT_BM 19 /* byte macro */ 104132718Skan#define TELOPT_DET 20 /* data entry terminal */ 105132718Skan#define TELOPT_SUPDUP 21 /* supdup protocol */ 106132718Skan#define TELOPT_SUPDUPOUTPUT 22 /* supdup output */ 107132718Skan#define TELOPT_SNDLOC 23 /* send location */ 108132718Skan#define TELOPT_TTYPE 24 /* terminal type */ 109132718Skan#define TELOPT_EOR 25 /* end or record */ 110132718Skan#define TELOPT_TUID 26 /* TACACS user identification */ 111132718Skan#define TELOPT_OUTMRK 27 /* output marking */ 112132718Skan#define TELOPT_TTYLOC 28 /* terminal location number */ 113132718Skan#define TELOPT_3270REGIME 29 /* 3270 regime */ 114169689Skan#define TELOPT_X3PAD 30 /* X.3 PAD */ 115169689Skan#define TELOPT_NAWS 31 /* window size */ 116169689Skan#define TELOPT_TSPEED 32 /* terminal speed */ 117169689Skan#define TELOPT_LFLOW 33 /* remote flow control */ 118169689Skan#define TELOPT_LINEMODE 34 /* Linemode option */ 119169689Skan#define TELOPT_XDISPLOC 35 /* X Display Location */ 120169689Skan#define TELOPT_OLD_ENVIRON 36 /* Old - Environment variables */ 121169689Skan#define TELOPT_AUTHENTICATION 37/* Authenticate */ 122169689Skan#define TELOPT_ENCRYPT 38 /* Encryption option */ 123169689Skan#define TELOPT_NEW_ENVIRON 39 /* New - Environment variables */ 124169689Skan#define TELOPT_TN3270E 40 /* RFC2355 - TN3270 Enhancements */ 125169689Skan#define TELOPT_CHARSET 42 /* RFC2066 - Charset */ 126169689Skan#define TELOPT_COMPORT 44 /* RFC2217 - Com Port Control */ 127169689Skan#define TELOPT_KERMIT 47 /* RFC2840 - Kermit */ 128169689Skan#define TELOPT_EXOPL 255 /* extended-options-list */ 129169689Skan 130169689Skan 13190075Sobrien#define NTELOPTS (1+TELOPT_KERMIT) 13290075Sobrien#ifdef TELOPTS 13390075Sobrienconst char *telopts[NTELOPTS+1] = { 13490075Sobrien "BINARY", "ECHO", "RCP", "SUPPRESS GO AHEAD", "NAME", 13590075Sobrien "STATUS", "TIMING MARK", "RCTE", "NAOL", "NAOP", 13690075Sobrien "NAOCRD", "NAOHTS", "NAOHTD", "NAOFFD", "NAOVTS", 13790075Sobrien "NAOVTD", "NAOLFD", "EXTEND ASCII", "LOGOUT", "BYTE MACRO", 13890075Sobrien "DATA ENTRY TERMINAL", "SUPDUP", "SUPDUP OUTPUT", 13990075Sobrien "SEND LOCATION", "TERMINAL TYPE", "END OF RECORD", 14090075Sobrien "TACACS UID", "OUTPUT MARKING", "TTYLOC", 14190075Sobrien "3270 REGIME", "X.3 PAD", "NAWS", "TSPEED", "LFLOW", 142132718Skan "LINEMODE", "XDISPLOC", "OLD-ENVIRON", "AUTHENTICATION", 143132718Skan "ENCRYPT", "NEW-ENVIRON", "TN3270E", "CHARSET", "COM-PORT", 144132718Skan "KERMIT", 145132718Skan 0 146132718Skan}; 147132718Skan#define TELOPT_FIRST TELOPT_BINARY 148132718Skan#define TELOPT_LAST TELOPT_KERMIT 149132718Skan#define TELOPT_OK(x) ((unsigned int)(x) <= TELOPT_LAST) 150132718Skan#define TELOPT(x) telopts[(x)-TELOPT_FIRST] 151132718Skan#endif 152132718Skan 153132718Skan/* sub-option qualifiers */ 154132718Skan#define TELQUAL_IS 0 /* option is... */ 155132718Skan#define TELQUAL_SEND 1 /* send option */ 156169689Skan#define TELQUAL_INFO 2 /* ENVIRON: informational version of IS */ 157169689Skan#define TELQUAL_REPLY 2 /* AUTHENTICATION: client version of IS */ 158169689Skan#define TELQUAL_NAME 3 /* AUTHENTICATION: client version of IS */ 159169689Skan 16090075Sobrien#define LFLOW_OFF 0 /* Disable remote flow control */ 16190075Sobrien#define LFLOW_ON 1 /* Enable remote flow control */ 162169689Skan#define LFLOW_RESTART_ANY 2 /* Restart output on any char */ 163169689Skan#define LFLOW_RESTART_XON 3 /* Restart output only on XON */ 164169689Skan 165169689Skan/* 16690075Sobrien * LINEMODE suboptions 16790075Sobrien */ 168117395Skan 169117395Skan#define LM_MODE 1 170117395Skan#define LM_FORWARDMASK 2 171132718Skan#define LM_SLC 3 172132718Skan 173132718Skan#define MODE_EDIT 0x01 174169689Skan#define MODE_TRAPSIG 0x02 175169689Skan#define MODE_ACK 0x04 176132718Skan#define MODE_SOFT_TAB 0x08 177117395Skan#define MODE_LIT_ECHO 0x10 178132718Skan 17990075Sobrien#define MODE_MASK 0x1f 18090075Sobrien 18190075Sobrien/* Not part of protocol, but needed to simplify things... */ 18290075Sobrien#define MODE_FLOW 0x0100 18390075Sobrien#define MODE_ECHO 0x0200 18490075Sobrien#define MODE_INBIN 0x0400 18590075Sobrien#define MODE_OUTBIN 0x0800 18690075Sobrien#define MODE_FORCE 0x1000 18790075Sobrien 18890075Sobrien#define SLC_SYNCH 1 18990075Sobrien#define SLC_BRK 2 19090075Sobrien#define SLC_IP 3 191132718Skan#define SLC_AO 4 19290075Sobrien#define SLC_AYT 5 19390075Sobrien#define SLC_EOR 6 19490075Sobrien#define SLC_ABORT 7 19590075Sobrien#define SLC_EOF 8 19690075Sobrien#define SLC_SUSP 9 19790075Sobrien#define SLC_EC 10 19890075Sobrien#define SLC_EL 11 19990075Sobrien#define SLC_EW 12 20090075Sobrien#define SLC_RP 13 20190075Sobrien#define SLC_LNEXT 14 20290075Sobrien#define SLC_XON 15 203132718Skan#define SLC_XOFF 16 204132718Skan#define SLC_FORW1 17 205132718Skan#define SLC_FORW2 18 206132718Skan#define SLC_MCL 19 20790075Sobrien#define SLC_MCR 20 20890075Sobrien#define SLC_MCWL 21 20990075Sobrien#define SLC_MCWR 22 210169689Skan#define SLC_MCBOL 23 211169689Skan#define SLC_MCEOL 24 21290075Sobrien#define SLC_INSRT 25 21390075Sobrien#define SLC_OVER 26 21490075Sobrien#define SLC_ECR 27 21590075Sobrien#define SLC_EWR 28 21690075Sobrien#define SLC_EBOL 29 21790075Sobrien#define SLC_EEOL 30 218169689Skan 219169689Skan#define NSLC 30 220132718Skan 221169689Skan/* 222146895Skan * For backwards compatibility, we define SLC_NAMES to be the 223169689Skan * list of names if SLC_NAMES is not defined. 224169689Skan */ 225146895Skan#define SLC_NAMELIST "0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR", \ 226117395Skan "ABORT", "EOF", "SUSP", "EC", "EL", "EW", "RP", \ 227117395Skan "LNEXT", "XON", "XOFF", "FORW1", "FORW2", \ 228117395Skan "MCL", "MCR", "MCWL", "MCWR", "MCBOL", \ 229117395Skan "MCEOL", "INSRT", "OVER", "ECR", "EWR", \ 230117395Skan "EBOL", "EEOL", \ 231117395Skan 0 232117395Skan 233117395Skan#ifdef SLC_NAMES 23490075Sobrienconst char *slc_names[] = { 23590075Sobrien SLC_NAMELIST 23690075Sobrien}; 23790075Sobrien#else 238169689Skanextern char *slc_names[]; 239169689Skan#define SLC_NAMES SLC_NAMELIST 240169689Skan#endif 241169689Skan 242169689Skan#define SLC_NAME_OK(x) ((unsigned int)(x) <= NSLC) 24390075Sobrien#define SLC_NAME(x) slc_names[x] 244132718Skan 245132718Skan#define SLC_NOSUPPORT 0 246132718Skan#define SLC_CANTCHANGE 1 247132718Skan#define SLC_VARIABLE 2 248169689Skan#define SLC_DEFAULT 3 249169689Skan#define SLC_LEVELBITS 0x03 250169689Skan 251169689Skan#define SLC_FUNC 0 252169689Skan#define SLC_FLAGS 1 253169689Skan#define SLC_VALUE 2 254169689Skan 255169689Skan#define SLC_ACK 0x80 256169689Skan#define SLC_FLUSHIN 0x40 257169689Skan#define SLC_FLUSHOUT 0x20 258169689Skan 259169689Skan#define OLD_ENV_VAR 1 260117395Skan#define OLD_ENV_VALUE 0 261117395Skan#define NEW_ENV_VAR 0 262117395Skan#define NEW_ENV_VALUE 1 263117395Skan#define ENV_ESC 2 264117395Skan#define ENV_USERVAR 3 265117395Skan 266117395Skan/* 267117395Skan * AUTHENTICATION suboptions 268117395Skan */ 269117395Skan 270169689Skan/* 271169689Skan * Who is authenticating who ... 272117395Skan */ 273169689Skan#define AUTH_WHO_CLIENT 0 /* Client authenticating server */ 274169689Skan#define AUTH_WHO_SERVER 1 /* Server authenticating client */ 275169689Skan#define AUTH_WHO_MASK 1 276169689Skan 277169689Skan/* 278169689Skan * amount of authentication done 279169689Skan */ 280169689Skan#define AUTH_HOW_ONE_WAY 0 281169689Skan#define AUTH_HOW_MUTUAL 2 282169689Skan#define AUTH_HOW_MASK 2 283169689Skan 284169689Skan#define AUTHTYPE_NULL 0 285169689Skan#define AUTHTYPE_KERBEROS_V4 1 286169689Skan#define AUTHTYPE_KERBEROS_V5 2 287169689Skan#define AUTHTYPE_SPX 3 288169689Skan#define AUTHTYPE_MINK 4 289169689Skan#define AUTHTYPE_SRA 6 290169689Skan#define AUTHTYPE_CNT 7 291169689Skan 292169689Skan#define AUTHTYPE_TEST 99 293169689Skan 294169689Skan#ifdef AUTH_NAMES 295169689Skanconst char *authtype_names[] = { 296169689Skan "NULL", "KERBEROS_V4", "KERBEROS_V5", "SPX", "MINK", NULL, "SRA", 297169689Skan 0 298169689Skan}; 299169689Skan#else 300169689Skanextern char *authtype_names[]; 301169689Skan#endif 302169689Skan 303169689Skan#define AUTHTYPE_NAME_OK(x) ((unsigned int)(x) < AUTHTYPE_CNT) 304169689Skan#define AUTHTYPE_NAME(x) authtype_names[x] 305169689Skan 306169689Skan/* 307169689Skan * ENCRYPTion suboptions 308169689Skan */ 309169689Skan#define ENCRYPT_IS 0 /* I pick encryption type ... */ 310169689Skan#define ENCRYPT_SUPPORT 1 /* I support encryption types ... */ 311169689Skan#define ENCRYPT_REPLY 2 /* Initial setup response */ 312169689Skan#define ENCRYPT_START 3 /* Am starting to send encrypted */ 313169689Skan#define ENCRYPT_END 4 /* Am ending encrypted */ 314169689Skan#define ENCRYPT_REQSTART 5 /* Request you start encrypting */ 315169689Skan#define ENCRYPT_REQEND 6 /* Request you end encrypting */ 316169689Skan#define ENCRYPT_ENC_KEYID 7 317169689Skan#define ENCRYPT_DEC_KEYID 8 318169689Skan#define ENCRYPT_CNT 9 319169689Skan 320169689Skan#define ENCTYPE_ANY 0 321169689Skan#define ENCTYPE_DES_CFB64 1 322169689Skan#define ENCTYPE_DES_OFB64 2 323169689Skan#define ENCTYPE_CNT 3 324169689Skan 325169689Skan#ifdef ENCRYPT_NAMES 326169689Skanconst char *encrypt_names[] = { 327169689Skan "IS", "SUPPORT", "REPLY", "START", "END", 328169689Skan "REQUEST-START", "REQUEST-END", "ENC-KEYID", "DEC-KEYID", 329169689Skan 0 330169689Skan}; 331169689Skanconst char *enctype_names[] = { 332169689Skan "ANY", "DES_CFB64", "DES_OFB64", 333169689Skan 0 334169689Skan}; 335169689Skan#else 336169689Skanextern char *encrypt_names[]; 337169689Skanextern char *enctype_names[]; 338169689Skan#endif 339169689Skan 340169689Skan 341169689Skan#define ENCRYPT_NAME_OK(x) ((unsigned int)(x) < ENCRYPT_CNT) 342169689Skan#define ENCRYPT_NAME(x) encrypt_names[x] 343169689Skan 344169689Skan#define ENCTYPE_NAME_OK(x) ((unsigned int)(x) < ENCTYPE_CNT) 345169689Skan#define ENCTYPE_NAME(x) enctype_names[x] 346169689Skan 347169689Skan#endif /* !_TELNET_H_ */ 348169689Skan