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