remove defunct PLUGIN_PACKET_{RX,TX} constants
[l2tpns.git] / l2tpns.h
index 3d19b8f..3ad2cf5 100644 (file)
--- a/l2tpns.h
+++ b/l2tpns.h
@@ -1,11 +1,10 @@
 // L2TPNS Global Stuff
-// $Id: l2tpns.h,v 1.85 2005/08/29 06:17:53 bodea Exp $
+// $Id: l2tpns.h,v 1.116 2006/04/27 14:37:28 bodea Exp $
 
 #ifndef __L2TPNS_H__
 #define __L2TPNS_H__
 
 #include <netinet/in.h>
-#include <execinfo.h>
 #include <stdio.h>
 #include <signal.h>
 #include <stdlib.h>
 #include <sys/types.h>
 #include <libcli.h>
 
-#define VERSION        "2.1.4"
+#define VERSION        "2.2.0"
 
 // Limits
 #define MAXTUNNEL      500             // could be up to 65535
+#define MAXBUNDLE      300             // could be up to 65535
+#define MAXBUNDLESES   10              // Maximum number of member links in bundle
+#define MAXADDRESS     20              // Maximum length for the Endpoint Discrminiator address
+#define MAXFRAGNUM     1500            // Maximum number of Multilink fragment in a bundle
+#define MAXFRAGLEN      1000           // Maximum length for Multilink fragment
 #define MAXSESSION     60000           // could be up to 65535
 #define MAXTBFS                6000            // Maximum token bucket filters. Might need up to 2 * session.
 
 #define RADIUS_SHIFT   6
-#define        RADIUS_FDS      (1 << RADIUS_SHIFT)
+#define RADIUS_FDS     (1 << RADIUS_SHIFT)
 #define RADIUS_MASK    ((1 << RADIUS_SHIFT) - 1)
 #define MAXRADIUS      (1 << (8 + RADIUS_SHIFT))
 
 #define T_UNDEF                (0xffff)        // A tunnel ID that won't ever be used. Mark session as undefined.
 #define T_FREE         (0)             // A tunnel ID that won't ever be used. Mark session as free.
 
-#define        MAXCONTROL      1000            // max length control message we ever send...
-#define        MAXETHER        (1500+18)       // max packet we try sending to tun
-#define        MAXTEL          96              // telephone number
+#define MAXCONTROL     1000            // max length control message we ever send...
+#define MINMTU         576             // minimum recommended MTU (rfc1063)
+#define MAXMTU         2600            // arbitrary maximum MTU
+#define PPPoE_MRU      1492            // maximum PPPoE MRU (rfc2516: 1500 less PPPoE header (6) and PPP protocol ID (2))
+#define MAXETHER       (MAXMTU+18)     // max packet we try sending to tun
+#define MAXTEL         96              // telephone number
 #define MAXUSER                128             // username
 #define MAXPASS                128             // password
 #define MAXPLUGINS     20              // maximum number of plugins to load
 #define MAXRADSERVER   10              // max radius servers
-#define        MAXROUTE        10              // max static routes per session
+#define MAXROUTE       10              // max static routes per session
 #define MAXIPPOOL      131072          // max number of ip addresses in pool
 #define RINGBUFFER_SIZE        10000           // Number of ringbuffer entries to allocate
 #define MAX_LOG_LENGTH 512             // Maximum size of log message
-#define ECHO_TIMEOUT   60              // Time between last packet sent and LCP ECHO generation
+#define ECHO_TIMEOUT   10              // Time between last packet sent and LCP ECHO generation
 #define IDLE_TIMEOUT   240             // Time between last packet sent and LCP ECHO generation
 #define BUSY_WAIT_TIME 3000            // 5 minutes in 1/10th seconds to wait for radius to cleanup on shutdown
