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