maxfail option, exit code for when when we fail to auth
[ppp.git] / pppd / pppd.h
index 405dcc7b15e125ecedcc88442a2aa87370242f32..2ce8519eb598de514b0b85f82ac55508a1d5898b 100644 (file)
@@ -16,7 +16,7 @@
  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  *
- * $Id: pppd.h,v 1.29 1999/03/12 06:07:20 paulus Exp $
+ * $Id: pppd.h,v 1.43 1999/08/12 04:22:53 paulus Exp $
  */
 
 /*
@@ -27,6 +27,7 @@
 #define __PPPD_H__
 
 #include <stdio.h>             /* for FILE */
+#include <limits.h>            /* for NGROUPS_MAX */
 #include <sys/param.h>         /* for MAXPATHLEN and BSD4_4, if defined */
 #include <sys/types.h>         /* for u_int32_t, if defined */
 #include <sys/time.h>          /* for struct timeval */
@@ -39,6 +40,7 @@
 #include <varargs.h>
 #define __V(x) (va_alist) va_dcl
 #define const
+#define volatile
 #endif
 
 /*
@@ -95,6 +97,10 @@ typedef struct {
 #define OPT_A2COPY     0x200000 /* addr2 -> second location to rcv value */
 #define OPT_ENABLE     0x400000 /* use *addr2 as enable for option */
 #define OPT_PRIVFIX    0x800000 /* can't be overridden if noauth */
+#define OPT_PREPASS    0x1000000 /* do this opt in pre-pass to find device */
+#define OPT_INITONLY   0x2000000 /* option can only be set in init phase */
+#define OPT_DEVEQUIV   0x4000000 /* equiv to device name */
+#define OPT_DEVNAM     (OPT_PREPASS | OPT_INITONLY | OPT_DEVEQUIV)
 
 #define OPT_VAL(x)     ((x) & OPT_VALUE)
 
