]> git.ozlabs.org Git - ppp.git/blobdiff - pppd/pppd.h
Large patch from Frank Cusack <fcusack@fcusack.com> to add proper
[ppp.git] / pppd / pppd.h
index 6baaebcbec65baf77bda958b6d5a1244dbc155d4..d75a6fd8161d2876bfc24057d733c07e151ec627 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.55 2000/06/30 04:54:22 paulus Exp $
+ * $Id: pppd.h,v 1.66 2002/03/01 14:39:18 dfs Exp $
  */
 
 /*
@@ -32,6 +32,7 @@
 #include <sys/types.h>         /* for u_int32_t, if defined */
 #include <sys/time.h>          /* for struct timeval */
 #include <net/ppp_defs.h>
+#include "patchlevel.h"
 
 #if defined(__STDC__)
 #include <stdarg.h>
@@ -70,6 +71,7 @@ enum opt_type {
        o_int,
        o_uint32,
        o_string,
+       o_wild
 };
 
 typedef struct {
@@ -81,6 +83,10 @@ typedef struct {
        void    *addr2;
        int     upper_limit;
        int     lower_limit;
+       const char *source;
+       short int priority;
+       short int winner;
+       void    *addr3;
 } option_t;
 
 /* Values for flags */
@@ -95,20 +101,35 @@ typedef struct {
 #define OPT_ULIMIT     0x8000  /* check value against upper limit */
 #define OPT_LIMITS     (OPT_LLIMIT|OPT_ULIMIT)
 #define OPT_ZEROOK     0x10000 /* 0 value is OK even if not within limits */
+#define OPT_HIDE       0x10000 /* for o_string, print value as ?????? */
+#define OPT_A2LIST     0x10000 /* for o_special, keep list of values */
+#define OPT_A2CLRB     0x10000 /* o_bool, clr val bits in *(u_char *)addr2 */
 #define OPT_NOINCR     0x20000 /* value mustn't be increased */
 #define OPT_ZEROINF    0x40000 /* with OPT_NOINCR, 0 == infinity */
-#define OPT_A2INFO     0x100000 /* addr2 -> option_info to update */
-#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_SEENIT     0x10000000 /* have seen this option already */
+#define OPT_PRIO       0x80000 /* process option priorities for this option */
+#define OPT_PRIOSUB    0x100000 /* subsidiary member of priority group */
+#define OPT_ALIAS      0x200000 /* option is alias for previous option */
+#define OPT_A2COPY     0x400000 /* addr2 -> second location to rcv value */
+#define OPT_ENABLE     0x800000 /* use *addr2 as enable for option */
+#define OPT_A2CLR      0x1000000 /* clear *(bool *)addr2 */
+#define OPT_PRIVFIX    0x2000000 /* user can't override if set by root */
+#define OPT_INITONLY   0x4000000 /* option can only be set in init phase */
+#define OPT_DEVEQUIV   0x8000000 /* equiv to device name */
+#define OPT_DEVNAM     (OPT_INITONLY | OPT_DEVEQUIV)
+#define OPT_A2PRINTER  0x10000000 /* *addr2 is a fn for printing option */
+#define OPT_A2STRVAL   0x20000000 /* *addr2 points to current string value */
+#define OPT_NOPRINT    0x40000000 /* don't print this option at all */
+#define OPT_A3OR       0x80000000 /* addr3 -> third location to rcv | value */
 
 #define OPT_VAL(x)     ((x) & OPT_VALUE)
 
+/* Values for priority */
+#define OPRIO_DEFAULT  0       /* a default value */
+#define OPRIO_CFGFILE  1       /* value from a configuration file */
+#define OPRIO_CMDLINE  2       /* value from the command line */
+#define OPRIO_SECFILE  3       /* value from options in a secrets file */
+#define OPRIO_ROOT     100     /* added to priority if OPT_PRIVFIX && root */
+
 #ifndef GIDSET_TYPE
 #define GIDSET_TYPE    gid_t
 #endif
@@ -129,6 +150,8 @@ struct permitted_ip {
 struct pppd_stats {
     unsigned int       bytes_in;
     unsigned int       bytes_out;
+    unsigned int       pkts_in;
+    unsigned int       pkts_out;
 };
 
 /* Used for storing a sequence of words.  Usually malloced. */
@@ -186,19 +209,26 @@ extern int        link_stats_valid; /* set if link_stats is valid */
 extern int     link_connect_time; /* time the link was up for */
 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 bool    log_to_file;    /* log_to_fd is a file */
-extern bool    log_to_specific_fd;     /* log_to_fd was specified by user */
+extern bool    log_default;    /* log_to_fd is default (stdout) */
 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 bool    devnam_fixed;   /* can no longer change devnam */
 extern int     unsuccess;      /* # unsuccessful connection attempts */
 extern int     do_callback;    /* set if we want to do callback next */
 extern int     doing_callback; /* set if this is a callback */
 extern char    ppp_devnam[MAXPATHLEN];
+extern char     remote_number[MAXNAMELEN]; /* Remote telephone number, if avail. */
+extern int      ppp_session_number; /* Session number (eg PPPoE session) */
+
+extern int     listen_time;    /* time to listen first (ms) */
 extern struct notifier *pidchange;   /* for notifications of pid changing */
 extern struct notifier *phasechange; /* for notifications of phase changes */
 extern struct notifier *exitnotify;  /* for notification that we're exiting */
 extern struct notifier *sigreceived; /* notification of received signal */
+extern struct notifier *ip_up_notifier; /* IPCP has come up */
+extern struct notifier *ip_down_notifier; /* IPCP has gone down */
+extern struct notifier *auth_up_notifier; /* peer has authenticated */
+extern struct notifier *link_down_notifier; /* link has gone down */
 
 /* Values for do_callback and doing_callback */
 #define CALLBACK_DIALIN                1       /* we are expecting the call back */
@@ -252,6 +282,8 @@ extern int  req_unit;       /* interface unit number to use */
 extern bool    multilink;      /* enable multilink operation */
 extern bool    noendpoint;     /* don't send or accept endpt. discrim. */
 extern char    *bundle_name;   /* bundle name for multilink */
+extern bool    dump_options;   /* print out option values */
+extern bool    dryrun;         /* check everything, print options, exit */
 
 #ifdef PPP_FILTER
 extern struct  bpf_program pass_filter;   /* Filter for pkts to pass */
@@ -266,6 +298,7 @@ extern bool ms_lanman;      /* Use LanMan password instead of NT */
 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 */
+extern int  option_priority;   /* priority of current options */
 
 /*
  * Values for phase.
@@ -324,6 +357,52 @@ struct protent {
 /* Table of pointers to supported protocols */
 extern struct protent *protocols[];
 
+/*
+ * This struct contains pointers to a set of procedures for
+ * doing operations on a "channel".  A channel provides a way
+ * to send and receive PPP packets - the canonical example is
+ * a serial port device in PPP line discipline (or equivalently
+ * with PPP STREAMS modules pushed onto it).
+ */
+struct channel {
+       /* set of options for this channel */
+       option_t *options;
+       /* find and process a per-channel options file */
+       void (*process_extra_options) __P((void));
+       /* check all the options that have been given */
+       void (*check_options) __P((void));
+       /* get the channel ready to do PPP, return a file descriptor */
+       int  (*connect) __P((void));
+       /* we're finished with the channel */
+       void (*disconnect) __P((void));
+       /* put the channel into PPP `mode' */
+       int  (*establish_ppp) __P((int));
+       /* take the channel out of PPP `mode', restore loopback if demand */
+       void (*disestablish_ppp) __P((int));
+       /* set the transmit-side PPP parameters of the channel */
+       void (*send_config) __P((int, u_int32_t, int, int));
+       /* set the receive-side PPP parameters of the channel */
+       void (*recv_config) __P((int, u_int32_t, int, int));
+       /* cleanup on error or normal exit */
+       void (*cleanup) __P((void));
+       /* close the device, called in children after fork */
+       void (*close) __P((void));
+};
+
+extern struct channel *the_channel;
+
+#define ppp_send_config(unit, mtu, accm, pc, acc)                       \
+do {                                                                    \
+       if (the_channel->send_config)                                    \
+               (*the_channel->send_config)((mtu), (accm), (pc), (acc)); \
+} while (0)
+
+#define ppp_recv_config(unit, mtu, accm, pc, acc)                       \
+do {                                                                    \
+       if (the_channel->send_config)                                    \
+               (*the_channel->recv_config)((mtu), (accm), (pc), (acc)); \
+} while (0)
+
 /*
  * Prototypes.
  */
@@ -334,8 +413,8 @@ void detach __P((void));    /* Detach from controlling tty */
 void die __P((int));           /* Cleanup and exit */
 void quit __P((void));         /* like die(1) */
 void novm __P((char *));       /* Say we ran out of memory, and die */
-void timeout __P((void (*func)(void *), void *arg, int t));
-                               /* Call func(arg) after t seconds */
+void timeout __P((void (*func)(void *), void *arg, int s, int us));
+                               /* Call func(arg) after s.us seconds */
 void untimeout __P((void (*func)(void *), void *arg));
                                /* Cancel call to func(arg) */
 void record_child __P((int, char *, void (*) (void *), void *));
@@ -355,10 +434,6 @@ void notify __P((struct notifier *, int));
 
 /* Procedures exported from tty.c. */
 void tty_init __P((void));
-int  connect_tty __P((void));
-void disconnect_tty __P((void));
-void tty_close_fds __P((void));
-void cleanup_tty __P((void));
 
 /* Procedures exported from utils.c. */
 void log_packet __P((u_char *, int, char *, int));
@@ -375,6 +450,11 @@ void notice __P((char *, ...));    /* log a notice-level message */
 void warn __P((char *, ...));  /* log a warning message */
 void error __P((char *, ...)); /* log an error message */
 void fatal __P((char *, ...)); /* log an error message and die(1) */
+void init_pr_log __P((char *, int));   /* initialize for using pr_log */
+void pr_log __P((void *, char *, ...));        /* printer fn, output to syslog */
+void end_pr_log __P((void));   /* finish up after using pr_log */
+void dump_packet __P((const char *, u_char *, int));
+                               /* dump packet to debug log if interesting */
 
 /* Procedures exported from auth.c */
 void link_required __P((int));   /* we are starting to use the link */
@@ -428,9 +508,10 @@ void sys_close __P((void));        /* Clean up in a child before execing */
 int  ppp_available __P((void));        /* Test whether ppp kernel support exists */
 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 */
+int  tty_establish_ppp __P((int));  /* Turn serial port into a ppp interface */
+void tty_disestablish_ppp __P((int)); /* Restore port to normal operation */
+void generic_disestablish_ppp __P((int dev_fd)); /* Restore device setting */
+int  generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */
 void make_new_bundle __P((int, int, int, int)); /* Create new bundle */
 int  bundle_attach __P((int)); /* Attach link to existing bundle */
 void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */
@@ -445,11 +526,11 @@ 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));
+void tty_send_config __P((int, u_int32_t, int, int));
                                /* Configure i/f transmit parameters */
-void ppp_set_xaccm __P((int, ext_accm));
+void tty_set_xaccm __P((ext_accm));
                                /* Set extended transmit ACCM */
-void ppp_recv_config __P((int, int, u_int32_t, int, int));
+void tty_recv_config __P((int, u_int32_t, int, int));
                                /* Configure i/f receive parameters */
 int  ccp_test __P((int, u_char *, int, int));
                                /* Test support for compression scheme */
@@ -460,6 +541,7 @@ 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 */
+void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */
 int  sifvjcomp __P((int, int, int, int));
                                /* Configure VJ TCP header compression */
 int  sifup __P((int));         /* Configure i/f up for one protocol */
@@ -504,6 +586,7 @@ int  get_if_hwaddr __P((u_char *addr, char *name));
 char *get_first_ethernet __P((void));
 
 /* Procedures exported from options.c */
+int setipaddr __P((char *, char **, int)); /* Set local/remote ip addresses */
 int  parse_args __P((int argc, char **argv));
                                /* Parse options from arguments given */
 int  options_from_file __P((char *filename, int must_exist, int check_prot,
@@ -520,25 +603,13 @@ void option_error __P((char *fmt, ...));
 int int_option __P((char *, int *));
                                /* Simplified number_option for decimal ints */
 void add_options __P((option_t *)); /* Add extra options */
-int parse_dotted_ip __P((char *, u_int32_t *));
+void check_options __P((void));        /* check values after all options parsed */
+int  override_value __P((const char *, int, const char *));
+                               /* override value if permitted by priority */
+void print_options __P((void (*) __P((void *, char *, ...)), void *));
+                               /* print out values of all options */
 
-/*
- * This structure is used to store information about certain
- * options, such as where the option value came from (/etc/ppp/options,
- * command line, etc.) and whether it came from a privileged source.
- */
-
-struct option_info {
-    int            priv;               /* was value set by sysadmin? */
-    char    *source;           /* where option came from */
-};
-
-extern struct option_info devnam_info;
-extern struct option_info initializer_info;
-extern struct option_info connect_script_info;
-extern struct option_info disconnect_script_info;
-extern struct option_info welcomer_info;
-extern struct option_info ptycommand_info;
+int parse_dotted_ip __P((char *, u_int32_t *));
 
 /*
  * Hooks to enable plugins to change various things.
@@ -552,10 +623,18 @@ extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
                                 struct wordlist **popts));
 extern void (*pap_logout_hook) __P((void));
 extern int (*pap_passwd_hook) __P((char *user, char *passwd));
+extern int (*allowed_address_hook) __P((u_int32_t addr));
 extern void (*ip_up_hook) __P((void));
 extern void (*ip_down_hook) __P((void));
 extern void (*ip_choose_hook) __P((u_int32_t *));
 
+extern int (*chap_check_hook) __P((void));
+extern int (*chap_passwd_hook) __P((char *user, char *passwd));
+
+/* Let a plugin snoop sent and received packets.  Useful for L2TP */
+extern void (*snoop_recv_hook) __P((unsigned char *p, int len));
+extern void (*snoop_send_hook) __P((unsigned char *p, int len));
+
 /*
  * Inline versions of get/put char/short/long.
  * Pointer is advanced; we assume that both arguments
@@ -599,7 +678,7 @@ extern void (*ip_choose_hook) __P((u_int32_t *));
  * System dependent definitions for user-level 4.3BSD UNIX implementation.
  */
 
-#define TIMEOUT(r, f, t)       timeout((r), (f), (t))
+#define TIMEOUT(r, f, t)       timeout((r), (f), (t), 0)
 #define UNTIMEOUT(r, f)                untimeout((r), (f))
 
 #define BCOPY(s, d, l)         memcpy(d, s, l)
@@ -732,4 +811,8 @@ extern void (*ip_choose_hook) __P((u_int32_t *));
 #define MAX(a, b)      ((a) > (b)? (a): (b))
 #endif
 
+#ifndef offsetof
+#define offsetof(type, member) ((size_t) &((type *)0)->member)
+#endif
+
 #endif /* __PPP_H__ */