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