1/*
2 * pppd.h - PPP daemon global declarations.
3 *
4 * Copyright (c) 1989 Carnegie Mellon University.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms are permitted
8 * provided that the above copyright notice and this paragraph are
9 * duplicated in all such forms and that any documentation,
10 * advertising materials, and other materials related to such
11 * distribution and use acknowledge that the software was developed
12 * by Carnegie Mellon University.  The name of the
13 * University may not be used to endorse or promote products derived
14 * from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
17 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
18 *
19 * $Id$
20 */
21
22/*
23 * TODO:
24 */
25
26#ifndef __PPPD_H__
27#define __PPPD_H__
28
29#include <stdio.h>		/* for FILE */
30#include <limits.h>		/* for NGROUPS_MAX */
31#include <sys/param.h>		/* for MAXPATHLEN and BSD4_4, if defined */
32#include <sys/types.h>		/* for u_int32_t, if defined */
33#include <sys/time.h>		/* for struct timeval */
34#include <net/ppp_defs.h>
35#include "patchlevel.h"
36
37#if defined(__STDC__)
38#include <stdarg.h>
39#define __V(x)	x
40#else
41#include <varargs.h>
42#define __V(x)	(va_alist) va_dcl
43#define const
44#define volatile
45#endif
46
47#ifdef INET6
48#include "eui64.h"
49#endif
50
51/*
52 * Limits.
53 */
54
55#define NUM_PPP		1	/* One PPP interface supported (per process) */
56#define MAXWORDLEN	1024	/* max length of word in file (incl null) */
57#define MAXARGS		1	/* max # args to a command */
58#define MAXNAMELEN	256	/* max length of hostname or name for auth */
59#define MAXSECRETLEN	256	/* max length of password or secret */
60
61/*
62 * Option descriptor structure.
63 */
64
65typedef unsigned char	bool;
66
67enum opt_type {
68	o_special_noarg = 0,
69	o_special = 1,
70	o_bool,
71	o_int,
72	o_uint32,
73	o_string,
74	o_wild,
75};
76
77typedef struct {
78	char	*name;		/* name of the option */
79	enum opt_type type;
80	void	*addr;
81	char	*description;
82	int	flags;
83	void	*addr2;
84	int	upper_limit;
85	int	lower_limit;
86	const char *source;
87	short int priority;
88	short int winner;
89} option_t;
90
91/* Values for flags */
92#define OPT_VALUE	0xff	/* mask for presupplied value */
93#define OPT_HEX		0x100	/* int option is in hex */
94#define OPT_NOARG	0x200	/* option doesn't take argument */
95#define OPT_OR		0x400	/* OR in argument to value */
96#define OPT_INC		0x800	/* increment value */
97#define OPT_PRIV	0x1000	/* privileged option */
98#define OPT_STATIC	0x2000	/* string option goes into static array */
99#define OPT_LLIMIT	0x4000	/* check value against lower limit */
100#define OPT_ULIMIT	0x8000	/* check value against upper limit */
101#define OPT_LIMITS	(OPT_LLIMIT|OPT_ULIMIT)
102#define OPT_ZEROOK	0x10000	/* 0 value is OK even if not within limits */
103#define OPT_HIDE	0x10000	/* for o_string, print value as ?????? */
104#define OPT_A2LIST	0x10000 /* for o_special, keep list of values */
105#define OPT_NOINCR	0x20000	/* value mustn't be increased */
106#define OPT_ZEROINF	0x40000	/* with OPT_NOINCR, 0 == infinity */
107#define OPT_PRIO	0x80000	/* process option priorities for this option */
108#define OPT_PRIOSUB	0x100000 /* subsidiary member of priority group */
109#define OPT_ALIAS	0x200000 /* option is alias for previous option */
110#define OPT_A2COPY	0x400000 /* addr2 -> second location to rcv value */
111#define OPT_ENABLE	0x800000 /* use *addr2 as enable for option */
112#define OPT_A2CLR	0x1000000 /* clear *(bool *)addr2 */
113#define OPT_PRIVFIX	0x2000000 /* user can't override if set by root */
114#define OPT_INITONLY	0x4000000 /* option can only be set in init phase */
115#define OPT_DEVEQUIV	0x8000000 /* equiv to device name */
116#define OPT_DEVNAM	(OPT_INITONLY | OPT_DEVEQUIV)
117#define OPT_A2PRINTER	0x10000000 /* *addr2 is a fn for printing option */
118#define OPT_A2STRVAL	0x20000000 /* *addr2 points to current string value */
119#define OPT_NOPRINT	0x40000000 /* don't print this option at all */
120
121#define OPT_VAL(x)	((x) & OPT_VALUE)
122
123/* Values for priority */
124#define OPRIO_DEFAULT	0	/* a default value */
125#define OPRIO_CFGFILE	1	/* value from a configuration file */
126#define OPRIO_CMDLINE	2	/* value from the command line */
127#define OPRIO_SECFILE	3	/* value from options in a secrets file */
128#define OPRIO_ROOT	100	/* added to priority if OPT_PRIVFIX && root */
129
130#ifndef GIDSET_TYPE
131#define GIDSET_TYPE	gid_t
132#endif
133
134/* Structure representing a list of permitted IP addresses. */
135struct permitted_ip {
136    int		permit;		/* 1 = permit, 0 = forbid */
137    u_int32_t	base;		/* match if (addr & mask) == base */
138    u_int32_t	mask;		/* base and mask are in network byte order */
139};
140
141/*
142 * Unfortunately, the linux kernel driver uses a different structure
143 * for statistics from the rest of the ports.
144 * This structure serves as a common representation for the bits
145 * pppd needs.
146 */
147struct pppd_stats {
148    unsigned int	bytes_in;
149    unsigned int	bytes_out;
150};
151
152/* Used for storing a sequence of words.  Usually malloced. */
153struct wordlist {
154    struct wordlist	*next;
155    char		*word;
156};
157
158/* An endpoint discriminator, used with multilink. */
159#define MAX_ENDP_LEN	20	/* maximum length of discriminator value */
160struct epdisc {
161    unsigned char	class;
162    unsigned char	length;
163    unsigned char	value[MAX_ENDP_LEN];
164};
165
166/* values for epdisc.class */
167#define EPD_NULL	0	/* null discriminator, no data */
168#define EPD_LOCAL	1
169#define EPD_IP		2
170#define EPD_MAC		3
171#define EPD_MAGIC	4
172#define EPD_PHONENUM	5
173
174typedef void (*notify_func) __P((void *, int));
175
176struct notifier {
177    struct notifier *next;
178    notify_func	    func;
179    void	    *arg;
180};
181
182/*
183 * Global variables.
184 */
185
186extern int	hungup;		/* Physical layer has disconnected */
187extern int	ifunit;		/* Interface unit number */
188extern char	ifname[];	/* Interface name */
189extern char	hostname[];	/* Our hostname */
190extern u_char	outpacket_buf[]; /* Buffer for outgoing packets */
191extern int	phase;		/* Current state of link - see values below */
192extern int	baud_rate;	/* Current link speed in bits/sec */
193extern char	*progname;	/* Name of this program */
194extern int	redirect_stderr;/* Connector's stderr should go to file */
195extern char	peer_authname[];/* Authenticated name of peer */
196extern int	privileged;	/* We were run by real-uid root */
197extern int	need_holdoff;	/* Need holdoff period after link terminates */
198extern char	**script_env;	/* Environment variables for scripts */
199extern int	detached;	/* Have detached from controlling tty */
200extern GIDSET_TYPE groups[NGROUPS_MAX];	/* groups the user is in */
201extern int	ngroups;	/* How many groups valid in groups */
202extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
203extern int	link_stats_valid; /* set if link_stats is valid */
204extern int	link_connect_time; /* time the link was up for */
205extern int	using_pty;	/* using pty as device (notty or pty opt.) */
206extern int	log_to_fd;	/* logging to this fd as well as syslog */
207extern bool	log_default;	/* log_to_fd is default (stdout) */
208extern char	*no_ppp_msg;	/* message to print if ppp not in kernel */
209extern volatile int status;	/* exit status for pppd */
210extern bool	devnam_fixed;	/* can no longer change devnam */
211extern int	unsuccess;	/* # unsuccessful connection attempts */
212extern int	do_callback;	/* set if we want to do callback next */
213extern int	doing_callback;	/* set if this is a callback */
214extern char	ppp_devnam[MAXPATHLEN];
215extern struct notifier *pidchange;   /* for notifications of pid changing */
216extern struct notifier *phasechange; /* for notifications of phase changes */
217extern struct notifier *exitnotify;  /* for notification that we're exiting */
218extern struct notifier *sigreceived; /* notification of received signal */
219extern int	listen_time;	/* time to listen first (ms) */
220
221/* Values for do_callback and doing_callback */
222#define CALLBACK_DIALIN		1	/* we are expecting the call back */
223#define CALLBACK_DIALOUT	2	/* we are dialling out to call back */
224
225/*
226 * Variables set by command-line options.
227 */
228
229extern int	debug;		/* Debug flag */
230extern int	kdebugflag;	/* Tell kernel to print debug messages */
231extern int	default_device;	/* Using /dev/tty or equivalent */
232extern char	devnam[MAXPATHLEN];	/* Device name */
233extern int	crtscts;	/* Use hardware flow control */
234extern bool	modem;		/* Use modem control lines */
235extern int	inspeed;	/* Input/Output speed requested */
236extern u_int32_t netmask;	/* IP netmask to set on interface */
237extern bool	lockflag;	/* Create lock file to lock the serial dev */
238extern bool	nodetach;	/* Don't detach from controlling tty */
239extern bool	updetach;	/* Detach from controlling tty when link up */
240extern char	*initializer;	/* Script to initialize physical link */
241extern char	*connect_script; /* Script to establish physical link */
242extern char	*disconnect_script; /* Script to disestablish physical link */
243extern char	*welcomer;	/* Script to welcome client after connection */
244extern char	*ptycommand;	/* Command to run on other side of pty */
245extern int	maxconnect;	/* Maximum connect time (seconds) */
246extern char	user[MAXNAMELEN];/* Our name for authenticating ourselves */
247extern char	passwd[MAXSECRETLEN];	/* Password for PAP or CHAP */
248extern bool	auth_required;	/* Peer is required to authenticate */
249extern bool	persist;	/* Reopen link after it goes down */
250extern bool	uselogin;	/* Use /etc/passwd for checking PAP */
251extern char	our_name[MAXNAMELEN];/* Our name for authentication purposes */
252extern char	remote_name[MAXNAMELEN]; /* Peer's name for authentication */
253extern bool	explicit_remote;/* remote_name specified with remotename opt */
254extern bool	demand;		/* Do dial-on-demand */
255extern char	*ipparam;	/* Extra parameter for ip up/down scripts */
256extern bool	cryptpap;	/* Others' PAP passwords are encrypted */
257extern int	idle_time_limit;/* Shut down link if idle for this long */
258extern int	holdoff;	/* Dead time before restarting */
259extern bool	holdoff_specified; /* true if user gave a holdoff value */
260extern bool	notty;		/* Stdin/out is not a tty */
261extern char	*pty_socket;	/* Socket to connect to pty */
262extern char	*record_file;	/* File to record chars sent/received */
263extern bool	sync_serial;	/* Device is synchronous serial device */
264extern int	maxfail;	/* Max # of unsuccessful connection attempts */
265extern char	linkname[MAXPATHLEN]; /* logical name for link */
266extern bool	tune_kernel;	/* May alter kernel settings as necessary */
267extern int	connect_delay;	/* Time to delay after connect script */
268extern int	max_data_rate;	/* max bytes/sec through charshunt */
269extern int	req_unit;	/* interface unit number to use */
270extern bool	multilink;	/* enable multilink operation */
271extern bool	noendpoint;	/* don't send or accept endpt. discrim. */
272extern char	*bundle_name;	/* bundle name for multilink */
273extern bool	dump_options;	/* print out option values */
274extern bool	dryrun;		/* check everything, print options, exit */
275
276#ifdef PPP_FILTER
277extern struct	bpf_program pass_filter;   /* Filter for pkts to pass */
278extern struct	bpf_program active_filter; /* Filter for link-active pkts */
279#endif
280
281#ifdef MSLANMAN
282extern bool	ms_lanman;	/* Use LanMan password instead of NT */
283				/* Has meaning only with MS-CHAP challenges */
284#endif
285
286extern char *current_option;	/* the name of the option being parsed */
287extern int  privileged_option;	/* set iff the current option came from root */
288extern char *option_source;	/* string saying where the option came from */
289extern int  option_priority;	/* priority of current options */
290
291/*
292 * Values for phase.
293 */
294#define PHASE_DEAD		0
295#define PHASE_INITIALIZE	1
296#define PHASE_SERIALCONN	2
297#define PHASE_DORMANT		3
298#define PHASE_ESTABLISH		4
299#define PHASE_AUTHENTICATE	5
300#define PHASE_CALLBACK		6
301#define PHASE_NETWORK		7
302#define PHASE_RUNNING		8
303#define PHASE_TERMINATE		9
304#define PHASE_DISCONNECT	10
305#define PHASE_HOLDOFF		11
306
307/*
308 * The following struct gives the addresses of procedures to call
309 * for a particular protocol.
310 */
311struct protent {
312    u_short protocol;		/* PPP protocol number */
313    /* Initialization procedure */
314    void (*init) __P((int unit));
315    /* Process a received packet */
316    void (*input) __P((int unit, u_char *pkt, int len));
317    /* Process a received protocol-reject */
318    void (*protrej) __P((int unit));
319    /* Lower layer has come up */
320    void (*lowerup) __P((int unit));
321    /* Lower layer has gone down */
322    void (*lowerdown) __P((int unit));
323    /* Open the protocol */
324    void (*open) __P((int unit));
325    /* Close the protocol */
326    void (*close) __P((int unit, char *reason));
327    /* Print a packet in readable form */
328    int  (*printpkt) __P((u_char *pkt, int len,
329			  void (*printer) __P((void *, char *, ...)),
330			  void *arg));
331    /* Process a received data packet */
332    void (*datainput) __P((int unit, u_char *pkt, int len));
333    bool enabled_flag;		/* 0 iff protocol is disabled */
334    char *name;			/* Text name of protocol */
335    char *data_name;		/* Text name of corresponding data protocol */
336    option_t *options;		/* List of command-line options */
337    /* Check requested options, assign defaults */
338    void (*check_options) __P((void));
339    /* Configure interface for demand-dial */
340    int  (*demand_conf) __P((int unit));
341    /* Say whether to bring up link for this pkt */
342    int  (*active_pkt) __P((u_char *pkt, int len));
343};
344
345/* Table of pointers to supported protocols */
346extern struct protent *protocols[];
347
348/*
349 * This struct contains pointers to a set of procedures for
350 * doing operations on a "channel".  A channel provides a way
351 * to send and receive PPP packets - the canonical example is
352 * a serial port device in PPP line discipline (or equivalently
353 * with PPP STREAMS modules pushed onto it).
354 */
355struct channel {
356	/* set of options for this channel */
357	option_t *options;
358	/* find and process a per-channel options file */
359	void (*process_extra_options) __P((void));
360	/* check all the options that have been given */
361	void (*check_options) __P((void));
362	/* get the channel ready to do PPP, return a file descriptor */
363	int  (*connect) __P((void));
364	/* we're finished with the channel */
365	void (*disconnect) __P((void));
366	/* put the channel into PPP `mode' */
367	int  (*establish_ppp) __P((int));
368	/* take the channel out of PPP `mode', restore loopback if demand */
369	void (*disestablish_ppp) __P((int));
370	/* set the transmit-side PPP parameters of the channel */
371	void (*send_config) __P((int, u_int32_t, int, int));
372	/* set the receive-side PPP parameters of the channel */
373	void (*recv_config) __P((int, u_int32_t, int, int));
374	/* cleanup on error or normal exit */
375	void (*cleanup) __P((void));
376	/* close the device, called in children after fork */
377	void (*close) __P((void));
378};
379
380extern struct channel *the_channel;
381
382#define ppp_send_config(unit, mtu, accm, pc, acc)			 \
383do {									 \
384	if (the_channel->send_config)					 \
385		(*the_channel->send_config)((mtu), (accm), (pc), (acc)); \
386} while (0)
387
388#define ppp_recv_config(unit, mtu, accm, pc, acc)			 \
389do {									 \
390	if (the_channel->send_config)					 \
391		(*the_channel->recv_config)((mtu), (accm), (pc), (acc)); \
392} while (0)
393
394/*
395 * Prototypes.
396 */
397
398/* Procedures exported from main.c. */
399void set_ifunit __P((int));	/* set stuff that depends on ifunit */
400void detach __P((void));	/* Detach from controlling tty */
401void die __P((int));		/* Cleanup and exit */
402void quit __P((void));		/* like die(1) */
403void novm __P((char *));	/* Say we ran out of memory, and die */
404void timeout __P((void (*func)(void *), void *arg, int s, int us));
405				/* Call func(arg) after s.us seconds */
406void untimeout __P((void (*func)(void *), void *arg));
407				/* Cancel call to func(arg) */
408void record_child __P((int, char *, void (*) (void *), void *));
409int  device_script __P((char *cmd, int in, int out, int dont_wait));
410				/* Run `cmd' with given stdin and stdout */
411pid_t run_program __P((char *prog, char **args, int must_exist,
412		       void (*done)(void *), void *arg));
413				/* Run program prog with args in child */
414void reopen_log __P((void));	/* (re)open the connection to syslog */
415void update_link_stats __P((int)); /* Get stats at link termination */
416void script_setenv __P((char *, char *, int));	/* set script env var */
417void script_unsetenv __P((char *));		/* unset script env var */
418void new_phase __P((int));	/* signal start of new phase */
419void add_notifier __P((struct notifier **, notify_func, void *));
420void remove_notifier __P((struct notifier **, notify_func, void *));
421void notify __P((struct notifier *, int));
422
423/* Procedures exported from tty.c. */
424void tty_init __P((void));
425
426/* Procedures exported from utils.c. */
427void log_packet __P((u_char *, int, char *, int));
428				/* Format a packet and log it with syslog */
429void print_string __P((char *, int,  void (*) (void *, char *, ...),
430		void *));	/* Format a string for output */
431int slprintf __P((char *, int, char *, ...));		/* sprintf++ */
432int vslprintf __P((char *, int, char *, va_list));	/* vsprintf++ */
433size_t strlcpy __P((char *, const char *, size_t));	/* safe strcpy */
434size_t strlcat __P((char *, const char *, size_t));	/* safe strncpy */
435#ifdef nostrip //Modified by Silver to shrink code
436void dbglog __P((char *, ...));	/* log a debug message */
437void info __P((char *, ...));	/* log an informational message */
438void notice __P((char *, ...));	/* log a notice-level message */
439void warn __P((char *, ...));	/* log a warning message */
440void error __P((char *, ...));	/* log an error message */
441void fatal __P((char *, ...));	/* log an error message and die(1) */
442void init_pr_log __P((char *, int));	/* initialize for using pr_log */
443void pr_log __P((void *, char *, ...));	/* printer fn, output to syslog */
444void end_pr_log __P((void));	/* finish up after using pr_log */
445#else
446#define dbglog(a, ...)
447#define info(a, ...)
448#define notice(a, ...)
449#define warn(a, ...)
450#define error(a, ...)
451#define fatal(a, ...)
452#define init_pr_log(a, b)
453#define pr_log(a,b, ...)
454#define end_pr_log()
455#endif
456
457/* Procedures exported from auth.c */
458void link_required __P((int));	  /* we are starting to use the link */
459void link_terminated __P((int));  /* we are finished with the link */
460void link_down __P((int));	  /* the LCP layer has left the Opened state */
461void link_established __P((int)); /* the link is up; authenticate now */
462void start_networks __P((void));  /* start all the network control protos */
463void np_up __P((int, int));	  /* a network protocol has come up */
464void np_down __P((int, int));	  /* a network protocol has gone down */
465void np_finished __P((int, int)); /* a network protocol no longer needs link */
466void auth_peer_fail __P((int, int));
467				/* peer failed to authenticate itself */
468void auth_peer_success __P((int, int, char *, int));
469				/* peer successfully authenticated itself */
470void auth_withpeer_fail __P((int, int));
471				/* we failed to authenticate ourselves */
472void auth_withpeer_success __P((int, int));
473				/* we successfully authenticated ourselves */
474void auth_check_options __P((void));
475				/* check authentication options supplied */
476void auth_reset __P((int));	/* check what secrets we have */
477int  check_passwd __P((int, char *, int, char *, int, char **));
478				/* Check peer-supplied username/password */
479int  get_secret __P((int, char *, char *, char *, int *, int));
480				/* get "secret" for chap */
481int  auth_ip_addr __P((int, u_int32_t));
482				/* check if IP address is authorized */
483int  bad_ip_adrs __P((u_int32_t));
484				/* check if IP address is unreasonable */
485
486/* Procedures exported from demand.c */
487void demand_conf __P((void));	/* config interface(s) for demand-dial */
488void demand_block __P((void));	/* set all NPs to queue up packets */
489void demand_unblock __P((void)); /* set all NPs to pass packets */
490void demand_discard __P((void)); /* set all NPs to discard packets */
491/* Foxconn added, Winster Chan, 05/15/2006, demand_discard2() */
492void demand_discard2 __P((void)); /* set all NPs to discard packets without errors */
493void demand_rexmit __P((int));	/* retransmit saved frames for an NP */
494int  loop_chars __P((unsigned char *, int)); /* process chars from loopback */
495int  loop_frame __P((unsigned char *, int)); /* should we bring link up? */
496
497#ifdef HAVE_MULTILINK   //Winster Chan added 05/16/2006
498/* Procedures exported from multilink.c */
499void mp_check_options __P((void)); /* Check multilink-related options */
500int  mp_join_bundle __P((void));  /* join our link to an appropriate bundle */
501char *epdisc_to_str __P((struct epdisc *)); /* string from endpoint discrim. */
502int  str_to_epdisc __P((struct epdisc *, char *)); /* endpt disc. from str */
503#endif  //HAVE_MULTILINK Winster Chan added 05/16/2006
504
505/* Procedures exported from sys-*.c */
506void sys_init __P((void));	/* Do system-dependent initialization */
507void sys_cleanup __P((void));	/* Restore system state before exiting */
508int  sys_check_options __P((void)); /* Check options specified */
509void sys_close __P((void));	/* Clean up in a child before execing */
510int  ppp_available __P((void));	/* Test whether ppp kernel support exists */
511int  get_pty __P((int *, int *, char *, int));	/* Get pty master/slave */
512int  open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
513int  tty_establish_ppp __P((int));  /* Turn serial port into a ppp interface */
514void tty_disestablish_ppp __P((int)); /* Restore port to normal operation */
515void generic_disestablish_ppp __P((int dev_fd)); /* Restore device setting */
516int  generic_establish_ppp __P((int dev_fd)); /* Make a ppp interface */
517void make_new_bundle __P((int, int, int, int)); /* Create new bundle */
518int  bundle_attach __P((int));	/* Attach link to existing bundle */
519void cfg_bundle __P((int, int, int, int)); /* Configure existing bundle */
520void clean_check __P((void));	/* Check if line was 8-bit clean */
521void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
522void restore_tty __P((int));	/* Restore port's original parameters */
523void setdtr __P((int, int));	/* Raise or lower port's DTR line */
524void output __P((int, u_char *, int)); /* Output a PPP packet */
525void wait_input __P((struct timeval *));
526				/* Wait for input, with timeout */
527void add_fd __P((int));		/* Add fd to set to wait for */
528void remove_fd __P((int));	/* Remove fd from set to wait for */
529int  read_packet __P((u_char *)); /* Read PPP packet */
530int  get_loop_output __P((void)); /* Read pkts from loopback */
531void tty_send_config __P((int, u_int32_t, int, int));
532				/* Configure i/f transmit parameters */
533void tty_set_xaccm __P((ext_accm));
534				/* Set extended transmit ACCM */
535void tty_recv_config __P((int, u_int32_t, int, int));
536				/* Configure i/f receive parameters */
537int  ccp_test __P((int, u_char *, int, int));
538				/* Test support for compression scheme */
539void ccp_flags_set __P((int, int, int));
540				/* Set kernel CCP state */
541int  ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
542int  get_idle_time __P((int, struct ppp_idle *));
543				/* Find out how long link has been idle */
544int  get_ppp_stats __P((int, struct pppd_stats *));
545				/* Return link statistics */
546void netif_set_mtu __P((int, int)); /* Set PPP interface MTU */
547int  sifvjcomp __P((int, int, int, int));
548				/* Configure VJ TCP header compression */
549int  sifup __P((int));		/* Configure i/f up for one protocol */
550int  sifnpmode __P((int u, int proto, enum NPmode mode));
551				/* Set mode for handling packets for proto */
552int  sifdown __P((int));	/* Configure i/f down for one protocol */
553int  sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
554				/* Configure IPv4 addresses for i/f */
555int  cifaddr __P((int, u_int32_t, u_int32_t));
556				/* Reset i/f IP addresses */
557#ifdef INET6
558int  sif6addr __P((int, eui64_t, eui64_t));
559				/* Configure IPv6 addresses for i/f */
560int  cif6addr __P((int, eui64_t, eui64_t));
561				/* Remove an IPv6 address from i/f */
562#endif
563int  sifdefaultroute __P((int, u_int32_t, u_int32_t));
564				/* Create default route through i/f */
565int  cifdefaultroute __P((int, u_int32_t, u_int32_t));
566				/* Delete default route through i/f */
567int  sifproxyarp __P((int, u_int32_t));
568				/* Add proxy ARP entry for peer */
569int  cifproxyarp __P((int, u_int32_t));
570				/* Delete proxy ARP entry for peer */
571u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
572int  lock __P((char *));	/* Create lock file for device */
573int  relock __P((int));		/* Rewrite lock file with new pid */
574void unlock __P((void));	/* Delete previously-created lock file */
575void logwtmp __P((const char *, const char *, const char *));
576				/* Write entry to wtmp file */
577int  get_host_seed __P((void));	/* Get host-dependent random number seed */
578int  have_route_to __P((u_int32_t)); /* Check if route to addr exists */
579#ifdef PPP_FILTER
580int  set_filters __P((struct bpf_program *pass, struct bpf_program *active));
581				/* Set filter programs in kernel */
582#endif
583#ifdef IPX_CHANGE
584int  sipxfaddr __P((int, unsigned long, unsigned char *));
585int  cipxfaddr __P((int));
586#endif
587int  get_if_hwaddr __P((u_char *addr, char *name));
588char *get_first_ethernet __P((void));
589
590/* Procedures exported from options.c */
591int  parse_args __P((int argc, char **argv));
592				/* Parse options from arguments given */
593int  options_from_file __P((char *filename, int must_exist, int check_prot,
594			    int privileged));
595				/* Parse options from an options file */
596int  options_from_user __P((void)); /* Parse options from user's .ppprc */
597int  options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
598int  options_from_list __P((struct wordlist *, int privileged));
599				/* Parse options from a wordlist */
600int  getword __P((FILE *f, char *word, int *newlinep, char *filename));
601				/* Read a word from a file */
602void option_error __P((char *fmt, ...));
603				/* Print an error message about an option */
604int int_option __P((char *, int *));
605				/* Simplified number_option for decimal ints */
606void add_options __P((option_t *)); /* Add extra options */
607void check_options __P((void));	/* check values after all options parsed */
608int remove_option __P((char *)); /* Disable the specified option */
609int  override_value __P((const char *, int, const char *));
610				/* override value if permitted by priority */
611void print_options __P((void (*) __P((void *, char *, ...)), void *));
612				/* print out values of all options */
613
614int parse_dotted_ip __P((char *, u_int32_t *));
615
616/*
617 * Hooks to enable plugins to change various things.
618 */
619extern int (*new_phase_hook) __P((int));
620extern int (*idle_time_hook) __P((struct ppp_idle *));
621extern int (*holdoff_hook) __P((void));
622extern int (*pap_check_hook) __P((void));
623extern int (*pap_auth_hook) __P((char *user, char *passwd, char **msgp,
624				 struct wordlist **paddrs,
625				 struct wordlist **popts));
626extern void (*pap_logout_hook) __P((void));
627extern int (*pap_passwd_hook) __P((char *user, char *passwd));
628extern void (*ip_up_hook) __P((void));
629extern void (*ip_down_hook) __P((void));
630extern void (*ip_choose_hook) __P((u_int32_t *));
631
632/*
633 * Inline versions of get/put char/short/long.
634 * Pointer is advanced; we assume that both arguments
635 * are lvalues and will already be in registers.
636 * cp MUST be u_char *.
637 */
638#define GETCHAR(c, cp) { \
639	(c) = *(cp)++; \
640}
641#define PUTCHAR(c, cp) { \
642	*(cp)++ = (u_char) (c); \
643}
644
645
646#define GETSHORT(s, cp) { \
647	(s) = *(cp)++ << 8; \
648	(s) |= *(cp)++; \
649}
650#define PUTSHORT(s, cp) { \
651	*(cp)++ = (u_char) ((s) >> 8); \
652	*(cp)++ = (u_char) (s); \
653}
654
655#define GETLONG(l, cp) { \
656	(l) = *(cp)++ << 8; \
657	(l) |= *(cp)++; (l) <<= 8; \
658	(l) |= *(cp)++; (l) <<= 8; \
659	(l) |= *(cp)++; \
660}
661#define PUTLONG(l, cp) { \
662	*(cp)++ = (u_char) ((l) >> 24); \
663	*(cp)++ = (u_char) ((l) >> 16); \
664	*(cp)++ = (u_char) ((l) >> 8); \
665	*(cp)++ = (u_char) (l); \
666}
667
668#define INCPTR(n, cp)	((cp) += (n))
669#define DECPTR(n, cp)	((cp) -= (n))
670
671/*
672 * System dependent definitions for user-level 4.3BSD UNIX implementation.
673 */
674
675#define TIMEOUT(r, f, t)	timeout((r), (f), (t), 0)
676#define UNTIMEOUT(r, f)		untimeout((r), (f))
677
678#define BCOPY(s, d, l)		memcpy(d, s, l)
679#define BZERO(s, n)		memset(s, 0, n)
680
681#define PRINTMSG(m, l)		{ info("Remote message: %0.*v", l, m); }
682
683/*
684 * MAKEHEADER - Add Header fields to a packet.
685 */
686#define MAKEHEADER(p, t) { \
687    PUTCHAR(PPP_ALLSTATIONS, p); \
688    PUTCHAR(PPP_UI, p); \
689    PUTSHORT(t, p); }
690
691/*
692 * Exit status values.
693 */
694#define EXIT_OK			0
695#define EXIT_FATAL_ERROR	1
696#define EXIT_OPTION_ERROR	2
697#define EXIT_NOT_ROOT		3
698#define EXIT_NO_KERNEL_SUPPORT	4
699#define EXIT_USER_REQUEST	5
700#define EXIT_LOCK_FAILED	6
701#define EXIT_OPEN_FAILED	7
702#define EXIT_CONNECT_FAILED	8
703#define EXIT_PTYCMD_FAILED	9
704#define EXIT_NEGOTIATION_FAILED	10
705#define EXIT_PEER_AUTH_FAILED	11
706#define EXIT_IDLE_TIMEOUT	12
707#define EXIT_CONNECT_TIME	13
708#define EXIT_CALLBACK		14
709#define EXIT_PEER_DEAD		15
710#define EXIT_HANGUP		16
711#define EXIT_LOOPBACK		17
712#define EXIT_INIT_FAILED	18
713#define EXIT_AUTH_TOPEER_FAILED	19
714
715/*
716 * Debug macros.  Slightly useful for finding bugs in pppd, not particularly
717 * useful for finding out why your connection isn't being established.
718 */
719#ifdef DEBUGALL
720#define DEBUGMAIN	1
721#define DEBUGFSM	1
722#define DEBUGLCP	1
723#define DEBUGIPCP	1
724#define DEBUGIPV6CP	1
725#define DEBUGUPAP	1
726#define DEBUGCHAP	1
727#endif
728
729#ifndef LOG_PPP			    /* we use LOG_LOCAL2 for syslog by default */
730#if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
731  || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
732  || defined(DEBUGCHAP) || defined(DEBUG) || defined(DEBUGIPV6CP)
733#define LOG_PPP LOG_LOCAL2
734#else
735#define LOG_PPP LOG_DAEMON
736#endif
737#endif /* LOG_PPP */
738
739#ifdef DEBUGMAIN
740#define MAINDEBUG(x)	if (debug) dbglog x
741#else
742#define MAINDEBUG(x)
743#endif
744
745#ifdef DEBUGSYS
746#define SYSDEBUG(x)	if (debug) dbglog x
747#else
748#define SYSDEBUG(x)
749#endif
750
751#ifdef DEBUGFSM
752#define FSMDEBUG(x)	if (debug) dbglog x
753#else
754#define FSMDEBUG(x)
755#endif
756
757#ifdef DEBUGLCP
758#define LCPDEBUG(x)	if (debug) dbglog x
759#else
760#define LCPDEBUG(x)
761#endif
762
763#ifdef DEBUGIPCP
764#define IPCPDEBUG(x)	if (debug) dbglog x
765#else
766#define IPCPDEBUG(x)
767#endif
768
769#ifdef DEBUGIPV6CP
770#define IPV6CPDEBUG(x)  if (debug) dbglog x
771#else
772#define IPV6CPDEBUG(x)
773#endif
774
775#ifdef DEBUGUPAP
776#define UPAPDEBUG(x)	if (debug) dbglog x
777#else
778#define UPAPDEBUG(x)
779#endif
780
781#ifdef DEBUGCHAP
782#define CHAPDEBUG(x)	if (debug) dbglog x
783#else
784#define CHAPDEBUG(x)
785#endif
786
787#ifdef DEBUGIPXCP
788#define IPXCPDEBUG(x)	if (debug) dbglog x
789#else
790#define IPXCPDEBUG(x)
791#endif
792
793#ifndef SIGTYPE
794#if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
795#define SIGTYPE void
796#else
797#define SIGTYPE int
798#endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
799#endif /* SIGTYPE */
800
801#ifndef MIN
802#define MIN(a, b)	((a) < (b)? (a): (b))
803#endif
804#ifndef MAX
805#define MAX(a, b)	((a) > (b)? (a): (b))
806#endif
807
808#endif /* __PPP_H__ */
809