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