oscore_context.c

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
/*
 * Copyright (c) 2018, SICS, RISE AB
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Institute nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */

 
#include "coap3/coap_libcoap_build.h"
 
#if COAP_OSCORE_SUPPORT
 
#include <stdio.h>
 
/* Move ptr from b to a, and then clear b */
#define OSC_MOVE_PTR(a,b) do { (a) = (b); (b) = NULL; } while(0)
 
static int oscore_context_release_recipients(oscore_ctx_t *osc_ctx);
 
static size_t
compose_info(uint8_t *buffer,
             size_t buf_size,
             cose_alg_t alg,
             coap_bin_const_t *id,
             coap_bin_const_t *id_context,
             coap_str_const_t *type,
             size_t out_len) {
  size_t ret = 0;
  size_t rem_size = buf_size;
 
  ret += oscore_cbor_put_array(&buffer, &rem_size, 5);
  ret += oscore_cbor_put_bytes(&buffer,
                               &rem_size,
                               id ? id->s : NULL,
                               id ? id->length : 0);
  if (id_context != NULL && id_context->length > 0) {
    ret += oscore_cbor_put_bytes(&buffer,
                                 &rem_size,
                                 id_context->s,
                                 id_context->length);
  } else {
    ret += oscore_cbor_put_nil(&buffer, &rem_size);
  }
  ret += oscore_cbor_put_unsigned(&buffer, &rem_size, alg);
  ret += oscore_cbor_put_text(&buffer,
                              &rem_size,
                              (const char *)type->s,
                              type->length);
  ret += oscore_cbor_put_unsigned(&buffer, &rem_size, out_len);
  return ret;
}
 
uint8_t
oscore_bytes_equal(uint8_t *a_ptr,
                   uint8_t a_len,
                   uint8_t *b_ptr,
                   uint8_t b_len) {
  if (a_len != b_len) {
    return 0;
  }
 
  if (memcmp(a_ptr, b_ptr, a_len) == 0) {
    return 1;
  } else {
    return 0;
  }
}
 
static void
oscore_enter_context(coap_context_t *c_context, oscore_ctx_t *osc_ctx) {
  if (c_context->p_osc_ctx) {
    oscore_ctx_t *head = c_context->p_osc_ctx;
    oscore_ctx_t *prev = head;
    oscore_ctx_t *next = head->next;
 
    /* verify if oscore context is already attached */
    if (head == osc_ctx) {
      return;
    }
    while (next != head) {
      if (next == osc_ctx) {
        return;
      }
      prev = next;
      next = next->next;
    }
    prev->next = osc_ctx;
    osc_ctx->next = head;
  } else {
    c_context->p_osc_ctx = osc_ctx;
    osc_ctx->next = osc_ctx;
  }
}
 
static void
oscore_free_recipient_ctx(oscore_recipient_ctx_t *rcp_ctx) {
  if (rcp_ctx == NULL)
    return;
 
  assert(rcp_ctx->ref > 0);
  if (--rcp_ctx->ref > 0) {
    return;
  }
 
  /* remove recipient from oscore context chain if attached */
  if (rcp_ctx->osc_ctx) {
    if (rcp_ctx->osc_ctx->recipient_chain == rcp_ctx) {
      rcp_ctx->osc_ctx->recipient_chain = rcp_ctx->next_recipient;
    } else {
      oscore_recipient_ctx_t *prev = rcp_ctx->osc_ctx->recipient_chain;
 
      while (prev && prev->next_recipient != rcp_ctx) {
        prev = prev->next_recipient;
      }
      if (prev) {
        prev->next_recipient = rcp_ctx->next_recipient;
      }
    }
  }
 
  coap_delete_bin_const(rcp_ctx->recipient_key);
  coap_delete_bin_const(rcp_ctx->recipient_id);
  coap_free_type(COAP_OSCORE_REC, rcp_ctx);
}
 
void
oscore_free_sender(oscore_sender_ctx_t *snd_ctx) {
 
  if (snd_ctx == NULL)
    return;
  coap_delete_bin_const(snd_ctx->sender_id);
  coap_delete_bin_const(snd_ctx->sender_key);
  coap_free_type(COAP_OSCORE_SEN, snd_ctx);
}
 
void
oscore_free_context(oscore_ctx_t *osc_ctx) {
  if (osc_ctx == NULL)
    return;
 
  oscore_free_sender(osc_ctx->sender_context);
 
  while (osc_ctx->recipient_chain) {
    oscore_recipient_ctx_t *next = osc_ctx->recipient_chain->next_recipient;
 
    oscore_free_recipient_ctx(osc_ctx->recipient_chain);
    osc_ctx->recipient_chain = next;
  }
 
  coap_delete_bin_const(osc_ctx->master_secret);
  coap_delete_bin_const(osc_ctx->master_salt);
  coap_delete_bin_const(osc_ctx->id_context);
  coap_delete_bin_const(osc_ctx->common_iv);
  coap_free_type(COAP_OSCORE_COM, osc_ctx);
}
 
