src/libcharon/plugins/tnc_ifmap/tnc_ifmap_soap.h

   1 /*
   2  * Copyright (C) 2011 Andreas Steffen
   3  * HSR 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
  16 /**
  17  * @defgroup tnc_ifmap_soap tnc_ifmap_soap
  18  * @{ @ingroup tnc_ifmap
  19  */
  20
  21 #ifndef TNC_IFMAP_SOAP_H_
  22 #define TNC_IFMAP_SOAP_H_
  23
  24 #include <library.h>
  25 #include <utils/host.h>
  26 #include <sa/ike_sa.h>
  27
  28 typedef struct tnc_ifmap_soap_t tnc_ifmap_soap_t;
  29
  30 /**
  31  * Implements the TNC IF-MAP 2.0 SOAP Binding
  32  */
  33 struct tnc_ifmap_soap_t {
  34
  35         /**
  36          * Creates a new IF-MAP session
  37          *
  38          * @return                              TRUE if command was successful
  39          */
  40         bool (*newSession)(tnc_ifmap_soap_t *this);
  41
  42         /**
  43          * Purges all metadata published by this publisher
  44          *
  45          * @return                              TRUE if command was successful
  46          */
  47         bool (*purgePublisher)(tnc_ifmap_soap_t *this);
  48
  49         /**
  50          * Publish metadata about established/deleted IKE_SAs
  51          *
  52          * @param ike_sa                IKE_SA for which metadate is published
  53          * @param up                    TRUE if IKE_SEA is up, FALSE if down
  54          * @return                              TRUE if command was successful
  55          */
  56         bool (*publish_ike_sa)(tnc_ifmap_soap_t *this, ike_sa_t *ike_sa, bool up);
  57
  58         /**
  59          * Publish PEP device-ip metadata
  60          *
  61          * @param host                  IP address of local endpoint
  62          * @return                              TRUE if command was successful
  63          */
  64         bool (*publish_device_ip)(tnc_ifmap_soap_t *this, host_t *host);
  65
  66         /**
  67          * Publish enforcement-report metadata
  68          *
  69          * @param host                  Host to be enforced
  70          * @param action                Enforcement action ("block" or "quarantine")
  71          * @param reason                Enforcement reason
  72          * @return                              TRUE if command was successful
  73          */
  74         bool (*publish_enforcement_report)(tnc_ifmap_soap_t *this, host_t *host,
  75                                                                            char *action, char *reason);
  76
  77         /**
  78          * Ends an IF-MAP session
  79          *
  80          * @return                              TRUE if command was successful
  81          */
  82         bool (*endSession)(tnc_ifmap_soap_t *this);
  83
  84         /**
  85          * Destroy a tnc_ifmap_soap_t.
  86          */
  87         void (*destroy)(tnc_ifmap_soap_t *this);
  88 };
  89
  90 /**
  91  * Create a tnc_ifmap_soap instance.
  92  */
  93 tnc_ifmap_soap_t *tnc_ifmap_soap_create();
  94
  95 #endif /** TNC_IFMAP_SOAP_H_ @}*/