@@ -102,6 +108,30 @@ typedef struct {
 #define GIDSET_TYPE    gid_t
 #endif
 
+/* Structure representing a list of permitted IP addresses. */
+struct permitted_ip {
+    int                permit;         /* 1 = permit, 0 = forbid */
+    u_int32_t  base;           /* match if (addr & mask) == base */
+    u_int32_t  mask;           /* base and mask are in network byte order */
+};
+
+/*
+ * Unfortunately, the linux kernel driver uses a different structure
+ * for statistics from the rest of the ports.
+ * This structure serves as a common representation for the bits
+ * pppd needs.
+ */
+struct pppd_stats {
+    unsigned int       bytes_in;
+    unsigned int       bytes_out;
+};
+
+/* Used for storing a sequence of words.  Usually malloced. */
+struct wordlist {
+    struct wordlist    *next;
+    char               *word;
+};
+
 /*
  * Global variables.
  */
@@ -123,6 +153,14 @@ extern char        **script_env;   /* Environment variables for scripts */
 extern int     detached;       /* Have detached from controlling tty */
 extern GIDSET_TYPE groups[NGROUPS_MAX];        /* groups the user is in */
 extern int     ngroups;        /* How many groups valid in groups */
+extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
+extern int     link_stats_valid; /* set if link_stats is valid */
+extern int     using_pty;      /* using pty as device (notty or pty opt.) */
+extern int     log_to_fd;      /* logging to this fd as well as syslog */
+extern char    *no_ppp_msg;    /* message to print if ppp not in kernel */
+extern volatile int status;    /* exit status for pppd */
+extern int     devnam_fixed;   /* can no longer change devnam */
+extern int     unsuccess;      /* # unsuccessful connection attempts */
 
 /*
  * Variables set by command-line options.
@@ -139,50 +177,57 @@ extern u_int32_t netmask; /* IP netmask to set on interface */
 extern bool    lockflag;       /* Create lock file to lock the serial dev */
 extern bool    nodetach;       /* Don't detach from controlling tty */
 extern bool    updetach;       /* Detach from controlling tty when link up */
+extern char    *initializer;   /* Script to initialize physical link */
 extern char    *connector;     /* Script to establish physical link */
 extern char    *disconnector;  /* Script to disestablish physical link */
 extern char    *welcomer;      /* Script to welcome client after connection */
+extern char    *ptycommand;    /* Command to run on other side of pty */
 extern int     maxconnect;     /* Maximum connect time (seconds) */
 extern char    user[MAXNAMELEN];/* Our name for authenticating ourselves */
-extern char    passwd[MAXSECRETLEN];   /* Password for PAP */
+extern char    passwd[MAXSECRETLEN];   /* Password for PAP or CHAP */
 extern bool    auth_required;  /* Peer is required to authenticate */
 extern bool    persist;        /* Reopen link after it goes down */
 extern bool    uselogin;       /* Use /etc/passwd for checking PAP */
 extern char    our_name[MAXNAMELEN];/* Our name for authentication purposes */
 extern char    remote_name[MAXNAMELEN]; /* Peer's name for authentication */
-extern int     explicit_remote;/* remote_name specified with remotename opt */
+extern bool    explicit_remote;/* remote_name specified with remotename opt */
 extern bool    demand;         /* Do dial-on-demand */
 extern char    *ipparam;       /* Extra parameter for ip up/down scripts */
 extern bool    cryptpap;       /* Others' PAP passwords are encrypted */
 extern int     idle_time_limit;/* Shut down link if idle for this long */
 extern int     holdoff;        /* Dead time before restarting */
+extern bool    notty;          /* Stdin/out is not a tty */
+extern char    *record_file;   /* File to record chars sent/received */
+extern bool    sync_serial;    /* Device is synchronous serial device */
+extern int     maxfail;        /* Max # of unsuccessful connection attempts */
 
 #ifdef PPP_FILTER
 extern struct  bpf_program pass_filter;   /* Filter for pkts to pass */
 extern struct  bpf_program active_filter; /* Filter for link-active pkts */
 #endif
 
-char *current_option;          /* the name of the option being parsed */
-int  privileged_option;                /* set iff the current option came from root */
-char *option_source;           /* string saying where the option came from */
-
 #ifdef MSLANMAN
 extern bool    ms_lanman;      /* Use LanMan password instead of NT */
                                /* Has meaning only with MS-CHAP challenges */
 #endif
 
+extern char *current_option;   /* the name of the option being parsed */
+extern int  privileged_option; /* set iff the current option came from root */
+extern char *option_source;    /* string saying where the option came from */
+
 /*
  * Values for phase.
  */
 #define PHASE_DEAD             0
 #define PHASE_INITIALIZE       1
-#define PHASE_DORMANT          2
-#define PHASE_ESTABLISH                3
-#define PHASE_AUTHENTICATE     4
-#define PHASE_CALLBACK         5
-#define PHASE_NETWORK          6
-#define PHASE_TERMINATE                7
-#define PHASE_HOLDOFF          8
+#define PHASE_SERIALCONN       2
+#define PHASE_DORMANT          3
+#define PHASE_ESTABLISH                4
+#define PHASE_AUTHENTICATE     5
+#define PHASE_CALLBACK         6
+#define PHASE_NETWORK          7
+#define PHASE_TERMINATE                8
+#define PHASE_HOLDOFF          9
 
 /*
  * The following struct gives the addresses of procedures to call
@@ -212,6 +257,7 @@ struct protent {
     void (*datainput) __P((int unit, u_char *pkt, int len));
     bool enabled_flag;         /* 0 iff protocol is disabled */
     char *name;                        /* Text name of protocol */
+    char *data_name;           /* Text name of corresponding data protocol */
     option_t *options;         /* List of command-line options */
     /* Check requested options, assign defaults */
     void (*check_options) __P((void));
@@ -240,21 +286,20 @@ void untimeout __P((void (*func)(void *), void *arg));
 pid_t run_program __P((char *prog, char **args, int must_exist,
                       void (*done)(void *), void *arg));
                                /* Run program prog with args in child */
-void demuxprotrej __P((int, int));
-                               /* Demultiplex a Protocol-Reject */
-void format_packet __P((u_char *, int, void (*) (void *, char *, ...),
-               void *));       /* Format a packet in human-readable form */
+void reopen_log __P((void));   /* (re)open the connection to syslog */
+void update_link_stats __P((int)); /* Get stats at link termination */
+void script_setenv __P((char *, char *));      /* set script env var */
+void script_unsetenv __P((char *));            /* unset script env var */
+
+/* Procedures exported from utils.c. */
 void log_packet __P((u_char *, int, char *, int));
                                /* Format a packet and log it with syslog */
 void print_string __P((char *, int,  void (*) (void *, char *, ...),
                void *));       /* Format a string for output */
 int slprintf __P((char *, int, char *, ...));          /* sprintf++ */
 int vslprintf __P((char *, int, char *, va_list));     /* vsprintf++ */
-void script_setenv __P((char *, char *));      /* set script env var */
-void script_unsetenv __P((char *));            /* unset script env var */
-void hangup_modem __P((int));  /* Make modem hang up */
-void strlcpy __P((char *, size_t, const char *));      /* safe strcpy */
-void strlcat __P((char *, size_t, const char *));      /* safe strncpy */
+size_t strlcpy __P((char *, const char *, size_t));    /* safe strcpy */
+size_t strlcat __P((char *, const char *, size_t));    /* safe strncpy */
 void dbglog __P((char *, ...));        /* log a debug message */
 void info __P((char *, ...));  /* log an informational message */
 void notice __P((char *, ...));        /* log a notice-level message */
@@ -267,6 +312,7 @@ void link_required __P((int));        /* we are starting to use the link */
 void link_terminated __P((int));  /* we are finished with the link */
 void link_down __P((int));       /* the LCP layer has left the Opened state */
 void link_established __P((int)); /* the link is up; authenticate now */
+void start_networks __P((void));  /* start all the network control protos */
 void np_up __P((int, int));      /* a network protocol has come up */
 void np_down __P((int, int));    /* a network protocol has gone down */
 void np_finished __P((int, int)); /* a network protocol no longer needs link */
@@ -289,8 +335,6 @@ int  auth_ip_addr __P((int, u_int32_t));
                                /* check if IP address is authorized */
 int  bad_ip_adrs __P((u_int32_t));
                                /* check if IP address is unreasonable */
-void check_access __P((FILE *, char *));
-                               /* check permissions on secrets file */
 
 /* Procedures exported from demand.c */
 void demand_conf __P((void));  /* config interface(s) for demand-dial */
@@ -299,7 +343,7 @@ void demand_unblock __P((void)); /* set all NPs to pass packets */
 void demand_discard __P((void)); /* set all NPs to discard packets */
 void demand_rexmit __P((int)); /* retransmit saved frames for an NP */
 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
-int  loop_frame __P((unsigned char *, int)); /* process frame from loopback */
+int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
 
 /* Procedures exported from sys-*.c */
 void sys_init __P((void));     /* Do system-dependent initialization */
@@ -307,8 +351,9 @@ void sys_cleanup __P((void));       /* Restore system state before exiting */
 int  sys_check_options __P((void)); /* Check options specified */
 void sys_close __P((void));    /* Clean up in a child before execing */
 int  ppp_available __P((void));        /* Test whether ppp kernel support exists */
-void open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
-void establish_ppp __P((int)); /* Turn serial port into a ppp interface */
+int  get_pty __P((int *, int *, char *, int)); /* Get pty master/slave */
+int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
+int  establish_ppp __P((int)); /* Turn serial port into a ppp interface */
 void restore_loop __P((void)); /* Transfer ppp unit back to loopback */
 void disestablish_ppp __P((int)); /* Restore port to normal operation */
 void clean_check __P((void));  /* Check if line was 8-bit clean */
@@ -318,9 +363,8 @@ void setdtr __P((int, int));        /* Raise or lower port's DTR line */
 void output __P((int, u_char *, int)); /* Output a PPP packet */
 void wait_input __P((struct timeval *));
                                /* Wait for input, with timeout */
-void wait_loop_output __P((struct timeval *));
-                               /* Wait for pkt from loopback, with timeout */
-void wait_time __P((struct timeval *)); /* Wait for given length of time */
+void add_fd __P((int));                /* Add fd to set to wait for */
+void remove_fd __P((int));     /* Remove fd from set to wait for */
 int  read_packet __P((u_char *)); /* Read PPP packet */
 int  get_loop_output __P((void)); /* Read pkts from loopback */
 void ppp_send_config __P((int, int, u_int32_t, int, int));
@@ -336,6 +380,8 @@ void ccp_flags_set __P((int, int, int));
 int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
 int  get_idle_time __P((int, struct ppp_idle *));
                                /* Find out how long link has been idle */
+int  get_ppp_stats __P((int, struct pppd_stats *));
+                               /* Return link statistics */
 int  sifvjcomp __P((int, int, int, int));
                                /* Configure VJ TCP header compression */
 int  sifup __P((int));         /* Configure i/f up (for IP) */
@@ -356,8 +402,8 @@ int  cifproxyarp __P((int, u_int32_t));
                                /* Delete proxy ARP entry for peer */
 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
 int  lock __P((char *));       /* Create lock file for device */
+int  relock __P((int));                /* Rewrite lock file with new pid */
 void unlock __P((void));       /* Delete previously-created lock file */
-int  daemon __P((int, int));   /* Detach us from terminal session */
 void logwtmp __P((const char *, const char *, const char *));
                                /* Write entry to wtmp file */
 int  get_host_seed __P((void));        /* Get host-dependent random number seed */
@@ -374,21 +420,17 @@ int  cipxfaddr __P((int));
 /* Procedures exported from options.c */
 int  parse_args __P((int argc, char **argv));
                                /* Parse options from arguments given */
-void usage __P((void));                /* Print a usage message */
 int  options_from_file __P((char *filename, int must_exist, int check_prot,
                            int privileged));
                                /* Parse options from an options file */
 int  options_from_user __P((void)); /* Parse options from user's .ppprc */
 int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
-void scan_args __P((int argc, char **argv));
-                               /* Look for tty name in command-line args */
+int  options_from_list __P((struct wordlist *, int privileged));
+                               /* Parse options from a wordlist */
 int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
                                /* Read a word from a file */
 void option_error __P((char *fmt, ...));
                                /* Print an error message about an option */
-int readable __P((int fd));    /* Is fd readable by real user? */
-int number_option __P((char *, u_int32_t *, int));
-                               /* Parse a numerical option */
 int int_option __P((char *, int *));
                                /* Simplified number_option for decimal ints */
 
@@ -404,9 +446,11 @@ struct option_info {
 };
 
 extern struct option_info devnam_info;
+extern struct option_info initializer_info;
 extern struct option_info connector_info;
 extern struct option_info disconnector_info;
 extern struct option_info welcomer_info;
+extern struct option_info ptycommand_info;
 
 /*
  * Inline versions of get/put char/short/long.
@@ -447,23 +491,15 @@ extern struct option_info welcomer_info;
 #define INCPTR(n, cp)  ((cp) += (n))
 #define DECPTR(n, cp)  ((cp) -= (n))
 
-#undef  FALSE
-#define FALSE  0
-#undef  TRUE
-#define TRUE   1
-
 /*
  * System dependent definitions for user-level 4.3BSD UNIX implementation.
  */
 
-#define DEMUXPROTREJ(u, p)     demuxprotrej(u, p)
-
 #define TIMEOUT(r, f, t)       timeout((r), (f), (t))
 #define UNTIMEOUT(r, f)                untimeout((r), (f))
 
 #define BCOPY(s, d, l)         memcpy(d, s, l)
 #define BZERO(s, n)            memset(s, 0, n)
-#define EXIT(u)                        quit()
 
 #define PRINTMSG(m, l)         { info("Remote message: %0.*v", l, m); }
 
@@ -475,7 +511,34 @@ extern struct option_info welcomer_info;
     PUTCHAR(PPP_UI, p); \
     PUTSHORT(t, p); }
 