void
oscore_free_contexts(coap_context_t *c_context) {
  while (c_context->p_osc_ctx) {
    oscore_ctx_t *osc_ctx = c_context->p_osc_ctx;
 
    if (osc_ctx->next == osc_ctx) {
      c_context->p_osc_ctx = NULL;
    } else {
      oscore_ctx_t *tail = osc_ctx;
      c_context->p_osc_ctx = osc_ctx->next;
      while (tail->next != osc_ctx) {
        tail = tail->next;
      }
      tail->next = c_context->p_osc_ctx;
    }
    osc_ctx->next = NULL;
 
    /*
     * Verify if all recipients can be released, if not
     * defer freeing of context until later when all recipients are released.
     * The oscore context is flagged as ready to be freed by removing
     * the oscore context from the coap context.
     */
    if (oscore_context_release_recipients(osc_ctx) > 0) {
      oscore_free_context(osc_ctx);
    }
  }
}

static int
oscore_context_release_recipients(oscore_ctx_t *osc_ctx) {
  int ok = 1;
 
  oscore_recipient_ctx_t *prev = NULL;
  oscore_recipient_ctx_t *next = osc_ctx->recipient_chain;
 
  while (next != NULL) {
    /* if reference is 1 or lower, ready to be freed */
    if (next->ref <= 1) {
      oscore_recipient_ctx_t *to_free = next;
      next = next->next_recipient;
      oscore_free_recipient_ctx(to_free);
      continue;
    }
 
    /*
     * Recipient is still attached to an oscore association or session,
     * can not be freed yet. Decrease ref counter and keep in chain.
     */
    next->ref--;
    ok = 0;
 
    /* keep recipient in chain, since still referenced by other
       session or association */
    if (prev != NULL) {
      prev->next_recipient = next;
    } else {
      osc_ctx->recipient_chain = next;
    }
    prev = next;
    next = next->next_recipient;
  }
  return ok;
}
 
int
oscore_remove_context(coap_context_t *c_context, oscore_ctx_t *osc_ctx) {
  oscore_ctx_t *head = c_context->p_osc_ctx;
  oscore_ctx_t *prev;
  oscore_ctx_t *next;
 
  if (head == NULL)
    return 0;
 
  prev = head;
  next = head;
  do {
    if (next == osc_ctx) {
      if (next->next == next) {
        c_context->p_osc_ctx = NULL;
      } else {
        while (prev->next != next) {
          prev = prev->next;
        }
        prev->next = next->next;
        if (next == c_context->p_osc_ctx)
          c_context->p_osc_ctx = next->next;
      }
      next->next = NULL;
      /*
       * Only free context if no recipient is still referenced by
       * an association or session. Otherwise defer context to be
       * freed after all references are resolved.
       */
      if (oscore_context_release_recipients(osc_ctx) <= 0) {
        return 2;
      }
 
      /* all related recipient ctx attachments are released */
      osc_ctx->recipient_chain = NULL;
      oscore_free_context(osc_ctx);
      return 1;
    }
    next = next->next;
  } while (next != head);
  return 0;
}
 
/*
 *  oscore_find_context
 * Finds OSCORE context for rcpkey_id and optional ctxkey_id
 * rcpkey_id can be 0 length.
 * Updates recipient_ctx.
 */
