usr.sbin/ppp/bundle.h

   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  * $FreeBSD$
  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     0x0001
  37 #define OPT_IFACEALIAS  0x0002
  38 #define OPT_KEEPSESSION 0x0004
  39 #define OPT_LOOPBACK    0x0008
  40 #define OPT_PASSWDAUTH  0x0010
  41 #define OPT_PROXY       0x0020
  42 #define OPT_PROXYALL    0x0040
  43 #define OPT_SROUTES     0x0080
  44 #define OPT_THROUGHPUT  0x0100
  45 #define OPT_UTMP        0x0200
  46
  47 #define MAX_ENDDISC_CLASS 5
  48
  49 #define Enabled(b, o) ((b)->cfg.opt & (o))
  50
  51 /* AutoAdjust() values */
  52 #define AUTO_UP         1
  53 #define AUTO_DOWN       2
  54
  55 struct sockaddr_un;
  56 struct datalink;
  57 struct physical;
  58 struct link;
  59 struct server;
  60 struct prompt;
  61 struct iface;
  62
  63 struct bundle {
  64   struct descriptor desc;     /* really all our datalinks */
  65   int unit;                   /* The device/interface unit number */
  66
  67   struct {
  68     char Name[20];            /* The /dev/XXXX name */
  69     int fd;                   /* The /dev/XXXX descriptor */
  70     unsigned header : 1;      /* Family header sent & received ? */
  71   } dev;
  72
  73   u_long bandwidth;           /* struct tuninfo speed */
  74   struct iface *iface;        /* Interface information */
  75
  76   int routing_seq;            /* The current routing sequence number */
  77   u_int phase;                /* Curent phase */
  78
  79   struct {
  80     int all;                  /* Union of all physical::type's */
  81     int open;                 /* Union of all open physical::type's */
  82   } phys_type;
  83
  84   unsigned CleaningUp : 1;    /* Going to exit.... */
  85   unsigned NatEnabled : 1;    /* Are we using libalias ? */
  86
  87   struct fsm_parent fsm;      /* Our callback functions */
  88   struct datalink *links;     /* Our data links */
  89
  90   time_t upat;                /* When the link came up */
  91
  92   struct {
  93     struct {
  94       int timeout;              /* NCP Idle timeout value */
  95       int min_timeout;          /* Don't idle out before this */
  96     } idle;
  97     struct {
  98       char name[AUTHLEN];     /* PAP/CHAP system name */
  99       char key[AUTHLEN];      /* PAP/CHAP key */
 100     } auth;
 101     unsigned opt;             /* Uses OPT_ bits from above */
 102     char label[50];           /* last thing `load'ed */
 103     u_short mtu;              /* Interface mtu */
 104
 105     struct {
 106       int timeout;            /* How long to leave the output queue choked */
 107     } choked;
 108   } cfg;
 109
 110   struct {
 111     struct ipcp ipcp;         /* Our IPCP FSM */
 112     struct mp mp;             /* Our MP */
 113   } ncp;
 114
 115   struct {
 116     struct filter in;         /* incoming packet filter */
 117     struct filter out;        /* outgoing packet filter */
 118     struct filter dial;       /* dial-out packet filter */
 119     struct filter alive;      /* keep-alive packet filter */
 120   } filter;
 121
 122   struct {
 123     struct pppTimer timer;    /* timeout after cfg.idle_timeout */
 124     time_t done;
 125   } idle;
 126
 127   struct {
 128     int fd;                   /* write status here */
 129   } notify;
 130
 131   struct {
 132     struct pppTimer timer;    /* choked output queue timer */
 133   } choked;
 134
 135 #ifndef NORADIUS
 136   struct radius radius;       /* Info retrieved from radius server */
 137 #endif
 138 };
 139
 140 #define descriptor2bundle(d) \
 141   ((d)->type == BUNDLE_DESCRIPTOR ? (struct bundle *)(d) : NULL)
 142
 143 extern struct bundle *bundle_Create(const char *, int, int);
 144 extern void bundle_Destroy(struct bundle *);
 145 extern const char *bundle_PhaseName(struct bundle *);
 146 #define bundle_Phase(b) ((b)->phase)
 147 extern void bundle_NewPhase(struct bundle *, u_int);
 148 extern void bundle_LinksRemoved(struct bundle *);
 149 extern int  bundle_LinkIsUp(const struct bundle *);
 150 extern int bundle_SetRoute(struct bundle *, int, struct in_addr,
 151                            struct in_addr, struct in_addr, int, int);
 152 extern void bundle_Close(struct bundle *, const char *, int);
 153 extern void bundle_Down(struct bundle *, int);
 154 extern void bundle_Open(struct bundle *, const char *, int, int);
 155 extern void bundle_LinkClosed(struct bundle *, struct datalink *);
 156
 157 extern int bundle_ShowLinks(struct cmdargs const *);
 158 extern int bundle_ShowStatus(struct cmdargs const *);
 159 extern void bundle_StartIdleTimer(struct bundle *);
 160 extern void bundle_SetIdleTimer(struct bundle *, int, int);
 161 extern void bundle_StopIdleTimer(struct bundle *);
 162 extern int bundle_IsDead(struct bundle *);
 163 extern struct datalink *bundle2datalink(struct bundle *, const char *);
 164
 165 extern void bundle_RegisterDescriptor(struct bundle *, struct descriptor *);
 166 extern void bundle_UnRegisterDescriptor(struct bundle *, struct descriptor *);
 167
 168 extern void bundle_SetTtyCommandMode(struct bundle *, struct datalink *);
 169
 170 extern int bundle_DatalinkClone(struct bundle *, struct datalink *,
 171                                 const char *);
 172 extern void bundle_DatalinkRemove(struct bundle *, struct datalink *);
 173 extern void bundle_CleanDatalinks(struct bundle *);
 174 extern void bundle_SetLabel(struct bundle *, const char *);
 175 extern const char *bundle_GetLabel(struct bundle *);
 176 extern void bundle_SendDatalink(struct datalink *, int, struct sockaddr_un *);
 177 extern int bundle_LinkSize(void);
 178 extern void bundle_ReceiveDatalink(struct bundle *, int);
 179 extern int bundle_SetMode(struct bundle *, struct datalink *, int);
 180 extern int bundle_RenameDatalink(struct bundle *, struct datalink *,
 181                                  const char *);
 182 extern void bundle_setsid(struct bundle *, int);
 183 extern void bundle_LockTun(struct bundle *);
 184 extern int bundle_HighestState(struct bundle *);
 185 extern int bundle_Exception(struct bundle *, int);
 186 extern void bundle_AdjustFilters(struct bundle *, struct in_addr *,
 187                                  struct in_addr *);
 188 extern void bundle_CalculateBandwidth(struct bundle *);
 189 extern void bundle_AutoAdjust(struct bundle *, int, int);
 190 extern int bundle_WantAutoloadTimer(struct bundle *);
 191 extern void bundle_ChangedPID(struct bundle *);