chiark / gitweb /
server/servutil.c: Add utilities for simple leaky-bucket rate limiting.
[tripe] / server / servutil.c
index 77cfd2c6c7fceba19c55c14ef60b380985be9409..72de38a2f9d47ece2d6110f92db1b1c39c9c7ccd 100644 (file)
@@ -1,29 +1,26 @@
 /* -*-c-*-
- *
- * $Id$
  *
  * Various handy server-only utilities
  *
  * (c) 2001 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Trivial IP Encryption (TrIPE).
  *
- * TrIPE is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- * 
- * TrIPE is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
+ * TrIPE is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your
+ * option) any later version.
+ *
+ * TrIPE is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * for more details.
+ *
  * You should have received a copy of the GNU General Public License
- * along with TrIPE; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * along with TrIPE.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 /*----- Header files ------------------------------------------------------*/
 
 /*----- Global variables --------------------------------------------------*/
 
-octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ];
-
-/*----- Main code ---------------------------------------------------------*/
-
-/* --- @mpstr@ --- *
- *
- * Arguments:  @mp *m@ = a multiprecision integer
- *
- * Returns:    A pointer to the integer's textual representation.
- *
- * Use:                Converts a multiprecision integer to a string.  Corrupts
- *             @buf_t@.
- */
-
-const char *mpstr(mp *m)
-{
-  if (mp_writestring(m, (char *)buf_t, sizeof(buf_t), 10))
-    return ("<failed>");
-  return ((const char *)buf_t);
-}
-
-/* --- @gestr@ --- *
- *
- * Arguments:  @group *g@ = a group
- *             @ge *x@ = a group element
- *
- * Returns:    A pointer to the element's textual representation.
- *
- * Use:                Converts a group element to a string.  Corrupts
- *             @buf_t@.
- */
-
-const char *gestr(group *g, ge *x)
-{
-  if (group_writestring(g, x, (char *)buf_t, sizeof(buf_t)))
-    return ("<failed>");
-  return ((const char *)buf_t);
-}
-
-/* --- @timestr@ --- *
- *
- * Arguments:  @time_t t@ = a time to convert
- *
- * Returns:    A pointer to a textual representation of the time.
- *
- * Use:                Converts a time to a textual representation.  Corrupts
- *             @buf_t@.
- */
+octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
 
-const char *timestr(time_t t)
-{
-  struct tm *tm;
-  if (!t)
-    return ("NEVER");
-  tm = localtime(&t);
-  strftime((char *)buf_t, sizeof(buf_t), "%Y-%m-%dT%H:%M:%S", tm);
-  return ((const char *)buf_t);
-}
+/*----- Sequence numbers --------------------------------------------------*/
 
 /* --- @seq_reset@ --- *
  *
@@ -140,157 +82,107 @@ int seq_check(seqwin *s, uint32 q, const char *service)
   return (0);
 }
 
-/* --- @versioncmp@ --- *
- *
- * Arguments:  @const char *va, *vb@ = two version strings
+/*----- Rate limiting -----------------------------------------------------*/
+
+/* --- @ratelim_init@ --- *
  *
- * Returns:    Less than, equal to, or greater than zero, according to
- *             whether @va@ is less than, equal to, or greater than @vb@.
+ * Arguments:  @ratelim *r@ = rate-limiting state to fill in
+ *             @unsigned persec@ = credit to accumulate per second
+ *             @unsigned max@ = maximum credit to retain
  *
- * Use:                Compares version number strings.
+ * Returns:    ---
  *
- *             The algorithm is an extension of the Debian version
- *             comparison algorithm.  A version number consists of three
- *             components:
+ * Use:                Initialize a rate-limiting state.
+ */
+
+void ratelim_init(ratelim *r, unsigned persec, unsigned max)
+{
+  r->n = r->max = max;
+  r->persec = persec;
+  gettimeofday(&r->when, 0);
+}
+
+/* --- @ratelim_withdraw@ --- *
  *
- *               [EPOCH :] MAIN [- SUB]
+ * Arguments:  @ratelim *r@ = rate-limiting state
+ *             @unsigned n@ = credit to withdraw
  *
- *             The MAIN part may contain colons or hyphens if there is an
- *             EPOCH or SUB, respectively.  Version strings are compared
- *             componentwise: first epochs, then main parts, and finally
- *             subparts.
+ * Returns:    Zero if successful; @-1@ if there is unsufficient credit
  *
- *             The component comparison is done as follows.  First, the
- *             initial subsequence of nondigit characters is extracted from
- *             each string, and these are compared lexicographically, using
- *             ASCII ordering, except that letters precede non-letters.  If
- *             both are the same, an initial sequence of digits is extracted
- *             from the remaining parts of the version strings, and these
- *             are compared numerically (an empty sequence being considered
- *             to have the value zero).  This process is repeated until we
- *             have a winner or until both strings are exhausted.
+ * Use:                Updates the state with any accumulated credit.  Then, if
+ *             there there are more than @n@ credits available, withdraw @n@
+ *             and return successfully; otherwise, report failure.
  */
 