oscore_ctx_t *
oscore_find_context(coap_session_t *session,
                    const coap_bin_const_t rcpkey_id,
                    const coap_bin_const_t *ctxkey_id,
                    uint8_t *oscore_r2,
                    oscore_recipient_ctx_t **recipient_ctx) {
  if (session->context->oscore_find_cb != NULL) {
    oscore_ctx_t *tmp_ctx = NULL;
    coap_oscore_conf_t *oscore_conf;
 
    if (session->recipient_ctx) {
      tmp_ctx = session->recipient_ctx->osc_ctx;
      if (!tmp_ctx) {
        return NULL;
      }
      if (coap_binary_equal(session->recipient_ctx->recipient_id, &rcpkey_id)) {
        if (oscore_r2) {
          if (tmp_ctx->id_context != NULL &&
              tmp_ctx->id_context->length > 8) {
            if (memcmp(tmp_ctx->id_context->s, oscore_r2, 8) == 0) {
              goto match;
            }
          }
        } else if (ctxkey_id) {
          if (session->recipient_ctx->osc_ctx->id_context != NULL) {
            if (!coap_binary_equal(tmp_ctx->id_context, ctxkey_id)) {
              return NULL;
            }
          } else if (ctxkey_id->length > 0) {
            return NULL;
          }
        }
match:
        *recipient_ctx = session->recipient_ctx;
        return session->recipient_ctx->osc_ctx;
      }
    }
    coap_lock_callback_ret(oscore_conf, session->context->oscore_find_cb(session,
                           &rcpkey_id,
                           ctxkey_id));
 
    if (oscore_conf) {
      tmp_ctx = coap_init_oscore_context_from_conf(oscore_conf);
    }
 
    if (tmp_ctx != NULL) {
      /*
       * find matching recipient and remove others if multiple recipients
       * have been provided. ensures unneeded memory is freed early
       * to prevent memory leaks and unnecessary memory usage.
       */
      if (tmp_ctx->recipient_chain != NULL &&
          tmp_ctx->recipient_chain->next_recipient != NULL) {
        oscore_recipient_ctx_t *rcp_ctx = tmp_ctx->recipient_chain;
        oscore_recipient_ctx_t *ref_ctx = NULL;
        while (rcp_ctx != NULL) {
          ref_ctx = rcp_ctx;
          rcp_ctx = rcp_ctx->next_recipient;
          if (coap_binary_equal(ref_ctx->recipient_id, &rcpkey_id)) {
            ref_ctx->next_recipient = NULL;
            *recipient_ctx = ref_ctx;
          } else {
            coap_delete_bin_const(ref_ctx->recipient_key);
            coap_delete_bin_const(ref_ctx->recipient_id);
            coap_free_type(COAP_OSCORE_REC, (void *)ref_ctx);
          }
        }
      } else {
        *recipient_ctx = tmp_ctx->recipient_chain;
      }
      tmp_ctx->recipient_chain = *recipient_ctx;
      const coap_bool_t  already_attached = session->recipient_ctx == *recipient_ctx;
      coap_oscore_session_set_recipient_ctx(session, *recipient_ctx);
      /* Remove the tmp_ctx reference */
      if (*recipient_ctx && !already_attached)
        (*recipient_ctx)->ref--;
      return tmp_ctx;
    }
  }
 
  oscore_ctx_t *pt = session->context->p_osc_ctx;
 
  *recipient_ctx = NULL;
  assert(rcpkey_id.length == 0 || rcpkey_id.s != NULL);
  if (pt == NULL)
    return NULL;
  do {
    int ok = 0;
    oscore_recipient_ctx_t *rpt = pt->recipient_chain;
 
    while (rpt) {
      ok = 0;
      if (rpt->recipient_id && rcpkey_id.length == rpt->recipient_id->length) {
        if (rcpkey_id.length != 0)
          ok = memcmp(rpt->recipient_id->s, rcpkey_id.s, rcpkey_id.length) != 0;
        if (oscore_r2) {
          if (pt->id_context != NULL && pt->id_context->length > 8) {
            ok = ok + (memcmp(pt->id_context->s, oscore_r2, 8) != 0);
          } else {
            ok += 1;
          }
        } else if (ctxkey_id) {
          if (pt->id_context != NULL) {
            if (ctxkey_id->length != pt->id_context->length)
              ok += 1;
            else
              ok = ok + (memcmp(pt->id_context->s,
                                ctxkey_id->s,
                                ctxkey_id->length) != 0);
          } else if (ctxkey_id->length > 0)
            ok += 1;
        }
        if (ok == 0) {
          /* optional id context and recipient id are the same  */
          *recipient_ctx = rpt;
          return pt; /* OSCORE context found */
        }
      }
      rpt = rpt->next_recipient;
    } /* while rpt */
    pt = pt->next;
  } while (pt != session->context->p_osc_ctx);
  return NULL;
}
 
#define OSCORE_LOG_SIZE 16
void
oscore_log_hex_value(coap_log_t level,
                     const char *name,
                     coap_bin_const_t *value) {
  size_t i;
 
  if (value == NULL) {
    coap_log(level, "    %-16s\n", name);
    return;
  }
  if (value->length == 0) {
    coap_log(level, "    %-16s <>\n", name);
    return;
  }
  if (coap_get_log_level() >= level) {
    for (i = 0; i < value->length; i += OSCORE_LOG_SIZE) {
      char number[3 * OSCORE_LOG_SIZE + 4];
 
      oscore_convert_to_hex(&value->s[i],
                            value->length - i > OSCORE_LOG_SIZE ?
                            OSCORE_LOG_SIZE : value->length - i,
                            number,
                            sizeof(number));
      coap_log(level, "    %-16s %s\n", i == 0 ? name : "", number);
    }
  }
}
 
void
oscore_log_int_value(coap_log_t level, const char *name, int value) {
  coap_log(level, "    %-16s %2d\n", name, value);
}
 
void
oscore_log_char_value(coap_log_t level, const char *name, const char *value) {
  coap_log(level, "    %-16s %s\n", name, value);
}
 
void
oscore_convert_to_hex(const uint8_t *src,
                      size_t src_len,
                      char *dest,
                      size_t dst_len) {
  /*
   * Last output character will be '\000'
   * (If output undersized, add trailing ... to indicate this.
   */
  size_t space = (dst_len - 4) / 3;
  uint32_t qq;
 
  for (qq = 0; qq < src_len && qq < space; qq++) {
    char tmp = src[qq] >> 4;
    if (tmp > 9)
      tmp = tmp + 0x61 - 10;
    else
      tmp = tmp + 0x30;
    dest[qq * 3] = tmp;
    tmp = src[qq] & 0xf;
    if (tmp > 9)
      tmp = tmp + 0x61 - 10;
    else
      tmp = tmp + 0x30;
    dest[qq * 3 + 1] = tmp;
    dest[qq * 3 + 2] = 0x20;
  }
  if (qq != src_len) {
    dest[qq * 3] = '.';
    dest[qq * 3 + 1] = '.';
    dest[qq * 3 + 2] = '.';
    qq++;
  }
  dest[qq * 3] = 0;
}
 
