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