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