1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
|
/*
* option.c -- helpers for handling options in CoAP PDUs
*
* Copyright (C) 2010-2013 Olaf Bergmann <bergmann@tzi.org>
*
* This file is part of the CoAP library libcoap. Please see
* README for terms of use.
*/
#include "coap_config.h"
#if defined(HAVE_ASSERT_H) && !defined(assert)
# include <assert.h>
#endif
#include <stdio.h>
#include <string.h>
#include "option.h"
#include "encode.h" /* for coap_fls() */
#include "debug.h"
coap_opt_t *
options_start(coap_pdu_t *pdu) {
if (pdu && pdu->hdr &&
(pdu->hdr->token + pdu->hdr->token_length
< (unsigned char *)pdu->hdr + pdu->length)) {
coap_opt_t *opt = pdu->hdr->token + pdu->hdr->token_length;
return (*opt == COAP_PAYLOAD_START) ? NULL : opt;
} else
return NULL;
}
size_t
coap_opt_parse(const coap_opt_t *opt, size_t length, coap_option_t *result) {
const coap_opt_t *opt_start = opt; /* store where parsing starts */
assert(opt); assert(result);
#define ADVANCE_OPT(o,e,step) if ((e) < step) { \
debug("cannot advance opt past end\n"); \
return 0; \
} else { \
(e) -= step; \
(o) = ((unsigned char *)(o)) + step; \
}
if (length < 1)
return 0;
result->delta = (*opt & 0xf0) >> 4;
result->length = *opt & 0x0f;
switch(result->delta) {
case 15:
if (*opt != COAP_PAYLOAD_START) {
debug("ignored reserved option delta 15\n");
}
return 0;
case 14:
/* Handle two-byte value: First, the MSB + 269 is stored as delta value.
* After that, the option pointer is advanced to the LSB which is handled
* just like case delta == 13. */
ADVANCE_OPT(opt,length,1);
result->delta = ((*opt & 0xff) << 8) + 269;
if (result->delta < 269) {
debug("delta too large\n");
return 0;
}
/* fall through */
case 13:
ADVANCE_OPT(opt,length,1);
result->delta += *opt & 0xff;
break;
default:
;
}
switch(result->length) {
case 15:
debug("found reserved option length 15\n");
return 0;
case 14:
/* Handle two-byte value: First, the MSB + 269 is stored as delta value.
* After that, the option pointer is advanced to the LSB which is handled
* just like case delta == 13. */
ADVANCE_OPT(opt,length,1);
result->length = ((*opt & 0xff) << 8) + 269;
/* fall through */
case 13:
ADVANCE_OPT(opt,length,1);
result->length += *opt & 0xff;
break;
default:
;
}
ADVANCE_OPT(opt,length,1);
/* opt now points to value, if present */
result->value = (unsigned char *)opt;
if (length < result->length) {
debug("invalid option length\n");
return 0;
}
#undef ADVANCE_OPT
return (opt + result->length) - opt_start;
}
coap_opt_iterator_t *
coap_option_iterator_init(coap_pdu_t *pdu, coap_opt_iterator_t *oi,
const coap_opt_filter_t filter) {
assert(pdu);
assert(pdu->hdr);
assert(oi);
memset(oi, 0, sizeof(coap_opt_iterator_t));
oi->next_option = (unsigned char *)pdu->hdr + sizeof(coap_hdr_t)
+ pdu->hdr->token_length;
if ((unsigned char *)pdu->hdr + pdu->length <= oi->next_option) {
oi->bad = 1;
return NULL;
}
assert((sizeof(coap_hdr_t) + pdu->hdr->token_length) <= pdu->length);
oi->length = pdu->length - (sizeof(coap_hdr_t) + pdu->hdr->token_length);
if (filter) {
memcpy(oi->filter, filter, sizeof(coap_opt_filter_t));
oi->filtered = 1;
}
return oi;
}
static inline int
opt_finished(coap_opt_iterator_t *oi) {
assert(oi);
if (oi->bad || oi->length == 0 ||
!oi->next_option || *oi->next_option == COAP_PAYLOAD_START) {
oi->bad = 1;
}
return oi->bad;
}
coap_opt_t *
coap_option_next(coap_opt_iterator_t *oi) {
coap_option_t option;
coap_opt_t *current_opt = NULL;
size_t optsize;
int b; /* to store result of coap_option_getb() */
assert(oi);
if (opt_finished(oi))
return NULL;
while (1) {
/* oi->option always points to the next option to deliver; as
* opt_finished() filters out any bad conditions, we can assume that
* oi->option is valid. */
current_opt = oi->next_option;
/* Advance internal pointer to next option, skipping any option that
* is not included in oi->filter. */
optsize = coap_opt_parse(oi->next_option, oi->length, &option);
if (optsize) {
assert(optsize <= oi->length);
oi->next_option += optsize;
oi->length -= optsize;
oi->type += option.delta;
} else { /* current option is malformed */
oi->bad = 1;
return NULL;
}
/* Exit the while loop when:
* - no filtering is done at all
* - the filter matches for the current option
* - the filter is too small for the current option number
*/
if (!oi->filtered ||
(b = coap_option_getb(oi->filter, oi->type)) > 0)
break;
else if (b < 0) { /* filter too small, cannot proceed */
oi->bad = 1;
return NULL;
}
}
return current_opt;
}
coap_opt_t *
coap_check_option(coap_pdu_t *pdu, unsigned short type,
coap_opt_iterator_t *oi) {
coap_opt_filter_t f;
coap_option_filter_clear(f);
coap_option_setb(f, type);
coap_option_iterator_init(pdu, oi, f);
return coap_option_next(oi);
}
unsigned short
coap_opt_delta(const coap_opt_t *opt) {
unsigned short n;
n = (*opt++ & 0xf0) >> 4;
switch (n) {
case 15: /* error */
warn("coap_opt_delta: illegal option delta\n");
/* This case usually should not happen, hence we do not have a
* proper way to indicate an error. */
return 0;
case 14:
/* Handle two-byte value: First, the MSB + 269 is stored as delta value.
* After that, the option pointer is advanced to the LSB which is handled
* just like case delta == 13. */
n = ((*opt++ & 0xff) << 8) + 269;
/* fall through */
case 13:
n += *opt & 0xff;
break;
default: /* n already contains the actual delta value */
;
}
return n;
}
unsigned short
coap_opt_length(const coap_opt_t *opt) {
unsigned short length;
length = *opt & 0x0f;
switch (*opt & 0xf0) {
case 0xf0:
debug("illegal option delta\n");
return 0;
case 0xe0:
++opt;
/* fall through to skip another byte */
case 0xd0:
++opt;
/* fall through to skip another byte */
default:
++opt;
}
switch (length) {
case 0x0f:
debug("illegal option length\n");
return 0;
case 0x0e:
length = (*opt++ << 8) + 269;
/* fall through */
case 0x0d:
length += *opt++;
break;
default:
;
}
return length;
}
unsigned char *
coap_opt_value(coap_opt_t *opt) {
size_t ofs = 1;
switch (*opt & 0xf0) {
case 0xf0:
debug("illegal option delta\n");
return 0;
case 0xe0:
++ofs;
/* fall through */
case 0xd0:
++ofs;
break;
default:
;
}
switch (*opt & 0x0f) {
case 0x0f:
debug("illegal option length\n");
return 0;
case 0x0e:
++ofs;
/* fall through */
case 0x0d:
++ofs;
break;
default:
;
}
return (unsigned char *)opt + ofs;
}
size_t
coap_opt_size(const coap_opt_t *opt) {
coap_option_t option;
/* we must assume that opt is encoded correctly */
return coap_opt_parse(opt, (size_t)-1, &option);
}
size_t
coap_opt_setheader(coap_opt_t *opt, size_t maxlen,
unsigned short delta, size_t length) {
size_t skip = 0;
assert(opt);
if (maxlen == 0) /* need at least one byte */
return 0;
if (delta < 13) {
opt[0] = delta << 4;
} else if (delta < 270) {
if (maxlen < 2) {
debug("insufficient space to encode option delta %d\n", delta);
return 0;
}
opt[0] = 0xd0;
opt[++skip] = delta - 13;
} else {
if (maxlen < 3) {
debug("insufficient space to encode option delta %d\n", delta);
return 0;
}
opt[0] = 0xe0;
opt[++skip] = ((delta - 269) >> 8) & 0xff;
opt[++skip] = (delta - 269) & 0xff;
}
if (length < 13) {
opt[0] |= length & 0x0f;
} else if (length < 270) {
if (maxlen < skip + 2) {
debug("insufficient space to encode option length %zu\n", length);
return 0;
}
opt[0] |= 0x0d;
opt[++skip] = length - 13;
} else {
if (maxlen < skip + 3) {
debug("insufficient space to encode option delta %d\n", delta);
return 0;
}
opt[0] |= 0x0e;
opt[++skip] = ((length - 269) >> 8) & 0xff;
opt[++skip] = (length - 269) & 0xff;
}
return skip + 1;
}
size_t
coap_opt_encode(coap_opt_t *opt, size_t maxlen, unsigned short delta,
const unsigned char *val, size_t length) {
size_t l = 1;
l = coap_opt_setheader(opt, maxlen, delta, length);
assert(l <= maxlen);
if (!l) {
debug("coap_opt_encode: cannot set option header\n");
return 0;
}
maxlen -= l;
opt += l;
if (maxlen < length) {
debug("coap_opt_encode: option too large for buffer\n");
return 0;
}
if (val) /* better be safe here */
memcpy(opt, val, length);
return l + length;
}
/* coap_opt_filter_t has the following internal structure: */
typedef struct {
uint16_t mask;
#define LONG_MASK ((1 << COAP_OPT_FILTER_LONG) - 1)
#define SHORT_MASK \
(~LONG_MASK & ((1 << (COAP_OPT_FILTER_LONG + COAP_OPT_FILTER_SHORT)) - 1))
uint16_t long_opts[COAP_OPT_FILTER_LONG];
uint8_t short_opts[COAP_OPT_FILTER_SHORT];
} opt_filter;
/** Returns true iff @p type denotes an option type larger than 255. */
static inline int
is_long_option(unsigned short type) { return type > 255; }
/** Operation specifiers for coap_filter_op(). */
enum filter_op_t { FILTER_SET, FILTER_CLEAR, FILTER_GET };
/**
* Applies @p op on @p filter with respect to @p type. The following
* operations are defined:
*
* FILTER_SET: Store @p type into an empty slot in @p filter. Returns
* @c 1 on success, or @c 0 if no spare slot was available.
*
* FILTER_CLEAR: Remove @p type from filter if it exists.
*
* FILTER_GET: Search for @p type in @p filter. Returns @c 1 if found,
* or @c 0 if not found.
*
* @param filter The filter object.
* @param type The option type to set, get or clear in @p filter.
* @param op The operation to apply to @p filter and @p type.
*
* @return 1 on success, and 0 when FILTER_GET yields no
* hit or no free slot is available to store @p type with FILTER_SET.
*/
static int
coap_option_filter_op(coap_opt_filter_t filter,
unsigned short type,
enum filter_op_t op) {
size_t index = 0;
opt_filter *of = (opt_filter *)filter;
uint16_t nr, mask = 0;
if (is_long_option(type)) {
mask = LONG_MASK;
for (nr = 1; index < COAP_OPT_FILTER_LONG; nr <<= 1, index++) {
if (((of->mask & nr) > 0) && (of->long_opts[index] == type)) {
if (op == FILTER_CLEAR) {
of->mask &= ~nr;
}
return 1;
}
}
} else {
mask = SHORT_MASK;
for (nr = 1 << COAP_OPT_FILTER_LONG; index < COAP_OPT_FILTER_SHORT;
nr <<= 1, index++) {
if (((of->mask & nr) > 0) && (of->short_opts[index] == (type & 0xff))) {
if (op == FILTER_CLEAR) {
of->mask &= ~nr;
}
return 1;
}
}
}
/* type was not found, so there is nothing to do if op is CLEAR or GET */
if ((op == FILTER_CLEAR) || (op == FILTER_GET)) {
return 0;
}
/* handle FILTER_SET: */
index = coap_fls(~of->mask & mask);
if (!index) {
return 0;
}
if (is_long_option(type)) {
of->long_opts[index - 1] = type;
} else {
of->short_opts[index - COAP_OPT_FILTER_LONG - 1] = type;
}
of->mask |= 1 << (index - 1);
return 1;
}
int
coap_option_filter_set(coap_opt_filter_t filter, unsigned short type) {
return coap_option_filter_op(filter, type, FILTER_SET);
}
int
coap_option_filter_unset(coap_opt_filter_t filter, unsigned short type) {
return coap_option_filter_op(filter, type, FILTER_CLEAR);
}
int
coap_option_filter_get(const coap_opt_filter_t filter, unsigned short type) {
/* Ugly cast to make the const go away (FILTER_GET wont change filter
* but as _set and _unset do, the function does not take a const). */
return coap_option_filter_op((uint16_t *)filter, type, FILTER_GET);
}
|