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