-#define DEFAULT_MRU    1452            // maximum packet size to avoid fragmentation when LNS ethernet MTU is 1500
+
+#define MP_BEGIN       0x80            // This value is used when (b)egin bit is set in MP header
+#define MP_END         0x40            // This value is used when (e)nd bit is set in MP header
+#define MP_BOTH_BITS   0xC0            // This value is used when both bits (begin and end) are set in MP header
+
+#define DEFAULT_EPDIS_ADDRESS  "L2TPNetServer"         // Company name may goes here!
 
 // Constants
 #ifndef ETCDIR
 #define IPPOOLFILE     FLASHDIR "/ip_pool"             // Address pool configuration
 #define ACCT_TIME      3000                            // 5 minute accounting interval
 #define ACCT_SHUT_TIME 600                             // 1 minute for counters of shutdown sessions
-#define        L2TPPORT        1701                            // L2TP port
+#define L2TPPORT       1701                            // L2TP port
 #define RADPORT                1645                            // old radius port...
 #define DAEPORT                3799                            // DAE port
-#define        PKTARP          0x0806                          // ARP packet type
-#define        PKTIP           0x0800                          // IPv4 packet type
-#define        PKTIPV6         0x86DD                          // IPv6 packet type
-#define        PPPPAP          0xC023
-#define        PPPCHAP         0xC223
-#define        PPPLCP          0xC021
-#define        PPPIPCP         0x8021
-#define        PPPIPV6CP       0x8057
-#define        PPPCCP          0x80FD
+#define PKTARP         0x0806                          // ARP packet type
+#define PKTIP          0x0800                          // IPv4 packet type
+#define PKTIPV6                0x86DD                          // IPv6 packet type
+#define PPPPAP         0xC023
+#define PPPCHAP                0xC223
+#define PPPLCP         0xC021
+#define PPPIPCP                0x8021
+#define PPPIPV6CP      0x8057
+#define PPPCCP         0x80FD
 #define PPPIP          0x0021
 #define PPPIPV6                0x0057
 #define PPPMP          0x003D
@@ -146,7 +158,23 @@ enum {
 
 // reset state machine counters
 #define initialise_restart_count(_s, _fsm)                     \
-       sess_local[_s]._fsm.conf_sent = sess_local[_s]._fsm.nak_sent
+       sess_local[_s]._fsm.conf_sent =                         \
+       sess_local[_s]._fsm.nak_sent = 0
+
+// no more attempts
+#define zero_restart_count(_s, _fsm) ({                                \
+       sess_local[_s]._fsm.conf_sent =                         \
+               config->ppp_max_configure;                      \
+       sess_local[_s]._fsm.restart =                           \
+               time_now + config->ppp_restart_time;            \
+})
+
+// increment ConfReq counter and reset timer
+#define restart_timer(_s, _fsm) ({                             \
+       sess_local[_s]._fsm.conf_sent++;                        \
+       sess_local[_s]._fsm.restart =                           \
+               time_now + config->ppp_restart_time;            \
+})
 
 // stop timer on change to state where timer does not run
 #define change_state(_s, _fsm, _new) ({                                \
@@ -169,6 +197,7 @@ enum {
 
 // Types
 typedef uint16_t sessionidt;
+typedef uint16_t bundleidt;
 typedef uint16_t tunnelidt;
 typedef uint32_t clockt;
 typedef uint8_t hasht[16];
@@ -214,25 +243,35 @@ typedef struct controls           // control message
 }
 controlt;
 
