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