source: trunk/src/sh_log_evalrule.c@ 264

#include "config_xor.h"

#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <time.h>
#include <limits.h>
#include <sys/types.h>

#ifdef USE_LOGFILE_MONITOR

#undef  FIL__
#define FIL__  _("sh_log_evalrule.c")

/* Debian/Ubuntu: libpcre3-dev */
#ifdef HAVE_PCRE_PCRE_H
#include <pcre/pcre.h>
#else
#include <pcre.h>
#endif

#ifndef PCRE_NO_AUTO_CAPTURE
#define PCRE_NO_AUTO_CAPTURE 0
#endif

#include "samhain.h"
#include "sh_pthread.h"
#include "sh_utils.h"
#include "sh_string.h"
#include "sh_log_check.h"
#include "sh_log_evalrule.h"
#include "zAVLTree.h"

extern int flag_err_debug;

/* #define DEBUG_EVALRULES */

#ifdef DEBUG_EVALRULES
void DEBUG(const char *fmt, ...)
{
  va_list ap;
  va_start(ap, fmt);
  vfprintf(stderr, fmt, ap); /* flawfinder: ignore *//* we control fmt string */
  va_end(ap);
  return;
}
#else
void DEBUG(const char *fmt, ...)
{
  (void) fmt;
  return;
}
#endif

enum policies {
  EVAL_REPORT,
  EVAL_SUM
};

struct sh_ceval    /* Counter for summarizing    */
{
  sh_string   * hostname;
  sh_string   * counted_str;
  sh_string   * filename;
  unsigned long count;
  time_t        start;
  time_t        interval;
};

void sh_ceval_free(void * item)
{
  struct sh_ceval * counter = (struct sh_ceval *) item;
  if (!counter)
    return;
  sh_string_destroy(&(counter->hostname));
  sh_string_destroy(&(counter->counted_str));
  sh_string_destroy(&(counter->filename));
  SH_FREE(counter);
}

struct sh_qeval  /* Queue with definitions */
{
  sh_string       * label;
  enum policies     policy;
  int               severity;
  time_t            interval;        /* if EVAL_SUM, interval   */ 
  struct sh_qeval * next;
};

enum {
  RFL_ISRULE  = 1 << 0,
  RFL_ISGROUP = 1 << 1,
  RFL_KEEP    = 1 << 2
};

/*--------------------------------------------------------------*/

struct sh_keep
{
  sh_string       * label;           /* label of keep rule   */
  unsigned long     delay;           /* valid delay             */
  time_t            last;            /* seen at                 */
  struct sh_keep *  next; 
};

static struct sh_keep * keeplist  = NULL;
static struct sh_keep * keeplast  = NULL;
static unsigned long    keepcount = 0;

static void sh_keep_free(void * item)
{
  struct sh_keep * keep = (struct sh_keep *) item;
  if (!keep)
    return;
  sh_string_destroy(&(keep->label));
  SH_FREE(keep);
}

static void sh_keep_destroy()
{
  struct sh_keep * keep;

  while (keeplist)
    {
      keep = keeplist;
      keeplist = keep->next;
      sh_keep_free(keep);
      --keepcount;
    }
  keeplist  = NULL;
  keeplast  = NULL;
  keepcount = 0;
}

static int sh_keep_add(sh_string * label, unsigned long delay, time_t last)
{
  struct sh_keep * keep = SH_ALLOC(sizeof(struct sh_keep));

  keep->label = sh_string_copy(label);
  keep->delay = delay;
  keep->last  = last;
  keep->next  = NULL;

  if (keeplast && keeplist)
    {
      keeplast->next = keep;
      keeplast       = keep;
    }
  else
    {
      keeplist = keep;
      keeplast = keeplist;
    }
  ++keepcount;
  return 0;
}

int sh_keep_comp(const void * a, const void * b)
{
  return ( (int)(((struct sh_keep *)a)->last) - 
           (int)(((struct sh_keep *)b)->last) );
}

static sh_string * sh_keep_eval()
{
  unsigned long count   = 0;
  sh_string * res       = NULL;
  time_t now            = time(NULL);
  struct sh_keep * keep = keeplist;
  struct sh_keep * prev = keeplist;
  struct sh_keep * arr;

  if (keepcount > 0)
    {
      arr = SH_ALLOC (keepcount * sizeof(struct sh_keep));

      while (count < keepcount && keep)
        {
          if ((now > keep->last) && ((unsigned long)(now - keep->last) <= keep->delay))
            {
              memcpy(&(arr[count]), keep, sizeof(struct sh_keep));
              ++count;
              prev = keep;
              keep = keep->next;
            }
          else /* Too old or in future, delete it */
            {
              if (keep != keeplist)
                {
                  prev->next = keep->next;
                  sh_keep_free(keep);
                  keep = prev->next;
                  --keepcount;
                }
              else /* list head */
                {
                  keeplist = keep->next;
                  prev     = keeplist;
                  sh_keep_free(keep);
                  keep     = keeplist;
                  --keepcount;
                }
            }
        }

      if (count > 0)
        {
          unsigned long i;
          qsort(arr, count, sizeof(struct sh_keep), sh_keep_comp);
          res = sh_string_copy(arr[0].label);
          for (i = 1; i < count; ++i)
            res = sh_string_add(res, arr[i].label);
        }
      SH_FREE(arr);
    }
  return res;
}