+typedef struct {
+       uint8_t length;                 // Endpoint Discriminator length
+       uint8_t addr_class;             // Endpoint Discriminator class
+       uint8_t address[MAXADDRESS];    // Endpoint Discriminator address
+} epdist;
+
+typedef struct {
+       uint16_t length;                // Fragment length
+       uint8_t data[MAXFRAGLEN];       // Fragment data
+} fragmentt;
+
 typedef struct
 {
        sessionidt next;                // next session in linked list
        sessionidt far;                 // far end session ID
        tunnelidt tunnel;               // near end tunnel ID
-       uint8_t l2tp_flags;             // various bit flags from the ICCN on the l2tp tunnel.
+       uint8_t flags;                  // session flags: see SESSION_*
        struct {
                uint8_t phase;          // PPP phase
                uint8_t lcp:4;          //   LCP    state
                uint8_t ipcp:4;         //   IPCP   state
                uint8_t ipv6cp:4;       //   IPV6CP state
                uint8_t ccp:4;          //   CCP    state
-               uint8_t pad;            // unused
        } ppp;
+       char reserved_1[2];             // unused: padding
        in_addr_t ip;                   // IP of session set by RADIUS response (host byte order).
        int ip_pool_index;              // index to IP pool
        uint32_t unique_id;             // unique session id
-       uint16_t nr;                    // next receive
-       uint16_t ns;                    // next send
+       char reserved_2[4];             // unused: was ns/nr
        uint32_t magic;                 // ppp magic number
        uint32_t pin, pout;             // packet counts
        uint32_t cin, cout;             // byte counts
@@ -257,15 +296,47 @@ typedef struct
        char calling[MAXTEL];           // calling number
        uint32_t tx_connect_speed;
        uint32_t rx_connect_speed;
+       clockt timeout;                 // Session timeout
+       uint32_t mrru;                  // Multilink Max-Receive-Reconstructed-Unit
+       uint8_t mssf;                   // Multilink Short Sequence Number Header Format
+       epdist epdis;                   // Multilink Endpoint Discriminator
+       bundleidt bundle;               // Multilink Bundle Identifier
        in_addr_t snoop_ip;             // Interception destination IP
        uint16_t snoop_port;            // Interception destination port
        uint8_t walled_garden;          // is this session gardened?
        uint8_t ipv6prefixlen;          // IPv6 route prefix length
        struct in6_addr ipv6route;      // Static IPv6 route
-       char reserved[11];              // Space to expand structure without changing HB_VERSION
+       char reserved_3[11];            // Space to expand structure without changing HB_VERSION
 }
 sessiont;
 
+typedef struct
+{
+       int state;                              // current state (bundlestate enum)
+       uint32_t seq_num_t;                     // Sequence Number (transmission)
+       uint32_t seq_num_m;                     // Last received frame sequence number (bearing B bit)
+       uint32_t offset;                        // Offset between sequence number and array index
+       uint8_t pending_frag;                   // Indicate that there is pending fragments to reassemble
+       uint8_t num_of_links;                   // Number of links joint to this bundle
+       uint32_t online_time;                   // The time this bundle is online
+       clockt last_check;                      // Last time the timeout is checked
+       uint32_t mrru;                          // Multilink Max-Receive-Reconstructed-Unit
+       uint8_t mssf;                           // Multilink Short Sequence Number Header Format
+       epdist epdis;                           // Multilink Endpoint Discriminator
+       char user[MAXUSER];                     // Needed for matching member links
+       sessionidt current_ses;                 // Current session to use for sending (used in RR load-balancing)
+       sessionidt members[MAXBUNDLESES];       // Array for member links sessions
+}
+bundlet;
+
+typedef struct
+{
+       fragmentt fragment[MAXFRAGNUM];
+       uint8_t reassembled_frame[MAXETHER];    // The reassembled frame
+       uint16_t re_frame_len;                  // The reassembled frame length
+}
+fragmentationt;
+
 #define AUTHPAP                1       // allow PAP
 #define AUTHCHAP       2       // allow CHAP
 
@@ -286,9 +357,24 @@ typedef struct
                int nak_sent;
        } lcp, ipcp, ipv6cp, ccp;
 
+       // identifier for Protocol-Reject, Code-Reject
+       uint8_t lcp_ident;
+
        // authentication to use
        int lcp_authtype;
 
+       // our MRU
+       uint16_t ppp_mru;
+
+       // our MRRU
+       uint16_t mp_mrru;
+
+       // our mssf
+       uint16_t mp_mssf;
+
+       // our Endpoint Discriminator
+       in_addr_t mp_epdis;
+
        // DoS prevention
        clockt last_packet_out;
        uint32_t packets_out;
