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