2 * pppd.h - PPP daemon global declarations.
4 * Copyright (c) 1989 Carnegie Mellon University.
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.
19 * $Id: pppd.h,v 1.42 1999/07/21 00:24:32 paulus Exp $
29 #include <stdio.h> /* for FILE */
30 #include <limits.h> /* for NGROUPS_MAX */
31 #include <sys/param.h> /* for MAXPATHLEN and BSD4_4, if defined */
32 #include <sys/types.h> /* for u_int32_t, if defined */
33 #include <sys/time.h> /* for struct timeval */
34 #include <net/ppp_defs.h>
41 #define __V(x) (va_alist) va_dcl
50 #define NUM_PPP 1 /* One PPP interface supported (per process) */
51 #define MAXWORDLEN 1024 /* max length of word in file (incl null) */
52 #define MAXARGS 1 /* max # args to a command */
53 #define MAXNAMELEN 256 /* max length of hostname or name for auth */
54 #define MAXSECRETLEN 256 /* max length of password or secret */
57 * Option descriptor structure.
60 typedef unsigned char bool;
72 char *name; /* name of the option */
82 /* Values for flags */
83 #define OPT_VALUE 0xff /* mask for presupplied value */
84 #define OPT_HEX 0x100 /* int option is in hex */
85 #define OPT_NOARG 0x200 /* option doesn't take argument */
86 #define OPT_OR 0x400 /* OR in argument to value */
87 #define OPT_INC 0x800 /* increment value */
88 #define OPT_PRIV 0x1000 /* privileged option */
89 #define OPT_STATIC 0x2000 /* string option goes into static array */
90 #define OPT_LLIMIT 0x4000 /* check value against lower limit */
91 #define OPT_ULIMIT 0x8000 /* check value against upper limit */
92 #define OPT_LIMITS (OPT_LLIMIT|OPT_ULIMIT)
93 #define OPT_ZEROOK 0x10000 /* 0 value is OK even if not within limits */
94 #define OPT_NOINCR 0x20000 /* value mustn't be increased */
95 #define OPT_ZEROINF 0x40000 /* with OPT_NOINCR, 0 == infinity */
96 #define OPT_A2INFO 0x100000 /* addr2 -> option_info to update */
97 #define OPT_A2COPY 0x200000 /* addr2 -> second location to rcv value */
98 #define OPT_ENABLE 0x400000 /* use *addr2 as enable for option */
99 #define OPT_PRIVFIX 0x800000 /* can't be overridden if noauth */
100 #define OPT_PREPASS 0x1000000 /* do this opt in pre-pass to find device */
101 #define OPT_INITONLY 0x2000000 /* option can only be set in init phase */
102 #define OPT_DEVEQUIV 0x4000000 /* equiv to device name */
103 #define OPT_DEVNAM (OPT_PREPASS | OPT_INITONLY | OPT_DEVEQUIV)
105 #define OPT_VAL(x) ((x) & OPT_VALUE)
108 #define GIDSET_TYPE gid_t
111 /* Structure representing a list of permitted IP addresses. */
112 struct permitted_ip {
113 int permit; /* 1 = permit, 0 = forbid */
114 u_int32_t base; /* match if (addr & mask) == base */
115 u_int32_t mask; /* base and mask are in network byte order */
119 * Unfortunately, the linux kernel driver uses a different structure
120 * for statistics from the rest of the ports.
121 * This structure serves as a common representation for the bits
125 unsigned int bytes_in;
126 unsigned int bytes_out;
129 /* Used for storing a sequence of words. Usually malloced. */
131 struct wordlist *next;
139 extern int hungup; /* Physical layer has disconnected */
140 extern int ifunit; /* Interface unit number */
141 extern char ifname[]; /* Interface name */
142 extern int ttyfd; /* Serial device file descriptor */
143 extern char hostname[]; /* Our hostname */
144 extern u_char outpacket_buf[]; /* Buffer for outgoing packets */
145 extern int phase; /* Current state of link - see values below */
146 extern int baud_rate; /* Current link speed in bits/sec */
147 extern char *progname; /* Name of this program */
148 extern int redirect_stderr;/* Connector's stderr should go to file */
149 extern char peer_authname[];/* Authenticated name of peer */
150 extern int privileged; /* We were run by real-uid root */
151 extern int need_holdoff; /* Need holdoff period after link terminates */
152 extern char **script_env; /* Environment variables for scripts */
153 extern int detached; /* Have detached from controlling tty */
154 extern GIDSET_TYPE groups[NGROUPS_MAX]; /* groups the user is in */
155 extern int ngroups; /* How many groups valid in groups */
156 extern struct pppd_stats link_stats; /* byte/packet counts etc. for link */
157 extern int link_stats_valid; /* set if link_stats is valid */
158 extern int using_pty; /* using pty as device (notty or pty opt.) */
159 extern int log_to_fd; /* logging to this fd as well as syslog */
160 extern char *no_ppp_msg; /* message to print if ppp not in kernel */
161 extern volatile int status; /* exit status for pppd */
162 extern int devnam_fixed; /* can no longer change devnam */
165 * Variables set by command-line options.
168 extern int debug; /* Debug flag */
169 extern int kdebugflag; /* Tell kernel to print debug messages */
170 extern int default_device; /* Using /dev/tty or equivalent */
171 extern char devnam[MAXPATHLEN]; /* Device name */
172 extern int crtscts; /* Use hardware flow control */
173 extern bool modem; /* Use modem control lines */
174 extern int inspeed; /* Input/Output speed requested */
175 extern u_int32_t netmask; /* IP netmask to set on interface */
176 extern bool lockflag; /* Create lock file to lock the serial dev */
177 extern bool nodetach; /* Don't detach from controlling tty */
178 extern bool updetach; /* Detach from controlling tty when link up */
179 extern char *initializer; /* Script to initialize physical link */
180 extern char *connector; /* Script to establish physical link */
181 extern char *disconnector; /* Script to disestablish physical link */
182 extern char *welcomer; /* Script to welcome client after connection */
183 extern char *ptycommand; /* Command to run on other side of pty */
184 extern int maxconnect; /* Maximum connect time (seconds) */
185 extern char user[MAXNAMELEN];/* Our name for authenticating ourselves */
186 extern char passwd[MAXSECRETLEN]; /* Password for PAP */
187 extern bool auth_required; /* Peer is required to authenticate */
188 extern bool persist; /* Reopen link after it goes down */
189 extern bool uselogin; /* Use /etc/passwd for checking PAP */
190 extern char our_name[MAXNAMELEN];/* Our name for authentication purposes */
191 extern char remote_name[MAXNAMELEN]; /* Peer's name for authentication */
192 extern bool explicit_remote;/* remote_name specified with remotename opt */
193 extern bool demand; /* Do dial-on-demand */
194 extern char *ipparam; /* Extra parameter for ip up/down scripts */
195 extern bool cryptpap; /* Others' PAP passwords are encrypted */
196 extern int idle_time_limit;/* Shut down link if idle for this long */
197 extern int holdoff; /* Dead time before restarting */
198 extern bool notty; /* Stdin/out is not a tty */
199 extern char *record_file; /* File to record chars sent/received */
200 extern bool sync_serial; /* Device is synchronous serial device */
203 extern struct bpf_program pass_filter; /* Filter for pkts to pass */
204 extern struct bpf_program active_filter; /* Filter for link-active pkts */
208 extern bool ms_lanman; /* Use LanMan password instead of NT */
209 /* Has meaning only with MS-CHAP challenges */
212 extern char *current_option; /* the name of the option being parsed */
213 extern int privileged_option; /* set iff the current option came from root */
214 extern char *option_source; /* string saying where the option came from */
220 #define PHASE_INITIALIZE 1
221 #define PHASE_SERIALCONN 2
222 #define PHASE_DORMANT 3
223 #define PHASE_ESTABLISH 4
224 #define PHASE_AUTHENTICATE 5
225 #define PHASE_CALLBACK 6
226 #define PHASE_NETWORK 7
227 #define PHASE_TERMINATE 8
228 #define PHASE_HOLDOFF 9
231 * The following struct gives the addresses of procedures to call
232 * for a particular protocol.
235 u_short protocol; /* PPP protocol number */
236 /* Initialization procedure */
237 void (*init) __P((int unit));
238 /* Process a received packet */
239 void (*input) __P((int unit, u_char *pkt, int len));
240 /* Process a received protocol-reject */
241 void (*protrej) __P((int unit));
242 /* Lower layer has come up */
243 void (*lowerup) __P((int unit));
244 /* Lower layer has gone down */
245 void (*lowerdown) __P((int unit));
246 /* Open the protocol */
247 void (*open) __P((int unit));
248 /* Close the protocol */
249 void (*close) __P((int unit, char *reason));
250 /* Print a packet in readable form */
251 int (*printpkt) __P((u_char *pkt, int len,
252 void (*printer) __P((void *, char *, ...)),
254 /* Process a received data packet */
255 void (*datainput) __P((int unit, u_char *pkt, int len));
256 bool enabled_flag; /* 0 iff protocol is disabled */
257 char *name; /* Text name of protocol */
258 char *data_name; /* Text name of corresponding data protocol */
259 option_t *options; /* List of command-line options */
260 /* Check requested options, assign defaults */
261 void (*check_options) __P((void));
262 /* Configure interface for demand-dial */
263 int (*demand_conf) __P((int unit));
264 /* Say whether to bring up link for this pkt */
265 int (*active_pkt) __P((u_char *pkt, int len));
268 /* Table of pointers to supported protocols */
269 extern struct protent *protocols[];
275 /* Procedures exported from main.c. */
276 void detach __P((void)); /* Detach from controlling tty */
277 void die __P((int)); /* Cleanup and exit */
278 void quit __P((void)); /* like die(1) */
279 void novm __P((char *)); /* Say we ran out of memory, and die */
280 void timeout __P((void (*func)(void *), void *arg, int t));
281 /* Call func(arg) after t seconds */
282 void untimeout __P((void (*func)(void *), void *arg));
283 /* Cancel call to func(arg) */
284 pid_t run_program __P((char *prog, char **args, int must_exist,
285 void (*done)(void *), void *arg));
286 /* Run program prog with args in child */
287 void reopen_log __P((void)); /* (re)open the connection to syslog */
288 void update_link_stats __P((int)); /* Get stats at link termination */
289 void script_setenv __P((char *, char *)); /* set script env var */
290 void script_unsetenv __P((char *)); /* unset script env var */
292 /* Procedures exported from utils.c. */
293 void log_packet __P((u_char *, int, char *, int));
294 /* Format a packet and log it with syslog */
295 void print_string __P((char *, int, void (*) (void *, char *, ...),
296 void *)); /* Format a string for output */
297 int slprintf __P((char *, int, char *, ...)); /* sprintf++ */
298 int vslprintf __P((char *, int, char *, va_list)); /* vsprintf++ */
299 size_t strlcpy __P((char *, const char *, size_t)); /* safe strcpy */
300 size_t strlcat __P((char *, const char *, size_t)); /* safe strncpy */
301 void dbglog __P((char *, ...)); /* log a debug message */
302 void info __P((char *, ...)); /* log an informational message */
303 void notice __P((char *, ...)); /* log a notice-level message */
304 void warn __P((char *, ...)); /* log a warning message */
305 void error __P((char *, ...)); /* log an error message */
306 void fatal __P((char *, ...)); /* log an error message and die(1) */
308 /* Procedures exported from auth.c */
309 void link_required __P((int)); /* we are starting to use the link */
310 void link_terminated __P((int)); /* we are finished with the link */
311 void link_down __P((int)); /* the LCP layer has left the Opened state */
312 void link_established __P((int)); /* the link is up; authenticate now */
313 void start_networks __P((void)); /* start all the network control protos */
314 void np_up __P((int, int)); /* a network protocol has come up */
315 void np_down __P((int, int)); /* a network protocol has gone down */
316 void np_finished __P((int, int)); /* a network protocol no longer needs link */
317 void auth_peer_fail __P((int, int));
318 /* peer failed to authenticate itself */
319 void auth_peer_success __P((int, int, char *, int));
320 /* peer successfully authenticated itself */
321 void auth_withpeer_fail __P((int, int));
322 /* we failed to authenticate ourselves */
323 void auth_withpeer_success __P((int, int));
324 /* we successfully authenticated ourselves */
325 void auth_check_options __P((void));
326 /* check authentication options supplied */
327 void auth_reset __P((int)); /* check what secrets we have */
328 int check_passwd __P((int, char *, int, char *, int, char **, int *));
329 /* Check peer-supplied username/password */
330 int get_secret __P((int, char *, char *, char *, int *, int));
331 /* get "secret" for chap */
332 int auth_ip_addr __P((int, u_int32_t));
333 /* check if IP address is authorized */
334 int bad_ip_adrs __P((u_int32_t));
335 /* check if IP address is unreasonable */
337 /* Procedures exported from demand.c */
338 void demand_conf __P((void)); /* config interface(s) for demand-dial */
339 void demand_block __P((void)); /* set all NPs to queue up packets */
340 void demand_unblock __P((void)); /* set all NPs to pass packets */
341 void demand_discard __P((void)); /* set all NPs to discard packets */
342 void demand_rexmit __P((int)); /* retransmit saved frames for an NP */
343 int loop_chars __P((unsigned char *, int)); /* process chars from loopback */
344 int loop_frame __P((unsigned char *, int)); /* should we bring link up? */
346 /* Procedures exported from sys-*.c */
347 void sys_init __P((void)); /* Do system-dependent initialization */
348 void sys_cleanup __P((void)); /* Restore system state before exiting */
349 int sys_check_options __P((void)); /* Check options specified */
350 void sys_close __P((void)); /* Clean up in a child before execing */
351 int ppp_available __P((void)); /* Test whether ppp kernel support exists */
352 int get_pty __P((int *, int *, char *, int)); /* Get pty master/slave */
353 int open_ppp_loopback __P((void)); /* Open loopback for demand-dialling */
354 int establish_ppp __P((int)); /* Turn serial port into a ppp interface */
355 void restore_loop __P((void)); /* Transfer ppp unit back to loopback */
356 void disestablish_ppp __P((int)); /* Restore port to normal operation */
357 void clean_check __P((void)); /* Check if line was 8-bit clean */
358 void set_up_tty __P((int, int)); /* Set up port's speed, parameters, etc. */
359 void restore_tty __P((int)); /* Restore port's original parameters */
360 void setdtr __P((int, int)); /* Raise or lower port's DTR line */
361 void output __P((int, u_char *, int)); /* Output a PPP packet */
362 void wait_input __P((struct timeval *));
363 /* Wait for input, with timeout */
364 void add_fd __P((int)); /* Add fd to set to wait for */
365 void remove_fd __P((int)); /* Remove fd from set to wait for */
366 int read_packet __P((u_char *)); /* Read PPP packet */
367 int get_loop_output __P((void)); /* Read pkts from loopback */
368 void ppp_send_config __P((int, int, u_int32_t, int, int));
369 /* Configure i/f transmit parameters */
370 void ppp_set_xaccm __P((int, ext_accm));
371 /* Set extended transmit ACCM */
372 void ppp_recv_config __P((int, int, u_int32_t, int, int));
373 /* Configure i/f receive parameters */
374 int ccp_test __P((int, u_char *, int, int));
375 /* Test support for compression scheme */
376 void ccp_flags_set __P((int, int, int));
377 /* Set kernel CCP state */
378 int ccp_fatal_error __P((int)); /* Test for fatal decomp error in kernel */
379 int get_idle_time __P((int, struct ppp_idle *));
380 /* Find out how long link has been idle */
381 int get_ppp_stats __P((int, struct pppd_stats *));
382 /* Return link statistics */
383 int sifvjcomp __P((int, int, int, int));
384 /* Configure VJ TCP header compression */
385 int sifup __P((int)); /* Configure i/f up (for IP) */
386 int sifnpmode __P((int u, int proto, enum NPmode mode));
387 /* Set mode for handling packets for proto */
388 int sifdown __P((int)); /* Configure i/f down (for IP) */
389 int sifaddr __P((int, u_int32_t, u_int32_t, u_int32_t));
390 /* Configure IP addresses for i/f */
391 int cifaddr __P((int, u_int32_t, u_int32_t));
392 /* Reset i/f IP addresses */
393 int sifdefaultroute __P((int, u_int32_t, u_int32_t));
394 /* Create default route through i/f */
395 int cifdefaultroute __P((int, u_int32_t, u_int32_t));
396 /* Delete default route through i/f */
397 int sifproxyarp __P((int, u_int32_t));
398 /* Add proxy ARP entry for peer */
399 int cifproxyarp __P((int, u_int32_t));
400 /* Delete proxy ARP entry for peer */
401 u_int32_t GetMask __P((u_int32_t)); /* Get appropriate netmask for address */
402 int lock __P((char *)); /* Create lock file for device */
403 int relock __P((int)); /* Rewrite lock file with new pid */
404 void unlock __P((void)); /* Delete previously-created lock file */
405 void logwtmp __P((const char *, const char *, const char *));
406 /* Write entry to wtmp file */
407 int get_host_seed __P((void)); /* Get host-dependent random number seed */
408 int have_route_to __P((u_int32_t)); /* Check if route to addr exists */
410 int set_filters __P((struct bpf_program *pass, struct bpf_program *active));
411 /* Set filter programs in kernel */
414 int sipxfaddr __P((int, unsigned long, unsigned char *));
415 int cipxfaddr __P((int));
418 /* Procedures exported from options.c */
419 int parse_args __P((int argc, char **argv));
420 /* Parse options from arguments given */
421 int options_from_file __P((char *filename, int must_exist, int check_prot,
423 /* Parse options from an options file */
424 int options_from_user __P((void)); /* Parse options from user's .ppprc */
425 int options_for_tty __P((void)); /* Parse options from /etc/ppp/options.tty */
426 int options_from_list __P((struct wordlist *, int privileged));
427 /* Parse options from a wordlist */
428 int getword __P((FILE *f, char *word, int *newlinep, char *filename));
429 /* Read a word from a file */
430 void option_error __P((char *fmt, ...));
431 /* Print an error message about an option */
432 int int_option __P((char *, int *));
433 /* Simplified number_option for decimal ints */
436 * This structure is used to store information about certain
437 * options, such as where the option value came from (/etc/ppp/options,
438 * command line, etc.) and whether it came from a privileged source.
442 int priv; /* was value set by sysadmin? */
443 char *source; /* where option came from */
446 extern struct option_info devnam_info;
447 extern struct option_info initializer_info;
448 extern struct option_info connector_info;
449 extern struct option_info disconnector_info;
450 extern struct option_info welcomer_info;
451 extern struct option_info ptycommand_info;
454 * Inline versions of get/put char/short/long.
455 * Pointer is advanced; we assume that both arguments
456 * are lvalues and will already be in registers.
457 * cp MUST be u_char *.
459 #define GETCHAR(c, cp) { \
462 #define PUTCHAR(c, cp) { \
463 *(cp)++ = (u_char) (c); \
467 #define GETSHORT(s, cp) { \
468 (s) = *(cp)++ << 8; \
471 #define PUTSHORT(s, cp) { \
472 *(cp)++ = (u_char) ((s) >> 8); \
473 *(cp)++ = (u_char) (s); \
476 #define GETLONG(l, cp) { \
477 (l) = *(cp)++ << 8; \
478 (l) |= *(cp)++; (l) <<= 8; \
479 (l) |= *(cp)++; (l) <<= 8; \
482 #define PUTLONG(l, cp) { \
483 *(cp)++ = (u_char) ((l) >> 24); \
484 *(cp)++ = (u_char) ((l) >> 16); \
485 *(cp)++ = (u_char) ((l) >> 8); \
486 *(cp)++ = (u_char) (l); \
489 #define INCPTR(n, cp) ((cp) += (n))
490 #define DECPTR(n, cp) ((cp) -= (n))
493 * System dependent definitions for user-level 4.3BSD UNIX implementation.
496 #define TIMEOUT(r, f, t) timeout((r), (f), (t))
497 #define UNTIMEOUT(r, f) untimeout((r), (f))
499 #define BCOPY(s, d, l) memcpy(d, s, l)
500 #define BZERO(s, n) memset(s, 0, n)
502 #define PRINTMSG(m, l) { info("Remote message: %0.*v", l, m); }
505 * MAKEHEADER - Add Header fields to a packet.
507 #define MAKEHEADER(p, t) { \
508 PUTCHAR(PPP_ALLSTATIONS, p); \
509 PUTCHAR(PPP_UI, p); \
513 * Exit status values.
516 #define EXIT_FATAL_ERROR 1
517 #define EXIT_OPTION_ERROR 2
518 #define EXIT_NOT_ROOT 3
519 #define EXIT_NO_KERNEL_SUPPORT 4
520 #define EXIT_USER_REQUEST 5
521 #define EXIT_LOCK_FAILED 6
522 #define EXIT_OPEN_FAILED 7
523 #define EXIT_CONNECT_FAILED 8
524 #define EXIT_PTYCMD_FAILED 9
525 #define EXIT_NEGOTIATION_FAILED 10
526 #define EXIT_PEER_AUTH_FAILED 11
527 #define EXIT_IDLE_TIMEOUT 12
528 #define EXIT_CONNECT_TIME 13
529 #define EXIT_CALLBACK 14
530 #define EXIT_PEER_DEAD 15
531 #define EXIT_HANGUP 16
532 #define EXIT_LOOPBACK 17
533 #define EXIT_INIT_FAILED 18
536 * Debug macros. Slightly useful for finding bugs in pppd, not particularly
537 * useful for finding out why your connection isn't being established.
548 #ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */
549 #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \
550 || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \
551 || defined(DEBUGCHAP) || defined(DEBUG)
552 #define LOG_PPP LOG_LOCAL2
554 #define LOG_PPP LOG_DAEMON
559 #define MAINDEBUG(x) if (debug) dbglog x
565 #define SYSDEBUG(x) if (debug) dbglog x
571 #define FSMDEBUG(x) if (debug) dbglog x
577 #define LCPDEBUG(x) if (debug) dbglog x
583 #define IPCPDEBUG(x) if (debug) dbglog x
589 #define UPAPDEBUG(x) if (debug) dbglog x
595 #define CHAPDEBUG(x) if (debug) dbglog x
601 #define IPXCPDEBUG(x) if (debug) dbglog x
603 #define IPXCPDEBUG(x)
607 #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE)
611 #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */
615 #define MIN(a, b) ((a) < (b)? (a): (b))
618 #define MAX(a, b) ((a) > (b)? (a): (b))
621 #endif /* __PPP_H__ */