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