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