Productize / nRF51822

library for BLE_GAP_backpack

Dependencies:   nrf51-sdk

Fork of nRF51822 by Nordic Semiconductor

source/btle/btle_security.cpp@597:bcd5e287c494, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 10:19:35 2016 +0000
Revision:
597:bcd5e287c494
Parent:
575:7023a8204a1b
Child:
598:814c1ce92947
Synchronized with git rev 0f76db4e

Author: Andres Amaya Garcia

Add helper function to get whitelist from SD bond table

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 541:884f95bf5351 1 /* mbed Microcontroller Library
vcoubard 541:884f95bf5351 2 * Copyright (c) 2006-2013 ARM Limited
vcoubard 541:884f95bf5351 3 *
vcoubard 541:884f95bf5351 4 * Licensed under the Apache License, Version 2.0 (the "License");
vcoubard 541:884f95bf5351 5 * you may not use this file except in compliance with the License.
vcoubard 541:884f95bf5351 6 * You may obtain a copy of the License at
vcoubard 541:884f95bf5351 7 *
vcoubard 541:884f95bf5351 8 * http://www.apache.org/licenses/LICENSE-2.0
vcoubard 541:884f95bf5351 9 *
vcoubard 541:884f95bf5351 10 * Unless required by applicable law or agreed to in writing, software
vcoubard 541:884f95bf5351 11 * distributed under the License is distributed on an "AS IS" BASIS,
vcoubard 541:884f95bf5351 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vcoubard 541:884f95bf5351 13 * See the License for the specific language governing permissions and
vcoubard 541:884f95bf5351 14 * limitations under the License.
vcoubard 541:884f95bf5351 15 */
vcoubard 541:884f95bf5351 16
vcoubard 541:884f95bf5351 17 #include "btle.h"
vcoubard 541:884f95bf5351 18
vcoubard 575:7023a8204a1b 19 #include "nRF5xn.h"
vcoubard 541:884f95bf5351 20
vcoubard 549:3f782c64d014 21 extern "C" {
vcoubard 549:3f782c64d014 22 #include "pstorage.h"
vcoubard 541:884f95bf5351 23 #include "device_manager.h"
vcoubard 549:3f782c64d014 24 }
vcoubard 549:3f782c64d014 25
vcoubard 541:884f95bf5351 26 #include "btle_security.h"
vcoubard 541:884f95bf5351 27
vcoubard 541:884f95bf5351 28 static dm_application_instance_t applicationInstance;
vcoubard 541:884f95bf5351 29 static ret_code_t dm_handler(dm_handle_t const *p_handle, dm_event_t const *p_event, ret_code_t event_result);
vcoubard 541:884f95bf5351 30
vcoubard 558:c4b56f9d6f3b 31 // default security parameters
vcoubard 558:c4b56f9d6f3b 32 static ble_gap_sec_params_t securityParameters = {
vcoubard 558:c4b56f9d6f3b 33 .bond = true, /**< Perform bonding. */
vcoubard 558:c4b56f9d6f3b 34 .mitm = true, /**< Man In The Middle protection required. */
vcoubard 558:c4b56f9d6f3b 35 .io_caps = SecurityManager::IO_CAPS_NONE, /**< IO capabilities, see @ref BLE_GAP_IO_CAPS. */
vcoubard 558:c4b56f9d6f3b 36 .oob = 0, /**< Out Of Band data available. */
vcoubard 558:c4b56f9d6f3b 37 .min_key_size = 16, /**< Minimum encryption key size in octets between 7 and 16. If 0 then not applicable in this instance. */
vcoubard 558:c4b56f9d6f3b 38 .max_key_size = 16, /**< Maximum encryption key size in octets between min_key_size and 16. */
vcoubard 558:c4b56f9d6f3b 39 .kdist_periph = {
vcoubard 558:c4b56f9d6f3b 40 .enc = 1, /**< Long Term Key and Master Identification. */
vcoubard 558:c4b56f9d6f3b 41 .id = 1, /**< Identity Resolving Key and Identity Address Information. */
vcoubard 558:c4b56f9d6f3b 42 .sign = 1, /**< Connection Signature Resolving Key. */
vcoubard 558:c4b56f9d6f3b 43 }, /**< Key distribution bitmap: keys that the peripheral device will distribute. */
vcoubard 558:c4b56f9d6f3b 44 };
vcoubard 558:c4b56f9d6f3b 45
vcoubard 597:bcd5e287c494 46 ble_error_t btle_createWhitelistFromBonds(ble_gap_whitelist_t *p_whitelist)
vcoubard 597:bcd5e287c494 47 {
vcoubard 597:bcd5e287c494 48 ret_code_t err = dm_whitelist_create(&applicationInstance, p_whitelist);
vcoubard 597:bcd5e287c494 49 if (err == NRF_SUCCESS) {
vcoubard 597:bcd5e287c494 50 return BLE_ERROR_NONE;
vcoubard 597:bcd5e287c494 51 } else if (err == NRF_ERROR_NULL) {
vcoubard 597:bcd5e287c494 52 return BLE_ERROR_PARAM_OUT_OF_RANGE;
vcoubard 597:bcd5e287c494 53 } else {
vcoubard 597:bcd5e287c494 54 return BLE_ERROR_INVALID_STATE;
vcoubard 597:bcd5e287c494 55 }
vcoubard 597:bcd5e287c494 56 }
vcoubard 597:bcd5e287c494 57
vcoubard 541:884f95bf5351 58 ble_error_t
vcoubard 541:884f95bf5351 59 btle_initializeSecurity(bool enableBonding,
vcoubard 541:884f95bf5351 60 bool requireMITM,
vcoubard 541:884f95bf5351 61 SecurityManager::SecurityIOCapabilities_t iocaps,
vcoubard 541:884f95bf5351 62 const SecurityManager::Passkey_t passkey)
vcoubard 541:884f95bf5351 63 {
vcoubard 541:884f95bf5351 64 /* guard against multiple initializations */
vcoubard 541:884f95bf5351 65 static bool initialized = false;
vcoubard 541:884f95bf5351 66 if (initialized) {
vcoubard 541:884f95bf5351 67 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 68 }
vcoubard 541:884f95bf5351 69
vcoubard 541:884f95bf5351 70 if (pstorage_init() != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 71 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 72 }
vcoubard 541:884f95bf5351 73
vcoubard 541:884f95bf5351 74 ret_code_t rc;
vcoubard 541:884f95bf5351 75 if (passkey) {
vcoubard 541:884f95bf5351 76 ble_opt_t opts;
vcoubard 541:884f95bf5351 77 opts.gap_opt.passkey.p_passkey = const_cast<uint8_t *>(passkey);
vcoubard 541:884f95bf5351 78 if ((rc = sd_ble_opt_set(BLE_GAP_OPT_PASSKEY, &opts)) != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 79 switch (rc) {
vcoubard 541:884f95bf5351 80 case BLE_ERROR_INVALID_CONN_HANDLE:
vcoubard 541:884f95bf5351 81 case NRF_ERROR_INVALID_ADDR:
vcoubard 541:884f95bf5351 82 case NRF_ERROR_INVALID_PARAM:
vcoubard 541:884f95bf5351 83 default:
vcoubard 541:884f95bf5351 84 return BLE_ERROR_INVALID_PARAM;
vcoubard 541:884f95bf5351 85 case NRF_ERROR_INVALID_STATE:
vcoubard 541:884f95bf5351 86 return BLE_ERROR_INVALID_STATE;
vcoubard 541:884f95bf5351 87 case NRF_ERROR_BUSY:
vcoubard 541:884f95bf5351 88 return BLE_STACK_BUSY;
vcoubard 541:884f95bf5351 89 }
vcoubard 541:884f95bf5351 90 }
vcoubard 541:884f95bf5351 91 }
vcoubard 541:884f95bf5351 92
vcoubard 541:884f95bf5351 93 dm_init_param_t dm_init_param = {
vcoubard 541:884f95bf5351 94 .clear_persistent_data = false /* Set to true in case the module should clear all persistent data. */
vcoubard 541:884f95bf5351 95 };
vcoubard 541:884f95bf5351 96 if (dm_init(&dm_init_param) != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 97 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 98 }
vcoubard 541:884f95bf5351 99
vcoubard 558:c4b56f9d6f3b 100 // update default security parameters with function call parameters
vcoubard 558:c4b56f9d6f3b 101 securityParameters.bond = enableBonding;
vcoubard 558:c4b56f9d6f3b 102 securityParameters.mitm = requireMITM;
vcoubard 558:c4b56f9d6f3b 103 securityParameters.io_caps = iocaps;
vcoubard 558:c4b56f9d6f3b 104
vcoubard 541:884f95bf5351 105 const dm_application_param_t dm_param = {
vcoubard 541:884f95bf5351 106 .evt_handler = dm_handler,
vcoubard 541:884f95bf5351 107 .service_type = DM_PROTOCOL_CNTXT_GATT_CLI_ID,
vcoubard 558:c4b56f9d6f3b 108 .sec_param = securityParameters
vcoubard 541:884f95bf5351 109 };
vcoubard 541:884f95bf5351 110
vcoubard 541:884f95bf5351 111 if ((rc = dm_register(&applicationInstance, &dm_param)) != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 112 switch (rc) {
vcoubard 541:884f95bf5351 113 case NRF_ERROR_INVALID_STATE:
vcoubard 541:884f95bf5351 114 return BLE_ERROR_INVALID_STATE;
vcoubard 541:884f95bf5351 115 case NRF_ERROR_NO_MEM:
vcoubard 541:884f95bf5351 116 return BLE_ERROR_NO_MEM;
vcoubard 541:884f95bf5351 117 default:
vcoubard 541:884f95bf5351 118 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 119 }
vcoubard 541:884f95bf5351 120 }
vcoubard 541:884f95bf5351 121
vcoubard 541:884f95bf5351 122 initialized = true;
vcoubard 541:884f95bf5351 123 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 124 }
vcoubard 541:884f95bf5351 125
vcoubard 541:884f95bf5351 126 ble_error_t
vcoubard 541:884f95bf5351 127 btle_purgeAllBondingState(void)
vcoubard 541:884f95bf5351 128 {
vcoubard 541:884f95bf5351 129 ret_code_t rc;
vcoubard 541:884f95bf5351 130 if ((rc = dm_device_delete_all(&applicationInstance)) == NRF_SUCCESS) {
vcoubard 541:884f95bf5351 131 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 132 }
vcoubard 541:884f95bf5351 133
vcoubard 541:884f95bf5351 134 switch (rc) {
vcoubard 541:884f95bf5351 135 case NRF_ERROR_INVALID_STATE:
vcoubard 541:884f95bf5351 136 return BLE_ERROR_INVALID_STATE;
vcoubard 541:884f95bf5351 137 case NRF_ERROR_NO_MEM:
vcoubard 541:884f95bf5351 138 return BLE_ERROR_NO_MEM;
vcoubard 541:884f95bf5351 139 default:
vcoubard 541:884f95bf5351 140 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 141 }
vcoubard 541:884f95bf5351 142 }
vcoubard 541:884f95bf5351 143
vcoubard 541:884f95bf5351 144 ble_error_t
vcoubard 541:884f95bf5351 145 btle_getLinkSecurity(Gap::Handle_t connectionHandle, SecurityManager::LinkSecurityStatus_t *securityStatusP)
vcoubard 541:884f95bf5351 146 {
vcoubard 541:884f95bf5351 147 ret_code_t rc;
vcoubard 541:884f95bf5351 148 dm_handle_t dmHandle = {
vcoubard 541:884f95bf5351 149 .appl_id = applicationInstance,
vcoubard 541:884f95bf5351 150 };
vcoubard 541:884f95bf5351 151 if ((rc = dm_handle_get(connectionHandle, &dmHandle)) != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 152 if (rc == NRF_ERROR_NOT_FOUND) {
vcoubard 541:884f95bf5351 153 return BLE_ERROR_INVALID_PARAM;
vcoubard 541:884f95bf5351 154 } else {
vcoubard 541:884f95bf5351 155 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 156 }
vcoubard 541:884f95bf5351 157 }
vcoubard 541:884f95bf5351 158
vcoubard 541:884f95bf5351 159 if ((rc = dm_security_status_req(&dmHandle, reinterpret_cast<dm_security_status_t *>(securityStatusP))) != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 160 switch (rc) {
vcoubard 541:884f95bf5351 161 case NRF_ERROR_INVALID_STATE:
vcoubard 541:884f95bf5351 162 return BLE_ERROR_INVALID_STATE;
vcoubard 541:884f95bf5351 163 case NRF_ERROR_NO_MEM:
vcoubard 541:884f95bf5351 164 return BLE_ERROR_NO_MEM;
vcoubard 541:884f95bf5351 165 default:
vcoubard 541:884f95bf5351 166 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 167 }
vcoubard 541:884f95bf5351 168 }
vcoubard 541:884f95bf5351 169
vcoubard 541:884f95bf5351 170 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 171 }
vcoubard 541:884f95bf5351 172
vcoubard 558:c4b56f9d6f3b 173 ble_error_t
vcoubard 558:c4b56f9d6f3b 174 btle_setLinkSecurity(Gap::Handle_t connectionHandle, SecurityManager::SecurityMode_t securityMode)
vcoubard 558:c4b56f9d6f3b 175 {
vcoubard 558:c4b56f9d6f3b 176 // use default and updated parameters as starting point
vcoubard 558:c4b56f9d6f3b 177 // and modify structure based on security mode.
vcoubard 558:c4b56f9d6f3b 178 ble_gap_sec_params_t params = securityParameters;
vcoubard 558:c4b56f9d6f3b 179
vcoubard 558:c4b56f9d6f3b 180 switch (securityMode) {
vcoubard 558:c4b56f9d6f3b 181 case SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK:
vcoubard 558:c4b56f9d6f3b 182 /**< Require no protection, open link. */
vcoubard 558:c4b56f9d6f3b 183 securityParameters.bond = false;
vcoubard 558:c4b56f9d6f3b 184 securityParameters.mitm = false;
vcoubard 558:c4b56f9d6f3b 185 break;
vcoubard 558:c4b56f9d6f3b 186
vcoubard 558:c4b56f9d6f3b 187 case SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM:
vcoubard 558:c4b56f9d6f3b 188 /**< Require encryption, but no MITM protection. */
vcoubard 558:c4b56f9d6f3b 189 securityParameters.bond = true;
vcoubard 558:c4b56f9d6f3b 190 securityParameters.mitm = false;
vcoubard 558:c4b56f9d6f3b 191 break;
vcoubard 558:c4b56f9d6f3b 192
vcoubard 558:c4b56f9d6f3b 193 // not yet implemented security modes
vcoubard 558:c4b56f9d6f3b 194 case SecurityManager::SECURITY_MODE_NO_ACCESS:
vcoubard 558:c4b56f9d6f3b 195 case SecurityManager::SECURITY_MODE_ENCRYPTION_WITH_MITM:
vcoubard 558:c4b56f9d6f3b 196 /**< Require encryption and MITM protection. */
vcoubard 558:c4b56f9d6f3b 197 case SecurityManager::SECURITY_MODE_SIGNED_NO_MITM:
vcoubard 558:c4b56f9d6f3b 198 /**< Require signing or encryption, but no MITM protection. */
vcoubard 558:c4b56f9d6f3b 199 case SecurityManager::SECURITY_MODE_SIGNED_WITH_MITM:
vcoubard 558:c4b56f9d6f3b 200 /**< Require signing or encryption, and MITM protection. */
vcoubard 558:c4b56f9d6f3b 201 default:
vcoubard 558:c4b56f9d6f3b 202 return BLE_ERROR_NOT_IMPLEMENTED;
vcoubard 558:c4b56f9d6f3b 203 }
vcoubard 558:c4b56f9d6f3b 204
vcoubard 558:c4b56f9d6f3b 205 // update security settings for given connection
vcoubard 558:c4b56f9d6f3b 206 uint32_t result = sd_ble_gap_authenticate(connectionHandle, &params);
vcoubard 558:c4b56f9d6f3b 207
vcoubard 558:c4b56f9d6f3b 208 if (result == NRF_SUCCESS) {
vcoubard 558:c4b56f9d6f3b 209 return BLE_ERROR_NONE;
vcoubard 558:c4b56f9d6f3b 210 } else {
vcoubard 558:c4b56f9d6f3b 211 return BLE_ERROR_UNSPECIFIED;
vcoubard 558:c4b56f9d6f3b 212 }
vcoubard 558:c4b56f9d6f3b 213 }
vcoubard 558:c4b56f9d6f3b 214
vcoubard 541:884f95bf5351 215 ret_code_t
vcoubard 541:884f95bf5351 216 dm_handler(dm_handle_t const *p_handle, dm_event_t const *p_event, ret_code_t event_result)
vcoubard 541:884f95bf5351 217 {
vcoubard 575:7023a8204a1b 218 nRF5xn &ble = nRF5xn::Instance(BLE::DEFAULT_INSTANCE);
vcoubard 575:7023a8204a1b 219 nRF5xSecurityManager &securityManager = (nRF5xSecurityManager &) ble.getSecurityManager();
vcoubard 575:7023a8204a1b 220
vcoubard 541:884f95bf5351 221 switch (p_event->event_id) {
vcoubard 541:884f95bf5351 222 case DM_EVT_SECURITY_SETUP: /* started */ {
vcoubard 541:884f95bf5351 223 const ble_gap_sec_params_t *peerParams = &p_event->event_param.p_gap_param->params.sec_params_request.peer_params;
vcoubard 575:7023a8204a1b 224 securityManager.processSecuritySetupInitiatedEvent(p_event->event_param.p_gap_param->conn_handle,
vcoubard 541:884f95bf5351 225 peerParams->bond,
vcoubard 541:884f95bf5351 226 peerParams->mitm,
vcoubard 541:884f95bf5351 227 (SecurityManager::SecurityIOCapabilities_t)peerParams->io_caps);
vcoubard 541:884f95bf5351 228 break;
vcoubard 541:884f95bf5351 229 }
vcoubard 541:884f95bf5351 230 case DM_EVT_SECURITY_SETUP_COMPLETE:
vcoubard 575:7023a8204a1b 231 securityManager.
vcoubard 541:884f95bf5351 232 processSecuritySetupCompletedEvent(p_event->event_param.p_gap_param->conn_handle,
vcoubard 541:884f95bf5351 233 (SecurityManager::SecurityCompletionStatus_t)(p_event->event_param.p_gap_param->params.auth_status.auth_status));
vcoubard 541:884f95bf5351 234 break;
vcoubard 541:884f95bf5351 235 case DM_EVT_LINK_SECURED: {
vcoubard 541:884f95bf5351 236 unsigned securityMode = p_event->event_param.p_gap_param->params.conn_sec_update.conn_sec.sec_mode.sm;
vcoubard 541:884f95bf5351 237 unsigned level = p_event->event_param.p_gap_param->params.conn_sec_update.conn_sec.sec_mode.lv;
vcoubard 541:884f95bf5351 238 SecurityManager::SecurityMode_t resolvedSecurityMode = SecurityManager::SECURITY_MODE_NO_ACCESS;
vcoubard 541:884f95bf5351 239 switch (securityMode) {
vcoubard 541:884f95bf5351 240 case 1:
vcoubard 541:884f95bf5351 241 switch (level) {
vcoubard 541:884f95bf5351 242 case 1:
vcoubard 541:884f95bf5351 243 resolvedSecurityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK;
vcoubard 541:884f95bf5351 244 break;
vcoubard 541:884f95bf5351 245 case 2:
vcoubard 541:884f95bf5351 246 resolvedSecurityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM;
vcoubard 541:884f95bf5351 247 break;
vcoubard 541:884f95bf5351 248 case 3:
vcoubard 541:884f95bf5351 249 resolvedSecurityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_WITH_MITM;
vcoubard 541:884f95bf5351 250 break;
vcoubard 541:884f95bf5351 251 }
vcoubard 541:884f95bf5351 252 break;
vcoubard 541:884f95bf5351 253 case 2:
vcoubard 541:884f95bf5351 254 switch (level) {
vcoubard 541:884f95bf5351 255 case 1:
vcoubard 541:884f95bf5351 256 resolvedSecurityMode = SecurityManager::SECURITY_MODE_SIGNED_NO_MITM;
vcoubard 541:884f95bf5351 257 break;
vcoubard 541:884f95bf5351 258 case 2:
vcoubard 541:884f95bf5351 259 resolvedSecurityMode = SecurityManager::SECURITY_MODE_SIGNED_WITH_MITM;
vcoubard 541:884f95bf5351 260 break;
vcoubard 541:884f95bf5351 261 }
vcoubard 541:884f95bf5351 262 break;
vcoubard 541:884f95bf5351 263 }
vcoubard 541:884f95bf5351 264
vcoubard 575:7023a8204a1b 265 securityManager.processLinkSecuredEvent(p_event->event_param.p_gap_param->conn_handle, resolvedSecurityMode);
vcoubard 541:884f95bf5351 266 break;
vcoubard 541:884f95bf5351 267 }
vcoubard 541:884f95bf5351 268 case DM_EVT_DEVICE_CONTEXT_STORED:
vcoubard 575:7023a8204a1b 269 securityManager.processSecurityContextStoredEvent(p_event->event_param.p_gap_param->conn_handle);
vcoubard 541:884f95bf5351 270 break;
vcoubard 541:884f95bf5351 271 default:
vcoubard 541:884f95bf5351 272 break;
vcoubard 541:884f95bf5351 273 }
vcoubard 541:884f95bf5351 274
vcoubard 541:884f95bf5351 275 return NRF_SUCCESS;
rgrover1 133:74079098b3c9 276 }