2 // $Id: l2tpns.h,v 1.75 2005-06-02 11:32:31 bodea Exp $
7 #include <netinet/in.h>
12 #include <netinet/in.h>
13 #include <sys/socket.h>
14 #include <arpa/inet.h>
15 #include <sys/types.h>
18 #define VERSION "2.1.0"
21 #define MAXTUNNEL 500 // could be up to 65535
22 #define MAXSESSION 60000 // could be up to 65535
23 #define MAXTBFS 6000 // Maximum token bucket filters. Might need up to 2 * session.
25 #define RADIUS_SHIFT 6
26 #define RADIUS_MASK ((1 << RADIUS_SHIFT) - 1)
27 #define MAXRADIUS (1 << (8 + RADIUS_SHIFT))
29 #define T_UNDEF (0xffff) // A tunnel ID that won't ever be used. Mark session as undefined.
30 #define T_FREE (0) // A tunnel ID that won't ever be used. Mark session as free.
32 #define MAXCONTROL 1000 // max length control message we ever send...
33 #define MAXETHER (1500+18) // max packet we try sending to tun
34 #define MAXTEL 96 // telephone number
35 #define MAXUSER 128 // username
36 #define MAXPASS 128 // password
37 #define MAXPLUGINS 20 // maximum number of plugins to load
38 #define MAXRADSERVER 10 // max radius servers
39 #define MAXROUTE 10 // max static routes per session
40 #define MAXIPPOOL 131072 // max number of ip addresses in pool
41 #define RINGBUFFER_SIZE 10000 // Number of ringbuffer entries to allocate
42 #define MAX_LOG_LENGTH 512 // Maximum size of log message
43 #define ECHO_TIMEOUT 60 // Time between last packet sent and LCP ECHO generation
44 #define IDLE_TIMEOUT 240 // Time between last packet sent and LCP ECHO generation
45 #define BUSY_WAIT_TIME 3000 // 5 minutes in 1/10th seconds to wait for radius to cleanup on shutdown
46 #define DEFAULT_MRU 1452 // maximum packet size to avoid fragmentation when LNS ethernet MTU is 1500
50 #define ETCDIR "/etc/l2tpns"
54 #define LIBDIR "/usr/lib/l2tpns"
58 #define PLUGINDIR LIBDIR // Plugins
62 #define PLUGINCONF ETCDIR // Plugin config dir
66 #define FLASHDIR ETCDIR
69 #define TUNDEVICE "/dev/net/tun"
70 #define RANDOMDEVICE "/dev/urandom" // default, not as secure as /dev/random but non-blocking
71 #define CONFIGFILE FLASHDIR "/startup-config" // Configuration file
72 #define CLIUSERS FLASHDIR "/users" // CLI Users file
73 #define IPPOOLFILE FLASHDIR "/ip_pool" // Address pool configuration
74 #define ACCT_TIME 3000 // 5 minute accounting interval
75 #define ACCT_SHUT_TIME 600 // 1 minute for counters of shutdown sessions
76 #define L2TPPORT 1701 // L2TP port
77 #define RADPORT 1645 // old radius port...
78 #define PKTARP 0x0806 // ARP packet type
79 #define PKTIP 0x0800 // IPv4 packet type
80 #define PKTIPV6 0x86DD // IPv6 packet type
82 #define PPPCHAP 0xC223
84 #define PPPIPCP 0x8021
85 #define PPPIPV6CP 0x8057
88 #define PPPIPV6 0x0057
90 #define MIN_IP_SIZE 0x19
117 typedef uint16_t sessionidt
;
118 typedef uint16_t tunnelidt
;
119 typedef uint32_t clockt
;
120 typedef uint8_t hasht
[16];
123 struct cli_session_actions
{
133 #define CLI_SESS_KILL 0x01
134 #define CLI_SESS_SNOOP 0x02
135 #define CLI_SESS_NOSNOOP 0x04
136 #define CLI_SESS_THROTTLE 0x08
137 #define CLI_SESS_NOTHROTTLE 0x10
138 #define CLI_SESS_FILTER 0x20
139 #define CLI_SESS_NOFILTER 0x40
141 struct cli_tunnel_actions
{
145 #define CLI_TUN_KILL 0x01
148 typedef struct // route
155 typedef struct controls
// control message
157 struct controls
*next
; // next in queue
158 uint16_t length
; // length
159 uint8_t buf
[MAXCONTROL
];
165 sessionidt next
; // next session in linked list
166 sessionidt far
; // far end session ID
167 tunnelidt tunnel
; // near end tunnel ID
168 uint8_t l2tp_flags
; // various bit flags from the ICCN on the l2tp tunnel.
169 uint8_t flags
; // Various session flags.
170 in_addr_t ip
; // IP of session set by RADIUS response (host byte order).
171 int ip_pool_index
; // index to IP pool
172 uint32_t unique_id
; // unique session id
173 uint16_t nr
; // next receive
174 uint16_t ns
; // next send
175 uint32_t magic
; // ppp magic number
176 uint32_t pin
, pout
; // packet counts
177 uint32_t cin
, cout
; // byte counts
178 uint32_t cin_wrap
, cout_wrap
; // byte counter wrap count (RADIUS accounting giagawords)
179 uint32_t cin_delta
, cout_delta
; // byte count changes (for dump_session())
180 uint16_t throttle_in
; // upstream throttle rate (kbps)
181 uint16_t throttle_out
; // downstream throttle rate
182 uint8_t filter_in
; // input filter index (to ip_filters[N-1]; 0 if none)
183 uint8_t filter_out
; // output filter index
184 uint16_t mru
; // maximum receive unit
185 clockt opened
; // when started
186 clockt die
; // being closed, when to finally free
187 time_t last_packet
; // Last packet from the user (used for idle timeouts)
188 in_addr_t dns1
, dns2
; // DNS servers
189 routet route
[MAXROUTE
]; // static routes
190 uint16_t tbf_in
; // filter bucket for throttling in from the user.
191 uint16_t tbf_out
; // filter bucket for throttling out to the user.
192 int random_vector_length
;
193 char random_vector
[MAXTEL
];
194 char user
[MAXUSER
]; // user (needed in seesion for radius stop messages)
195 char called
[MAXTEL
]; // called number
196 char calling
[MAXTEL
]; // calling number
197 uint32_t tx_connect_speed
;
198 uint32_t rx_connect_speed
;
199 in_addr_t snoop_ip
; // Interception destination IP
200 uint16_t snoop_port
; // Interception destination port
201 uint8_t walled_garden
; // is this session gardened?
202 uint8_t ipv6prefixlen
; // IPv6 route prefix length
203 struct in6_addr ipv6route
; // Static IPv6 route
204 char reserved
[16]; // Space to expand structure without changing HB_VERSION
208 #define SF_IPCP_ACKED 1 // Has this session seen an IPCP Ack?
209 #define SF_LCP_ACKED 2 // LCP negotiated
210 #define SF_CCP_ACKED 4 // CCP negotiated
211 #define SF_IPV6CP_ACKED 8 // IPv6 negotiated
212 #define SF_IPV6_NACKED 16 // IPv6 rejected
213 #define SF_IPV6_ROUTED 32 // advertised v6 route
215 #define AUTHPAP 1 // allow PAP
216 #define AUTHCHAP 2 // allow CHAP
229 clockt last_packet_out
;
230 uint32_t packets_out
;
231 uint32_t packets_dropped
;
233 // RADIUS session in use
240 #define SESSIONPFC 1 // PFC negotiated flags
241 #define SESSIONACFC 2 // ACFC negotiated flags
243 // 168 bytes per tunnel
246 tunnelidt far
; // far end tunnel ID
247 in_addr_t ip
; // Ip for far end
248 uint16_t port
; // port for far end
249 uint16_t window
; // Rx window
250 uint16_t nr
; // next receive
251 uint16_t ns
; // next send
252 int state
; // current state (tunnelstate enum)
253 clockt last
; // when last control message sent (used for resend timeout)
254 clockt retry
; // when to try resenting pending control
255 clockt die
; // being closed, when to finally free
256 clockt lastrec
; // when the last control message was received
257 char hostname
[128]; // tunnel hostname
258 char vendor
[128]; // LAC vendor
259 uint8_t try; // number of retrys on a control message
260 uint16_t controlc
; // outstaind messages in queue
261 controlt
*controls
; // oldest message
262 controlt
*controle
; // newest message
266 // 180 bytes per radius session
267 typedef struct // outstanding RADIUS requests
269 sessionidt session
; // which session this applies to
270 hasht auth
; // request authenticator
271 clockt retry
; // when to try next
272 char calling
[MAXTEL
]; // calling number
273 char pass
[129]; // password
274 uint8_t id
; // ID for PPP response
275 uint8_t try; // which try we are on
276 uint8_t state
; // state of radius requests
277 uint8_t chap
; // set if CHAP used (is CHAP identifier)
283 in_addr_t address
; // Host byte order..
284 char assigned
; // 1 if assigned, 0 if free
286 clockt last
; // last used
287 char user
[129]; // user (try to have ip addresses persistent)
298 char message
[MAX_LOG_LENGTH
];
299 } buffer
[RINGBUFFER_SIZE
];
306 * Possible tunnel states
307 * TUNNELFREE -> TUNNELOPEN -> TUNNELDIE -> TUNNELFREE
311 TUNNELFREE
, // Not in use
312 TUNNELOPEN
, // Active tunnel
313 TUNNELDIE
, // Currently closing
314 TUNNELOPENING
, // Busy opening
315 TUNNELUNDEF
, // Undefined
320 RADIUSNULL
, // Not in use
321 RADIUSCHAP
, // sending CHAP down PPP
322 RADIUSAUTH
, // sending auth to RADIUS server
323 RADIUSIPCP
, // sending IPCP to end user
324 RADIUSSTART
, // sending start accounting to RADIUS server
325 RADIUSSTOP
, // sending stop accounting to RADIUS server
326 RADIUSINTERIM
, // sending interim accounting to RADIUS server
327 RADIUSWAIT
, // waiting timeout before available, in case delayed replies
335 uint32_t tun_rx_packets
;
336 uint32_t tun_tx_packets
;
337 uint32_t tun_rx_bytes
;
338 uint32_t tun_tx_bytes
;
339 uint32_t tun_rx_errors
;
340 uint32_t tun_tx_errors
;
341 uint32_t tun_rx_dropped
;
343 uint32_t tunnel_rx_packets
;
344 uint32_t tunnel_tx_packets
;
345 uint32_t tunnel_rx_bytes
;
346 uint32_t tunnel_tx_bytes
;
347 uint32_t tunnel_rx_errors
;
348 uint32_t tunnel_tx_errors
;
350 uint32_t tunnel_retries
;
351 uint32_t radius_retries
;
355 uint32_t packets_snooped
;
357 uint32_t tunnel_created
;
358 uint32_t session_created
;
359 uint32_t tunnel_timeout
;
360 uint32_t session_timeout
;
361 uint32_t radius_timeout
;
362 uint32_t radius_overflow
;
363 uint32_t tunnel_overflow
;
364 uint32_t session_overflow
;
366 uint32_t ip_allocated
;
369 uint32_t c_forwarded
;
370 uint32_t recv_forward
;
372 uint32_t select_called
;
373 uint32_t multi_read_used
;
374 uint32_t multi_read_exceeded
;
377 uint32_t call_processtun
;
378 uint32_t call_processipout
;
379 uint32_t call_processipv6out
;
380 uint32_t call_processudp
;
381 uint32_t call_sessionbyip
;
382 uint32_t call_sessionbyipv6
;
383 uint32_t call_sessionbyuser
;
384 uint32_t call_sendarp
;
385 uint32_t call_sendipcp
;
386 uint32_t call_processipv6cp
;
387 uint32_t call_tunnelsend
;
388 uint32_t call_sessionkill
;
389 uint32_t call_sessionshutdown
;
390 uint32_t call_tunnelkill
;
391 uint32_t call_tunnelshutdown
;
392 uint32_t call_assign_ip_address
;
393 uint32_t call_free_ip_address
;
394 uint32_t call_dump_acct_info
;
395 uint32_t call_sessionsetup
;
396 uint32_t call_processpap
;
397 uint32_t call_processchap
;
398 uint32_t call_processlcp
;
399 uint32_t call_processipcp
;
400 uint32_t call_processipin
;
401 uint32_t call_processipv6in
;
402 uint32_t call_processccp
;
403 uint32_t call_sendchap
;
404 uint32_t call_processrad
;
405 uint32_t call_radiussend
;
406 uint32_t call_radiusretry
;
407 uint32_t call_random_data
;
414 #define CSTAT(x) STAT(call_ ## x)
419 #define STAT(x) (_statistics->x++)
420 #define INC_STAT(x,y) (_statistics->x += (y))
421 #define GET_STAT(x) (_statistics->x)
422 #define SET_STAT(x, y) (_statistics->x = (y))
426 #define INC_STAT(x,y)
427 #define GET_STAT(x) 0
428 #define SET_STAT(x, y)
433 int debug
; // debugging level
434 time_t start_time
; // time when l2tpns was started
435 char bandwidth
[256]; // current bandwidth
436 char pid_file
[256]; // file to write PID to on startup
438 clockt current_time
; // 1/10ths of a second since the process started.
439 // means that we can only run a given process
440 // for 13 years without re-starting!
442 char config_file
[128];
443 int reload_config
; // flag to re-read config (set by cli)
444 int multi_read_count
; // amount of packets to read per fd in processing loop
446 char tundevice
[10]; // tun device name
447 char log_filename
[128];
450 char random_device
[256]; // random device path, defaults to RANDOMDEVICE
452 char radiussecret
[64];
453 int radius_accounting
;
455 in_addr_t radiusserver
[MAXRADSERVER
]; // radius servers
456 uint16_t radiusport
[MAXRADSERVER
]; // radius base ports
457 uint8_t numradiusservers
; // radius server count
458 short num_radfds
; // Number of radius filehandles allocated
460 char radius_authtypes_s
[32]; // list of valid authentication types (chap, pap) in order of preference
461 int radius_authtypes
;
462 int radius_authprefer
;
464 int allow_duplicate_users
; // allow multiple logins with the same username
466 in_addr_t default_dns1
, default_dns2
;
468 unsigned long rl_rate
; // default throttle rate
469 int num_tbfs
; // number of throttle buckets
471 char accounting_dir
[128];
472 in_addr_t bind_address
;
473 in_addr_t peer_address
;
474 int send_garp
; // Set to true to garp for vip address on startup
478 char plugins
[64][MAXPLUGINS
];
479 char old_plugins
[64][MAXPLUGINS
];
481 int next_tbf
; // Next HTB id available to use
482 int scheduler_fifo
; // If the system has multiple CPUs, use FIFO scheduling
483 // policy for this process.
484 int lock_pages
; // Lock pages into memory.
485 int icmp_rate
; // Max number of ICMP unreachable per second to send
486 int max_packets
; // DoS prevention: per session limit of packets/0.1s
488 in_addr_t cluster_address
; // Multicast address of cluster.
489 // Send to this address to have everyone hear.
490 char cluster_interface
[64]; // Which interface to listen for multicast on.
491 int cluster_iam_master
; // Are we the cluster master???
492 int cluster_iam_uptodate
; // Set if we've got a full set of state from the master.
493 in_addr_t cluster_master_address
; // The network address of the cluster master.
494 // Zero if i am the cluster master.
495 int cluster_seq_number
; // Sequence number of the next heartbeat we'll send out
496 // (or the seq number we're next expecting if we're a slave).
497 int cluster_undefined_sessions
; // How many sessions we're yet to receive from the master.
498 int cluster_undefined_tunnels
; // How many tunnels we're yet to receive from the master.
499 int cluster_highest_sessionid
;
500 int cluster_highest_tunnelid
;
501 clockt cluster_last_hb
; // Last time we saw a heartbeat from the master.
502 int cluster_last_hb_ver
; // Heartbeat version last seen from master
503 int cluster_num_changes
; // Number of changes queued.
505 int cluster_hb_interval
; // How often to send a heartbeat.
506 int cluster_hb_timeout
; // How many missed heartbeats trigger an election.
507 uint64_t cluster_table_version
; // # state changes processed by cluster
509 struct in6_addr ipv6_prefix
; // Our IPv6 network pool.
512 int cluster_master_min_adv
; // Master advertises routes while the number of up to date
513 // slaves is less than this value.
516 #define BGP_NUM_PEERS 2
523 } neighbour
[BGP_NUM_PEERS
];
527 enum config_typet
{ INT
, STRING
, UNSIGNED_LONG
, SHORT
, BOOL
, IPv4
, IPv6
, MAC
};
533 enum config_typet type
;
538 uint8_t op
; // operation
539 #define FILTER_PORT_OP_NONE 0 // all ports match
540 #define FILTER_PORT_OP_EQ 1
541 #define FILTER_PORT_OP_NEQ 2
542 #define FILTER_PORT_OP_GT 3
543 #define FILTER_PORT_OP_LT 4
544 #define FILTER_PORT_OP_RANGE 5
545 uint16_t port
; // port (host byte order)
546 uint16_t port2
; // range
551 int action
; // permit/deny
552 #define FILTER_ACTION_DENY 1
553 #define FILTER_ACTION_PERMIT 2
554 uint8_t proto
; // protocol: IPPROTO_* (netinet/in.h)
555 in_addr_t src_ip
; // source ip (network byte order)
557 ip_filter_portt src_ports
;
558 in_addr_t dst_ip
; // dest ip
560 ip_filter_portt dst_ports
;
561 uint8_t frag
; // apply to non-initial fragments
562 uint8_t tcp_flag_op
; // match type: any, all, established
563 #define FILTER_FLAG_OP_ANY 1
564 #define FILTER_FLAG_OP_ALL 2
565 #define FILTER_FLAG_OP_EST 3
566 uint8_t tcp_sflags
; // flags set
567 uint8_t tcp_cflags
; // flags clear
568 uint32_t counter
; // match count
571 #define TCP_FLAG_FIN 0x01
572 #define TCP_FLAG_SYN 0x02
573 #define TCP_FLAG_RST 0x04
574 #define TCP_FLAG_PSH 0x08
575 #define TCP_FLAG_ACK 0x10
576 #define TCP_FLAG_URG 0x20
579 #define MAXFILTER_RULES 32
582 char name
[32]; // ACL name
583 int extended
; // type: 0 = standard, 1 = extended
584 ip_filter_rulet rules
[MAXFILTER_RULES
];
585 int used
; // session ref count
589 void sendarp(int ifr_idx
, const unsigned char* mac
, in_addr_t ip
);
593 void processpap(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
594 void processchap(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
595 void processlcp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
596 void processipcp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
597 void processipv6cp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
598 void processipin(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
599 void processipv6in(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
600 void processccp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
601 void sendchap(tunnelidt t
, sessionidt s
);
602 uint8_t *makeppp(uint8_t *b
, int size
, uint8_t *p
, int l
, tunnelidt t
, sessionidt s
, uint16_t mtype
);
603 void sendlcp(tunnelidt t
, sessionidt s
, int authtype
);
604 void send_ipin(sessionidt s
, uint8_t *buf
, int len
);
609 void radiussend(uint16_t r
, uint8_t state
);
610 void processrad(uint8_t *buf
, int len
, char socket_index
);
611 void radiusretry(uint16_t r
);
612 uint16_t radiusnew(sessionidt s
);
613 void radiusclear(uint16_t r
, sessionidt s
);
617 clockt
backoff(uint8_t try);
618 void send_ipv6_ra(tunnelidt t
, sessionidt s
, struct in6_addr
*ip
);
619 void route6set(sessionidt s
, struct in6_addr ip
, int prefixlen
, int add
);
620 sessionidt
sessionbyip(in_addr_t ip
);
621 sessionidt
sessionbyipv6(struct in6_addr ip
);
622 sessionidt
sessionbyuser(char *username
);
623 void increment_counter(uint32_t *counter
, uint32_t *wrap
, uint32_t delta
);
624 void random_data(uint8_t *buf
, int len
);
625 void sessionkill(sessionidt s
, char *reason
);
626 void sessionshutdown(sessionidt s
, char *reason
, int result
, int error
);
627 void send_garp(in_addr_t ip
);
628 void tunnelsend(uint8_t *buf
, uint16_t l
, tunnelidt t
);
629 void sendipcp(tunnelidt t
, sessionidt s
);
630 void processudp(uint8_t *buf
, int len
, struct sockaddr_in
*addr
);
631 void snoop_send_packet(char *packet
, uint16_t size
, in_addr_t destination
, uint16_t port
);
632 int ip_filter(uint8_t *buf
, int len
, uint8_t filter
);
633 int cmd_show_ipcache(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
634 int cmd_show_hist_idle(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
635 int cmd_show_hist_open(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
639 #define LOG(D, s, t, f, ...) ({ if (D <= config->debug) _log(D, s, t, f, ## __VA_ARGS__); })
640 #define LOG_HEX(D, t, d, s) ({ if (D <= config->debug) _log_hex(D, t, d, s); })
642 void _log(int level
, sessionidt s
, tunnelidt t
, const char *format
, ...) __attribute__((format (printf
, 4, 5)));
643 void _log_hex(int level
, const char *title
, const char *data
, int maxsize
);
645 int sessionsetup(tunnelidt t
, sessionidt s
);
646 int run_plugins(int plugin_type
, void *data
);
647 void rebuild_address_pool(void);
648 void throttle_session(sessionidt s
, int rate_in
, int rate_out
);
649 int load_session(sessionidt
, sessiont
*);
650 void become_master(void); // We're the master; kick off any required master initializations.
654 void init_cli(char *hostname
);
655 void cli_do_file(FILE *fh
);
656 void cli_do(int sockfd
);
657 int cli_arg_help(struct cli_def
*cli
, int cr_ok
, char *entry
, ...);
661 void host_unreachable(in_addr_t destination
, uint16_t id
, in_addr_t source
, char *packet
, int packet_len
);
664 extern tunnelt
*tunnel
;
665 extern sessiont
*session
;
666 extern sessionlocalt
*sess_local
;
667 extern ippoolt
*ip_address_pool
;
668 #define sessionfree (session[0].next)
670 #define log_backtrace(count, max) \
671 if (count++ < max) { \
675 LOG(0, 0, t, "Backtrace follows"); \
676 size = backtrace(array, 10); \
677 strings = backtrace_symbols(array, size); \
678 if (strings) for (i = 0; i < size; i++) \
680 LOG(0, 0, t, "%s\n", strings[i]); \
686 extern configt
*config
;
687 extern time_t basetime
; // Time when this process started.
688 extern time_t time_now
; // Seconds since EPOCH.
689 extern char main_quit
;
690 extern uint32_t last_id
;
691 extern struct Tstats
*_statistics
;
692 extern in_addr_t my_address
;
693 extern int tun_write(uint8_t *data
, int size
);
697 #define TIME (config->current_time)
699 // macros for handling help in cli commands
700 #define CLI_HELP_REQUESTED (argc > 0 && argv[argc-1][strlen(argv[argc-1])-1] == '?')
701 #define CLI_HELP_NO_ARGS (argc > 1 || argv[0][1]) ? CLI_OK : cli_arg_help(cli, 1, NULL)
703 // CVS identifiers (for "show version file")
704 extern char const *cvs_id_arp
;
705 extern char const *cvs_id_cli
;
706 extern char const *cvs_id_cluster
;
707 extern char const *cvs_id_constants
;
708 extern char const *cvs_id_control
;
709 extern char const *cvs_id_icmp
;
710 extern char const *cvs_id_l2tpns
;
711 extern char const *cvs_id_ll
;
712 extern char const *cvs_id_md5
;
713 extern char const *cvs_id_ppp
;
714 extern char const *cvs_id_radius
;
715 extern char const *cvs_id_tbf
;
716 extern char const *cvs_id_util
;
718 #endif /* __L2TPNS_H__ */