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