usr.sbin/ppp/hdlc.c

   1 /*
   2  *           PPP High Level Link Control (HDLC) Module
   3  *
   4  *          Written by Toshiharu OHNO (tony-o@iij.ad.jp)
   5  *
   6  *   Copyright (C) 1993, Internet Initiative Japan, Inc. All rights reserverd.
   7  *
   8  * Redistribution and use in source and binary forms are permitted
   9  * provided that the above copyright notice and this paragraph are
  10  * duplicated in all such forms and that any documentation,
  11  * advertising materials, and other materials related to such
  12  * distribution and use acknowledge that the software was developed
  13  * by the Internet Initiative Japan, Inc.  The name of the
  14  * IIJ may not be used to endorse or promote products derived
  15  * from this software without specific prior written permission.
  16  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  18  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19  *
  20  * $FreeBSD$
  21  *
  22  *      TODO:
  23  */
  24 #include <sys/param.h>
  25 #include <sys/un.h>
  26
  27 #include <stdio.h>
  28 #include <string.h>
  29 #include <termios.h>
  30
  31 #include "defs.h"
  32 #include "layer.h"
  33 #include "command.h"
  34 #include "mbuf.h"
  35 #include "log.h"
  36 #include "timer.h"
  37 #include "fsm.h"
  38 #include "lqr.h"
  39 #include "hdlc.h"
  40 #include "throughput.h"
  41 #include "auth.h"
  42 #include "lcp.h"
  43 #include "async.h"
  44 #include "ccp.h"
  45 #include "link.h"
  46 #include "descriptor.h"
  47 #include "chap.h"
  48 #include "physical.h"
  49 #include "prompt.h"
  50 #include "chat.h"
  51 #include "mp.h"
  52 #include "cbcp.h"
  53 #include "datalink.h"
  54
  55 static u_int16_t const fcstab[256] = {
  56    /* 00 */ 0x0000, 0x1189, 0x2312, 0x329b, 0x4624, 0x57ad, 0x6536, 0x74bf,
  57    /* 08 */ 0x8c48, 0x9dc1, 0xaf5a, 0xbed3, 0xca6c, 0xdbe5, 0xe97e, 0xf8f7,
  58    /* 10 */ 0x1081, 0x0108, 0x3393, 0x221a, 0x56a5, 0x472c, 0x75b7, 0x643e,
  59    /* 18 */ 0x9cc9, 0x8d40, 0xbfdb, 0xae52, 0xdaed, 0xcb64, 0xf9ff, 0xe876,
  60    /* 20 */ 0x2102, 0x308b, 0x0210, 0x1399, 0x6726, 0x76af, 0x4434, 0x55bd,
  61    /* 28 */ 0xad4a, 0xbcc3, 0x8e58, 0x9fd1, 0xeb6e, 0xfae7, 0xc87c, 0xd9f5,
  62    /* 30 */ 0x3183, 0x200a, 0x1291, 0x0318, 0x77a7, 0x662e, 0x54b5, 0x453c,
  63    /* 38 */ 0xbdcb, 0xac42, 0x9ed9, 0x8f50, 0xfbef, 0xea66, 0xd8fd, 0xc974,
  64    /* 40 */ 0x4204, 0x538d, 0x6116, 0x709f, 0x0420, 0x15a9, 0x2732, 0x36bb,
  65    /* 48 */ 0xce4c, 0xdfc5, 0xed5e, 0xfcd7, 0x8868, 0x99e1, 0xab7a, 0xbaf3,
  66    /* 50 */ 0x5285, 0x430c, 0x7197, 0x601e, 0x14a1, 0x0528, 0x37b3, 0x263a,
  67    /* 58 */ 0xdecd, 0xcf44, 0xfddf, 0xec56, 0x98e9, 0x8960, 0xbbfb, 0xaa72,
  68    /* 60 */ 0x6306, 0x728f, 0x4014, 0x519d, 0x2522, 0x34ab, 0x0630, 0x17b9,
  69    /* 68 */ 0xef4e, 0xfec7, 0xcc5c, 0xddd5, 0xa96a, 0xb8e3, 0x8a78, 0x9bf1,
  70    /* 70 */ 0x7387, 0x620e, 0x5095, 0x411c, 0x35a3, 0x242a, 0x16b1, 0x0738,
  71    /* 78 */ 0xffcf, 0xee46, 0xdcdd, 0xcd54, 0xb9eb, 0xa862, 0x9af9, 0x8b70,
  72    /* 80 */ 0x8408, 0x9581, 0xa71a, 0xb693, 0xc22c, 0xd3a5, 0xe13e, 0xf0b7,
  73    /* 88 */ 0x0840, 0x19c9, 0x2b52, 0x3adb, 0x4e64, 0x5fed, 0x6d76, 0x7cff,
  74    /* 90 */ 0x9489, 0x8500, 0xb79b, 0xa612, 0xd2ad, 0xc324, 0xf1bf, 0xe036,
  75    /* 98 */ 0x18c1, 0x0948, 0x3bd3, 0x2a5a, 0x5ee5, 0x4f6c, 0x7df7, 0x6c7e,
  76    /* a0 */ 0xa50a, 0xb483, 0x8618, 0x9791, 0xe32e, 0xf2a7, 0xc03c, 0xd1b5,
  77    /* a8 */ 0x2942, 0x38cb, 0x0a50, 0x1bd9, 0x6f66, 0x7eef, 0x4c74, 0x5dfd,
  78    /* b0 */ 0xb58b, 0xa402, 0x9699, 0x8710, 0xf3af, 0xe226, 0xd0bd, 0xc134,
  79    /* b8 */ 0x39c3, 0x284a, 0x1ad1, 0x0b58, 0x7fe7, 0x6e6e, 0x5cf5, 0x4d7c,
  80    /* c0 */ 0xc60c, 0xd785, 0xe51e, 0xf497, 0x8028, 0x91a1, 0xa33a, 0xb2b3,
  81    /* c8 */ 0x4a44, 0x5bcd, 0x6956, 0x78df, 0x0c60, 0x1de9, 0x2f72, 0x3efb,
  82    /* d0 */ 0xd68d, 0xc704, 0xf59f, 0xe416, 0x90a9, 0x8120, 0xb3bb, 0xa232,
  83    /* d8 */ 0x5ac5, 0x4b4c, 0x79d7, 0x685e, 0x1ce1, 0x0d68, 0x3ff3, 0x2e7a,
  84    /* e0 */ 0xe70e, 0xf687, 0xc41c, 0xd595, 0xa12a, 0xb0a3, 0x8238, 0x93b1,
  85    /* e8 */ 0x6b46, 0x7acf, 0x4854, 0x59dd, 0x2d62, 0x3ceb, 0x0e70, 0x1ff9,
  86    /* f0 */ 0xf78f, 0xe606, 0xd49d, 0xc514, 0xb1ab, 0xa022, 0x92b9, 0x8330,
  87    /* f8 */ 0x7bc7, 0x6a4e, 0x58d5, 0x495c, 0x3de3, 0x2c6a, 0x1ef1, 0x0f78
  88 };
  89
  90 void
  91 hdlc_Init(struct hdlc *hdlc, struct lcp *lcp)
  92 {
  93   memset(hdlc, '\0', sizeof(struct hdlc));
  94   hdlc->lqm.owner = lcp;
  95 }
  96
  97 /*
  98  *  HDLC FCS computation. Read RFC 1171 Appendix B and CCITT X.25 section
  99  *  2.27 for further details.
 100  */
 101 u_short
 102 hdlc_Fcs(u_char *cp, size_t len)
 103 {
 104   u_short fcs = INITFCS;
 105
 106   while (len--)
 107     fcs = (fcs >> 8) ^ fcstab[(fcs ^ *cp++) & 0xff];
 108
 109   return fcs;
 110 }
 111
 112 static inline u_short
 113 HdlcFcsBuf(u_short fcs, struct mbuf *m)
 114 {
 115   int len;
 116   u_char *pos, *end;
 117
 118   len = mbuf_Length(m);
 119   pos = MBUF_CTOP(m);
 120   end = pos + m->cnt;
 121   while (len--) {
 122     fcs = (fcs >> 8) ^ fcstab[(fcs ^ *pos++) & 0xff];
 123     if (pos == end && len) {
 124       m = m->next;
 125       pos = MBUF_CTOP(m);
 126       end = pos + m->cnt;
 127     }
 128   }
 129   return (fcs);
 130 }
 131
 132 int
 133 hdlc_WrapperOctets(struct lcp *lcp, u_short proto)
 134 {
 135   return 2;
 136 }
 137
 138 static struct mbuf *
 139 hdlc_LayerPush(struct bundle *bundle, struct link *l, struct mbuf *bp,
 140                int pri, u_short *proto)
 141 {
 142   struct mbuf *last;
 143   u_char *cp;
 144   u_short fcs;
 145
 146   mbuf_SetType(bp, MB_HDLCOUT);
 147   fcs = HdlcFcsBuf(INITFCS, bp);
 148   fcs = ~fcs;
 149
 150   for (last = bp; last->next; last = last->next)
 151     ;
 152
 153   if (last->size - last->offset - last->cnt >= 2) {
 154     cp = MBUF_CTOP(last) + last->cnt;
 155     last->cnt += 2;
 156   } else {
 157     struct mbuf *tail = mbuf_Alloc(2, MB_HDLCOUT);
 158     last->next = tail;
 159     cp = MBUF_CTOP(tail);
 160   }
 161
 162   *cp++ = fcs & 0377;           /* Low byte first (nothing like consistency) */
 163   *cp++ = fcs >> 8;
 164
 165   log_DumpBp(LogHDLC, "hdlc_Output", bp);
 166
 167   return bp;
 168 }
 169
 170 /* Check out the latest ``Assigned numbers'' rfc (rfc1700.txt) */
 171 static struct {
 172   u_short from;
 173   u_short to;
 174   const char *name;
 175 } protocols[] = {
 176   { 0x0001, 0x0001, "Padding Protocol" },
 177   { 0x0003, 0x001f, "reserved (transparency inefficient)" },
 178   { 0x0021, 0x0021, "Internet Protocol" },
 179   { 0x0023, 0x0023, "OSI Network Layer" },
 180   { 0x0025, 0x0025, "Xerox NS IDP" },
 181   { 0x0027, 0x0027, "DECnet Phase IV" },
 182   { 0x0029, 0x0029, "Appletalk" },
 183   { 0x002b, 0x002b, "Novell IPX" },
 184   { 0x002d, 0x002d, "Van Jacobson Compressed TCP/IP" },
 185   { 0x002f, 0x002f, "Van Jacobson Uncompressed TCP/IP" },
 186   { 0x0031, 0x0031, "Bridging PDU" },
 187   { 0x0033, 0x0033, "Stream Protocol (ST-II)" },
 188   { 0x0035, 0x0035, "Banyan Vines" },
 189   { 0x0037, 0x0037, "reserved (until 1993)" },
 190   { 0x0039, 0x0039, "AppleTalk EDDP" },
 191   { 0x003b, 0x003b, "AppleTalk SmartBuffered" },
 192   { 0x003d, 0x003d, "Multi-Link" },
 193   { 0x003f, 0x003f, "NETBIOS Framing" },
 194   { 0x0041, 0x0041, "Cisco Systems" },
 195   { 0x0043, 0x0043, "Ascom Timeplex" },
 196   { 0x0045, 0x0045, "Fujitsu Link Backup and Load Balancing (LBLB)" },
 197   { 0x0047, 0x0047, "DCA Remote Lan" },
 198   { 0x0049, 0x0049, "Serial Data Transport Protocol (PPP-SDTP)" },
 199   { 0x004b, 0x004b, "SNA over 802.2" },
 200   { 0x004d, 0x004d, "SNA" },
 201   { 0x004f, 0x004f, "IP6 Header Compression" },
 202   { 0x0051, 0x0051, "KNX Bridging Data" },
 203   { 0x0053, 0x0053, "Encryption" },
 204   { 0x0055, 0x0055, "Individual Link Encryption" },
 205   { 0x006f, 0x006f, "Stampede Bridging" },
 206   { 0x0071, 0x0071, "BAP Bandwidth Allocation Protocol" },
 207   { 0x0073, 0x0073, "MP+ Protocol" },
 208   { 0x007d, 0x007d, "reserved (Control Escape)" },
 209   { 0x007f, 0x007f, "reserved (compression inefficient)" },
 210   { 0x00cf, 0x00cf, "reserved (PPP NLPID)" },
 211   { 0x00fb, 0x00fb, "compression on single link in multilink group" },
 212   { 0x00fd, 0x00fd, "1st choice compression" },
 213   { 0x00ff, 0x00ff, "reserved (compression inefficient)" },
 214   { 0x0200, 0x02ff, "(compression inefficient)" },
 215   { 0x0201, 0x0201, "802.1d Hello Packets" },
 216   { 0x0203, 0x0203, "IBM Source Routing BPDU" },
 217   { 0x0205, 0x0205, "DEC LANBridge100 Spanning Tree" },
 218   { 0x0207, 0x0207, "Cisco Discovery Protocol" },
 219   { 0x0209, 0x0209, "Netcs Twin Routing" },
 220   { 0x0231, 0x0231, "Luxcom" },
 221   { 0x0233, 0x0233, "Sigma Network Systems" },
 222   { 0x0235, 0x0235, "Apple Client Server Protocol" },
 223   { 0x1e00, 0x1eff, "(compression inefficient)" },
 224   { 0x4001, 0x4001, "Cray Communications Control Protocol" },
 225   { 0x4003, 0x4003, "CDPD Mobile Network Registration Protocol" },
 226   { 0x4021, 0x4021, "Stacker LZS" },
 227   { 0x8001, 0x801f, "Not Used - reserved" },
 228   { 0x8021, 0x8021, "Internet Protocol Control Protocol" },
 229   { 0x8023, 0x8023, "OSI Network Layer Control Protocol" },
 230   { 0x8025, 0x8025, "Xerox NS IDP Control Protocol" },
 231   { 0x8027, 0x8027, "DECnet Phase IV Control Protocol" },
 232   { 0x8029, 0x8029, "Appletalk Control Protocol" },
 233   { 0x802b, 0x802b, "Novell IPX Control Protocol" },
 234   { 0x802d, 0x802d, "reserved" },
 235   { 0x802f, 0x802f, "reserved" },
 236   { 0x8031, 0x8031, "Bridging NCP" },
 237   { 0x8033, 0x8033, "Stream Protocol Control Protocol" },
 238   { 0x8035, 0x8035, "Banyan Vines Control Protocol" },
 239   { 0x8037, 0x8037, "reserved till 1993" },
 240   { 0x8039, 0x8039, "reserved" },
 241   { 0x803b, 0x803b, "reserved" },
 242   { 0x803d, 0x803d, "Multi-Link Control Protocol" },
 243   { 0x803f, 0x803f, "NETBIOS Framing Control Protocol" },
 244   { 0x8041, 0x8041, "Cisco Systems Control Protocol" },
 245   { 0x8043, 0x8043, "Ascom Timeplex" },
 246   { 0x8045, 0x8045, "Fujitsu LBLB Control Protocol" },
 247   { 0x8047, 0x8047, "DCA Remote Lan Network Control Protocol (RLNCP)" },
 248   { 0x8049, 0x8049, "Serial Data Control Protocol (PPP-SDCP)" },
 249   { 0x804b, 0x804b, "SNA over 802.2 Control Protocol" },
 250   { 0x804d, 0x804d, "SNA Control Protocol" },
 251   { 0x804f, 0x804f, "IP6 Header Compression Control Protocol" },
 252   { 0x8051, 0x8051, "KNX Bridging Control Protocol" },
 253   { 0x8053, 0x8053, "Encryption Control Protocol" },
 254   { 0x8055, 0x8055, "Individual Link Encryption Control Protocol" },
 255   { 0x806f, 0x806f, "Stampede Bridging Control Protocol" },
 256   { 0x8073, 0x8073, "MP+ Control Protocol" },
 257   { 0x8071, 0x8071, "BACP Bandwidth Allocation Control Protocol" },
 258   { 0x807d, 0x807d, "Not Used - reserved" },
 259   { 0x80cf, 0x80cf, "Not Used - reserved" },
 260   { 0x80fb, 0x80fb, "compression on single link in multilink group control" },
 261   { 0x80fd, 0x80fd, "Compression Control Protocol" },
 262   { 0x80ff, 0x80ff, "Not Used - reserved" },
 263   { 0x8207, 0x8207, "Cisco Discovery Protocol Control" },
 264   { 0x8209, 0x8209, "Netcs Twin Routing" },
 265   { 0x8235, 0x8235, "Apple Client Server Protocol Control" },
 266   { 0xc021, 0xc021, "Link Control Protocol" },
 267   { 0xc023, 0xc023, "Password Authentication Protocol" },
 268   { 0xc025, 0xc025, "Link Quality Report" },
 269   { 0xc027, 0xc027, "Shiva Password Authentication Protocol" },
 270   { 0xc029, 0xc029, "CallBack Control Protocol (CBCP)" },
 271   { 0xc081, 0xc081, "Container Control Protocol" },
 272   { 0xc223, 0xc223, "Challenge Handshake Authentication Protocol" },
 273   { 0xc225, 0xc225, "RSA Authentication Protocol" },
 274   { 0xc227, 0xc227, "Extensible Authentication Protocol" },
 275   { 0xc26f, 0xc26f, "Stampede Bridging Authorization Protocol" },
 276   { 0xc281, 0xc281, "Proprietary Authentication Protocol" },
 277   { 0xc283, 0xc283, "Proprietary Authentication Protocol" },
 278   { 0xc481, 0xc481, "Proprietary Node ID Authentication Protocol" }
 279 };
 280
 281 #define NPROTOCOLS (sizeof protocols/sizeof protocols[0])
 282
 283 const char *
 284 hdlc_Protocol2Nam(u_short proto)
 285 {
 286   int f;
 287
 288   for (f = 0; f < NPROTOCOLS; f++)
 289     if (proto >= protocols[f].from && proto <= protocols[f].to)
 290       return protocols[f].name;
 291     else if (proto < protocols[f].from)
 292       break;
 293   return "unrecognised protocol";
 294 }
 295
 296 static struct mbuf *
 297 hdlc_LayerPull(struct bundle *b, struct link *l, struct mbuf *bp,
 298                u_short *proto)
 299 {
 300   struct physical *p = link2physical(l);
 301   u_short fcs;
 302   int len;
 303
 304   if (!p) {
 305     log_Printf(LogERROR, "Can't Pull a hdlc packet from a logical link\n");
 306     return bp;
 307   }
 308
 309   log_DumpBp(LogHDLC, "hdlc_Input:", bp);
 310
 311   fcs = hdlc_Fcs(MBUF_CTOP(bp), bp->cnt);
 312
 313   log_Printf(LogDEBUG, "%s: hdlc_Input: fcs = %04x (%s)\n",
 314              p->link.name, fcs, (fcs == GOODFCS) ? "good" : "BAD!");
 315
 316   if (fcs != GOODFCS) {
 317     p->hdlc.lqm.SaveInErrors++;
 318     p->hdlc.stats.badfcs++;
 319     mbuf_Free(bp);
 320     return NULL;
 321   }
 322
 323   p->hdlc.lqm.SaveInOctets += bp->cnt + 1;
 324   p->hdlc.lqm.SaveInPackets++;
 325
 326   len = mbuf_Length(bp);
 327   if (len < 4) {                        /* rfc1662 section 4.3 */
 328     mbuf_Free(bp);
 329     bp = NULL;
 330   }
 331
 332   bp = mbuf_Truncate(bp, len - 2);      /* discard the FCS */
 333   mbuf_SetType(bp, MB_HDLCIN);
 334
 335   return bp;
 336 }
 337
 338 /* Detect a HDLC frame */
 339
 340 static const struct frameheader {
 341   const u_char *data;
 342   int len;
 343 } FrameHeaders[] = {
 344   { "\176\377\003\300\041", 5 },
 345   { "\176\377\175\043\300\041", 6 },
 346   { "\176\177\175\043\100\041", 6 },
 347   { "\176\175\337\175\043\300\041", 7 },
 348   { "\176\175\137\175\043\100\041", 7 },
 349   { NULL, 0 }
 350 };
 351
 352 int
 353 hdlc_Detect(u_char const **cp, int n, int issync)
 354 {
 355   const struct frameheader *fh;
 356   const u_char *h;
 357   size_t len, cmp;
 358
 359   while (n) {
 360     for (fh = FrameHeaders; fh->len; fh++) {
 361       h = issync ? fh->data + 1 : fh->data;
 362       len = issync ? fh->len - 1 : fh->len;
 363       cmp = n >= len ? len : n;
 364       if (memcmp(*cp, h, cmp) == 0)
 365         return cmp == len;
 366     }
 367     n--;
 368     (*cp)++;
 369   }
 370
 371   return 0;
 372 }
 373
 374 int
 375 hdlc_ReportStatus(struct cmdargs const *arg)
 376 {
 377   struct hdlc *hdlc = &arg->cx->physical->hdlc;
 378
 379   prompt_Printf(arg->prompt, "%s HDLC level errors:\n", arg->cx->name);
 380   prompt_Printf(arg->prompt, " Bad Frame Check Sequence fields: %u\n",
 381                 hdlc->stats.badfcs);
 382   prompt_Printf(arg->prompt, " Bad address (!= 0x%02x) fields:    %u\n",
 383                 HDLC_ADDR, hdlc->stats.badaddr);
 384   prompt_Printf(arg->prompt, " Bad command (!= 0x%02x) fields:    %u\n",
 385                 HDLC_UI, hdlc->stats.badcommand);
 386   prompt_Printf(arg->prompt, " Unrecognised protocol fields:    %u\n",
 387                 hdlc->stats.unknownproto);
 388   return 0;
 389 }
 390
 391 static void
 392 hdlc_ReportTime(void *v)
 393 {
 394   /* Moan about HDLC errors */
 395   struct hdlc *hdlc = (struct hdlc *)v;
 396
 397   timer_Stop(&hdlc->ReportTimer);
 398
 399   if (memcmp(&hdlc->laststats, &hdlc->stats, sizeof hdlc->stats)) {
 400     log_Printf(LogPHASE,
 401               "%s: HDLC errors -> FCS: %u, ADDR: %u, COMD: %u, PROTO: %u\n",
 402               hdlc->lqm.owner->fsm.link->name,
 403               hdlc->stats.badfcs - hdlc->laststats.badfcs,
 404               hdlc->stats.badaddr - hdlc->laststats.badaddr,
 405               hdlc->stats.badcommand - hdlc->laststats.badcommand,
 406               hdlc->stats.unknownproto - hdlc->laststats.unknownproto);
 407     hdlc->laststats = hdlc->stats;
 408   }
 409
 410   timer_Start(&hdlc->ReportTimer);
 411 }
 412
 413 void
 414 hdlc_StartTimer(struct hdlc *hdlc)
 415 {
 416   timer_Stop(&hdlc->ReportTimer);
 417   hdlc->ReportTimer.load = 60 * SECTICKS;
 418   hdlc->ReportTimer.arg = hdlc;
 419   hdlc->ReportTimer.func = hdlc_ReportTime;
 420   hdlc->ReportTimer.name = "hdlc";
 421   timer_Start(&hdlc->ReportTimer);
 422 }
 423
 424 void
 425 hdlc_StopTimer(struct hdlc *hdlc)
 426 {
 427   timer_Stop(&hdlc->ReportTimer);
 428 }
 429
 430 struct layer hdlclayer = { LAYER_HDLC, "hdlc", hdlc_LayerPush, hdlc_LayerPull };