Merge pull request #367 from jkroonza/consolidated-ifup-down-and-scripts

Implement net-init, net-pre-up and net-down scripts in pppd.

diff --combined pppd/pathnames.h
index 12609a969429fc9d148284d98f6207617c152c81,439c6c8e21da0c2ea0ed3022473df27ddf4c61cd..e50132f5962191d7a20991c718b900f3ba518ef2
--- 1/pppd/pathnames.h
--- 2/pppd/pathnames.h
+++ b/pppd/pathnames.h
@@@ -107,6 -107,10 +107,10 @@@
  #define PPP_PATH_PEERFILES      PPP_PATH_CONFDIR "/peers/"
  #define PPP_PATH_RESOLV         PPP_PATH_CONFDIR "/resolv.conf"
  
+ #define PPP_PATH_NET_INIT     PPP_PATH_CONFDIR "/net-init"
+ #define PPP_PATH_NET_PREUP    PPP_PATH_CONFDIR "/net-pre-up"
+ #define PPP_PATH_NET_DOWN     PPP_PATH_CONFDIR "/net-down"
+ 
  #define PPP_PATH_CONNERRS       PPP_PATH_VARLOG  "/connect-errors"
  
  #define PPP_PATH_USEROPT        ".ppprc"
@@@ -120,12 -124,12 +124,12 @@@
  #define PPP_PATH_PPPDB          PPP_PATH_VARRUN  "/pppd2.tdb"
  
  #ifdef __linux__
 -#define PPP_PATH_LOCKDIR        PPP_PATH_VARRUN  "/lock"
 +#define PPP_PATH_LOCKDIR        "/var/lock"
  #else
  #ifdef SVR4
 -#define PPP_PATH_LOCKDIR        LOCALSTATEDIR "/spool/locks"
 +#define PPP_PATH_LOCKDIR        "/var/spool/locks"
  #else
 -#define PPP_PATH_LOCKDIR        LOCALSTATEDIR "/spool/lock"
 +#define PPP_PATH_LOCKDIR        "/var/spool/lock"
  #endif
  #endif
  

diff --combined pppd/pppd.8
index 6c2de4ceb69dd749abd6ca212cf9fd9ab23a5348,f66ca891e10c106130a0845fc088a996201cf503..7be3e8074fe2502a9b7efc23bf5fcc0e535298c6
--- 1/pppd/pppd.8
--- 2/pppd/pppd.8
+++ b/pppd/pppd.8
@@@ -637,10 -637,6 +637,10 @@@ Set the maximum number of LCP terminate
  Set the LCP restart interval (retransmission timeout) to \fIn\fR
  seconds (default 3).
  .TP
 +.B lcp\-rtt\-file \fIfilename
 +Sets the file where the round-trip time (RTT) of LCP echo-request frames
 +will be logged.
 +.TP
  .B linkname \fIname\fR
  Sets the logical name of the link to \fIname\fR.  Pppd will create a
  file named \fBppp\-\fIname\fB.pid\fR in /var/run (or /etc/ppp on some
@@@ -691,7 -687,7 +691,7 @@@ network control protocol comes up)
  Terminate after \fIn\fR consecutive failed connection attempts.  A
  value of 0 means no limit.  The default value is 10.
  .TP
 -.B max-tls-version \fIstring
 +.B max\-tls-\version \fIstring
  (EAP-TLS, or PEAP) Configures the max allowed TLS version used during
  negotiation with a peer.  The default value for this is \fI1.2\fR.  Values
  allowed for this option is \fI1.0.\fR, \fI1.1\fR, \fI1.2\fR, \fI1.3\fR.
@@@ -764,7 -760,7 +764,7 @@@ name to \fIname\fR.
  Disable Address/Control compression in both directions (send and
  receive).
  .TP
 -.B need-peer-eap
 +.B need\-peer\-eap
  (EAP-TLS) Require the peer to verify our authentication credentials.
  .TP
  .B noauth
@@@ -1140,13 -1136,13 +1140,13 @@@ The device used by pppd with this optio
  Currently supports Microgate SyncLink adapters
  under Linux and FreeBSD 2.2.8 and later.
  .TP
 -.B tls-verify-method \fIstring
 +.B tls\-verify\-method \fIstring
  (EAP-TLS, or PEAP) Match the value specified for \fIremotename\fR to that that
  of the X509 certificates subject name, common name, or suffix of the common
  name.  Respective values allowed for this option is: \fInone\fR, \fIsubject\fR,
  \fIname\fR, or \fIsuffix\fR.  The default value for this option is \fIname\fR.
  .TP
 -.B tls-verify-key-usage
 +.B tls\-verify\-key\-usage
  (EAP-TLS, or PEAP) Enables examination of peer certificate's purpose, and
  extended key usage attributes.
  .TP