struct sh_mkeep
{
  sh_string       * label;           /* label of match rule     */
  pcre            * rule;            /* compiled regex for rule */
  struct sh_qeval * queue;           /* assigned queue          */
  struct sh_mkeep * next; 
};

struct sh_mkeep * mkeep_list = NULL;

static struct sh_qeval * find_queue(const char * str);

static int sh_keep_match_add(const char * str, const char * queue, const char * pattern)
{
  unsigned int nfields = 1; /* seconds:label */
  size_t       lengths[1];
  char *       new    = sh_util_strdup(str);
  char **      splits = split_array_braced(new, _("CORRELATE"), &nfields, lengths);

  if (nfields == 1 && lengths[0] > 0)
    {
      struct sh_mkeep * mkeep = SH_ALLOC(sizeof(struct sh_mkeep));
      const char * error;
      int          erroffset;
      struct sh_qeval * rqueue = NULL;

      mkeep->rule = pcre_compile(pattern, PCRE_NO_AUTO_CAPTURE, 
                             &error, &erroffset, NULL);
      if (!(mkeep->rule))
        {
          sh_string * msg =  sh_string_new(0);
          sh_string_add_from_char(msg, _("Bad regex: "));
          sh_string_add_from_char(msg, pattern);
          
          SH_MUTEX_LOCK(mutex_thread_nolog);
          sh_error_handle(SH_ERR_ERR, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                          sh_string_str(msg),
                          _("sh_keep_match_add"));
          SH_MUTEX_UNLOCK(mutex_thread_nolog);
          sh_string_destroy(&msg);
          
          SH_FREE(splits);
          SH_FREE(mkeep);
          SH_FREE(new);
          return -1;
        }

      if (0 != strcmp(queue, _("trash")))
        {

          rqueue = find_queue(queue);
          if (!rqueue)
            {
              pcre_free(mkeep->rule);
              SH_FREE(splits);
              SH_FREE(mkeep);
              SH_FREE(new);
              return -1;
            }
        }

      mkeep->queue = rqueue;
      mkeep->label = sh_string_new_from_lchar(splits[0], strlen(splits[0]));
      mkeep->next  = mkeep_list;
      mkeep_list   = mkeep;
    }
  SH_FREE(new);
  return 0;
}

static void sh_keep_match_del()
{
  struct sh_mkeep * mkeep = mkeep_list;
  while (mkeep)
    {
      mkeep_list = mkeep->next;
      sh_string_destroy(&(mkeep->label));
      pcre_free(mkeep->rule);
      mkeep = mkeep_list;
    }
  mkeep_list = NULL;
}

static struct sh_mkeep ** dummy_mkeep;

void sh_keep_match()
{
  if (mkeep_list)
    {
      sh_string       * res = sh_keep_eval();

      if (res)
        {
          struct sh_mkeep * mkeep = mkeep_list;

          dummy_mkeep = &mkeep;

          while (mkeep)
            {
              int val = pcre_exec(mkeep->rule, NULL, 
                                  sh_string_str(res), (int)sh_string_len(res), 
                                  0, 0, NULL, 0);
              if (val >= 0)
                {
                  char * tmp;
                  SH_MUTEX_LOCK(mutex_thread_nolog);
                  tmp = sh_util_safe_name (sh_string_str(mkeep->label));
                  sh_error_handle (mkeep->queue->severity, FIL__, __LINE__, 0, 
                                   MSG_LOGMON_COR, tmp);
                  SH_FREE(tmp);
                  SH_MUTEX_UNLOCK(mutex_thread_nolog);
                }
              mkeep = mkeep->next;
            }
          sh_string_destroy(&res);
        }
    }
  return;
}

/*--------------------------------------------------------------*/

