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