@@ -299,10 +385,15 @@ typedef struct
 
        // interim RADIUS
        time_t last_interim;
+
+       // last LCP Echo
+       time_t last_echo;
 } sessionlocalt;
 
-#define        SESSIONPFC      1       // PFC negotiated flags
-#define        SESSIONACFC     2       // ACFC negotiated flags
+// session flags
+#define SESSION_PFC    (1 << 0)        // use Protocol-Field-Compression
+#define SESSION_ACFC   (1 << 1)        // use Address-and-Control-Field-Compression
+#define SESSION_STARTED        (1 << 2)        // RADIUS Start record sent
 
 // 168 bytes per tunnel
 typedef struct
@@ -315,7 +406,7 @@ typedef struct
        uint16_t ns;            // next send
        int state;              // current state (tunnelstate enum)
        clockt last;            // when last control message sent (used for resend timeout)
-       clockt retry;           // when to try resenting pending control
+       clockt retry;           // when to try resending pending control
        clockt die;             // being closed, when to finally free
        clockt lastrec;         // when the last control message was received
        char hostname[128];     // tunnel hostname
@@ -327,7 +418,7 @@ typedef struct
 }
 tunnelt;
 
-// 160 bytes per radius session
+// 164 bytes per radius session
 typedef struct                 // outstanding RADIUS requests
 {
        sessionidt session;     // which session this applies to
@@ -338,6 +429,8 @@ typedef struct                      // outstanding RADIUS requests
        uint8_t try;            // which try we are on
        uint8_t state;          // state of radius requests
        uint8_t chap;           // set if CHAP used (is CHAP identifier)
+       uint8_t term_cause;     // Stop record: Acct-Terminate-Cause
+       char const *term_msg;   //   terminate reason
 }
 radiust;
 
@@ -378,6 +471,23 @@ enum
        TUNNELUNDEF,            // Undefined
 };
 
+enum
+{
+       BUNDLEFREE,             // Not in use
+       BUNDLEOPEN,             // Active bundle
+       BUNDLEUNDEF,            // Undefined
+};
+
+enum
+{
+       NULLCLASS = 0,          //End Point Discriminator classes
+       LOCALADDR,
+       IPADDR,
+       IEEEMACADDR,
+       PPPMAGIC,
+       PSNDN,
+};
+
 enum
 {
        RADIUSNULL,             // Not in use
@@ -508,7 +618,9 @@ typedef struct
 
        char            tundevice[10];                  // tun device name
        char            log_filename[128];
-       char            l2tpsecret[64];
+
+       char            l2tp_secret[64];                // L2TP shared secret
+       int             l2tp_mtu;                       // MTU of interface used for L2TP
 
        char            random_device[256];             // random device path, defaults to RANDOMDEVICE
 
@@ -530,6 +642,7 @@ typedef struct
        int             radius_authprefer;
 
        int             allow_duplicate_users;          // allow multiple logins with the same username
+       char            guest_user[MAXUSER];            // allow multiple logins to guest account username
 
        in_addr_t       default_dns1, default_dns2;
 
@@ -541,7 +654,6 @@ typedef struct
        in_addr_t       peer_address;
        int             send_garp;                      // Set to true to garp for vip address on startup
 
-       int             target_uid;
        int             dump_speed;
        char            plugins[64][MAXPLUGINS];
        char            old_plugins[64][MAXPLUGINS];
@@ -552,6 +664,7 @@ typedef struct
        int             lock_pages;                     // Lock pages into memory.
        int             icmp_rate;                      // Max number of ICMP unreachable per second to send
        int             max_packets;                    // DoS prevention: per session limit of packets/0.1s
+       char            epdis_addr[20];                 // MP Endpoint Discriminator address
 
        in_addr_t       cluster_address;                // Multicast address of cluster.
                                                        // Send to this address to have everyone hear.
@@ -563,23 +676,24 @@ typedef struct
        int             cluster_seq_number;             // Sequence number of the next heartbeat we'll send out
                                                        // (or the seq number we're next expecting if we're a slave).
        int             cluster_undefined_sessions;     // How many sessions we're yet to receive from the master.
+       int             cluster_undefined_bundles;      // How many bundles we're yet to receive from the master.
        int             cluster_undefined_tunnels;      // How many tunnels we're yet to receive from the master.
        int             cluster_highest_sessionid;
+       int             cluster_highest_bundleid;
        int             cluster_highest_tunnelid;
        clockt          cluster_last_hb;                // Last time we saw a heartbeat from the master.
        int             cluster_last_hb_ver;            // Heartbeat version last seen from master
        int             cluster_num_changes;            // Number of changes queued.
 
+       int             cluster_mcast_ttl;              // TTL for multicast packets
        int             cluster_hb_interval;            // How often to send a heartbeat.
        int             cluster_hb_timeout;             // How many missed heartbeats trigger an election.
        uint64_t        cluster_table_version;          // # state changes processed by cluster
-
-       struct in6_addr ipv6_prefix;                    // Our IPv6 network pool.
-
-
        int             cluster_master_min_adv;         // Master advertises routes while the number of up to date
                                                        // slaves is less than this value.
 
+       struct in6_addr ipv6_prefix;                    // Our IPv6 network pool.
+
 #ifdef BGP
 #define BGP_NUM_PEERS  2
        uint16_t as_number;
@@ -592,7 +706,7 @@ typedef struct
 #endif
 } configt;
 