struct sh_geval  /* Group of rules (may be a single rule) */
{
  sh_string       * label;           /* label for this group    */
  pcre            * rule;            /* compiled regex for rule */
  pcre_extra      * rule_extra;
  int             * ovector;         /* captured substrings     */
  int               ovecnum;         /* how many captured       */
  int               captures;        /* (captures+1)*3 required */
  int               flags;           /* bit flags               */
  unsigned long     delay;           /* delay for keep rules    */
  zAVLTree        * counterlist;     /* counters if EVAL_SUM    */
  struct sh_qeval * queue;           /* queue for this rule     */
  struct sh_geval * nextrule;        /* next rule in this group */
  struct sh_geval * next;            /* next group of rules     */
  struct sh_geval * gnext;           /* grouplist next          */
};

struct sh_heval  /* host-specific rules */
{
  pcre            * hostname;        /* compiled regex for hostname */
  pcre_extra      * hostname_extra;
  struct sh_geval * rulegroups;      /* list of group of rules      */
  struct sh_heval * next;
};

static struct sh_heval * hostlist  = NULL;
static struct sh_qeval * queuelist = NULL;
static struct sh_geval * grouplist = NULL;

/* These flags are set if we are within 
 * the define of a host/rule group.
 */
static struct sh_heval * host_open  = NULL;
static struct sh_geval * group_open = NULL;

int sh_eval_gend (const char * str)
{
  (void) str;
  if (group_open) {
    group_open = NULL;
    return 0;
  }
  return -1;
}

int sh_eval_gadd (const char * str)
{
  struct sh_geval * ng;
  struct sh_geval * tmp;
  pcre *  group;
  pcre_extra * group_extra;
  const char * error;
  int          erroffset;
  unsigned int nfields = 2;
  size_t       lengths[2];
  char *       new = sh_util_strdup(str);
  char **      splits = split_array(new, &nfields, ':', lengths);

  if (group_open)
    group_open = NULL;

  if (nfields != 2)
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }

  group = pcre_compile(splits[1], PCRE_NO_AUTO_CAPTURE, 
                       &error, &erroffset, NULL);
  if (!group)
    {
      sh_string * msg =  sh_string_new(0);
      sh_string_add_from_char(msg, _("Bad regex: "));
      sh_string_add_from_char(msg, splits[1]);
      
      SH_MUTEX_LOCK(mutex_thread_nolog);
      sh_error_handle(SH_ERR_ERR, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                      sh_string_str(msg),
                      _("sh_eval_gadd"));
      SH_MUTEX_UNLOCK(mutex_thread_nolog);
      sh_string_destroy(&msg);
      
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }
  group_extra = NULL; /* pcre_study(group, 0, &error); */

  ng = SH_ALLOC(sizeof(struct sh_geval));
  ng->label       = sh_string_new_from_lchar(splits[0], lengths[0]);
  ng->flags       = RFL_ISGROUP;

  ng->rule        = group;
  ng->rule_extra  = group_extra;
  ng->ovector     = NULL;
  ng->ovecnum     = 0;
  ng->captures    = 0;
  ng->counterlist = NULL;
  ng->queue       = NULL;
  ng->nextrule    = NULL;
  ng->next        = NULL;
  ng->gnext       = NULL;

  if (!host_open)
    {
      if (0 != sh_eval_hadd("^.*"))
        {
          pcre_free(group);
          sh_string_destroy(&(ng->label));
          SH_FREE(splits);
          SH_FREE(new);
          SH_FREE(ng);
          return -1;
        }
    }

  /* 
   * Insert at end, to keep user-defined order 
   */ 

  if (host_open)
    {
      if (grouplist) 
        {
          tmp = grouplist; 
          while (tmp->gnext != NULL) { tmp = tmp->gnext; }
          tmp->gnext = ng;
        } else {
          grouplist = ng;
        }


      /* 
       * If there is an open host group, add it to its
       * rulegroups
       */

      if (host_open->rulegroups) 
        {
          tmp = host_open->rulegroups; 
          while (tmp->next != NULL) { tmp = tmp->next; }
          tmp->next = ng;
        } else {
          host_open->rulegroups = ng;
        }
    }

  group_open = ng;
  SH_FREE(splits);
  SH_FREE(new);
  return 0;
}

int sh_eval_hend (const char * str)
{
  (void) str;
  if (host_open) {
    host_open = NULL;
    return 0;
  }
  return -1;
}

