pppd/cbcp.c

   1 /*
   2  * cbcp - Call Back Configuration Protocol.
   3  *
   4  * Copyright (c) 1995 Pedro Roque Marques.  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. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  *
  18  * 3. The names of the authors of this software must not be used to
  19  *    endorse or promote products derived from this software without
  20  *    prior written permission.
  21  *
  22  * 4. Redistributions of any form whatsoever must retain the following
  23  *    acknowledgment:
  24  *    "This product includes software developed by Pedro Roque Marques
  25  *     <pedro_m@yahoo.com>"
  26  *
  27  * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
  28  * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  29  * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
  30  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  31  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  32  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  33  * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  34  */
  35
  36 #define RCSID   "$Id: cbcp.c,v 1.15 2003/01/17 07:23:35 fcusack Exp $"
  37
  38 #include <stdio.h>
  39 #include <string.h>
  40 #include <sys/types.h>
  41 #include <sys/time.h>
  42
  43 #include "pppd.h"
  44 #include "cbcp.h"
  45 #include "fsm.h"
  46 #include "lcp.h"
  47
  48 static const char rcsid[] = RCSID;
  49
  50 /*
  51  * Options.
  52  */
  53 static int setcbcp __P((char **));
  54
  55 static option_t cbcp_option_list[] = {
  56     { "callback", o_special, (void *)setcbcp,
  57       "Ask for callback", OPT_PRIO | OPT_A2STRVAL, &cbcp[0].us_number },
  58     { NULL }
  59 };
  60
  61 /*
  62  * Protocol entry points.
  63  */
  64 static void cbcp_init      __P((int unit));
  65 static void cbcp_open      __P((int unit));
  66 static void cbcp_lowerup   __P((int unit));
  67 static void cbcp_input     __P((int unit, u_char *pkt, int len));
  68 static void cbcp_protrej   __P((int unit));
  69 static int  cbcp_printpkt  __P((u_char *pkt, int len,
  70                                 void (*printer) __P((void *, char *, ...)),
  71                                 void *arg));
  72
  73 struct protent cbcp_protent = {
  74     PPP_CBCP,
  75     cbcp_init,
  76     cbcp_input,
  77     cbcp_protrej,
  78     cbcp_lowerup,
  79     NULL,
  80     cbcp_open,
  81     NULL,
  82     cbcp_printpkt,
  83     NULL,
  84     0,
  85     "CBCP",
  86     NULL,
  87     cbcp_option_list,
  88     NULL,
  89     NULL,
  90     NULL
  91 };
  92
  93 cbcp_state cbcp[NUM_PPP];
  94
  95 /* internal prototypes */
  96
  97 static void cbcp_recvreq __P((cbcp_state *us, u_char *pckt, int len));
  98 static void cbcp_resp __P((cbcp_state *us));
  99 static void cbcp_up __P((cbcp_state *us));
 100 static void cbcp_recvack __P((cbcp_state *us, u_char *pckt, int len));
 101 static void cbcp_send __P((cbcp_state *us, int code, u_char *buf, int len));
 102
 103 /* option processing */
 104 static int
 105 setcbcp(argv)
 106     char **argv;
 107 {
 108     lcp_wantoptions[0].neg_cbcp = 1;
 109     cbcp_protent.enabled_flag = 1;
 110     cbcp[0].us_number = strdup(*argv);
 111     if (cbcp[0].us_number == 0)
 112         novm("callback number");
 113     cbcp[0].us_type |= (1 << CB_CONF_USER);
 114     cbcp[0].us_type |= (1 << CB_CONF_ADMIN);
 115     return (1);
 116 }
 117
 118 /* init state */
 119 static void
 120 cbcp_init(iface)
 121     int iface;
 122 {
 123     cbcp_state *us;
 124
 125     us = &cbcp[iface];
 126     memset(us, 0, sizeof(cbcp_state));
 127     us->us_unit = iface;
 128     us->us_type |= (1 << CB_CONF_NO);
 129 }
 130
 131 /* lower layer is up */
 132 static void
 133 cbcp_lowerup(iface)
 134     int iface;
 135 {
 136     cbcp_state *us = &cbcp[iface];
 137
 138     dbglog("cbcp_lowerup");
 139     dbglog("want: %d", us->us_type);
 140
 141     if (us->us_type == CB_CONF_USER)
 142         dbglog("phone no: %s", us->us_number);
 143 }
 144
 145 static void
 146 cbcp_open(unit)
 147     int unit;
 148 {
 149     dbglog("cbcp_open");
 150 }
 151
 152 /* process an incomming packet */
 153 static void
 154 cbcp_input(unit, inpacket, pktlen)
 155     int unit;
 156     u_char *inpacket;
 157     int pktlen;
 158 {
 159     u_char *inp;
 160     u_char code, id;
 161     u_short len;
 162
 163     cbcp_state *us = &cbcp[unit];
 164
 165     inp = inpacket;
 166
 167     if (pktlen < CBCP_MINLEN) {
 168         error("CBCP packet is too small");
 169         return;
 170     }
 171
 172     GETCHAR(code, inp);
 173     GETCHAR(id, inp);
 174     GETSHORT(len, inp);
 175
 176 #if 0
 177     if (len > pktlen) {
 178         error("CBCP packet: invalid length");
 179         return;
 180     }
 181 #endif
 182
 183     len -= CBCP_MINLEN;
 184
 185     switch(code) {
 186     case CBCP_REQ:
 187         us->us_id = id;
 188         cbcp_recvreq(us, inp, len);
 189         break;
 190
 191     case CBCP_RESP:
 192         dbglog("CBCP_RESP received");
 193         break;
 194
 195     case CBCP_ACK:
 196         if (id != us->us_id)
 197             dbglog("id doesn't match: expected %d recv %d",
 198                    us->us_id, id);
 199
 200         cbcp_recvack(us, inp, len);
 201         break;
 202
 203     default:
 204         break;
 205     }
 206 }
 207
 208 /* protocol was rejected by foe */
 209 void cbcp_protrej(int iface)
 210 {
 211 }
 212
 213 char *cbcp_codenames[] = {
 214     "Request", "Response", "Ack"
 215 };
 216
 217 char *cbcp_optionnames[] = {
 218     "NoCallback",
 219     "UserDefined",
 220     "AdminDefined",
 221     "List"
 222 };
 223
 224 /* pretty print a packet */
 225 static int
 226 cbcp_printpkt(p, plen, printer, arg)
 227     u_char *p;
 228     int plen;
 229     void (*printer) __P((void *, char *, ...));
 230     void *arg;
 231 {
 232     int code, opt, id, len, olen, delay;
 233     u_char *pstart;
 234
 235     if (plen < HEADERLEN)
 236         return 0;
 237     pstart = p;
 238     GETCHAR(code, p);
 239     GETCHAR(id, p);
 240     GETSHORT(len, p);
 241     if (len < HEADERLEN || len > plen)
 242         return 0;
 243
 244     if (code >= 1 && code <= sizeof(cbcp_codenames) / sizeof(char *))
 245         printer(arg, " %s", cbcp_codenames[code-1]);
 246     else
 247         printer(arg, " code=0x%x", code);
 248
 249     printer(arg, " id=0x%x", id);
 250     len -= HEADERLEN;
 251
 252     switch (code) {
 253     case CBCP_REQ:
 254     case CBCP_RESP:
 255     case CBCP_ACK:
 256         while(len >= 2) {
 257             GETCHAR(opt, p);
 258             GETCHAR(olen, p);
 259
 260             if (olen < 2 || olen > len) {
 261                 break;
 262             }
 263
 264             printer(arg, " <");
 265             len -= olen;
 266
 267             if (opt >= 1 && opt <= sizeof(cbcp_optionnames) / sizeof(char *))
 268                 printer(arg, " %s", cbcp_optionnames[opt-1]);
 269             else
 270                 printer(arg, " option=0x%x", opt);
 271
 272             if (olen > 2) {
 273                 GETCHAR(delay, p);
 274                 printer(arg, " delay = %d", delay);
 275             }
 276
 277             if (olen > 3) {
 278                 int addrt;
 279                 char str[256];
 280
 281                 GETCHAR(addrt, p);
 282                 memcpy(str, p, olen - 4);
 283                 str[olen - 4] = 0;
 284                 printer(arg, " number = %s", str);
 285             }
 286             printer(arg, ">");
 287         }
 288         break;
 289
 290     default:
 291         break;
 292     }
 293
 294     for (; len > 0; --len) {
 295         GETCHAR(code, p);
 296         printer(arg, " %.2x", code);
 297     }
 298
 299     return p - pstart;
 300 }
 301
 302 /* received CBCP request */
 303 static void
 304 cbcp_recvreq(us, pckt, pcktlen)
 305     cbcp_state *us;
 306     u_char *pckt;
 307     int pcktlen;
 308 {
 309     u_char type, opt_len, delay, addr_type;
 310     char address[256];
 311     int len = pcktlen;
 312
 313     address[0] = 0;
 314
 315     while (len) {
 316         dbglog("length: %d", len);
 317
 318         GETCHAR(type, pckt);
 319         GETCHAR(opt_len, pckt);
 320
 321         if (opt_len > 2)
 322             GETCHAR(delay, pckt);
 323
 324         us->us_allowed |= (1 << type);
 325
 326         switch(type) {
 327         case CB_CONF_NO:
 328             dbglog("no callback allowed");
 329             break;
 330
 331         case CB_CONF_USER:
 332             dbglog("user callback allowed");
 333             if (opt_len > 4) {
 334                 GETCHAR(addr_type, pckt);
 335                 memcpy(address, pckt, opt_len - 4);
 336                 address[opt_len - 4] = 0;
 337                 if (address[0])
 338                     dbglog("address: %s", address);
 339             }
 340             break;
 341
 342         case CB_CONF_ADMIN:
 343             dbglog("user admin defined allowed");
 344             break;
 345
 346         case CB_CONF_LIST:
 347             break;
 348         }
 349         len -= opt_len;
 350     }
 351
 352     cbcp_resp(us);
 353 }
 354
 355 static void
 356 cbcp_resp(us)
 357     cbcp_state *us;
 358 {
 359     u_char cb_type;
 360     u_char buf[256];
 361     u_char *bufp = buf;
 362     int len = 0;
 363
 364     cb_type = us->us_allowed & us->us_type;
 365     dbglog("cbcp_resp cb_type=%d", cb_type);
 366
 367 #if 0
 368     if (!cb_type)
 369         lcp_down(us->us_unit);
 370 #endif
 371
 372     if (cb_type & ( 1 << CB_CONF_USER ) ) {
 373         dbglog("cbcp_resp CONF_USER");
 374         PUTCHAR(CB_CONF_USER, bufp);
 375         len = 3 + 1 + strlen(us->us_number) + 1;
 376         PUTCHAR(len , bufp);
 377         PUTCHAR(5, bufp); /* delay */
 378         PUTCHAR(1, bufp);
 379         BCOPY(us->us_number, bufp, strlen(us->us_number) + 1);
 380         cbcp_send(us, CBCP_RESP, buf, len);
 381         return;
 382     }
 383
 384     if (cb_type & ( 1 << CB_CONF_ADMIN ) ) {
 385         dbglog("cbcp_resp CONF_ADMIN");
 386         PUTCHAR(CB_CONF_ADMIN, bufp);
 387         len = 3;
 388         PUTCHAR(len, bufp);
 389         PUTCHAR(5, bufp); /* delay */
 390         cbcp_send(us, CBCP_RESP, buf, len);
 391         return;
 392     }
 393
 394     if (cb_type & ( 1 << CB_CONF_NO ) ) {
 395         dbglog("cbcp_resp CONF_NO");
 396         PUTCHAR(CB_CONF_NO, bufp);
 397         len = 2;
 398         PUTCHAR(len , bufp);
 399         cbcp_send(us, CBCP_RESP, buf, len);
 400         start_networks(us->us_unit);
 401         return;
 402     }
 403 }
 404
 405 static void
 406 cbcp_send(us, code, buf, len)
 407     cbcp_state *us;
 408     int code;
 409     u_char *buf;
 410     int len;
 411 {
 412     u_char *outp;
 413     int outlen;
 414
 415     outp = outpacket_buf;
 416
 417     outlen = 4 + len;
 418
 419     MAKEHEADER(outp, PPP_CBCP);
 420
 421     PUTCHAR(code, outp);
 422     PUTCHAR(us->us_id, outp);
 423     PUTSHORT(outlen, outp);
 424
 425     if (len)
 426         BCOPY(buf, outp, len);
 427
 428     output(us->us_unit, outpacket_buf, outlen + PPP_HDRLEN);
 429 }
 430
 431 static void
 432 cbcp_recvack(us, pckt, len)
 433     cbcp_state *us;
 434     u_char *pckt;
 435     int len;
 436 {
 437     u_char type, delay, addr_type;
 438     int opt_len;
 439     char address[256];
 440
 441     if (len) {
 442         GETCHAR(type, pckt);
 443         GETCHAR(opt_len, pckt);
 444
 445         if (opt_len > 2)
 446             GETCHAR(delay, pckt);
 447
 448         if (opt_len > 4) {
 449             GETCHAR(addr_type, pckt);
 450             memcpy(address, pckt, opt_len - 4);
 451             address[opt_len - 4] = 0;
 452             if (address[0])
 453                 dbglog("peer will call: %s", address);
 454         }
 455         if (type == CB_CONF_NO)
 456             return;
 457     }
 458
 459     cbcp_up(us);
 460 }
 461
 462 /* ok peer will do callback */
 463 static void
 464 cbcp_up(us)
 465     cbcp_state *us;
 466 {
 467     persist = 0;
 468     lcp_close(0, "Call me back, please");
 469     status = EXIT_CALLBACK;
 470 }