coap_bin_const_t *
oscore_build_key(oscore_ctx_t *osc_ctx,
                 coap_bin_const_t *salt,
                 coap_bin_const_t *ikm,
                 cose_alg_t aead_alg,
                 coap_bin_const_t *id,
                 coap_str_const_t *type,
                 size_t out_len) {
  uint8_t info_buffer[80];
  size_t info_len;
  coap_bin_const_t *hkdf;
  uint8_t *hkdf_tmp = coap_malloc_type(COAP_STRING, out_len);
 
  if (hkdf_tmp == NULL)
    return NULL;
 
  info_len = compose_info(info_buffer,
                          sizeof(info_buffer),
                          aead_alg,
                          id,
                          osc_ctx->id_context,
                          type,
                          out_len);
  if (info_len == 0 || info_len > sizeof(info_buffer)) {
    coap_free_type(COAP_STRING, hkdf_tmp);
    return NULL;
  }
 
  oscore_hkdf(osc_ctx->hkdf_alg,
              salt,
              ikm,
              info_buffer,
              info_len,
              hkdf_tmp,
              out_len);
  hkdf = coap_new_bin_const(hkdf_tmp, out_len);
  coap_free_type(COAP_STRING, hkdf_tmp);
  return hkdf;
}
 
static void
oscore_log_context(oscore_ctx_t *osc_ctx, const char *heading) {
#if COAP_MAX_LOGGING_LEVEL < _COAP_LOG_OSCORE
  (void)osc_ctx;
  (void)heading;
#else /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_OSCORE */
  if (coap_get_log_level() >= COAP_LOG_OSCORE) {
    char buffer[30];
    oscore_recipient_ctx_t *next = osc_ctx->recipient_chain;
    size_t count = 0;
 
    coap_log_oscore("%s\n", heading);
    oscore_log_char_value(COAP_LOG_OSCORE, "AEAD alg",
                          cose_get_alg_name(osc_ctx->aead_alg, buffer,
                                            sizeof(buffer)));
    oscore_log_char_value(COAP_LOG_OSCORE, "HKDF alg",
                          cose_get_hkdf_alg_name(osc_ctx->hkdf_alg, buffer,
                                                 sizeof(buffer)));
    oscore_log_hex_value(COAP_LOG_OSCORE, "ID Context", osc_ctx->id_context);
    oscore_log_hex_value(COAP_LOG_OSCORE,
                         "Master Secret",
                         osc_ctx->master_secret);
    oscore_log_hex_value(COAP_LOG_OSCORE, "Master Salt", osc_ctx->master_salt);
    oscore_log_hex_value(COAP_LOG_OSCORE, "Common IV", osc_ctx->common_iv);
    oscore_log_hex_value(COAP_LOG_OSCORE,
                         "Sender ID",
                         osc_ctx->sender_context->sender_id);
    oscore_log_hex_value(COAP_LOG_OSCORE,
                         "Sender Key",
                         osc_ctx->sender_context->sender_key);
    while (next) {
      snprintf(buffer, sizeof(buffer), "Recipient ID[%zu]", count);
      oscore_log_hex_value(COAP_LOG_OSCORE,
                           buffer,
                           next->recipient_id);
      snprintf(buffer, sizeof(buffer), "Recipient Key[%zu]", count);
      oscore_log_hex_value(COAP_LOG_OSCORE,
                           buffer,
                           next->recipient_key);
      count++;
      next = next->next_recipient;
    }
  }
#endif /* COAP_MAX_LOGGING_LEVEL >= _COAP_LOG_OSCORE */
}
 