int sh_eval_hadd (const char * str)
{
  struct sh_heval * nh;
  struct sh_heval * tmp;
  pcre *  host;
  pcre_extra * host_extra;
  const char * error;
  int          erroffset;

  if (host_open)
    host_open = NULL;

  host = pcre_compile(str, PCRE_NO_AUTO_CAPTURE, 
                      &error, &erroffset, NULL);
  if (!host)
    {
      sh_string * msg =  sh_string_new(0);
      sh_string_add_from_char(msg, _("Bad regex: "));
      sh_string_add_from_char(msg, str);
      
      SH_MUTEX_LOCK(mutex_thread_nolog);
      sh_error_handle(SH_ERR_ERR, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                      sh_string_str(msg),
                      _("sh_eval_hadd"));
      SH_MUTEX_UNLOCK(mutex_thread_nolog);
      sh_string_destroy(&msg);

      return -1;
    }
  host_extra = NULL; /* pcre_study(host, 0, &error); */

  nh = SH_ALLOC(sizeof(struct sh_heval));
  nh->hostname = host;
  nh->hostname_extra = host_extra;
  nh->rulegroups = NULL;

  /* 
   * Insert at end, to keep user-defined order 
   */ 
  nh->next = NULL;
  if (hostlist) {
    tmp = hostlist; 
    while (tmp->next != NULL) { tmp = tmp->next; }
    tmp->next = nh;
  } else {
    hostlist = nh;
  }
  host_open = nh;

  return 0;
}

int sh_eval_qadd (const char * str)
{
  struct sh_qeval * nq;
  int     severity;
  unsigned int nfields = 4; /* label:interval:(report|sum):severity */
  size_t  lengths[4];
  char *  new = sh_util_strdup(str);
  char ** splits = split_array(new, &nfields, ':', lengths);

  if (nfields != 4)
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }

  if (strcmp(splits[2], _("sum")) && strcmp(splits[2], _("report")))
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }

  if (!strcmp(splits[2], _("sum")) && atoi(splits[1]) < 0)
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }
  
  if (!strcmp(splits[1], _("trash"))) /* predefined, reserved */
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }
  
  severity = sh_error_convert_level (splits[3]);
  if (severity < 0)
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }

  nq = SH_ALLOC(sizeof(struct sh_qeval));
  nq->label = sh_string_new_from_lchar(splits[0], lengths[0]);

  DEBUG("debug: splits[2] = %s, policy = %d\n",splits[2],nq->policy); 
  if (0 == strcmp(splits[2], _("report"))) {
    nq->policy   = EVAL_REPORT;
    nq->interval = 0;
  }
  else {
    nq->policy   = EVAL_SUM;
    nq->interval = (time_t) atoi(splits[1]);
  }

  nq->severity = severity;
  nq->next     = queuelist;
  queuelist    = nq;

  SH_FREE(splits);
  SH_FREE(new);
  return 0;
}

static struct sh_qeval * find_queue(const char * str)
{
  struct sh_qeval * retval = queuelist;

  if (!str)
    return NULL;

  while (retval)
    {
      if (0 == strcmp(str, sh_string_str(retval->label)))
        break;
      retval = retval->next;
    }
  return retval;
}

char * get_keep(char * str, unsigned long * seconds)
{
  char       * res    = NULL;
  char       * endptr = NULL;

  unsigned int nfields = 2; /* seconds:label */
  size_t       lengths[2];
  char *       new    = sh_util_strdup(str);
  char **      splits = split_array_braced(new, _("KEEP"), &nfields, lengths);

  if (nfields == 2 && lengths[0] > 0 && lengths[1] > 0)
    {
      *seconds = strtoul(splits[0], &endptr, 10);
      if ((endptr == '\0' || endptr != splits[0]) && (*seconds != ULONG_MAX))
        {
          res = sh_util_strdup(splits[1]);
        }
    }
  if (splits)
    SH_FREE(splits);
  SH_FREE(new);
  return res;
}

static struct sh_qeval ** dummy_queue;
static char            ** dummy_dstr;

