kacd

 

NAME

kacd - Katalix Access Concentrator Daemon  

SYNOPSIS

kacd [-h] [-v] [-f] [-c config] [-l license] [-n] [-o output] [-D] [-d debugmask] [-L facility]  

DESCRIPTION

kacd is a PPP Access Concentrator, designed to route PPP traffic from remote clients to remote access servers. At this time, only PPPoE clients are supported; ATM and serial PPP interfaces will be added if there is demand.

User PPP traffic may be routed through L2TP tunnels, or terminated by local pppd instances.

For L2TP routes, kacd interfaces with prol2tpd to create and delete L2TP tunnels as required. The data path for PPPoE to L2TP routes is handled entirely within the kernel, giving the best possible performance. The kernel module l2tp_ac_pppoe is required by kacd to complete these routes.  

OPTIONS

-h
Display usage information.
-v
Display version information.
-f
Run in the foreground. By default, kacd forks itself and runs in the background. For debugging, it is sometimes useful to run the application in the foreground. Note that when run in the foreground, daemon output messages are sent to the controlling terminal rather than to syslog.
-c config
Read configuration commands from the specified file rather than the default /etc/kacd/kacd.conf. See the kacd.conf man page for details.
-l license
Use the specified file as the kacd license file, rather than the default /etc/kacd/kacd.lic.
-n
Checks the config file for correctness and outputs the resulting configuration information. Exits after reading the configuration.
-o output
Send daemon output to the specified filename, rather than syslog.
-D
Enable daemon debugging messages.
-d debugmask
Configures the debug message mask. The mask may be specified as a decimal or hexadecimal integer or as a comma-separated list of debug modules. Valid debug modules are route, pppoe, l2tp, radius, ppp, pppfsm, lcpfsm, ctrl, trace, pppd, system and parser. The special mask all enables debugging in all modules.
-L facility
If logging to syslog, this option can be used to specify the syslog facility to be used. Valid values are local0 .. local7, or default. The value "local0" corresponds to LOG_LOCAL0. The default is LOG_DAEMON.
 

OPERATION

kacd negotiates and accepts client connections and opens a connection to the server based on the route definitions specified in it's configuration file. The client connection is referred to as the source endpoint and the server connection is referred to destination endpoint. The relationship between source endpoint and destination endpoint is referred to as a route.  

CONFIGURATION

The config file is read at startup and when kacd receives a SIGHUP signal.  

PROTOCOLS

kacd currently supports only PPPoE as a source endpoint and both L2TP and PPP as destination endpoints. It also supports querying RADIUS servers to make authentication and routing decisions about incoming client session setup requests. It fully implements the server side of RFC 2516 (A Method for Transmitting PPP Over Ethernet), to listen for incoming service requests.

kacd requires an external L2TP daemon, prol2tpd in order to establish L2TP destination endpoints. An external PPP daemon, pppd is required to terminate PPP sessions locally.  

LINUX KERNEL DRIVERS

In order to switch data packets from an incoming PPPoE session to an L2TP session, kacd requires that the linux kernel driver l2tp_ac_pppoe is loaded. This driver should have been provided along with the distribution of kacd you received.

kacd is able to terminate incoming sessions in a local pppd instance, to do so it makes use of the rp-pppoe.so plugin distributed with pppd, which requires that the linux kernel driver pppoe is loaded.  

MANAGEMENT INTERFACE

A management interface is provided to allow users or applications to query the status of the daemon. It uses the netlink protocol familiar to kernel programmers, using an AF_UNIX socket attached to a named pipe for transport. An example application kac_info is provided to allow the user to dump the list of current routes and the set of statistics kept by the daemon.  

REPORTING BUGS

Please report bugs to <kacd-bugs@katalix.com>.  

SEE ALSO


kacd.conf(5), kac_info(8), kac_trace(8), kac_manage(8),


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
OPERATION
CONFIGURATION
PROTOCOLS
LINUX KERNEL DRIVERS
MANAGEMENT INTERFACE
REPORTING BUGS
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 07:40:26 GMT, October 17, 2016