@@@ -1237,36 -1233,36 +1237,36 @@@ by specifying ppp'd option \fBnic-eth0\
  option may be avoided if interface name is unambiguous and does not
  look like any other pppd's option.
  .TP
 -.B pppoe-service \fIname
 +.B pppoe\-service \fIname
  Connect to specified PPPoE service name. For backward compatibility also
  \fBrp_pppoe_service\fP option name is supported.
  .TP
 -.B pppoe-ac \fIname
 +.B pppoe\-ac \fIname
  Connect to specified PPPoE access concentrator name. For backward
  compatibility also \fBrp_pppoe_ac\fP option name is supported.
  .TP
 -.B pppoe-sess \fIsessid\fP:\fImacaddr
 +.B pppoe\-sess \fIsessid\fP:\fImacaddr
  Attach to existing PPPoE session. For backward compatibility also
  \fBrp_pppoe_sess\fP option name is supported.
  .TP
 -.B pppoe-verbose \fIn
 +.B pppoe\-verbose \fIn
  Be verbose about discovered access concentrators. When set to 2 or bigger
  value then dump also discovery packets. For backward compatibility also
  \fBrp_pppoe_verbose\fP option name is supported.
  .TP
 -.B pppoe-mac \fImacaddr
 +.B pppoe\-mac \fImacaddr
  Connect to specified MAC address.
  .TP
 -.B pppoe-host-uniq \fIstring
 +.B pppoe\-host\-uniq \fIstring
  Set the PPPoE Host-Uniq tag to the supplied hex string.
  By default PPPoE Host-Uniq tag is set to the pppd's process PID.
  For backward compatibility this option may be specified without
  \fBpppoe-\fP prefix.
  .TP
 -.B pppoe-padi-timeout \fIn
 +.B pppoe\-padi\-timeout \fIn
  Initial timeout for discovery packets in seconds (default 5).
  .TP
 -.B pppoe-padi-attempts \fIn
 +.B pppoe\-padi\-attempts \fIn
  Number of discovery attempts (default 3).
  .SH OPTIONS FILES
  Options can be taken from files as well as the command line.  Pppd
@@@ -1733,8 -1729,8 +1733,8 @@@ We failed to authenticate ourselves to 
  Pppd invokes scripts at various stages in its processing which can be
  used to perform site-specific ancillary processing.  These scripts are
  usually shell scripts, but could be executable code files instead.
- Pppd does not wait for the scripts to finish (except for the ip\-pre\-up
- script).  The scripts are
 -Pppd does not wait for the scripts to finish (except for the net-init,
 -net-pre-up and ip-pre-up scripts).  The scripts are
++Pppd does not wait for the scripts to finish (except for the net\-init,
++net\-pre\-up and ip\-pre\-up scripts).  The scripts are
  executed as root (with the real and effective user-id set to 0), so
  that they can do things such as update routing tables or run
  privileged daemons.  Be careful that the contents of these scripts do
@@@ -1844,6 -1840,14 +1844,14 @@@ IP addresses assigned but is still down
  add firewall rules before any IP traffic can pass through the
  interface.  Pppd will wait for this script to finish before bringing
  the interface up, so this script should run quickly.
+ .PP
+ WARNING:  Please note that on systems where a single interface carries multiple
+ protocols (Linux) ip-pre-up is NOT actually guaranteed to execute prior to the
+ interface moving into an up state, although IP information won't be known you
+ should consider using net-pre-up instead, alternatively, disable other NCPs
+ such that IPv4 is the only negotiated protocol - which will also result in a
+ guarantee that ip-pre-up is called prior to the interface going into an UP
+ state.
  .TP
  .B /etc/ppp/ip\-up
  A program or script which is executed when the link is available for
@@@ -1873,6 -1877,27 +1881,27 @@@ Similar to /etc/ppp/ip\-down, but it i
  longer be transmitted on the link. It is executed with the same parameters 
  as the ipv6\-up script.
  .TP
+ .B /etc/ppp/net\-init
+ This script will be executed the moment the ppp unit number is known.  This
+ script will be waited for and should not cause significant delays.  This can be
+ used to update book-keeping type systems external to ppp and provides the only
+ guaranteed point where a script can be executed knowing the ppp unit number
+ prior to LCP being initiated.  It is executed with the parameters
+ .IP
+ \fIinterface\-name tty\-device speed ipparam
+ .TP
+ .B /etc/ppp/net\-pre\-up
+ This script will be executed just prior to NCP negotiations initiating, and is
+ guaranteed to be executed whilst the interface (Linux) and/or sub-interfaces
+ (Solaris) as the case may be is/are still down.  ppp will block waiting for
+ this script to complete, and the interface may be safely renamed in this script
+ (using for example "ip li set dev $1 name ppp-foobar".  The parameters are the
+ same as for net\-init.
+ .TP
+ .B /etc/ppp/net\-down
+ This script will be executed just prior to ppp terminating and will not be
+ waited for.  The parameters are the same as for net\-init.
+ .TP
  .B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others)
  Process-ID for pppd process on ppp interface unit \fIn\fR.
  .TP
@@@ -2079,7 -2104,7 +2108,7 @@@ are met
  .br
       (412) 268-4387, fax: (412) 268-7395
  .br
 -     tech-transfer@andrew.cmu.edu
 +     tech\-transfer@andrew.cmu.edu
  .LP
  3b. The name(s) of the authors of this software must not be used to
     endorse or promote products derived from this software without