maxfail option, exit code for when when we fail to auth
[ppp.git] / pppd / pppd.h
index 04c3ff9a8c794e4bf75366b473eebecf8723ee12..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.35 1999/03/24 05:05:25 paulus Exp $
+ * $Id: pppd.h,v 1.43 1999/08/12 04:22:53 paulus Exp $
  */
 
 /*
@@ -40,6 +40,7 @@
 #include <varargs.h>
 #define __V(x) (va_alist) va_dcl
 #define const
+#define volatile
 #endif
 
 /*
@@ -96,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)
 
@@ -121,6 +126,12 @@ struct pppd_stats {
     unsigned int       bytes_out;
 };
 
+/* Used for storing a sequence of words.  Usually malloced. */
+struct wordlist {
+    struct wordlist    *next;
+    char               *word;
+};
+
 /*
  * Global variables.
  */
@@ -145,6 +156,11 @@ 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.
@@ -161,13 +177,14 @@ 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 */
@@ -181,33 +198,36 @@ 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
@@ -266,16 +286,18 @@ 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 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 */
 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 */
@@ -290,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 */
@@ -379,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 */
@@ -402,8 +425,8 @@ int  options_from_file __P((char *filename, int must_exist, int check_prot,
                                /* 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, ...));
@@ -423,6 +446,7 @@ 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;
@@ -487,7 +511,34 @@ extern struct option_info ptycommand_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