2 // $Id: l2tpns.h,v 1.45 2004-12-03 06:40:02 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.0.13"
21 #define MAXTUNNEL 500 // could be up to 65535
22 #define MAXSESSION 50000 // 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 STATEFILE DATADIR "/state.dump" // State dump file
76 #define CONFIGFILE FLASHDIR "/startup-config" // Configuration file
77 #define CLIUSERS FLASHDIR "/users" // CLI Users file
78 #define IPPOOLFILE FLASHDIR "/ip_pool" // Address pool configuration
79 #define ACCT_TIME 3000 // 5 minute accounting interval
80 #define L2TPPORT 1701 // L2TP port
81 #define RADPORT 1645 // old radius port...
82 #define PKTARP 0x0806 // ARP packet type
83 #define PKTIP 0x0800 // IP packet type
84 #define PSEUDOMAC 0x0200 // pseudo MAC prefix (local significant MAC)
86 #define PPPCHAP 0xC223
88 #define PPPIPCP 0x8021
92 #define MIN_IP_SIZE 0x19
110 typedef unsigned short u16
;
111 typedef unsigned int u32
;
112 typedef unsigned long long u64
;
113 typedef unsigned char u8
;
116 typedef u16 sessionidt
;
117 typedef u16 tunnelidt
;
119 typedef u8 hasht
[16];
122 struct cli_session_actions
{
132 #define CLI_SESS_KILL 0x01
133 #define CLI_SESS_SNOOP 0x02
134 #define CLI_SESS_NOSNOOP 0x04
135 #define CLI_SESS_THROTTLE 0x08
136 #define CLI_SESS_NOTHROTTLE 0x10
137 #define CLI_SESS_FILTER 0x20
138 #define CLI_SESS_NOFILTER 0x40
140 struct cli_tunnel_actions
{
144 #define CLI_TUN_KILL 0x01
146 // dump header: update number if internal format changes
147 #define DUMP_MAGIC "L2TPNS#" VERSION "#"
150 typedef struct // route
157 typedef struct controls
// control message
159 struct controls
*next
; // next in queue
160 u16 length
; // length
167 sessionidt next
; // next session in linked list
168 sessionidt far
; // far end session ID
169 tunnelidt tunnel
; // near end tunnel ID
170 ipt ip
; // IP of session set by RADIUS response (host byte order).
171 int ip_pool_index
; // index to IP pool
172 unsigned long unique_id
; // unique session id
173 u16 nr
; // next receive
175 u32 magic
; // ppp magic number
176 u32 cin
, cout
; // byte counts
177 u32 pin
, pout
; // packet counts
178 u32 total_cin
; // This counter is never reset while a session is open
179 u32 total_cout
; // This counter is never reset while a session is open
180 u32 id
; // session id
181 u16 throttle_in
; // upstream throttle rate (kbps)
182 u16 throttle_out
; // downstream throttle rate
183 clockt opened
; // when started
184 clockt die
; // being closed, when to finally free
185 time_t last_packet
; // Last packet from the user (used for idle timeouts)
186 ipt dns1
, dns2
; // DNS servers
187 routet route
[MAXROUTE
]; // static routes
188 u16 radius
; // which radius session is being used (0 for not waiting on authentication)
189 u16 mru
; // maximum receive unit
190 u16 tbf_in
; // filter bucket for throttling in from the user.
191 u16 tbf_out
; // filter bucket for throttling out to the user.
192 u8 l2tp_flags
; // various bit flags from the ICCN on the l2tp tunnel.
193 u8 reserved_old_snoop
; // No longer used - remove at some time
194 u8 walled_garden
; // is this session gardened?
195 u8 flags1
; // additional flags (currently unused);
196 char random_vector
[MAXTEL
];
197 int random_vector_length
;
198 char user
[129]; // user (needed in seesion for radius stop messages) (can we reduce this? --mo)
199 char called
[MAXTEL
]; // called number
200 char calling
[MAXTEL
]; // calling number
201 u32 tx_connect_speed
;
202 u32 rx_connect_speed
;
203 u32 flags
; // Various session flags.
204 ipt snoop_ip
; // Interception destination IP
205 u16 snoop_port
; // Interception destination port
206 u16 sid
; // near end session id.
207 u8 filter_in
; // input filter index (to ip_filters[N-1]; 0 if none)
208 u8 filter_out
; // output filter index
209 char reserved
[18]; // Space to expand structure without changing HB_VERSION
213 #define SF_IPCP_ACKED 1 // Has this session seen an IPCP Ack?
214 #define SF_LCP_ACKED 2 // LCP negotiated
215 #define SF_CCP_ACKED 4 // CCP negotiated
223 #define SESSIONPFC 1 // PFC negotiated flags
224 #define SESSIONACFC 2 // ACFC negotiated flags
226 // 168 bytes per tunnel
229 tunnelidt far
; // far end tunnel ID
230 ipt ip
; // Ip for far end
231 portt port
; // port for far end
232 u16 window
; // Rx window
233 u16 nr
; // next receive
235 int state
; // current state (tunnelstate enum)
236 clockt last
; // when last control message sent (used for resend timeout)
237 clockt retry
; // when to try resenting pending control
238 clockt die
; // being closed, when to finally free
239 clockt lastrec
; // when the last control message was received
240 char hostname
[128]; // tunnel hostname
241 char vendor
[128]; // LAC vendor
242 u8
try; // number of retrys on a control message
243 u16 controlc
; // outstaind messages in queue
244 controlt
*controls
; // oldest message
245 controlt
*controle
; // newest message
249 // 180 bytes per radius session
250 typedef struct // outstanding RADIUS requests
252 sessionidt session
; // which session this applies to
253 hasht auth
; // request authenticator
254 clockt retry
; // when to try next
255 char calling
[MAXTEL
]; // calling number
256 char pass
[129]; // password
257 u8 id
; // ID for PPP response
258 u8
try; // which try we are on
259 u8 state
; // state of radius requests
260 u8 chap
; // set if CHAP used (is CHAP identifier)
266 ipt address
; // Host byte order..
267 char assigned
; // 1 if assigned, 0 if free
269 clockt last
; // last used
270 char user
[129]; // user (try to have ip addresses persistent)
281 char message
[MAX_LOG_LENGTH
];
282 } buffer
[RINGBUFFER_SIZE
];
289 * Possible tunnel states
290 * TUNNELFREE -> TUNNELOPEN -> TUNNELDIE -> TUNNELFREE
294 TUNNELFREE
, // Not in use
295 TUNNELOPEN
, // Active tunnel
296 TUNNELDIE
, // Currently closing
297 TUNNELOPENING
, // Busy opening
298 TUNNELUNDEF
, // Undefined
303 RADIUSNULL
, // Not in use
304 RADIUSCHAP
, // sending CHAP down PPP
305 RADIUSAUTH
, // sending auth to RADIUS server
306 RADIUSIPCP
, // sending IPCP to end user
307 RADIUSSTART
, // sending start accounting to RADIUS server
308 RADIUSSTOP
, // sending stop accounting to RADIUS server
309 RADIUSWAIT
, // waiting timeout before available, in case delayed replies
310 RADIUSDEAD
, // errored while talking to radius server.
318 unsigned long tun_rx_packets
;
319 unsigned long tun_tx_packets
;
320 unsigned long tun_rx_bytes
;
321 unsigned long tun_tx_bytes
;
322 unsigned long tun_rx_errors
;
323 unsigned long tun_tx_errors
;
325 unsigned long tunnel_rx_packets
;
326 unsigned long tunnel_tx_packets
;
327 unsigned long tunnel_rx_bytes
;
328 unsigned long tunnel_tx_bytes
;
329 unsigned long tunnel_rx_errors
;
330 unsigned long tunnel_tx_errors
;
332 unsigned long tunnel_retries
;
333 unsigned long radius_retries
;
335 unsigned long arp_sent
;
337 unsigned long packets_snooped
;
339 unsigned long tunnel_created
;
340 unsigned long session_created
;
341 unsigned long tunnel_timeout
;
342 unsigned long session_timeout
;
343 unsigned long radius_timeout
;
344 unsigned long radius_overflow
;
345 unsigned long tunnel_overflow
;
346 unsigned long session_overflow
;
348 unsigned long ip_allocated
;
349 unsigned long ip_freed
;
351 unsigned long c_forwarded
;
352 unsigned long recv_forward
;
354 unsigned long call_processtun
;
355 unsigned long call_processipout
;
356 unsigned long call_processudp
;
357 unsigned long call_sessionbyip
;
358 unsigned long call_sessionbyuser
;
359 unsigned long call_sendarp
;
360 unsigned long call_sendipcp
;
361 unsigned long call_tunnelsend
;
362 unsigned long call_sessionkill
;
363 unsigned long call_sessionshutdown
;
364 unsigned long call_tunnelkill
;
365 unsigned long call_tunnelshutdown
;
366 unsigned long call_assign_ip_address
;
367 unsigned long call_free_ip_address
;
368 unsigned long call_dump_acct_info
;
369 unsigned long call_sessionsetup
;
370 unsigned long call_processpap
;
371 unsigned long call_processchap
;
372 unsigned long call_processlcp
;
373 unsigned long call_processipcp
;
374 unsigned long call_processipin
;
375 unsigned long call_processccp
;
376 unsigned long call_sendchap
;
377 unsigned long call_processrad
;
378 unsigned long call_radiussend
;
379 unsigned long call_radiusretry
;
386 #define CSTAT(x) STAT(x)
391 #define STAT(x) (_statistics->x++)
392 #define INC_STAT(x,y) (_statistics->x += (y))
393 #define GET_STAT(x) (_statistics->x)
394 #define SET_STAT(x, y) (_statistics->x = (y))
398 #define INC_STAT(x,y)
399 #define GET_STAT(x) 0
400 #define SET_STAT(x, y)
405 int debug
; // debugging level
406 time_t start_time
; // time when l2tpns was started
407 char bandwidth
[256]; // current bandwidth
408 char pid_file
[256]; // file to write PID to on startup
410 clockt current_time
; // 1/10ths of a second since the process started.
411 // means that we can only run a given process
412 // for 13 years without re-starting!
414 char config_file
[128];
415 int reload_config
; // flag to re-read config (set by cli)
416 int cleanup_interval
; // interval between regular cleanups (in seconds)
417 int multi_read_count
; // amount of packets to read per fd in processing loop
419 char tundevice
[10]; // tun device name
420 char log_filename
[128];
423 char radiussecret
[64];
424 int radius_accounting
;
425 ipt radiusserver
[MAXRADSERVER
]; // radius servers
426 u16 radiusport
[MAXRADSERVER
]; // radius base ports
427 u8 numradiusservers
; // radius server count
428 short num_radfds
; // Number of radius filehandles allocated
430 ipt default_dns1
, default_dns2
;
432 unsigned long rl_rate
; // default throttle rate
433 int num_tbfs
; // number of throttle buckets
436 char accounting_dir
[128];
439 int send_garp
; // Set to true to garp for vip address on startup
443 char plugins
[64][MAXPLUGINS
];
444 char old_plugins
[64][MAXPLUGINS
];
446 int next_tbf
; // Next HTB id available to use
447 int scheduler_fifo
; // If the system has multiple CPUs, use FIFO scheduling policy for this process.
448 int lock_pages
; // Lock pages into memory.
449 int icmp_rate
; // Max number of ICMP unreachable per second to send>
451 u32 cluster_address
; // Multicast address of cluster.
452 // Send to this address to have everyone hear.
453 char cluster_interface
[64]; // Which interface to listen for multicast on.
454 int cluster_iam_master
; // Are we the cluster master???
455 int cluster_iam_uptodate
; // Set if we've got a full set of state from the master.
456 u32 cluster_master_address
; // The network address of the cluster master.
457 // Zero if i am the cluster master.
458 int cluster_seq_number
; // Sequence number of the next heartbeat we'll send out
459 // (or the seq number we're next expecting if we're a slave).
460 int cluster_undefined_sessions
; // How many sessions we're yet to receive from the master.
461 int cluster_undefined_tunnels
; // How many tunnels we're yet to receive from the master.
462 int cluster_highest_sessionid
;
463 int cluster_highest_tunnelid
;
464 clockt cluster_last_hb
; // Last time we saw a heartbeat from the master.
465 int cluster_num_changes
; // Number of changes queued.
467 int cluster_hb_interval
; // How often to send a heartbeat.
468 int cluster_hb_timeout
; // How many missed heartbeats trigger an election.
469 u64 cluster_table_version
; // # state changes processed by cluster
472 #define BGP_NUM_PEERS 2
479 } neighbour
[BGP_NUM_PEERS
];
483 enum config_typet
{ INT
, STRING
, UNSIGNED_LONG
, SHORT
, BOOL
, IP
, MAC
};
489 enum config_typet type
;
495 #define FILTER_PORT_OP_NONE 0 // all ports match
496 #define FILTER_PORT_OP_EQ 1
497 #define FILTER_PORT_OP_NEQ 2
498 #define FILTER_PORT_OP_GT 3
499 #define FILTER_PORT_OP_LT 4
500 #define FILTER_PORT_OP_RANGE 5
501 portt port
; // port (host byte order)
502 portt port2
; // range
507 int action
; // permit/deny
508 #define FILTER_ACTION_DENY 1
509 #define FILTER_ACTION_PERMIT 2
510 u8 proto
; // protocol: IPPROTO_* (netinet/in.h)
511 ipt src_ip
; // source ip (network byte order)
513 ip_filter_portt src_ports
;
514 ipt dst_ip
; // dest ip
516 ip_filter_portt dst_ports
;
517 u8 frag
; // apply to non-initial fragments
518 u8 tcp_flag_op
; // match type: any, all, established
519 #define FILTER_FLAG_OP_ANY 1
520 #define FILTER_FLAG_OP_ALL 2
521 #define FILTER_FLAG_OP_EST 3
522 u8 tcp_sflags
; // flags set
523 u8 tcp_cflags
; // flags clear
524 u32 counter
; // match count
527 #define TCP_FLAG_FIN 0x01
528 #define TCP_FLAG_SYN 0x02
529 #define TCP_FLAG_RST 0x04
530 #define TCP_FLAG_PSH 0x08
531 #define TCP_FLAG_ACK 0x10
532 #define TCP_FLAG_URG 0x20
535 #define MAXFILTER_RULES 32
538 char name
[32]; // ACL name
539 int extended
; // type: 0 = standard, 1 = extended
540 ip_filter_rulet rules
[MAXFILTER_RULES
];
541 int used
; // session ref count
545 void sendarp(int ifr_idx
, const unsigned char* mac
, ipt ip
);
549 void processpap(tunnelidt t
, sessionidt s
, u8
* p
, u16 l
);
550 void processchap(tunnelidt t
, sessionidt s
, u8
* p
, u16 l
);
551 void processlcp(tunnelidt t
, sessionidt s
, u8
* p
, u16 l
);
552 void processipcp(tunnelidt t
, sessionidt s
, u8
* p
, u16 l
);
553 void processipin(tunnelidt t
, sessionidt s
, u8
* p
, u16 l
);
554 void processccp(tunnelidt t
, sessionidt s
, u8
* p
, u16 l
);
555 void sendchap(tunnelidt t
, sessionidt s
);
556 u8
*makeppp(u8
* b
, int size
, u8
* p
, int l
, tunnelidt t
, sessionidt s
, u16 mtype
);
557 void initlcp(tunnelidt t
, sessionidt s
);
558 void send_ipin(sessionidt s
, u8
* buf
, int len
);
563 void radiussend(u16 r
, u8 state
);
564 void processrad(u8
*buf
, int len
, char socket_index
);
565 void radiusretry(u16 r
);
566 u16
radiusnew(sessionidt s
);
567 void radiusclear(u16 r
, sessionidt s
);
571 clockt
backoff(u8
try);
572 sessionidt
sessionbyip(ipt ip
);
573 sessionidt
sessionbyuser(char *username
);
574 void sessionshutdown(sessionidt s
, char *reason
);
575 void send_garp(ipt ip
);
576 void tunnelsend(u8
* buf
, u16 l
, tunnelidt t
);
577 void sendipcp(tunnelidt t
, sessionidt s
);
578 void processudp(u8
* buf
, int len
, struct sockaddr_in
*addr
);
579 void snoop_send_packet(char *packet
, u16 size
, ipt destination
, u16 port
);
580 int ip_filter(u8
*buf
, int len
, u8 filter
);
581 int cmd_show_ipcache(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
582 int cmd_show_hist_idle(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
583 int cmd_show_hist_open(struct cli_def
*cli
, char *command
, char **argv
, int argc
);
587 #define LOG(D, s, t, f, ...) ({ if (D <= config->debug) _log(D, s, t, f, ## __VA_ARGS__); })
588 #define LOG_HEX(D, t, d, s) ({ if (D <= config->debug) _log_hex(D, t, d, s); })
590 void _log(int level
, sessionidt s
, tunnelidt t
, const char *format
, ...) __attribute__((format (printf
, 4, 5)));
591 void _log_hex(int level
, const char *title
, const char *data
, int maxsize
);
593 int sessionsetup(tunnelidt t
, sessionidt s
);
594 int run_plugins(int plugin_type
, void *data
);
595 void rebuild_address_pool(void);
596 void throttle_session(sessionidt s
, int rate_in
, int rate_out
);
597 int load_session(sessionidt
, sessiont
*);
598 void become_master(void); // We're the master; kick off any required master initializations.
602 void init_cli(char *hostname
);
603 void cli_do_file(FILE *fh
);
604 void cli_do(int sockfd
);
605 int cli_arg_help(struct cli_def
*cli
, int cr_ok
, char *entry
, ...);
609 void host_unreachable(ipt destination
, u16 id
, ipt source
, char *packet
, int packet_len
);
612 extern tunnelt
*tunnel
;
613 extern sessiont
*session
;
614 extern sessioncountt
*sess_count
;
615 extern ippoolt
*ip_address_pool
;
616 #define sessionfree (session[0].next)
618 #define log_backtrace(count, max) \
619 if (count++ < max) { \
623 LOG(0, 0, t, "Backtrace follows"); \
624 size = backtrace(array, 10); \
625 strings = backtrace_symbols(array, size); \
626 if (strings) for (i = 0; i < size; i++) \
628 LOG(0, 0, t, "%s\n", strings[i]); \
634 extern configt
*config
;
635 extern time_t basetime
; // Time when this process started.
636 extern time_t time_now
; // Seconds since EPOCH.
638 extern struct Tstats
*_statistics
;
639 extern ipt my_address
;
640 extern int tun_write(u8
*data
, int size
);
644 #define TIME (config->current_time)
646 // macros for handling help in cli commands
647 #define CLI_HELP_REQUESTED (argc > 0 && argv[argc-1][strlen(argv[argc-1])-1] == '?')
648 #define CLI_HELP_NO_ARGS (argc > 1 || argv[0][1]) ? CLI_OK : cli_arg_help(cli, 1, NULL)
650 // CVS identifiers (for "show version file")
651 extern char const *cvs_id_arp
;
652 extern char const *cvs_id_cli
;
653 extern char const *cvs_id_cluster
;
654 extern char const *cvs_id_constants
;
655 extern char const *cvs_id_control
;
656 extern char const *cvs_id_icmp
;
657 extern char const *cvs_id_l2tpns
;
658 extern char const *cvs_id_ll
;
659 extern char const *cvs_id_md5
;
660 extern char const *cvs_id_ppp
;
661 extern char const *cvs_id_radius
;
662 extern char const *cvs_id_tbf
;
663 extern char const *cvs_id_util
;
665 #endif /* __L2TPNS_H__ */