void
oscore_update_ctx(oscore_ctx_t *osc_ctx, coap_bin_const_t *id_context) {
  coap_bin_const_t *temp;
 
  /* Update with new ID Context */
  coap_delete_bin_const(osc_ctx->id_context);
  osc_ctx->id_context = id_context;
 
  /* Update sender_key, recipient_key and common_iv */
  temp = osc_ctx->sender_context->sender_key;
  osc_ctx->sender_context->sender_key =
      oscore_build_key(osc_ctx,
                       osc_ctx->master_salt,
                       osc_ctx->master_secret,
                       osc_ctx->aead_alg,
                       osc_ctx->sender_context->sender_id,
                       coap_make_str_const("Key"),
                       cose_key_len(osc_ctx->aead_alg));
  if (!osc_ctx->sender_context->sender_key)
    osc_ctx->sender_context->sender_key = temp;
  else
    coap_delete_bin_const(temp);
  temp = osc_ctx->recipient_chain->recipient_key;
  osc_ctx->recipient_chain->recipient_key =
      oscore_build_key(osc_ctx,
                       osc_ctx->master_salt,
                       osc_ctx->master_secret,
                       osc_ctx->aead_alg,
                       osc_ctx->recipient_chain->recipient_id,
                       coap_make_str_const("Key"),
                       cose_key_len(osc_ctx->aead_alg));
  if (!osc_ctx->recipient_chain->recipient_key)
    osc_ctx->recipient_chain->recipient_key = temp;
  else
    coap_delete_bin_const(temp);
  temp = osc_ctx->common_iv;
  osc_ctx->common_iv = oscore_build_key(osc_ctx,
                                        osc_ctx->master_salt,
                                        osc_ctx->master_secret,
                                        osc_ctx->aead_alg,
                                        NULL,
                                        coap_make_str_const("IV"),
                                        cose_nonce_len(osc_ctx->aead_alg));
  if (!osc_ctx->common_iv)
    osc_ctx->common_iv = temp;
  else
    coap_delete_bin_const(temp);
 
  oscore_log_context(osc_ctx, "Updated Common context");
}
 
oscore_ctx_t *
oscore_duplicate_ctx(coap_context_t *c_context,
                     oscore_ctx_t *o_osc_ctx,
                     coap_bin_const_t *sender_id,
                     coap_bin_const_t *recipient_id,
                     coap_bin_const_t *id_context) {
  oscore_ctx_t *osc_ctx = NULL;
  oscore_sender_ctx_t *sender_ctx = NULL;
  coap_oscore_rcp_conf_t *rcp_conf;
 
  osc_ctx = coap_malloc_type(COAP_OSCORE_COM, sizeof(oscore_ctx_t));
  if (osc_ctx == NULL)
    goto error;
  memset(osc_ctx, 0, sizeof(oscore_ctx_t));
 
  sender_ctx = coap_malloc_type(COAP_OSCORE_SEN, sizeof(oscore_sender_ctx_t));
  if (sender_ctx == NULL)
    goto error;
  memset(sender_ctx, 0, sizeof(oscore_sender_ctx_t));
 
  osc_ctx->sender_context = sender_ctx;
  if (o_osc_ctx->master_secret)
    osc_ctx->master_secret =
        coap_new_bin_const(o_osc_ctx->master_secret->s,
                           o_osc_ctx->master_secret->length);
  if (o_osc_ctx->master_salt)
    osc_ctx->master_salt = coap_new_bin_const(o_osc_ctx->master_salt->s,
                                              o_osc_ctx->master_salt->length);
  osc_ctx->aead_alg = o_osc_ctx->aead_alg;
  osc_ctx->hkdf_alg = o_osc_ctx->hkdf_alg;
  if (id_context)
    osc_ctx->id_context = coap_new_bin_const(id_context->s, id_context->length);
  osc_ctx->ssn_freq = o_osc_ctx->ssn_freq;
  osc_ctx->replay_window_size = o_osc_ctx->replay_window_size;
  osc_ctx->rfc8613_b_1_2 = o_osc_ctx->rfc8613_b_1_2;
  osc_ctx->rfc8613_b_2 = o_osc_ctx->rfc8613_b_2;
  osc_ctx->save_seq_num_func = o_osc_ctx->save_seq_num_func;
  osc_ctx->save_seq_num_func_param = o_osc_ctx->save_seq_num_func_param;
 
  if (o_osc_ctx->master_secret) {
    /* sender_ key */
    sender_ctx->sender_key = oscore_build_key(osc_ctx,
                                              osc_ctx->master_salt,
                                              osc_ctx->master_secret,
                                              osc_ctx->aead_alg,
                                              sender_id,
                                              coap_make_str_const("Key"),
                                              cose_key_len(osc_ctx->aead_alg));
    if (!sender_ctx->sender_key)
      goto error;
 
    /* common IV */
    osc_ctx->common_iv = oscore_build_key(osc_ctx,
                                          osc_ctx->master_salt,
                                          osc_ctx->master_secret,
                                          osc_ctx->aead_alg,
                                          NULL,
                                          coap_make_str_const("IV"),
                                          cose_nonce_len(osc_ctx->aead_alg));
    if (!osc_ctx->common_iv)
      goto error;
 
  }
 
  /*
   * Need to set the last Sender Seq Num based on ssn_freq
   * The value should only change if there is a change to ssn_freq
   * and (potentially) be lower than seq, then save_seq_num_func() is
   * immediately called on next SSN update.
   */
  sender_ctx->next_seq = 0;
  sender_ctx->seq = 0;
 
  sender_ctx->sender_id = coap_new_bin_const(sender_id->s, sender_id->length);
 
  rcp_conf = coap_malloc_type(COAP_STRING, sizeof(coap_oscore_rcp_conf_t));
  if (rcp_conf == NULL)
    goto error;
  memset(rcp_conf, 0, sizeof(coap_oscore_rcp_conf_t));
  rcp_conf->recipient_id = coap_new_bin_const(recipient_id->s, recipient_id->length);
  if (rcp_conf->recipient_id == NULL)
    goto error;
  /* rcp_conf is released in oscore_add_recipient() */
  if (oscore_add_recipient(osc_ctx, rcp_conf, 0) == NULL)
    goto error;
 
  oscore_log_context(osc_ctx, "New Common context");
  oscore_enter_context(c_context, osc_ctx);
 
  return osc_ctx;
 
error:
  oscore_free_context(osc_ctx);
  return NULL;
}
 