int sh_eval_radd (const char * str)
{
  struct sh_geval * nr;
  struct sh_geval * tmp;
  struct sh_qeval * queue = NULL;
  pcre *  rule;
  pcre_extra * rule_extra;
  const char * error;
  int          erroffset;
  int          captures = 0;
  unsigned int nfields = 2; /* queue:regex */
  size_t       lengths[2];
  char *       new    = sh_util_strdup(str);
  char **      splits = split_array(new, &nfields, ':', lengths);

  int           qpos = 0;
  volatile int  rpos = 1;
  unsigned long dsec = 0;
  char *        dstr = NULL;

  dummy_queue = &queue;
  dummy_dstr  = &dstr;

  if (nfields < 2 || nfields > 3)
    {
      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }

  if (nfields == 3)
    {
      /* KEEP(nsec):queue:regex
       */
      dstr = get_keep(splits[0], &dsec);
      if (!dstr)
        {
          /* CORRELATE:queue:regex 
           */
          int retval = sh_keep_match_add(splits[0], splits[1], splits[2]);
          SH_FREE(splits);
          SH_FREE(new);
          return retval;
        }
      ++qpos; ++rpos;
    }

  if (0 != strcmp(splits[qpos], _("trash")))
    {
      queue = find_queue(splits[qpos]);
      if (!queue)
        {
          SH_FREE(splits);
          SH_FREE(new);
          return -1;
        }
    }

  rule = pcre_compile(splits[rpos], 0, 
                      &error, &erroffset, NULL);
  if (!rule)
    {
      sh_string * msg =  sh_string_new(0);
      sh_string_add_from_char(msg, _("Bad regex: "));
      sh_string_add_from_char(msg, splits[rpos]);
      
      SH_MUTEX_LOCK(mutex_thread_nolog);
      sh_error_handle(SH_ERR_ERR, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                      sh_string_str(msg),
                      _("sh_eval_radd"));
      SH_MUTEX_UNLOCK(mutex_thread_nolog);
      sh_string_destroy(&msg);

      SH_FREE(splits);
      SH_FREE(new);
      return -1;
    }
  rule_extra = NULL; /* pcre_study(rule, 0, &error); */
  pcre_fullinfo(rule, rule_extra, PCRE_INFO_CAPTURECOUNT, &captures);

  if (flag_err_debug == SL_TRUE)
    {
      char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
      if (dstr)
        sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Adding rule: |%s| with %d captures, keep(%lu,%s)"), 
                    splits[rpos], captures, dsec, dstr);
      else
        sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Adding rule: |%s| with %d captures"), 
                    splits[rpos], captures);
      SH_MUTEX_LOCK(mutex_thread_nolog);
      sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                      emsg, _("sh_eval_radd"));
      SH_MUTEX_UNLOCK(mutex_thread_nolog);
      SH_FREE(emsg);
    }

  DEBUG("adding rule: |%s| with %d captures\n", splits[rpos], captures);

  SH_FREE(splits);
  SH_FREE(new);

  nr = SH_ALLOC(sizeof(struct sh_geval));
  nr->label       = NULL;
  nr->flags       = RFL_ISRULE;
  nr->delay       = 0;

  nr->rule        = rule;
  nr->rule_extra  = rule_extra;
  nr->captures    = captures;
  nr->ovector     = SH_ALLOC(sizeof(int) * (captures+1) * 3);
  nr->ovecnum     = 0;
  nr->counterlist = NULL;
  nr->queue       = queue;
  nr->nextrule    = NULL;
  nr->next        = NULL;
  nr->gnext       = NULL;


  if (dstr)
    {
      nr->label   = sh_string_new_from_lchar(dstr, strlen(dstr));
      nr->flags  |= RFL_KEEP;
      nr->delay   = dsec;
      SH_FREE(dstr);
    }

  /* 
   * If there is an open group, add it to its
   * rules
   */
  if (group_open)
    {
      if (flag_err_debug == SL_TRUE)
        {
          char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
          sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Adding rule to group |%s|"), 
                      sh_string_str(group_open->label));
          SH_MUTEX_LOCK(mutex_thread_nolog);
          sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                          emsg, _("sh_eval_radd"));
          SH_MUTEX_UNLOCK(mutex_thread_nolog);
          SH_FREE(emsg);
        }

      DEBUG("adding rule to group |%s|\n", sh_string_str(group_open->label));

      if (group_open->nextrule) 
        {
          tmp = group_open->nextrule; 
          while (tmp->nextrule != NULL) { tmp = tmp->nextrule; } /* next -> nextrule */
          tmp->nextrule = nr;                                    /* next -> nextrule */
        } else {
          group_open->nextrule = nr;
        }
    }

  /* 
   * ..else, add it to the currently open host (open the
   * default host, if there is no open one)
   */
  else
    {
      if (!host_open)
        {
          if (0 != sh_eval_hadd("^.*"))
            {
              if (nr->label)
                sh_string_destroy(&(nr->label));
              SH_FREE(nr->ovector);
              SH_FREE(nr);
              return -1;
            }
        }

      if (host_open)
        {
          /* 
           * Add rule as member to grouplist, to facilitate cleanup
           */

          DEBUG("adding solitary rule to grouplist\n");

          if (grouplist) 
            {
              tmp = grouplist; 
              while (tmp->gnext != NULL) { tmp = tmp->gnext; }
              tmp->gnext = nr;
            } else {
              grouplist = nr;
            }


          /* 
           * Add rule to host rulegroups
           */
          DEBUG("adding solitary rule to host rulegroups\n");

          if (host_open->rulegroups) 
            {
              /* Second, third, ... rule go to host_open->rulegroups->next,
               * since test_grules() iterates over nextrules
               */
              tmp = host_open->rulegroups; 
              while (tmp->next != NULL) { tmp = tmp->next; }
              tmp->next = nr;
            } 
          else 
            {
              /* First rule goes to host_open->rulegroups */
              host_open->rulegroups = nr;
            }
        }
      else
        {
          if (nr->label)
            sh_string_destroy(&(nr->label));
          SH_FREE(nr->ovector);
          SH_FREE(nr);
          return -1;
        }
    }

  return 0;
}

