l2tpns.h

   1 // L2TPNS Global Stuff
   2 // $Id: l2tpns.h,v 1.121 2009-12-08 14:49:28 bodea Exp $
   3
   4 #ifndef __L2TPNS_H__
   5 #define __L2TPNS_H__
   6
   7 #include <netinet/in.h>
   8 #include <stdio.h>
   9 #include <signal.h>
  10 #include <stdlib.h>
  11 #include <netinet/in.h>
  12 #include <net/ethernet.h>
  13 #include <sys/socket.h>
  14 #include <arpa/inet.h>
  15 #include <sys/types.h>
  16 #include <libcli.h>
  17
  18 #define VERSION "2.2.1"
  19
  20 // Limits
  21 #define MAXTUNNEL       500             // could be up to 65535
  22 #define MAXBUNDLE       300             // could be up to 65535
  23 #define MAXBUNDLESES    12              // Maximum number of member links in bundle
  24 #define MAXADDRESS      20              // Maximum length for the Endpoint Discrminiator address
  25 #define MAXSESSION      60000           // could be up to 65535
  26 #define MAXTBFS         6000            // Maximum token bucket filters. Might need up to 2 * session.
  27 #define MAXSESSINGRP    12              // Maximum number of member links in grouped session
  28 #define MAXGRPINSESS    12              // Maximum number of member links in session group
  29 #define MAXGROUPE               300     // could be up to 65535, Maximum number of grouped session
  30 #define MAXROUTEINGRP   15              // max static routes per group
  31
  32 // Tunnel Id reserved for pppoe
  33 #define TUNNEL_ID_PPPOE 1
  34
  35 #define RADIUS_SHIFT    6
  36 #define RADIUS_FDS      (1 << RADIUS_SHIFT)
  37 #define RADIUS_MASK     ((1 << RADIUS_SHIFT) - 1)
  38 #define MAXRADIUS       (1 << (8 + RADIUS_SHIFT))
  39
  40 #define T_UNDEF         (0xffff)        // A tunnel ID that won't ever be used. Mark session as undefined.
  41 #define T_FREE          (0)             // A tunnel ID that won't ever be used. Mark session as free.
  42
  43 #define MAXCONTROL      1000            // max length control message we ever send...
  44 #define MINMTU          576             // minimum recommended MTU (rfc1063)
  45 #define MAXMTU          2600            // arbitrary maximum MTU
  46 #define PPPoE_MRU       1492            // maximum PPPoE MRU (rfc2516: 1500 less PPPoE header (6) and PPP protocol ID (2))
  47 #define MAXETHER        (MAXMTU+18)     // max packet we try sending to tun
  48 #define MAXTEL          96              // telephone number
  49 #define MAXHOSTNAME     256             // hostname
  50 #define MAXUSER         128             // username
  51 #define MAXPASS         128             // password
  52 #define MAXCLASS        128             // radius class attribute size
  53 #define MAXPLUGINS      20              // maximum number of plugins to load
  54 #define MAXRADSERVER    10              // max radius servers
  55 #define MAXROUTE        10              // max static routes per session
  56 #define MAXIPPOOL       131072          // max number of ip addresses in pool
  57 #define RINGBUFFER_SIZE 10000           // Number of ringbuffer entries to allocate
  58 #define MAX_LOG_LENGTH  512             // Maximum size of log message
  59 #define ECHO_TIMEOUT    10              // Time between last packet sent and LCP ECHO generation
  60 #define IDLE_ECHO_TIMEOUT       240             // Time between last packet seen and session shutdown
  61 #define BUSY_WAIT_TIME  3000            // 5 minutes in 1/10th seconds to wait for radius to cleanup on shutdown
  62
  63 #define MP_BEGIN        0x80            // This value is used when (b)egin bit is set in MP header
  64 #define MP_END          0x40            // This value is used when (e)nd bit is set in MP header
  65 #define MP_BOTH_BITS    0xC0            // This value is used when both bits (begin and end) are set in MP header
  66
  67 #define MINFRAGLEN      64              // Minumum fragment length
  68 #define MAXFRAGLEN      1496    // Maximum length for Multilink fragment (The multilink may contain only one link)
  69 #define MAXFRAGNUM      512             // Maximum number of Multilink fragment in a bundle (must be in the form of 2^X)
  70                                         // it's not expected to have a space for more than 10 unassembled packets = 10 * MAXBUNDLESES
  71 #define MAXFRAGNUM_MASK (MAXFRAGNUM - 1)                // Must be equal to MAXFRAGNUM-1
  72
  73 // Constants
  74 #ifndef ETCDIR
  75 #define ETCDIR          "/etc/l2tpns"
  76 #endif
  77
  78 #ifndef LIBDIR
  79 #define LIBDIR          "/usr/lib/l2tpns"
  80 #endif
  81
  82 #ifndef PLUGINDIR
  83 #define PLUGINDIR       LIBDIR          // Plugins
  84 #endif
  85
  86 #ifndef PLUGINCONF
  87 #define PLUGINCONF      ETCDIR          // Plugin config dir
  88 #endif
  89
  90 #ifndef FLASHDIR
  91 #define FLASHDIR        ETCDIR
  92 #endif
  93
  94 #define TUNDEVICE       "/dev/net/tun"
  95 #define RANDOMDEVICE    "/dev/urandom"                  // default, not as secure as /dev/random but non-blocking
  96 #define CONFIGFILE      FLASHDIR "/startup-config"      // Configuration file
  97 #define CLIUSERS        FLASHDIR "/users"               // CLI Users file
  98 #define IPPOOLFILE      FLASHDIR "/ip_pool"             // Address pool configuration
  99 #define ACCT_TIME       3000                            // 5 minute accounting interval
 100 #define ACCT_SHUT_TIME  600                             // 1 minute for counters of shutdown sessions
 101 #define L2TPPORT        1701                            // L2TP port
 102 #define RADPORT         1645                            // old radius port...
 103 #define DAEPORT         3799                            // DAE port
 104 #define PKTARP          0x0806                          // ARP packet type
 105 #define PKTIP           0x0800                          // IPv4 packet type
 106 #define PKTIPV6         0x86DD                          // IPv6 packet type
 107 #define PPPPAP          0xC023
 108 #define PPPCHAP         0xC223
 109 #define PPPLCP          0xC021
 110 #define PPPIPCP         0x8021
 111 #define PPPIPV6CP       0x8057
 112 #define PPPCCP          0x80FD
 113 #define PPPIP           0x0021
 114 #define PPPIPV6         0x0057
 115 #define PPPMP           0x003D
 116 #define MIN_IP_SIZE     0x19
 117
 118 enum {
 119         ConfigReq = 1,
 120         ConfigAck,
 121         ConfigNak,
 122         ConfigRej,
 123         TerminateReq,
 124         TerminateAck,
 125         CodeRej,
 126         ProtocolRej,
 127         EchoReq,
 128         EchoReply,
 129         DiscardRequest,
 130         IdentRequest
 131 };
 132
 133 enum {
 134         AccessRequest = 1,
 135         AccessAccept,
 136         AccessReject,
 137         AccountingRequest,
 138         AccountingResponse,
 139         AccessChallenge = 11,
 140         DisconnectRequest = 40,
 141         DisconnectACK,
 142         DisconnectNAK,
 143         CoARequest,
 144         CoAACK,
 145         CoANAK
 146 };
 147
 148 // PPP phases
 149 enum {
 150         Dead,
 151         Establish,
 152         Authenticate,
 153         Network,
 154         Terminate
 155 };
 156
 157 // PPP states
 158 enum {
 159         Initial,
 160         Starting,
 161         Closed,
 162         Stopped,
 163         Closing,
 164         Stopping,
 165         RequestSent,
 166         AckReceived,
 167         AckSent,
 168         Opened
 169 };
 170
 171 // reset state machine counters
 172 #define initialise_restart_count(_s, _fsm)                      \
 173         sess_local[_s]._fsm.conf_sent =                         \
 174         sess_local[_s]._fsm.nak_sent = 0
 175
 176 // no more attempts
 177 #define zero_restart_count(_s, _fsm) ({                         \
 178         sess_local[_s]._fsm.conf_sent =                         \
 179                 config->ppp_max_configure;                      \
 180         sess_local[_s]._fsm.restart =                           \
 181                 time_now + config->ppp_restart_time;            \
 182 })
 183
 184 // increment ConfReq counter and reset timer
 185 #define restart_timer(_s, _fsm) ({                              \
 186         sess_local[_s]._fsm.conf_sent++;                        \
 187         sess_local[_s]._fsm.restart =                           \
 188                 time_now + config->ppp_restart_time;            \
 189 })
 190
 191 // stop timer on change to state where timer does not run
 192 #define change_state(_s, _fsm, _new) ({                         \
 193         if (_new != session[_s].ppp._fsm)                       \
 194         {                                                       \
 195                 switch (_new)                                   \
 196                 {                                               \
 197                 case Initial:                                   \
 198                 case Starting:                                  \
 199                 case Closed:                                    \
 200                 case Stopped:                                   \
 201                 case Opened:                                    \
 202                         sess_local[_s]._fsm.restart = 0;        \
 203                         initialise_restart_count(_s, _fsm);     \
 204                 }                                               \
 205                 session[_s].ppp._fsm = _new;                    \
 206                 cluster_send_session(_s);                       \
 207         }                                                       \
 208 })
 209
 210 // Types
 211 typedef uint16_t sessionidt;
 212 typedef uint16_t bundleidt;
 213 typedef uint16_t tunnelidt;
 214 typedef uint16_t groupidt;
 215 typedef uint32_t clockt;
 216 typedef uint8_t hasht[16];
 217
 218 // CLI actions
 219 struct cli_session_actions {
 220         char action;
 221         in_addr_t snoop_ip;
 222         uint16_t snoop_port;
 223         int throttle_in;
 224         int throttle_out;
 225         int filter_in;
 226         int filter_out;
 227 };
 228
 229 #define CLI_SESS_KILL           0x01
 230 #define CLI_SESS_SNOOP          0x02
 231 #define CLI_SESS_NOSNOOP        0x04
 232 #define CLI_SESS_THROTTLE       0x08
 233 #define CLI_SESS_NOTHROTTLE     0x10
 234 #define CLI_SESS_FILTER         0x20
 235 #define CLI_SESS_NOFILTER       0x40
 236
 237 struct cli_tunnel_actions {
 238         char action;
 239 };
 240
 241 #define CLI_TUN_KILL            0x01
 242
 243 // structures
 244 typedef struct                  // route
 245 {
 246         in_addr_t ip;
 247         int prefixlen;
 248 }
 249 routet;
 250
 251 typedef struct controls         // control message
 252 {
 253         struct controls *next;  // next in queue
 254         uint16_t length;        // length
 255         union {
 256                 uint8_t buf[MAXCONTROL];
 257                 uint16_t buf16[MAXCONTROL/2];
 258         } __attribute__ ((__transparent_union__));
 259 }
 260 controlt;
 261
 262 typedef struct {
 263         uint8_t length;                 // Endpoint Discriminator length
 264         uint8_t addr_class;             // Endpoint Discriminator class
 265         uint8_t address[MAXADDRESS];    // Endpoint Discriminator address
 266 } epdist;
 267
 268 typedef struct {
 269         sessionidt sid;                 // Fragment originating session
 270         tunnelidt tid;                  // Fragment originating tunnel
 271         uint8_t flags;                  // MP frame flags
 272         uint32_t seq;                   // fragment seq num
 273         uint32_t jitteravg;
 274         uint16_t length;                // Fragment length
 275         uint8_t data[MAXFRAGLEN];       // Fragment data
 276 } fragmentt;
 277
 278 typedef struct
 279 {
 280         sessionidt next;                // next session in linked list
 281         sessionidt far;                 // far end session ID
 282         tunnelidt tunnel;               // near end tunnel ID
 283         uint8_t flags;                  // session flags: see SESSION_*
 284         struct {
 285                 uint8_t phase;          // PPP phase
 286                 uint8_t lcp:4;          //   LCP    state
 287                 uint8_t ipcp:4;         //   IPCP   state
 288                 uint8_t ipv6cp:4;       //   IPV6CP state
 289                 uint8_t ccp:4;          //   CCP    state
 290         } ppp;
 291         uint16_t mru;                   // maximum receive unit
 292         in_addr_t ip;                   // IP of session set by RADIUS response (host byte order).
 293         int ip_pool_index;              // index to IP pool
 294         uint32_t unique_id;             // unique session id
 295         uint32_t magic;                 // ppp magic number
 296         uint32_t pin, pout;             // packet counts
 297         uint32_t cin, cout;             // byte counts
 298         uint32_t cin_wrap, cout_wrap;   // byte counter wrap count (RADIUS accounting giagawords)
 299         uint32_t cin_delta, cout_delta; // byte count changes (for dump_session())
 300         uint16_t throttle_in;           // upstream throttle rate (kbps)
 301         uint16_t throttle_out;          // downstream throttle rate
 302         uint8_t filter_in;              // input filter index (to ip_filters[N-1]; 0 if none)
 303         uint8_t filter_out;             // output filter index
 304         uint16_t snoop_port;            // Interception destination port
 305         in_addr_t snoop_ip;             // Interception destination IP
 306         clockt opened;                  // when started
 307         clockt die;                     // being closed, when to finally free
 308         uint32_t session_timeout;       // Maximum session time in seconds
 309         uint32_t idle_timeout;          // Maximum idle time in seconds
 310         time_t last_packet;             // Last packet from the user (used for idle timeouts)
 311         time_t last_data;               // Last data packet to/from the user (used for idle timeouts)
 312         in_addr_t dns1, dns2;           // DNS servers
 313         routet route[MAXROUTE];         // static routes
 314         uint16_t tbf_in;                // filter bucket for throttling in from the user.
 315         uint16_t tbf_out;               // filter bucket for throttling out to the user.
 316         int random_vector_length;
 317         uint8_t random_vector[MAXTEL];
 318         char user[MAXUSER];             // user (needed in session for radius stop messages)
 319         char called[MAXTEL];            // called number
 320         char calling[MAXTEL];           // calling number
 321         uint32_t tx_connect_speed;
 322         uint32_t rx_connect_speed;
 323         clockt timeout;                 // Session timeout
 324         uint32_t mrru;                  // Multilink Max-Receive-Reconstructed-Unit
 325         epdist epdis;                   // Multilink Endpoint Discriminator
 326         bundleidt bundle;               // Multilink Bundle Identifier
 327         uint8_t mssf;                   // Multilink Short Sequence Number Header Format
 328         uint8_t walled_garden;          // is this session gardened?
 329         uint8_t classlen;               // class (needed for radius accounting messages)
 330         char class[MAXCLASS];
 331         uint8_t ipv6prefixlen;          // IPv6 route prefix length
 332         struct in6_addr ipv6route;      // Static IPv6 route
 333 #ifdef LAC
 334         sessionidt forwardtosession;    // LNS id_session to forward
 335         uint8_t src_hwaddr[ETH_ALEN];   // MAC addr source (for pppoe sessions 6 bytes)
 336         uint32_t coutgrp_delta;
 337 #else
 338         uint8_t src_hwaddr[ETH_ALEN];   // MAC addr source (for pppoe sessions 6 bytes)
 339         uint32_t coutgrp_delta;
 340         char reserved[2];               // Space to expand structure without changing HB_VERSION
 341 #endif
 342 }
 343 sessiont;
 344
 345 typedef struct
 346 {
 347         uint32_t tx_rate;
 348         time_t mark_time;
 349         sessionidt sid;
 350         uint8_t weight;
 351 }
 352 groupsessionidt;
 353
 354 typedef struct
 355 {
 356         //uint16_t indexprevsessid;
 357         uint32_t time_changed;
 358         //time_t mark_time;
 359         groupidt prev;
 360         groupsessionidt sesslist[MAXSESSINGRP];
 361         routet route[MAXROUTEINGRP];            // static routes
 362         uint8_t nbroutesgrp;
 363         uint8_t nbsession;
 364 }
 365 groupsesst;
 366
 367 typedef struct
 368 {
 369         int state;                              // current state (bundlestate enum)
 370         uint32_t seq_num_t;                     // Sequence Number (transmission)
 371         uint32_t timeout;                       // Session-Timeout for bundle
 372         uint32_t max_seq;                       // Max value of sequence number field
 373         uint8_t num_of_links;                   // Number of links joint to this bundle
 374         uint32_t online_time;                   // The time this bundle is online
 375         clockt last_check;                      // Last time the timeout is checked
 376         uint32_t mrru;                          // Multilink Max-Receive-Reconstructed-Unit
 377         uint8_t mssf;                           // Multilink Short Sequence Number Header Format
 378         epdist epdis;                           // Multilink Endpoint Discriminator
 379         char user[MAXUSER];                     // Needed for matching member links
 380         sessionidt current_ses;                 // Current session to use for sending (used in RR load-balancing)
 381         sessionidt members[MAXBUNDLESES];       // Array for member links sessions
 382 }
 383 bundlet;
 384
 385 typedef struct
 386 {
 387         fragmentt fragment[MAXFRAGNUM];
 388         uint8_t reassembled_frame[MAXETHER];    // The reassembled frame
 389         uint16_t re_frame_len;                  // The reassembled frame length
 390         uint16_t re_frame_begin_index, re_frame_end_index;      // reassembled frame begin index, end index respectively
 391         uint16_t start_index, end_index;        // start and end sequence numbers available on the fragments array respectively
 392         uint32_t M;                             // Minumum frame sequence number received over all bundle members
 393         uint32_t start_seq;                     // Last received frame sequence number (bearing B bit)
 394 }
 395 fragmentationt;
 396
 397 #define AUTHPAP         1       // allow PAP
 398 #define AUTHCHAP        2       // allow CHAP
 399
 400 typedef struct
 401 {
 402         // packet counters
 403         uint32_t pin;
 404         uint32_t pout;
 405
 406         // byte counters
 407         uint32_t cin;
 408         uint32_t cout;
 409
 410         // PPP restart timer/counters
 411         struct {
 412                 time_t restart;
 413                 int conf_sent;
 414                 int nak_sent;
 415         } lcp, ipcp, ipv6cp, ccp;
 416
 417         // identifier for Protocol-Reject, Code-Reject
 418         uint8_t lcp_ident;
 419
 420         // authentication to use
 421         int lcp_authtype;
 422
 423         // our MRU
 424         uint16_t ppp_mru;
 425
 426         // our MRRU
 427         uint16_t mp_mrru;
 428
 429         // our mssf
 430         uint16_t mp_mssf;
 431
 432         // our Endpoint Discriminator
 433         in_addr_t mp_epdis;
 434
 435         // DoS prevention
 436         clockt last_packet_out;
 437         uint32_t packets_out;
 438         uint32_t packets_dropped;
 439
 440         // RADIUS session in use
 441         uint16_t radius;
 442
 443         // interim RADIUS
 444         time_t last_interim;
 445
 446         // last LCP Echo
 447         time_t last_echo;
 448
 449         // Last Multilink frame sequence number received
 450         uint32_t last_seq;
 451
 452         // jitter average of the session
 453         uint32_t jitteravg;
 454         // time in milliseconds of the last fragment.
 455         uint64_t prev_time;
 456 } sessionlocalt;
 457
 458 // session flags
 459 #define SESSION_PFC     (1 << 0)        // use Protocol-Field-Compression
 460 #define SESSION_ACFC    (1 << 1)        // use Address-and-Control-Field-Compression
 461 #define SESSION_STARTED (1 << 2)        // RADIUS Start record sent
 462
 463 // 328 bytes per tunnel
 464 typedef struct
 465 {
 466         tunnelidt far;          // far end tunnel ID
 467         in_addr_t ip;           // Ip for far end
 468         uint16_t port;          // port for far end
 469         uint16_t window;        // Rx window
 470         uint16_t nr;            // next receive
 471         uint16_t ns;            // next send
 472         int state;              // current state (tunnelstate enum)
 473         clockt last;            // when last control message sent (used for resend timeout)
 474         clockt retry;           // when to try resending pending control
 475         clockt die;             // being closed, when to finally free
 476         clockt lastrec;         // when the last control message was received
 477         char hostname[128];     // tunnel hostname
 478         char vendor[128];       // LAC vendor
 479         uint8_t try;            // number of retrys on a control message
 480         uint16_t controlc;      // outstaind messages in queue
 481         controlt *controls;     // oldest message
 482         controlt *controle;     // newest message
 483 #ifdef LAC
 484         uint16_t isremotelns;   // != 0 if the tunnel is to remote LNS (== index on the conf remote lns)
 485         char reserved[14];              // Space to expand structure without changing HB_VERSION
 486 #else
 487         char reserved[16];              // Space to expand structure without changing HB_VERSION
 488 #endif
 489 }
 490 tunnelt;
 491
 492 // 164 bytes per radius session
 493 typedef struct                  // outstanding RADIUS requests
 494 {
 495         sessionidt session;     // which session this applies to
 496         hasht auth;             // request authenticator
 497         clockt retry;           // when to try next
 498         char pass[129];         // password
 499         uint8_t id;             // ID for PPP response
 500         uint8_t try;            // which try we are on
 501         uint8_t state;          // state of radius requests
 502         uint8_t chap;           // set if CHAP used (is CHAP identifier)
 503         uint8_t term_cause;     // Stop record: Acct-Terminate-Cause
 504         char const *term_msg;   //   terminate reason
 505 }
 506 radiust;
 507
 508 typedef struct
 509 {
 510         in_addr_t       address;        // Host byte order..
 511         char            assigned;       // 1 if assigned, 0 if free
 512         sessionidt      session;
 513         clockt          last;           // last used
 514         char            user[129];      // user (try to have ip addresses persistent)
 515 }
 516 ippoolt;
 517
 518 #ifdef RINGBUFFER
 519 struct Tringbuffer
 520 {
 521         struct {
 522                 char level;
 523                 sessionidt session;
 524                 tunnelidt tunnel;
 525                 char message[MAX_LOG_LENGTH];
 526         } buffer[RINGBUFFER_SIZE];
 527         int head;
 528         int tail;
 529 };
 530 #endif
 531
 532 /*
 533  * Possible tunnel states
 534  * TUNNELFREE -> TUNNELOPEN -> TUNNELDIE -> TUNNELFREE
 535  */
 536 enum
 537 {
 538         TUNNELFREE,             // Not in use
 539         TUNNELOPEN,             // Active tunnel
 540         TUNNELDIE,              // Currently closing
 541         TUNNELOPENING,          // Busy opening
 542         TUNNELUNDEF,            // Undefined
 543 };
 544
 545 enum
 546 {
 547         BUNDLEFREE,             // Not in use
 548         BUNDLEOPEN,             // Active bundle
 549         BUNDLEUNDEF,            // Undefined
 550 };
 551
 552 enum
 553 {
 554         NULLCLASS = 0,          //End Point Discriminator classes
 555         LOCALADDR,
 556         IPADDR,
 557         IEEEMACADDR,
 558         PPPMAGIC,
 559         PSNDN,
 560 };
 561
 562 enum
 563 {
 564         RADIUSNULL,             // Not in use
 565         RADIUSCHAP,             // sending CHAP down PPP
 566         RADIUSAUTH,             // sending auth to RADIUS server
 567         RADIUSSTART,            // sending start accounting to RADIUS server
 568         RADIUSSTOP,             // sending stop accounting to RADIUS server
 569         RADIUSINTERIM,          // sending interim accounting to RADIUS server
 570         RADIUSWAIT,             // waiting timeout before available, in case delayed replies
 571         RADIUSJUSTAUTH,         // sending auth to RADIUS server, just authentication, no ip assigning
 572 };
 573
 574 struct Tstats
 575 {
 576     time_t      start_time;
 577     time_t      last_reset;
 578
 579     uint32_t    tun_rx_packets;
 580     uint32_t    tun_tx_packets;
 581     uint32_t    tun_rx_bytes;
 582     uint32_t    tun_tx_bytes;
 583     uint32_t    tun_rx_errors;
 584     uint32_t    tun_tx_errors;
 585     uint32_t    tun_rx_dropped;
 586
 587     uint32_t    tunnel_rx_packets;
 588     uint32_t    tunnel_tx_packets;
 589     uint32_t    tunnel_rx_bytes;
 590     uint32_t    tunnel_tx_bytes;
 591     uint32_t    tunnel_rx_errors;
 592     uint32_t    tunnel_tx_errors;
 593
 594     uint32_t    tunnel_retries;
 595     uint32_t    radius_retries;
 596
 597     uint32_t    arp_sent;
 598
 599     uint32_t    packets_snooped;
 600
 601     uint32_t    tunnel_created;
 602     uint32_t    session_created;
 603     uint32_t    tunnel_timeout;
 604     uint32_t    session_timeout;
 605     uint32_t    radius_timeout;
 606     uint32_t    radius_overflow;
 607     uint32_t    tunnel_overflow;
 608     uint32_t    session_overflow;
 609
 610     uint32_t    ip_allocated;
 611     uint32_t    ip_freed;
 612
 613     uint32_t    c_forwarded;
 614     uint32_t    recv_forward;
 615
 616     uint32_t    select_called;
 617     uint32_t    multi_read_used;
 618     uint32_t    multi_read_exceeded;
 619
 620 #ifdef STATISTICS
 621     uint32_t    call_processtun;
 622     uint32_t    call_processipout;
 623     uint32_t    call_processipv6out;
 624     uint32_t    call_processudp;
 625     uint32_t    call_sessionbyip;
 626     uint32_t    call_sessionbyipv6;
 627     uint32_t    call_sessionbyuser;
 628     uint32_t    call_sendarp;
 629     uint32_t    call_sendipcp;
 630     uint32_t    call_sendipv6cp;
 631     uint32_t    call_processipv6cp;
 632     uint32_t    call_tunnelsend;
 633     uint32_t    call_sessionkill;
 634     uint32_t    call_sessionshutdown;
 635     uint32_t    call_tunnelkill;
 636     uint32_t    call_tunnelshutdown;
 637     uint32_t    call_assign_ip_address;
 638     uint32_t    call_free_ip_address;
 639     uint32_t    call_dump_acct_info;
 640     uint32_t    call_sessionsetup;
 641     uint32_t    call_processpap;
 642     uint32_t    call_processchap;
 643     uint32_t    call_processlcp;
 644     uint32_t    call_processipcp;
 645     uint32_t    call_processipin;
 646     uint32_t    call_processipv6in;
 647     uint32_t    call_processccp;
 648     uint32_t    call_sendchap;
 649     uint32_t    call_processrad;
 650     uint32_t    call_radiussend;
 651     uint32_t    call_radiusretry;
 652     uint32_t    call_random_data;
 653 #endif
 654 };
 655
 656 #ifdef STATISTICS
 657
 658 #ifdef STAT_CALLS
 659 #define CSTAT(x)        STAT(call_ ## x)
 660 #else
 661 #define CSTAT(x)
 662 #endif
 663
 664 #define STAT(x)         (_statistics->x++)
 665 #define INC_STAT(x,y)   (_statistics->x += (y))
 666 #define GET_STAT(x)     (_statistics->x)
 667 #define SET_STAT(x, y)  (_statistics->x = (y))
 668 #else
 669 #define CSTAT(x)
 670 #define STAT(x)
 671 #define INC_STAT(x,y)
 672 #define GET_STAT(x)     0
 673 #define SET_STAT(x, y)
 674 #endif
 675
 676 #ifndef IFNAMSIZ
 677 # define IFNAMSIZ 16
 678 #endif
 679
 680 typedef struct
 681 {
 682         int             debug;                          // debugging level
 683         time_t          start_time;                     // time when l2tpns was started
 684         char            bandwidth[256];                 // current bandwidth
 685         char            pid_file[256];                  // file to write PID to on startup
 686         int             wrote_pid;
 687         clockt          current_time;                   // 1/10ths of a second since the process started.
 688                                                         // means that we can only run a given process
 689                                                         // for 13 years without re-starting!
 690
 691         char            config_file[128];
 692         int             reload_config;                  // flag to re-read config (set by cli)
 693         int             multi_read_count;               // amount of packets to read per fd in processing loop
 694
 695         char            tundevicename[IFNAMSIZ];                // tun device name
 696         char            log_filename[128];
 697
 698         char            l2tp_secret[64];                // L2TP shared secret
 699         int             l2tp_mtu;                       // MTU of interface used for L2TP
 700
 701         char            random_device[256];             // random device path, defaults to RANDOMDEVICE
 702
 703         int             ppp_restart_time;               // timeout for PPP restart
 704         int             ppp_max_configure;              // max lcp configure requests to send
 705         int             ppp_max_failure;                // max lcp configure naks to send
 706
 707         char            radiussecret[64];
 708         int             radius_accounting;
 709         int             radius_interim;
 710         in_addr_t       radiusserver[MAXRADSERVER];     // radius servers
 711         uint16_t        radiusport[MAXRADSERVER];       // radius base ports
 712         uint8_t         numradiusservers;               // radius server count
 713
 714         uint16_t        radius_dae_port;                // port for radius DAE
 715         uint16_t        radius_bind_min;                // port range for udp sockets used to send/recv radius packets
 716         uint16_t        radius_bind_max;
 717
 718         char            radius_authtypes_s[32];         // list of valid authentication types (chap, pap) in order of preference
 719         int             radius_authtypes;
 720         int             radius_authprefer;
 721
 722         int             allow_duplicate_users;          // allow multiple logins with the same username
 723         int             kill_timedout_sessions;         // kill authenticated sessions with "session_timeout == 0"
 724
 725         in_addr_t       default_dns1, default_dns2;
 726
 727         unsigned long   rl_rate;                        // default throttle rate
 728         int             num_tbfs;                       // number of throttle buckets
 729
 730         char            accounting_dir[128];
 731         in_addr_t       bind_address;
 732         in_addr_t       peer_address;
 733         int             send_garp;                      // Set to true to garp for vip address on startup
 734
 735         int             dump_speed;
 736         char            plugins[64][MAXPLUGINS];
 737         char            old_plugins[64][MAXPLUGINS];
 738
 739         int             next_tbf;                       // Next HTB id available to use
 740         int             scheduler_fifo;                 // If the system has multiple CPUs, use FIFO scheduling
 741                                                         // policy for this process.
 742         int             lock_pages;                     // Lock pages into memory.
 743         int             icmp_rate;                      // Max number of ICMP unreachable per second to send
 744         int             max_packets;                    // DoS prevention: per session limit of packets/0.1s
 745         char            epdis_addr[20];                 // MP Endpoint Discriminator address
 746
 747         in_addr_t       cluster_address;                // Multicast address of cluster.
 748                                                         // Send to this address to have everyone hear.
 749         char            cluster_interface[64];          // Which interface to listen for multicast on.
 750         int             cluster_iam_master;             // Are we the cluster master???
 751         int             cluster_iam_uptodate;           // Set if we've got a full set of state from the master.
 752         in_addr_t       cluster_master_address;         // The network address of the cluster master.
 753                                                         // Zero if i am the cluster master.
 754         int             cluster_seq_number;             // Sequence number of the next heartbeat we'll send out
 755                                                         // (or the seq number we're next expecting if we're a slave).
 756         int             cluster_undefined_sessions;     // How many sessions we're yet to receive from the master.
 757         int             cluster_undefined_bundles;      // How many bundles we're yet to receive from the master.
 758         int             cluster_undefined_tunnels;      // How many tunnels we're yet to receive from the master.
 759         int             cluster_highest_sessionid;
 760         int             cluster_highest_bundleid;
 761         int             cluster_highest_tunnelid;
 762         clockt          cluster_last_hb;                // Last time we saw a heartbeat from the master.
 763         int             cluster_last_hb_ver;            // Heartbeat version last seen from master
 764         int             cluster_num_changes;            // Number of changes queued.
 765
 766         int             cluster_mcast_ttl;              // TTL for multicast packets
 767         int             cluster_hb_interval;            // How often to send a heartbeat.
 768         int             cluster_hb_timeout;             // How many missed heartbeats trigger an election.
 769         uint64_t        cluster_table_version;          // # state changes processed by cluster
 770
 771         struct in6_addr ipv6_prefix;                    // Our IPv6 network pool.
 772
 773
 774         int             cluster_master_min_adv;         // Master advertises routes while the number of up to date
 775                                                         // slaves is less than this value.
 776         in_addr_t       cli_bind_address;               // bind address for CLI
 777         char            hostname[MAXHOSTNAME];  // hostname (overridden by -h on command line)
 778         // Guest change
 779         char            guest_user[MAXUSER];            // Guest account username
 780
 781 #ifdef BGP
 782 #define BGP_NUM_PEERS   2
 783         uint16_t as_number;
 784         struct {
 785                 char name[64];
 786                 uint16_t as;
 787                 int keepalive;
 788                 int hold;
 789                 struct in_addr update_source;
 790         } neighbour[BGP_NUM_PEERS];
 791         in_addr_t       nexthop_address;
 792         struct in6_addr nexthop6_address;
 793 #endif
 794
 795         int echo_timeout; // Time between last packet sent and LCP ECHO generation
 796         int idle_echo_timeout; // Time between last packet seen and
 797                                                    // Drop sessions who have not responded within IDLE_ECHO_TIMEOUT seconds
 798         in_addr_t iftun_address;
 799 #ifdef LAC
 800         int disable_lac_func;
 801         int auth_tunnel_change_addr_src;
 802         int highest_rlnsid;
 803         uint16_t bind_portremotelns;
 804         in_addr_t bind_address_remotelns;
 805 #endif
 806         char pppoe_if_to_bind[IFNAMSIZ];        // Name pppoe interface to bind
 807         char pppoe_service_name[64];    // pppoe service name
 808         char pppoe_ac_name[64];
 809         uint8_t pppoe_hwaddr[ETH_ALEN]; // MAC addr of interface pppoe to bind
 810         int disable_sending_hello; // Disable l2tp sending HELLO message for Apple compatibility.
 811         int disable_no_spoof; // Disable no spoof (permit load balancing client --> internet)
 812         int grp_txrate_average_time; // caculation txrate average time (default 10s)
 813 } configt;
 814
 815 enum config_typet { INT, STRING, UNSIGNED_LONG, SHORT, BOOL, IPv4, IPv6 };
 816 typedef struct
 817 {
 818         char *key;
 819         int offset;
 820         int size;
 821         enum config_typet type;
 822 } config_descriptt;
 823
 824 typedef struct
 825 {
 826         uint8_t op;     // operation
 827 #define FILTER_PORT_OP_NONE     0 // all ports match
 828 #define FILTER_PORT_OP_EQ       1
 829 #define FILTER_PORT_OP_NEQ      2
 830 #define FILTER_PORT_OP_GT       3
 831 #define FILTER_PORT_OP_LT       4
 832 #define FILTER_PORT_OP_RANGE    5
 833         uint16_t port;  // port (host byte order)
 834         uint16_t port2; // range
 835 } ip_filter_portt;
 836
 837 typedef struct
 838 {
 839         int action;             // permit/deny
 840 #define FILTER_ACTION_DENY      1
 841 #define FILTER_ACTION_PERMIT    2
 842         uint8_t proto;          // protocol: IPPROTO_* (netinet/in.h)
 843         in_addr_t src_ip;       // source ip (network byte order)
 844         in_addr_t src_wild;
 845         ip_filter_portt src_ports;
 846         in_addr_t dst_ip;       // dest ip
 847         in_addr_t dst_wild;
 848         ip_filter_portt dst_ports;
 849         uint8_t frag;           // apply to non-initial fragments
 850         uint8_t tcp_flag_op;    // match type: any, all, established
 851 #define FILTER_FLAG_OP_ANY      1
 852 #define FILTER_FLAG_OP_ALL      2
 853 #define FILTER_FLAG_OP_EST      3
 854         uint8_t tcp_sflags;     // flags set
 855         uint8_t tcp_cflags;     // flags clear
 856         uint32_t counter;       // match count
 857 } ip_filter_rulet;
 858
 859 #define TCP_FLAG_FIN    0x01
 860 #define TCP_FLAG_SYN    0x02
 861 #define TCP_FLAG_RST    0x04
 862 #define TCP_FLAG_PSH    0x08
 863 #define TCP_FLAG_ACK    0x10
 864 #define TCP_FLAG_URG    0x20
 865
 866 #define MAXFILTER               32
 867 #define MAXFILTER_RULES         32
 868 typedef struct
 869 {
 870         char name[32];          // ACL name
 871         int extended;           // type: 0 = standard, 1 = extended
 872         ip_filter_rulet rules[MAXFILTER_RULES];
 873         int used;               // session ref count
 874 } ip_filtert;
 875
 876 // CDN result/error codes
 877 #define CDN_NONE                        0, 0
 878 #define CDN_TRY_ANOTHER                 2, 7
 879 #define CDN_ADMIN_DISC                  3, 0
 880 #define CDN_UNAVAILABLE                 4, 0
 881
 882 // RADIUS Acct-Terminate-Cause values
 883 #define TERM_USER_REQUEST               1
 884 #define TERM_LOST_CARRIER               2
 885 #define TERM_LOST_SERVICE               3
 886 #define TERM_IDLE_TIMEOUT               4
 887 #define TERM_SESSION_TIMEOUT            5
 888 #define TERM_ADMIN_RESET                6
 889 #define TERM_ADMIN_REBOOT               7
 890 #define TERM_PORT_ERROR                 8
 891 #define TERM_NAS_ERROR                  9
 892 #define TERM_NAS_REQUEST                10
 893 #define TERM_NAS_REBOOT                 11
 894 #define TERM_PORT_UNNEEDED              12
 895 #define TERM_PORT_PREEMPTED             13
 896 #define TERM_PORT_SUSPENDED             14
 897 #define TERM_SERVICE_UNAVAILABLE        15
 898 #define TERM_CALLBACK                   16
 899 #define TERM_USER_ERROR                 17
 900 #define TERM_HOST_REQUEST               18
 901 #define TERM_SUPPLICANT_RESTART         19
 902 #define TERM_REAUTHENTICATION_FAILURE   20
 903 #define TERM_PORT_REINIT                21
 904 #define TERM_PORT_DISABLED              22
 905
 906 // on slaves, alow BGP to withdraw cleanly before exiting
 907 #define QUIT_DELAY      5
 908
 909 // quit actions (master)
 910 #define QUIT_FAILOVER   1 // SIGTERM: exit when all control messages have been acked (for cluster failover)
 911 #define QUIT_SHUTDOWN   2 // SIGQUIT: shutdown sessions/tunnels, reject new connections
 912
 913 // arp.c
 914 void sendarp(int ifr_idx, const unsigned char* mac, in_addr_t ip);
 915
 916
 917 // ppp.c
 918 void processpap(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 919 void processchap(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 920 void lcp_open(sessionidt s, tunnelidt t);
 921 void lcp_restart(sessionidt s);
 922 void processlcp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 923 void processipcp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 924 void processipv6cp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 925 void processipin(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 926 void processmpin(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 927 void processmpframe(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l, uint8_t extra);
 928 void processipv6in(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 929 void processccp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 930 void sendchap(sessionidt s, tunnelidt t);
 931 uint8_t *makeppp(uint8_t *b, int size, uint8_t *p, int l, sessionidt s, tunnelidt t, uint16_t mtype, uint8_t prio, bundleidt bid, uint8_t mp_bits);
 932 uint8_t *opt_makeppp(uint8_t *p, int l, sessionidt s, tunnelidt t, uint16_t mtype, uint8_t prio, bundleidt bid, uint8_t mp_bits);
 933 void sendlcp(sessionidt s, tunnelidt t);
 934 void send_ipin(sessionidt s, uint8_t *buf, int len);
 935 void sendccp(sessionidt s, tunnelidt t);
 936 void protoreject(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l, uint16_t proto);
 937 int join_bundle(sessionidt s);
 938
 939
 940 // radius.c
 941 void initrad(void);
 942 void radiussend(uint16_t r, uint8_t state);
 943 void processrad(uint8_t *buf, int len, char socket_index);
 944 void radiusretry(uint16_t r);
 945 uint16_t radiusnew(sessionidt s);
 946 void radiusclear(uint16_t r, sessionidt s);
 947 void processdae(uint8_t *buf, int len, struct sockaddr_in *addr, int alen, struct in_addr *local);
 948 #ifdef LAC
 949 int rad_tunnel_pwdecode(uint8_t *pl2tpsecret, size_t *pl2tpsecretlen, const char *radiussecret, const uint8_t * auth);
 950 #endif
 951
 952 // l2tpns.c
 953 clockt backoff(uint8_t try);
 954 void send_ipv6_ra(sessionidt s, tunnelidt t, struct in6_addr *ip);
 955 void route6set(sessionidt s, struct in6_addr ip, int prefixlen, int add);
 956 sessionidt sessionbyip(in_addr_t ip);
 957 sessionidt sessionbyipv6(struct in6_addr ip);
 958 sessionidt sessionbyuser(char *username);
 959 void increment_counter(uint32_t *counter, uint32_t *wrap, uint32_t delta);
 960 void random_data(uint8_t *buf, int len);
 961 void sessionkill(sessionidt s, char *reason);
 962 void sessionshutdown(sessionidt s, char const *reason, int cdn_result, int cdn_error, int term_cause);
 963 void filter_session(sessionidt s, int filter_in, int filter_out);
 964 void send_garp(in_addr_t ip);
 965 void tunnelsend(uint8_t *buf, uint16_t l, tunnelidt t);
 966 int tun_write(uint8_t *data, int size);
 967 void adjust_tcp_mss(sessionidt s, tunnelidt t, uint8_t *buf, int len, uint8_t *tcp);
 968 void sendipcp(sessionidt s, tunnelidt t);
 969 void sendipv6cp(sessionidt s, tunnelidt t);
 970 void processudp(uint8_t *buf, int len, struct sockaddr_in *addr);
 971 void processipout(uint8_t *buf, int len);
 972 void snoop_send_packet(uint8_t *packet, uint16_t size, in_addr_t destination, uint16_t port);
 973 int find_filter(char const *name, size_t len);
 974 int ip_filter(uint8_t *buf, int len, uint8_t filter);
 975 int cmd_show_ipcache(struct cli_def *cli, char *command, char **argv, int argc);
 976 int cmd_show_hist_idle(struct cli_def *cli, char *command, char **argv, int argc);
 977 int cmd_show_hist_open(struct cli_def *cli, char *command, char **argv, int argc);
 978 void netlink_addattr(struct nlmsghdr *nh, int type, const void *data, int alen);
 979 ssize_t netlink_send(struct nlmsghdr *nh);
 980 void cache_ipmap(in_addr_t ip, sessionidt s);
 981
 982 #ifdef LAC
 983 tunnelidt lac_new_tunnel();
 984 void lac_tunnelclear(tunnelidt t);
 985 void lac_send_SCCRQ(tunnelidt t, uint8_t * auth, unsigned int auth_len);
 986 void lac_send_ICRQ(tunnelidt t, sessionidt s);
 987 void lac_tunnelshutdown(tunnelidt t, char *reason, int result, int error, char *msg);
 988 #endif
 989
 990 // grpsess.c
 991 sessionidt grp_getnextsession(groupidt g, in_addr_t ip);
 992 void grp_initdata(void);
 993 void grp_processvendorspecific(sessionidt s, uint8_t *pvs);
 994 groupidt grp_groupbysession(sessionidt s);
 995 groupidt grp_groupbyip(in_addr_t ip);
 996 void grp_setgrouproute(groupidt g, int add);
 997 void grp_time_changed(void);
 998 void grp_removesession(groupidt g, sessionidt s);
 999
1000 #undef LOG
1001 #undef LOG_HEX
1002 #define LOG(D, s, t, f, ...)    ({ if (D <= config->debug) _log(D, s, t, f, ## __VA_ARGS__); })
1003 #define LOG_HEX(D, t, d, s)     ({ if (D <= config->debug) _log_hex(D, t, d, s); })
1004
1005 void _log(int level, sessionidt s, tunnelidt t, const char *format, ...) __attribute__((format (printf, 4, 5)));
1006 void _log_hex(int level, const char *title, const uint8_t *data, int maxsize);
1007
1008
1009 int sessionsetup(sessionidt s, tunnelidt t);
1010 int run_plugins(int plugin_type, void *data);
1011 void rebuild_address_pool(void);
1012 void throttle_session(sessionidt s, int rate_in, int rate_out);
1013 int load_session(sessionidt, sessiont *);
1014 void become_master(void);       // We're the master; kick off any required master initializations.
1015
1016
1017 // cli.c
1018 void init_cli();
1019 void cli_init_complete(char *hostname);
1020 void cli_do_file(FILE *fh);
1021 void cli_do(int sockfd);
1022 int cli_arg_help(struct cli_def *cli, int cr_ok, char *entry, ...);
1023
1024
1025 // icmp.c
1026 void host_unreachable(in_addr_t destination, uint16_t id, in_addr_t source, uint8_t *packet, int packet_len);
1027
1028
1029 extern tunnelt *tunnel;
1030 extern bundlet *bundle;
1031 extern sessiont *session;
1032 extern sessionlocalt *sess_local;
1033 extern ippoolt *ip_address_pool;
1034 extern groupsesst *grpsession;
1035 #define sessionfree (session[0].next)
1036
1037
1038 extern configt *config;
1039 extern time_t basetime;         // Time when this process started.
1040 extern time_t time_now;         // Seconds since EPOCH.
1041 extern char main_quit;
1042 extern uint32_t last_id;
1043 extern struct Tstats *_statistics;
1044 extern in_addr_t my_address;
1045 extern int clifd;
1046 extern int epollfd;
1047 extern int tunidx;              // ifr_ifindex of tun device
1048
1049 struct event_data {
1050         enum {
1051                 FD_TYPE_CLI,
1052                 FD_TYPE_CLUSTER,
1053                 FD_TYPE_TUN,
1054                 FD_TYPE_UDP,
1055                 FD_TYPE_CONTROL,
1056                 FD_TYPE_DAE,
1057                 FD_TYPE_RADIUS,
1058                 FD_TYPE_BGP,
1059                 FD_TYPE_NETLINK,
1060 #ifdef LAC
1061                 FD_TYPE_UDPLAC,
1062 #endif
1063                 FD_TYPE_PPPOEDISC,
1064                 FD_TYPE_PPPOESESS
1065         } type;
1066         int index; // for RADIUS, BGP
1067 };
1068
1069 #define TIME (config->current_time)
1070
1071 extern uint16_t MRU;
1072 extern uint16_t MSS;
1073
1074 // macros for handling help in cli commands
1075 #define CLI_HELP_REQUESTED      (argc > 0 && argv[argc-1][strlen(argv[argc-1])-1] == '?')
1076 #define CLI_HELP_NO_ARGS        (argc > 1 || argv[0][1]) ? CLI_OK : cli_arg_help(cli, 1, NULL)
1077
1078 #endif /* __L2TPNS_H__ */