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