include/arpa/telnet.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1983, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)telnet.h    8.2 (Berkeley) 12/15/93
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _ARPA_TELNET_H_
  36 #define _ARPA_TELNET_H_
  37
  38 /*
  39  * Definitions for the TELNET protocol.
  40  */
  41 #define IAC     255             /* interpret as command: */
  42 #define DONT    254             /* you are not to use option */
  43 #define DO      253             /* please, you use option */
  44 #define WONT    252             /* I won't use option */
  45 #define WILL    251             /* I will use option */
  46 #define SB      250             /* interpret as subnegotiation */
  47 #define GA      249             /* you may reverse the line */
  48 #define EL      248             /* erase the current line */
  49 #define EC      247             /* erase the current character */
  50 #define AYT     246             /* are you there */
  51 #define AO      245             /* abort output--but let prog finish */
  52 #define IP      244             /* interrupt process--permanently */
  53 #define BREAK   243             /* break */
  54 #define DM      242             /* data mark--for connect. cleaning */
  55 #define NOP     241             /* nop */
  56 #define SE      240             /* end sub negotiation */
  57 #define EOR     239             /* end of record (transparent mode) */
  58 #define ABORT   238             /* Abort process */
  59 #define SUSP    237             /* Suspend process */
  60 #define xEOF    236             /* End of file: EOF is already used... */
  61
  62 #define SYNCH   242             /* for telfunc calls */
  63
  64 #ifdef TELCMDS
  65 const char *telcmds[] = {
  66         "EOF", "SUSP", "ABORT", "EOR",
  67         "SE", "NOP", "DMARK", "BRK", "IP", "AO", "AYT", "EC",
  68         "EL", "GA", "SB", "WILL", "WONT", "DO", "DONT", "IAC",
  69         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_TN3270E  40      /* RFC2355 - TN3270 Enhancements */
 123 #define TELOPT_CHARSET  42      /* RFC2066 - Charset */
 124 #define TELOPT_COMPORT  44      /* RFC2217 - Com Port Control */
 125 #define TELOPT_KERMIT   47      /* RFC2840 - Kermit */
 126 #define TELOPT_EXOPL    255     /* extended-options-list */
 127
 128
 129 #define NTELOPTS        (1+TELOPT_KERMIT)
 130 #ifdef TELOPTS
 131 const char *telopts[NTELOPTS+1] = {
 132         "BINARY", "ECHO", "RCP", "SUPPRESS GO AHEAD", "NAME",
 133         "STATUS", "TIMING MARK", "RCTE", "NAOL", "NAOP",
 134         "NAOCRD", "NAOHTS", "NAOHTD", "NAOFFD", "NAOVTS",
 135         "NAOVTD", "NAOLFD", "EXTEND ASCII", "LOGOUT", "BYTE MACRO",
 136         "DATA ENTRY TERMINAL", "SUPDUP", "SUPDUP OUTPUT",
 137         "SEND LOCATION", "TERMINAL TYPE", "END OF RECORD",
 138         "TACACS UID", "OUTPUT MARKING", "TTYLOC",
 139         "3270 REGIME", "X.3 PAD", "NAWS", "TSPEED", "LFLOW",
 140         "LINEMODE", "XDISPLOC", "OLD-ENVIRON", "AUTHENTICATION",
 141         "ENCRYPT", "NEW-ENVIRON", "TN3270E", "XAUTH", "CHARSET",
 142         "RSP", "COM-PORT", "SLE", "STARTTLS", "KERMIT",
 143         0
 144 };
 145 #define TELOPT_FIRST    TELOPT_BINARY
 146 #define TELOPT_LAST     TELOPT_KERMIT
 147 #define TELOPT_OK(x)    ((unsigned int)(x) <= TELOPT_LAST)
 148 #define TELOPT(x)       telopts[(x)-TELOPT_FIRST]
 149 #endif
 150
 151 /* sub-option qualifiers */
 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
 167 #define LM_MODE         1
 168 #define LM_FORWARDMASK  2
 169 #define LM_SLC          3
 170
 171 #define MODE_EDIT       0x01
 172 #define MODE_TRAPSIG    0x02
 173 #define MODE_ACK        0x04
 174 #define MODE_SOFT_TAB   0x08
 175 #define MODE_LIT_ECHO   0x10
 176
 177 #define MODE_MASK       0x1f
 178
 179 /* Not part of protocol, but needed to simplify things... */
 180 #define MODE_FLOW               0x0100
 181 #define MODE_ECHO               0x0200
 182 #define MODE_INBIN              0x0400
 183 #define MODE_OUTBIN             0x0800
 184 #define MODE_FORCE              0x1000
 185
 186 #define SLC_SYNCH       1
 187 #define SLC_BRK         2
 188 #define SLC_IP          3
 189 #define SLC_AO          4
 190 #define SLC_AYT         5
 191 #define SLC_EOR         6
 192 #define SLC_ABORT       7
 193 #define SLC_EOF         8
 194 #define SLC_SUSP        9
 195 #define SLC_EC          10
 196 #define SLC_EL          11
 197 #define SLC_EW          12
 198 #define SLC_RP          13
 199 #define SLC_LNEXT       14
 200 #define SLC_XON         15
 201 #define SLC_XOFF        16
 202 #define SLC_FORW1       17
 203 #define SLC_FORW2       18
 204 #define SLC_MCL         19
 205 #define SLC_MCR         20
 206 #define SLC_MCWL        21
 207 #define SLC_MCWR        22
 208 #define SLC_MCBOL       23
 209 #define SLC_MCEOL       24
 210 #define SLC_INSRT       25
 211 #define SLC_OVER        26
 212 #define SLC_ECR         27
 213 #define SLC_EWR         28
 214 #define SLC_EBOL        29
 215 #define SLC_EEOL        30
 216
 217 #define NSLC            30
 218
 219 /*
 220  * For backwards compatibility, we define SLC_NAMES to be the
 221  * list of names if SLC_NAMES is not defined.
 222  */
 223 #define SLC_NAMELIST    "0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR",  \
 224                         "ABORT", "EOF", "SUSP", "EC", "EL", "EW", "RP", \
 225                         "LNEXT", "XON", "XOFF", "FORW1", "FORW2",       \
 226                         "MCL", "MCR", "MCWL", "MCWR", "MCBOL",          \
 227                         "MCEOL", "INSRT", "OVER", "ECR", "EWR",         \
 228                         "EBOL", "EEOL",                                 \
 229                         0
 230
 231 #ifdef  SLC_NAMES
 232 const char *slc_names[] = {
 233         SLC_NAMELIST
 234 };
 235 #else
 236 extern char *slc_names[];
 237 #define SLC_NAMES SLC_NAMELIST
 238 #endif
 239
 240 #define SLC_NAME_OK(x)  ((unsigned int)(x) <= NSLC)
 241 #define SLC_NAME(x)     slc_names[x]
 242
 243 #define SLC_NOSUPPORT   0
 244 #define SLC_CANTCHANGE  1
 245 #define SLC_VARIABLE    2
 246 #define SLC_DEFAULT     3
 247 #define SLC_LEVELBITS   0x03
 248
 249 #define SLC_FUNC        0
 250 #define SLC_FLAGS       1
 251 #define SLC_VALUE       2
 252
 253 #define SLC_ACK         0x80
 254 #define SLC_FLUSHIN     0x40
 255 #define SLC_FLUSHOUT    0x20
 256
 257 #define OLD_ENV_VAR     1
 258 #define OLD_ENV_VALUE   0
 259 #define NEW_ENV_VAR     0
 260 #define NEW_ENV_VALUE   1
 261 #define ENV_ESC         2
 262 #define ENV_USERVAR     3
 263
 264 /*
 265  * AUTHENTICATION suboptions
 266  */
 267
 268 /*
 269  * Who is authenticating who ...
 270  */
 271 #define AUTH_WHO_CLIENT         0       /* Client authenticating server */
 272 #define AUTH_WHO_SERVER         1       /* Server authenticating client */
 273 #define AUTH_WHO_MASK           1
 274
 275 /*
 276  * amount of authentication done
 277  */
 278 #define AUTH_HOW_ONE_WAY        0
 279 #define AUTH_HOW_MUTUAL         2
 280 #define AUTH_HOW_MASK           2
 281
 282 #define AUTHTYPE_NULL           0
 283 #define AUTHTYPE_KERBEROS_V4    1
 284 #define AUTHTYPE_KERBEROS_V5    2
 285 #define AUTHTYPE_SPX            3
 286 #define AUTHTYPE_MINK           4
 287 #define AUTHTYPE_SRA            6
 288 #define AUTHTYPE_CNT            7
 289
 290 #define AUTHTYPE_TEST           99
 291
 292 #ifdef  AUTH_NAMES
 293 const char *authtype_names[] = {
 294         "NULL", "KERBEROS_V4", "KERBEROS_V5", "SPX", "MINK", NULL, "SRA",
 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
 318 #define ENCTYPE_ANY             0
 319 #define ENCTYPE_DES_CFB64       1
 320 #define ENCTYPE_DES_OFB64       2
 321 #define ENCTYPE_CNT             3
 322
 323 #ifdef  ENCRYPT_NAMES
 324 const char *encrypt_names[] = {
 325         "IS", "SUPPORT", "REPLY", "START", "END",
 326         "REQUEST-START", "REQUEST-END", "ENC-KEYID", "DEC-KEYID",
 327         0
 328 };
 329 const char *enctype_names[] = {
 330         "ANY", "DES_CFB64",  "DES_OFB64",
 331         0
 332 };
 333 #else
 334 extern char *encrypt_names[];
 335 extern char *enctype_names[];
 336 #endif
 337
 338
 339 #define ENCRYPT_NAME_OK(x)      ((unsigned int)(x) < ENCRYPT_CNT)
 340 #define ENCRYPT_NAME(x)         encrypt_names[x]
 341
 342 #define ENCTYPE_NAME_OK(x)      ((unsigned int)(x) < ENCTYPE_CNT)
 343 #define ENCTYPE_NAME(x)         enctype_names[x]
 344
 345 #endif /* !_TELNET_H_ */