sys/netgraph/cisco/ng_cisco.c

   1
   2 /*
   3  * ng_cisco.c
   4  *
   5  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   6  * All rights reserved.
   7  *
   8  * Subject to the following obligations and disclaimer of warranty, use and
   9  * redistribution of this software, in source or object code forms, with or
  10  * without modifications are expressly permitted by Whistle Communications;
  11  * provided, however, that:
  12  * 1. Any and all reproductions of the source or object code must include the
  13  *    copyright notice above and the following disclaimer of warranties; and
  14  * 2. No rights are granted, in any manner or form, to use Whistle
  15  *    Communications, Inc. trademarks, including the mark "WHISTLE
  16  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  17  *    such appears in the above copyright notice or in the software.
  18  *
  19  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  20  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  21  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  22  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  23  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  24  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  25  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  26  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  27  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  28  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  29  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  30  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  31  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  32  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  35  * OF SUCH DAMAGE.
  36  *
  37  * Author: Julian Elischer <julian@freebsd.org>
  38  *
  39  * $FreeBSD: src/sys/netgraph/ng_cisco.c,v 1.4.2.6 2002/07/02 23:44:02 archie Exp $
  40  * $DragonFly: src/sys/netgraph/cisco/ng_cisco.c,v 1.9 2006/12/20 18:14:43 dillon Exp $
  41  * $Whistle: ng_cisco.c,v 1.25 1999/11/01 09:24:51 julian Exp $
  42  */
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/errno.h>
  47 #include <sys/kernel.h>
  48 #include <sys/socket.h>
  49 #include <sys/malloc.h>
  50 #include <sys/mbuf.h>
  51 #include <sys/syslog.h>
  52 #include <sys/thread2.h>
  53
  54 #include <machine/inttypes.h>
  55
  56 #include <net/if.h>
  57
  58 #include <netinet/in.h>
  59 #include <netinet/if_ether.h>
  60
  61 #include <netproto/atalk/at.h>
  62
  63 #include <netproto/ipx/ipx.h>
  64 #include <netproto/ipx/ipx_if.h>
  65
  66 #include <netgraph/ng_message.h>
  67 #include <netgraph/netgraph.h>
  68 #include <netgraph/ng_parse.h>
  69 #include "ng_cisco.h"
  70
  71 #define CISCO_MULTICAST         0x8f    /* Cisco multicast address */
  72 #define CISCO_UNICAST           0x0f    /* Cisco unicast address */
  73 #define CISCO_KEEPALIVE         0x8035  /* Cisco keepalive protocol */
  74 #define CISCO_ADDR_REQ          0       /* Cisco address request */
  75 #define CISCO_ADDR_REPLY        1       /* Cisco address reply */
  76 #define CISCO_KEEPALIVE_REQ     2       /* Cisco keepalive request */
  77
  78 #define KEEPALIVE_SECS          10
  79
  80 struct cisco_header {
  81         u_char  address;
  82         u_char  control;
  83         u_short protocol;
  84 };
  85
  86 #define CISCO_HEADER_LEN          sizeof (struct cisco_header)
  87
  88 struct cisco_packet {
  89         u_long  type;
  90         u_long  par1;
  91         u_long  par2;
  92         u_short rel;
  93         u_short time0;
  94         u_short time1;
  95 };
  96
  97 #define CISCO_PACKET_LEN (sizeof(struct cisco_packet))
  98
  99 struct protoent {
 100         hook_p  hook;           /* the hook for this proto */
 101         u_short af;             /* address family, -1 = downstream */
 102 };
 103
 104 struct cisco_priv {
 105         u_long  local_seq;
 106         u_long  remote_seq;
 107         u_long  seqRetries;     /* how many times we've been here throwing out
 108                                  * the same sequence number without ack */
 109         node_p  node;
 110         struct callout timeout;
 111         struct protoent downstream;
 112         struct protoent inet;           /* IP information */
 113         struct in_addr localip;
 114         struct in_addr localmask;
 115         struct protoent inet6;          /* IPv6 information */
 116         struct protoent atalk;          /* AppleTalk information */
 117         struct protoent ipx;            /* IPX information */
 118 };
 119 typedef struct cisco_priv *sc_p;
 120
 121 /* Netgraph methods */
 122 static ng_constructor_t         cisco_constructor;
 123 static ng_rcvmsg_t              cisco_rcvmsg;
 124 static ng_shutdown_t            cisco_rmnode;
 125 static ng_newhook_t             cisco_newhook;
 126 static ng_rcvdata_t             cisco_rcvdata;
 127 static ng_disconnect_t          cisco_disconnect;
 128
 129 /* Other functions */
 130 static int      cisco_input(sc_p sc, struct mbuf *m, meta_p meta);
 131 static void     cisco_keepalive(void *arg);
 132 static int      cisco_send(sc_p sc, int type, long par1, long par2);
 133
 134 /* Parse type for struct ng_cisco_ipaddr */
 135 static const struct ng_parse_struct_field ng_cisco_ipaddr_type_fields[]
 136         = NG_CISCO_IPADDR_TYPE_INFO;
 137 static const struct ng_parse_type ng_cisco_ipaddr_type = {
 138         &ng_parse_struct_type,
 139         &ng_cisco_ipaddr_type_fields
 140 };
 141
 142 /* Parse type for struct ng_async_stat */
 143 static const struct ng_parse_struct_field ng_cisco_stats_type_fields[]
 144         = NG_CISCO_STATS_TYPE_INFO;
 145 static const struct ng_parse_type ng_cisco_stats_type = {
 146         &ng_parse_struct_type,
 147         &ng_cisco_stats_type_fields
 148 };
 149
 150 /* List of commands and how to convert arguments to/from ASCII */
 151 static const struct ng_cmdlist ng_cisco_cmdlist[] = {
 152         {
 153           NGM_CISCO_COOKIE,
 154           NGM_CISCO_SET_IPADDR,
 155           "setipaddr",
 156           &ng_cisco_ipaddr_type,
 157           NULL
 158         },
 159         {
 160           NGM_CISCO_COOKIE,
 161           NGM_CISCO_GET_IPADDR,
 162           "getipaddr",
 163           NULL,
 164           &ng_cisco_ipaddr_type
 165         },
 166         {
 167           NGM_CISCO_COOKIE,
 168           NGM_CISCO_GET_STATUS,
 169           "getstats",
 170           NULL,
 171           &ng_cisco_stats_type
 172         },
 173         { 0 }
 174 };
 175
 176 /* Node type */
 177 static struct ng_type typestruct = {
 178         NG_VERSION,
 179         NG_CISCO_NODE_TYPE,
 180         NULL,
 181         cisco_constructor,
 182         cisco_rcvmsg,
 183         cisco_rmnode,
 184         cisco_newhook,
 185         NULL,
 186         NULL,
 187         cisco_rcvdata,
 188         cisco_rcvdata,
 189         cisco_disconnect,
 190         ng_cisco_cmdlist
 191 };
 192 NETGRAPH_INIT(cisco, &typestruct);
 193
 194 /*
 195  * Node constructor
 196  */
 197 static int
 198 cisco_constructor(node_p *nodep)
 199 {
 200         sc_p sc;
 201         int error = 0;
 202
 203         MALLOC(sc, sc_p, sizeof(*sc), M_NETGRAPH, M_NOWAIT);
 204         if (sc == NULL)
 205                 return (ENOMEM);
 206         bzero(sc, sizeof(struct cisco_priv));
 207
 208         callout_init(&sc->timeout);
 209         if ((error = ng_make_node_common(&typestruct, nodep))) {
 210                 FREE(sc, M_NETGRAPH);
 211                 return (error);
 212         }
 213         (*nodep)->private = sc;
 214         sc->node = *nodep;
 215
 216         /* Initialise the varous protocol hook holders */
 217         sc->downstream.af = 0xffff;
 218         sc->inet.af = AF_INET;
 219         sc->inet6.af = AF_INET6;
 220         sc->atalk.af = AF_APPLETALK;
 221         sc->ipx.af = AF_IPX;
 222         return (0);
 223 }
 224
 225 /*
 226  * Check new hook
 227  */
 228 static int
 229 cisco_newhook(node_p node, hook_p hook, const char *name)
 230 {
 231         const sc_p sc = node->private;
 232
 233         if (strcmp(name, NG_CISCO_HOOK_DOWNSTREAM) == 0) {
 234                 sc->downstream.hook = hook;
 235                 hook->private = &sc->downstream;
 236
 237                 /* Start keepalives */
 238                 callout_reset(&sc->timeout, hz * KEEPALIVE_SECS,
 239                                 cisco_keepalive, sc);
 240         } else if (strcmp(name, NG_CISCO_HOOK_INET) == 0) {
 241                 sc->inet.hook = hook;
 242                 hook->private = &sc->inet;
 243         } else if (strcmp(name, NG_CISCO_HOOK_APPLETALK) == 0) {
 244                 sc->atalk.hook = hook;
 245                 hook->private = &sc->atalk;
 246         } else if (strcmp(name, NG_CISCO_HOOK_IPX) == 0) {
 247                 sc->ipx.hook = hook;
 248                 hook->private = &sc->ipx;
 249         } else if (strcmp(name, NG_CISCO_HOOK_DEBUG) == 0) {
 250                 hook->private = NULL;   /* unimplemented */
 251         } else
 252                 return (EINVAL);
 253         return 0;
 254 }
 255
 256 /*
 257  * Receive control message.
 258  */
 259 static int
 260 cisco_rcvmsg(node_p node, struct ng_mesg *msg,
 261         const char *retaddr, struct ng_mesg **rptr)
 262 {
 263         const sc_p sc = node->private;
 264         struct ng_mesg *resp = NULL;
 265         int error = 0;
 266
 267         switch (msg->header.typecookie) {
 268         case NGM_GENERIC_COOKIE:
 269                 switch (msg->header.cmd) {
 270                 case NGM_TEXT_STATUS:
 271                     {
 272                         char *arg;
 273                         int pos;
 274
 275                         NG_MKRESPONSE(resp, msg, sizeof(struct ng_mesg)
 276                             + NG_TEXTRESPONSE, M_NOWAIT);
 277                         if (resp == NULL) {
 278                                 error = ENOMEM;
 279                                 break;
 280                         }
 281                         arg = (char *) resp->data;
 282                         pos = ksprintf(arg,
 283                           "keepalive period: %d sec; ", KEEPALIVE_SECS);
 284                         pos += ksprintf(arg + pos,
 285                           "unacknowledged keepalives: %ld", sc->seqRetries);
 286                         resp->header.arglen = pos + 1;
 287                         break;
 288                     }
 289                 default:
 290                         error = EINVAL;
 291                         break;
 292                 }
 293                 break;
 294         case NGM_CISCO_COOKIE:
 295                 switch (msg->header.cmd) {
 296                 case NGM_CISCO_GET_IPADDR:      /* could be a late reply! */
 297                         if ((msg->header.flags & NGF_RESP) == 0) {
 298                                 struct in_addr *ips;
 299
 300                                 NG_MKRESPONSE(resp, msg,
 301                                     2 * sizeof(*ips), M_NOWAIT);
 302                                 if (!resp) {
 303                                         error = ENOMEM;
 304                                         break;
 305                                 }
 306                                 ips = (struct in_addr *) resp->data;
 307                                 ips[0] = sc->localip;
 308                                 ips[1] = sc->localmask;
 309                                 break;
 310                         }
 311                         /* FALLTHROUGH */       /* ...if it's a reply */
 312                 case NGM_CISCO_SET_IPADDR:
 313                     {
 314                         struct in_addr *const ips = (struct in_addr *)msg->data;
 315
 316                         if (msg->header.arglen < 2 * sizeof(*ips)) {
 317                                 error = EINVAL;
 318                                 break;
 319                         }
 320                         sc->localip = ips[0];
 321                         sc->localmask = ips[1];
 322                         break;
 323                     }
 324                 case NGM_CISCO_GET_STATUS:
 325                     {
 326                         struct ng_cisco_stats *stat;
 327
 328                         NG_MKRESPONSE(resp, msg, sizeof(*stat), M_NOWAIT);
 329                         if (!resp) {
 330                                 error = ENOMEM;
 331                                 break;
 332                         }
 333                         stat = (struct ng_cisco_stats *)resp->data;
 334                         stat->seqRetries = sc->seqRetries;
 335                         stat->keepAlivePeriod = KEEPALIVE_SECS;
 336                         break;
 337                     }
 338                 default:
 339                         error = EINVAL;
 340                         break;
 341                 }
 342                 break;
 343         default:
 344                 error = EINVAL;
 345                 break;
 346         }
 347         if (rptr)
 348                 *rptr = resp;
 349         else if (resp)
 350                 FREE(resp, M_NETGRAPH);
 351         FREE(msg, M_NETGRAPH);
 352         return (error);
 353 }
 354
 355 /*
 356  * Receive data
 357  */
 358 static int
 359 cisco_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
 360 {
 361         const sc_p sc = hook->node->private;
 362         struct protoent *pep;
 363         struct cisco_header *h;
 364         int error = 0;
 365
 366         if ((pep = hook->private) == NULL)
 367                 goto out;
 368
 369         /* If it came from our downlink, deal with it separately */
 370         if (pep->af == 0xffff)
 371                 return (cisco_input(sc, m, meta));
 372
 373         /* OK so it came from a protocol, heading out. Prepend general data
 374            packet header. For now, IP,IPX only  */
 375         M_PREPEND(m, CISCO_HEADER_LEN, MB_DONTWAIT);
 376         if (!m) {
 377                 error = ENOBUFS;
 378                 goto out;
 379         }
 380         h = mtod(m, struct cisco_header *);
 381         h->address = CISCO_UNICAST;
 382         h->control = 0;
 383
 384         switch (pep->af) {
 385         case AF_INET:           /* Internet Protocol */
 386                 h->protocol = htons(ETHERTYPE_IP);
 387                 break;
 388         case AF_INET6:
 389                 h->protocol = htons(ETHERTYPE_IPV6);
 390                 break;
 391         case AF_APPLETALK:      /* AppleTalk Protocol */
 392                 h->protocol = htons(ETHERTYPE_AT);
 393                 break;
 394         case AF_IPX:            /* Novell IPX Protocol */
 395                 h->protocol = htons(ETHERTYPE_IPX);
 396                 break;
 397         default:
 398                 error = EAFNOSUPPORT;
 399                 goto out;
 400         }
 401
 402         /* Send it */
 403         NG_SEND_DATA(error, sc->downstream.hook, m, meta);
 404         return (error);
 405
 406 out:
 407         NG_FREE_DATA(m, meta);
 408         return (error);
 409 }
 410
 411 /*
 412  * Shutdown node
 413  */
 414 static int
 415 cisco_rmnode(node_p node)
 416 {
 417         const sc_p sc = node->private;
 418
 419         node->flags |= NG_INVALID;
 420         ng_cutlinks(node);
 421         ng_unname(node);
 422         node->private = NULL;
 423         ng_unref(sc->node);
 424         FREE(sc, M_NETGRAPH);
 425         return (0);
 426 }
 427
 428 /*
 429  * Disconnection of a hook
 430  *
 431  * For this type, removal of the last link destroys the node
 432  */
 433 static int
 434 cisco_disconnect(hook_p hook)
 435 {
 436         const sc_p sc = hook->node->private;
 437         struct protoent *pep;
 438
 439         /* Check it's not the debug hook */
 440         if ((pep = hook->private)) {
 441                 pep->hook = NULL;
 442                 if (pep->af == 0xffff) {
 443                         /* If it is the downstream hook, stop the timers */
 444                         callout_stop(&sc->timeout);
 445                 }
 446         }
 447
 448         /* If no more hooks, remove the node */
 449         if (hook->node->numhooks == 0)
 450                 ng_rmnode(hook->node);
 451         return (0);
 452 }
 453
 454 /*
 455  * Receive data
 456  */
 457 static int
 458 cisco_input(sc_p sc, struct mbuf *m, meta_p meta)
 459 {
 460         const struct cisco_header *h;
 461         struct cisco_header hdrbuf;
 462         struct protoent *pep;
 463         int error = 0;
 464
 465         /* Sanity check header length */
 466         if (m->m_pkthdr.len < sizeof(*h)) {
 467                 error = EINVAL;
 468                 goto drop;
 469         }
 470
 471         /* Get cisco header */
 472         if (m->m_len >= sizeof(*h))                     /* the common case */
 473                 h = mtod(m, const struct cisco_header *);
 474         else {
 475                 m_copydata(m, 0, sizeof(*h), (caddr_t)&hdrbuf);
 476                 h = &hdrbuf;
 477         }
 478         m_adj(m, sizeof(*h));
 479
 480         /* Check header address */
 481         switch (h->address) {
 482         default:                /* Invalid Cisco packet. */
 483                 goto drop;
 484         case CISCO_UNICAST:
 485         case CISCO_MULTICAST:
 486                 /* Don't check the control field here (RFC 1547). */
 487                 switch (ntohs(h->protocol)) {
 488                 default:
 489                         goto drop;
 490                 case CISCO_KEEPALIVE:
 491                     {
 492                         const struct cisco_packet *p;
 493                         struct cisco_packet pktbuf;
 494
 495                         /* Sanity check packet length */
 496                         if (m->m_pkthdr.len < sizeof(*p)) {
 497                                 error = EINVAL;
 498                                 goto drop;
 499                         }
 500
 501                         /* Get cisco packet */
 502                         if (m->m_len >= sizeof(*p))     /* the common case */
 503                                 p = mtod(m, const struct cisco_packet *);
 504                         else {
 505                                 m_copydata(m, 0, sizeof(*p), (caddr_t)&pktbuf);
 506                                 p = &pktbuf;
 507                         }
 508
 509                         /* Check packet type */
 510                         switch (ntohl(p->type)) {
 511                         default:
 512                                 log(LOG_WARNING,
 513                                     "cisco: unknown cisco packet type: 0x%"PRIx32"\n",
 514                                        ntohl(p->type));
 515                                 break;
 516                         case CISCO_ADDR_REPLY:
 517                                 /* Reply on address request, ignore */
 518                                 break;
 519                         case CISCO_KEEPALIVE_REQ:
 520                                 sc->remote_seq = ntohl(p->par1);
 521                                 if (sc->local_seq == ntohl(p->par2)) {
 522                                         sc->local_seq++;
 523                                         sc->seqRetries = 0;
 524                                 }
 525                                 break;
 526                         case CISCO_ADDR_REQ:
 527                             {
 528                                 struct ng_mesg *msg, *resp;
 529
 530                                 /* Ask inet peer for IP address information */
 531                                 if (sc->inet.hook == NULL)
 532                                         goto nomsg;
 533                                 NG_MKMESSAGE(msg, NGM_CISCO_COOKIE,
 534                                     NGM_CISCO_GET_IPADDR, 0, M_NOWAIT);
 535                                 if (msg == NULL)
 536                                         goto nomsg;
 537                                 ng_send_msg(sc->node, msg,
 538                                     NG_CISCO_HOOK_INET, &resp);
 539                                 if (resp != NULL)
 540                                         cisco_rcvmsg(sc->node, resp, ".", NULL);
 541
 542                 nomsg:
 543                                 /* Send reply to peer device */
 544                                 error = cisco_send(sc, CISCO_ADDR_REPLY,
 545                                             ntohl(sc->localip.s_addr),
 546                                             ntohl(sc->localmask.s_addr));
 547                                 break;
 548                             }
 549                         }
 550                         goto drop;
 551                     }
 552                 case ETHERTYPE_IP:
 553                         pep = &sc->inet;
 554                         break;
 555                 case ETHERTYPE_IPV6:
 556                         pep = &sc->inet6;
 557                         break;
 558                 case ETHERTYPE_AT:
 559                         pep = &sc->atalk;
 560                         break;
 561                 case ETHERTYPE_IPX:
 562                         pep = &sc->ipx;
 563                         break;
 564                 }
 565                 break;
 566         }
 567
 568         /* Drop if payload is empty */
 569         if (m->m_pkthdr.len == 0) {
 570                 error = EINVAL;
 571                 goto drop;
 572         }
 573
 574         /* Send it on */
 575         if (pep->hook == NULL)
 576                 goto drop;
 577         NG_SEND_DATA(error, pep->hook, m, meta);
 578         return (error);
 579
 580 drop:
 581         NG_FREE_DATA(m, meta);
 582         return (error);
 583 }
 584
 585
 586 /*
 587  * Send keepalive packets, every 10 seconds.
 588  */
 589 static void
 590 cisco_keepalive(void *arg)
 591 {
 592         const sc_p sc = arg;
 593
 594         crit_enter();
 595         cisco_send(sc, CISCO_KEEPALIVE_REQ, sc->local_seq, sc->remote_seq);
 596         sc->seqRetries++;
 597         crit_exit();
 598         callout_reset(&sc->timeout, hz * KEEPALIVE_SECS,
 599                         cisco_keepalive, sc);
 600 }
 601
 602 /*
 603  * Send Cisco keepalive packet.
 604  */
 605 static int
 606 cisco_send(sc_p sc, int type, long par1, long par2)
 607 {
 608         struct cisco_header *h;
 609         struct cisco_packet *ch;
 610         struct mbuf *m;
 611         u_long  t;
 612         int     error = 0;
 613         meta_p  meta = NULL;
 614         struct timeval time;
 615
 616         getmicrotime(&time);
 617
 618         MGETHDR(m, MB_DONTWAIT, MT_DATA);
 619         if (!m)
 620                 return (ENOBUFS);
 621
 622         t = (time.tv_sec - boottime.tv_sec) * 1000;
 623         m->m_pkthdr.len = m->m_len = CISCO_HEADER_LEN + CISCO_PACKET_LEN;
 624         m->m_pkthdr.rcvif = 0;
 625
 626         h = mtod(m, struct cisco_header *);
 627         h->address = CISCO_MULTICAST;
 628         h->control = 0;
 629         h->protocol = htons(CISCO_KEEPALIVE);
 630
 631         ch = (struct cisco_packet *) (h + 1);
 632         ch->type = htonl(type);
 633         ch->par1 = htonl(par1);
 634         ch->par2 = htonl(par2);
 635         ch->rel = -1;
 636         ch->time0 = htons((u_short) (t >> 16));
 637         ch->time1 = htons((u_short) t);
 638
 639         NG_SEND_DATA(error, sc->downstream.hook, m, meta);
 640         return (error);
 641 }