src/libcharon/encoding/payloads/notify_payload.h

   1 /*
   2  * Copyright (C) 2006-2008 Tobias Brunner
   3  * Copyright (C) 2006 Daniel Roethlisberger
   4  * Copyright (C) 2005-2006 Martin Willi
   5  * Copyright (C) 2005 Jan Hutter
   6  * Hochschule fuer Technik Rapperswil
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2 of the License, or (at your
  11  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16  * for more details.
  17  */
  18
  19 /**
  20  * @defgroup notify_payload notify_payload
  21  * @{ @ingroup payloads
  22  */
  23
  24 #ifndef NOTIFY_PAYLOAD_H_
  25 #define NOTIFY_PAYLOAD_H_
  26
  27 typedef enum notify_type_t notify_type_t;
  28 typedef struct notify_payload_t notify_payload_t;
  29
  30 #include <library.h>
  31 #include <encoding/payloads/payload.h>
  32 #include <encoding/payloads/proposal_substructure.h>
  33 #include <utils/linked_list.h>
  34
  35 /**
  36  * Notify message types for IKEv2, and a subset for IKEv1.
  37  */
  38 enum notify_type_t {
  39         /* notify error messages */
  40         UNSUPPORTED_CRITICAL_PAYLOAD = 1,
  41         /* IKEv1 alias */
  42         INVALID_PAYLOAD_TYPE = 1,
  43         INVALID_IKE_SPI = 4,
  44         INVALID_MAJOR_VERSION = 5,
  45         INVALID_SYNTAX = 7,
  46         /* IKEv1 alias */
  47         INVALID_EXCHANGE_TYPE = 7,
  48         INVALID_MESSAGE_ID = 9,
  49         INVALID_SPI = 11,
  50         /* IKEv1 only */
  51         ATTRIBUTES_NOT_SUPPORTED = 13,
  52         /* IKEv1 alias */
  53         NO_PROPOSAL_CHOSEN = 14,
  54         /* IKEv1 only */
  55         PAYLOAD_MALFORMED = 16,
  56         INVALID_KE_PAYLOAD = 17,
  57         /* IKEv1 alias */
  58         INVALID_KEY_INFORMATION = 17,
  59         /* IKEv1 only */
  60         INVALID_ID_INFORMATION = 18,
  61         INVALID_CERT_ENCODING = 19,
  62         INVALID_CERTIFICATE = 20,
  63         CERT_TYPE_UNSUPPORTED = 21,
  64         INVALID_CERT_AUTHORITY = 22,
  65         INVALID_HASH_INFORMATION = 23,
  66         AUTHENTICATION_FAILED = 24,
  67         SINGLE_PAIR_REQUIRED = 34,
  68         NO_ADDITIONAL_SAS = 35,
  69         INTERNAL_ADDRESS_FAILURE = 36,
  70         FAILED_CP_REQUIRED = 37,
  71         TS_UNACCEPTABLE = 38,
  72         INVALID_SELECTORS = 39,
  73         /* mobile extension, RFC 4555 */
  74         UNACCEPTABLE_ADDRESSES = 40,
  75         UNEXPECTED_NAT_DETECTED = 41,
  76         /* mobile IPv6 bootstrapping, RFC 5026 */
  77         USE_ASSIGNED_HoA = 42,
  78         /* IKEv2 RFC 5996 */
  79         TEMPORARY_FAILURE = 43,
  80         CHILD_SA_NOT_FOUND = 44,
  81
  82         /* IKE-ME, private use */
  83         ME_CONNECT_FAILED = 8192,
  84
  85         /* Windows error code */
  86         MS_NOTIFY_STATUS = 12345,
  87
  88         /* notify status messages */
  89         INITIAL_CONTACT = 16384,
  90         SET_WINDOW_SIZE = 16385,
  91         ADDITIONAL_TS_POSSIBLE = 16386,
  92         IPCOMP_SUPPORTED = 16387,
  93         NAT_DETECTION_SOURCE_IP = 16388,
  94         NAT_DETECTION_DESTINATION_IP = 16389,
  95         COOKIE = 16390,
  96         USE_TRANSPORT_MODE = 16391,
  97         HTTP_CERT_LOOKUP_SUPPORTED = 16392,
  98         REKEY_SA = 16393,
  99         ESP_TFC_PADDING_NOT_SUPPORTED = 16394,
 100         NON_FIRST_FRAGMENTS_ALSO = 16395,
 101         /* mobike extension, RFC4555 */
 102         MOBIKE_SUPPORTED = 16396,
 103         ADDITIONAL_IP4_ADDRESS = 16397,
 104         ADDITIONAL_IP6_ADDRESS = 16398,
 105         NO_ADDITIONAL_ADDRESSES = 16399,
 106         UPDATE_SA_ADDRESSES = 16400,
 107         COOKIE2 = 16401,
 108         NO_NATS_ALLOWED = 16402,
 109         /* repeated authentication extension, RFC4478 */
 110         AUTH_LIFETIME = 16403,
 111         /* multiple authentication exchanges, RFC 4739 */
 112         MULTIPLE_AUTH_SUPPORTED = 16404,
 113         ANOTHER_AUTH_FOLLOWS = 16405,
 114         /* redirect mechanism, RFC 5685 */
 115         REDIRECT_SUPPORTED = 16406,
 116         REDIRECT = 16407,
 117         REDIRECTED_FROM = 16408,
 118         /* session resumption, RFC 5723 */
 119         TICKET_LT_OPAQUE = 16409,
 120         TICKET_REQUEST = 16410,
 121         TICKET_ACK = 16411,
 122         TICKET_NACK = 16412,
 123         TICKET_OPAQUE = 16413,
 124         /* IPv6 configuration, RFC 5739 */
 125         LINK_ID = 16414,
 126         /* wrapped esp, RFC 5840 */
 127         USE_WESP_MODE = 16415,
 128         /* robust header compression, RFC 5857 */
 129         ROHC_SUPPORTED = 16416,
 130         /* EAP-only authentication, RFC 5998 */
 131         EAP_ONLY_AUTHENTICATION = 16417,
 132         /* Childless initiation of IKEv2 SA, RFC 6023 */
 133         CHILDLESS_IKEV2_SUPPORTED = 16418,
 134         /* Quick crash detection for IKE, RFC 6290 */
 135         QUICK_CRASH_DETECTION = 16419,
 136         /* High availability of IKEv2/IPsec, RFC 6311 */
 137         IKEV2_MESSAGE_ID_SYNC_SUPPORTED = 16420,
 138         IKEV2_REPLAY_COUNTER_SYNC_SUPPORTED = 16421,
 139         IKEV2_MESSAGE_ID_SYNC = 16422,
 140         IPSEC_REPLAY_COUNTER_SYNC = 16423,
 141         /* Secure password methods, RFC 6467 */
 142         SECURE_PASSWORD_METHOD = 16424,
 143         /* PACE - draft-kuegler-ipsecme-pace-ikev2 */
 144         PSK_PERSIST = 16425,
 145         PSK_CONFIRM = 16426,
 146         /* IKEv1 initial contact */
 147         INITIAL_CONTACT_IKEV1 = 24578,
 148         /* IKEv1 DPD */
 149         DPD_R_U_THERE = 36136,
 150         DPD_R_U_THERE_ACK = 36137,
 151         /* IKEv1 Cisco High Availability */
 152         UNITY_LOAD_BALANCE = 40501,
 153         /* BEET mode, not even a draft yet. private use */
 154         USE_BEET_MODE = 40961,
 155         /* IKE-ME, private use */
 156         ME_MEDIATION = 40962,
 157         ME_ENDPOINT = 40963,
 158         ME_CALLBACK = 40964,
 159         ME_CONNECTID = 40965,
 160         ME_CONNECTKEY = 40966,
 161         ME_CONNECTAUTH = 40967,
 162         ME_RESPONSE = 40968,
 163         /* RADIUS attribute received/to send to a AAA backend */
 164         RADIUS_ATTRIBUTE = 40969,
 165 };
 166
 167 /**
 168  * enum name for notify_type_t.
 169  */
 170 extern enum_name_t *notify_type_names;
 171
 172 /**
 173  * enum name for notify_type_t (shorter strings).
 174  */
 175 extern enum_name_t *notify_type_short_names;
 176
 177 /**
 178  * Class representing an IKEv2-Notify Payload.
 179  *
 180  * The Notify Payload format is described in Draft section 3.10.
 181  */
 182 struct notify_payload_t {
 183         /**
 184          * The payload_t interface.
 185          */
 186         payload_t payload_interface;
 187
 188         /**
 189          * Gets the protocol id of this payload.
 190          *
 191          * @return                      protocol id of this payload
 192          */
 193         u_int8_t (*get_protocol_id) (notify_payload_t *this);
 194
 195         /**
 196          * Sets the protocol id of this payload.
 197          *
 198          * @param protocol_id   protocol id to set
 199          */
 200         void (*set_protocol_id) (notify_payload_t *this, u_int8_t protocol_id);
 201
 202         /**
 203          * Gets the notify message type of this payload.
 204          *
 205          * @return                      notify message type of this payload
 206          */
 207         notify_type_t (*get_notify_type) (notify_payload_t *this);
 208
 209         /**
 210          * Sets notify message type of this payload.
 211          *
 212          * @param type          notify message type to set
 213          */
 214         void (*set_notify_type) (notify_payload_t *this, notify_type_t type);
 215
 216         /**
 217          * Returns the currently set spi of this payload.
 218          *
 219          * This is only valid for notifys with protocol AH|ESP
 220          *
 221          * @return              SPI value
 222          */
 223         u_int32_t (*get_spi) (notify_payload_t *this);
 224
 225         /**
 226          * Sets the spi of this payload.
 227          *
 228          * This is only valid for notifys with protocol AH|ESP
 229          *
 230          * @param spi   SPI value
 231          */
 232         void (*set_spi) (notify_payload_t *this, u_int32_t spi);
 233
 234         /**
 235          * Returns the currently set spi of this payload.
 236          *
 237          * This is only valid for notifys with protocol ISAKMP
 238          *
 239          * @return              SPI value
 240          */
 241         chunk_t (*get_spi_data) (notify_payload_t *this);
 242
 243         /**
 244          * Sets the spi of this payload.
 245          *
 246          * This is only valid for notifys with protocol ISAKMP
 247          *
 248          * @param spi   SPI value
 249          */
 250         void (*set_spi_data) (notify_payload_t *this, chunk_t spi);
 251
 252         /**
 253          * Returns the currently set notification data of payload.
 254          *
 255          * Returned data are not copied.
 256          *
 257          * @return              chunk_t pointing to the value
 258          */
 259         chunk_t (*get_notification_data) (notify_payload_t *this);
 260
 261         /**
 262          * Sets the notification data of this payload.
 263          *
 264          * @warning Value is getting copied.
 265          *
 266          * @param notification_data     chunk_t pointing to the value to set
 267          */
 268         void (*set_notification_data) (notify_payload_t *this,
 269                                                                    chunk_t notification_data);
 270
 271         /**
 272          * Destroys an notify_payload_t object.
 273          */
 274         void (*destroy) (notify_payload_t *this);
 275 };
 276
 277 /**
 278  * Creates an empty notify_payload_t object
 279  *
 280  * @param type          payload type, NOTIFY or NOTIFY_V1
 281  * @return                      created notify_payload_t object
 282  */
 283 notify_payload_t *notify_payload_create(payload_type_t type);
 284
 285 /**
 286  * Creates an notify_payload_t object of specific type for specific protocol id.
 287  *
 288  * @param type                                  payload type, NOTIFY or NOTIFY_V1
 289  * @param protocol                              protocol id (IKE, AH or ESP)
 290  * @param notify                                type of notify
 291  * @return                                              notify_payload_t object
 292  */
 293 notify_payload_t *notify_payload_create_from_protocol_and_type(
 294                         payload_type_t type, protocol_id_t protocol, notify_type_t notify);
 295
 296 #endif /** NOTIFY_PAYLOAD_H_ @}*/