nrf51822/source/nRF5xSecurityManager.h

93 lines
2.8 KiB
C
Raw Normal View History

2015-06-19 07:28:35 +00:00
/* mbed Microcontroller Library
* Copyright (c) 2006-2013 ARM Limited
*
* Licensed 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 __NRF51822_SECURITY_MANAGER_H__
#define __NRF51822_SECURITY_MANAGER_H__
#include <stddef.h>
#include "nRF5xGap.h"
#include "ble/SecurityManager.h"
2015-06-19 07:28:35 +00:00
#include "btle_security.h"
class nRF5xSecurityManager : public SecurityManager
2015-06-19 07:28:35 +00:00
{
public:
/* Functions that must be implemented from SecurityManager */
virtual ble_error_t init(bool enableBonding,
bool requireMITM,
SecurityIOCapabilities_t iocaps,
const Passkey_t passkey) {
return btle_initializeSecurity(enableBonding, requireMITM, iocaps, passkey);
}
virtual ble_error_t getLinkSecurity(Gap::Handle_t connectionHandle, LinkSecurityStatus_t *securityStatusP) {
return btle_getLinkSecurity(connectionHandle, securityStatusP);
}
virtual ble_error_t setLinkSecurity(Gap::Handle_t connectionHandle, SecurityMode_t securityMode) {
return btle_setLinkSecurity(connectionHandle, securityMode);
}
2015-06-19 07:28:35 +00:00
virtual ble_error_t purgeAllBondingState(void) {
return btle_purgeAllBondingState();
}
Improve shutdown to clear BLE API and not just SD Improve the shutdown functionality, such that a call to ble.shutdown() from the user application clears the API and nRF5x state and NOT only the SoftDevice. To achieve this the following changes are introduced: * Add a protected member cleanup() to nRF5xGap, nRF5xGattClient, nRF5xGattServer, nRF5xSecurityManager and nRF5xServiceDiscovery. * Modify the shutdown() implementation in nRF5xn such that it also calls the static member shutdown() exposed by the BLE API in Gap.h, SecurityManager.h, GattClient.h and GattServer.h. * Modify nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager classes so that they dynamically create their respective objects only if needed. Previously the GattClient, GattServer and SecurityManager objects were declared as static, which means that they were always present even though they were not always needed. This increases memory consumption unnecessarily. Furthermore, pointers to the object instances are stored in static members of the classes as specified by the BLE API base classes. This ensures that calls to shutdown do not require calls to getInstance() functions that would otherwise result in undesired memory allocations. * nRF5xGap object is always needed, so this remains allocated statically. But the reference in Gap is pointed to this object. The shutdown procedure is as follows: 1. The user calls ble.shutdown() which executes the code in nRF5xn::shutdown() 1. The SoftDevice is shutdown 1. The static members of Gap.h, SecurityManager.h, GattClient.h and GattServer.h are called to clean up their own state. If at any point an error occur during the last step, BLE_ERROR_INVALID_STATE is returned.
2015-12-11 17:37:58 +00:00
/**
* @brief Clear nRF5xSecurityManager's state.
*
* @return
* BLE_ERROR_NONE if successful.
*/
virtual ble_error_t reset(void)
Improve shutdown to clear BLE API and not just SD Improve the shutdown functionality, such that a call to ble.shutdown() from the user application clears the API and nRF5x state and NOT only the SoftDevice. To achieve this the following changes are introduced: * Add a protected member cleanup() to nRF5xGap, nRF5xGattClient, nRF5xGattServer, nRF5xSecurityManager and nRF5xServiceDiscovery. * Modify the shutdown() implementation in nRF5xn such that it also calls the static member shutdown() exposed by the BLE API in Gap.h, SecurityManager.h, GattClient.h and GattServer.h. * Modify nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager classes so that they dynamically create their respective objects only if needed. Previously the GattClient, GattServer and SecurityManager objects were declared as static, which means that they were always present even though they were not always needed. This increases memory consumption unnecessarily. Furthermore, pointers to the object instances are stored in static members of the classes as specified by the BLE API base classes. This ensures that calls to shutdown do not require calls to getInstance() functions that would otherwise result in undesired memory allocations. * nRF5xGap object is always needed, so this remains allocated statically. But the reference in Gap is pointed to this object. The shutdown procedure is as follows: 1. The user calls ble.shutdown() which executes the code in nRF5xn::shutdown() 1. The SoftDevice is shutdown 1. The static members of Gap.h, SecurityManager.h, GattClient.h and GattServer.h are called to clean up their own state. If at any point an error occur during the last step, BLE_ERROR_INVALID_STATE is returned.
2015-12-11 17:37:58 +00:00
{
if (SecurityManager::reset() != BLE_ERROR_NONE) {
Improve shutdown to clear BLE API and not just SD Improve the shutdown functionality, such that a call to ble.shutdown() from the user application clears the API and nRF5x state and NOT only the SoftDevice. To achieve this the following changes are introduced: * Add a protected member cleanup() to nRF5xGap, nRF5xGattClient, nRF5xGattServer, nRF5xSecurityManager and nRF5xServiceDiscovery. * Modify the shutdown() implementation in nRF5xn such that it also calls the static member shutdown() exposed by the BLE API in Gap.h, SecurityManager.h, GattClient.h and GattServer.h. * Modify nRF5xGattClient, nRF5xGattServer and nRF5xSecurityManager classes so that they dynamically create their respective objects only if needed. Previously the GattClient, GattServer and SecurityManager objects were declared as static, which means that they were always present even though they were not always needed. This increases memory consumption unnecessarily. Furthermore, pointers to the object instances are stored in static members of the classes as specified by the BLE API base classes. This ensures that calls to shutdown do not require calls to getInstance() functions that would otherwise result in undesired memory allocations. * nRF5xGap object is always needed, so this remains allocated statically. But the reference in Gap is pointed to this object. The shutdown procedure is as follows: 1. The user calls ble.shutdown() which executes the code in nRF5xn::shutdown() 1. The SoftDevice is shutdown 1. The static members of Gap.h, SecurityManager.h, GattClient.h and GattServer.h are called to clean up their own state. If at any point an error occur during the last step, BLE_ERROR_INVALID_STATE is returned.
2015-12-11 17:37:58 +00:00
return BLE_ERROR_INVALID_STATE;
}
return BLE_ERROR_NONE;
}
bool hasInitialized(void) const {
return btle_hasInitializedSecurity();
}
2015-06-19 07:28:35 +00:00
public:
/*
* Allow instantiation from nRF5xn when required.
*/
friend class nRF5xn;
nRF5xSecurityManager() {
2015-06-19 07:28:35 +00:00
/* empty */
}
private:
nRF5xSecurityManager(const nRF5xSecurityManager &);
const nRF5xSecurityManager& operator=(const nRF5xSecurityManager &);
ble_error_t createWhitelistFromBondTable(ble_gap_whitelist_t &whitelistFromBondTable) const {
return btle_createWhitelistFromBondTable(&whitelistFromBondTable);
}
bool matchAddressAndIrk(ble_gap_addr_t *address, ble_gap_irk_t *irk) const {
return btle_matchAddressAndIrk(address, irk);
}
friend class nRF5xGap;
2015-06-19 07:28:35 +00:00
};
#endif // ifndef __NRF51822_SECURITY_MANAGER_H__