]> git.ozlabs.org Git - ppp.git/blobdiff - pppd/pppd.h
use strlcpy, strlcat, slprintf everywhere
[ppp.git] / pppd / pppd.h
index c652a5e4c4e9e8ea07a794e08b971ba0ffb28c35..405dcc7b15e125ecedcc88442a2aa87370242f32 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.11 1996/01/01 23:02:23 paulus Exp $
+ * $Id: pppd.h,v 1.29 1999/03/12 06:07:20 paulus Exp $
  */
 
 /*
 #include <sys/time.h>          /* for struct timeval */
 #include <net/ppp_defs.h>
 
-#define NUM_PPP        1               /* One PPP interface supported (per process) */
+#if __STDC__
+#include <stdarg.h>
+#define __V(x) x
+#else
+#include <varargs.h>
+#define __V(x) (va_alist) va_dcl
+#define const
+#endif
 
 /*
  * Limits.
  */
 
+#define NUM_PPP                1       /* One PPP interface supported (per process) */
 #define MAXWORDLEN     1024    /* max length of word in file (incl null) */
 #define MAXARGS                1       /* max # args to a command */
 #define MAXNAMELEN     256     /* max length of hostname or name for auth */
 #define MAXSECRETLEN   256     /* max length of password or secret */
 
+/*
+ * Option descriptor structure.
+ */
+
+typedef unsigned char  bool;
+
+enum opt_type {
+       o_special_noarg = 0,
+       o_special = 1,
+       o_bool,
+       o_int,
+       o_uint32,
+       o_string,
+};
+
+typedef struct {
+       char    *name;          /* name of the option */
+       enum opt_type type;
+       void    *addr;
+       char    *description;
+       int     flags;
+       void    *addr2;
+       int     upper_limit;
+       int     lower_limit;
+} option_t;
+
+/* Values for flags */
+#define OPT_VALUE      0xff    /* mask for presupplied value */
+#define OPT_HEX                0x100   /* int option is in hex */
+#define OPT_NOARG      0x200   /* option doesn't take argument */
+#define OPT_OR         0x400   /* OR in argument to value */
+#define OPT_INC                0x800   /* increment value */
+#define OPT_PRIV       0x1000  /* privileged option */
+#define OPT_STATIC     0x2000  /* string option goes into static array */
+#define OPT_LLIMIT     0x4000  /* check value against lower limit */
+#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_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_VAL(x)     ((x) & OPT_VALUE)
+
+#ifndef GIDSET_TYPE
+#define GIDSET_TYPE    gid_t
+#endif
+
 /*
  * Global variables.
  */
@@ -56,6 +115,14 @@ extern u_char       outpacket_buf[]; /* Buffer for outgoing packets */
 extern int     phase;          /* Current state of link - see values below */
 extern int     baud_rate;      /* Current link speed in bits/sec */
 extern char    *progname;      /* Name of this program */
+extern int     redirect_stderr;/* Connector's stderr should go to file */
+extern char    peer_authname[];/* Authenticated name of peer */
+extern int     privileged;     /* We were run by real-uid root */
+extern int     need_holdoff;   /* Need holdoff period after link terminates */
+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 */
 
 /*
  * Variables set by command-line options.
@@ -64,45 +131,58 @@ extern char        *progname;      /* Name of this program */
 extern int     debug;          /* Debug flag */
 extern int     kdebugflag;     /* Tell kernel to print debug messages */
 extern int     default_device; /* Using /dev/tty or equivalent */
-extern char    devnam[];       /* Device name */
+extern char    devnam[MAXPATHLEN];     /* Device name */
 extern int     crtscts;        /* Use hardware flow control */
-extern int     modem;          /* Use modem control lines */
+extern bool    modem;          /* Use modem control lines */
 extern int     inspeed;        /* Input/Output speed requested */
 extern u_int32_t netmask;      /* IP netmask to set on interface */
-extern int     lockflag;       /* Create lock file to lock the serial dev */
-extern int     nodetach;       /* Don't detach from controlling tty */
+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    *connector;     /* Script to establish physical link */
 extern char    *disconnector;  /* Script to disestablish physical link */
 extern char    *welcomer;      /* Script to welcome client after connection */
