pppd/multilink.c

   1 /*
   2  * multilink.c - support routines for multilink.
   3  *
   4  * Copyright (c) 2000-2002 Paul Mackerras. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. The name(s) of the authors of this software must not be used to
  14  *    endorse or promote products derived from this software without
  15  *    prior written permission.
  16  *
  17  * 3. Redistributions of any form whatsoever must retain the following
  18  *    acknowledgment:
  19  *    "This product includes software developed by Paul Mackerras
  20  *     <paulus@samba.org>".
  21  *
  22  * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
  23  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  24  * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  25  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  26  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  27  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  28  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  29  */
  30 #include <string.h>
  31 #include <ctype.h>
  32 #include <stdlib.h>
  33 #include <netdb.h>
  34 #include <errno.h>
  35 #include <signal.h>
  36 #include <netinet/in.h>
  37 #include <unistd.h>
  38
  39 #include "pppd.h"
  40 #include "fsm.h"
  41 #include "lcp.h"
  42 #include "tdb.h"
  43
  44 bool endpoint_specified;        /* user gave explicit endpoint discriminator */
  45 char *bundle_id;                /* identifier for our bundle */
  46 char *blinks_id;                /* key for the list of links */
  47 bool doing_multilink;           /* multilink was enabled and agreed to */
  48 bool multilink_master;          /* we own the multilink bundle */
  49
  50 extern TDB_CONTEXT *pppdb;
  51 extern char db_key[];
  52
  53 static void make_bundle_links(int append);
  54 static void remove_bundle_link(void);
  55 static void iterate_bundle_links(void (*func)(char *));
  56
  57 static int get_default_epdisc(struct epdisc *);
  58 static int parse_num(char *str, const char *key, int *valp);
  59 static int owns_unit(TDB_DATA pid, int unit);
  60
  61 #define set_ip_epdisc(ep, addr) do {    \
  62         ep->length = 4;                 \
  63         ep->value[0] = addr >> 24;      \
  64         ep->value[1] = addr >> 16;      \
  65         ep->value[2] = addr >> 8;       \
  66         ep->value[3] = addr;            \
  67 } while (0)
  68
  69 #define LOCAL_IP_ADDR(addr)                                               \
  70         (((addr) & 0xff000000) == 0x0a000000            /* 10.x.x.x */    \
  71          || ((addr) & 0xfff00000) == 0xac100000         /* 172.16.x.x */  \
  72          || ((addr) & 0xffff0000) == 0xc0a80000)        /* 192.168.x.x */
  73
  74 #define process_exists(n)       (kill((n), 0) == 0 || errno != ESRCH)
  75
  76 void
  77 mp_check_options(void)
  78 {
  79         lcp_options *wo = &lcp_wantoptions[0];
  80         lcp_options *ao = &lcp_allowoptions[0];
  81
  82         doing_multilink = 0;
  83         if (!multilink)
  84                 return;
  85         /* if we're doing multilink, we have to negotiate MRRU */
  86         if (!wo->neg_mrru) {
  87                 /* mrru not specified, default to mru */
  88                 wo->mrru = wo->mru;
  89                 wo->neg_mrru = 1;
  90         }
  91         ao->mrru = ao->mru;
  92         ao->neg_mrru = 1;
  93
  94         if (!wo->neg_endpoint && !noendpoint) {
  95                 /* get a default endpoint value */
  96                 wo->neg_endpoint = get_default_epdisc(&wo->endpoint);
  97         }
  98 }
  99
 100 /*
 101  * Make a new bundle or join us to an existing bundle
 102  * if we are doing multilink.
 103  */
 104 int
 105 mp_join_bundle(void)
 106 {
 107         lcp_options *go = &lcp_gotoptions[0];
 108         lcp_options *ho = &lcp_hisoptions[0];
 109         lcp_options *ao = &lcp_allowoptions[0];
 110         int unit, pppd_pid;
 111         int l, mtu;
 112         char *p;
 113         TDB_DATA key, pid, rec;
 114
 115         if (doing_multilink) {
 116                 /* have previously joined a bundle */
 117                 if (!go->neg_mrru || !ho->neg_mrru) {
 118                         notice("oops, didn't get multilink on renegotiation");
 119                         lcp_close(0, "multilink required");
 120                         return 0;
 121                 }
 122                 /* XXX should check the peer_authname and ho->endpoint
 123                    are the same as previously */
 124                 return 0;
 125         }
 126
 127         if (!go->neg_mrru || !ho->neg_mrru) {
 128                 /* not doing multilink */
 129                 if (go->neg_mrru)
 130                         notice("oops, multilink negotiated only for receive");
 131                 mtu = ho->neg_mru? ho->mru: PPP_MRU;
 132                 if (mtu > ao->mru)
 133                         mtu = ao->mru;
 134                 if (demand) {
 135                         /* already have a bundle */
 136                         cfg_bundle(0, 0, 0, 0);
 137                         netif_set_mtu(0, mtu);
 138                         return 0;
 139                 }
 140                 make_new_bundle(0, 0, 0, 0);
 141                 set_ifunit(1);
 142                 netif_set_mtu(0, mtu);
 143                 return 0;
 144         }
 145
 146         doing_multilink = 1;
 147
 148         /*
 149          * Find the appropriate bundle or join a new one.
 150          * First we make up a name for the bundle.
 151          * The length estimate is worst-case assuming every
 152          * character has to be quoted.
 153          */
 154         l = 4 * strlen(peer_authname) + 10;
 155         if (ho->neg_endpoint)
 156                 l += 3 * ho->endpoint.length + 8;
 157         if (bundle_name)
 158                 l += 3 * strlen(bundle_name) + 2;
 159         bundle_id = malloc(l);
 160         if (bundle_id == 0)
 161                 novm("bundle identifier");
 162
 163         p = bundle_id;
 164         p += slprintf(p, l-1, "BUNDLE=\"%q\"", peer_authname);
 165         if (ho->neg_endpoint || bundle_name)
 166                 *p++ = '/';
 167         if (ho->neg_endpoint)
 168                 p += slprintf(p, bundle_id+l-p, "%s",
 169                               epdisc_to_str(&ho->endpoint));
 170         if (bundle_name)
 171                 p += slprintf(p, bundle_id+l-p, "/%v", bundle_name);
 172
 173         /* Make the key for the list of links belonging to the bundle */
 174         l = p - bundle_id;
 175         blinks_id = malloc(l + 7);
 176         if (blinks_id == NULL)
 177                 novm("bundle links key");
 178         slprintf(blinks_id, l + 7, "BUNDLE_LINKS=%s", bundle_id + 7);
 179
 180         /*
 181          * For demand mode, we only need to configure the bundle
 182          * and attach the link.
 183          */
 184         mtu = MIN(ho->mrru, ao->mru);
 185         if (demand) {
 186                 cfg_bundle(go->mrru, ho->mrru, go->neg_ssnhf, ho->neg_ssnhf);
 187                 netif_set_mtu(0, mtu);
 188                 script_setenv("BUNDLE", bundle_id + 7, 1);
 189                 return 0;
 190         }
 191
 192         /*
 193          * Check if the bundle ID is already in the database.
 194          */
 195         unit = -1;
 196         lock_db();
 197         key.dptr = bundle_id;
 198         key.dsize = p - bundle_id;
 199         pid = tdb_fetch(pppdb, key);
 200         if (pid.dptr != NULL) {
 201                 /* bundle ID exists, see if the pppd record exists */
 202                 rec = tdb_fetch(pppdb, pid);
 203                 if (rec.dptr != NULL && rec.dsize > 0) {
 204                         /* make sure the string is null-terminated */
 205                         rec.dptr[rec.dsize-1] = 0;
 206                         /* parse the interface number */
 207                         parse_num(rec.dptr, "UNIT=", &unit);
 208                         /* check the pid value */
 209                         if (!parse_num(rec.dptr, "PPPD_PID=", &pppd_pid)
 210                             || !process_exists(pppd_pid)
 211                             || !owns_unit(pid, unit))
 212                                 unit = -1;
 213                         free(rec.dptr);
 214                 }
 215                 free(pid.dptr);
 216         }
 217
 218         if (unit >= 0) {
 219                 /* attach to existing unit */
 220                 if (bundle_attach(unit)) {
 221                         set_ifunit(0);
 222                         script_setenv("BUNDLE", bundle_id + 7, 0);
 223                         make_bundle_links(1);
 224                         unlock_db();
 225                         info("Link attached to %s", ifname);
 226                         return 1;
 227                 }
 228                 /* attach failed because bundle doesn't exist */
 229         }
 230
 231         /* we have to make a new bundle */
 232         make_new_bundle(go->mrru, ho->mrru, go->neg_ssnhf, ho->neg_ssnhf);
 233         set_ifunit(1);
 234         netif_set_mtu(0, mtu);
 235         script_setenv("BUNDLE", bundle_id + 7, 1);
 236         make_bundle_links(0);
 237         unlock_db();
 238         info("New bundle %s created", ifname);
 239         multilink_master = 1;
 240         return 0;
 241 }
 242
 243 void mp_exit_bundle(void)
 244 {
 245         lock_db();
 246         remove_bundle_link();
 247         unlock_db();
 248 }
 249
 250 static void sendhup(char *str)
 251 {
 252         int pid;
 253
 254         if (parse_num(str, "PPPD_PID=", &pid) && pid != getpid()) {
 255                 if (debug)
 256                         dbglog("sending SIGHUP to process %d", pid);
 257                 kill(pid, SIGHUP);
 258         }
 259 }
 260
 261 void mp_bundle_terminated(void)
 262 {
 263         TDB_DATA key;
 264
 265         bundle_terminating = 1;
 266         upper_layers_down(0);
 267         notice("Connection terminated.");
 268         print_link_stats();
 269         if (!demand) {
 270                 remove_pidfiles();
 271                 script_unsetenv("IFNAME");
 272         }
 273
 274         lock_db();
 275         destroy_bundle();
 276         iterate_bundle_links(sendhup);
 277         key.dptr = blinks_id;
 278         key.dsize = strlen(blinks_id);
 279         tdb_delete(pppdb, key);
 280         unlock_db();
 281
 282         new_phase(PHASE_DEAD);
 283
 284         doing_multilink = 0;
 285         multilink_master = 0;
 286 }
 287
 288 static void make_bundle_links(int append)
 289 {
 290         TDB_DATA key, rec;
 291         char *p;
 292         char entry[32];
 293         int l;
 294
 295         key.dptr = blinks_id;
 296         key.dsize = strlen(blinks_id);
 297         slprintf(entry, sizeof(entry), "%s;", db_key);
 298         p = entry;
 299         if (append) {
 300                 rec = tdb_fetch(pppdb, key);
 301                 if (rec.dptr != NULL && rec.dsize > 0) {
 302                         rec.dptr[rec.dsize-1] = 0;
 303                         if (strstr(rec.dptr, db_key) != NULL) {
 304                                 /* already in there? strange */
 305                                 warn("link entry already exists in tdb");
 306                                 return;
 307                         }
 308                         l = rec.dsize + strlen(entry);
 309                         p = malloc(l);
 310                         if (p == NULL)
 311                                 novm("bundle link list");
 312                         slprintf(p, l, "%s%s", rec.dptr, entry);
 313                 } else {
 314                         warn("bundle link list not found");
 315                 }
 316                 if (rec.dptr != NULL)
 317                         free(rec.dptr);
 318         }
 319         rec.dptr = p;
 320         rec.dsize = strlen(p) + 1;
 321         if (tdb_store(pppdb, key, rec, TDB_REPLACE))
 322                 error("couldn't %s bundle link list",
 323                       append? "update": "create");
 324         if (p != entry)
 325                 free(p);
 326 }
 327
 328 static void remove_bundle_link(void)
 329 {
 330         TDB_DATA key, rec;
 331         char entry[32];
 332         char *p, *q;
 333         int l;
 334
 335         key.dptr = blinks_id;
 336         key.dsize = strlen(blinks_id);
 337         slprintf(entry, sizeof(entry), "%s;", db_key);
 338
 339         rec = tdb_fetch(pppdb, key);
 340         if (rec.dptr == NULL || rec.dsize <= 0) {
 341                 if (rec.dptr != NULL)
 342                         free(rec.dptr);
 343                 return;
 344         }
 345         rec.dptr[rec.dsize-1] = 0;
 346         p = strstr(rec.dptr, entry);
 347         if (p != NULL) {
 348                 q = p + strlen(entry);
 349                 l = strlen(q) + 1;
 350                 memmove(p, q, l);
 351                 rec.dsize = p - rec.dptr + l;
 352                 if (tdb_store(pppdb, key, rec, TDB_REPLACE))
 353                         error("couldn't update bundle link list (removal)");
 354         }
 355         free(rec.dptr);
 356 }
 357
 358 static void iterate_bundle_links(void (*func)(char *))
 359 {
 360         TDB_DATA key, rec, pp;
 361         char *p, *q;
 362
 363         key.dptr = blinks_id;
 364         key.dsize = strlen(blinks_id);
 365         rec = tdb_fetch(pppdb, key);
 366         if (rec.dptr == NULL || rec.dsize <= 0) {
 367                 error("bundle link list not found (iterating list)");
 368                 if (rec.dptr != NULL)
 369                         free(rec.dptr);
 370                 return;
 371         }
 372         p = rec.dptr;
 373         p[rec.dsize-1] = 0;
 374         while ((q = strchr(p, ';')) != NULL) {
 375                 *q = 0;
 376                 key.dptr = p;
 377                 key.dsize = q - p;
 378                 pp = tdb_fetch(pppdb, key);
 379                 if (pp.dptr != NULL && pp.dsize > 0) {
 380                         pp.dptr[pp.dsize-1] = 0;
 381                         func(pp.dptr);
 382                 }
 383                 if (pp.dptr != NULL)
 384                         free(pp.dptr);
 385                 p = q + 1;
 386         }
 387         free(rec.dptr);
 388 }
 389
 390 static int
 391 parse_num(char *str, const char *key, int *valp)
 392 {
 393         char *p, *endp;
 394         int i;
 395
 396         p = strstr(str, key);
 397         if (p != 0) {
 398                 p += strlen(key);
 399                 i = strtol(p, &endp, 10);
 400                 if (endp != p && (*endp == 0 || *endp == ';')) {
 401                         *valp = i;
 402                         return 1;
 403                 }
 404         }
 405         return 0;
 406 }
 407
 408 /*
 409  * Check whether the pppd identified by `key' still owns ppp unit `unit'.
 410  */
 411 static int
 412 owns_unit(TDB_DATA key, int unit)
 413 {
 414         char ifkey[32];
 415         TDB_DATA kd, vd;
 416         int ret = 0;
 417
 418         slprintf(ifkey, sizeof(ifkey), "UNIT=%d", unit);
 419         kd.dptr = ifkey;
 420         kd.dsize = strlen(ifkey);
 421         vd = tdb_fetch(pppdb, kd);
 422         if (vd.dptr != NULL) {
 423                 ret = vd.dsize == key.dsize
 424                         && memcmp(vd.dptr, key.dptr, vd.dsize) == 0;
 425                 free(vd.dptr);
 426         }
 427         return ret;
 428 }
 429
 430 static int
 431 get_default_epdisc(struct epdisc *ep)
 432 {
 433         struct hostent *hp;
 434         u_int32_t addr;
 435
 436         /* First try for an ethernet MAC address */
 437         if (get_first_ether_hwaddr(ep->value) >= 0) {
 438                 ep->class = EPD_MAC;
 439                 ep->length = 6;
 440                 return 1;
 441         }
 442
 443         /* see if our hostname corresponds to a reasonable IP address */
 444         hp = gethostbyname(hostname);
 445         if (hp != NULL) {
 446                 addr = *(u_int32_t *)hp->h_addr;
 447                 if (!bad_ip_adrs(addr)) {
 448                         addr = ntohl(addr);
 449                         if (!LOCAL_IP_ADDR(addr)) {
 450                                 ep->class = EPD_IP;
 451                                 set_ip_epdisc(ep, addr);
 452                                 return 1;
 453                         }
 454                 }
 455         }
 456
 457         return 0;
 458 }
 459
 460 /*
 461  * epdisc_to_str - make a printable string from an endpoint discriminator.
 462  */
 463
 464 static char *endp_class_names[] = {
 465     "null", "local", "IP", "MAC", "magic", "phone"
 466 };
 467
 468 char *
 469 epdisc_to_str(struct epdisc *ep)
 470 {
 471         static char str[MAX_ENDP_LEN*3+8];
 472         u_char *p = ep->value;
 473         int i, mask = 0;
 474         char *q, c, c2;
 475
 476         if (ep->class == EPD_NULL && ep->length == 0)
 477                 return "null";
 478         if (ep->class == EPD_IP && ep->length == 4) {
 479                 u_int32_t addr;
 480
 481                 GETLONG(addr, p);
 482                 slprintf(str, sizeof(str), "IP:%I", htonl(addr));
 483                 return str;
 484         }
 485
 486         c = ':';
 487         c2 = '.';
 488         if (ep->class == EPD_MAC && ep->length == 6)
 489                 c2 = ':';
 490         else if (ep->class == EPD_MAGIC && (ep->length % 4) == 0)
 491                 mask = 3;
 492         q = str;
 493         if (ep->class <= EPD_PHONENUM)
 494                 q += slprintf(q, sizeof(str)-1, "%s",
 495                               endp_class_names[ep->class]);
 496         else
 497                 q += slprintf(q, sizeof(str)-1, "%d", ep->class);
 498         c = ':';
 499         for (i = 0; i < ep->length && i < MAX_ENDP_LEN; ++i) {
 500                 if ((i & mask) == 0) {
 501                         *q++ = c;
 502                         c = c2;
 503                 }
 504                 q += slprintf(q, str + sizeof(str) - q, "%.2x", ep->value[i]);
 505         }
 506         return str;
 507 }
 508
 509 static int hexc_val(int c)
 510 {
 511         if (c >= 'a')
 512                 return c - 'a' + 10;
 513         if (c >= 'A')
 514                 return c - 'A' + 10;
 515         return c - '0';
 516 }
 517
 518 int
 519 str_to_epdisc(struct epdisc *ep, char *str)
 520 {
 521         int i, l;
 522         char *p, *endp;
 523
 524         for (i = EPD_NULL; i <= EPD_PHONENUM; ++i) {
 525                 int sl = strlen(endp_class_names[i]);
 526                 if (strncasecmp(str, endp_class_names[i], sl) == 0) {
 527                         str += sl;
 528                         break;
 529                 }
 530         }
 531         if (i > EPD_PHONENUM) {
 532                 /* not a class name, try a decimal class number */
 533                 i = strtol(str, &endp, 10);
 534                 if (endp == str)
 535                         return 0;       /* can't parse class number */
 536                 str = endp;
 537         }
 538         ep->class = i;
 539         if (*str == 0) {
 540                 ep->length = 0;
 541                 return 1;
 542         }
 543         if (*str != ':' && *str != '.')
 544                 return 0;
 545         ++str;
 546
 547         if (i == EPD_IP) {
 548                 u_int32_t addr;
 549                 i = parse_dotted_ip(str, &addr);
 550                 if (i == 0 || str[i] != 0)
 551                         return 0;
 552                 set_ip_epdisc(ep, addr);
 553                 return 1;
 554         }
 555         if (i == EPD_MAC && get_if_hwaddr(ep->value, str) >= 0) {
 556                 ep->length = 6;
 557                 return 1;
 558         }
 559
 560         p = str;
 561         for (l = 0; l < MAX_ENDP_LEN; ++l) {
 562                 if (*str == 0)
 563                         break;
 564                 if (p <= str)
 565                         for (p = str; isxdigit(*p); ++p)
 566                                 ;
 567                 i = p - str;
 568                 if (i == 0)
 569                         return 0;
 570                 ep->value[l] = hexc_val(*str++);
 571                 if ((i & 1) == 0)
 572                         ep->value[l] = (ep->value[l] << 4) + hexc_val(*str++);
 573                 if (*str == ':' || *str == '.')
 574                         ++str;
 575         }
 576         if (*str != 0 || (ep->class == EPD_MAC && l != 6))
 577                 return 0;
 578         ep->length = l;
 579         return 1;
 580 }