-struct vinfo {
-  const char *e, *el;
-  const char *m, *ml;
-  const char *s, *sl;
-};
-
-static int vint(const char **vv, const char *vl)
+int ratelim_withdraw(ratelim *r, unsigned n)
 {
-  int n = 0;
-  const char *v = *vv;
-  int ch;
-
-  while (v < vl) {
-    ch = *v;
-    if (!isdigit((unsigned char)ch))
-      break;
-    v++;
-    n = n * 10 + (ch - '0');
-  }
-  *vv = v;
-  return (n);
+  struct timeval now, delta;
+  unsigned long d;
+
+  gettimeofday(&now, 0);
+  TV_SUB(&delta, &now, &r->when);
+  d = (unsigned long)r->persec*delta.tv_sec +
+    (unsigned long)r->persec*delta.tv_usec/MILLION;
+  if (d < r->max - r->n) r->n += d;
+  else r->n = r->max;
+  r->when = now;
+
+  if (n > r->n) return (-1);
+  else { r->n -= n; return (0); }
 }
 
-static const char *vchr(const char **vv, const char *vl)
-{
-  const char *v = *vv;
-  const char *b = v;
-  int ch;
+/*----- Random odds and sods ----------------------------------------------*/
 
-  while (v < vl) {
-    ch = *v;
-    if (isdigit((unsigned char)ch))
-      break;
-    v++;
-  }
-  *vv = v;
-  return (b);
+/* --- @timestr@ --- *
+ *
+ * Arguments:  @time_t t@ = a time to convert
+ *
+ * Returns:    A pointer to a textual representation of the time.
+ *
+ * Use:                Converts a time to a textual representation.  Corrupts
+ *             @buf_u@.
+ */
+
+const char *timestr(time_t t)
+{
+  struct tm *tm;
+  if (!t)
+    return ("NEVER");
+  tm = localtime(&t);
+  strftime((char *)buf_u, sizeof(buf_u), "%Y-%m-%dT%H:%M:%S", tm);
+  return ((const char *)buf_u);
 }
 
-#define CMP(x, y) ((x) < (y) ? -1 : +1)
+/* --- @mystrieq@ --- *
+ *
+ * Arguments:  @const char *x, *y@ = two strings
+ *
+ * Returns:    True if @x@ and @y are equal, up to case.
+ */
 
-static int vcmp(const char *va, const char *val,
-               const char *vb, const char *vbl)
+int mystrieq(const char *x, const char *y)
 {
-  const char *pa, *pb;
-  int ia, ib;
-
   for (;;) {
-
-    /* --- See if we're done --- */
-
-    if (va == val && vb == vbl)
+    if (!*x && !*y) return (1);
+    if (tolower((unsigned char)*x) != tolower((unsigned char)*y))
       return (0);
-
-    /* --- Compare nondigit portions --- */
-
-    pa = vchr(&va, val); pb = vchr(&vb, vbl);
-    for (;;) {
-      if (pa == va && pb == vb)
-       break;
-      else if (pa == va)
-       return (-1);
-      else if (pb == vb)
-       return (+1);
-      else if (*pa == *pb) {
-       pa++; pb++;
-       continue;
-      } else if (isalpha((unsigned char)*pa) == isalpha((unsigned char)*pb))
-       return (CMP(*pa, *pb));
-      else if (isalpha((unsigned char)*pa))
-       return (-1);
-      else
-       return (+1);
-    }
-
-    /* --- Compare digit portions --- */
-
-    ia = vint(&va, val); ib = vint(&vb, vbl);
-    if (ia != ib)
-      return (CMP(ia, ib));
+    x++; y++;
   }
 }
 
-static void vsplit(const char *v, struct vinfo *vi)
-{
-  const char *p;
-  size_t n;
-
-  if ((p = strchr(v, ':')) == 0)
-    vi->e = vi->el = 0;
-  else {
-    vi->e = v;
-    vi->el = p;
-    v = p + 1;
-  }
-
-  n = strlen(v);
-  if ((p = strrchr(v, '-')) == 0)
-    vi->s = vi->sl = 0;
-  else {    
-    vi->s = p + 1;
-    vi->sl = v + n;
-    n = p - v;
-  }
-
-  vi->m = v;
-  vi->ml = v + n;
-}
+/* --- @addrsz@ --- *
+ *
+ * Arguments:  @const addr *a@ = a network address
+ *
+ * Returns:    The size of the address, for passing into the sockets API.
+ */
 
-int versioncmp(const char *va, const char *vb)
+socklen_t addrsz(const addr *a)
 {
-  struct vinfo via, vib;
-  int rc;
-
-  vsplit(va, &via); vsplit(vb, &vib);
-  if ((rc = vcmp(via.e, via.el, vib.e, vib.el)) != 0 ||
-      (rc = vcmp(via.m, via.ml, vib.m, vib.ml)) != 0 ||
-      (rc = vcmp(via.s, via.sl, vib.s, vib.sl)) != 0)
-    return (rc);
-  return (0);
+  switch (a->sa.sa_family) {
+    case AF_INET: return (sizeof(a->sin));
+    default: abort();
+  }
 }
 
 /*----- That's all, folks -------------------------------------------------*/