void sh_eval_cleanup()
{
  struct sh_geval * gtmp;
  struct sh_qeval * qtmp;
  struct sh_heval * htmp;

  while (grouplist)
    {
      gtmp      = grouplist;
      grouplist = gtmp->gnext;

      if (gtmp->label)      sh_string_destroy(&(gtmp->label));
      if (gtmp->rule_extra) (*pcre_free)(gtmp->rule_extra);
      if (gtmp->rule)       (*pcre_free)(gtmp->rule);
      if (gtmp->counterlist)
        zAVLFreeTree(gtmp->counterlist, sh_ceval_free);
      if (gtmp->ovector)
        SH_FREE(gtmp->ovector);
#if 0
      while (gtmp->nextrule)
        {
          tmp            = gtmp->nextrule;
          gtmp->nextrule = tmp->nextrule;

          if (tmp->rule_extra) (*pcre_free)(tmp->rule_extra);
          if (tmp->rule)       (*pcre_free)(tmp->rule);
          if (tmp->counterlist)
            zAVLFreeTree(tmp->counterlist, sh_ceval_free);
          if (tmp->ovector)
            SH_FREE(tmp->ovector);
          SH_FREE(tmp);
        }
#endif
      SH_FREE(gtmp);
    }

  qtmp = queuelist;
  while (qtmp)
    {
      if (qtmp->label)      sh_string_destroy(&(qtmp->label));
      queuelist = qtmp->next;
      SH_FREE(qtmp);
      qtmp = queuelist;
    }

  htmp = hostlist;
  while (htmp)
    {
      if (htmp->hostname_extra) (*pcre_free)(htmp->hostname_extra);
      if (htmp->hostname)       (*pcre_free)(htmp->hostname);
      hostlist = htmp->next;
      SH_FREE(htmp);
      htmp = hostlist;
    }

  sh_keep_destroy();
  sh_keep_match_del();

  return;
}

/**********************************************************************
 *
 * Actual rule processing
 *
 **********************************************************************/ 

/* Test a list of rules against msg; return matched rule, with ovector 
 * filled in
 */
static struct sh_geval ** dummy1;

static struct sh_geval * test_rule (struct sh_geval * rule, sh_string *msg, time_t tstamp)
{
  int res; 
  volatile int    count;
  volatile time_t timestamp = tstamp;

  dummy1 = &rule;

  if (!rule)
    DEBUG("debug: (NULL) rule\n");

  if (rule && sh_string_len(msg) < (size_t)INT_MAX)
    {
      count = 1;
      do {

        if (flag_err_debug == SL_TRUE)
          {
            char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
            sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Check rule %d for |%s|"), 
                        count, sh_string_str(msg));
            SH_MUTEX_LOCK(mutex_thread_nolog);
            sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                            emsg, _("test_rule"));
            SH_MUTEX_UNLOCK(mutex_thread_nolog);
            SH_FREE(emsg);
          }

        DEBUG("debug: check rule %d for <%s>\n", count, msg->str);
        res = pcre_exec(rule->rule, rule->rule_extra, 
                        sh_string_str(msg), (int)sh_string_len(msg), 0,
                        0, rule->ovector, (3*(1+rule->captures)));
        if (res >= 0)
          {
            rule->ovecnum = res;

            if (flag_err_debug == SL_TRUE)
              {
                char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
                if ( rule->flags & RFL_KEEP )
                  sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Rule %d matches, result = %d (keep)"), 
                              count, res);
                else
                  sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Rule %d matches, result = %d"), 
                              count, res);
                SH_MUTEX_LOCK(mutex_thread_nolog);
                sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                                emsg, _("test_rule"));
                SH_MUTEX_UNLOCK(mutex_thread_nolog);
                SH_FREE(emsg);
              }

            if ( rule->flags & RFL_KEEP )
              {
                DEBUG("debug: rule %d matches (keep)\n", count);
                sh_keep_add(rule->label, rule->delay, 
                            timestamp == 0 ? time(NULL) : timestamp);
              }

            break; /* return the matching rule; ovector is filled in */
          }

        if (flag_err_debug == SL_TRUE)
          {
            char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
            sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Rule %d did not match"), 
                        count);
            SH_MUTEX_LOCK(mutex_thread_nolog);
            sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                            emsg, _("test_rule"));
            SH_MUTEX_UNLOCK(mutex_thread_nolog);
            SH_FREE(emsg);
          }
        DEBUG("debug: rule %d did not match\n", count);

        rule = rule->nextrule; ++count;
      } while (rule);
    }
  if (!rule)
    DEBUG("debug: no match found\n");
  /* If there was no match, this is NULL */
  return rule;
}
  
