src/libcharon/encoding/payloads/unknown_payload.c

   1 /*
   2  * Copyright (C) 2005-2006 Martin Willi
   3  * Copyright (C) 2005 Jan Hutter
   4  * Hochschule fuer Technik Rapperswil
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2 of the License, or (at your
   9  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * for more details.
  15  */
  16
  17 #include <stddef.h>
  18
  19 #include "unknown_payload.h"
  20
  21 typedef struct private_unknown_payload_t private_unknown_payload_t;
  22
  23 /**
  24  * Private data of an unknown_payload_t object.
  25  */
  26 struct private_unknown_payload_t {
  27
  28         /**
  29          * Public unknown_payload_t interface.
  30          */
  31         unknown_payload_t public;
  32
  33         /**
  34          * Type of this payload
  35          */
  36         payload_type_t type;
  37
  38         /**
  39          * Next payload type.
  40          */
  41         u_int8_t next_payload;
  42
  43         /**
  44          * Critical flag.
  45          */
  46         bool critical;
  47
  48         /**
  49          * Reserved bits
  50          */
  51         bool reserved[7];
  52
  53         /**
  54          * Length of this payload.
  55          */
  56         u_int16_t payload_length;
  57
  58         /**
  59          * The contained data.
  60          */
  61         chunk_t data;
  62 };
  63
  64 /**
  65  * Encoding rules to parse an payload which is not further specified.
  66  *
  67  * The defined offsets are the positions in a object of type
  68  * private_unknown_payload_t.
  69  *
  70  */
  71 static encoding_rule_t encodings[] = {
  72         /* 1 Byte next payload type, stored in the field next_payload */
  73         { U_INT_8,                      offsetof(private_unknown_payload_t, next_payload)       },
  74         /* the critical bit */
  75         { FLAG,                         offsetof(private_unknown_payload_t, critical)           },
  76         /* 7 Bit reserved bits */
  77         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[0])        },
  78         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[1])        },
  79         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[2])        },
  80         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[3])        },
  81         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[4])        },
  82         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[5])        },
  83         { RESERVED_BIT,         offsetof(private_unknown_payload_t, reserved[6])        },
  84         /* Length of the whole payload*/
  85         { PAYLOAD_LENGTH,       offsetof(private_unknown_payload_t, payload_length)     },
  86         /* some unknown data bytes, length is defined in PAYLOAD_LENGTH */
  87         { UNKNOWN_DATA,         offsetof(private_unknown_payload_t, data)                       },
  88 };
  89
  90 /*
  91                            1                   2                   3
  92         0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  93        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  94        ! Next Payload  !C!  RESERVED   !         Payload Length        !
  95        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  96        !                                                               !
  97        ~                       Data of any type                        ~
  98        !                                                               !
  99        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 100 */
 101
 102 METHOD(payload_t, verify, status_t,
 103         private_unknown_payload_t *this)
 104 {
 105         if (this->payload_length != UNKNOWN_PAYLOAD_HEADER_LENGTH + this->data.len)
 106         {
 107                 return FAILED;
 108         }
 109         return SUCCESS;
 110 }
 111
 112 METHOD(payload_t, get_encoding_rules, int,
 113         private_unknown_payload_t *this, encoding_rule_t **rules)
 114 {
 115         *rules = encodings;
 116         return countof(encodings);
 117 }
 118
 119 METHOD(payload_t, get_payload_type, payload_type_t,
 120         private_unknown_payload_t *this)
 121 {
 122         return this->type;
 123 }
 124
 125 METHOD(payload_t, get_next_type, payload_type_t,
 126         private_unknown_payload_t *this)
 127 {
 128         return this->next_payload;
 129 }
 130
 131 METHOD(payload_t, set_next_type, void,
 132         private_unknown_payload_t *this,payload_type_t type)
 133 {
 134         this->next_payload = type;
 135 }
 136
 137 METHOD(payload_t, get_length, size_t,
 138         private_unknown_payload_t *this)
 139 {
 140         return this->payload_length;
 141 }
 142
 143 METHOD(unknown_payload_t, is_critical, bool,
 144         private_unknown_payload_t *this)
 145 {
 146         return this->critical;
 147 }
 148
 149 METHOD(unknown_payload_t, get_data, chunk_t,
 150         private_unknown_payload_t *this)
 151 {
 152         return this->data;
 153 }
 154
 155 METHOD2(payload_t, unknown_payload_t, destroy, void,
 156         private_unknown_payload_t *this)
 157 {
 158         free(this->data.ptr);
 159         free(this);
 160 }
 161
 162 /*
 163  * Described in header
 164  */
 165 unknown_payload_t *unknown_payload_create(payload_type_t type)
 166 {
 167         private_unknown_payload_t *this;
 168
 169         INIT(this,
 170                 .public = {
 171                         .payload_interface = {
 172                                 .verify = _verify,
 173                                 .get_encoding_rules = _get_encoding_rules,
 174                                 .get_length = _get_length,
 175                                 .get_next_type = _get_next_type,
 176                                 .set_next_type = _set_next_type,
 177                                 .get_type = _get_payload_type,
 178                                 .destroy = _destroy,
 179                         },
 180                         .is_critical = _is_critical,
 181                         .get_data = _get_data,
 182                         .destroy = _destroy,
 183                 },
 184                 .next_payload = NO_PAYLOAD,
 185                 .payload_length = UNKNOWN_PAYLOAD_HEADER_LENGTH,
 186                 .type = type,
 187         );
 188
 189         return &this->public;
 190 }
 191
 192
 193 /*
 194  * Described in header
 195  */
 196 unknown_payload_t *unknown_payload_create_data(payload_type_t type,
 197                                                                                            bool critical, chunk_t data)
 198 {
 199         private_unknown_payload_t *this;
 200
 201         this = (private_unknown_payload_t*)unknown_payload_create(type);
 202         this->data = data;
 203         this->critical = critical;
 204         this->payload_length = UNKNOWN_PAYLOAD_HEADER_LENGTH + data.len;
 205
 206         return &this->public;
 207 }