corsaro_plugin.h

Go to the documentation of this file.

/* 
 * corsaro
 *
 * Alistair King, CAIDA, UC San Diego
 * corsaro-info@caida.org
 * 
 * Copyright (C) 2012 The Regents of the University of California.
 * 
 * This file is part of corsaro.
 *
 * corsaro 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.
 *
 * corsaro 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 corsaro.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __CORSARO_PLUGIN_H
#define __CORSARO_PLUGIN_H

#include "corsaro_int.h"

#define CORSARO_PLUGIN_GENERATE_PROTOS(plugin)                          \
  corsaro_plugin_t * plugin##_alloc();                                  \
  int plugin##_probe_filename(const char *fname);                       \
  int plugin##_probe_magic(struct corsaro_in * corsaro, corsaro_file_in_t *file); \
  int plugin##_init_input(struct corsaro_in *corsaro);                  \
  int plugin##_init_output(struct corsaro *corsaro);                    \
  int plugin##_close_input(struct corsaro_in *corsaro);                 \
  int plugin##_close_output(struct corsaro *corsaro);                   \
  off_t plugin##_read_record(struct corsaro_in *corsaro,                        \
                           enum corsaro_in_record_type *record_type,    \
                           struct corsaro_in_record *record);           \
  off_t plugin##_read_global_data_record(struct corsaro_in *corsaro,    \
                           enum corsaro_in_record_type *record_type,    \
                           struct corsaro_in_record *record);           \
  int plugin##_start_interval(struct corsaro *corsaro,                  \
                              struct corsaro_interval *int_start);      \
  int plugin##_end_interval(struct corsaro *corsaro,                    \
                            struct corsaro_interval *int_end);          \
  int plugin##_process_packet(struct corsaro *corsaro,                  \
                              struct corsaro_packet *packet);

#ifdef WITH_PLUGIN_SIXT
#define CORSARO_PLUGIN_GENERATE_FT_PROTO(plugin)                        \
  int plugin##_process_flowtuple(struct corsaro *corsaro,               \
                                 corsaro_flowtuple_t *flowtuple,        \
                                 struct corsaro_packet_state *state);   \
  int plugin##_process_flowtuple_class_start(struct corsaro *corsaro,   \
                                             corsaro_flowtuple_class_start_t *class); \
  int plugin##_process_flowtuple_class_end(struct corsaro *corsaro,     \
                                           corsaro_flowtuple_class_end_t *class);
#endif

#ifdef WITH_PLUGIN_SIXT
#define CORSARO_PLUGIN_GENERATE_PTRS(plugin)            \
  plugin##_probe_filename,                              \
    plugin##_probe_magic,                               \
    plugin##_init_input,                                \
    plugin##_init_output,                               \
    plugin##_close_input,                               \
    plugin##_close_output,                              \
    plugin##_read_record,                               \
    plugin##_read_global_data_record,                   \
    plugin##_start_interval,                            \
    plugin##_end_interval,                              \
    plugin##_process_packet,                            \
    NULL,                                               \
    NULL,                                               \
    NULL

#define CORSARO_PLUGIN_GENERATE_PTRS_FT(plugin) \
  plugin##_probe_filename,                              \
    plugin##_probe_magic,                               \
    plugin##_init_input,                                \
    plugin##_init_output,                               \
    plugin##_close_input,                               \
    plugin##_close_output,                              \
    plugin##_read_record,                               \
    plugin##_read_global_data_record,                   \
    plugin##_start_interval,                            \
    plugin##_end_interval,                              \
    plugin##_process_packet,                            \
    plugin##_process_flowtuple,                         \
    plugin##_process_flowtuple_class_start,             \
    plugin##_process_flowtuple_class_end
#else
#define CORSARO_PLUGIN_GENERATE_PTRS(plugin)            \
  plugin##_probe_filename,                              \
    plugin##_probe_magic,                               \
    plugin##_init_input,                                \
    plugin##_init_output,                               \
    plugin##_close_input,                               \
    plugin##_close_output,                              \
    plugin##_read_record,                               \
    plugin##_read_global_data_record,                   \
    plugin##_start_interval,                            \
    plugin##_end_interval,                              \
    plugin##_process_packet                             
#endif

#define CORSARO_PLUGIN_GENERATE_TAIL            \
  NULL,                         /* next */      \
    0,                          /* argc */      \
    NULL                        /* argv */

