diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2012-09-22 14:32:36 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2012-09-22 14:32:36 +0000 |
commit | c76adf6f3fc62ab0729e7398c8583c543500f9a4 (patch) | |
tree | 37baad1b517bfb7d6b04c1133996f89e66128a24 | |
parent | 197669fe8923e3ea51187e39f267a0c24e385020 (diff) |
various fixes; ok yasuoka
-rw-r--r-- | usr.sbin/npppd/npppd/npppd.conf.5 | 573 |
1 files changed, 306 insertions, 267 deletions
diff --git a/usr.sbin/npppd/npppd/npppd.conf.5 b/usr.sbin/npppd/npppd/npppd.conf.5 index a7cddbb0ab6..fb7894dcc1e 100644 --- a/usr.sbin/npppd/npppd/npppd.conf.5 +++ b/usr.sbin/npppd/npppd/npppd.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: npppd.conf.5,v 1.4 2012/09/19 19:29:21 yasuoka Exp $ +.\" $OpenBSD: npppd.conf.5,v 1.5 2012/09/22 14:32:35 jmc Exp $ .\" .\" Copyright (c) 2012 YASUOKA Masahiko <yasuoka@openbsd.org> .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: September 19 2012 $ +.Dd $Mdocdate: September 22 2012 $ .Dt NPPPD.CONF 5 .Os .Sh NAME @@ -22,289 +22,316 @@ .Nd npppd configuration file .Sh DESCRIPTION .Nm -is the configuration file for the PPP daemon, +is the configuration file for the PPP daemon .Xr npppd 8 . .Sh SECTIONS .Nm -is devided six sections: -.Bl -tag -compact -width Authentications -.It Sy Globals -Global setting -.It Sy Tunnels -Tunnel setting describes the tunneling protocol and PPP settings. -.It Sy IPCPs -IPCP setting describes the Internet Protocol Configuration Protocol(IPCP) -of PPP. -.It Sy Interfaces -Inteface setting -.It Sy Authentications -Authenticaton setting -.It Sy Binds -Bind the setting +is divided into six sections: +.Pp +.Bl -tag -width "AuthenticationXXX" -offset indent -compact +.It Sy Global +Global settings. +.It Sy Tunnel +Tunneling protocol and PPP settings. +.It Sy IPCP +Internet Protocol Configuration Protocol (IPCP) of PPP. +.It Sy Interface +Interface settings. +.It Sy Authentication +Authenticaton settings. +.It Sy Bind +Bind settings. .El .Sh GLOBAL -Global options are following: +The global options are as follows: .Bl -tag -width Ds .It Ic set max-session Ar number Specify the maximum number of sessions. -`0' means no limit. -Default value is `0'. +.Sq 0 +means no limit. +The default value is 0. .It Ic set user-max-session Ar number Specify the maximum number of sessions for each user. -`0' means no limit. -Default value is `0'. +.Sq 0 +means no limit. +The default value is 0. .El .Sh TUNNEL The .Ic tunnel -setting are described below: -.Bd -literal -.Ic tunnel Ar name Ic protocol Ar protocol Ic { Ar options Ic } -.Ed +setting is described below: .Pp -Specify -.Ar name -of this tunnel protocol setting. -For -.Ar protocol , -specify one of the following that this tunnel setting accepts from: +.Ic tunnel Ar name Ic protocol Ar protocol Op Ar option ... +.Pp +Specify the tunnel +.Ar protocol : .Pp -.Bl -tag -offset indent -compact -width pppoe +.Bl -tag -width "pppoeXXX" -offset indent -compact .It Ic l2tp Layer Two Tunneling Protocol (RFC 2661) -.It Ic pptp -Point-to-Point Tunneling Protocol (RFC 2637) .It Ic pppoe PPP Over Ethernet (RFC 2516) +.It Ic pptp +Point-to-Point Tunneling Protocol (RFC 2637) .El .Pp -Supported options are following: +The supported options are as follows: .Bl -tag -width Ds .It Ic listen on Ar address Op Ic port Ar port -Specify IP address that this tunnel protocol listens on. -Both IPv4 and IPv6 address can be used. -If the port is ommited, the default port numbers are used. -The default port number is 1723 for PPTP and 1701 for L2TP. -Default value is `0.0.0.0'. -This option can be specified if the tunnel protocol is not PPPoE. +Specify the IP address that this tunnel listens on. +Both IPv4 and IPv6 addresses can be used. +If the port is omitted, the default port numbers are used. +The default port numbers are 1723 for PPTP and 1701 for L2TP. +The default value is 0.0.0.0. +This option is for PPTP and L2TP only. .It Ic listen on interface Ar interface-name Specify the interface name that this PPPoE tunnel listens on. -The interface must be ethernet interface. -This option can be specified if the tunnel protocol is PPPoE. +The interface must be an Ethernet interface. +This option is for PPPoE only. .It Ic l2tp-hostname Ar string -Specify a hostname that are used by L2TP. -Default value is the value that is returned by -.Xr gethostname 2 . -This option can be specified if the tunnel protocol is L2TP. +Specify an L2TP hostname. +The default value is the value that is returned by +.Xr gethostname 3 . +This option is for L2TP only. .It Ic l2tp-vendor-name Ar string -Specify a vendor name that are used by L2TP. -Default value is "" (empty string). -This option can be specified if the tunnel protocol is L2TP. +Specify an L2TP vendor name. +The default value is "" (an empty string). +This option is for L2TP only. .It Ic l2tp-hello-interval Ar number -Specify the interval time between L2TP hello request in seconds. -The default value is `60'. -This option can be specified if the tunnel protocol is L2TP. +Specify the interval time between L2TP hello requests, in seconds. +The default value is 60. +This option is for L2TP only. .It Ic l2tp-hello-timeout Ar number -Specify the maximim time that +Specify the maximum time that .Nm -waits L2TP hello response in seconds. -The default value is `30'. -This option can be specified if the tunnel protocol is L2TP. +waits for L2TP hello responses, in seconds. +This option is for L2TP only. .It Ic l2tp-accept-dialin Ar yes | no -If `yes' is specified, +If +.Dq yes +is specified, .Xr npppd 8 accepts Proxy-LCP and Proxy-Authentication AVPs from LAC -that is to do `compulsory tunneling mode'. -The default is `no'. -This option can be specified if the tunnel protocol is L2TP. +to do `compulsory tunneling mode'. +The default is +.Dq no . +This option is for L2TP only. .It Ic l2tp-lcp-renegotiation Ar yes | no -If `yes' is specified, +If +.Dq yes +is specified, .Xr npppd 8 will basically use the LCP that is received by Proxied-LCP AVPs, -but when if the LCP is not acceptable +but if the LCP is not acceptable .Xr npppd 8 will negotiate LCP again. -The default is `yes'. -This option can be specified if the tunnel protocol is L2TP. +The default is +.Dq yes . +This option is for L2TP only. .It Ic l2tp-force-lcp-renegotiation Ar yes | no -If `yes' is specified, +If +.Dq yes +is specified, .Xr npppd 8 will not use the LCP that is received by Proxied-LCP AVPs, it will negotiate LCP again. -The default is `no'. -This option can be specified if the tunnel protocol is L2TP. +The default is +.Dq no . +This option is for L2TP only. .It Ic l2tp-data-use-seq Ar yes | no -Specify `yes' to use sequencling for L2TP Data comunication. -The default is `yes'. -This option can be specified if the tunnel protocol is L2TP. +Specify +.Dq yes +to use sequencing for L2TP Data communications. +The default is +.Dq yes . +This option is for L2TP only. .It Ic l2tp-require-ipsec Ar yes | no -Specify `yes' to refuse L2TP connections without IPsec encapsulation. -The default is `no'. -This option can be specified if the tunnel protocol is L2TP. +Specify +.Dq yes +to refuse L2TP connections without IPsec encapsulation. +The default is +.Dq no . +This option is for L2TP only. .It Ic pptp-hostname Ar string -Specify a hostname that are used by PPTP. -Default value is the value that is returned by -.Xr gethostname 2 . -This option can be specified if the tunnel protocol is PPTP. +Specify a PPTP hostname. +The default value is the value that is returned by +.Xr gethostname 3 . +This option is for PPTP only. .It Ic pptp-vendor-name Ar string -Specify a vendor name that are used by PPTP. -Default value is "" (empty string). -This option can be specified if the tunnel protocol is PPTP. +Specify a PPTP vendor name. +The default value is "" (an empty string). +This option is for PPTP only. .It Ic pptp-echo-interval Ar number -Specify the interval time between PPTP echo request in seconds. -The default value is `60'. -This option can be specified if the tunnel protocol is PPTP. +Specify the interval time between PPTP echo requests, in seconds. +The default value is 60. +This option is for PPTP only. .It Ic pptp-echo-timeout Ar number -Specify the maximim time that +Specify the maximum time that .Nm -waits PPTP echo reply in seconds. -The default value is `60'. -This option can be specified if the tunnel protocol is PPTP. +waits for PPTP echo replies, in seconds. +The default value is 60. +This option is for PPTP only. .It Ic pppoe-service-name Ar string Specify a service name. -The default is "" (empty string). -This option can be specified if the tunnel protocol is PPPoE. +The default is "" (an empty string). +This option is for PPPoE only. .It Ic pppoe-accept-any-service Ar yes | no -If `yes' is specified +If +.Dq yes +is specified .Xr npppd 8 -accepts request from the clients that are accepting any service names -Default value is `yes'. -This option can be specified if the tunnel protocol is PPPoE. +accepts requests from clients that are accepting any service names. +The default value is +.Dq yes . +This option is for PPPoE only. .It Ic pppoe-ac-name Ar string -Specify the access concentrator(ac) name. -The default value is created by the MAC Address +Specify the access concentrator (AC) name. +The default value is created by the MAC address of the listening interface. -This option can be specified if the tunnel protocol is PPPoE. +This option is for PPPoE only. .It Ic mru Ar number -Specified the MRU(Maximum Receive Unit) value. +Specify the Maximum Receive Unit (MRU). This value is used for LCP negotiation with the tunnel peer. -The default value is `1360' for L2TP, `1400' for pptp and '1492' for PPPoE. +The default values are 1360 for L2TP, 1400 for PPTP, and 1492 for PPPoE. .It Ic lcp-keepalive Ar yes | no Specify whether .Xr npppd 8 -uses LCP keep alive. -The default value `no' for L2TP, `yes' for PPTP and PPPoE. +uses LCP keepalive. +The default value is +.Dq no +for L2TP and +.Dq yes +for PPTP and PPPoE. .It Ic lcp-keepalive-interval Ar number -Specify the interval time between LCP echo request in seconds. -The default value is `300'. +Specify the interval time between LCP echo requests, in seconds. +The default value is 300. .It Ic lcp-keepalive-retry-interval Ar number -Specify the interval time between retrying LCP echo request +Specify the interval time between retrying LCP echo requests without receiving the echo reply from the peer. The value must be specified in seconds. -The default value is `60'. +The default value is 60. .It Ic lcp-keepalive-max-retries Ar number -Specify the maximum number of retrying LCP echo. -If the peer doesn't respond and the number of retry reaches this value, +Specify the maximum number of LCP echo retries. +If the peer doesn't respond and the number of retries reaches this value, .Xr npppd 8 -treats the link is dead and it closes the link. -The default value is `3'. +treats the link as dead and closes it. +The default value is 3. .It Ic lcp-timeout Ar number Specify the timeout value for LCP retransmission in seconds. -Default value is `3'. +The default value is 3. .It Ic lcp-max-configure Ar number -Specify the maximum number of LCP configure reqeuest transmission. -Default value is `10'. +Specify the maximum number of LCP configure request transmissions. +The default value is 10. .It Ic lcp-max-terminate Ar number -Specify the maximum number of LCP terminate reqeuest transmission. -Default value is `2'. +Specify the maximum number of LCP terminate request transmissions. +The default value is 2. .It Ic lcp-max-nak-loop Ar number Specify the maximum number of LCP configure NAK loops. -Default value is `5'. +The default value is 5. .It Ic authentication-method Ar authentication-method ... -Specify authentication methods. +Specify an authentication method: .Pp -Following authentication methods can be used: .Bl -tag -width mschapv2 -compact .It Ic pap -Password Authentication Protocol +Password Authentication Protocol. .It Ic chap -PPP Challenge Handshake Authentication Protocol (RFC 1994) +PPP Challenge Handshake Authentication Protocol (RFC 1994). .It Ic mschapv2 -Microsoft PPP CHAP Extensions, Version 2 (RFC 2749) +Microsoft PPP CHAP Extensions, Version 2 (RFC 2749). .El .Pp -`mschapv2' is used as the default for PPTP, -`pap chap mschapv2' will be used as the default for other protocols. +.Ic mschapv2 +is used as the default for PPTP; +.Ic pap chap mschapv2 +is used as the default for other protocols. .It Ic ccp-timeout Ar number -Specify the timeout value for CCP retransmission in seconds. -Default value is `3'. +Specify the timeout value for CCP retransmission, in seconds. +The default value is 3. .It Ic ccp-max-configure Ar number -Specify the maximum number of CCP configure reqeuest transmission. -Default value is `10'. +Specify the maximum number of CCP configure request transmissions. +The default value is 10. .It Ic ccp-max-terminate Ar number -Specify the maximum number of CCP terminate reqeuest transmission. -Default value is `2'. +Specify the maximum number of CCP terminate request transmissions. +The default value is 2. .It Ic ccp-max-nak-loop Ar number Specify the maximum number of CCP configure NAK loops. -Default value is `5'. +The default value is 5. .It Ic ipcp-timeout Ar number -Specify the timeout value for IPCP retransmission in seconds. -Default value is `3'. +Specify the timeout value for IPCP retransmission, in seconds. +The default value is 3. .It Ic ipcp-max-configure Ar number -Specify the maximum number of IPCP configure reqeuest transmission. -Default value is `10'. +Specify the maximum number of IPCP configure request transmissions. +The default value is 10. .It Ic ipcp-max-terminate Ar number -Specify the maximum number of IPCP terminate reqeuest transmission. -Default value is `2'. +Specify the maximum number of IPCP terminate request transmissions. +The default value is 2. .It Ic ipcp-max-nak-loop Ar number Specify the maximum number of IPCP configure NAK loops. -Default value is `5'. +The default value is 5. .It Ic mppe-key-length Ar key-length ... -Specify key lengths that this configuration use. +Specify key lengths for this configuration. +The following key lengths can be used: .Pp -Following key lengths can be used: -.Bl -tag -width 128 -compact +.Bl -tag -width "128XXX" -compact .It Ic 128 -128 bits encryption +128-bit encryption. .It Ic 56 -56 bits encryption +56-bit encryption. .It Ic 40 -40 bits encryption +40-bit encryption. .El .It Ic mppe-key-state Ar mode ... -Specify the key change modes that this configuration supports to. +Specify the key change modes that this configuration supports. +The following modes can be used: .Pp -Following modes can be used: -.Bl -tag -width stateless -compact +.Bl -tag -width "statelessXXX" -compact .It Ic stateful -Stateful mode key changes +Stateful mode key changes. .It Ic stateless -Stateless mode key changes +Stateless mode key changes. .El .It Ic idle-timeout Ar number -Specify the timeout value for the idle timer in seconds. -The idle timer disconnects the link if the link keeps idle for the time +Specify the timeout value for the idle timer, in seconds. +The idle timer disconnects the link if the link is idle for the time specified by this value. -The link is treated as `idle' if the no data packet are sent or received. +The link is treated as idle if no data packets are sent or received. 0 means disable the idle timer. -Default value is `0'. +The default value is 0. .It Ic tcp-mss-adjust Ar yes | no -If `yes' is specified, +If +.Dq yes +is specified, .Xr npppd 8 -adjusts TCP SYN packets so that the value of TCP MSS (maximum segment -size) option is less than the value calculated from the link MTU. -The default value is `no'. +adjusts TCP SYN packets so that the value of TCP maximum segment size (MSS) +is less than the value calculated from the link MTU. +The default value is +.Dq no . .It Ic ingress-filter Ar yes | no -If `yes' is specified, +If +.Dq yes +is specified, .Xr npppd 8 -applies ingress filter for incoming packets. -The ingress filter drops all packets that source address does not match to -the address assigned by +applies an ingress filter for incoming packets. +The ingress filter drops all packets whose source address does not match +the address assigned by .Xr npppd 8 for the link. -Default value is `no'. +The default value is +.Dq no . .It Ic pipex Ar yes | no Specify whether .Xr npppd 8 uses .Xr pipex 4 . -Default is `yes'. +The default is +.Dq yes . .It Ic debug-dump-pktin Ar protocol ... If this option is specified, .Xr npppd 8 dumps received packets which match the specified protocol. -Following protocols can be specified: -.Bl -tag -width mppe -compact +The following protocols can be specified: +.Pp +.Bl -tag -width "mppeXXX" -offset indent -compact .It Ic ip Internet Protocol (IP) .It Ic lcp @@ -325,7 +352,7 @@ IP Configuration Protocol (IPCP) .It Ic debug-dump-pktout Ar protocol ... If this option is specified, .Xr npppd 8 -dumps sending packets which match the specified protocol. +dumps sent packets which match the specified protocol. See .Ic debug-dump-pktin section for @@ -333,154 +360,165 @@ section for .It Ic l2tp-ctrl-in-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps received L2TP control packets for debug. -Default is `no'. +dumps received L2TP control packets for debugging. +The default is +.Dq no . .It Ic l2tp-ctrl-out-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps sending L2TP control packets for debug. -Default is `no'. +dumps sent L2TP control packets for debugging. +The default is +.Dq no . .It Ic l2tp-data-in-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps received L2TP data packets for debug. -Default is `no'. +dumps received L2TP data packets for debugging. +The default is +.Dq no . .It Ic l2tp-data-out-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps sending L2TP data packets for debug. -Default is `no'. +dumps sent L2TP data packets for debugging. +The default is +.Dq no . .It Ic pptp-ctrl-in-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps received PPTP control packets for debug. -Default is `no'. +dumps received PPTP control packets for debugging. +The default is +.Dq no . .It Ic pptp-ctrl-out-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps sending PPTP control packets for debug. -Default is `no'. +dumps sent PPTP control packets for debugging. +The default is +.Dq no . .It Ic pptp-data-in-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps received PPTP data packets for debug. -Default is `no'. +dumps received PPTP data packets for debugging. +The default is +.Dq no . .It Ic pptp-data-out-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps sending PPTP data packets for debug. -Default is `no'. +dumps sent PPTP data packets for debugging. +The default is +.Dq no . .It Ic pppoe-desc-in-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps received PPPoE discovery packets for debug. -Default is `no'. +dumps received PPPoE discovery packets for debugging. +The default is +.Dq no . .It Ic pppoe-desc-out-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps sending PPPoE discovery packets for debug. -Default is `no'. +dumps sent PPPoE discovery packets for debugging. +The default is +.Dq no . .It Ic pppoe-session-in-pktdump Ar yes | no Specify whether .Xr npppd 8 dumps received PPPoE session packets for debug. -Default is `no'. +The default is +.Dq no . .It Ic pppoe-session-out-pktdump Ar yes | no Specify whether .Xr npppd 8 -dumps sending PPPoE session packets for debug. -Default is `no'. +dumps sent PPPoE session packets for debug. +The default is +.Dq no . .El .Sh IPCP The .Ic icpp -setting are described below: -.Bd -literal -.Ic ipcp Ar name { Ar option ... Ic } -.Ed +setting is described below: .Pp -Specify name of this +.Ic ipcp Ar name Op Ar option ... +.Pp +.Ar name +specifies the name of this .Ic ipcp setting. The maximum number of .Ic ipcp settings is 8. .Pp -Supported options are following: +The supported options are as follows: .Bl -tag -width Ds .It Ic pool-address Ar address-range | address-mask Op Ic for Ar dynamic | static Specify the IP address space that is pooled for this IPCP setting. The address space can be specified by .Ar address-range -(eg. 192.168.0.2-192.168.0.254) +(e.g. 192.168.0.2-192.168.0.254) or .Ar address-mask -(eg. 192.168.0.0/24) . -.Ic for +(e.g. 192.168.0.0/24) . .Ar dynamic -means the address space is reserved for dynamic allocation, +means the address space is reserved for dynamic allocation; .Ar static means the address space is reserved for static allocation. -Default is +The default is .Ar dynamic . -This option can be used in multiple times. -.It Ic dns-servers Ar primary-server-address Op secondary-server-address -Specify the DNS servers' IP address. -.It Ic nbns-servers Ar primary-server-address Op secondary-server-address -Specify the NetBIOS name servers' IP address. +This option can be used multiple times. +.It Ic dns-servers Ar primary-server-address Op Ar secondary-server-address +Specify the DNS servers' IP addresses. +.It Ic nbns-servers Ar primary-server-address Op Ar secondary-server-address +Specify the NetBIOS name servers' IP addresses. .It Ic allow-user-selected-address Ar yes | no Specify whether .Xr npppd 8 -is allowed to assign prior the address that is selected by the user. -Default is `yes'. +is allowed to assign an address selected by the user. +The default is +.Dq yes . .El .Sh INTERFACE The .Ic interface setting is described below: -.Bd -literal +.Pp .Ic interface Ar ifname Ic address Ar address Ic ipcp Ar ipcp -.Ed .Pp Use .Xr tun 4 or -.Xr pppx 4 +.\".Xr pppx 4 +pppx and specify its name to .Ar ifname . .Ar address -is the IP address of this interface, and it is noticed as the tunnel address +is the IP address of this interface, and it is used as the tunnel address to the tunnel peer. -Specify the .Ic ipcp -setting name that are used with this interface. +specifies the +setting name that is used with this interface. The maximum number of .Ic interface settings is 8. .Sh AUTHENTICATION The .Ic authentication -setting are described below: -.Bd -literal +setting is described below: +.Pp .Ic authentication Ar name Ic type Ar type { Ar option ... Ic } -.Ed .Pp -Specify +Specify a .Ar name for this authentication setting. For .Ar type , one of the following can be specified: .Pp -.Bl -tag -offset indent -compact -width radius +.Bl -tag -offset indent -compact -width "radiusXXX" .It Ic local -authenticates by the local file. +Authenticates using local file. .It Ic radius -authenticates by the remote RADIUS servers. +Authenticates using remote RADIUS servers. .El .Pp -Supported options are following: +The supported options are as follows: .Bl -tag -width Ds .It Ic username-suffix Ar string Specify the suffix of the username @@ -500,75 +538,76 @@ that matches this prefix pattern. .It Ic strip-nt-domain Ar yes | no Specify whether .Xr npppd 8 -remove the NT domain prefix like '\\\\NTDOMAIN\\' from the username -before requesting the authentication server. -Default is `no'. +removes the NT domain prefix, +such as '\e\eNTDOMAIN\e', +from the username before requesting the authentication server. +The default is +.Dq no . .It Ic strip-atmark-realm Ar yes | no Specify whether .Xr npppd 8 -remove the realm part that begins '@' (atmark) +removes the realm part that begins '@' (atmark) from the username before requesting the authentication server. -Default is `no'. +The default is +.Dq no . .It Ic users-file Ar string Specify the path for -.Xr npppd-users 7 +.Xr npppd-users 5 that describes users' account information. -The path must be under `/etc/npppd/', because +The path must be under +.Pa /etc/npppd/ +because .Xr npppd 8 -is restricted to access the files only in limited directories. -.It Ic authentication-server { Ar radius-config Ic } -This option describes the settings for RADIUS authentication server. -This option can be used in RADIUS type only. -.Bl -tag -width max-failovers -compact +is restricted to accessing files only in certain directories. +.It Ic authentication-server Op Ar radius-config +This option describes the settings for a RADIUS authentication server. +.Bl -tag -width Ds .It Ic address Ar address Oo Ic port Ar port Oc Op Ic secret Ar secret -Specify the IP address and port of RADIUS server to +Specify the IP .Ar address and -.Ar port , -and -the shared secret to +.Ar port +of the RADIUS server, +using shared .Ar secret . .Ar secret -must be less than 127 chars. -Default port is 1812 for -.Ic authentication-server, +must be less than 127 characters. +The default port is 1812 for +.Ic authentication-server ; 1813 for -.Ic accouting-server . -This option can be specified multiple times (max 16 times) in a +.Ic accounting-server . +This option can be specified multiple times (maximum 16) in a .Ar radius-config . .It Ic timeout Ar number -Specify the maximum time for waiting the response in seconds. -Default is `9'. +Specify the maximum time for waiting for a response, in seconds. +The default is 9. .It Ic max-tries Ar number -Specify the maximum number of retransmission. -Default is `3'. +Specify the maximum number of retransmissions. +The default is 3. .It Ic max-failovers Ar number Specify the maximum number of failovers. -Default is `1'. +The default is 1. .El .It Ic accounting-server { Ar radius-config Ic } -This option describes the settings for RADIUS accounting server. +This option describes the settings for a RADIUS accounting server. See .Ic authentication-server -section for -.Ar radius-config -This option can be used in RADIUS type only. +section for details of +.Ar radius-config . .El .Sh BIND .Ic bind -describes a set of the -.Ar tunnel -setting, -.Ar authentication -setting and +describes a group of +.Ar tunnel , +.Ar authentication , +and .Ar interface -setting so that they are used together. -.Bd -literal +settings so that they are used together. +.Pp .Ic bind Ic tunnel from Ar tunnel Ic authenticated by Ar authentication .Ic to Ar ifname -.Ed .Sh EXAMPLES -Very simple configuration example is below: +A very simple configuration example is below: .Bd -literal -offset indent tunnel L2TP protocol l2tp tunnel PPTP protocol pptp @@ -584,7 +623,7 @@ bind tunnel from L2TP authenticated by LOCAL to pppx0 bind tunnel from PPTP authenticated by LOCAL to pppx0 .Ed .Pp -Simple configuration but has two authentication realms: +Another simple configuration, but with two authentication realms: .Bd -literal -offset indent tunnel L2TP protocol l2tp { listen on 203.0.113.100 @@ -612,13 +651,13 @@ bind tunnel from L2TP authenticated by RADIUS to tun0 bind tunnel from L2TP authenticated by LOCAL to tun1 .Ed .Sh SEE ALSO -.Xr npppctl 8 , -.Xr npppd 8 , .Xr pipex 4 , +.\".Xr pppx 4 , .Xr tun 4 , -.Xr pppx 4 +.Xr npppctl 8 , +.Xr npppd 8 .Sh BUGS -Current version of +The current version of .Xr npppd 8 -does not support adding or removing tunnel settings or changing its listener -settings(listen address, port and l2tp-ipsec-require). +does not support adding or removing tunnel settings or changing listener +settings (listen address, port and l2tp-ipsec-require). |