-enum config_typet { INT, STRING, UNSIGNED_LONG, SHORT, BOOL, IPv4, IPv6, MAC };
+enum config_typet { INT, STRING, UNSIGNED_LONG, SHORT, BOOL, IPv4, IPv6 };
 typedef struct
 {
        char *key;
@@ -653,6 +767,36 @@ typedef struct
        int used;               // session ref count
 } ip_filtert;
 
+// CDN result/error codes
+#define CDN_NONE                       0, 0
+#define CDN_TRY_ANOTHER                        2, 7
+#define CDN_ADMIN_DISC                 3, 0
+#define CDN_UNAVAILABLE                        4, 0
+
+// RADIUS Acct-Terminate-Cause values
+#define TERM_USER_REQUEST              1
+#define TERM_LOST_CARRIER              2
+#define TERM_LOST_SERVICE              3
+#define TERM_IDLE_TIMEOUT              4
+#define TERM_SESSION_TIMEOUT           5
+#define TERM_ADMIN_RESET               6
+#define TERM_ADMIN_REBOOT              7
+#define TERM_PORT_ERROR                        8
+#define TERM_NAS_ERROR                 9
+#define TERM_NAS_REQUEST               10
+#define TERM_NAS_REBOOT                        11
+#define TERM_PORT_UNNEEDED             12
+#define TERM_PORT_PREEMPTED            13
+#define TERM_PORT_SUSPENDED            14
+#define TERM_SERVICE_UNAVAILABLE       15
+#define TERM_CALLBACK                  16
+#define TERM_USER_ERROR                        17
+#define TERM_HOST_REQUEST              18
+#define TERM_SUPPLICANT_RESTART                19
+#define TERM_REAUTHENTICATION_FAILURE  20
+#define TERM_PORT_REINIT               21
+#define TERM_PORT_DISABLED             22
+
 // arp.c
 void sendarp(int ifr_idx, const unsigned char* mac, in_addr_t ip);
 