oscore_ctx_t *
oscore_derive_ctx_from_conf(coap_oscore_conf_t *oscore_conf) {
  oscore_ctx_t *osc_ctx = NULL;
  oscore_sender_ctx_t *sender_ctx = NULL;
  coap_oscore_rcp_conf_t *rcp_conf;
  int ok;
 
  osc_ctx = coap_malloc_type(COAP_OSCORE_COM, sizeof(oscore_ctx_t));
  if (osc_ctx == NULL)
    goto error;
  memset(osc_ctx, 0, sizeof(oscore_ctx_t));
 
  sender_ctx = coap_malloc_type(COAP_OSCORE_SEN, sizeof(oscore_sender_ctx_t));
  if (sender_ctx == NULL)
    goto error;
  memset(sender_ctx, 0, sizeof(oscore_sender_ctx_t));
 
  osc_ctx->sender_context = sender_ctx;
  OSC_MOVE_PTR(osc_ctx->master_secret, oscore_conf->master_secret);
  OSC_MOVE_PTR(osc_ctx->master_salt, oscore_conf->master_salt);
  osc_ctx->aead_alg = oscore_conf->aead_alg;
  osc_ctx->hkdf_alg = oscore_conf->hkdf_alg;
  OSC_MOVE_PTR(osc_ctx->id_context, oscore_conf->id_context);
  osc_ctx->ssn_freq = oscore_conf->ssn_freq ? oscore_conf->ssn_freq : 1;
  osc_ctx->replay_window_size = oscore_conf->replay_window ?
                                oscore_conf->replay_window :
                                COAP_OSCORE_DEFAULT_REPLAY_WINDOW;
  osc_ctx->rfc8613_b_1_2 = oscore_conf->rfc8613_b_1_2;
  osc_ctx->rfc8613_b_2 = oscore_conf->rfc8613_b_2;
  osc_ctx->save_seq_num_func = oscore_conf->save_seq_num_func;
  osc_ctx->save_seq_num_func_param = oscore_conf->save_seq_num_func_param;
 
  if (osc_ctx->master_secret) {
    /* sender_ key */
    if (oscore_conf->break_sender_key)
      /* Interop testing */
      sender_ctx->sender_key = oscore_build_key(osc_ctx,
                                                osc_ctx->master_salt,
                                                osc_ctx->master_secret,
                                                osc_ctx->aead_alg,
                                                oscore_conf->sender->sender_id,
                                                coap_make_str_const("BAD"),
                                                cose_key_len(osc_ctx->aead_alg));
    else
      sender_ctx->sender_key = oscore_build_key(osc_ctx,
                                                osc_ctx->master_salt,
                                                osc_ctx->master_secret,
                                                osc_ctx->aead_alg,
                                                oscore_conf->sender->sender_id,
                                                coap_make_str_const("Key"),
                                                cose_key_len(osc_ctx->aead_alg));
    if (!sender_ctx->sender_key)
      goto error;
 
    /* common IV */
    osc_ctx->common_iv = oscore_build_key(osc_ctx,
                                          osc_ctx->master_salt,
                                          osc_ctx->master_secret,
                                          osc_ctx->aead_alg,
                                          NULL,
                                          coap_make_str_const("IV"),
                                          cose_nonce_len(osc_ctx->aead_alg));
    if (!osc_ctx->common_iv)
      goto error;
 
  }
 
  /*
   * Need to set the last Sender Seq Num based on ssn_freq
   * The value should only change if there is a change to ssn_freq
   * and (potentially) be lower than seq, then save_seq_num_func() is
   * immediately called on next SSN update.
   */
  sender_ctx->next_seq = oscore_conf->start_seq_num -
                         (oscore_conf->start_seq_num % (oscore_conf->ssn_freq > 0 ? oscore_conf->ssn_freq : 1));
 
  sender_ctx->seq = oscore_conf->start_seq_num;
  if (oscore_conf->sender) {
    OSC_MOVE_PTR(sender_ctx->sender_id, oscore_conf->sender->sender_id);
    coap_free_type(COAP_STRING, oscore_conf->sender);
    oscore_conf->sender = NULL;
  }
 
  rcp_conf = oscore_conf->recipient_chain;
  ok = 1;
  while (rcp_conf) {
    coap_oscore_rcp_conf_t *rcp_next = rcp_conf->next_recipient;
 
    /* rcp_conf is released in oscore_add_recipient() */
    if (oscore_add_recipient(osc_ctx, rcp_conf,
                             oscore_conf->break_recipient_key) == NULL) {
      coap_log_warn("OSCORE: Failed to add Client ID\n");
      ok = 0;
    }
    rcp_conf = rcp_next;
  }
  oscore_conf->recipient_chain = NULL;
  if (!ok)
    goto error;
 
  oscore_log_context(osc_ctx, "Common context");
  return osc_ctx;
error:
  oscore_free_context(osc_ctx);
  return NULL;
}
 