/* Test a (struct sh_geval *), which may be single rule or a group of rules,
 * against msg
 */
static struct sh_geval ** dummy2;
static struct sh_geval ** dummy3;

static struct sh_geval * test_grules (struct sh_heval * host, 
                                      sh_string       * msg,
                                      time_t            timestamp)
{
  struct sh_geval * result = NULL;
  struct sh_geval * group  = host->rulegroups;

  dummy2 = &result;
  dummy3 = &group;

  if (group && sh_string_len(msg) < (size_t)INT_MAX)
    {
      DEBUG("debug: if group\n");
      do {
        if( (group->label != NULL) && (0 != (group->flags & RFL_ISGROUP))) 
          {
            /* this is a rule group */

            if (flag_err_debug == SL_TRUE)
              {
                char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
                sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Checking group |%s| of rules against |%s|"), 
                            sh_string_str(group->label), sh_string_str(msg));
                SH_MUTEX_LOCK(mutex_thread_nolog);
                sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                                emsg, _("test_rule"));
                SH_MUTEX_UNLOCK(mutex_thread_nolog);
                SH_FREE(emsg);
              }

            DEBUG("debug: if group->label %s\n", sh_string_str(group->label));
            if (pcre_exec(group->rule, group->rule_extra,
                          sh_string_str(msg), (int) sh_string_len(msg),
                          0, 0, NULL, 0) >= 0)
              {
                result = test_rule(group->nextrule, msg, timestamp);
                if (result)
                  break;
              }
          }
        else
          {
            /* If there is no group label, the 'group' is actually a solitary 
             * rule (not within any group).
             */

            if (flag_err_debug == SL_TRUE)
              {
                char * emsg = SH_ALLOC(SH_ERRBUF_SIZE);
                sl_snprintf(emsg,  SH_ERRBUF_SIZE, _("Checking solitary rules"));
                SH_MUTEX_LOCK(mutex_thread_nolog);
                sh_error_handle(SH_ERR_ALL, FIL__, __LINE__, 0, MSG_E_SUBGEN,
                                emsg, _("test_rule"));
                SH_MUTEX_UNLOCK(mutex_thread_nolog);
                SH_FREE(emsg);
              }

            DEBUG("debug: else (single rule)\n");
            result = test_rule(group, msg, timestamp);
            if (result)
              break;
          }
        group = group->next; /* next group of rules */
      } while (group);
    }
  return result;
}

/* Top-level find_rule() function
 */
static struct sh_geval * find_rule (sh_string *host, 
                                    sh_string *msg,
                                    time_t     timestamp)
{
  struct sh_geval * result = NULL;
  struct sh_heval * hlist  = hostlist;

  if (hlist && sh_string_len(host) < (size_t)INT_MAX)
    {
      do {
        if (pcre_exec(hlist->hostname, hlist->hostname_extra, 
                      sh_string_str(host), (int) sh_string_len(host), 
                      0, 0, NULL, 0) >= 0)
          {
            /* matching host, check rules/groups of rules */
            result = test_grules(hlist, msg, timestamp);
            if (result)
              break;
          }
        hlist = hlist->next;
      } while (hlist);
    }
  return result;
}

/* copy the message and replace captured substrings with '___'
 */
static sh_string * replace_captures(const sh_string * message, 
                                    int * ovector, int ovecnum)
{
  sh_string * retval = sh_string_new_from_lchar(sh_string_str(message), 
                                                sh_string_len(message));

  if (ovecnum > 1)
    {
      retval = sh_string_replace(retval, &(ovector[2]), (ovecnum-1), "___", 3);
    }
  return retval;
}

static void msg_report(int severity, struct sh_geval * rule, struct sh_logrecord * record)
{
  char      * tmp;
  char      * msg;
  sh_string * mmm = NULL;
  char      * ttt;


  SH_MUTEX_LOCK(mutex_thread_nolog);
  if (rule) {
    mmm = replace_captures(record->message, rule->ovector, 
                           rule->ovecnum);
    msg = sh_util_safe_name_keepspace (sh_string_str(mmm));
  }
  else {
    msg = sh_util_safe_name_keepspace (sh_string_str(record->message));
  }
  tmp = sh_util_safe_name (record->filename);
  ttt = sh_util_safe_name_keepspace (sh_string_str(record->timestr));
  sh_error_handle (severity, FIL__, __LINE__, 0, MSG_LOGMON_REP,
                   msg,
                   ttt,
                   sh_string_str(record->host),
                   tmp);
  SH_FREE(ttt);
  SH_FREE(msg);
  SH_FREE(tmp);
  if (mmm)
    sh_string_destroy(&mmm);
  SH_MUTEX_UNLOCK(mutex_thread_nolog);
}

