1 /*- 2 * Copyright (c) 1998 Brian Somers <brian@Awfulhak.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $Id: bundle.h,v 1.10 1998/07/28 21:54:51 brian Exp $ 27 */ 28 29 #define PHASE_DEAD 0 /* Link is dead */ 30 #define PHASE_ESTABLISH 1 /* Establishing link */ 31 #define PHASE_AUTHENTICATE 2 /* Being authenticated */ 32 #define PHASE_NETWORK 3 /* We're alive ! */ 33 #define PHASE_TERMINATE 4 /* Terminating link */ 34 35 /* cfg.opt bit settings */ 36 #define OPT_IDCHECK 0x01 37 #define OPT_LOOPBACK 0x02 38 #define OPT_PASSWDAUTH 0x04 39 #define OPT_PROXY 0x08 40 #define OPT_SROUTES 0x10 41 #define OPT_THROUGHPUT 0x20 42 #define OPT_UTMP 0x40 43 44 #define MAX_ENDDISC_CLASS 5 45 46 #define Enabled(b, o) ((b)->cfg.opt & (o)) 47 48 struct sockaddr_un; 49 struct datalink; 50 struct physical; 51 struct link; 52 struct server; 53 struct prompt; 54 55 struct bundle { 56 struct descriptor desc; /* really all our datalinks */ 57 int unit; /* The device/interface unit number */ 58 const char **argv; /* From main() */ 59 60 struct { 61 char Name[20]; /* The /dev/XXXX name */ 62 int fd; /* The /dev/XXXX descriptor */ 63 } dev; 64 65 struct { 66 u_long Speed; /* struct tuninfo speed */ 67 int Index; /* The interface index */ 68 char *Name; /* The interface name */ 69 } ifp; 70 71 int routing_seq; /* The current routing sequence number */ 72 u_int phase; /* Curent phase */ 73 74 struct { 75 int all; /* Union of all physical::type's */ 76 int open; /* Union of all open physical::type's */ 77 } phys_type; 78 79 unsigned CleaningUp : 1; /* Going to exit.... */ 80 unsigned AliasEnabled : 1; /* Are we using libalias ? */ 81 82 struct fsm_parent fsm; /* Our callback functions */ 83 struct datalink *links; /* Our data links */ 84 85 struct { 86 int idle_timeout; /* NCP Idle timeout value */ 87 struct { 88 char name[50]; /* PAP/CHAP system name */ 89 char key[50]; /* PAP/CHAP key */ 90 } auth; 91 unsigned opt; /* Uses OPT_ bits from above */ 92 char label[50]; /* last thing `load'ed */ 93 u_short mtu; /* Interface mtu */ 94 95 struct { /* We need/don't need another link when */ 96 struct { /* more/less than */ 97 int packets; /* this number of packets are queued for */ 98 int timeout; /* this number of seconds */ 99 } max, min; 100 } autoload; 101 } cfg; 102 103 struct { 104 struct ipcp ipcp; /* Our IPCP FSM */ 105 struct mp mp; /* Our MP */ 106 } ncp; 107 108 struct { 109 struct filter in; /* incoming packet filter */ 110 struct filter out; /* outgoing packet filter */ 111 struct filter dial; /* dial-out packet filter */ 112 struct filter alive; /* keep-alive packet filter */ 113 } filter; 114 115 struct { 116 struct pppTimer timer; /* timeout after cfg.idle_timeout */ 117 time_t done; 118 } idle; 119 120 struct { 121 int fd; /* write status here */ 122 } notify; 123 124 struct { 125 struct pppTimer timer; 126 time_t done; 127 unsigned running : 1; 128 unsigned comingup : 1; 129 } autoload; 130 }; 131 132 #define descriptor2bundle(d) \ 133 ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL) 134 135 extern struct bundle *bundle_Create(const char *, int, const char **); 136 extern void bundle_Destroy(struct bundle *); 137 extern const char *bundle_PhaseName(struct bundle *); 138 #define bundle_Phase(b) ((b)->phase) 139 extern void bundle_NewPhase(struct bundle *, u_int); 140 extern int bundle_LinkIsUp(const struct bundle *); 141 extern int bundle_SetRoute(struct bundle *, int, struct in_addr, 142 struct in_addr, struct in_addr, int, int); 143 extern void bundle_Close(struct bundle *, const char *, int); 144 extern void bundle_Down(struct bundle *, int); 145 extern void bundle_Open(struct bundle *, const char *, int, int); 146 extern void bundle_LinkClosed(struct bundle *, struct datalink *); 147 148 extern int bundle_FillQueues(struct bundle *); 149 extern int bundle_ShowLinks(struct cmdargs const *); 150 extern int bundle_ShowStatus(struct cmdargs const *); 151 extern void bundle_StartIdleTimer(struct bundle *); 152 extern void bundle_SetIdleTimer(struct bundle *, int); 153 extern void bundle_StopIdleTimer(struct bundle *); 154 extern int bundle_IsDead(struct bundle *); 155 extern struct datalink *bundle2datalink(struct bundle *, const char *); 156 157 extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *); 158 extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *); 159 160 extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *); 161 162 extern int bundle_DatalinkClone(struct bundle *, struct datalink *, 163 const char *); 164 extern void bundle_DatalinkRemove(struct bundle *, struct datalink *); 165 extern void bundle_CleanDatalinks(struct bundle *); 166 extern void bundle_SetLabel(struct bundle *, const char *); 167 extern const char *bundle_GetLabel(struct bundle *); 168 extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *); 169 extern void bundle_ReceiveDatalink(struct bundle *, int, struct sockaddr_un *); 170 extern int bundle_SetMode(struct bundle *, struct datalink *, int); 171 extern int bundle_RenameDatalink(struct bundle *, struct datalink *, 172 const char *); 173 extern void bundle_setsid(struct bundle *, int); 174 extern void bundle_LockTun(struct bundle *); 175