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