#define CORSARO_PLUGIN_STATE(corsaro, type, id)                 \
  ((struct corsaro_##type##_state_t*)                           \
   ((corsaro)->plugin_manager->plugins_state[(id)-1]))

#define CORSARO_PLUGIN_PLUGIN(corsaro, id)                                              \
  ((corsaro)->plugin_manager->plugins[(id)-1])

typedef enum corsaro_plugin_id
{
  CORSARO_PLUGIN_ID_PCAP             = 1,
  
  CORSARO_PLUGIN_ID_ANON             = 2,

  CORSARO_PLUGIN_ID_PFX2AS           = 3,

  CORSARO_PLUGIN_ID_FILTERGEO        = 6,

  CORSARO_PLUGIN_ID_FILTERPFX        = 7,

  CORSARO_PLUGIN_ID_GEODB            = 9,

  CORSARO_PLUGIN_ID_FLOWTUPLE        = 20,

  CORSARO_PLUGIN_ID_DOS              = 30,

  CORSARO_PLUGIN_ID_SMEE             = 80,

  CORSARO_PLUGIN_ID_MAX              = CORSARO_PLUGIN_ID_SMEE
} corsaro_plugin_id_t;

/* All functions should return -1, or NULL on failure */
typedef struct corsaro_plugin
{
  const char *name;

#if 0

  /*const char *version;*/
#endif

  const corsaro_plugin_id_t id;

  const uint32_t magic;

  int (*probe_filename)(const char *fname);
  
  int (*probe_magic)(struct corsaro_in *corsaro, corsaro_file_in_t *file);
  
  int (*init_input)(struct corsaro_in *corsaro);

  int (*init_output)(struct corsaro *corsaro);

  int (*close_input)(struct corsaro_in *corsaro);

  int (*close_output)(struct corsaro *corsaro);

  off_t (*read_record)(struct corsaro_in *corsaro, 
                       enum corsaro_in_record_type *record_type, 
                       struct corsaro_in_record *record);

  off_t (*read_global_data_record)(struct corsaro_in *corsaro, 
                       enum corsaro_in_record_type *record_type, 
                       struct corsaro_in_record *record);

  int (*start_interval)(struct corsaro *corsaro, struct corsaro_interval *int_start);

  int (*end_interval)(struct corsaro *corsaro, struct corsaro_interval *int_end);

  int (*process_packet)(struct corsaro *corsaro, struct corsaro_packet *packet);

#ifdef WITH_PLUGIN_SIXT

  int (*process_flowtuple)(struct corsaro *corsaro, 
                           corsaro_flowtuple_t *flowtuple,
                           struct corsaro_packet_state *state);

  int (*process_flowtuple_class_start)(struct corsaro *corsaro, 
                                       corsaro_flowtuple_class_start_t *class);

  int (*process_flowtuple_class_end)(struct corsaro *corsaro, 
                                     corsaro_flowtuple_class_end_t *class);
#endif

  struct corsaro_plugin *next;

  int argc;
  
  char **argv;
  
} corsaro_plugin_t;

typedef struct corsaro_plugin_manager
{
  uint16_t *plugins_enabled;

  uint16_t plugins_enabled_cnt;

  corsaro_plugin_t **plugins;

  corsaro_plugin_t *first_plugin;

  void **plugins_state;

  uint16_t plugins_cnt;

  corsaro_file_t *logfile;

} corsaro_plugin_manager_t;

corsaro_plugin_manager_t *corsaro_plugin_manager_init();

int corsaro_plugin_manager_start(corsaro_plugin_manager_t *manager); 

void corsaro_plugin_manager_free(corsaro_plugin_manager_t *manager);

corsaro_plugin_t *corsaro_plugin_get_by_id(corsaro_plugin_manager_t *manager, 
                                           int id);

corsaro_plugin_t *corsaro_plugin_get_by_magic(corsaro_plugin_manager_t *manager, 
                                              uint32_t id);

corsaro_plugin_t *corsaro_plugin_get_by_name(corsaro_plugin_manager_t *manager, 
                                         const char *name);

corsaro_plugin_t *corsaro_plugin_next(corsaro_plugin_manager_t *manager, 
                                  corsaro_plugin_t *plugin);

void corsaro_plugin_register_state(corsaro_plugin_manager_t *manager, 
                                 corsaro_plugin_t *plugin,
                                 void *state);

void corsaro_plugin_free_state(corsaro_plugin_manager_t *manager, 
                             corsaro_plugin_t *plugin);

int corsaro_plugin_probe_filename(const char *fname, corsaro_plugin_t *plugin);

const char *corsaro_plugin_get_name_by_id(corsaro_plugin_manager_t *manager,
                                          int id);

const char *corsaro_plugin_get_name_by_magic(corsaro_plugin_manager_t *manager,
                                             uint32_t magic);

int corsaro_plugin_is_enabled(corsaro_plugin_manager_t *manager,
                              corsaro_plugin_t *plugin);

int corsaro_plugin_enable_plugin(corsaro_plugin_manager_t *manager,
                                 const char *plugin_name,
                                 const char *plugin_args);

#endif /* __CORSARO_PLUGIN_H */