int
oscore_add_context(coap_context_t *c_context, oscore_ctx_t *osc_ctx) {
  oscore_enter_context(c_context, osc_ctx);
  return 1;
}
 
int
oscore_is_context_attached(const oscore_ctx_t *osc_ctx) {
  return osc_ctx->next != NULL;
}
 
oscore_ctx_t *
oscore_derive_ctx(coap_context_t *c_context, coap_oscore_conf_t *oscore_conf) {
  oscore_ctx_t *osc_ctx = oscore_derive_ctx_from_conf(oscore_conf);
  oscore_enter_context(c_context, osc_ctx);
  return osc_ctx;
}
 
oscore_recipient_ctx_t *
oscore_add_recipient(oscore_ctx_t *osc_ctx, coap_oscore_rcp_conf_t *rcp_conf,
                     uint32_t break_key) {
  oscore_recipient_ctx_t *rcp_chain = osc_ctx->recipient_chain;
  oscore_recipient_ctx_t *rcp_ctx = NULL;
 
  if (rcp_conf->recipient_id->length > 7) {
    coap_log_warn("oscore_add_recipient: Maximum size of recipient_id is 7 bytes\n");
    goto free_rcp_conf;
  }
  /* Check this is not a duplicate recipient id */
  while (rcp_chain) {
    if (rcp_chain->recipient_id->length == rcp_conf->recipient_id->length &&
        memcmp(rcp_chain->recipient_id->s, rcp_conf->recipient_id->s,
               rcp_conf->recipient_id->length) == 0) {
      goto free_rcp_conf;
    }
    rcp_chain = rcp_chain->next_recipient;
  }
  rcp_ctx = (oscore_recipient_ctx_t *)coap_malloc_type(COAP_OSCORE_REC,
                                                       sizeof(oscore_recipient_ctx_t));
  if (rcp_ctx == NULL) {
    goto free_rcp_conf;
  }
  memset(rcp_ctx, 0, sizeof(oscore_recipient_ctx_t));
 
  if (osc_ctx->master_secret) {
    if (break_key)
      /* Interop testing */
      rcp_ctx->recipient_key = oscore_build_key(osc_ctx,
                                                osc_ctx->master_salt,
                                                osc_ctx->master_secret,
                                                osc_ctx->aead_alg,
                                                rcp_conf->recipient_id,
                                                coap_make_str_const("BAD"),
                                                cose_key_len(osc_ctx->aead_alg));
    else
      rcp_ctx->recipient_key = oscore_build_key(osc_ctx,
                                                osc_ctx->master_salt,
                                                osc_ctx->master_secret,
                                                osc_ctx->aead_alg,
                                                rcp_conf->recipient_id,
                                                coap_make_str_const("Key"),
                                                cose_key_len(osc_ctx->aead_alg));
    if (!rcp_ctx->recipient_key) {
      goto free_rcp_conf;
    }
  }
  rcp_ctx->silent_server = rcp_conf->silent_server;
  OSC_MOVE_PTR(rcp_ctx->recipient_id, rcp_conf->recipient_id);
  if (rcp_conf->window_initialized) {
    rcp_ctx->last_seq = rcp_conf->last_seq;
    rcp_ctx->sliding_window = rcp_conf->sliding_window;
  }
 
  rcp_ctx->initial_state = 1;
  rcp_ctx->osc_ctx = osc_ctx;
 
  rcp_chain = osc_ctx->recipient_chain;
  rcp_ctx->next_recipient = rcp_chain;
  osc_ctx->recipient_chain = rcp_ctx;
  oscore_reference_recipient_ctx(rcp_ctx);
  /* All configured values are now in rcp_ctx */
  coap_free_type(COAP_STRING, rcp_conf);
  return rcp_ctx;
 
free_rcp_conf:
  coap_free_type(COAP_OSCORE_REC, rcp_ctx);
  coap_delete_oscore_rcp_conf(rcp_conf);
  return NULL;
}
 
int
oscore_delete_recipient(oscore_ctx_t *osc_ctx, coap_bin_const_t *rid) {
  oscore_recipient_ctx_t *prev = NULL;
  oscore_recipient_ctx_t *next = osc_ctx->recipient_chain;
  while (next) {
    if (next->recipient_id->length == rid->length &&
        memcmp(next->recipient_id->s, rid->s, rid->length) == 0) {
      if (prev != NULL)
        prev->next_recipient = next->next_recipient;
      else
        osc_ctx->recipient_chain = next->next_recipient;
      oscore_free_recipient_ctx(next);
      return 1;
    }
    prev = next;
    next = next->next_recipient;
  }
  return 0;
}
 
