2 * pppd.h - PPP daemon global declarations.
4 * Copyright (c) 1989 Carnegie Mellon University.
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.
19 * $Id: pppd.h,v 1.77 2002/11/02 19:48:13 carlsonj Exp $
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"
42 #define __V(x) (va_alist) va_dcl
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 */
62 * Option descriptor structure.
65 typedef unsigned char bool;
78 char *name; /* name of the option */
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 */
124 #define OPT_VAL(x) ((x) & OPT_VALUE)
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 */
134 #define GIDSET_TYPE gid_t
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 */
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
151 unsigned int bytes_in;
152 unsigned int bytes_out;
153 unsigned int pkts_in;
154 unsigned int pkts_out;
157 /* Used for storing a sequence of words. Usually malloced. */
159 struct wordlist *next;
163 /* An endpoint discriminator, used with multilink. */
164 #define MAX_ENDP_LEN 20 /* maximum length of discriminator value */
167 unsigned char length;
168 unsigned char value[MAX_ENDP_LEN];
171 /* values for epdisc.class */
172 #define EPD_NULL 0 /* null discriminator, no data */
177 #define EPD_PHONENUM 5
179 typedef void (*notify_func) __P((void *, int));
182 struct notifier *next;
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) */
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 */
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 */
239 * Variables set by command-line options.
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 */
290 extern unsigned int maxoctets; /* Maximum octetes per session (in bytes) */
291 extern int maxoctets_dir; /* Direction :
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
306 extern struct bpf_program pass_filter; /* Filter for pkts to pass */
307 extern struct bpf_program active_filter; /* Filter for link-active pkts */
311 extern bool ms_lanman; /* Use LanMan password instead of NT */
312 /* Has meaning only with MS-CHAP challenges */
315 /* Values for auth_pending, auth_done */
316 #define PAP_WITHPEER 0x1
318 #define CHAP_WITHPEER 0x4
319 #define CHAP_PEER 0x8
320 #define EAP_WITHPEER 0x10
321 #define EAP_PEER 0x20
323 /* Values for auth_done only */
324 #define CHAP_MD5_WITHPEER 0x40
325 #define CHAP_MD5_PEER 0x80
327 #define CHAP_MS_SHIFT 8 /* LSB position for MS auths */
328 #define CHAP_MS_WITHPEER 0x100
329 #define CHAP_MS_PEER 0x200
330 #define CHAP_MS2_WITHPEER 0x400
331 #define CHAP_MS2_PEER 0x800
334 extern char *current_option; /* the name of the option being parsed */
335 extern int privileged_option; /* set iff the current option came from root */
336 extern char *option_source; /* string saying where the option came from */
337 extern int option_priority; /* priority of current options */
343 #define PHASE_INITIALIZE 1
344 #define PHASE_SERIALCONN 2
345 #define PHASE_DORMANT 3
346 #define PHASE_ESTABLISH 4
347 #define PHASE_AUTHENTICATE 5
348 #define PHASE_CALLBACK 6
349 #define PHASE_NETWORK 7
350 #define PHASE_RUNNING 8
351 #define PHASE_TERMINATE 9
352 #define PHASE_DISCONNECT 10
353 #define PHASE_HOLDOFF 11
356 * The following struct gives the addresses of procedures to call
357 * for a particular protocol.
360 u_short protocol; /* PPP protocol number */
361 /* Initialization procedure */
362 void (*init) __P((int unit));
363 /* Process a received packet */
364 void (*input) __P((int unit, u_char *pkt, int len));
365 /* Process a received protocol-reject */
366 void (*protrej) __P((int unit));
367 /* Lower layer has come up */
368 void (*lowerup) __P((int unit));
369 /* Lower layer has gone down */
370 void (*lowerdown) __P((int unit));
371 /* Open the protocol */
372 void (*open) __P((int unit));
373 /* Close the protocol */
374 void (*close) __P((int unit, char *reason));
375 /* Print a packet in readable form */
376 int (*printpkt) __P((u_char *pkt, int len,
377 void (*printer) __P((void *, char *, ...)),
379 /* Process a received data packet */
380 void (*datainput) __P((int unit, u_char *pkt, int len));
381 bool enabled_flag; /* 0 iff protocol is disabled */
382 char *name; /* Text name of protocol */
383 char *data_name; /* Text name of corresponding data protocol */
384 option_t *options; /* List of command-line options */
385 /* Check requested options, assign defaults */
386 void (*check_options) __P((void));
387 /* Configure interface for demand-dial */
388 int (*demand_conf) __P((int unit));
389 /* Say whether to bring up link for this pkt */
390 int (*active_pkt) __P((u_char *pkt, int len));
393 /* Table of pointers to supported protocols */
394 extern struct protent *protocols[];
397 * This struct contains pointers to a set of procedures for
398 * doing operations on a "channel". A channel provides a way
399 * to send and receive PPP packets - the canonical example is
400 * a serial port device in PPP line discipline (or equivalently
401 * with PPP STREAMS modules pushed onto it).
404 /* set of options for this channel */
406 /* find and process a per-channel options file */
407 void (*process_extra_options) __P((void));
408 /* check all the options that have been given */
409 void (*check_options) __P((void));
410 /* get the channel ready to do PPP, return a file descriptor */
411 int (*connect) __P((void));
412 /* we're finished with the channel */
413 void (*disconnect) __P((void));
414 /* put the channel into PPP `mode' */
415 int (*establish_ppp) __P((int));
416 /* take the channel out of PPP `mode', restore loopback if demand */
417 void (*disestablish_ppp) __P((int));
418 /* set the transmit-side PPP parameters of the channel */
419 void (*send_config) __P((int, u_int32_t, int, int));
420 /* set the receive-side PPP parameters of the channel */
421 void (*recv_config) __P((int, u_int32_t, int, int));
422 /* cleanup on error or normal exit */
423 void (*cleanup) __P((void));
424 /* close the device, called in children after fork */
425 void (*close) __P((void));
428 extern struct channel *the_channel;
430 #define ppp_send_config(unit, mtu, accm, pc, acc) \
432 if (the_channel->send_config) \
433 (*the_channel->send_config)((mtu), (accm), (pc), (acc)); \
436 #define ppp_recv_config(unit, mtu, accm, pc, acc) \
438 if (the_channel->send_config) \
439 (*the_channel->recv_config)((mtu), (accm), (pc), (acc)); \
446 /* Procedures exported from main.c. */
447 void set_ifunit __P((int)); /* set stuff that depends on ifunit */
448 void detach __P((void)); /* Detach from controlling tty */
449 void die __P((int)); /* Cleanup and exit */
450 void quit __P((void)); /* like die(1) */
451 void novm __P((char *)); /* Say we ran out of memory, and die */
452 void timeout __P((void (*func)(void *), void *arg, int s, int us));
453 /* Call func(arg) after s.us seconds */
454 void untimeout __P((void (*func)(void *), void *arg));
455 /* Cancel call to func(arg) */
456 void record_child __P((int, char *, void (*) (void *), void *));
457 int device_script __P((char *cmd, int in, int out, int dont_wait));
458 /* Run `cmd' with given stdin and stdout */
459 pid_t run_program __P((char *prog, char **args, int must_exist,
460 void (*done)(void *), void *arg));
461 /* Run program prog with args in child */
462 void reopen_log __P((void)); /* (re)open the connection to syslog */
463 void update_link_stats __P((int)); /* Get stats at link termination */
464 void script_setenv __P((char *, char *, int)); /* set script env var */
465 void script_unsetenv __P((char *)); /* unset script env var */
466 void new_phase __P((int)); /* signal start of new phase */
467 void add_notifier __P((struct notifier **, notify_func, void *));
468 void remove_notifier __P((struct notifier **, notify_func, void *));
469 void notify __P((struct notifier *, int));
471 /* Procedures exported from tty.c. */
472 void tty_init __P((void));
474 /* Procedures exported from utils.c. */
475 void log_packet __P((u_char *, int, char *, int));
476 /* Format a packet and log it with syslog */
477 void print_string __P((char *, int, void (*) (void *, char *, ...),
478 void *)); /* Format a string for output */
479 int slprintf __P((char *, int, char *, ...)); /* sprintf++ */
480 int vslprintf __P((char *, int, char *, va_list)); /* vsprintf++ */
481 size_t strlcpy __P((char *, const char *, size_t)); /* safe strcpy */
482 size_t strlcat __P((char *, const char *, size_t)); /* safe strncpy */
483 void dbglog __P((char *, ...)); /* log a debug message */
484 void info __P((char *, ...)); /* log an informational message */
485 void notice __P((char *, ...)); /* log a notice-level message */
486 void warn __P((char *, ...)); /* log a warning message */
487 void error __P((char *, ...)); /* log an error message */
488 void fatal __P((char *, ...)); /* log an error message and die(1) */
489 void init_pr_log __P((char *, int)); /* initialize for using pr_log */
490 void pr_log __P((void *, char *, ...)); /* printer fn, output to syslog */
491 void end_pr_log __P((void)); /* finish up after using pr_log */
492 void dump_packet __P((const char *, u_char *, int));
493 /* dump packet to debug log if interesting */
495 /* Procedures exported from auth.c */
496 void link_required __P((int)); /* we are starting to use the link */
497 void link_terminated __P((int)); /* we are finished with the link */
498 void link_down __P((int)); /* the LCP layer has left the Opened state */
499 void link_established __P((int)); /* the link is up; authenticate now */
500 void start_networks __P((int)); /* start all the network control protos */
501 void continue_networks __P((int)); /* start network [ip, etc] control protos */
502 void np_up __P((int, int)); /* a network protocol has come up */
503 void np_down __P((int, int)); /* a network protocol has gone down */
504 void np_finished __P((int, int)); /* a network protocol no longer needs link */
505 void auth_peer_fail __P((int, int));
506 /* peer failed to authenticate itself */
507 void auth_peer_success __P((int, int, int, char *, int));
508 /* peer successfully authenticated itself */
509 void auth_withpeer_fail __P((int, int));
510 /* we failed to authenticate ourselves */
511 void auth_withpeer_success __P((int, int, int));
512 /* we successfully authenticated ourselves */
513 void auth_check_options __P((void));
514 /* check authentication options supplied */
515 void auth_reset __P((int)); /* check what secrets we have */
516 int check_passwd __P((int, char *, int, char *, int, char **));
517 /* Check peer-supplied username/password */
518 int get_secret __P((int, char *, char *, char *, int *, int));
519 /* get "secret" for chap */
520 int get_srp_secret __P((int unit, char *client, char *server, char *secret,
522 int auth_ip_addr __P((int, u_int32_t));
523 /* check if IP address is authorized */
524 int auth_number __P((void)); /* check if remote number is authorized */
525 int bad_ip_adrs __P((u_int32_t));
526 /* check if IP address is unreasonable */
528 /* Procedures exported from demand.c */
529 void demand_conf __P((void)); /* config interface(s) for demand-dial */
530 void demand_block __P((void)); /* set all NPs to queue up packets */
531 void demand_unblock __P((void)); /* set all NPs to pass packets */
532 void demand_discard __P((void)); /* set all NPs to discard packets */
533 void demand_rexmit __P((int)); /* retransmit saved frames for an NP */
534 int loop_chars __P((unsigned char *, int)); /* process chars from loopback */
535 int loop_frame __P((unsigned char *, int)); /* should we bring link up? */
537 /* Procedures exported from multilink.c */
538 void mp_check_options __P((void)); /* Check multilink-related options */
539 int mp_join_bundle __P((void)); /* join our link to an appropriate bundle */
540 char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */
541 int str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */
543 /* Procedures exported from sys-*.c */
544 void sys_init __P((void)); /* Do system-dependent initialization */
545 void sys_cleanup __P((void)); /* Restore system state before exiting */
546 int sys_check_options __P((void)); /* Check options specified */
547 void sys_close __P((void)); /* Clean up in a child before execing */
548 int ppp_available __P((void)); /* Test whether ppp kernel support exists */
549 int get_pty __P((int *, int *, char *, int)); /* Get pty master/slave */
550 int open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
551 int tty_establish_ppp __P((int)); /* Turn serial port into a ppp interface */
552 void tty_disestablish_ppp __P((int)); /* Restore port to normal operation */
553 void generic_disestablish_ppp __P((int dev_fd)); /* Restore device setting */
554 int generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */
555 void make_new_bundle __P((int, int, int, int)); /* Create new bundle */
556 int bundle_attach __P((int)); /* Attach link to existing bundle */
557 void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */
558 void clean_check __P((void)); /* Check if line was 8-bit clean */
559 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
560 void restore_tty __P((int)); /* Restore port's original parameters */
561 void setdtr __P((int, int)); /* Raise or lower port's DTR line */
562 void output __P((int, u_char *, int)); /* Output a PPP packet */
563 void wait_input __P((struct timeval *));
564 /* Wait for input, with timeout */
565 void add_fd __P((int)); /* Add fd to set to wait for */
566 void remove_fd __P((int)); /* Remove fd from set to wait for */
567 int read_packet __P((u_char *)); /* Read PPP packet */
568 int get_loop_output __P((void)); /* Read pkts from loopback */
569 void tty_send_config __P((int, u_int32_t, int, int));
570 /* Configure i/f transmit parameters */
571 void tty_set_xaccm __P((ext_accm));
572 /* Set extended transmit ACCM */
573 void tty_recv_config __P((int, u_int32_t, int, int));
574 /* Configure i/f receive parameters */
575 int ccp_test __P((int, u_char *, int, int));
576 /* Test support for compression scheme */
577 void ccp_flags_set __P((int, int, int));
578 /* Set kernel CCP state */
579 int ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
580 int get_idle_time __P((int, struct ppp_idle *));
581 /* Find out how long link has been idle */
582 int get_ppp_stats __P((int, struct pppd_stats *));
583 /* Return link statistics */
584 void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */
585 int netif_get_mtu __P((int)); /* Get PPP interface MTU */
586 int sifvjcomp __P((int, int, int, int));
587 /* Configure VJ TCP header compression */
588 int sifup __P((int)); /* Configure i/f up for one protocol */
589 int sifnpmode __P((int u, int proto, enum NPmode mode));
590 /* Set mode for handling packets for proto */
591 int sifdown __P((int)); /* Configure i/f down for one protocol */
592 int sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
593 /* Configure IPv4 addresses for i/f */
594 int cifaddr __P((int, u_int32_t, u_int32_t));
595 /* Reset i/f IP addresses */
597 int sif6addr __P((int, eui64_t, eui64_t));
598 /* Configure IPv6 addresses for i/f */
599 int cif6addr __P((int, eui64_t, eui64_t));
600 /* Remove an IPv6 address from i/f */
602 int sifdefaultroute __P((int, u_int32_t, u_int32_t));
603 /* Create default route through i/f */
604 int cifdefaultroute __P((int, u_int32_t, u_int32_t));
605 /* Delete default route through i/f */
606 int sifproxyarp __P((int, u_int32_t));
607 /* Add proxy ARP entry for peer */
608 int cifproxyarp __P((int, u_int32_t));
609 /* Delete proxy ARP entry for peer */
610 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
611 int lock __P((char *)); /* Create lock file for device */
612 int relock __P((int)); /* Rewrite lock file with new pid */
613 void unlock __P((void)); /* Delete previously-created lock file */
614 void logwtmp __P((const char *, const char *, const char *));
615 /* Write entry to wtmp file */
616 int get_host_seed __P((void)); /* Get host-dependent random number seed */
617 int have_route_to __P((u_int32_t)); /* Check if route to addr exists */
619 int set_filters __P((struct bpf_program *pass, struct bpf_program *active));
620 /* Set filter programs in kernel */
623 int sipxfaddr __P((int, unsigned long, unsigned char *));
624 int cipxfaddr __P((int));
626 int get_if_hwaddr __P((u_char *addr, char *name));
627 char *get_first_ethernet __P((void));
629 /* Procedures exported from options.c */
630 int setipaddr __P((char *, char **, int)); /* Set local/remote ip addresses */
631 int parse_args __P((int argc, char **argv));
632 /* Parse options from arguments given */
633 int options_from_file __P((char *filename, int must_exist, int check_prot,
635 /* Parse options from an options file */
636 int options_from_user __P((void)); /* Parse options from user's .ppprc */
637 int options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
638 int options_from_list __P((struct wordlist *, int privileged));
639 /* Parse options from a wordlist */
640 int getword __P((FILE *f, char *word, int *newlinep, char *filename));
641 /* Read a word from a file */
642 void option_error __P((char *fmt, ...));
643 /* Print an error message about an option */
644 int int_option __P((char *, int *));
645 /* Simplified number_option for decimal ints */
646 void add_options __P((option_t *)); /* Add extra options */
647 void check_options __P((void)); /* check values after all options parsed */
648 int override_value __P((const char *, int, const char *));
649 /* override value if permitted by priority */
650 void print_options __P((void (*) __P((void *, char *, ...)), void *));
651 /* print out values of all options */
653 int parse_dotted_ip __P((char *, u_int32_t *));
656 * Hooks to enable plugins to change various things.
658 extern int (*new_phase_hook) __P((int));
659 extern int (*idle_time_hook) __P((struct ppp_idle *));
660 extern int (*holdoff_hook) __P((void));
661 extern int (*pap_check_hook) __P((void));
662 extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
663 struct wordlist **paddrs,
664 struct wordlist **popts));
665 extern void (*pap_logout_hook) __P((void));
666 extern int (*pap_passwd_hook) __P((char *user, char *passwd));
667 extern int (*allowed_address_hook) __P((u_int32_t addr));
668 extern void (*ip_up_hook) __P((void));
669 extern void (*ip_down_hook) __P((void));
670 extern void (*ip_choose_hook) __P((u_int32_t *));
672 extern int (*chap_check_hook) __P((void));
673 extern int (*chap_passwd_hook) __P((char *user, char *passwd));
675 /* Let a plugin snoop sent and received packets. Useful for L2TP */
676 extern void (*snoop_recv_hook) __P((unsigned char *p, int len));
677 extern void (*snoop_send_hook) __P((unsigned char *p, int len));
680 * Inline versions of get/put char/short/long.
681 * Pointer is advanced; we assume that both arguments
682 * are lvalues and will already be in registers.
683 * cp MUST be u_char *.
685 #define GETCHAR(c, cp) { \
688 #define PUTCHAR(c, cp) { \
689 *(cp)++ = (u_char) (c); \
693 #define GETSHORT(s, cp) { \
694 (s) = *(cp)++ << 8; \
697 #define PUTSHORT(s, cp) { \
698 *(cp)++ = (u_char) ((s) >> 8); \
699 *(cp)++ = (u_char) (s); \
702 #define GETLONG(l, cp) { \
703 (l) = *(cp)++ << 8; \
704 (l) |= *(cp)++; (l) <<= 8; \
705 (l) |= *(cp)++; (l) <<= 8; \
708 #define PUTLONG(l, cp) { \
709 *(cp)++ = (u_char) ((l) >> 24); \
710 *(cp)++ = (u_char) ((l) >> 16); \
711 *(cp)++ = (u_char) ((l) >> 8); \
712 *(cp)++ = (u_char) (l); \
715 #define INCPTR(n, cp) ((cp) += (n))
716 #define DECPTR(n, cp) ((cp) -= (n))
719 * System dependent definitions for user-level 4.3BSD UNIX implementation.
722 #define TIMEOUT(r, f, t) timeout((r), (f), (t), 0)
723 #define UNTIMEOUT(r, f) untimeout((r), (f))
725 #define BCOPY(s, d, l) memcpy(d, s, l)
726 #define BZERO(s, n) memset(s, 0, n)
727 #define BCMP(s1, s2, l) memcmp(s1, s2, l)
729 #define PRINTMSG(m, l) { info("Remote message: %0.*v", l, m); }
732 * MAKEHEADER - Add Header fields to a packet.
734 #define MAKEHEADER(p, t) { \
735 PUTCHAR(PPP_ALLSTATIONS, p); \
736 PUTCHAR(PPP_UI, p); \
740 * Exit status values.
743 #define EXIT_FATAL_ERROR 1
744 #define EXIT_OPTION_ERROR 2
745 #define EXIT_NOT_ROOT 3
746 #define EXIT_NO_KERNEL_SUPPORT 4
747 #define EXIT_USER_REQUEST 5
748 #define EXIT_LOCK_FAILED 6
749 #define EXIT_OPEN_FAILED 7
750 #define EXIT_CONNECT_FAILED 8
751 #define EXIT_PTYCMD_FAILED 9
752 #define EXIT_NEGOTIATION_FAILED 10
753 #define EXIT_PEER_AUTH_FAILED 11
754 #define EXIT_IDLE_TIMEOUT 12
755 #define EXIT_CONNECT_TIME 13
756 #define EXIT_CALLBACK 14
757 #define EXIT_PEER_DEAD 15
758 #define EXIT_HANGUP 16
759 #define EXIT_LOOPBACK 17
760 #define EXIT_INIT_FAILED 18
761 #define EXIT_AUTH_TOPEER_FAILED 19
763 #define EXIT_TRAFFIC_LIMIT 20
765 #define EXIT_CNID_AUTH_FAILED 21
768 * Debug macros. Slightly useful for finding bugs in pppd, not particularly
769 * useful for finding out why your connection isn't being established.
776 #define DEBUGIPV6CP 1
781 #ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */
782 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
783 || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
784 || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
785 #define LOG_PPP LOG_LOCAL2
787 #define LOG_PPP LOG_DAEMON
792 #define MAINDEBUG(x) if (debug) dbglog x
798 #define SYSDEBUG(x) if (debug) dbglog x
804 #define FSMDEBUG(x) if (debug) dbglog x
810 #define LCPDEBUG(x) if (debug) dbglog x
816 #define IPCPDEBUG(x) if (debug) dbglog x
822 #define IPV6CPDEBUG(x) if (debug) dbglog x
824 #define IPV6CPDEBUG(x)
828 #define UPAPDEBUG(x) if (debug) dbglog x
834 #define CHAPDEBUG(x) if (debug) dbglog x
840 #define IPXCPDEBUG(x) if (debug) dbglog x
842 #define IPXCPDEBUG(x)
846 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
850 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
854 #define MIN(a, b) ((a) < (b)? (a): (b))
857 #define MAX(a, b) ((a) > (b)? (a): (b))
861 #define offsetof(type, member) ((size_t) &((type *)0)->member)
864 #endif /* __PPP_H__ */