corsaro_geo.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_GEO_H
#define __CORSARO_GEO_H

#include "khash.h"

#include "corsaro_int.h"

KHASH_MAP_INIT_INT(corsaro_geo_rechash, struct corsaro_geo_record *)


typedef struct corsaro_geo_record
{
  uint32_t id;

  char country_code[3];

  int continent_code;
  
  char region[3];

  char *city; 
  
  char *post_code;

  double latitude;

  double longitude;

  uint32_t metro_code;

  uint32_t area_code;

  char *conn_speed;

  uint32_t *asn;

  int asn_cnt;

  uint32_t asn_ip_cnt;

  /* -- ADD NEW FIELDS ABOVE HERE -- */

  struct corsaro_geo_record *next;

} corsaro_geo_record_t;

typedef enum corsaro_geo_provider_default
  {
    CORSARO_GEO_PROVIDER_DEFAULT_NO   = 0,

    CORSARO_GEO_PROVIDER_DEFAULT_YES  = 1,

  } corsaro_geo_provider_default_t;

typedef enum corsaro_geo_provider_id
  {
    CORSARO_GEO_PROVIDER_MAXMIND      =  1,

    CORSARO_GEO_PROVIDER_NETACQ_EDGE  =  2,

    CORSARO_GEO_PROVIDER_PFX2AS       = 3,

    CORSARO_GEO_PROVIDER_MAX          = CORSARO_GEO_PROVIDER_PFX2AS,

  } corsaro_geo_provider_id_t;

typedef struct corsaro_geo_provider
{
  corsaro_geo_provider_id_t id;

  const char *name;

  khash_t(corsaro_geo_rechash) *all_records;

  struct corsaro_geo_datastructure *ds;

  corsaro_geo_record_t *records;

} corsaro_geo_provider_t;

typedef enum corsaro_geo_datastructure_id
  {
    CORSARO_GEO_DATASTRUCTURE_PATRICIA      =  1,

    CORSARO_GEO_DATASTRUCTURE_MAX          = CORSARO_GEO_DATASTRUCTURE_PATRICIA,

    CORSARO_GEO_DATASTRUCTURE_DEFAULT = CORSARO_GEO_DATASTRUCTURE_PATRICIA,

  } corsaro_geo_datastructure_id_t;

typedef struct corsaro_geo_datastructure
{
  corsaro_geo_datastructure_id_t id;
  
  char *name;

  int (*init)(corsaro_t *corsaro, struct corsaro_geo_datastructure *ds);
  
  void (*free)(struct corsaro_geo_datastructure *ds);

  int (*add_prefix)(corsaro_t *corsaro,
                    struct corsaro_geo_datastructure *ds, 
                    uint32_t addr, uint8_t mask,
                    corsaro_geo_record_t *record);

  corsaro_geo_record_t *(*lookup_record)(corsaro_t *corsaro,
                                           struct corsaro_geo_datastructure *ds,
                                           uint32_t addr);

  void *state;

} corsaro_geo_datastructure_t;

const char *corsaro_geo_get_provider_name(corsaro_geo_provider_id_t id);

const char **corsaro_geo_get_provider_names();

corsaro_geo_provider_t *corsaro_geo_init_provider(
                                corsaro_t *corsaro,
                                corsaro_geo_provider_id_t provider_id,
                                corsaro_geo_datastructure_id_t ds_id,
                                corsaro_geo_provider_default_t set_default);

void corsaro_geo_free_provider(corsaro_t *corsaro,
                             corsaro_geo_provider_t *provider);

corsaro_geo_record_t *corsaro_geo_init_record(corsaro_geo_provider_t *provider,
                                              uint32_t id);

corsaro_geo_record_t *corsaro_geo_get_record(corsaro_geo_provider_t *provider,
                                             uint32_t id);

int corsaro_geo_get_all_records(corsaro_geo_provider_t *provider,
                                corsaro_geo_record_t ***records);


int corsaro_geo_provider_associate_record(corsaro_t *corsaro, 
                                          corsaro_geo_provider_t *provider,
                                          uint32_t addr,
                                          uint8_t mask,
                                          corsaro_geo_record_t *record);

corsaro_geo_record_t *corsaro_geo_provider_lookup_record(corsaro_t *corsaro, 
                                       corsaro_geo_provider_t *provider,
                                       uint32_t addr);

int corsaro_geo_provider_clear(corsaro_geo_provider_t *provider);

void corsaro_geo_provider_add_record(corsaro_geo_provider_t *provider,
                                     corsaro_geo_record_t *record);


corsaro_geo_provider_t *corsaro_geo_get_default(corsaro_t *corsaro);

corsaro_geo_provider_t *corsaro_geo_get_by_id(corsaro_t *corsaro,
                                            corsaro_geo_provider_id_t id);

corsaro_geo_provider_t *corsaro_geo_get_by_name(corsaro_t *corsaro,
                                              const char *name);

corsaro_geo_record_t *corsaro_geo_next_record(corsaro_geo_provider_t *provider,
                                              corsaro_geo_record_t *record);

void corsaro_geo_dump_record(corsaro_geo_record_t *record);

const char *corsaro_geo_get_maxmind_iso2(int country_id);

int corsaro_geo_get_maxmind_iso2_list(const char ***countries);

const char *corsaro_geo_get_maxmind_iso3(int country_id);

int corsaro_geo_get_maxmind_iso3_list(const char ***countries);

const char *corsaro_geo_get_maxmind_country_name(int country_id);

int corsaro_geo_get_maxmind_country_name_list(const char ***countries);

const char *corsaro_geo_get_maxmind_continent(int country_id);

int corsaro_geo_get_maxmind_country_continent_list(const char ***continents);

#endif /* __CORSARO_GEO_H */