nbroker_api.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2017-2018 ntop.org
 *
 *      http://www.ntop.org/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesses General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 */

#ifndef NBROKER_API
#define NBROKER_API

#include <net/if.h>

#include "rrc.h"

/* This can be used in place of the rule_id parameters to enable automatic rule assignment */
#define NBROKER_AUTO_RULE_ID 0

#define NBROKER_FLAGS_FAST     (1 <<  0) 
/* ************************************************************* */

typedef enum {
  NBROKER_RC_OK = 0,
  NBROKER_RC_INTERNAL_ERROR,             /* a generic error */
  NBROKER_RC_SYNTAX_ERROR,
  NBROKER_RC_UNSUPPORTED_MODE,           /* the command is not supported in the current text/binary mode */
  NBROKER_RC_INVALID_DEVICE_PORT,
  NBROKER_RC_INVALID_REDIRECTION_PORT,
  NBROKER_RC_RULE_NOT_FOUND,
  NBROKER_RC_RULE_EXISTS,
  NBROKER_RC_DEVICE_COMMAND_ERROR,       /* an error occurred while setting the command on the physical device */
  NBROKER_RC_BAD_BINARY_VERSION,
  NBROKER_RC_CONNECTION_ERROR,
  NBROKER_RC_BUSY,
} nbroker_rc_t;

typedef struct {
  u_int8_t binary_mark;
  u_int8_t binary_version;
} __attribute__((packed))
nbroker_command_header_t;

/* ************************************************************* */

typedef enum {
  NBROKER_POLICY_DROP,
  NBROKER_POLICY_PASS
} nbroker_policy_t;

typedef enum {
  NBROKER_TYPE_FILTERING,
  NBROKER_TYPE_STEERING
} nbroker_filter_type_t;

typedef struct {
  u_int32_t rule_id;          
  rrc_match_t match;      
  union {
    nbroker_policy_t policy;  
    u_int8_t steer_to;        
  } u;
} nbroker_rule_t;

#define CMD_QUEUE_ITEMS 1024 /* pow of 2 */
#define CMD_QUEUE_ITEMS_MASK (CMD_QUEUE_ITEMS - 1)

typedef enum {
  CMD_SET_RULE = 0
} cmd_type_t;

typedef struct {
  cmd_type_t type;
  struct {
    char port[IFNAMSIZ];
    nbroker_filter_type_t type;
    u_int32_t rule_id;
    rrc_match_t match;
    nbroker_policy_t policy;
    char redirectionPort[IFNAMSIZ];
  } rule;
} cmd_desc_t;

typedef struct {
  u_int64_t head;
  u_int64_t tail;
  cmd_desc_t desc[CMD_QUEUE_ITEMS];
} cmd_queue_t;

typedef struct nbroker {
  void *zmq_context, *zmq_requester;
  int breakloop;
  u_int32_t flags;
  pthread_t cmdqthread;
  cmd_queue_t cmdq;
} nbroker_t;

/* ************************************************************* */

nbroker_rc_t nbroker_init(nbroker_t **bkr, u_int32_t flags);

nbroker_rc_t nbroker_term(nbroker_t *bkr);

nbroker_rc_t nbroker_set_default_policy(nbroker_t *bkr, const char *port, nbroker_policy_t policy);

nbroker_rc_t nbroker_apply_pending_rules(nbroker_t *bkr);

nbroker_rc_t nbroker_set_default_steering(nbroker_t *bkr, const char *port, const char *steer_to);

nbroker_rc_t nbroker_set_filtering_rule(nbroker_t *bkr, const char *port,
      u_int32_t *rule_id, const rrc_match_t *match, nbroker_policy_t policy);

nbroker_rc_t nbroker_set_steering_rule(nbroker_t *bkr, const char *port,
      u_int32_t *rule_id, const rrc_match_t *match, const char *steer_to);

nbroker_rc_t nbroker_remove_rule_by_id(nbroker_t *bkr, const char *port,
      u_int32_t rule_id, nbroker_filter_type_t filter_type);

nbroker_rc_t nbroker_remove_rule_by_match(nbroker_t *bkr, const char *port,
      const rrc_match_t *match, nbroker_filter_type_t filter_type);

nbroker_rc_t nbroker_list_rules(nbroker_t *bkr, const char *port,
      nbroker_filter_type_t filter_type, u_int32_t *num_rules, nbroker_rule_t **rules);

nbroker_rc_t nbroker_reset_rules(nbroker_t *bkr, const char *port, nbroker_filter_type_t filter_type);

nbroker_rc_t nbroker_purge_idle_rules(nbroker_t *bkr, u_int32_t idle_for);

nbroker_rc_t nbroker_set_auto_purge(nbroker_t *bkr, u_int32_t idle_for);

nbroker_rc_t nbroker_ifname_to_internal_port(nbroker_t *bkr, const char *ifname, u_int8_t *port);

nbroker_rc_t nbroker_ifname_to_external_port(nbroker_t *bkr, const char *ifname, u_int8_t *port);

rrc_match_t* nbroker_parse_rule(const char *rule);

/* TODO
 * nbroker_rc_t nbroker_get_port_stats(const char *port, nbroker_stats_t *stats);
 * nbroker_rc_t nbroker_get_rule_stats(const char *port, u_int32_t rule_id, nbroker_stats_t *stats);
 */

#endif