static void sum_report(int severity, sh_string * host, sh_string * message, sh_string * path)
{
  char * tmp;
  char * msg;

  SH_MUTEX_LOCK(mutex_thread_nolog);
  tmp = sh_util_safe_name (sh_string_str(path));
  msg = sh_util_safe_name_keepspace (sh_string_str(message));
  sh_error_handle (severity, FIL__, __LINE__, 0, MSG_LOGMON_SUM,
                   msg,
                   sh_string_str(host), 
                   tmp);
  SH_FREE(msg);
  SH_FREE(tmp);
  SH_MUTEX_UNLOCK(mutex_thread_nolog);
}

static zAVLKey sh_eval_getkey(void const *item)
{
  return ((struct sh_ceval *)item)->hostname->str;
}

/* Find the counter, or initialize one if there is none already
 */
static struct sh_ceval * find_counter(struct sh_geval * rule, 
                                      sh_string * host, time_t interval)
{
  struct sh_ceval * counter;

  if (!(rule->counterlist))
    {
      DEBUG("debug: allocate new counterlist AVL tree\n");
      rule->counterlist = zAVLAllocTree(sh_eval_getkey);
    }

  counter = (struct sh_ceval *) zAVLSearch (rule->counterlist, 
                                            sh_string_str(host));

  if (!counter)
    {
      DEBUG("debug: no counter found\n");

      counter = SH_ALLOC(sizeof(struct sh_ceval));
      counter->hostname    = sh_string_new_from_lchar(sh_string_str(host), 
                                                      sh_string_len(host));
      counter->counted_str = NULL;
      counter->filename    = NULL;
      counter->count       = 0;
      counter->start       = time(NULL);
      counter->interval    = interval;

      zAVLInsert(rule->counterlist, counter);
    }
  return counter;
                       
}


/* process the counter for a SUM rule
 */
static int  process_counter(struct sh_ceval * counter, 
                            struct sh_geval * rule,  struct sh_logrecord * record)
{
  int retval = -1;
  time_t  now;

  if (!(counter->counted_str))
    {
      counter->counted_str = replace_captures(record->message, rule->ovector, 
                                              rule->ovecnum);
      counter->filename    = sh_string_new_from_lchar(record->filename,
                                                      strlen(record->filename));
      DEBUG("debug: counted_str after replace: %s\n", 
            sh_string_str(counter->counted_str)); 
    }

  ++(counter->count);
  now = time(NULL); now -= counter->start;
  DEBUG("debug: count %lu, interval %lu, time %lu\n", 
        counter->count, counter->interval, now);
  if (now >= counter->interval)
    {
      DEBUG("debug: report count\n");
      sum_report(rule->queue->severity, counter->hostname, 
                 counter->counted_str, counter->filename);
      counter->start = time(NULL);
      counter->count = 0;
    }
  return retval;
}

/* Process a rule
 */
static int  process_rule(struct sh_geval * rule, struct sh_logrecord * record)
{
  int retval = -1;
  struct sh_qeval * queue = rule->queue;

  if (queue)
    {
      DEBUG("debug: queue policy = %d found\n", queue->policy);
      if (queue->policy == EVAL_REPORT)
        {
          DEBUG("debug: EVAL_REPORT host: %s, message: %s\n",
                 sh_string_str(record->host), 
                 sh_string_str(record->message));
          msg_report(queue->severity, rule, record);
          retval = 0;
        }
      else if (queue->policy == EVAL_SUM)
        {
          
          struct sh_ceval * counter = 
            find_counter(rule, record->host, queue->interval);
          DEBUG("debug: EVAL_SUM host: %s, message: %s\n",
                 sh_string_str(record->host),
                 sh_string_str(record->message));
          if (counter)
            {
              DEBUG("debug: counter found\n");
              retval = process_counter(counter, rule, record);
            }
        }
    }
  else
    {
      DEBUG("debug: no queue found -- trash\n");
      /* No queue means 'trash' */
      retval = 0;
    }
  return retval;
}

#define DEFAULT_SEVERITY (-1)

int sh_eval_process_msg(struct sh_logrecord * record)
{
  static unsigned long i = 0;
  if (record)
    {
      struct sh_geval * rule = find_rule (record->host,
                                          record->message,
                                          record->timestamp);

      if (rule)
        {
          DEBUG("debug: (%lu) rule found\n", i); ++i;
          return process_rule(rule, record);
        }
      else
        {
          DEBUG("debug: (%lu) no rule found\n", i); ++i;
          msg_report(DEFAULT_SEVERITY, NULL, record);
        }
      return 0;
    }
  return -1;
}

#endif