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