nordic
Fork of nRF51822 by
source/btle/btle_security.cpp@542:884f95bf5351, 2016-01-11 (annotated)
- Committer:
- vcoubard
- Date:
- Mon Jan 11 10:19:02 2016 +0000
- Revision:
- 542:884f95bf5351
- Parent:
- 526:d76f1c3f4599
- Child:
- 550:3f782c64d014
Synchronized with git rev 60a7c0c0
Author: Rohit Grover
bring in the latest changes for BLE::init() where we allow <object, member> tuples for init callback.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
vcoubard | 542:884f95bf5351 | 1 | /* mbed Microcontroller Library |
vcoubard | 542:884f95bf5351 | 2 | * Copyright (c) 2006-2013 ARM Limited |
vcoubard | 542:884f95bf5351 | 3 | * |
vcoubard | 542:884f95bf5351 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
vcoubard | 542:884f95bf5351 | 5 | * you may not use this file except in compliance with the License. |
vcoubard | 542:884f95bf5351 | 6 | * You may obtain a copy of the License at |
vcoubard | 542:884f95bf5351 | 7 | * |
vcoubard | 542:884f95bf5351 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
vcoubard | 542:884f95bf5351 | 9 | * |
vcoubard | 542:884f95bf5351 | 10 | * Unless required by applicable law or agreed to in writing, software |
vcoubard | 542:884f95bf5351 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
vcoubard | 542:884f95bf5351 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
vcoubard | 542:884f95bf5351 | 13 | * See the License for the specific language governing permissions and |
vcoubard | 542:884f95bf5351 | 14 | * limitations under the License. |
vcoubard | 542:884f95bf5351 | 15 | */ |
vcoubard | 542:884f95bf5351 | 16 | |
vcoubard | 542:884f95bf5351 | 17 | #include "btle.h" |
vcoubard | 542:884f95bf5351 | 18 | #include "pstorage.h" |
vcoubard | 542:884f95bf5351 | 19 | |
vcoubard | 542:884f95bf5351 | 20 | #include "nRF5xGap.h" |
vcoubard | 542:884f95bf5351 | 21 | #include "nRF5xSecurityManager.h" |
vcoubard | 542:884f95bf5351 | 22 | |
vcoubard | 542:884f95bf5351 | 23 | #include "device_manager.h" |
vcoubard | 542:884f95bf5351 | 24 | #include "btle_security.h" |
vcoubard | 542:884f95bf5351 | 25 | |
vcoubard | 542:884f95bf5351 | 26 | static dm_application_instance_t applicationInstance; |
vcoubard | 542:884f95bf5351 | 27 | static ret_code_t dm_handler(dm_handle_t const *p_handle, dm_event_t const *p_event, ret_code_t event_result); |
vcoubard | 542:884f95bf5351 | 28 | |
vcoubard | 542:884f95bf5351 | 29 | ble_error_t |
vcoubard | 542:884f95bf5351 | 30 | btle_initializeSecurity(bool enableBonding, |
vcoubard | 542:884f95bf5351 | 31 | bool requireMITM, |
vcoubard | 542:884f95bf5351 | 32 | SecurityManager::SecurityIOCapabilities_t iocaps, |
vcoubard | 542:884f95bf5351 | 33 | const SecurityManager::Passkey_t passkey) |
vcoubard | 542:884f95bf5351 | 34 | { |
vcoubard | 542:884f95bf5351 | 35 | /* guard against multiple initializations */ |
vcoubard | 542:884f95bf5351 | 36 | static bool initialized = false; |
vcoubard | 542:884f95bf5351 | 37 | if (initialized) { |
vcoubard | 542:884f95bf5351 | 38 | return BLE_ERROR_NONE; |
vcoubard | 542:884f95bf5351 | 39 | } |
vcoubard | 542:884f95bf5351 | 40 | |
vcoubard | 542:884f95bf5351 | 41 | if (pstorage_init() != NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 42 | return BLE_ERROR_UNSPECIFIED; |
vcoubard | 542:884f95bf5351 | 43 | } |
vcoubard | 542:884f95bf5351 | 44 | |
vcoubard | 542:884f95bf5351 | 45 | ret_code_t rc; |
vcoubard | 542:884f95bf5351 | 46 | if (passkey) { |
vcoubard | 542:884f95bf5351 | 47 | ble_opt_t opts; |
vcoubard | 542:884f95bf5351 | 48 | opts.gap_opt.passkey.p_passkey = const_cast<uint8_t *>(passkey); |
vcoubard | 542:884f95bf5351 | 49 | if ((rc = sd_ble_opt_set(BLE_GAP_OPT_PASSKEY, &opts)) != NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 50 | switch (rc) { |
vcoubard | 542:884f95bf5351 | 51 | case BLE_ERROR_INVALID_CONN_HANDLE: |
vcoubard | 542:884f95bf5351 | 52 | case NRF_ERROR_INVALID_ADDR: |
vcoubard | 542:884f95bf5351 | 53 | case NRF_ERROR_INVALID_PARAM: |
vcoubard | 542:884f95bf5351 | 54 | default: |
vcoubard | 542:884f95bf5351 | 55 | return BLE_ERROR_INVALID_PARAM; |
vcoubard | 542:884f95bf5351 | 56 | case NRF_ERROR_INVALID_STATE: |
vcoubard | 542:884f95bf5351 | 57 | return BLE_ERROR_INVALID_STATE; |
vcoubard | 542:884f95bf5351 | 58 | case NRF_ERROR_BUSY: |
vcoubard | 542:884f95bf5351 | 59 | return BLE_STACK_BUSY; |
vcoubard | 542:884f95bf5351 | 60 | } |
vcoubard | 542:884f95bf5351 | 61 | } |
vcoubard | 542:884f95bf5351 | 62 | } |
vcoubard | 542:884f95bf5351 | 63 | |
vcoubard | 542:884f95bf5351 | 64 | dm_init_param_t dm_init_param = { |
vcoubard | 542:884f95bf5351 | 65 | .clear_persistent_data = false /* Set to true in case the module should clear all persistent data. */ |
vcoubard | 542:884f95bf5351 | 66 | }; |
vcoubard | 542:884f95bf5351 | 67 | if (dm_init(&dm_init_param) != NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 68 | return BLE_ERROR_UNSPECIFIED; |
vcoubard | 542:884f95bf5351 | 69 | } |
vcoubard | 542:884f95bf5351 | 70 | |
vcoubard | 542:884f95bf5351 | 71 | const dm_application_param_t dm_param = { |
vcoubard | 542:884f95bf5351 | 72 | .evt_handler = dm_handler, |
vcoubard | 542:884f95bf5351 | 73 | .service_type = DM_PROTOCOL_CNTXT_GATT_CLI_ID, |
vcoubard | 542:884f95bf5351 | 74 | .sec_param = { |
vcoubard | 542:884f95bf5351 | 75 | .bond = enableBonding,/**< Perform bonding. */ |
vcoubard | 542:884f95bf5351 | 76 | .mitm = requireMITM, /**< Man In The Middle protection required. */ |
vcoubard | 542:884f95bf5351 | 77 | .io_caps = iocaps, /**< IO capabilities, see @ref BLE_GAP_IO_CAPS. */ |
vcoubard | 542:884f95bf5351 | 78 | .oob = 0, /**< Out Of Band data available. */ |
vcoubard | 542:884f95bf5351 | 79 | .min_key_size = 16, /**< Minimum encryption key size in octets between 7 and 16. If 0 then not applicable in this instance. */ |
vcoubard | 542:884f95bf5351 | 80 | .max_key_size = 16, /**< Maximum encryption key size in octets between min_key_size and 16. */ |
vcoubard | 542:884f95bf5351 | 81 | .kdist_periph = { |
vcoubard | 542:884f95bf5351 | 82 | .enc = 1, /**< Long Term Key and Master Identification. */ |
vcoubard | 542:884f95bf5351 | 83 | .id = 1, /**< Identity Resolving Key and Identity Address Information. */ |
vcoubard | 542:884f95bf5351 | 84 | .sign = 1, /**< Connection Signature Resolving Key. */ |
vcoubard | 542:884f95bf5351 | 85 | }, /**< Key distribution bitmap: keys that the peripheral device will distribute. */ |
vcoubard | 542:884f95bf5351 | 86 | } |
vcoubard | 542:884f95bf5351 | 87 | }; |
vcoubard | 542:884f95bf5351 | 88 | |
vcoubard | 542:884f95bf5351 | 89 | if ((rc = dm_register(&applicationInstance, &dm_param)) != NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 90 | switch (rc) { |
vcoubard | 542:884f95bf5351 | 91 | case NRF_ERROR_INVALID_STATE: |
vcoubard | 542:884f95bf5351 | 92 | return BLE_ERROR_INVALID_STATE; |
vcoubard | 542:884f95bf5351 | 93 | case NRF_ERROR_NO_MEM: |
vcoubard | 542:884f95bf5351 | 94 | return BLE_ERROR_NO_MEM; |
vcoubard | 542:884f95bf5351 | 95 | default: |
vcoubard | 542:884f95bf5351 | 96 | return BLE_ERROR_UNSPECIFIED; |
vcoubard | 542:884f95bf5351 | 97 | } |
vcoubard | 542:884f95bf5351 | 98 | } |
vcoubard | 542:884f95bf5351 | 99 | |
vcoubard | 542:884f95bf5351 | 100 | initialized = true; |
vcoubard | 542:884f95bf5351 | 101 | return BLE_ERROR_NONE; |
vcoubard | 542:884f95bf5351 | 102 | } |
vcoubard | 542:884f95bf5351 | 103 | |
vcoubard | 542:884f95bf5351 | 104 | ble_error_t |
vcoubard | 542:884f95bf5351 | 105 | btle_purgeAllBondingState(void) |
vcoubard | 542:884f95bf5351 | 106 | { |
vcoubard | 542:884f95bf5351 | 107 | ret_code_t rc; |
vcoubard | 542:884f95bf5351 | 108 | if ((rc = dm_device_delete_all(&applicationInstance)) == NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 109 | return BLE_ERROR_NONE; |
vcoubard | 542:884f95bf5351 | 110 | } |
vcoubard | 542:884f95bf5351 | 111 | |
vcoubard | 542:884f95bf5351 | 112 | switch (rc) { |
vcoubard | 542:884f95bf5351 | 113 | case NRF_ERROR_INVALID_STATE: |
vcoubard | 542:884f95bf5351 | 114 | return BLE_ERROR_INVALID_STATE; |
vcoubard | 542:884f95bf5351 | 115 | case NRF_ERROR_NO_MEM: |
vcoubard | 542:884f95bf5351 | 116 | return BLE_ERROR_NO_MEM; |
vcoubard | 542:884f95bf5351 | 117 | default: |
vcoubard | 542:884f95bf5351 | 118 | return BLE_ERROR_UNSPECIFIED; |
vcoubard | 542:884f95bf5351 | 119 | } |
vcoubard | 542:884f95bf5351 | 120 | } |
vcoubard | 542:884f95bf5351 | 121 | |
vcoubard | 542:884f95bf5351 | 122 | ble_error_t |
vcoubard | 542:884f95bf5351 | 123 | btle_getLinkSecurity(Gap::Handle_t connectionHandle, SecurityManager::LinkSecurityStatus_t *securityStatusP) |
vcoubard | 542:884f95bf5351 | 124 | { |
vcoubard | 542:884f95bf5351 | 125 | ret_code_t rc; |
vcoubard | 542:884f95bf5351 | 126 | dm_handle_t dmHandle = { |
vcoubard | 542:884f95bf5351 | 127 | .appl_id = applicationInstance, |
vcoubard | 542:884f95bf5351 | 128 | }; |
vcoubard | 542:884f95bf5351 | 129 | if ((rc = dm_handle_get(connectionHandle, &dmHandle)) != NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 130 | if (rc == NRF_ERROR_NOT_FOUND) { |
vcoubard | 542:884f95bf5351 | 131 | return BLE_ERROR_INVALID_PARAM; |
vcoubard | 542:884f95bf5351 | 132 | } else { |
vcoubard | 542:884f95bf5351 | 133 | return BLE_ERROR_UNSPECIFIED; |
vcoubard | 542:884f95bf5351 | 134 | } |
vcoubard | 542:884f95bf5351 | 135 | } |
vcoubard | 542:884f95bf5351 | 136 | |
vcoubard | 542:884f95bf5351 | 137 | if ((rc = dm_security_status_req(&dmHandle, reinterpret_cast<dm_security_status_t *>(securityStatusP))) != NRF_SUCCESS) { |
vcoubard | 542:884f95bf5351 | 138 | switch (rc) { |
vcoubard | 542:884f95bf5351 | 139 | case NRF_ERROR_INVALID_STATE: |
vcoubard | 542:884f95bf5351 | 140 | return BLE_ERROR_INVALID_STATE; |
vcoubard | 542:884f95bf5351 | 141 | case NRF_ERROR_NO_MEM: |
vcoubard | 542:884f95bf5351 | 142 | return BLE_ERROR_NO_MEM; |
vcoubard | 542:884f95bf5351 | 143 | default: |
vcoubard | 542:884f95bf5351 | 144 | return BLE_ERROR_UNSPECIFIED; |
vcoubard | 542:884f95bf5351 | 145 | } |
vcoubard | 542:884f95bf5351 | 146 | } |
vcoubard | 542:884f95bf5351 | 147 | |
vcoubard | 542:884f95bf5351 | 148 | return BLE_ERROR_NONE; |
vcoubard | 542:884f95bf5351 | 149 | } |
vcoubard | 542:884f95bf5351 | 150 | |
vcoubard | 542:884f95bf5351 | 151 | ret_code_t |
vcoubard | 542:884f95bf5351 | 152 | dm_handler(dm_handle_t const *p_handle, dm_event_t const *p_event, ret_code_t event_result) |
vcoubard | 542:884f95bf5351 | 153 | { |
vcoubard | 542:884f95bf5351 | 154 | switch (p_event->event_id) { |
vcoubard | 542:884f95bf5351 | 155 | case DM_EVT_SECURITY_SETUP: /* started */ { |
vcoubard | 542:884f95bf5351 | 156 | const ble_gap_sec_params_t *peerParams = &p_event->event_param.p_gap_param->params.sec_params_request.peer_params; |
vcoubard | 542:884f95bf5351 | 157 | nRF5xSecurityManager::getInstance().processSecuritySetupInitiatedEvent(p_event->event_param.p_gap_param->conn_handle, |
vcoubard | 542:884f95bf5351 | 158 | peerParams->bond, |
vcoubard | 542:884f95bf5351 | 159 | peerParams->mitm, |
vcoubard | 542:884f95bf5351 | 160 | (SecurityManager::SecurityIOCapabilities_t)peerParams->io_caps); |
vcoubard | 542:884f95bf5351 | 161 | break; |
vcoubard | 542:884f95bf5351 | 162 | } |
vcoubard | 542:884f95bf5351 | 163 | case DM_EVT_SECURITY_SETUP_COMPLETE: |
vcoubard | 542:884f95bf5351 | 164 | nRF5xSecurityManager::getInstance(). |
vcoubard | 542:884f95bf5351 | 165 | processSecuritySetupCompletedEvent(p_event->event_param.p_gap_param->conn_handle, |
vcoubard | 542:884f95bf5351 | 166 | (SecurityManager::SecurityCompletionStatus_t)(p_event->event_param.p_gap_param->params.auth_status.auth_status)); |
vcoubard | 542:884f95bf5351 | 167 | break; |
vcoubard | 542:884f95bf5351 | 168 | case DM_EVT_LINK_SECURED: { |
vcoubard | 542:884f95bf5351 | 169 | unsigned securityMode = p_event->event_param.p_gap_param->params.conn_sec_update.conn_sec.sec_mode.sm; |
vcoubard | 542:884f95bf5351 | 170 | unsigned level = p_event->event_param.p_gap_param->params.conn_sec_update.conn_sec.sec_mode.lv; |
vcoubard | 542:884f95bf5351 | 171 | SecurityManager::SecurityMode_t resolvedSecurityMode = SecurityManager::SECURITY_MODE_NO_ACCESS; |
vcoubard | 542:884f95bf5351 | 172 | switch (securityMode) { |
vcoubard | 542:884f95bf5351 | 173 | case 1: |
vcoubard | 542:884f95bf5351 | 174 | switch (level) { |
vcoubard | 542:884f95bf5351 | 175 | case 1: |
vcoubard | 542:884f95bf5351 | 176 | resolvedSecurityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_OPEN_LINK; |
vcoubard | 542:884f95bf5351 | 177 | break; |
vcoubard | 542:884f95bf5351 | 178 | case 2: |
vcoubard | 542:884f95bf5351 | 179 | resolvedSecurityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_NO_MITM; |
vcoubard | 542:884f95bf5351 | 180 | break; |
vcoubard | 542:884f95bf5351 | 181 | case 3: |
vcoubard | 542:884f95bf5351 | 182 | resolvedSecurityMode = SecurityManager::SECURITY_MODE_ENCRYPTION_WITH_MITM; |
vcoubard | 542:884f95bf5351 | 183 | break; |
vcoubard | 542:884f95bf5351 | 184 | } |
vcoubard | 542:884f95bf5351 | 185 | break; |
vcoubard | 542:884f95bf5351 | 186 | case 2: |
vcoubard | 542:884f95bf5351 | 187 | switch (level) { |
vcoubard | 542:884f95bf5351 | 188 | case 1: |
vcoubard | 542:884f95bf5351 | 189 | resolvedSecurityMode = SecurityManager::SECURITY_MODE_SIGNED_NO_MITM; |
vcoubard | 542:884f95bf5351 | 190 | break; |
vcoubard | 542:884f95bf5351 | 191 | case 2: |
vcoubard | 542:884f95bf5351 | 192 | resolvedSecurityMode = SecurityManager::SECURITY_MODE_SIGNED_WITH_MITM; |
vcoubard | 542:884f95bf5351 | 193 | break; |
vcoubard | 542:884f95bf5351 | 194 | } |
vcoubard | 542:884f95bf5351 | 195 | break; |
vcoubard | 542:884f95bf5351 | 196 | } |
vcoubard | 542:884f95bf5351 | 197 | |
vcoubard | 542:884f95bf5351 | 198 | nRF5xSecurityManager::getInstance().processLinkSecuredEvent(p_event->event_param.p_gap_param->conn_handle, resolvedSecurityMode); |
vcoubard | 542:884f95bf5351 | 199 | break; |
vcoubard | 542:884f95bf5351 | 200 | } |
vcoubard | 542:884f95bf5351 | 201 | case DM_EVT_DEVICE_CONTEXT_STORED: |
vcoubard | 542:884f95bf5351 | 202 | nRF5xSecurityManager::getInstance().processSecurityContextStoredEvent(p_event->event_param.p_gap_param->conn_handle); |
vcoubard | 542:884f95bf5351 | 203 | break; |
vcoubard | 542:884f95bf5351 | 204 | default: |
vcoubard | 542:884f95bf5351 | 205 | break; |
vcoubard | 542:884f95bf5351 | 206 | } |
vcoubard | 542:884f95bf5351 | 207 | |
vcoubard | 542:884f95bf5351 | 208 | return NRF_SUCCESS; |
rgrover1 | 134:74079098b3c9 | 209 | } |