2 // $Id: l2tpns.h,v 1.57 2005/02/14 06:58:39 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 5
26 #define RADIUS_MASK ((unsigned short)(((unsigned short)~0) >> (16 - RADIUS_SHIFT)))
27 #define MAXRADIUS ((unsigned long)(1L << RADIUS_SHIFT) * 255)
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 MAXPLUGINS 20 // maximum number of plugins to load
36 #define MAXRADSERVER 10 // max radius servers
37 #define MAXROUTE 10 // max static routes per session
38 #define MAXIPPOOL 131072 // max number of ip addresses in pool
39 #define RINGBUFFER_SIZE 10000 // Number of ringbuffer entries to allocate
40 #define MAX_LOG_LENGTH 512 // Maximum size of log message
41 #define ECHO_TIMEOUT 60 // Time between last packet sent and LCP ECHO generation
42 #define IDLE_TIMEOUT 240 // Time between last packet sent and LCP ECHO generation
43 #define BUSY_WAIT_TIME 3000 // 5 minutes in 1/10th seconds to wait for radius to cleanup on shutdown
47 #define ETCDIR "/etc/l2tpns"
51 #define LIBDIR "/usr/lib/l2tpns"
55 #define STATEDIR "/var/lib/l2tpns"
59 #define PLUGINDIR LIBDIR // Plugins
63 #define PLUGINCONF ETCDIR // Plugin config dir
67 #define FLASHDIR ETCDIR
71 #define DATADIR STATEDIR
74 #define TUNDEVICE "/dev/net/tun"
75 #define RANDOMDEVICE "/dev/urandom" // default, not as secure as /dev/random but non-blocking
76 #define STATEFILE DATADIR "/state.dump" // State dump file
77 #define CONFIGFILE FLASHDIR "/startup-config" // Configuration file
78 #define CLIUSERS FLASHDIR "/users" // CLI Users file
79 #define IPPOOLFILE FLASHDIR "/ip_pool" // Address pool configuration
80 #define ACCT_TIME 3000 // 5 minute accounting interval
81 #define ACCT_SHUT_TIME 600 // 1 minute for counters of shutdown sessions
82 #define L2TPPORT 1701 // L2TP port
83 #define RADPORT 1645 // old radius port...
84 #define PKTARP 0x0806 // ARP packet type
85 #define PKTIP 0x0800 // IPv4 packet type
86 #define PKTIPV6 0x86DD // IPv6 packet type
88 #define PPPCHAP 0xC223
90 #define PPPIPCP 0x8021
91 #define PPPIPV6CP 0x8057
94 #define PPPIPV6 0x0057
96 #define MIN_IP_SIZE 0x19
123 typedef uint16_t sessionidt
;
124 typedef uint16_t tunnelidt
;
125 typedef uint32_t clockt
;
126 typedef uint8_t hasht
[16];
129 struct cli_session_actions
{
139 #define CLI_SESS_KILL 0x01
140 #define CLI_SESS_SNOOP 0x02
141 #define CLI_SESS_NOSNOOP 0x04
142 #define CLI_SESS_THROTTLE 0x08
143 #define CLI_SESS_NOTHROTTLE 0x10
144 #define CLI_SESS_FILTER 0x20
145 #define CLI_SESS_NOFILTER 0x40
147 struct cli_tunnel_actions
{
151 #define CLI_TUN_KILL 0x01
153 // dump header: update number if internal format changes
154 #define DUMP_MAGIC "L2TPNS#" VERSION "#"
157 typedef struct // route
164 typedef struct controls
// control message
166 struct controls
*next
; // next in queue
167 uint16_t length
; // length
168 uint8_t buf
[MAXCONTROL
];
174 sessionidt next
; // next session in linked list
175 sessionidt far
; // far end session ID
176 tunnelidt tunnel
; // near end tunnel ID
177 in_addr_t ip
; // IP of session set by RADIUS response (host byte order).
178 int ip_pool_index
; // index to IP pool
179 unsigned long unique_id
; // unique session id
180 uint16_t nr
; // next receive
181 uint16_t ns
; // next send
182 uint32_t magic
; // ppp magic number
183 uint32_t cin
, cout
; // byte counts
184 uint32_t pin
, pout
; // packet counts
185 uint32_t total_cin
; // This counter is never reset while a session is open
186 uint32_t total_cout
; // This counter is never reset while a session is open
187 uint32_t id
; // session id
188 uint16_t throttle_in
; // upstream throttle rate (kbps)
189 uint16_t throttle_out
; // downstream throttle rate
190 clockt opened
; // when started
191 clockt die
; // being closed, when to finally free
192 time_t last_packet
; // Last packet from the user (used for idle timeouts)
193 in_addr_t dns1
, dns2
; // DNS servers
194 routet route
[MAXROUTE
]; // static routes
195 uint16_t radius
; // which radius session is being used (0 for not waiting on authentication)
196 uint16_t mru
; // maximum receive unit
197 uint16_t tbf_in
; // filter bucket for throttling in from the user.
198 uint16_t tbf_out
; // filter bucket for throttling out to the user.
199 uint8_t l2tp_flags
; // various bit flags from the ICCN on the l2tp tunnel.
200 uint8_t reserved_old_snoop
; // No longer used - remove at some time
201 uint8_t walled_garden
; // is this session gardened?
202 uint8_t flags1
; // additional flags (currently unused);
203 char random_vector
[MAXTEL
];
204 int random_vector_length
;
205 char user
[129]; // user (needed in seesion for radius stop messages) (can we reduce this? --mo)
206 char called
[MAXTEL
]; // called number
207 char calling
[MAXTEL
]; // calling number
208 uint32_t tx_connect_speed
;
209 uint32_t rx_connect_speed
;
210 uint32_t flags
; // Various session flags.
211 in_addr_t snoop_ip
; // Interception destination IP
212 uint16_t snoop_port
; // Interception destination port
213 uint16_t sid
; // near end session id.
214 uint8_t filter_in
; // input filter index (to ip_filters[N-1]; 0 if none)
215 uint8_t filter_out
; // output filter index
216 struct in6_addr ipv6route
; // Static IPv6 route
217 uint8_t ipv6prefixlen
; // IPv6 route prefix length
218 char reserved
[1]; // Space to expand structure without changing HB_VERSION
222 #define SF_IPCP_ACKED 1 // Has this session seen an IPCP Ack?
223 #define SF_LCP_ACKED 2 // LCP negotiated
224 #define SF_CCP_ACKED 4 // CCP negotiated
225 #define SF_IPV6CP_ACKED 8 // IPv6 negotiated
226 #define SF_IPV6_NACKED 16 // IPv6 rejected
227 #define SF_IPV6_ROUTED 32 // advertised v6 route
229 #define AUTHPAP 1 // allow PAP
230 #define AUTHCHAP 2 // allow CHAP
239 clockt last_packet_out
;
240 uint32_t packets_out
;
241 uint32_t packets_dropped
;
244 #define SESSIONPFC 1 // PFC negotiated flags
245 #define SESSIONACFC 2 // ACFC negotiated flags
247 // 168 bytes per tunnel
250 tunnelidt far
; // far end tunnel ID
251 in_addr_t ip
; // Ip for far end
252 uint16_t port
; // port for far end
253 uint16_t window
; // Rx window
254 uint16_t nr
; // next receive
255 uint16_t ns
; // next send
256 int state
; // current state (tunnelstate enum)
257 clockt last
; // when last control message sent (used for resend timeout)
258 clockt retry
; // when to try resenting pending control
259 clockt die
; // being closed, when to finally free
260 clockt lastrec
; // when the last control message was received
261 char hostname
[128]; // tunnel hostname
262 char vendor
[128]; // LAC vendor
263 uint8_t try; // number of retrys on a control message
264 uint16_t controlc
; // outstaind messages in queue
265 controlt
*controls
; // oldest message
266 controlt
*controle
; // newest message
270 // 180 bytes per radius session
271 typedef struct // outstanding RADIUS requests
273 sessionidt session
; // which session this applies to
274 hasht auth
; // request authenticator
275 clockt retry
; // when to try next
276 char calling
[MAXTEL
]; // calling number
277 char pass
[129]; // password
278 uint8_t id
; // ID for PPP response
279 uint8_t try; // which try we are on
280 uint8_t state
; // state of radius requests
281 uint8_t chap
; // set if CHAP used (is CHAP identifier)
287 in_addr_t address
; // Host byte order..
288 char assigned
; // 1 if assigned, 0 if free
290 clockt last
; // last used
291 char user
[129]; // user (try to have ip addresses persistent)
302 char message
[MAX_LOG_LENGTH
];
303 } buffer
[RINGBUFFER_SIZE
];
310 * Possible tunnel states
311 * TUNNELFREE -> TUNNELOPEN -> TUNNELDIE -> TUNNELFREE
315 TUNNELFREE
, // Not in use
316 TUNNELOPEN
, // Active tunnel
317 TUNNELDIE
, // Currently closing
318 TUNNELOPENING
, // Busy opening
319 TUNNELUNDEF
, // Undefined
324 RADIUSNULL
, // Not in use
325 RADIUSCHAP
, // sending CHAP down PPP
326 RADIUSAUTH
, // sending auth to RADIUS server
327 RADIUSIPCP
, // sending IPCP to end user
328 RADIUSSTART
, // sending start accounting to RADIUS server
329 RADIUSSTOP
, // sending stop accounting to RADIUS server
330 RADIUSWAIT
, // waiting timeout before available, in case delayed replies
331 RADIUSDEAD
, // errored while talking to radius server.
339 uint32_t tun_rx_packets
;
340 uint32_t tun_tx_packets
;
341 uint32_t tun_rx_bytes
;
342 uint32_t tun_tx_bytes
;
343 uint32_t tun_rx_errors
;
344 uint32_t tun_tx_errors
;
345 uint32_t tun_rx_dropped
;
347 uint32_t tunnel_rx_packets
;
348 uint32_t tunnel_tx_packets
;
349 uint32_t tunnel_rx_bytes
;
350 uint32_t tunnel_tx_bytes
;
351 uint32_t tunnel_rx_errors
;
352 uint32_t tunnel_tx_errors
;
354 uint32_t tunnel_retries
;
355 uint32_t radius_retries
;
359 uint32_t packets_snooped
;
361 uint32_t tunnel_created
;
362 uint32_t session_created
;
363 uint32_t tunnel_timeout
;
364 uint32_t session_timeout
;
365 uint32_t radius_timeout
;
366 uint32_t radius_overflow
;
367 uint32_t tunnel_overflow
;
368 uint32_t session_overflow
;
370 uint32_t ip_allocated
;
373 uint32_t c_forwarded
;
374 uint32_t recv_forward
;
376 uint32_t select_called
;
377 uint32_t multi_read_used
;
378 uint32_t multi_read_exceeded
;
381 uint32_t call_processtun
;
382 uint32_t call_processipout
;
383 uint32_t call_processipv6out
;
384 uint32_t call_processudp
;
385 uint32_t call_sessionbyip
;
386 uint32_t call_sessionbyipv6
;
387 uint32_t call_sessionbyuser
;
388 uint32_t call_sendarp
;
389 uint32_t call_sendipcp
;
390 uint32_t call_processipv6cp
;
391 uint32_t call_tunnelsend
;
392 uint32_t call_sessionkill
;
393 uint32_t call_sessionshutdown
;
394 uint32_t call_tunnelkill
;
395 uint32_t call_tunnelshutdown
;
396 uint32_t call_assign_ip_address
;
397 uint32_t call_free_ip_address
;
398 uint32_t call_dump_acct_info
;
399 uint32_t call_sessionsetup
;
400 uint32_t call_processpap
;
401 uint32_t call_processchap
;
402 uint32_t call_processlcp
;
403 uint32_t call_processipcp
;
404 uint32_t call_processipin
;
405 uint32_t call_processipv6in
;
406 uint32_t call_processccp
;
407 uint32_t call_sendchap
;
408 uint32_t call_processrad
;
409 uint32_t call_radiussend
;
410 uint32_t call_radiusretry
;
411 uint32_t call_random_data
;
418 #define CSTAT(x) STAT(call_ ## x)
423 #define STAT(x) (_statistics->x++)
424 #define INC_STAT(x,y) (_statistics->x += (y))
425 #define GET_STAT(x) (_statistics->x)
426 #define SET_STAT(x, y) (_statistics->x = (y))
430 #define INC_STAT(x,y)
431 #define GET_STAT(x) 0
432 #define SET_STAT(x, y)
437 int debug
; // debugging level
438 time_t start_time
; // time when l2tpns was started
439 char bandwidth
[256]; // current bandwidth
440 char pid_file
[256]; // file to write PID to on startup
442 clockt current_time
; // 1/10ths of a second since the process started.
443 // means that we can only run a given process
444 // for 13 years without re-starting!
446 char config_file
[128];
447 int reload_config
; // flag to re-read config (set by cli)
448 int cleanup_interval
; // interval between regular cleanups (in seconds)
449 int multi_read_count
; // amount of packets to read per fd in processing loop
451 char tundevice
[10]; // tun device name
452 char log_filename
[128];
455 char random_device
[256]; // random device path, defaults to RANDOMDEVICE
457 char radiussecret
[64];
458 int radius_accounting
;
459 in_addr_t radiusserver
[MAXRADSERVER
]; // radius servers
460 uint16_t radiusport
[MAXRADSERVER
]; // radius base ports
461 uint8_t numradiusservers
; // radius server count
462 short num_radfds
; // Number of radius filehandles allocated
464 char radius_authtypes_s
[32]; // list of valid authentication types (chap, pap) in order of preference
465 int radius_authtypes
;
466 int radius_authprefer
;
468 in_addr_t default_dns1
, default_dns2
;
470 unsigned long rl_rate
; // default throttle rate
471 int num_tbfs
; // number of throttle buckets
473 char accounting_dir
[128];
474 in_addr_t bind_address
;
475 in_addr_t peer_address
;
476 int send_garp
; // Set to true to garp for vip address on startup
480 char plugins
[64][MAXPLUGINS
];
481 char old_plugins
[64][MAXPLUGINS
];
483 int next_tbf
; // Next HTB id available to use
484 int scheduler_fifo
; // If the system has multiple CPUs, use FIFO scheduling policy for this process.
485 int lock_pages
; // Lock pages into memory.
486 int icmp_rate
; // Max number of ICMP unreachable per second to send
487 int max_packets
; // DoS prevention: per session limit of packets/0.1s
489 in_addr_t cluster_address
; // Multicast address of cluster.
490 // Send to this address to have everyone hear.
491 char cluster_interface
[64]; // Which interface to listen for multicast on.
492 int cluster_iam_master
; // Are we the cluster master???
493 int cluster_iam_uptodate
; // Set if we've got a full set of state from the master.
494 in_addr_t cluster_master_address
; // The network address of the cluster master.
495 // Zero if i am the cluster master.
496 int cluster_seq_number
; // Sequence number of the next heartbeat we'll send out
497 // (or the seq number we're next expecting if we're a slave).
498 int cluster_undefined_sessions
; // How many sessions we're yet to receive from the master.
499 int cluster_undefined_tunnels
; // How many tunnels we're yet to receive from the master.
500 int cluster_highest_sessionid
;
501 int cluster_highest_tunnelid
;
502 clockt cluster_last_hb
; // Last time we saw a heartbeat from the 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 #define BGP_NUM_PEERS 2
519 } neighbour
[BGP_NUM_PEERS
];
523 enum config_typet
{ INT
, STRING
, UNSIGNED_LONG
, SHORT
, BOOL
, IPv4
, IPv6
, MAC
};
529 enum config_typet type
;
534 uint8_t op
; // operation
535 #define FILTER_PORT_OP_NONE 0 // all ports match
536 #define FILTER_PORT_OP_EQ 1
537 #define FILTER_PORT_OP_NEQ 2
538 #define FILTER_PORT_OP_GT 3
539 #define FILTER_PORT_OP_LT 4
540 #define FILTER_PORT_OP_RANGE 5
541 uint16_t port
; // port (host byte order)
542 uint16_t port2
; // range
547 int action
; // permit/deny
548 #define FILTER_ACTION_DENY 1
549 #define FILTER_ACTION_PERMIT 2
550 uint8_t proto
; // protocol: IPPROTO_* (netinet/in.h)
551 in_addr_t src_ip
; // source ip (network byte order)
553 ip_filter_portt src_ports
;
554 in_addr_t dst_ip
; // dest ip
556 ip_filter_portt dst_ports
;
557 uint8_t frag
; // apply to non-initial fragments
558 uint8_t tcp_flag_op
; // match type: any, all, established
559 #define FILTER_FLAG_OP_ANY 1
560 #define FILTER_FLAG_OP_ALL 2
561 #define FILTER_FLAG_OP_EST 3
562 uint8_t tcp_sflags
; // flags set
563 uint8_t tcp_cflags
; // flags clear
564 uint32_t counter
; // match count
567 #define TCP_FLAG_FIN 0x01
568 #define TCP_FLAG_SYN 0x02
569 #define TCP_FLAG_RST 0x04
570 #define TCP_FLAG_PSH 0x08
571 #define TCP_FLAG_ACK 0x10
572 #define TCP_FLAG_URG 0x20
575 #define MAXFILTER_RULES 32
578 char name
[32]; // ACL name
579 int extended
; // type: 0 = standard, 1 = extended
580 ip_filter_rulet rules
[MAXFILTER_RULES
];
581 int used
; // session ref count
585 void sendarp(int ifr_idx
, const unsigned char* mac
, in_addr_t ip
);
589 void processpap(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
590 void processchap(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
591 void processlcp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
592 void processipcp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
593 void processipv6cp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
594 void processipin(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
595 void processipv6in(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
596 void processccp(tunnelidt t
, sessionidt s
, uint8_t *p
, uint16_t l
);
597 void sendchap(tunnelidt t
, sessionidt s
);
598 uint8_t *makeppp(uint8_t *b
, int size
, uint8_t *p
, int l
, tunnelidt t
, sessionidt s
, uint16_t mtype
);
599 void initlcp(tunnelidt t
, sessionidt s
);
600 void send_ipin(sessionidt s
, uint8_t *buf
, int len
);
605 void radiussend(uint16_t r
, uint8_t state
);
606 void processrad(uint8_t *buf
, int len
, char socket_index
);
607 void radiusretry(uint16_t r
);
608 uint16_t radiusnew(sessionidt s
);
609 void radiusclear(uint16_t r
, sessionidt s
);
613 clockt
backoff(uint8_t try);
614 void send_ipv6_ra(tunnelidt t
, sessionidt s
, struct in6_addr
*ip
);
615 void route6set(sessionidt s
, struct in6_addr ip
, int prefixlen
, int add
);
616 sessionidt
sessionbyip(in_addr_t ip
);
617 sessionidt
sessionbyipv6(struct in6_addr ip
);
618 sessionidt
sessionbyuser(char *username
);
619 void random_data(uint8_t *buf
, int len
);
620 void sessionkill(sessionidt s
, char *reason
);
621 void sessionshutdown(sessionidt s
, char *reason
);
622 void send_garp(in_addr_t ip
);
623 void tunnelsend(uint8_t *buf
, uint16_t l
, tunnelidt t
);
624 void sendipcp(tunnelidt t
, sessionidt s
);
625 void processudp(uint8_t *buf
, int len
, struct sockaddr_in
*addr
);
626 void snoop_send_packet(char *packet
, uint16_t size
, in_addr_t destination
, uint16_t port
);
627 int ip_filter(uint8_t *buf
, int len
, uint8_t filter
);
628 int cmd_show_ipcache(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
629 int cmd_show_hist_idle(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
630 int cmd_show_hist_open(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
634 #define LOG(D, s, t, f, ...) ({ if (D <= config->debug) _log(D, s, t, f, ## __VA_ARGS__); })
635 #define LOG_HEX(D, t, d, s) ({ if (D <= config->debug) _log_hex(D, t, d, s); })
637 void _log(int level
, sessionidt s
, tunnelidt t
, const char *format
, ...) __attribute__((format (printf
, 4, 5)));
638 void _log_hex(int level
, const char *title
, const char *data
, int maxsize
);
640 int sessionsetup(tunnelidt t
, sessionidt s
);
641 int run_plugins(int plugin_type
, void *data
);
642 void rebuild_address_pool(void);
643 void throttle_session(sessionidt s
, int rate_in
, int rate_out
);
644 int load_session(sessionidt
, sessiont
*);
645 void become_master(void); // We're the master; kick off any required master initializations.
649 void init_cli(char *hostname
);
650 void cli_do_file(FILE *fh
);
651 void cli_do(int sockfd
);
652 int cli_arg_help(struct cli_def
*cli
, int cr_ok
, char *entry
, ...);
656 void host_unreachable(in_addr_t destination
, uint16_t id
, in_addr_t source
, char *packet
, int packet_len
);
659 extern tunnelt
*tunnel
;
660 extern sessiont
*session
;
661 extern sessionlocalt
*sess_local
;
662 extern ippoolt
*ip_address_pool
;
663 #define sessionfree (session[0].next)
665 #define log_backtrace(count, max) \
666 if (count++ < max) { \
670 LOG(0, 0, t, "Backtrace follows"); \
671 size = backtrace(array, 10); \
672 strings = backtrace_symbols(array, size); \
673 if (strings) for (i = 0; i < size; i++) \
675 LOG(0, 0, t, "%s\n", strings[i]); \
681 extern configt
*config
;
682 extern time_t basetime
; // Time when this process started.
683 extern time_t time_now
; // Seconds since EPOCH.
684 extern uint32_t last_id
;
685 extern struct Tstats
*_statistics
;
686 extern in_addr_t my_address
;
687 extern int tun_write(uint8_t *data
, int size
);
691 #define TIME (config->current_time)
693 // macros for handling help in cli commands
694 #define CLI_HELP_REQUESTED (argc > 0 && argv[argc-1][strlen(argv[argc-1])-1] == '?')
695 #define CLI_HELP_NO_ARGS (argc > 1 || argv[0][1]) ? CLI_OK : cli_arg_help(cli, 1, NULL)
697 // CVS identifiers (for "show version file")
698 extern char const *cvs_id_arp
;
699 extern char const *cvs_id_cli
;
700 extern char const *cvs_id_cluster
;
701 extern char const *cvs_id_constants
;
702 extern char const *cvs_id_control
;
703 extern char const *cvs_id_icmp
;
704 extern char const *cvs_id_l2tpns
;
705 extern char const *cvs_id_ll
;
706 extern char const *cvs_id_md5
;
707 extern char const *cvs_id_ppp
;
708 extern char const *cvs_id_radius
;
709 extern char const *cvs_id_tbf
;
710 extern char const *cvs_id_util
;
712 #endif /* __L2TPNS_H__ */