minor bugfixes, now 2.4.2b1, add pkts_in/out to pppd_stats,
[ppp.git] / pppd / pppd.h
1 /*
2  * pppd.h - PPP daemon global declarations.
3  *
4  * Copyright (c) 1989 Carnegie Mellon University.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms are permitted
8  * provided that the above copyright notice and this paragraph are
9  * duplicated in all such forms and that any documentation,
10  * advertising materials, and other materials related to such
11  * distribution and use acknowledge that the software was developed
12  * by Carnegie Mellon University.  The name of the
13  * University may not be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
17  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
18  *
19  * $Id: pppd.h,v 1.60 2001/04/27 23:16:13 paulus Exp $
20  */
21
22 /*
23  * TODO:
24  */
25
26 #ifndef __PPPD_H__
27 #define __PPPD_H__
28
29 #include <stdio.h>              /* for FILE */
30 #include <limits.h>             /* for NGROUPS_MAX */
31 #include <sys/param.h>          /* for MAXPATHLEN and BSD4_4, if defined */
32 #include <sys/types.h>          /* for u_int32_t, if defined */
33 #include <sys/time.h>           /* for struct timeval */
34 #include <net/ppp_defs.h>
35 #include "patchlevel.h"
36
37 #if defined(__STDC__)
38 #include <stdarg.h>
39 #define __V(x)  x
40 #else
41 #include <varargs.h>
42 #define __V(x)  (va_alist) va_dcl
43 #define const
44 #define volatile
45 #endif
46
47 #ifdef INET6
48 #include "eui64.h"
49 #endif
50
51 /*
52  * Limits.
53  */
54
55 #define NUM_PPP         1       /* One PPP interface supported (per process) */
56 #define MAXWORDLEN      1024    /* max length of word in file (incl null) */
57 #define MAXARGS         1       /* max # args to a command */
58 #define MAXNAMELEN      256     /* max length of hostname or name for auth */
59 #define MAXSECRETLEN    256     /* max length of password or secret */
60
61 /*
62  * Option descriptor structure.
63  */
64
65 typedef unsigned char   bool;
66
67 enum opt_type {
68         o_special_noarg = 0,
69         o_special = 1,
70         o_bool,
71         o_int,
72         o_uint32,
73         o_string,
74         o_wild,
75 };
76
77 typedef struct {
78         char    *name;          /* name of the option */
79         enum opt_type type;
80         void    *addr;
81         char    *description;
82         int     flags;
83         void    *addr2;
84         int     upper_limit;
85         int     lower_limit;
86         const char *source;
87         short int priority;
88         short int winner;
89 } option_t;
90
91 /* Values for flags */
92 #define OPT_VALUE       0xff    /* mask for presupplied value */
93 #define OPT_HEX         0x100   /* int option is in hex */
94 #define OPT_NOARG       0x200   /* option doesn't take argument */
95 #define OPT_OR          0x400   /* OR in argument to value */
96 #define OPT_INC         0x800   /* increment value */
97 #define OPT_PRIV        0x1000  /* privileged option */
98 #define OPT_STATIC      0x2000  /* string option goes into static array */
99 #define OPT_LLIMIT      0x4000  /* check value against lower limit */
100 #define OPT_ULIMIT      0x8000  /* check value against upper limit */
101 #define OPT_LIMITS      (OPT_LLIMIT|OPT_ULIMIT)
102 #define OPT_ZEROOK      0x10000 /* 0 value is OK even if not within limits */
103 #define OPT_HIDE        0x10000 /* for o_string, print value as ?????? */
104 #define OPT_A2LIST      0x10000 /* for o_special, keep list of values */
105 #define OPT_NOINCR      0x20000 /* value mustn't be increased */
106 #define OPT_ZEROINF     0x40000 /* with OPT_NOINCR, 0 == infinity */
107 #define OPT_PRIO        0x80000 /* process option priorities for this option */
108 #define OPT_PRIOSUB     0x100000 /* subsidiary member of priority group */
109 #define OPT_ALIAS       0x200000 /* option is alias for previous option */
110 #define OPT_A2COPY      0x400000 /* addr2 -> second location to rcv value */
111 #define OPT_ENABLE      0x800000 /* use *addr2 as enable for option */
112 #define OPT_A2CLR       0x1000000 /* clear *(bool *)addr2 */
113 #define OPT_PRIVFIX     0x2000000 /* user can't override if set by root */
114 #define OPT_INITONLY    0x4000000 /* option can only be set in init phase */
115 #define OPT_DEVEQUIV    0x8000000 /* equiv to device name */
116 #define OPT_DEVNAM      (OPT_INITONLY | OPT_DEVEQUIV)
117 #define OPT_A2PRINTER   0x10000000 /* *addr2 is a fn for printing option */
118 #define OPT_A2STRVAL    0x20000000 /* *addr2 points to current string value */
119 #define OPT_NOPRINT     0x40000000 /* don't print this option at all */
120
121 #define OPT_VAL(x)      ((x) & OPT_VALUE)
122
123 /* Values for priority */
124 #define OPRIO_DEFAULT   0       /* a default value */
125 #define OPRIO_CFGFILE   1       /* value from a configuration file */
126 #define OPRIO_CMDLINE   2       /* value from the command line */
127 #define OPRIO_SECFILE   3       /* value from options in a secrets file */
128 #define OPRIO_ROOT      100     /* added to priority if OPT_PRIVFIX && root */
129
130 #ifndef GIDSET_TYPE
131 #define GIDSET_TYPE     gid_t
132 #endif
133
134 /* Structure representing a list of permitted IP addresses. */
135 struct permitted_ip {
136     int         permit;         /* 1 = permit, 0 = forbid */
137     u_int32_t   base;           /* match if (addr & mask) == base */
138     u_int32_t   mask;           /* base and mask are in network byte order */
139 };
140
141 /*
142  * Unfortunately, the linux kernel driver uses a different structure
143  * for statistics from the rest of the ports.
144  * This structure serves as a common representation for the bits
145  * pppd needs.
146  */
147 struct pppd_stats {
148     unsigned int        bytes_in;
149     unsigned int        bytes_out;
150     unsigned int        pkts_in;
151     unsigned int        pkts_out;
152 };
153
154 /* Used for storing a sequence of words.  Usually malloced. */
155 struct wordlist {
156     struct wordlist     *next;
157     char                *word;
158 };
159
160 /* An endpoint discriminator, used with multilink. */
161 #define MAX_ENDP_LEN    20      /* maximum length of discriminator value */
162 struct epdisc {
163     unsigned char       class;
164     unsigned char       length;
165     unsigned char       value[MAX_ENDP_LEN];
166 };
167
168 /* values for epdisc.class */
169 #define EPD_NULL        0       /* null discriminator, no data */
170 #define EPD_LOCAL       1
171 #define EPD_IP          2
172 #define EPD_MAC         3
173 #define EPD_MAGIC       4
174 #define EPD_PHONENUM    5
175
176 typedef void (*notify_func) __P((void *, int));
177
178 struct notifier {
179     struct notifier *next;
180     notify_func     func;
181     void            *arg;
182 };
183
184 /*
185  * Global variables.
186  */
187
188 extern int      hungup;         /* Physical layer has disconnected */
189 extern int      ifunit;         /* Interface unit number */
190 extern char     ifname[];       /* Interface name */
191 extern char     hostname[];     /* Our hostname */
192 extern u_char   outpacket_buf[]; /* Buffer for outgoing packets */
193 extern int      phase;          /* Current state of link - see values below */
194 extern int      baud_rate;      /* Current link speed in bits/sec */
195 extern char     *progname;      /* Name of this program */
196 extern int      redirect_stderr;/* Connector's stderr should go to file */
197 extern char     peer_authname[];/* Authenticated name of peer */
198 extern int      privileged;     /* We were run by real-uid root */
199 extern int      need_holdoff;   /* Need holdoff period after link terminates */
200 extern char     **script_env;   /* Environment variables for scripts */
201 extern int      detached;       /* Have detached from controlling tty */
202 extern GIDSET_TYPE groups[NGROUPS_MAX]; /* groups the user is in */
203 extern int      ngroups;        /* How many groups valid in groups */
204 extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
205 extern int      link_stats_valid; /* set if link_stats is valid */
206 extern int      link_connect_time; /* time the link was up for */
207 extern int      using_pty;      /* using pty as device (notty or pty opt.) */
208 extern int      log_to_fd;      /* logging to this fd as well as syslog */
209 extern bool     log_default;    /* log_to_fd is default (stdout) */
210 extern char     *no_ppp_msg;    /* message to print if ppp not in kernel */
211 extern volatile int status;     /* exit status for pppd */
212 extern bool     devnam_fixed;   /* can no longer change devnam */
213 extern int      unsuccess;      /* # unsuccessful connection attempts */
214 extern int      do_callback;    /* set if we want to do callback next */
215 extern int      doing_callback; /* set if this is a callback */
216 extern char     ppp_devnam[MAXPATHLEN];
217 extern int      listen_time;    /* time to listen first (ms) */
218 extern struct notifier *pidchange;   /* for notifications of pid changing */
219 extern struct notifier *phasechange; /* for notifications of phase changes */
220 extern struct notifier *exitnotify;  /* for notification that we're exiting */
221 extern struct notifier *sigreceived; /* notification of received signal */
222 extern struct notifier *ip_up_notifier; /* IPCP has come up */
223 extern struct notifier *ip_down_notifier; /* IPCP has gone down */
224 extern struct notifier *auth_up_notifier; /* peer has authenticated */
225 extern struct notifier *link_down_notifier; /* link has gone down */
226
227 /* Values for do_callback and doing_callback */
228 #define CALLBACK_DIALIN         1       /* we are expecting the call back */
229 #define CALLBACK_DIALOUT        2       /* we are dialling out to call back */
230
231 /*
232  * Variables set by command-line options.
233  */
234
235 extern int      debug;          /* Debug flag */
236 extern int      kdebugflag;     /* Tell kernel to print debug messages */
237 extern int      default_device; /* Using /dev/tty or equivalent */
238 extern char     devnam[MAXPATHLEN];     /* Device name */
239 extern int      crtscts;        /* Use hardware flow control */
240 extern bool     modem;          /* Use modem control lines */
241 extern int      inspeed;        /* Input/Output speed requested */
242 extern u_int32_t netmask;       /* IP netmask to set on interface */
243 extern bool     lockflag;       /* Create lock file to lock the serial dev */
244 extern bool     nodetach;       /* Don't detach from controlling tty */
245 extern bool     updetach;       /* Detach from controlling tty when link up */
246 extern char     *initializer;   /* Script to initialize physical link */
247 extern char     *connect_script; /* Script to establish physical link */
248 extern char     *disconnect_script; /* Script to disestablish physical link */
249 extern char     *welcomer;      /* Script to welcome client after connection */
250 extern char     *ptycommand;    /* Command to run on other side of pty */
251 extern int      maxconnect;     /* Maximum connect time (seconds) */
252 extern char     user[MAXNAMELEN];/* Our name for authenticating ourselves */
253 extern char     passwd[MAXSECRETLEN];   /* Password for PAP or CHAP */
254 extern bool     auth_required;  /* Peer is required to authenticate */
255 extern bool     persist;        /* Reopen link after it goes down */
256 extern bool     uselogin;       /* Use /etc/passwd for checking PAP */
257 extern char     our_name[MAXNAMELEN];/* Our name for authentication purposes */
258 extern char     remote_name[MAXNAMELEN]; /* Peer's name for authentication */
259 extern bool     explicit_remote;/* remote_name specified with remotename opt */
260 extern bool     demand;         /* Do dial-on-demand */
261 extern char     *ipparam;       /* Extra parameter for ip up/down scripts */
262 extern bool     cryptpap;       /* Others' PAP passwords are encrypted */
263 extern int      idle_time_limit;/* Shut down link if idle for this long */
264 extern int      holdoff;        /* Dead time before restarting */
265 extern bool     holdoff_specified; /* true if user gave a holdoff value */
266 extern bool     notty;          /* Stdin/out is not a tty */
267 extern char     *pty_socket;    /* Socket to connect to pty */
268 extern char     *record_file;   /* File to record chars sent/received */
269 extern bool     sync_serial;    /* Device is synchronous serial device */
270 extern int      maxfail;        /* Max # of unsuccessful connection attempts */
271 extern char     linkname[MAXPATHLEN]; /* logical name for link */
272 extern bool     tune_kernel;    /* May alter kernel settings as necessary */
273 extern int      connect_delay;  /* Time to delay after connect script */
274 extern int      max_data_rate;  /* max bytes/sec through charshunt */
275 extern int      req_unit;       /* interface unit number to use */
276 extern bool     multilink;      /* enable multilink operation */
277 extern bool     noendpoint;     /* don't send or accept endpt. discrim. */
278 extern char     *bundle_name;   /* bundle name for multilink */
279 extern bool     dump_options;   /* print out option values */
280 extern bool     dryrun;         /* check everything, print options, exit */
281
282 #ifdef PPP_FILTER
283 extern struct   bpf_program pass_filter;   /* Filter for pkts to pass */
284 extern struct   bpf_program active_filter; /* Filter for link-active pkts */
285 #endif
286
287 #ifdef MSLANMAN
288 extern bool     ms_lanman;      /* Use LanMan password instead of NT */
289                                 /* Has meaning only with MS-CHAP challenges */
290 #endif
291
292 extern char *current_option;    /* the name of the option being parsed */
293 extern int  privileged_option;  /* set iff the current option came from root */
294 extern char *option_source;     /* string saying where the option came from */
295 extern int  option_priority;    /* priority of current options */
296
297 /*
298  * Values for phase.
299  */
300 #define PHASE_DEAD              0
301 #define PHASE_INITIALIZE        1
302 #define PHASE_SERIALCONN        2
303 #define PHASE_DORMANT           3
304 #define PHASE_ESTABLISH         4
305 #define PHASE_AUTHENTICATE      5
306 #define PHASE_CALLBACK          6
307 #define PHASE_NETWORK           7
308 #define PHASE_RUNNING           8
309 #define PHASE_TERMINATE         9
310 #define PHASE_DISCONNECT        10
311 #define PHASE_HOLDOFF           11
312
313 /*
314  * The following struct gives the addresses of procedures to call
315  * for a particular protocol.
316  */
317 struct protent {
318     u_short protocol;           /* PPP protocol number */
319     /* Initialization procedure */
320     void (*init) __P((int unit));
321     /* Process a received packet */
322     void (*input) __P((int unit, u_char *pkt, int len));
323     /* Process a received protocol-reject */
324     void (*protrej) __P((int unit));
325     /* Lower layer has come up */
326     void (*lowerup) __P((int unit));
327     /* Lower layer has gone down */
328     void (*lowerdown) __P((int unit));
329     /* Open the protocol */
330     void (*open) __P((int unit));
331     /* Close the protocol */
332     void (*close) __P((int unit, char *reason));
333     /* Print a packet in readable form */
334     int  (*printpkt) __P((u_char *pkt, int len,
335                           void (*printer) __P((void *, char *, ...)),
336                           void *arg));
337     /* Process a received data packet */
338     void (*datainput) __P((int unit, u_char *pkt, int len));
339     bool enabled_flag;          /* 0 iff protocol is disabled */
340     char *name;                 /* Text name of protocol */
341     char *data_name;            /* Text name of corresponding data protocol */
342     option_t *options;          /* List of command-line options */
343     /* Check requested options, assign defaults */
344     void (*check_options) __P((void));
345     /* Configure interface for demand-dial */
346     int  (*demand_conf) __P((int unit));
347     /* Say whether to bring up link for this pkt */
348     int  (*active_pkt) __P((u_char *pkt, int len));
349 };
350
351 /* Table of pointers to supported protocols */
352 extern struct protent *protocols[];
353
354 /*
355  * This struct contains pointers to a set of procedures for
356  * doing operations on a "channel".  A channel provides a way
357  * to send and receive PPP packets - the canonical example is
358  * a serial port device in PPP line discipline (or equivalently
359  * with PPP STREAMS modules pushed onto it).
360  */
361 struct channel {
362         /* set of options for this channel */
363         option_t *options;
364         /* find and process a per-channel options file */
365         void (*process_extra_options) __P((void));
366         /* check all the options that have been given */
367         void (*check_options) __P((void));
368         /* get the channel ready to do PPP, return a file descriptor */
369         int  (*connect) __P((void));
370         /* we're finished with the channel */
371         void (*disconnect) __P((void));
372         /* put the channel into PPP `mode' */
373         int  (*establish_ppp) __P((int));
374         /* take the channel out of PPP `mode', restore loopback if demand */
375         void (*disestablish_ppp) __P((int));
376         /* set the transmit-side PPP parameters of the channel */
377         void (*send_config) __P((int, u_int32_t, int, int));
378         /* set the receive-side PPP parameters of the channel */
379         void (*recv_config) __P((int, u_int32_t, int, int));
380         /* cleanup on error or normal exit */
381         void (*cleanup) __P((void));
382         /* close the device, called in children after fork */
383         void (*close) __P((void));
384 };
385
386 extern struct channel *the_channel;
387
388 #define ppp_send_config(unit, mtu, accm, pc, acc)                        \
389 do {                                                                     \
390         if (the_channel->send_config)                                    \
391                 (*the_channel->send_config)((mtu), (accm), (pc), (acc)); \
392 } while (0)
393
394 #define ppp_recv_config(unit, mtu, accm, pc, acc)                        \
395 do {                                                                     \
396         if (the_channel->send_config)                                    \
397                 (*the_channel->recv_config)((mtu), (accm), (pc), (acc)); \
398 } while (0)
399
400 /*
401  * Prototypes.
402  */
403
404 /* Procedures exported from main.c. */
405 void set_ifunit __P((int));     /* set stuff that depends on ifunit */
406 void detach __P((void));        /* Detach from controlling tty */
407 void die __P((int));            /* Cleanup and exit */
408 void quit __P((void));          /* like die(1) */
409 void novm __P((char *));        /* Say we ran out of memory, and die */
410 void timeout __P((void (*func)(void *), void *arg, int s, int us));
411                                 /* Call func(arg) after s.us seconds */
412 void untimeout __P((void (*func)(void *), void *arg));
413                                 /* Cancel call to func(arg) */
414 void record_child __P((int, char *, void (*) (void *), void *));
415 int  device_script __P((char *cmd, int in, int out, int dont_wait));
416                                 /* Run `cmd' with given stdin and stdout */
417 pid_t run_program __P((char *prog, char **args, int must_exist,
418                        void (*done)(void *), void *arg));
419                                 /* Run program prog with args in child */
420 void reopen_log __P((void));    /* (re)open the connection to syslog */
421 void update_link_stats __P((int)); /* Get stats at link termination */
422 void script_setenv __P((char *, char *, int));  /* set script env var */
423 void script_unsetenv __P((char *));             /* unset script env var */
424 void new_phase __P((int));      /* signal start of new phase */
425 void add_notifier __P((struct notifier **, notify_func, void *));
426 void remove_notifier __P((struct notifier **, notify_func, void *));
427 void notify __P((struct notifier *, int));
428
429 /* Procedures exported from tty.c. */
430 void tty_init __P((void));
431
432 /* Procedures exported from utils.c. */
433 void log_packet __P((u_char *, int, char *, int));
434                                 /* Format a packet and log it with syslog */
435 void print_string __P((char *, int,  void (*) (void *, char *, ...),
436                 void *));       /* Format a string for output */
437 int slprintf __P((char *, int, char *, ...));           /* sprintf++ */
438 int vslprintf __P((char *, int, char *, va_list));      /* vsprintf++ */
439 size_t strlcpy __P((char *, const char *, size_t));     /* safe strcpy */
440 size_t strlcat __P((char *, const char *, size_t));     /* safe strncpy */
441 void dbglog __P((char *, ...)); /* log a debug message */
442 void info __P((char *, ...));   /* log an informational message */
443 void notice __P((char *, ...)); /* log a notice-level message */
444 void warn __P((char *, ...));   /* log a warning message */
445 void error __P((char *, ...));  /* log an error message */
446 void fatal __P((char *, ...));  /* log an error message and die(1) */
447 void init_pr_log __P((char *, int));    /* initialize for using pr_log */
448 void pr_log __P((void *, char *, ...)); /* printer fn, output to syslog */
449 void end_pr_log __P((void));    /* finish up after using pr_log */
450
451 /* Procedures exported from auth.c */
452 void link_required __P((int));    /* we are starting to use the link */
453 void link_terminated __P((int));  /* we are finished with the link */
454 void link_down __P((int));        /* the LCP layer has left the Opened state */
455 void link_established __P((int)); /* the link is up; authenticate now */
456 void start_networks __P((void));  /* start all the network control protos */
457 void np_up __P((int, int));       /* a network protocol has come up */
458 void np_down __P((int, int));     /* a network protocol has gone down */
459 void np_finished __P((int, int)); /* a network protocol no longer needs link */
460 void auth_peer_fail __P((int, int));
461                                 /* peer failed to authenticate itself */
462 void auth_peer_success __P((int, int, char *, int));
463                                 /* peer successfully authenticated itself */
464 void auth_withpeer_fail __P((int, int));
465                                 /* we failed to authenticate ourselves */
466 void auth_withpeer_success __P((int, int));
467                                 /* we successfully authenticated ourselves */
468 void auth_check_options __P((void));
469                                 /* check authentication options supplied */
470 void auth_reset __P((int));     /* check what secrets we have */
471 int  check_passwd __P((int, char *, int, char *, int, char **));
472                                 /* Check peer-supplied username/password */
473 int  get_secret __P((int, char *, char *, char *, int *, int));
474                                 /* get "secret" for chap */
475 int  auth_ip_addr __P((int, u_int32_t));
476                                 /* check if IP address is authorized */
477 int  bad_ip_adrs __P((u_int32_t));
478                                 /* check if IP address is unreasonable */
479
480 /* Procedures exported from demand.c */
481 void demand_conf __P((void));   /* config interface(s) for demand-dial */
482 void demand_block __P((void));  /* set all NPs to queue up packets */
483 void demand_unblock __P((void)); /* set all NPs to pass packets */
484 void demand_discard __P((void)); /* set all NPs to discard packets */
485 void demand_rexmit __P((int));  /* retransmit saved frames for an NP */
486 int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
487 int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
488
489 /* Procedures exported from multilink.c */
490 void mp_check_options __P((void)); /* Check multilink-related options */
491 int  mp_join_bundle __P((void));  /* join our link to an appropriate bundle */
492 char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */
493 int  str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */
494
495 /* Procedures exported from sys-*.c */
496 void sys_init __P((void));      /* Do system-dependent initialization */
497 void sys_cleanup __P((void));   /* Restore system state before exiting */
498 int  sys_check_options __P((void)); /* Check options specified */
499 void sys_close __P((void));     /* Clean up in a child before execing */
500 int  ppp_available __P((void)); /* Test whether ppp kernel support exists */
501 int  get_pty __P((int *, int *, char *, int));  /* Get pty master/slave */
502 int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
503 int  tty_establish_ppp __P((int));  /* Turn serial port into a ppp interface */
504 void tty_disestablish_ppp __P((int)); /* Restore port to normal operation */
505 void make_new_bundle __P((int, int, int, int)); /* Create new bundle */
506 int  bundle_attach __P((int));  /* Attach link to existing bundle */
507 void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */
508 void clean_check __P((void));   /* Check if line was 8-bit clean */
509 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
510 void restore_tty __P((int));    /* Restore port's original parameters */
511 void setdtr __P((int, int));    /* Raise or lower port's DTR line */
512 void output __P((int, u_char *, int)); /* Output a PPP packet */
513 void wait_input __P((struct timeval *));
514                                 /* Wait for input, with timeout */
515 void add_fd __P((int));         /* Add fd to set to wait for */
516 void remove_fd __P((int));      /* Remove fd from set to wait for */
517 int  read_packet __P((u_char *)); /* Read PPP packet */
518 int  get_loop_output __P((void)); /* Read pkts from loopback */
519 void tty_send_config __P((int, u_int32_t, int, int));
520                                 /* Configure i/f transmit parameters */
521 void tty_set_xaccm __P((ext_accm));
522                                 /* Set extended transmit ACCM */
523 void tty_recv_config __P((int, u_int32_t, int, int));
524                                 /* Configure i/f receive parameters */
525 int  ccp_test __P((int, u_char *, int, int));
526                                 /* Test support for compression scheme */
527 void ccp_flags_set __P((int, int, int));
528                                 /* Set kernel CCP state */
529 int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
530 int  get_idle_time __P((int, struct ppp_idle *));
531                                 /* Find out how long link has been idle */
532 int  get_ppp_stats __P((int, struct pppd_stats *));
533                                 /* Return link statistics */
534 void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */
535 int  sifvjcomp __P((int, int, int, int));
536                                 /* Configure VJ TCP header compression */
537 int  sifup __P((int));          /* Configure i/f up for one protocol */
538 int  sifnpmode __P((int u, int proto, enum NPmode mode));
539                                 /* Set mode for handling packets for proto */
540 int  sifdown __P((int));        /* Configure i/f down for one protocol */
541 int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
542                                 /* Configure IPv4 addresses for i/f */
543 int  cifaddr __P((int, u_int32_t, u_int32_t));
544                                 /* Reset i/f IP addresses */
545 #ifdef INET6
546 int  sif6addr __P((int, eui64_t, eui64_t));
547                                 /* Configure IPv6 addresses for i/f */
548 int  cif6addr __P((int, eui64_t, eui64_t));
549                                 /* Remove an IPv6 address from i/f */
550 #endif
551 int  sifdefaultroute __P((int, u_int32_t, u_int32_t));
552                                 /* Create default route through i/f */
553 int  cifdefaultroute __P((int, u_int32_t, u_int32_t));
554                                 /* Delete default route through i/f */
555 int  sifproxyarp __P((int, u_int32_t));
556                                 /* Add proxy ARP entry for peer */
557 int  cifproxyarp __P((int, u_int32_t));
558                                 /* Delete proxy ARP entry for peer */
559 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
560 int  lock __P((char *));        /* Create lock file for device */
561 int  relock __P((int));         /* Rewrite lock file with new pid */
562 void unlock __P((void));        /* Delete previously-created lock file */
563 void logwtmp __P((const char *, const char *, const char *));
564                                 /* Write entry to wtmp file */
565 int  get_host_seed __P((void)); /* Get host-dependent random number seed */
566 int  have_route_to __P((u_int32_t)); /* Check if route to addr exists */
567 #ifdef PPP_FILTER
568 int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
569                                 /* Set filter programs in kernel */
570 #endif
571 #ifdef IPX_CHANGE
572 int  sipxfaddr __P((int, unsigned long, unsigned char *));
573 int  cipxfaddr __P((int));
574 #endif
575 int  get_if_hwaddr __P((u_char *addr, char *name));
576 char *get_first_ethernet __P((void));
577
578 /* Procedures exported from options.c */
579 int  parse_args __P((int argc, char **argv));
580                                 /* Parse options from arguments given */
581 int  options_from_file __P((char *filename, int must_exist, int check_prot,
582                             int privileged));
583                                 /* Parse options from an options file */
584 int  options_from_user __P((void)); /* Parse options from user's .ppprc */
585 int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
586 int  options_from_list __P((struct wordlist *, int privileged));
587                                 /* Parse options from a wordlist */
588 int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
589                                 /* Read a word from a file */
590 void option_error __P((char *fmt, ...));
591                                 /* Print an error message about an option */
592 int int_option __P((char *, int *));
593                                 /* Simplified number_option for decimal ints */
594 void add_options __P((option_t *)); /* Add extra options */
595 void check_options __P((void)); /* check values after all options parsed */
596 int  override_value __P((const char *, int, const char *));
597                                 /* override value if permitted by priority */
598 void print_options __P((void (*) __P((void *, char *, ...)), void *));
599                                 /* print out values of all options */
600
601 int parse_dotted_ip __P((char *, u_int32_t *));
602
603 /*
604  * Hooks to enable plugins to change various things.
605  */
606 extern int (*new_phase_hook) __P((int));
607 extern int (*idle_time_hook) __P((struct ppp_idle *));
608 extern int (*holdoff_hook) __P((void));
609 extern int (*pap_check_hook) __P((void));
610 extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
611                                  struct wordlist **paddrs,
612                                  struct wordlist **popts));
613 extern void (*pap_logout_hook) __P((void));
614 extern int (*pap_passwd_hook) __P((char *user, char *passwd));
615 extern void (*ip_up_hook) __P((void));
616 extern void (*ip_down_hook) __P((void));
617 extern void (*ip_choose_hook) __P((u_int32_t *));
618
619 /*
620  * Inline versions of get/put char/short/long.
621  * Pointer is advanced; we assume that both arguments
622  * are lvalues and will already be in registers.
623  * cp MUST be u_char *.
624  */
625 #define GETCHAR(c, cp) { \
626         (c) = *(cp)++; \
627 }
628 #define PUTCHAR(c, cp) { \
629         *(cp)++ = (u_char) (c); \
630 }
631
632
633 #define GETSHORT(s, cp) { \
634         (s) = *(cp)++ << 8; \
635         (s) |= *(cp)++; \
636 }
637 #define PUTSHORT(s, cp) { \
638         *(cp)++ = (u_char) ((s) >> 8); \
639         *(cp)++ = (u_char) (s); \
640 }
641
642 #define GETLONG(l, cp) { \
643         (l) = *(cp)++ << 8; \
644         (l) |= *(cp)++; (l) <<= 8; \
645         (l) |= *(cp)++; (l) <<= 8; \
646         (l) |= *(cp)++; \
647 }
648 #define PUTLONG(l, cp) { \
649         *(cp)++ = (u_char) ((l) >> 24); \
650         *(cp)++ = (u_char) ((l) >> 16); \
651         *(cp)++ = (u_char) ((l) >> 8); \
652         *(cp)++ = (u_char) (l); \
653 }
654
655 #define INCPTR(n, cp)   ((cp) += (n))
656 #define DECPTR(n, cp)   ((cp) -= (n))
657
658 /*
659  * System dependent definitions for user-level 4.3BSD UNIX implementation.
660  */
661
662 #define TIMEOUT(r, f, t)        timeout((r), (f), (t), 0)
663 #define UNTIMEOUT(r, f)         untimeout((r), (f))
664
665 #define BCOPY(s, d, l)          memcpy(d, s, l)
666 #define BZERO(s, n)             memset(s, 0, n)
667
668 #define PRINTMSG(m, l)          { info("Remote message: %0.*v", l, m); }
669
670 /*
671  * MAKEHEADER - Add Header fields to a packet.
672  */
673 #define MAKEHEADER(p, t) { \
674     PUTCHAR(PPP_ALLSTATIONS, p); \
675     PUTCHAR(PPP_UI, p); \
676     PUTSHORT(t, p); }
677
678 /*
679  * Exit status values.
680  */
681 #define EXIT_OK                 0
682 #define EXIT_FATAL_ERROR        1
683 #define EXIT_OPTION_ERROR       2
684 #define EXIT_NOT_ROOT           3
685 #define EXIT_NO_KERNEL_SUPPORT  4
686 #define EXIT_USER_REQUEST       5
687 #define EXIT_LOCK_FAILED        6
688 #define EXIT_OPEN_FAILED        7
689 #define EXIT_CONNECT_FAILED     8
690 #define EXIT_PTYCMD_FAILED      9
691 #define EXIT_NEGOTIATION_FAILED 10
692 #define EXIT_PEER_AUTH_FAILED   11
693 #define EXIT_IDLE_TIMEOUT       12
694 #define EXIT_CONNECT_TIME       13
695 #define EXIT_CALLBACK           14
696 #define EXIT_PEER_DEAD          15
697 #define EXIT_HANGUP             16
698 #define EXIT_LOOPBACK           17
699 #define EXIT_INIT_FAILED        18
700 #define EXIT_AUTH_TOPEER_FAILED 19
701
702 /*
703  * Debug macros.  Slightly useful for finding bugs in pppd, not particularly
704  * useful for finding out why your connection isn't being established.
705  */
706 #ifdef DEBUGALL
707 #define DEBUGMAIN       1
708 #define DEBUGFSM        1
709 #define DEBUGLCP        1
710 #define DEBUGIPCP       1
711 #define DEBUGIPV6CP     1
712 #define DEBUGUPAP       1
713 #define DEBUGCHAP       1
714 #endif
715
716 #ifndef LOG_PPP                 /* we use LOG_LOCAL2 for syslog by default */
717 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
718   || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
719   || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
720 #define LOG_PPP LOG_LOCAL2
721 #else
722 #define LOG_PPP LOG_DAEMON
723 #endif
724 #endif /* LOG_PPP */
725
726 #ifdef DEBUGMAIN
727 #define MAINDEBUG(x)    if (debug) dbglog x
728 #else
729 #define MAINDEBUG(x)
730 #endif
731
732 #ifdef DEBUGSYS
733 #define SYSDEBUG(x)     if (debug) dbglog x
734 #else
735 #define SYSDEBUG(x)
736 #endif
737
738 #ifdef DEBUGFSM
739 #define FSMDEBUG(x)     if (debug) dbglog x
740 #else
741 #define FSMDEBUG(x)
742 #endif
743
744 #ifdef DEBUGLCP
745 #define LCPDEBUG(x)     if (debug) dbglog x
746 #else
747 #define LCPDEBUG(x)
748 #endif
749
750 #ifdef DEBUGIPCP
751 #define IPCPDEBUG(x)    if (debug) dbglog x
752 #else
753 #define IPCPDEBUG(x)
754 #endif
755
756 #ifdef DEBUGIPV6CP
757 #define IPV6CPDEBUG(x)  if (debug) dbglog x
758 #else
759 #define IPV6CPDEBUG(x)
760 #endif
761
762 #ifdef DEBUGUPAP
763 #define UPAPDEBUG(x)    if (debug) dbglog x
764 #else
765 #define UPAPDEBUG(x)
766 #endif
767
768 #ifdef DEBUGCHAP
769 #define CHAPDEBUG(x)    if (debug) dbglog x
770 #else
771 #define CHAPDEBUG(x)
772 #endif
773
774 #ifdef DEBUGIPXCP
775 #define IPXCPDEBUG(x)   if (debug) dbglog x
776 #else
777 #define IPXCPDEBUG(x)
778 #endif
779
780 #ifndef SIGTYPE
781 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
782 #define SIGTYPE void
783 #else
784 #define SIGTYPE int
785 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
786 #endif /* SIGTYPE */
787
788 #ifndef MIN
789 #define MIN(a, b)       ((a) < (b)? (a): (b))
790 #endif
791 #ifndef MAX
792 #define MAX(a, b)       ((a) > (b)? (a): (b))
793 #endif
794
795 #endif /* __PPP_H__ */