-extern int     maxconnect;     /* maximum number of seconds for a connection */
-extern char    user[];         /* Username for PAP */
-extern char    passwd[];       /* Password for PAP */
-extern int     auth_required;  /* Peer is required to authenticate */
-extern int     proxyarp;       /* Set up proxy ARP entry for peer */
-extern int     persist;        /* Reopen link after it goes down */
-extern int     uselogin;       /* Use /etc/passwd for checking PAP */
-extern int     lcp_echo_interval; /* Interval between LCP echo-requests */
-extern int     lcp_echo_fails; /* Tolerance to unanswered echo-requests */
-extern char    our_name[];     /* Our name for authentication purposes */
-extern char    remote_name[];  /* Peer's name for authentication */
-extern int     usehostname;    /* Use hostname for our_name */
-extern int     disable_defaultip; /* Don't use hostname for default IP adrs */
-extern int     demand;         /* Do dial-on-demand */
+extern int     maxconnect;     /* Maximum connect time (seconds) */
+extern char    user[MAXNAMELEN];/* Our name for authenticating ourselves */
+extern char    passwd[MAXSECRETLEN];   /* Password for PAP */
+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    demand;         /* Do dial-on-demand */
 extern char    *ipparam;       /* Extra parameter for ip up/down scripts */
-extern int     cryptpap;       /* Others' PAP passwords are encrypted */
+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 */
 
+#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
+
 /*
  * Values for phase.
  */
 #define PHASE_DEAD             0
-#define PHASE_DORMANT          1
-#define PHASE_ESTABLISH                2
-#define PHASE_AUTHENTICATE     3
-#define PHASE_NETWORK          4
-#define PHASE_TERMINATE                5
-#define PHASE_HOLDOFF          6
+#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
 
 /*
  * The following struct gives the addresses of procedures to call
@@ -110,19 +190,35 @@ extern int        holdoff;        /* Dead time before restarting */
  */
 struct protent {
     u_short protocol;          /* PPP protocol number */
-    void (*init)();            /* Initialization procedure */
-    void (*input)();           /* Process a received packet */
-    void (*protrej)();         /* Process a received protocol-reject */
-    void (*lowerup)();         /* Lower layer has come up */
-    void (*lowerdown)();       /* Lower layer has gone down */
-    void (*open)();            /* Open the protocol */
-    void (*close)();           /* Close the protocol */
-    int  (*printpkt)();                /* Print a packet in readable form */
-    void (*datainput)();       /* Process a received data packet */
-    int  enabled_flag;         /* 0 iff protocol is disabled */
+    /* Initialization procedure */
+    void (*init) __P((int unit));
+    /* Process a received packet */
+    void (*input) __P((int unit, u_char *pkt, int len));
+    /* Process a received protocol-reject */
+    void (*protrej) __P((int unit));
+    /* Lower layer has come up */
+    void (*lowerup) __P((int unit));
+    /* Lower layer has gone down */
+    void (*lowerdown) __P((int unit));
+    /* Open the protocol */
+    void (*open) __P((int unit));
+    /* Close the protocol */
+    void (*close) __P((int unit, char *reason));
+    /* Print a packet in readable form */
+    int  (*printpkt) __P((u_char *pkt, int len,
+                         void (*printer) __P((void *, char *, ...)),
+                         void *arg));
+    /* Process a received data packet */
+    void (*datainput) __P((int unit, u_char *pkt, int len));
+    bool enabled_flag;         /* 0 iff protocol is disabled */
     char *name;                        /* Text name of protocol */
-    void (*check_options)();   /* Check requested options, assign dflts */
-    int  (*demand_conf)();     /* Configure interface for demand-dial */
+    option_t *options;         /* List of command-line options */
+    /* Check requested options, assign defaults */
+    void (*check_options) __P((void));
+    /* Configure interface for demand-dial */
+    int  (*demand_conf) __P((int unit));
+    /* Say whether to bring up link for this pkt */
+    int  (*active_pkt) __P((u_char *pkt, int len));
 };
 
 /* Table of pointers to supported protocols */
@@ -133,23 +229,38 @@ extern struct protent *protocols[];
  */
 
 /* Procedures exported from main.c. */
+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)(), caddr_t arg, int t));
+void timeout __P((void (*func)(void *), void *arg, int t));
                                /* Call func(arg) after t seconds */
-void untimeout __P((void (*func)(), caddr_t arg));
+void untimeout __P((void (*func)(void *), void *arg));
                                /* Cancel call to func(arg) */
-int run_program __P((char *prog, char **args, int must_exist));
+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 log_packet __P((u_char *, int, char *));
+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 */
+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 */
+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) */
 
 /* Procedures exported from auth.c */
 void link_required __P((int));   /* we are starting to use the link */