+/*
+ * Exit status values.
+ */
+#define EXIT_OK                        0
+#define EXIT_FATAL_ERROR       1
+#define EXIT_OPTION_ERROR      2
+#define EXIT_NOT_ROOT          3
+#define EXIT_NO_KERNEL_SUPPORT 4
+#define EXIT_USER_REQUEST      5
+#define EXIT_LOCK_FAILED       6
+#define EXIT_OPEN_FAILED       7
+#define EXIT_CONNECT_FAILED    8
+#define EXIT_PTYCMD_FAILED     9
+#define EXIT_NEGOTIATION_FAILED        10
+#define EXIT_PEER_AUTH_FAILED  11
+#define EXIT_IDLE_TIMEOUT      12
+#define EXIT_CONNECT_TIME      13
+#define EXIT_CALLBACK          14
+#define EXIT_PEER_DEAD         15
+#define EXIT_HANGUP            16
+#define EXIT_LOOPBACK          17
+#define EXIT_INIT_FAILED       18
+#define EXIT_AUTH_TOPEER_FAILED        19
 
+/*
+ * Debug macros.  Slightly useful for finding bugs in pppd, not particularly
+ * useful for finding out why your connection isn't being established.
+ */
 #ifdef DEBUGALL
 #define DEBUGMAIN      1
 #define DEBUGFSM       1
