ble_store.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef H_BLE_STORE_
#define H_BLE_STORE_
 
#include <inttypes.h>
#include "nimble/nimble/include/nimble/ble.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BLE_STORE_OBJ_TYPE_OUR_SEC           1
#define BLE_STORE_OBJ_TYPE_PEER_SEC          2
#define BLE_STORE_OBJ_TYPE_CCCD              3
#define BLE_STORE_OBJ_TYPE_PEER_DEV_REC      4
 
#if MYNEWT_VAL(ENC_ADV_DATA)
#define BLE_STORE_OBJ_TYPE_ENC_ADV_DATA      5
#endif
#define BLE_STORE_OBJ_TYPE_PEER_ADDR         6
 
#define BLE_STORE_OBJ_TYPE_LOCAL_IRK        7
#define BLE_STORE_EVENT_OVERFLOW        1
 
#define BLE_STORE_EVENT_FULL            2
 
struct ble_store_key_sec {
    ble_addr_t peer_addr;
 
    uint16_t ediv;
 
    uint64_t rand_num;
 
    unsigned ediv_rand_present:1;
 
    uint8_t idx;
};
 
struct ble_store_value_sec {
    ble_addr_t peer_addr;
    uint16_t bond_count;
 
    uint8_t key_size;
    uint16_t ediv;
    uint64_t rand_num;
    uint8_t ltk[16];
    uint8_t ltk_present:1;
 
    uint8_t irk[16];
    uint8_t irk_present:1;
 
    uint8_t csrk[16];
    uint8_t csrk_present:1;
    uint32_t sign_counter;
 
    unsigned authenticated:1;
    uint8_t sc:1;
};
 
struct ble_store_key_cccd {
    ble_addr_t peer_addr;
 
    uint16_t chr_val_handle;
 
    uint8_t idx;
};
 
struct ble_store_value_cccd {
    ble_addr_t peer_addr;
    uint16_t chr_val_handle;
    uint16_t flags;
    unsigned value_changed:1;
};
 
#if MYNEWT_VAL(ENC_ADV_DATA)
struct ble_store_key_ead {
    ble_addr_t peer_addr;
 
    uint8_t idx;
};
 
struct ble_store_value_ead {
    ble_addr_t peer_addr;
    unsigned km_present:1;
    struct key_material *km;
};
#endif
 
struct ble_store_key_local_irk {
    ble_addr_t addr;
 
    uint8_t idx;
};
 
struct ble_store_value_local_irk {
     ble_addr_t addr;
 
     uint8_t irk[16];
};
 
struct ble_store_key_rpa_rec{
    ble_addr_t peer_rpa_addr;
    uint8_t idx;
};
struct ble_store_value_rpa_rec{
    ble_addr_t peer_rpa_addr;
    ble_addr_t peer_addr;
};
 
union ble_store_key {
    struct ble_store_key_sec sec;
    struct ble_store_key_cccd cccd;
#if MYNEWT_VAL(ENC_ADV_DATA)
    struct ble_store_key_ead ead;
#endif
    struct ble_store_key_rpa_rec rpa_rec;
    struct ble_store_key_local_irk local_irk;
};
 
union ble_store_value {
    struct ble_store_value_sec sec;
    struct ble_store_value_cccd cccd;
#if MYNEWT_VAL(ENC_ADV_DATA)
    struct ble_store_value_ead ead;
#endif
   struct ble_store_value_rpa_rec rpa_rec;
   struct ble_store_value_local_irk local_irk;
};
 
struct ble_store_status_event {
    int event_code;
 
    union {
        struct {
            int obj_type;
 
            const union ble_store_value *value;
        } overflow;
 
        struct {
            int obj_type;
 
            uint16_t conn_handle;
        } full;
    };
};
 
typedef int ble_store_read_fn(int obj_type, const union ble_store_key *key,
                              union ble_store_value *dst);
 
typedef int ble_store_write_fn(int obj_type, const union ble_store_value *val);
 
typedef int ble_store_delete_fn(int obj_type, const union ble_store_key *key);
 
