2 * pppd.h - PPP daemon global declarations.
4 * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
18 * 3. The name "Carnegie Mellon University" must not be used to
19 * endorse or promote products derived from this software without
20 * prior written permission. For permission or any legal
21 * details, please contact
22 * Office of Technology Transfer
23 * Carnegie Mellon University
25 * Pittsburgh, PA 15213-3890
26 * (412) 268-4387, fax: (412) 268-7395
27 * tech-transfer@andrew.cmu.edu
29 * 4. Redistributions of any form whatsoever must retain the following
31 * "This product includes software developed by Computing Services
32 * at Carnegie Mellon University (http://www.cmu.edu/computing/)."
34 * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
35 * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
36 * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
37 * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
38 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
39 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
40 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
42 * $Id: pppd.h,v 1.96 2008/06/23 11:47:18 paulus Exp $
52 #include <stdio.h> /* for FILE */
53 #include <limits.h> /* for NGROUPS_MAX */
54 #include <sys/param.h> /* for MAXPATHLEN and BSD4_4, if defined */
55 #include <sys/types.h> /* for u_int32_t, if defined */
56 #include <sys/time.h> /* for struct timeval */
57 #include <net/ppp_defs.h>
58 #include "patchlevel.h"
65 #define __V(x) (va_alist) va_dcl
78 #define NUM_PPP 1 /* One PPP interface supported (per process) */
79 #define MAXWORDLEN 1024 /* max length of word in file (incl null) */
80 #define MAXARGS 1 /* max # args to a command */
81 #define MAXNAMELEN 256 /* max length of hostname or name for auth */
82 #define MAXSECRETLEN 256 /* max length of password or secret */
83 #define MAXUNIT 255 /* max ppp interface */
86 * Option descriptor structure.
89 typedef unsigned char bool;
102 char *name
; /* name of the option */
115 /* Values for flags */
116 #define OPT_VALUE 0xff /* mask for presupplied value */
117 #define OPT_HEX 0x100 /* int option is in hex */
118 #define OPT_NOARG 0x200 /* option doesn't take argument */
119 #define OPT_OR 0x400 /* for u32, OR in argument to value */
120 #define OPT_INC 0x400 /* for o_int, increment value */
121 #define OPT_A2OR 0x800 /* for o_bool, OR arg to *(u_char *)addr2 */
122 #define OPT_PRIV 0x1000 /* privileged option */
123 #define OPT_STATIC 0x2000 /* string option goes into static array */
124 #define OPT_NOINCR 0x2000 /* for o_int, value mustn't be increased */
125 #define OPT_LLIMIT 0x4000 /* check value against lower limit */
126 #define OPT_ULIMIT 0x8000 /* check value against upper limit */
127 #define OPT_LIMITS (OPT_LLIMIT|OPT_ULIMIT)
128 #define OPT_ZEROOK 0x10000 /* 0 value is OK even if not within limits */
129 #define OPT_HIDE 0x10000 /* for o_string, print value as ?????? */
130 #define OPT_A2LIST 0x20000 /* for o_special, keep list of values */
131 #define OPT_A2CLRB 0x20000 /* o_bool, clr val bits in *(u_char *)addr2 */
132 #define OPT_ZEROINF 0x40000 /* with OPT_NOINCR, 0 == infinity */
133 #define OPT_PRIO 0x80000 /* process option priorities for this option */
134 #define OPT_PRIOSUB 0x100000 /* subsidiary member of priority group */
135 #define OPT_ALIAS 0x200000 /* option is alias for previous option */
136 #define OPT_A2COPY 0x400000 /* addr2 -> second location to rcv value */
137 #define OPT_ENABLE 0x800000 /* use *addr2 as enable for option */
138 #define OPT_A2CLR 0x1000000 /* clear *(bool *)addr2 */
139 #define OPT_PRIVFIX 0x2000000 /* user can't override if set by root */
140 #define OPT_INITONLY 0x4000000 /* option can only be set in init phase */
141 #define OPT_DEVEQUIV 0x8000000 /* equiv to device name */
142 #define OPT_DEVNAM (OPT_INITONLY | OPT_DEVEQUIV)
143 #define OPT_A2PRINTER 0x10000000 /* *addr2 is a fn for printing option */
144 #define OPT_A2STRVAL 0x20000000 /* *addr2 points to current string value */
145 #define OPT_NOPRINT 0x40000000 /* don't print this option at all */
147 #define OPT_VAL(x) ((x) & OPT_VALUE)
149 /* Values for priority */
150 #define OPRIO_DEFAULT 0 /* a default value */
151 #define OPRIO_CFGFILE 1 /* value from a configuration file */
152 #define OPRIO_CMDLINE 2 /* value from the command line */
153 #define OPRIO_SECFILE 3 /* value from options in a secrets file */
154 #define OPRIO_ROOT 100 /* added to priority if OPT_PRIVFIX && root */
157 #define GIDSET_TYPE gid_t
160 /* Structure representing a list of permitted IP addresses. */
161 struct permitted_ip
{
162 int permit
; /* 1 = permit, 0 = forbid */
163 u_int32_t base
; /* match if (addr & mask) == base */
164 u_int32_t mask
; /* base and mask are in network byte order */
168 * Unfortunately, the linux kernel driver uses a different structure
169 * for statistics from the rest of the ports.
170 * This structure serves as a common representation for the bits
174 unsigned int bytes_in
;
175 unsigned int bytes_out
;
176 unsigned int pkts_in
;
177 unsigned int pkts_out
;
180 /* Used for storing a sequence of words. Usually malloced. */
182 struct wordlist
*next
;
186 /* An endpoint discriminator, used with multilink. */
187 #define MAX_ENDP_LEN 20 /* maximum length of discriminator value */
190 unsigned char length
;
191 unsigned char value
[MAX_ENDP_LEN
];
194 /* values for epdisc.class */
195 #define EPD_NULL 0 /* null discriminator, no data */
200 #define EPD_PHONENUM 5
202 typedef void (*notify_func
) __P((void *, int));
205 struct notifier
*next
;
213 extern bool tx_only
; /* JYWeng 20031216: idle time counting on tx traffic */
215 extern int hungup
; /* Physical layer has disconnected */
216 extern int ifunit
; /* Interface unit number */
217 extern char ifname
[]; /* Interface name */
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
[NGROUPS_MAX
]; /* 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
[MAXPATHLEN
];
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
*auth_up_notifier
; /* peer has authenticated */
265 extern struct notifier
*link_down_notifier
; /* link has gone down */
266 extern struct notifier
*fork_notifier
; /* we are a new child process */
268 /* Values for do_callback and doing_callback */
269 #define CALLBACK_DIALIN 1 /* we are expecting the call back */
270 #define CALLBACK_DIALOUT 2 /* we are dialling out to call back */
273 * Variables set by command-line options.
276 extern bool nochecktime
; /* Don't check time */
277 extern int debug
; /* Debug flag */
278 extern int kdebugflag
; /* Tell kernel to print debug messages */
279 extern int default_device
; /* Using /dev/tty or equivalent */
280 extern char devnam
[MAXPATHLEN
]; /* Device name */
281 extern int crtscts
; /* Use hardware flow control */
282 extern bool modem
; /* Use modem control lines */
283 extern int inspeed
; /* Input/Output speed requested */
284 extern u_int32_t netmask
; /* IP netmask to set on interface */
285 extern bool lockflag
; /* Create lock file to lock the serial dev */
286 extern bool nodetach
; /* Don't detach from controlling tty */
287 extern bool updetach
; /* Detach from controlling tty when link up */
288 extern char *initializer
; /* Script to initialize physical link */
289 extern char *connect_script
; /* Script to establish physical link */
290 extern char *disconnect_script
; /* Script to disestablish physical link */
291 extern char *welcomer
; /* Script to welcome client after connection */
292 extern char *ptycommand
; /* Command to run on other side of pty */
293 extern int maxconnect
; /* Maximum connect time (seconds) */
294 extern char user
[MAXNAMELEN
];/* Our name for authenticating ourselves */
295 extern char passwd
[MAXSECRETLEN
]; /* Password for PAP or CHAP */
296 extern bool auth_required
; /* Peer is required to authenticate */
297 extern bool persist
; /* Reopen link after it goes down */
298 extern bool uselogin
; /* Use /etc/passwd for checking PAP */
299 extern bool session_mgmt
; /* Do session management (login records) */
300 extern char our_name
[MAXNAMELEN
];/* Our name for authentication purposes */
301 extern char remote_name
[MAXNAMELEN
]; /* Peer's name for authentication */
302 extern bool explicit_remote
;/* remote_name specified with remotename opt */
303 extern bool demand
; /* Do dial-on-demand */
304 extern char *ipparam
; /* Extra parameter for ip up/down scripts */
305 extern char *chapseccustom
; /* Custom chap-secrets file */
306 extern bool cryptpap
; /* Others' PAP passwords are encrypted */
307 extern int idle_time_limit
;/* Shut down link if idle for this long */
308 extern int holdoff
; /* Dead time before restarting */
309 extern bool holdoff_specified
; /* true if user gave a holdoff value */
310 extern bool notty
; /* Stdin/out is not a tty */
311 extern char *pty_socket
; /* Socket to connect to pty */
312 extern bool sync_serial
; /* Device is synchronous serial device */
313 extern int maxfail
; /* Max # of unsuccessful connection attempts */
314 extern char linkname
[MAXPATHLEN
]; /* logical name for link */
315 extern bool tune_kernel
; /* May alter kernel settings as necessary */
316 extern int connect_delay
; /* Time to delay after connect script */
317 extern int max_data_rate
; /* max bytes/sec through charshunt */
318 extern int req_unit
; /* interface unit number to use */
319 extern int req_minunit
; /* interface minimal unit number to use */
320 extern char path_ipup
[MAXPATHLEN
]; /* pathname of ip-up script */
321 extern char path_ipdown
[MAXPATHLEN
]; /* pathname of ip-down script */
322 extern bool multilink
; /* enable multilink operation */
323 extern bool noendpoint
; /* don't send or accept endpt. discrim. */
324 extern char *bundle_name
; /* bundle name for multilink */
325 extern bool dump_options
; /* print out option values */
326 extern bool dryrun
; /* check everything, print options, exit */
327 extern int child_wait
; /* # seconds to wait for children at end */
329 extern bool ms_ignore_domain
; /* Ignore any MS domain prefix */
333 extern unsigned int maxoctets
; /* Maximum octetes per session (in bytes) */
334 extern int maxoctets_dir
; /* Direction :
339 extern int maxoctets_timeout
; /* Timeout for check of octets limit */
340 #define PPP_OCTETS_DIRECTION_SUM 0
341 #define PPP_OCTETS_DIRECTION_IN 1
342 #define PPP_OCTETS_DIRECTION_OUT 2
343 #define PPP_OCTETS_DIRECTION_MAXOVERAL 3
344 /* same as previos, but little different on RADIUS side */
345 #define PPP_OCTETS_DIRECTION_MAXSESSION 4
349 extern struct bpf_program pass_filter
; /* Filter for pkts to pass */
350 extern struct bpf_program active_filter
; /* Filter for link-active pkts */
354 extern bool ms_lanman
; /* Use LanMan password instead of NT */
355 /* Has meaning only with MS-CHAP challenges */
358 /* Values for auth_pending, auth_done */
359 #define PAP_WITHPEER 0x1
361 #define CHAP_WITHPEER 0x4
362 #define CHAP_PEER 0x8
363 #define EAP_WITHPEER 0x10
364 #define EAP_PEER 0x20
366 /* Values for auth_done only */
367 #define CHAP_MD5_WITHPEER 0x40
368 #define CHAP_MD5_PEER 0x80
369 #define CHAP_MS_SHIFT 8 /* LSB position for MS auths */
370 #define CHAP_MS_WITHPEER 0x100
371 #define CHAP_MS_PEER 0x200
372 #define CHAP_MS2_WITHPEER 0x400
373 #define CHAP_MS2_PEER 0x800
375 extern char *current_option
; /* the name of the option being parsed */
376 extern int privileged_option
; /* set iff the current option came from root */
377 extern char *option_source
; /* string saying where the option came from */
378 extern int option_priority
; /* priority of current options */
384 #define PHASE_INITIALIZE 1
385 #define PHASE_SERIALCONN 2
386 #define PHASE_DORMANT 3
387 #define PHASE_ESTABLISH 4
388 #define PHASE_AUTHENTICATE 5
389 #define PHASE_CALLBACK 6
390 #define PHASE_NETWORK 7
391 #define PHASE_RUNNING 8
392 #define PHASE_TERMINATE 9
393 #define PHASE_DISCONNECT 10
394 #define PHASE_HOLDOFF 11
395 #define PHASE_MASTER 12
398 * The following struct gives the addresses of procedures to call
399 * for a particular protocol.
402 u_short protocol
; /* PPP protocol number */
403 /* Initialization procedure */
404 void (*init
) __P((int unit
));
405 /* Process a received packet */
406 void (*input
) __P((int unit
, u_char
*pkt
, int len
));
407 /* Process a received protocol-reject */
408 void (*protrej
) __P((int unit
));
409 /* Lower layer has come up */
410 void (*lowerup
) __P((int unit
));
411 /* Lower layer has gone down */
412 void (*lowerdown
) __P((int unit
));
413 /* Open the protocol */
414 void (*open
) __P((int unit
));
415 /* Close the protocol */
416 void (*close
) __P((int unit
, char *reason
));
417 /* Print a packet in readable form */
418 int (*printpkt
) __P((u_char
*pkt
, int len
,
419 void (*printer
) __P((void *, char *, ...)),
421 /* Process a received data packet */
422 void (*datainput
) __P((int unit
, u_char
*pkt
, int len
));
423 bool enabled_flag
; /* 0 iff protocol is disabled */
424 char *name
; /* Text name of protocol */
425 char *data_name
; /* Text name of corresponding data protocol */
426 option_t
*options
; /* List of command-line options */
427 /* Check requested options, assign defaults */
428 void (*check_options
) __P((void));
429 /* Configure interface for demand-dial */
430 int (*demand_conf
) __P((int unit
));
431 /* Say whether to bring up link for this pkt */
432 int (*active_pkt
) __P((u_char
*pkt
, int len
));
435 /* Table of pointers to supported protocols */
436 extern struct protent
*protocols
[];
439 * This struct contains pointers to a set of procedures for
440 * doing operations on a "channel". A channel provides a way
441 * to send and receive PPP packets - the canonical example is
442 * a serial port device in PPP line discipline (or equivalently
443 * with PPP STREAMS modules pushed onto it).
446 /* set of options for this channel */
448 /* find and process a per-channel options file */
449 void (*process_extra_options
) __P((void));
450 /* check all the options that have been given */
451 void (*check_options
) __P((void));
452 /* get the channel ready to do PPP, return a file descriptor */
453 int (*connect
) __P((void));
454 /* we're finished with the channel */
455 void (*disconnect
) __P((void));
456 /* put the channel into PPP `mode' */
457 int (*establish_ppp
) __P((int));
458 /* take the channel out of PPP `mode', restore loopback if demand */
459 void (*disestablish_ppp
) __P((int));
460 /* set the transmit-side PPP parameters of the channel */
461 void (*send_config
) __P((int, u_int32_t
, int, int));
462 /* set the receive-side PPP parameters of the channel */
463 void (*recv_config
) __P((int, u_int32_t
, int, int));
464 /* cleanup on error or normal exit */
465 void (*cleanup
) __P((void));
466 /* close the device, called in children after fork */
467 void (*close
) __P((void));
470 extern struct channel
*the_channel
;
476 /* Procedures exported from main.c. */
477 void set_ifunit
__P((int)); /* set stuff that depends on ifunit */
478 void detach
__P((void)); /* Detach from controlling tty */
479 void die
__P((int)); /* Cleanup and exit */
480 void quit
__P((void)); /* like die(1) */
481 void novm
__P((char *)); /* Say we ran out of memory, and die */
482 void timeout
__P((void (*func
)(void *), void *arg
, int s
, int us
));
483 /* Call func(arg) after s.us seconds */
484 void untimeout
__P((void (*func
)(void *), void *arg
));
485 /* Cancel call to func(arg) */
486 void record_child
__P((int, char *, void (*) (void *), void *, int));
487 pid_t safe_fork
__P((int, int, int)); /* Fork & close stuff in child */
488 int device_script
__P((char *cmd
, int in
, int out
, int dont_wait
));
489 /* Run `cmd' with given stdin and stdout */
490 pid_t run_program
__P((char *prog
, char **args
, int must_exist
,
491 void (*done
)(void *), void *arg
, int wait
));
492 /* Run program prog with args in child */
493 void reopen_log
__P((void)); /* (re)open the connection to syslog */
494 void print_link_stats
__P((void)); /* Print stats, if available */
495 void reset_link_stats
__P((int)); /* Reset (init) stats when link goes up */
496 void update_link_stats
__P((int)); /* Get stats at link termination */
497 void script_setenv
__P((char *, char *, int)); /* set script env var */
498 void script_unsetenv
__P((char *)); /* unset script env var */
499 void new_phase
__P((int)); /* signal start of new phase */
500 void add_notifier
__P((struct notifier
**, notify_func
, void *));
501 void remove_notifier
__P((struct notifier
**, notify_func
, void *));
502 void notify
__P((struct notifier
*, int));
503 int ppp_send_config
__P((int, int, u_int32_t
, int, int));
504 int ppp_recv_config
__P((int, int, u_int32_t
, int, int));
505 const char *protocol_name
__P((int));
506 void remove_pidfiles
__P((void));
507 void lock_db
__P((void));
508 void unlock_db
__P((void));
510 /* Procedures exported from tty.c. */
511 void tty_init
__P((void));
513 /* Procedures exported from utils.c. */
514 void log_packet
__P((u_char
*, int, char *, int));
515 /* Format a packet and log it with syslog */
516 void print_string
__P((char *, int, void (*) (void *, char *, ...),
517 void *)); /* Format a string for output */
518 int slprintf
__P((char *, int, char *, ...)); /* sprintf++ */
519 int vslprintf
__P((char *, int, char *, va_list)); /* vsprintf++ */
520 size_t strlcpy
__P((char *, const char *, size_t)); /* safe strcpy */
521 size_t strlcat
__P((char *, const char *, size_t)); /* safe strncpy */
522 void dbglog
__P((char *, ...)); /* log a debug message */
523 void info
__P((char *, ...)); /* log an informational message */
524 void notice
__P((char *, ...)); /* log a notice-level message */
525 void warn
__P((char *, ...)); /* log a warning message */
526 void error
__P((char *, ...)); /* log an error message */
527 void fatal
__P((char *, ...)); /* log an error message and die(1) */
528 void init_pr_log
__P((const char *, int)); /* initialize for using pr_log */
529 void pr_log
__P((void *, char *, ...)); /* printer fn, output to syslog */
530 void end_pr_log
__P((void)); /* finish up after using pr_log */
531 void dump_packet
__P((const char *, u_char
*, int));
532 /* dump packet to debug log if interesting */
533 ssize_t complete_read
__P((int, void *, size_t));
534 /* read a complete buffer */
536 /* Procedures exported from auth.c */
537 void link_required
__P((int)); /* we are starting to use the link */
538 void start_link
__P((int)); /* bring the link up now */
539 void link_terminated
__P((int)); /* we are finished with the link */
540 void link_down
__P((int)); /* the LCP layer has left the Opened state */
541 void upper_layers_down
__P((int));/* take all NCPs down */
542 void link_established
__P((int)); /* the link is up; authenticate now */
543 void start_networks
__P((int)); /* start all the network control protos */
544 void continue_networks
__P((int)); /* start network [ip, etc] control protos */
545 void np_up
__P((int, int)); /* a network protocol has come up */
546 void np_down
__P((int, int)); /* a network protocol has gone down */
547 void np_finished
__P((int, int)); /* a network protocol no longer needs link */
548 void auth_peer_fail
__P((int, int));
549 /* peer failed to authenticate itself */
550 void auth_peer_success
__P((int, int, int, char *, int));
551 /* peer successfully authenticated itself */
552 void auth_withpeer_fail
__P((int, int));
553 /* we failed to authenticate ourselves */
554 void auth_withpeer_success
__P((int, int, int));
555 /* we successfully authenticated ourselves */
556 void auth_check_options
__P((void));
557 /* check authentication options supplied */
558 void auth_reset
__P((int)); /* check what secrets we have */
559 int check_passwd
__P((int, char *, int, char *, int, char **));
560 /* Check peer-supplied username/password */
561 int get_secret
__P((int, char *, char *, char *, int *, int));
562 /* get "secret" for chap */
563 int get_srp_secret
__P((int unit
, char *client
, char *server
, char *secret
,
565 int auth_ip_addr
__P((int, u_int32_t
));
566 /* check if IP address is authorized */
567 int auth_number
__P((void)); /* check if remote number is authorized */
568 int bad_ip_adrs
__P((u_int32_t
));
569 /* check if IP address is unreasonable */
571 /* Procedures exported from demand.c */
572 void demand_conf
__P((void)); /* config interface(s) for demand-dial */
573 void demand_block
__P((void)); /* set all NPs to queue up packets */
574 void demand_unblock
__P((void)); /* set all NPs to pass packets */
575 void demand_discard
__P((void)); /* set all NPs to discard packets */
576 void demand_rexmit
__P((int, u_int32_t
)); /* retransmit saved frames for an NP*/
577 int loop_chars
__P((unsigned char *, int)); /* process chars from loopback */
578 int loop_frame
__P((unsigned char *, int)); /* should we bring link up? */
580 /* Procedures exported from multilink.c */
581 #ifdef HAVE_MULTILINK
582 void mp_check_options
__P((void)); /* Check multilink-related options */
583 int mp_join_bundle
__P((void)); /* join our link to an appropriate bundle */
584 void mp_exit_bundle
__P((void)); /* have disconnected our link from bundle */
585 void mp_bundle_terminated
__P((void));
586 char *epdisc_to_str
__P((struct epdisc
*)); /* string from endpoint discrim. */
587 int str_to_epdisc
__P((struct epdisc
*, char *)); /* endpt disc. from str */
589 #define mp_bundle_terminated() /* nothing */
590 #define mp_exit_bundle() /* nothing */
591 #define doing_multilink 0
592 #define multilink_master 0
595 /* Procedures exported from sys-*.c */
596 void sys_init
__P((void)); /* Do system-dependent initialization */
597 void sys_cleanup
__P((void)); /* Restore system state before exiting */
598 int sys_check_options
__P((void)); /* Check options specified */
599 void sys_close
__P((void)); /* Clean up in a child before execing */
600 int ppp_available
__P((void)); /* Test whether ppp kernel support exists */
601 int get_pty
__P((int *, int *, char *, int)); /* Get pty master/slave */
602 int open_ppp_loopback
__P((void)); /* Open loopback for demand-dialling */
603 int tty_establish_ppp
__P((int)); /* Turn serial port into a ppp interface */
604 void tty_disestablish_ppp
__P((int)); /* Restore port to normal operation */
605 void generic_disestablish_ppp
__P((int dev_fd
)); /* Restore device setting */
606 int generic_establish_ppp
__P((int dev_fd
)); /* Make a ppp interface */
607 void make_new_bundle
__P((int, int, int, int)); /* Create new bundle */
608 int bundle_attach
__P((int)); /* Attach link to existing bundle */
609 void cfg_bundle
__P((int, int, int, int)); /* Configure existing bundle */
610 void destroy_bundle
__P((void)); /* Tell driver to destroy bundle */
611 void clean_check
__P((void)); /* Check if line was 8-bit clean */
612 void set_up_tty
__P((int, int)); /* Set up port's speed, parameters, etc. */
613 void restore_tty
__P((int)); /* Restore port's original parameters */
614 void setdtr
__P((int, int)); /* Raise or lower port's DTR line */
615 void output
__P((int, u_char
*, int)); /* Output a PPP packet */
616 void wait_input
__P((struct timeval
*));
617 /* Wait for input, with timeout */
618 void add_fd
__P((int)); /* Add fd to set to wait for */
619 void remove_fd
__P((int)); /* Remove fd from set to wait for */
620 int read_packet
__P((u_char
*)); /* Read PPP packet */
621 int get_loop_output
__P((void)); /* Read pkts from loopback */
622 void tty_send_config
__P((int, u_int32_t
, int, int));
623 /* Configure i/f transmit parameters */
624 void tty_set_xaccm
__P((ext_accm
));
625 /* Set extended transmit ACCM */
626 void tty_recv_config
__P((int, u_int32_t
, int, int));
627 /* Configure i/f receive parameters */
628 int ccp_test
__P((int, u_char
*, int, int));
629 /* Test support for compression scheme */
630 void ccp_flags_set
__P((int, int, int));
631 /* Set kernel CCP state */
632 int ccp_fatal_error
__P((int)); /* Test for fatal decomp error in kernel */
633 int get_idle_time
__P((int, struct ppp_idle
*));
634 /* Find out how long link has been idle */
635 int get_ppp_stats
__P((int, struct pppd_stats
*));
636 /* Return link statistics */
637 void netif_set_mtu
__P((int, int)); /* Set PPP interface MTU */
638 int netif_get_mtu
__P((int)); /* Get PPP interface MTU */
639 int sifvjcomp
__P((int, int, int, int));
640 /* Configure VJ TCP header compression */
641 int sifup
__P((int)); /* Configure i/f up for one protocol */
642 int sifnpmode
__P((int u
, int proto
, enum NPmode mode
));
643 /* Set mode for handling packets for proto */
644 int sifdown
__P((int)); /* Configure i/f down for one protocol */
645 int sifaddr
__P((int, u_int32_t
, u_int32_t
, u_int32_t
));
646 /* Configure IPv4 addresses for i/f */
647 int cifaddr
__P((int, u_int32_t
, u_int32_t
));
648 /* Reset i/f IP addresses */
650 int sif6addr
__P((int, eui64_t
, eui64_t
));
651 /* Configure IPv6 addresses for i/f */
652 int cif6addr
__P((int, eui64_t
, eui64_t
));
653 /* Remove an IPv6 address from i/f */
655 int sifdefaultroute
__P((int, u_int32_t
, u_int32_t
));
656 /* Create default route through i/f */
657 int cifdefaultroute
__P((int, u_int32_t
, u_int32_t
));
658 /* Delete default route through i/f */
659 int sifproxyarp
__P((int, u_int32_t
));
660 /* Add proxy ARP entry for peer */
661 int cifproxyarp
__P((int, u_int32_t
));
662 /* Delete proxy ARP entry for peer */
663 u_int32_t GetMask
__P((u_int32_t
)); /* Get appropriate netmask for address */
664 int lock
__P((char *)); /* Create lock file for device */
665 int relock
__P((int)); /* Rewrite lock file with new pid */
666 void unlock
__P((void)); /* Delete previously-created lock file */
667 void logwtmp
__P((const char *, const char *, const char *));
668 /* Write entry to wtmp file */
669 int get_host_seed
__P((void)); /* Get host-dependent random number seed */
670 int have_route_to
__P((u_int32_t
)); /* Check if route to addr exists */
672 int set_filters
__P((struct bpf_program
*pass
, struct bpf_program
*active
));
673 /* Set filter programs in kernel */
676 int sipxfaddr
__P((int, unsigned long, unsigned char *));
677 int cipxfaddr
__P((int));
679 int get_if_hwaddr
__P((u_char
*addr
, char *name
));
680 char *get_first_ethernet
__P((void));
682 /* Procedures exported from options.c */
683 int setipaddr
__P((char *, char **, int)); /* Set local/remote ip addresses */
684 int parse_args
__P((int argc
, char **argv
));
685 /* Parse options from arguments given */
686 int options_from_file
__P((char *filename
, int must_exist
, int check_prot
,
688 /* Parse options from an options file */
689 int options_from_user
__P((void)); /* Parse options from user's .ppprc */
690 int options_for_tty
__P((void)); /* Parse options from /etc/ppp/options.tty */
691 int options_from_list
__P((struct wordlist
*, int privileged
));
692 /* Parse options from a wordlist */
693 int getword
__P((FILE *f
, char *word
, int *newlinep
, char *filename
));
694 /* Read a word from a file */
695 void option_error
__P((char *fmt
, ...));
696 /* Print an error message about an option */
697 int int_option
__P((char *, int *));
698 /* Simplified number_option for decimal ints */
699 void add_options
__P((option_t
*)); /* Add extra options */
700 void check_options
__P((void)); /* check values after all options parsed */
701 int override_value
__P((const char *, int, const char *));
702 /* override value if permitted by priority */
703 void print_options
__P((void (*) __P((void *, char *, ...)), void *));
704 /* print out values of all options */
706 int parse_dotted_ip
__P((char *, u_int32_t
*));
709 * Hooks to enable plugins to change various things.
711 extern int (*new_phase_hook
) __P((int));
712 extern int (*idle_time_hook
) __P((struct ppp_idle
*));
713 extern int (*holdoff_hook
) __P((void));
714 extern int (*pap_check_hook
) __P((void));
715 extern int (*pap_auth_hook
) __P((char *user
, char *passwd
, char **msgp
,
716 struct wordlist
**paddrs
,
717 struct wordlist
**popts
));
718 extern void (*pap_logout_hook
) __P((void));
719 extern int (*pap_passwd_hook
) __P((char *user
, char *passwd
));
720 extern int (*allowed_address_hook
) __P((u_int32_t addr
));
721 extern void (*ip_up_hook
) __P((void));
722 extern void (*ip_down_hook
) __P((void));
723 extern void (*ip_choose_hook
) __P((u_int32_t
*));
725 extern int (*chap_check_hook
) __P((void));
726 extern int (*chap_passwd_hook
) __P((char *user
, char *passwd
));
727 extern void (*multilink_join_hook
) __P((void));
729 /* Let a plugin snoop sent and received packets. Useful for L2TP */
730 extern void (*snoop_recv_hook
) __P((unsigned char *p
, int len
));
731 extern void (*snoop_send_hook
) __P((unsigned char *p
, int len
));
734 * Inline versions of get/put char/short/long.
735 * Pointer is advanced; we assume that both arguments
736 * are lvalues and will already be in registers.
737 * cp MUST be u_char *.
739 #define GETCHAR(c, cp) { \
742 #define PUTCHAR(c, cp) { \
743 *(cp)++ = (u_char) (c); \
747 #define GETSHORT(s, cp) { \
748 (s) = *(cp)++ << 8; \
751 #define PUTSHORT(s, cp) { \
752 *(cp)++ = (u_char) ((s) >> 8); \
753 *(cp)++ = (u_char) (s); \
756 #define GETLONG(l, cp) { \
757 (l) = *(cp)++ << 8; \
758 (l) |= *(cp)++; (l) <<= 8; \
759 (l) |= *(cp)++; (l) <<= 8; \
762 #define PUTLONG(l, cp) { \
763 *(cp)++ = (u_char) ((l) >> 24); \
764 *(cp)++ = (u_char) ((l) >> 16); \
765 *(cp)++ = (u_char) ((l) >> 8); \
766 *(cp)++ = (u_char) (l); \
769 #define INCPTR(n, cp) ((cp) += (n))
770 #define DECPTR(n, cp) ((cp) -= (n))
773 * System dependent definitions for user-level 4.3BSD UNIX implementation.
776 #define TIMEOUT(r, f, t) timeout((r), (f), (t), 0)
777 #define UNTIMEOUT(r, f) untimeout((r), (f))
779 #define BCOPY(s, d, l) memcpy(d, s, l)
780 #define BZERO(s, n) memset(s, 0, n)
781 #define BCMP(s1, s2, l) memcmp(s1, s2, l)
783 #define PRINTMSG(m, l) { info("Remote message: %0.*v", l, m); }
786 * MAKEHEADER - Add Header fields to a packet.
788 #define MAKEHEADER(p, t) { \
789 PUTCHAR(PPP_ALLSTATIONS, p); \
790 PUTCHAR(PPP_UI, p); \
794 * Exit status values.
797 #define EXIT_FATAL_ERROR 1
798 #define EXIT_OPTION_ERROR 2
799 #define EXIT_NOT_ROOT 3
800 #define EXIT_NO_KERNEL_SUPPORT 4
801 #define EXIT_USER_REQUEST 5
802 #define EXIT_LOCK_FAILED 6
803 #define EXIT_OPEN_FAILED 7
804 #define EXIT_CONNECT_FAILED 8
805 #define EXIT_PTYCMD_FAILED 9
806 #define EXIT_NEGOTIATION_FAILED 10
807 #define EXIT_PEER_AUTH_FAILED 11
808 #define EXIT_IDLE_TIMEOUT 12
809 #define EXIT_CONNECT_TIME 13
810 #define EXIT_CALLBACK 14
811 #define EXIT_PEER_DEAD 15
812 #define EXIT_HANGUP 16
813 #define EXIT_LOOPBACK 17
814 #define EXIT_INIT_FAILED 18
815 #define EXIT_AUTH_TOPEER_FAILED 19
817 #define EXIT_TRAFFIC_LIMIT 20
819 #define EXIT_CNID_AUTH_FAILED 21
822 * Debug macros. Slightly useful for finding bugs in pppd, not particularly
823 * useful for finding out why your connection isn't being established.
830 #define DEBUGIPV6CP 1
835 #ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */
836 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
837 || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
838 || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
839 #define LOG_PPP LOG_LOCAL2
841 #define LOG_PPP LOG_DAEMON
846 #define MAINDEBUG(x) if (debug) dbglog x
852 #define SYSDEBUG(x) if (debug) dbglog x
858 #define FSMDEBUG(x) if (debug) dbglog x
864 #define LCPDEBUG(x) if (debug) dbglog x
870 #define IPCPDEBUG(x) if (debug) dbglog x
876 #define IPV6CPDEBUG(x) if (debug) dbglog x
878 #define IPV6CPDEBUG(x)
882 #define UPAPDEBUG(x) if (debug) dbglog x
888 #define CHAPDEBUG(x) if (debug) dbglog x
894 #define IPXCPDEBUG(x) if (debug) dbglog x
896 #define IPXCPDEBUG(x)
900 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
904 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
908 #define MIN(a, b) ((a) < (b)? (a): (b))
911 #define MAX(a, b) ((a) > (b)? (a): (b))
915 #define offsetof(type, member) ((size_t) &((type *)0)->member)
918 #endif /* __PPP_H__ */