@@ -496,49 +559,49 @@ extern struct option_info welcomer_info;
 #endif /* LOG_PPP */
 
 #ifdef DEBUGMAIN
-#define MAINDEBUG(x)   if (debug) syslog x
+#define MAINDEBUG(x)   if (debug) dbglog x
 #else
 #define MAINDEBUG(x)
 #endif
 
 #ifdef DEBUGSYS
-#define SYSDEBUG(x)    if (debug) syslog x
+#define SYSDEBUG(x)    if (debug) dbglog x
 #else
 #define SYSDEBUG(x)
 #endif
 
 #ifdef DEBUGFSM
-#define FSMDEBUG(x)    if (debug) syslog x
+#define FSMDEBUG(x)    if (debug) dbglog x
 #else
 #define FSMDEBUG(x)
 #endif
 
 #ifdef DEBUGLCP
-#define LCPDEBUG(x)    if (debug) syslog x
+#define LCPDEBUG(x)    if (debug) dbglog x
 #else
 #define LCPDEBUG(x)
 #endif
 
 #ifdef DEBUGIPCP
-#define IPCPDEBUG(x)   if (debug) syslog x
+#define IPCPDEBUG(x)   if (debug) dbglog x
 #else
 #define IPCPDEBUG(x)
 #endif
 
 #ifdef DEBUGUPAP
-#define UPAPDEBUG(x)   if (debug) syslog x
+#define UPAPDEBUG(x)   if (debug) dbglog x
 #else
 #define UPAPDEBUG(x)
 #endif
 
 #ifdef DEBUGCHAP
-#define CHAPDEBUG(x)   if (debug) syslog x
+#define CHAPDEBUG(x)   if (debug) dbglog x
 #else
 #define CHAPDEBUG(x)
 #endif
 
 #ifdef DEBUGIPXCP
-#define IPXCPDEBUG(x)  if (debug) syslog x
+#define IPXCPDEBUG(x)  if (debug) dbglog x
 #else
 #define IPXCPDEBUG(x)
 #endif