typedef int ble_store_status_fn(struct ble_store_status_event *event,
                                void *arg);
 
int ble_store_read(int obj_type, const union ble_store_key *key,
                   union ble_store_value *val);
int ble_store_write(int obj_type, const union ble_store_value *val);
int ble_store_delete(int obj_type, const union ble_store_key *key);
int ble_store_overflow_event(int obj_type, const union ble_store_value *value);
int ble_store_full_event(int obj_type, uint16_t conn_handle);
 
int ble_store_read_our_sec(const struct ble_store_key_sec *key_sec,
                           struct ble_store_value_sec *value_sec);
int ble_store_write_our_sec(const struct ble_store_value_sec *value_sec);
int ble_store_delete_our_sec(const struct ble_store_key_sec *key_sec);
int ble_store_read_peer_sec(const struct ble_store_key_sec *key_sec,
                            struct ble_store_value_sec *value_sec);
int ble_store_write_peer_sec(const struct ble_store_value_sec *value_sec);
int ble_store_delete_peer_sec(const struct ble_store_key_sec *key_sec);
 
int ble_store_read_cccd(const struct ble_store_key_cccd *key,
                        struct ble_store_value_cccd *out_value);
int ble_store_write_cccd(const struct ble_store_value_cccd *value);
int ble_store_delete_cccd(const struct ble_store_key_cccd *key);
 
void ble_store_key_from_value_sec(struct ble_store_key_sec *out_key,
                                  const struct ble_store_value_sec *value);
void ble_store_key_from_value_cccd(struct ble_store_key_cccd *out_key,
                                   const struct ble_store_value_cccd *value);
#if MYNEWT_VAL(ENC_ADV_DATA)
int ble_store_read_ead(const struct ble_store_key_ead *key,
                       struct ble_store_value_ead *out_value);
int ble_store_write_ead(const struct ble_store_value_ead *value);
int ble_store_delete_ead(const struct ble_store_key_ead *key);
void ble_store_key_from_value_ead(struct ble_store_key_ead *out_key,
                                  const struct ble_store_value_ead *value);
#endif
/* irk store*/
int ble_store_read_local_irk(const struct ble_store_key_local_irk *key,
                       struct ble_store_value_local_irk *out_value);
int ble_store_write_local_irk(const struct ble_store_value_local_irk *value);
int ble_store_delete_local_irk(const struct ble_store_key_local_irk *key);
void ble_store_key_from_value_local_irk(struct ble_store_key_local_irk *out_key,
                                  const struct ble_store_value_local_irk *value);
 
/*irk store */
/* rpa mapping*/
int ble_store_read_rpa_rec(const struct ble_store_key_rpa_rec *key,
                       struct ble_store_value_rpa_rec *out_value);
int ble_store_write_rpa_rec(const struct ble_store_value_rpa_rec *value);
int ble_store_delete_rpa_rec(const struct ble_store_key_rpa_rec *key);
void ble_store_key_from_value_rpa_rec(struct ble_store_key_rpa_rec *out_key,
                                  const struct ble_store_value_rpa_rec *value);
/* rpa mapping*/
void ble_store_key_from_value(int obj_type,
                              union ble_store_key *out_key,
                              const union ble_store_value *value);
 
typedef int ble_store_iterator_fn(int obj_type,
                                  union ble_store_value *val,
                                  void *cookie);
 
int ble_store_iterate(int obj_type,
                      ble_store_iterator_fn *callback,
                      void *cookie);
 
int ble_store_clear(void);
 
/*** Utility functions. */
 
int ble_store_util_bonded_peers(ble_addr_t *out_peer_id_addrs,
                                int *out_num_peers,
                                int max_peers);
int ble_store_util_delete_all(int type, const union ble_store_key *key);
int ble_store_util_delete_peer(const ble_addr_t *peer_id_addr);
int ble_store_util_delete_oldest_peer(void);
int ble_store_util_count(int type, int *out_count);
int ble_store_util_status_rr(struct ble_store_status_event *event, void *arg);
 
#ifdef __cplusplus
}
#endif
 
#endif