@@ -665,13 +809,17 @@ void processlcp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 void processipcp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 void processipv6cp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 void processipin(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
+void processmpin(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
+void processmpframe(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l, uint8_t extra);
 void processipv6in(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 void processccp(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l);
 void sendchap(sessionidt s, tunnelidt t);
-uint8_t *makeppp(uint8_t *b, int size, uint8_t *p, int l, sessionidt s, tunnelidt t, uint16_t mtype);
+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);
 void sendlcp(sessionidt s, tunnelidt t);
 void send_ipin(sessionidt s, uint8_t *buf, int len);
 void sendccp(sessionidt s, tunnelidt t);
+void protoreject(sessionidt s, tunnelidt t, uint8_t *p, uint16_t l, uint16_t proto);
+int join_bundle(sessionidt s);
 
 
 // radius.c
@@ -681,7 +829,7 @@ void processrad(uint8_t *buf, int len, char socket_index);
 void radiusretry(uint16_t r);
 uint16_t radiusnew(sessionidt s);
 void radiusclear(uint16_t r, sessionidt s);
-void processdae(uint8_t *buf, int len, struct sockaddr_in *addr, int alen);
+void processdae(uint8_t *buf, int len, struct sockaddr_in *addr, int alen, struct in_addr *local);
 
 
 // l2tpns.c
@@ -694,10 +842,12 @@ sessionidt sessionbyuser(char *username);
 void increment_counter(uint32_t *counter, uint32_t *wrap, uint32_t delta);
 void random_data(uint8_t *buf, int len);
 void sessionkill(sessionidt s, char *reason);
-void sessionshutdown(sessionidt s, char *reason, int result, int error);
+void sessionshutdown(sessionidt s, char const *reason, int cdn_result, int cdn_error, int term_cause);
 void filter_session(sessionidt s, int filter_in, int filter_out);
 void send_garp(in_addr_t ip);
 void tunnelsend(uint8_t *buf, uint16_t l, tunnelidt t);
+int tun_write(uint8_t *data, int size);
+void adjust_tcp_mss(sessionidt s, tunnelidt t, uint8_t *buf, int len, uint8_t *tcp);
 void sendipcp(sessionidt s, tunnelidt t);
 void sendipv6cp(sessionidt s, tunnelidt t);
 void processudp(uint8_t *buf, int len, struct sockaddr_in *addr);
@@ -716,6 +866,7 @@ int cmd_show_hist_open(struct cli_def *cli, char *command, char **argv, int argc
 void _log(int level, sessionidt s, tunnelidt t, const char *format, ...) __attribute__((format (printf, 4, 5)));
 void _log_hex(int level, const char *title, const uint8_t *data, int maxsize);
 
+
 int sessionsetup(sessionidt s, tunnelidt t);
 int run_plugins(int plugin_type, void *data);
 void rebuild_address_pool(void);
@@ -736,26 +887,12 @@ void host_unreachable(in_addr_t destination, uint16_t id, in_addr_t source, uint
 
 
 extern tunnelt *tunnel;
+extern bundlet *bundle;
 extern sessiont *session;
 extern sessionlocalt *sess_local;
 extern ippoolt *ip_address_pool;
 #define sessionfree (session[0].next)
 
-#define log_backtrace(count, max) \
-if (count++ < max) { \
-       void *array[20]; \
-       char **strings; \
-       int size, i; \
-       LOG(0, 0, t, "Backtrace follows:\n"); \
-       size = backtrace(array, 10); \
-       strings = backtrace_symbols(array, size); \
-       if (strings) for (i = 0; i < size; i++) \
-       { \
-               LOG(0, 0, t, " %s\n", strings[i]); \
-       } \
-       free(strings); \
-}
-
 
 extern configt *config;
 extern time_t basetime;                // Time when this process started.
@@ -764,7 +901,6 @@ extern char main_quit;
 extern uint32_t last_id;
 extern struct Tstats *_statistics;
 extern in_addr_t my_address;
-extern int tun_write(uint8_t *data, int size);
 extern int clifd;
 extern int epollfd;
 
@@ -784,6 +920,9 @@ struct event_data {
 
 #define TIME (config->current_time)
 
+extern uint16_t MRU;
+extern uint16_t MSS;
+
 // macros for handling help in cli commands
 #define CLI_HELP_REQUESTED     (argc > 0 && argv[argc-1][strlen(argv[argc-1])-1] == '?')
 #define CLI_HELP_NO_ARGS       (argc > 1 || argv[0][1]) ? CLI_OK : cli_arg_help(cli, 1, NULL)