/* $OpenBSD: pppd.h,v 1.15 2003/04/25 23:24:32 deraadt Exp $ */ /* * pppd.h - PPP daemon global declarations. * * Copyright (c) 1984-2000 Carnegie Mellon University. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The name "Carnegie Mellon University" must not be used to * endorse or promote products derived from this software without * prior written permission. For permission or any legal * details, please contact * Office of Technology Transfer * Carnegie Mellon University * 5000 Forbes Avenue * Pittsburgh, PA 15213-3890 * (412) 268-4387, fax: (412) 268-7395 * tech-transfer@andrew.cmu.edu * * 4. Redistributions of any form whatsoever must retain the following * acknowledgment: * "This product includes software developed by Computing Services * at Carnegie Mellon University (http://www.cmu.edu/computing/)." * * CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY * AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE * FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ /* * TODO: */ #ifndef __PPPD_H__ #define __PPPD_H__ #include /* for FILE */ #include #include /* for MAXPATHLEN and BSD4_4, if defined */ #include /* for u_int32_t, if defined */ #include /* for struct timeval */ #include /* * Limits. */ #define NUM_PPP 1 /* One PPP interface supported (per process) */ #define MAXWORDLEN 1024 /* max length of word in file (incl null) */ #define MAXARGS 1 /* max # args to a command */ #define MAXNAMELEN 256 /* max length of hostname or name for auth */ #define MAXSECRETLEN 256 /* max length of password or secret */ /* * Global variables. */ extern int hungup; /* Physical layer has disconnected */ extern int ifunit; /* Interface unit number */ extern char ifname[]; /* Interface name */ extern int ttyfd; /* Serial device file descriptor */ extern char hostname[]; /* Our hostname */ extern u_char outpacket_buf[]; /* Buffer for outgoing packets */ extern int phase; /* Current state of link - see values below */ extern int baud_rate; /* Current link speed in bits/sec */ extern char *progname; /* Name of this program */ extern int redirect_stderr;/* Connector's stderr should go to file */ extern char peer_authname[];/* Authenticated name of peer */ extern int privileged; /* We were run by real-uid root */ extern int need_holdoff; /* Need holdoff period after link terminates */ extern char **script_env; /* Environment variables for scripts */ extern int detached; /* Have detached from controlling tty */ /* * Variables set by command-line options. */ extern int debug; /* Debug flag */ extern int kdebugflag; /* Tell kernel to print debug messages */ extern int default_device; /* Using /dev/tty or equivalent */ extern char devnam[]; /* Device name */ extern int crtscts; /* Use hardware flow control */ extern int modem; /* Use modem control lines */ extern int modem_chat; /* Watch carrier detect in chat script */ extern int inspeed; /* Input/Output speed requested */ extern u_int32_t netmask; /* IP netmask to set on interface */ extern int lockflag; /* Create lock file to lock the serial dev */ extern int nodetach; /* Don't detach from controlling tty */ extern char *connector; /* Script to establish physical link */ extern char *disconnector; /* Script to disestablish physical link */ extern char *welcomer; /* Script to welcome client after connection */ extern int maxconnect; /* Maximum connect time (seconds) */ extern char user[]; /* Our name for authenticating ourselves */ extern char passwd[]; /* Password for PAP */ extern int auth_required; /* Peer is required to authenticate */ extern int proxyarp; /* Set up proxy ARP entry for peer */ extern int persist; /* Reopen link after it goes down */ extern int uselogin; /* Use /etc/passwd for checking PAP */ extern int lcp_echo_interval; /* Interval between LCP echo-requests */ extern int lcp_echo_fails; /* Tolerance to unanswered echo-requests */ extern char our_name[]; /* Our name for authentication purposes */ extern char remote_name[]; /* Peer's name for authentication */ extern int explicit_remote;/* remote_name specified with remotename opt */ extern int usehostname; /* Use hostname for our_name */ extern int disable_defaultip; /* Don't use hostname for default IP adrs */ extern int demand; /* Do dial-on-demand */ extern char *ipparam; /* Extra parameter for ip up/down scripts */ extern int cryptpap; /* Others' PAP passwords are encrypted */ extern int idle_time_limit;/* Shut down link if idle for this long */ extern int holdoff; /* Dead time before restarting */ extern int refuse_pap; /* Don't wanna auth. ourselves with PAP */ extern int refuse_chap; /* Don't wanna auth. ourselves with CHAP */ #ifdef PPP_FILTER extern struct bpf_program pass_filter; /* Filter for pkts to pass */ extern struct bpf_program active_filter; /* Filter for link-active pkts */ #endif #ifdef MSLANMAN extern int ms_lanman; /* Nonzero if use LanMan password instead of NT */ /* Has meaning only with MS-CHAP challenges */ #endif /* * Values for phase. */ #define PHASE_DEAD 0 #define PHASE_INITIALIZE 1 #define PHASE_DORMANT 2 #define PHASE_ESTABLISH 3 #define PHASE_AUTHENTICATE 4 #define PHASE_CALLBACK 5 #define PHASE_NETWORK 6 #define PHASE_TERMINATE 7 #define PHASE_HOLDOFF 8 /* * The following struct gives the addresses of procedures to call * for a particular protocol. */ struct protent { u_short protocol; /* PPP protocol number */ /* Initialization procedure */ void (*init)(int unit); /* Process a received packet */ void (*input)(int unit, u_char *pkt, int len); /* Process a received protocol-reject */ void (*protrej)(int unit); /* Lower layer has come up */ void (*lowerup)(int unit); /* Lower layer has gone down */ void (*lowerdown)(int unit); /* Open the protocol */ void (*open)(int unit); /* Close the protocol */ void (*close)(int unit, char *reason); /* Print a packet in readable form */ int (*printpkt)(u_char *pkt, int len, void (*printer)(void *, char *, ...), void *arg); /* Process a received data packet */ void (*datainput)(int unit, u_char *pkt, int len); int enabled_flag; /* 0 iff protocol is disabled */ char *name; /* Text name of protocol */ /* Check requested options, assign defaults */ void (*check_options)(void); /* Configure interface for demand-dial */ int (*demand_conf)(int unit); /* Say whether to bring up link for this pkt */ int (*active_pkt)(u_char *pkt, int len); }; /* Table of pointers to supported protocols */ extern struct protent *protocols[]; /* * Prototypes. */ /* Procedures exported from main.c. */ void detach(void); /* Detach from controlling tty */ void die(int); /* Cleanup and exit */ void quit(void); /* like die(1) */ void novm(char *); /* Say we ran out of memory, and die */ void timeout(void (*func)(void *), void *arg, int t); /* Call func(arg) after t seconds */ void untimeout(void (*func)(void *), void *arg); /* Cancel call to func(arg) */ int run_program(char *prog, char **args, int must_exist); /* Run program prog with args in child */ void demuxprotrej(int, int); /* Demultiplex a Protocol-Reject */ void format_packet(u_char *, int, void (*) (void *, char *, ...), void *); /* Format a packet in human-readable form */ void log_packet(u_char *, int, char *, int); /* Format a packet and log it with syslog */ void print_string(char *, int, void (*) (void *, char *, ...), void *); /* Format a string for output */ int fmtmsg(char *, int, char *, ...); /* snprintf++ */ int vfmtmsg(char *, int, char *, va_list); /* vsnprintf++ */ void script_setenv(char *, char *); /* set script env var */ void script_unsetenv(char *); /* unset script env var */ /* Procedures exported from auth.c */ void link_required(int); /* we are starting to use the link */ void link_terminated(int); /* we are finished with the link */ void link_down(int); /* the LCP layer has left the Opened state */ void link_established(int); /* the link is up; authenticate now */ void np_up(int, int); /* a network protocol has come up */ void np_down(int, int); /* a network protocol has gone down */ void np_finished(int, int); /* a network protocol no longer needs link */ void auth_peer_fail(int, int); /* peer failed to authenticate itself */ void auth_peer_success(int, int, char *, int); /* peer successfully authenticated itself */ void auth_withpeer_fail(int, int); /* we failed to authenticate ourselves */ void auth_withpeer_success(int, int); /* we successfully authenticated ourselves */ void auth_check_options(void); /* check authentication options supplied */ void auth_reset(int); /* check what secrets we have */ int check_passwd(int, char *, int, char *, int, char **, int *); /* Check peer-supplied username/password */ int get_secret(int, char *, char *, char *, int *, int); /* get "secret" for chap */ int auth_ip_addr(int, u_int32_t); /* check if IP address is authorized */ int bad_ip_adrs(u_int32_t); /* check if IP address is unreasonable */ void check_access(FILE *, char *); /* check permissions on secrets file */ /* Procedures exported from demand.c */ void demand_conf(void); /* config interface(s) for demand-dial */ void demand_block(void); /* set all NPs to queue up packets */ void demand_drop(void); /* set all NPs to drop packets */ void demand_unblock(void); /* set all NPs to pass packets */ void demand_discard(void); /* set all NPs to discard packets */ void demand_rexmit(int); /* retransmit saved frames for an NP */ int loop_chars(unsigned char *, int); /* process chars from loopback */ int loop_frame(unsigned char *, int); /* process frame from loopback */ /* Procedures exported from sys-*.c */ void sys_init(void); /* Do system-dependent initialization */ void sys_cleanup(void); /* Restore system state before exiting */ void sys_check_options(void); /* Check options specified */ void sys_close(void); /* Clean up in a child before execing */ int ppp_available(void); /* Test whether ppp kernel support exists */ void open_ppp_loopback(void); /* Open loopback for demand-dialling */ void establish_ppp(int); /* Turn serial port into a ppp interface */ void restore_loop(void); /* Transfer ppp unit back to loopback */ void disestablish_ppp(int); /* Restore port to normal operation */ void clean_check(void); /* Check if line was 8-bit clean */ void set_up_tty(int, int); /* Set up port's speed, parameters, etc. */ void restore_tty(int); /* Restore port's original parameters */ void setdtr(int, int); /* Raise or lower port's DTR line */ void output(int, u_char *, int); /* Output a PPP packet */ void wait_input(struct timeval *); /* Wait for input, with timeout */ void wait_loop_output(struct timeval *); /* Wait for pkt from loopback, with timeout */ void wait_time(struct timeval *); /* Wait for given length of time */ int read_packet(u_char *); /* Read PPP packet */ int get_loop_output(void); /* Read pkts from loopback */ void ppp_send_config(int, int, u_int32_t, int, int); /* Configure i/f transmit parameters */ void ppp_set_xaccm(int, ext_accm); /* Set extended transmit ACCM */ void ppp_recv_config(int, int, u_int32_t, int, int); /* Configure i/f receive parameters */ int ccp_test(int, u_char *, int, int); /* Test support for compression scheme */ void ccp_flags_set(int, int, int); /* Set kernel CCP state */ int ccp_fatal_error(int); /* Test for fatal decomp error in kernel */ int get_idle_time(int, struct ppp_idle *); /* Find out how long link has been idle */ int sifvjcomp(int, int, int, int); /* Configure VJ TCP header compression */ int sifup(int); /* Configure i/f up (for IP) */ int sifnpmode(int u, int proto, enum NPmode mode); /* Set mode for handling packets for proto */ int sifdown(int); /* Configure i/f down (for IP) */ int sifaddr(int, u_int32_t, u_int32_t, u_int32_t); /* Configure IP addresses for i/f */ int cifaddr(int, u_int32_t, u_int32_t); /* Reset i/f IP addresses */ int sifdefaultroute(int, u_int32_t, u_int32_t); /* Create default route through i/f */ int cifdefaultroute(int, u_int32_t, u_int32_t); /* Delete default route through i/f */ int sifproxyarp(int, u_int32_t); /* Add proxy ARP entry for peer */ int cifproxyarp(int, u_int32_t); /* Delete proxy ARP entry for peer */ u_int32_t GetMask(u_int32_t); /* Get appropriate netmask for address */ int lock(char *); /* Create lock file for device */ void unlock(void); /* Delete previously-created lock file */ int daemon(int, int); /* Detach us from terminal session */ void logwtmp(const char *, const char *, const char *); /* Write entry to wtmp file */ int get_host_seed(void); /* Get host-dependent random number seed */ #ifdef PPP_FILTER int set_filters(struct bpf_program *pass, struct bpf_program *active); /* Set filter programs in kernel */ #endif /* Procedures exported from options.c */ int parse_args(int argc, char **argv); /* Parse options from arguments given */ void usage(void); /* Print a usage message */ int options_from_file(char *filename, int must_exist, int check_prot, int privileged); /* Parse options from an options file */ int options_from_user(void); /* Parse options from user's .ppprc */ int options_for_tty(void); /* Parse options from /etc/ppp/options.tty */ void scan_args(int argc, char **argv); /* Look for tty name in command-line args */ int getword(FILE *f, char *word, int *newlinep, char *filename); /* Read a word from a file */ void option_error(char *fmt, ...); /* Print an error message about an option */ /* * This structure is used to store information about certain * options, such as where the option value came from (/etc/ppp/options, * command line, etc.) and whether it came from a privileged source. */ struct option_info { int priv; /* was value set by sysadmin? */ char *source; /* where option came from */ }; extern struct option_info auth_req_info; extern struct option_info connector_info; extern struct option_info disconnector_info; extern struct option_info welcomer_info; extern struct option_info devnam_info; /* * Inline versions of get/put char/short/long. * Pointer is advanced; we assume that both arguments * are lvalues and will already be in registers. * cp MUST be u_char *. */ #define GETCHAR(c, cp) { \ (c) = *(cp)++; \ } #define PUTCHAR(c, cp) { \ *(cp)++ = (u_char) (c); \ } #define GETSHORT(s, cp) { \ (s) = *(cp)++ << 8; \ (s) |= *(cp)++; \ } #define PUTSHORT(s, cp) { \ *(cp)++ = (u_char) ((s) >> 8); \ *(cp)++ = (u_char) (s); \ } #define GETLONG(l, cp) { \ (l) = *(cp)++ << 8; \ (l) |= *(cp)++; (l) <<= 8; \ (l) |= *(cp)++; (l) <<= 8; \ (l) |= *(cp)++; \ } #define PUTLONG(l, cp) { \ *(cp)++ = (u_char) ((l) >> 24); \ *(cp)++ = (u_char) ((l) >> 16); \ *(cp)++ = (u_char) ((l) >> 8); \ *(cp)++ = (u_char) (l); \ } #define INCPTR(n, cp) ((cp) += (n)) #define DECPTR(n, cp) ((cp) -= (n)) #undef FALSE #define FALSE 0 #undef TRUE #define TRUE 1 /* * System dependent definitions for user-level 4.3BSD UNIX implementation. */ #define DEMUXPROTREJ(u, p) demuxprotrej(u, p) #define TIMEOUT(r, f, t) timeout((r), (f), (t)) #define UNTIMEOUT(r, f) untimeout((r), (f)) #define BCOPY(s, d, l) memcpy(d, s, l) #define BZERO(s, n) memset(s, 0, n) #define EXIT(u) quit() #define PRINTMSG(m, l) { m[l] = '\0'; syslog(LOG_INFO, "Remote message: %s", m); } /* * MAKEHEADER - Add Header fields to a packet. */ #define MAKEHEADER(p, t) { \ PUTCHAR(PPP_ALLSTATIONS, p); \ PUTCHAR(PPP_UI, p); \ PUTSHORT(t, p); } #ifdef DEBUGALL #define DEBUGMAIN 1 #define DEBUGFSM 1 #define DEBUGLCP 1 #define DEBUGIPCP 1 #define DEBUGUPAP 1 #define DEBUGCHAP 1 #endif #ifndef LOG_PPP /* we use LOG_LOCAL2 for syslog by default */ #if defined(DEBUGMAIN) || defined(DEBUGFSM) || defined(DEBUGSYS) \ || defined(DEBUGLCP) || defined(DEBUGIPCP) || defined(DEBUGUPAP) \ || defined(DEBUGCHAP) || defined(DEBUG) #define LOG_PPP LOG_LOCAL2 #else #define LOG_PPP LOG_DAEMON #endif #endif /* LOG_PPP */ #ifdef DEBUGMAIN #define MAINDEBUG(x) if (debug) syslog x #else #define MAINDEBUG(x) #endif #ifdef DEBUGSYS #define SYSDEBUG(x) if (debug) syslog x #else #define SYSDEBUG(x) #endif #ifdef DEBUGFSM #define FSMDEBUG(x) if (debug) syslog x #else #define FSMDEBUG(x) #endif #ifdef DEBUGLCP #define LCPDEBUG(x) if (debug) syslog x #else #define LCPDEBUG(x) #endif #ifdef DEBUGIPCP #define IPCPDEBUG(x) if (debug) syslog x #else #define IPCPDEBUG(x) #endif #ifdef DEBUGUPAP #define UPAPDEBUG(x) if (debug) syslog x #else #define UPAPDEBUG(x) #endif #ifdef DEBUGCHAP #define CHAPDEBUG(x) if (debug) syslog x #else #define CHAPDEBUG(x) #endif #ifdef DEBUGIPXCP #define IPXCPDEBUG(x) if (debug) syslog x #else #define IPXCPDEBUG(x) #endif #ifndef SIGTYPE #if defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) #define SIGTYPE void #else #define SIGTYPE int #endif /* defined(sun) || defined(SYSV) || defined(POSIX_SOURCE) */ #endif /* SIGTYPE */ #ifndef MIN #define MIN(a, b) ((a) < (b)? (a): (b)) #endif #ifndef MAX #define MAX(a, b) ((a) > (b)? (a): (b)) #endif #endif /* __PPP_H__ */