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