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