pppd.h 35 KB

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