src/charon/sa/trap_manager.h

   1 /*
   2  * Copyright (C) 2009 Martin Willi
   3  * Hochschule fuer Technik Rapperswil
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  *
  15  * $Id$
  16  */
  17
  18 /**
  19  * @defgroup trap_manager trap_manager
  20  * @{ @ingroup sa
  21  */
  22
  23 #ifndef TRAP_MANAGER_H_
  24 #define TRAP_MANAGER_H_
  25
  26 #include <library.h>
  27 #include <utils/enumerator.h>
  28 #include <config/peer_cfg.h>
  29
  30 typedef struct trap_manager_t trap_manager_t;
  31
  32 /**
  33  * Manage policies to create SAs from traffic.
  34  */
  35 struct trap_manager_t {
  36
  37         /**
  38          * Install a policy as a trap.
  39          *
  40          * @param peer          peer configuration to initiate on trap
  41          * @param child         child configuration to install as a trap
  42          * @return                      reqid of installed CHILD_SA, 0 if failed
  43          */
  44         u_int (*install)(trap_manager_t *this, peer_cfg_t *peer, child_cfg_t *child);
  45
  46         /**
  47          * Uninstall a trap policy.
  48          *
  49          * @param id            reqid of CHILD_SA to uninstall, returned by install()
  50          * @return                      TRUE if uninstalled successfully
  51          */
  52         bool (*uninstall)(trap_manager_t *this, u_int reqid);
  53
  54         /**
  55          * Create an enumerator over all installed traps.
  56          *
  57          * @return                      enumerator over (peer_cfg_t, child_sa_t)
  58          */
  59         enumerator_t* (*create_enumerator)(trap_manager_t *this);
  60
  61         /**
  62          * Acquire an SA triggered by an installed trap.
  63          *
  64          * @param reqid         requid of the triggering CHILD_SA
  65          * @param src           source of the triggering packet
  66          * @param dst           destination of the triggering packet
  67          */
  68         void (*acquire)(trap_manager_t *this, u_int reqid, traffic_selector_t *src,
  69                                         traffic_selector_t *dst);
  70
  71         /**
  72          * Destroy a trap_manager_t.
  73          */
  74         void (*destroy)(trap_manager_t *this);
  75 };
  76
  77 /**
  78  * Create a trap_manager instance.
  79  */
  80 trap_manager_t *trap_manager_create();
  81
  82 #endif /* TRAP_MANAGER_ @}*/