void
oscore_reference_recipient_ctx(oscore_recipient_ctx_t *recipient_ctx) {
  recipient_ctx->ref++;
}
 
void
oscore_release_recipient_ctx(oscore_recipient_ctx_t **recipient_ctx) {
  oscore_ctx_t *osc_ctx;
 
  if (recipient_ctx == NULL || *recipient_ctx == NULL)
    return;
 
  /* ensure oscore context is freed if not attached to coap context */
  osc_ctx = (*recipient_ctx)->osc_ctx;
  oscore_free_recipient_ctx(*recipient_ctx);
  /*
   * Free temporary oscore context if not attached to a coap context
   * and no recipients attached anymore.
   */
  if (!oscore_is_context_attached(osc_ctx) && osc_ctx->recipient_chain == NULL) {
    oscore_free_context(osc_ctx);
  }
  *recipient_ctx = NULL;
}
 
void
oscore_free_association(oscore_association_t *association) {
  if (association) {
    oscore_release_recipient_ctx(&association->recipient_ctx);
 
    coap_delete_pdu_lkd(association->sent_pdu);
    coap_delete_bin_const(association->token);
    coap_delete_bin_const(association->aad);
    coap_delete_bin_const(association->nonce);
    coap_delete_bin_const(association->partial_iv);
    coap_delete_bin_const(association->obs_partial_iv);
    coap_free_type(COAP_STRING, association);
  }
}
 
int
oscore_new_association(coap_session_t *session,
                       coap_pdu_t *sent_pdu,
                       coap_bin_const_t *token,
                       oscore_recipient_ctx_t *recipient_ctx,
                       coap_bin_const_t *aad,
                       coap_bin_const_t *nonce,
                       coap_bin_const_t *partial_iv,
                       int is_observe) {
  oscore_association_t *association;
 
  association = coap_malloc_type(COAP_STRING, sizeof(oscore_association_t));
  if (association == NULL)
    return 0;
 
  coap_log_oscore("Association %p created\n", (void *)association);
  memset(association, 0, sizeof(oscore_association_t));
  coap_oscore_association_set_recipient_ctx(association, recipient_ctx);
  association->is_observe = is_observe;
  association->just_set_up = 1;
 
  if (sent_pdu) {
    size_t size;
    const uint8_t *data;
 
    association->sent_pdu = coap_pdu_duplicate_lkd(sent_pdu, session,
                                                   token->length, token->s,
                                                   NULL, COAP_BOOL_FALSE);
    if (association->sent_pdu == NULL)
      goto error;
    if (coap_get_data(sent_pdu, &size, &data)) {
      coap_add_data(association->sent_pdu, size, data);
    }
  }
  association->token = coap_new_bin_const(token->s, token->length);
  if (association->token == NULL)
    goto error;
 
  if (aad) {
    association->aad = coap_new_bin_const(aad->s, aad->length);
    if (association->aad == NULL)
      goto error;
  }
 
  if (nonce) {
    association->nonce = coap_new_bin_const(nonce->s, nonce->length);
    if (association->nonce == NULL)
      goto error;
  }
 
  if (partial_iv) {
    association->partial_iv =
        coap_new_bin_const(partial_iv->s, partial_iv->length);
    if (association->partial_iv == NULL)
      goto error;
  }
 
  OSCORE_ASSOCIATIONS_ADD(session->associations, association);
  return 1;
 
error:
  oscore_free_association(association);
  return 0;
}
 
oscore_association_t *
oscore_find_association(coap_session_t *session, coap_bin_const_t *token) {
  oscore_association_t *association;
 
  OSCORE_ASSOCIATIONS_FIND(session->associations, token, association);
  return association;
}
 
int
oscore_delete_association(coap_session_t *session,
                          oscore_association_t *association) {
  if (association) {
    OSCORE_ASSOCIATIONS_DELETE(session->associations, association);
    coap_log_oscore("Association %p deleted\n", (void *)association);
    oscore_free_association(association);
    return 1;
  }
  return 0;
}
 
void
oscore_delete_server_associations(coap_session_t *session) {
  if (session) {
    oscore_association_t *association;
    oscore_association_t *tmp;
 
    OSCORE_ASSOCIATIONS_ITER_SAFE(session->associations, association, tmp) {
      OSCORE_ASSOCIATIONS_DELETE(session->associations, association);
      coap_log_oscore("Association %p deleted\n", (void *)association);
      oscore_free_association(association);
    }
    session->associations = NULL;
  }
}
 
#else /* ! COAP_OSCORE_SUPPORT */
 
#ifdef __clang__
/* Make compilers happy that do not like empty modules. As this function is
 * never used, we ignore -Wunused-function at the end of compiling this file
 */
#pragma GCC diagnostic ignored "-Wunused-function"
#endif
static inline void
dummy(void) {
}
 
#endif /* ! COAP_OSCORE_SUPPORT */