resource/csdk/connectivity/lib/libcoap-4.1.1/pdu.h

   1 /* pdu.h -- CoAP message structure
   2  *
   3  * Copyright (C) 2010--2012 Olaf Bergmann <bergmann@tzi.org>
   4  *
   5  * This file is part of the CoAP library libcoap. Please see
   6  * README for terms of use.
   7  */
   8
   9 #ifndef _PDU_H_
  10 #define _PDU_H_
  11
  12 #include "config.h"
  13 #include "coap_list.h"
  14 #include "uri.h"
  15
  16 #ifdef WITH_LWIP
  17 #include <lwip/pbuf.h>
  18 #endif
  19
  20 /* pre-defined constants that reflect defaults for CoAP */
  21
  22 #define COAP_DEFAULT_RESPONSE_TIMEOUT  2 /* response timeout in seconds */
  23 #define COAP_DEFAULT_MAX_RETRANSMIT    4 /* max number of retransmissions */
  24 #define COAP_DEFAULT_PORT           5683 /* CoAP default UDP port */
  25 #define COAP_DEFAULT_MAX_AGE          60 /* default maximum object lifetime in seconds */
  26 #ifndef COAP_MAX_PDU_SIZE
  27 #ifdef WITH_ARDUINO
  28 #define COAP_MAX_PDU_SIZE           320 /* maximum size of a CoAP PDU for embedded platforms*/
  29 #else
  30 #define COAP_MAX_PDU_SIZE           1400 /* maximum size of a CoAP PDU for big platforms*/
  31 #endif
  32 #endif /* COAP_MAX_PDU_SIZE */
  33
  34 #define COAP_DEFAULT_VERSION           1 /* version of CoAP supported */
  35 #define COAP_DEFAULT_SCHEME        "coap" /* the default scheme for CoAP URIs */
  36
  37 /** well-known resources URI */
  38 #define COAP_DEFAULT_URI_WELLKNOWN ".well-known/core"
  39
  40 #ifdef __COAP_DEFAULT_HASH
  41 /* pre-calculated hash key for the default well-known URI */
  42 #define COAP_DEFAULT_WKC_HASHKEY   "\345\130\144\245"
  43 #endif
  44
  45 /* CoAP message types */
  46
  47 #define COAP_MESSAGE_CON               0 /* confirmable message (requires ACK/RST) */
  48 #define COAP_MESSAGE_NON               1 /* non-confirmable message (one-shot message) */
  49 #define COAP_MESSAGE_ACK               2 /* used to acknowledge confirmable messages */
  50 #define COAP_MESSAGE_RST               3 /* indicates error in received messages */
  51
  52 /* CoAP request methods */
  53
  54 #define COAP_REQUEST_GET       1
  55 #define COAP_REQUEST_POST      2
  56 #define COAP_REQUEST_PUT       3
  57 #define COAP_REQUEST_DELETE    4
  58
  59 /* CoAP option types (be sure to update check_critical when adding options */
  60
  61 #define COAP_OPTION_IF_MATCH      1 /* C, opaque, 0-8 B, (none) */
  62 #define COAP_OPTION_URI_HOST      3 /* C, String, 1-255 B, destination address */
  63 #define COAP_OPTION_ETAG          4 /* E, opaque, 1-8 B, (none) */
  64 #define COAP_OPTION_IF_NONE_MATCH 5 /* empty, 0 B, (none) */
  65 #define COAP_OPTION_URI_PORT      7 /* C, uint, 0-2 B, destination port */
  66 #define COAP_OPTION_LOCATION_PATH 8 /* E, String, 0-255 B, - */
  67 #define COAP_OPTION_URI_PATH     11 /* C, String, 0-255 B, (none) */
  68 #define COAP_OPTION_CONTENT_FORMAT 12 /* E, uint, 0-2 B, (none) */
  69 #define COAP_OPTION_CONTENT_TYPE COAP_OPTION_CONTENT_FORMAT
  70 #define COAP_OPTION_MAXAGE       14 /* E, uint, 0--4 B, 60 Seconds */
  71 #define COAP_OPTION_URI_QUERY    15 /* C, String, 1-255 B, (none) */
  72 #define COAP_OPTION_ACCEPT       17 /* C, uint,   0-2 B, (none) */
  73 #define COAP_OPTION_LOCATION_QUERY 20 /* E, String,   0-255 B, (none) */
  74 #define COAP_OPTION_PROXY_URI    35 /* C, String, 1-1034 B, (none) */
  75 #define COAP_OPTION_PROXY_SCHEME 39 /* C, String, 1-255 B, (none) */
  76 #define COAP_OPTION_SIZE1        60 /* E, uint, 0-4 B, (none) */
  77
  78 /* option types from draft-ietf-coap-observe-09 */
  79
  80 #define COAP_OPTION_OBSERVE       6 /* E, empty/uint, 0 B/0-3 B, (none) */
  81 #define COAP_OPTION_SUBSCRIPTION  COAP_OPTION_OBSERVE
  82
  83 /* selected option types from draft-core-block-04 */
  84
  85 #define COAP_OPTION_BLOCK2       23 /* C, uint, 0--3 B, (none) */
  86 #define COAP_OPTION_BLOCK1       27 /* C, uint, 0--3 B, (none) */
  87
  88 #define COAP_MAX_OPT             63 /**< the highest option number we know */
  89
  90 /* CoAP result codes (HTTP-Code / 100 * 40 + HTTP-Code % 100) */
  91
  92 /* As of draft-ietf-core-coap-04, response codes are encoded to base
  93  * 32, i.e.  the three upper bits determine the response class while
  94  * the remaining five fine-grained information specific to that class.
  95  */
  96 #define COAP_RESPONSE_CODE(N) (((N)/100 << 5) | (N)%100)
  97
  98 /* Determines the class of response code C */
  99 #define COAP_RESPONSE_CLASS(C) (((C) >> 5) & 0xFF)
 100
 101 #ifndef SHORT_ERROR_RESPONSE
 102 /**
 103  * Returns a human-readable response phrase for the specified CoAP
 104  * response @p code. This function returns @c NULL if not found.
 105  *
 106  * @param code The response code for which the literal phrase should
 107  * be retrieved.
 108  *
 109  * @return A zero-terminated string describing the error, or @c NULL
 110  * if not found.
 111  */
 112 char *coap_response_phrase(unsigned char code);
 113
 114 #define COAP_ERROR_PHRASE_LENGTH 32 /**< maximum length of error phrase */
 115
 116 #else
 117 #define coap_response_phrase(x) ((char *)NULL)
 118
 119 #define COAP_ERROR_PHRASE_LENGTH 0 /**< maximum length of error phrase */
 120 #endif /* SHORT_ERROR_RESPONSE */
 121
 122 /* The following definitions exist for backwards compatibility */
 123 #if 0 /* this does not exist any more */
 124 #define COAP_RESPONSE_100      40 /* 100 Continue */
 125 #endif
 126 #define COAP_RESPONSE_200      COAP_RESPONSE_CODE(200)  /* 2.00 OK */
 127 #define COAP_RESPONSE_201      COAP_RESPONSE_CODE(201)  /* 2.01 Created */
 128 #define COAP_RESPONSE_304      COAP_RESPONSE_CODE(203)  /* 2.03 Valid */
 129 #define COAP_RESPONSE_400      COAP_RESPONSE_CODE(400)  /* 4.00 Bad Request */
 130 #define COAP_RESPONSE_404      COAP_RESPONSE_CODE(404)  /* 4.04 Not Found */
 131 #define COAP_RESPONSE_405      COAP_RESPONSE_CODE(405)  /* 4.05 Method Not Allowed */
 132 #define COAP_RESPONSE_415      COAP_RESPONSE_CODE(415)  /* 4.15 Unsupported Media Type */
 133 #define COAP_RESPONSE_500      COAP_RESPONSE_CODE(500)  /* 5.00 Internal Server Error */
 134 #define COAP_RESPONSE_501      COAP_RESPONSE_CODE(501)  /* 5.01 Not Implemented */
 135 #define COAP_RESPONSE_503      COAP_RESPONSE_CODE(503)  /* 5.03 Service Unavailable */
 136 #define COAP_RESPONSE_504      COAP_RESPONSE_CODE(504)  /* 5.04 Gateway Timeout */
 137 #if 0  /* these response codes do not have a valid code any more */
 138 #  define COAP_RESPONSE_X_240    240   /* Token Option required by server */
 139 #  define COAP_RESPONSE_X_241    241   /* Uri-Authority Option required by server */
 140 #endif
 141 #define COAP_RESPONSE_X_242    COAP_RESPONSE_CODE(402)  /* Critical Option not supported */
 142
 143 /* CoAP media type encoding */
 144
 145 #define COAP_MEDIATYPE_TEXT_PLAIN                     0 /* text/plain (UTF-8) */
 146 #define COAP_MEDIATYPE_APPLICATION_LINK_FORMAT       40 /* application/link-format */
 147 #define COAP_MEDIATYPE_APPLICATION_XML               41 /* application/xml */
 148 #define COAP_MEDIATYPE_APPLICATION_OCTET_STREAM      42 /* application/octet-stream */
 149 #define COAP_MEDIATYPE_APPLICATION_RDF_XML           43 /* application/rdf+xml */
 150 #define COAP_MEDIATYPE_APPLICATION_EXI               47 /* application/exi  */
 151 #define COAP_MEDIATYPE_APPLICATION_JSON              50 /* application/json  */
 152
 153 /* Note that identifiers for registered media types are in the range 0-65535. We
 154  * use an unallocated type here and hope for the best. */
 155 #define COAP_MEDIATYPE_ANY                         0xff /* any media type */
 156
 157 /* CoAP transaction id */
 158 /*typedef unsigned short coap_tid_t; */
 159 typedef int coap_tid_t;
 160 #define COAP_INVALID_TID -1
 161
 162 #ifdef WORDS_BIGENDIAN
 163 typedef struct
 164 {
 165     unsigned int version:2; /* protocol version */
 166     unsigned int type:2; /* type flag */
 167     unsigned int token_length:4; /* length of Token */
 168     unsigned int code:8; /* request method (value 1--10) or response code (value 40-255) */
 169     unsigned short id; /* message id */
 170     unsigned char token[]; /* the actual token, if any */
 171 }coap_hdr_t;
 172 #else
 173 typedef struct
 174 {
 175     unsigned int token_length :4; /* length of Token */
 176     unsigned int type :2; /* type flag */
 177     unsigned int version :2; /* protocol version */
 178     unsigned int code :8; /* request method (value 1--10) or response code (value 40-255) */
 179     unsigned short id; /* transaction id (network byte order!) */
 180     unsigned char token[]; /* the actual token, if any */
 181 } coap_hdr_t;
 182 #endif
 183
 184 #define COAP_MESSAGE_IS_EMPTY(MSG)    ((MSG)->code == 0)
 185 #define COAP_MESSAGE_IS_REQUEST(MSG)  (!COAP_MESSAGE_IS_EMPTY(MSG)  \
 186                        && ((MSG)->code < 32))
 187 #define COAP_MESSAGE_IS_RESPONSE(MSG) ((MSG)->code >= 64 && (MSG)->code <= 191)
 188
 189 #define COAP_OPT_LONG 0x0F  /* OC == 0b1111 indicates that the option list in a
 190                  * CoAP message is limited by 0b11110000 marker */
 191
 192 #define COAP_OPT_END 0xF0   /* end marker */
 193
 194 #define COAP_PAYLOAD_START 0xFF /* payload marker */
 195
 196 /**
 197  * Structures for more convenient handling of options. (To be used with ordered
 198  * coap_list_t.) The option's data will be added to the end of the coap_option
 199  * structure (see macro COAP_OPTION_DATA).
 200  */
 201 typedef struct
 202 {
 203     unsigned short key; /* the option key (no delta coding) */
 204     unsigned int length;
 205 } coap_option;
 206
 207 #define COAP_OPTION_KEY(option) (option).key
 208 #define COAP_OPTION_LENGTH(option) (option).length
 209 #define COAP_OPTION_DATA(option) ((unsigned char *)&(option) + sizeof(coap_option))
 210
 211 /** Header structure for CoAP PDUs */
 212
 213 typedef struct
 214 {
 215     size_t max_size; /**< allocated storage for options and data */
 216
 217     coap_hdr_t *hdr;
 218     unsigned short max_delta; /**< highest option number */
 219     unsigned short length; /**< PDU length (including header, options, data)  */
 220     unsigned char *data; /**< payload */
 221
 222 #ifdef WITH_LWIP
 223     struct pbuf
 224             *pbuf; /**< lwIP PBUF. The allocated coap_pdu_t will always reside inside the pbuf's payload, but the pointer has to be kept because no exact offset can be given. This field must not be accessed from outside, because the pbuf's reference count is checked to be 1 when the pbuf is assigned to the pdu, and the pbuf stays exclusive to this pdu. */
 225 #endif
 226
 227 } coap_pdu_t;
 228
 229 /** Options in coap_pdu_t are accessed with the macro COAP_OPTION. */
 230 #define COAP_OPTION(node) ((coap_option *)(node)->options)
 231
 232 #ifdef WITH_LWIP
 233 /**
 234  * Creates a CoAP PDU from an lwIP @p pbuf, whose reference is passed on to
 235  * this function.
 236  *
 237  * The pbuf is checked for being contiguous, for having enough head space for
 238  * the PDU struct (which is located directly in front of the data, overwriting
 239  * the old other headers), and for having only one reference. The reference is
 240  * stored in the PDU and will be freed when the PDU is freed.
 241  *
 242  * (For now, these are errors; in future, a new pbuf might be allocated, the
 243  * data copied and the passed pbuf freed).
 244  *
 245  * This behaves like coap_pdu_init(0, 0, 0, pbuf->tot_len), and afterwards
 246  * copying the contents of the pbuf to the pdu.
 247  *
 248  * @return A pointer to the new PDU object or @c NULL on error.
 249  */
 250 coap_pdu_t * coap_pdu_from_pbuf(struct pbuf *pbuf);
 251 #endif
 252
 253 /**
 254  * Creates a new CoAP PDU of given @p size (must be large enough to hold the
 255  * basic CoAP message header (coap_hdr_t). The function returns a pointer to
 256  * the node coap_pdu_t object on success, or @c NULL on error. The storage
 257  * allocated for the result must be released with coap_delete_pdu().
 258  *
 259  * @param type The type of the PDU (one of COAP_MESSAGE_CON,
 260  *             COAP_MESSAGE_NON, COAP_MESSAGE_ACK, COAP_MESSAGE_RST).
 261  * @param code The message code.
 262  * @param id   The message id to set or COAP_INVALID_TID if unknown.
 263  * @param size The number of bytes to allocate for the actual message.
 264  *
 265  * @return A pointer to the new PDU object or @c NULL on error.
 266  */
 267 coap_pdu_t *
 268 coap_pdu_init(unsigned char type, unsigned char code, unsigned short id, size_t size);
 269
 270 /**
 271  * Clears any contents from @p pdu and resets @c version field, @c
 272  * length and @c data pointers. @c max_size is set to @p size, any
 273  * other field is set to @c 0. Note that @p pdu must be a valid
 274  * pointer to a coap_pdu_t object created e.g. by coap_pdu_init().
 275  */
 276 void coap_pdu_clear(coap_pdu_t *pdu, size_t size);
 277
 278 /**
 279  * Creates a new CoAP PDU. The object is created on the heap and must be released
 280  * using coap_delete_pdu();
 281  *
 282  * @deprecated This function allocates the maximum storage for each
 283  * PDU. Use coap_pdu_init() instead.
 284  */
 285 coap_pdu_t *coap_new_pdu();
 286
 287 void coap_delete_pdu(coap_pdu_t *);
 288
 289 /**
 290  * Parses @p data into the CoAP PDU structure given in @p result. This
 291  * function returns @c 0 on error or a number greater than zero on
 292  * success.
 293  *
 294  * @param data   The raw data to parse as CoAP PDU
 295  * @param length The actual size of @p data
 296  * @param result The PDU structure to fill. Note that the structure must
 297  *               provide space for at least @p length bytes to hold the
 298  *               entire CoAP PDU.
 299  * @return A value greater than zero on success or @c 0 on error.
 300  */
 301 int coap_pdu_parse(unsigned char *data, size_t length, coap_pdu_t *result);
 302
 303 /**
 304  * Adds token of length @p len to @p pdu. Adding the token destroys
 305  * any following contents of the pdu. Hence options and data must be
 306  * added after coap_add_token() has been called. In @p pdu, length is
 307  * set to @p len + @c 4, and max_delta is set to @c 0.  This funtion
 308  * returns @c 0 on error or a value greater than zero on success.
 309  *
 310  * @param pdu  The PDU where the token is to be added.
 311  * @param len  The length of the new token.
 312  * @param data The token to add.
 313  * @return A value greater than zero on success, or @c 0 on error.
 314  */
 315 int coap_add_token(coap_pdu_t *pdu, size_t len, const unsigned char *data);
 316
 317 /**
 318  * Adds option of given type to pdu that is passed as first
 319  * parameter. coap_add_option() destroys the PDU's data, so
 320  * coap_add_data() must be called after all options have been added.
 321  * As coap_add_token() destroys the options following the token,
 322  * the token must be added before coap_add_option() is called.
 323  * This function returns the number of bytes written or @c 0 on error.
 324  */
 325 size_t coap_add_option(coap_pdu_t *pdu, unsigned short type, unsigned int len,
 326         const unsigned char *data);
 327
 328 /**
 329  * Adds option of given type to pdu that is passed as first
 330  * parameter, but does not write a value. It works like coap_add_option with
 331  * respect to calling sequence (i.e. after token and before data).
 332  * This function returns a memory address to which the option data has to be
 333  * written before the PDU can be sent, or @c NULL on error.
 334  */
 335 unsigned char *coap_add_option_later(coap_pdu_t *pdu, unsigned short type, unsigned int len);
 336
 337 /**
 338  * Adds given data to the pdu that is passed as first parameter. Note
 339  * that the PDU's data is destroyed by coap_add_option(). coap_add_data()
 340  * must be called only once per PDU, otherwise the result is undefined.
 341  */
 342 int coap_add_data(coap_pdu_t *pdu, unsigned int len, const unsigned char *data);
 343
 344 /**
 345  * Retrieves the length and data pointer of specified PDU. Returns 0 on error
 346  * or 1 if *len and *data have correct values. Note that these values are
 347  * destroyed with the pdu.
 348  */
 349 int coap_get_data(coap_pdu_t *pdu, size_t *len, unsigned char **data);
 350
 351 #endif /* _PDU_H_ */