@@ -161,14 +272,15 @@ 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 */
 void auth_peer_fail __P((int, int));
                                /* peer failed to authenticate itself */
-void auth_peer_success __P((int, int));
+void auth_peer_success __P((int, int, char *, int));
                                /* peer successfully authenticated itself */
 void auth_withpeer_fail __P((int, int));
                                /* we failed to authenticate ourselves */
 void auth_withpeer_success __P((int, int));
                                /* we successfully authenticated ourselves */
-void check_auth_options __P((void));
+void auth_check_options __P((void));
                                /* check authentication options supplied */
+void auth_reset __P((int));    /* check what secrets we have */
 int  check_passwd __P((int, char *, int, char *, int, char **, int *));
                                /* Check peer-supplied username/password */
 int  get_secret __P((int, char *, char *, char *, int *, int));
@@ -192,13 +304,11 @@ int  loop_frame __P((unsigned char *, int)); /* process frame from loopback */
 /* Procedures exported from sys-*.c */
 void sys_init __P((void));     /* Do system-dependent initialization */
 void sys_cleanup __P((void));  /* Restore system state before exiting */
-void sys_check_options __P((void)); /* Check options specified */
+int  sys_check_options __P((void)); /* Check options specified */
 void sys_close __P((void));    /* Clean up in a child before execing */
-void note_debug_level __P((void)); /* Note change in debug level */
 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 */
-/*void transfer_ppp __P((int));        /* Transfer ppp unit to another fd */
 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 */
@@ -208,7 +318,11 @@ 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 */
 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));
                                /* Configure i/f transmit parameters */
 void ppp_set_xaccm __P((int, ext_accm));
@@ -220,17 +334,21 @@ int  ccp_test __P((int, u_char *, int, int));
 void ccp_flags_set __P((int, int, int));
                                /* Set kernel CCP state */
 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  sifvjcomp __P((int, int, int, int));
                                /* Configure VJ TCP header compression */
 int  sifup __P((int));         /* Configure i/f up (for IP) */
+int  sifnpmode __P((int u, int proto, enum NPmode mode));
+                               /* Set mode for handling packets for proto */
 int  sifdown __P((int));       /* Configure i/f down (for IP) */
 int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
                                /* Configure IP addresses for i/f */
 int  cifaddr __P((int, u_int32_t, u_int32_t));
                                /* Reset i/f IP addresses */
-int  sifdefaultroute __P((int, u_int32_t));
+int  sifdefaultroute __P((int, u_int32_t, u_int32_t));
                                /* Create default route through i/f */
-int  cifdefaultroute __P((int, u_int32_t));
+int  cifdefaultroute __P((int, u_int32_t, u_int32_t));
                                /* Delete default route through i/f */
 int  sifproxyarp __P((int, u_int32_t));
                                /* Add proxy ARP entry for peer */
@@ -240,8 +358,55 @@ u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
 int  lock __P((char *));       /* Create lock file for device */
 void unlock __P((void));       /* Delete previously-created lock file */
 int  daemon __P((int, int));   /* Detach us from terminal session */
-int  logwtmp __P((char *, char *, char *));
+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 */
+int  have_route_to __P((u_int32_t)); /* Check if route to addr exists */
+#ifdef PPP_FILTER
+int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
+                               /* Set filter programs in kernel */
+#endif
+#ifdef IPX_CHANGE
+int  sipxfaddr __P((int, unsigned long, unsigned char *));
+int  cipxfaddr __P((int));
+#endif
+
+/* 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  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 */
+
+/*
+ * 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 connector_info;
+extern struct option_info disconnector_info;
+extern struct option_info welcomer_info;
 
 /*
  * Inline versions of get/put char/short/long.
@@ -300,7 +465,7 @@ int  logwtmp __P((char *, char *, char *));
 #define BZERO(s, n)            memset(s, 0, n)
 #define EXIT(u)                        quit()
 
-#define PRINTMSG(m, l) { m[l] = '\0'; syslog(LOG_INFO, "Remote message: %s", m); }
+#define PRINTMSG(m, l)         { info("Remote message: %0.*v", l, m); }
 
 /*
  * MAKEHEADER - Add Header fields to a packet.
@@ -372,6 +537,12 @@ int  logwtmp __P((char *, char *, char *));
 #define CHAPDEBUG(x)
 #endif
 
+#ifdef DEBUGIPXCP
+#define IPXCPDEBUG(x)  if (debug) syslog x
+#else
+#define IPXCPDEBUG(x)
+#endif
+
 #ifndef SIGTYPE
 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
 #define SIGTYPE void