mirror of https://github.com/ARMmbed/mbed-os.git
boilerplate
paul-szczepanek-arm
parent
da3ecfc2e4
commit
8a0aba398b
|
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* PalSM.h
|
||||
/* mbed Microcontroller Library
|
||||
* Copyright (c) 2017-2018 ARM Limited
|
||||
*
|
||||
* Created on: 12 Dec 2017
|
||||
* Author: pawszc02
|
||||
* 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 MBED_OS_FEATURES_FEATURE_BLE_BLE_PAL_PALSM_H_
|
||||
|
|
@ -23,17 +32,18 @@ using SecurityManager::IO_CAPS_NONE;
|
|||
using SecurityManager::SecurityCompletionStatus_t;
|
||||
using SecurityManager::SecurityMode_t;
|
||||
using SecurityManager::LinkSecurityStatus_t;
|
||||
using SecurityManager::Passkey_t;
|
||||
using SecurityManager::Keypress_t;
|
||||
using SecurityManager::C192_t;
|
||||
using SecurityManager::R192_t;
|
||||
using SecurityManager::C256_t;
|
||||
using SecurityManager::R256_t;
|
||||
|
||||
using BLEProtocol::AddressBytes_t;
|
||||
/* please use typedef for porting not the types directly */
|
||||
|
||||
typedef SecurityManager::Passkey_t passkey_t;
|
||||
typedef SecurityManager::C192_t c192_t;
|
||||
typedef SecurityManager::R192_t r192_t;
|
||||
typedef SecurityManager::C256_t c256_t;
|
||||
typedef SecurityManager::R256_t r256_t;
|
||||
|
||||
using BLEProtocol::Address_t;
|
||||
|
||||
|
||||
typedef uint8_t irk_t[16];
|
||||
typedef uint8_t csrk_t[16];
|
||||
typedef uint8_t ltk_t[16];
|
||||
|
|
@ -75,72 +85,207 @@ public:
|
|||
SecurityManager() : _event_handler(NULL) { };
|
||||
virtual ~SecurityManager() { };
|
||||
|
||||
virtual ble_error_t initialize() = 0;
|
||||
virtual ble_error_t terminate() = 0;
|
||||
virtual ble_error_t reset() = 0;
|
||||
virtual ble_error_t initialize() {
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t terminate() {
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t reset() {
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* persistence */
|
||||
|
||||
virtual ble_error_t get_bonded_list(bonded_list_t &list) = 0;
|
||||
virtual ble_error_t set_bonded_list(bonded_list_t &list) = 0;
|
||||
virtual ble_error_t get_bonded_list(bonded_list_t &list) {
|
||||
(void)list;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_bonded_list(bonded_list_t &list) {
|
||||
(void)list;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t get_resolving_list(resolving_list_t &list) = 0;
|
||||
virtual ble_error_t set_resolving_list(resolving_list_t &list) = 0;
|
||||
virtual ble_error_t get_resolving_list(resolving_list_t &list) {
|
||||
(void)list;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_resolving_list(resolving_list_t &list) {
|
||||
(void)list;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t get_whitelist(Gap::Whitelist_t &addresses) = 0;
|
||||
virtual ble_error_t set_whitelist(Gap::Whitelist_t &addresses) = 0;
|
||||
virtual ble_error_t get_whitelist(Gap::Whitelist_t &list) {
|
||||
(void)list;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_whitelist(Gap::Whitelist_t &list) {
|
||||
(void)list;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* feature support */
|
||||
|
||||
virtual ble_error_t set_secure_connections_support(bool enabled, bool secure_connections_only = false) = 0;
|
||||
virtual ble_error_t get_secure_connections_support(bool &enabled, bool &secure_connections_only) = 0;
|
||||
virtual ble_error_t set_secure_connections_support(bool enabled, bool secure_connections_only = false) {
|
||||
(void)enabled;
|
||||
(void)secure_connections_only;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t get_secure_connections_support(bool &enabled, bool &secure_connections_only) {
|
||||
(void)enabled;
|
||||
(void)secure_connections_only;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* security settings */
|
||||
|
||||
virtual ble_error_t set_io_capabilities(SecurityIOCapabilities_t iocaps = IO_CAPS_NONE) = 0;
|
||||
virtual ble_error_t set_bondable(bool bondable = true) = 0;
|
||||
virtual ble_error_t set_keypress_notification(bool send_keypresses = true) = 0;
|
||||
virtual ble_error_t set_io_capabilities(SecurityIOCapabilities_t iocaps = IO_CAPS_NONE) {
|
||||
(void)iocaps;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_bondable(bool bondable = true) {
|
||||
(void)bondable;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_keypress_notification(bool send_keypresses = true) {
|
||||
(void)send_keypresses;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t set_pin_code(uint8_t pin_length, uint8_t *pin_code, bool static_pin = false) = 0;
|
||||
virtual ble_error_t set_passkey(passkey_num_t passkey) = 0;
|
||||
virtual ble_error_t set_oob_data_usage(connection_handle_t connectionHandle, bool useOOB, bool OOBProvidesMITM) = 0;
|
||||
virtual ble_error_t set_pin_code(uint8_t pin_length, uint8_t *pin_code, bool static_pin = false) {
|
||||
(void)pin_length;
|
||||
(void)pin_code;
|
||||
(void)static_pin;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_passkey(passkey_num_t passkey) {
|
||||
(void)passkey;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_oob_data_usage(connection_handle_t handle, bool useOOB, bool OOBProvidesMITM) {
|
||||
(void)handle;
|
||||
(void)useOOB;
|
||||
(void)OOBProvidesMITM;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t set_encryption_key_size(uint8_t minimum_bitsize, uint8_t maximum_bitsize = 128) = 0;
|
||||
virtual ble_error_t get_encryption_key_size(connection_handle_t, uint8_t &size) = 0;
|
||||
virtual ble_error_t set_encryption_key_size(uint8_t minimum_bitsize, uint8_t maximum_bitsize = 128) {
|
||||
(void)minimum_bitsize;
|
||||
(void)maximum_bitsize;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t get_encryption_key_size(connection_handle_t, uint8_t &bitsize) {
|
||||
(void)bitsize;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t set_authentication_timeout(connection_handle_t, uint16_t timeout /*x10 ms*/) = 0;
|
||||
virtual ble_error_t get_authentication_timeout(connection_handle_t, uint16_t &timeout /*x10 ms*/) = 0;
|
||||
virtual ble_error_t set_authentication_timeout(connection_handle_t, uint16_t timeout_in_10ms) {
|
||||
(void)timeout_in_10ms;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t get_authentication_timeout(connection_handle_t, uint16_t &timeout_in_10ms) {
|
||||
(void)timeout_in_10ms;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t refresh_encryption_key(connection_handle_t) = 0;
|
||||
virtual ble_error_t refresh_encryption_key(connection_handle_t handle) {
|
||||
(void)handle;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* privacy */
|
||||
|
||||
virtual ble_error_t set_private_address_timeout(uint16_t timeout_seconds) = 0;
|
||||
virtual ble_error_t set_private_address_timeout(uint16_t timeout_in_seconds) {
|
||||
(void)timeout_in_seconds;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* authentication */
|
||||
|
||||
/* triggers pairing if required */
|
||||
virtual ble_error_t set_security_mode(connection_handle_t handle, SecurityMode_t mode) = 0;
|
||||
virtual ble_error_t get_security_mode(connection_handle_t handle, SecurityMode_t &mode) = 0;
|
||||
virtual ble_error_t set_security_mode(connection_handle_t handle, SecurityMode_t mode) {
|
||||
(void)handle;
|
||||
(void)mode;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t get_security_mode(connection_handle_t handle, SecurityMode_t &mode) {
|
||||
(void)handle;
|
||||
(void)mode;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t get_encryption_status(connection_handle_t handle, LinkSecurityStatus_t &mode) = 0;
|
||||
virtual ble_error_t get_encryption_status(connection_handle_t handle, LinkSecurityStatus_t &status) {
|
||||
(void)handle;
|
||||
(void)status;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t request_pairing(bool authentication_required = true) = 0;
|
||||
virtual ble_error_t set_pairing_request_authorisation(bool required = true) = 0;
|
||||
virtual ble_error_t accept_pairing_request(bool accept = true, bool authentication_required = true) = 0;
|
||||
virtual ble_error_t request_pairing(bool authentication_required = true) {
|
||||
(void)authentication_required;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_pairing_request_authorisation(bool authentication_required = true) {
|
||||
(void)authentication_required;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t accept_pairing_request(bool accept = true, bool authentication_required = true) {
|
||||
(void)accept;
|
||||
(void)authentication_required;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t request_authentication() = 0;
|
||||
virtual ble_error_t request_authentication() {
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* MITM */
|
||||
|
||||
virtual ble_error_t confirmation_entered(connection_handle_t address, bool confirmation) = 0;
|
||||
virtual ble_error_t passkey_entered(connection_handle_t, Passkey_t passkey) = 0;
|
||||
virtual ble_error_t send_keypress_notification(connection_handle_t, Keypress_t keypress) = 0;
|
||||
virtual ble_error_t confirmation_entered(connection_handle_t handle, bool confirmation) {
|
||||
(void)handle;
|
||||
(void)confirmation;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t passkey_entered(connection_handle_t handle, passkey_t passkey) {
|
||||
(void)handle;
|
||||
(void)passkey;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t send_keypress_notification(connection_handle_t handle, Keypress_t keypress) {
|
||||
(void)handle;
|
||||
(void)keypress;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
virtual ble_error_t set_oob(connection_handle_t handle, C192_t&, R192_t&) = 0;
|
||||
virtual ble_error_t set_extended_oob(connection_handle_t handle, C192_t&, R192_t&, C256_t&, R256_t&) = 0;
|
||||
virtual ble_error_t get_local_oob_data(connection_handle_t handle, C192_t&, R192_t&) = 0;
|
||||
virtual ble_error_t get_local_extended_oob_data(connection_handle_t handle, C192_t&, R192_t&, C256_t&, R256_t&) = 0;
|
||||
virtual ble_error_t set_oob(connection_handle_t handle, c192_t& c192, r192_t& r192) {
|
||||
(void)handle;
|
||||
(void)c192;
|
||||
(void)r192;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t set_extended_oob(connection_handle_t handle,
|
||||
c192_t& c192, r192_t& r192, c256_t& c256, r256_t& r256) {
|
||||
(void)handle;
|
||||
(void)c192;
|
||||
(void)r192;
|
||||
(void)c256;
|
||||
(void)r256;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t get_local_oob_data(connection_handle_t handle, c192_t& c192, r192_t& r192) {
|
||||
(void)handle;
|
||||
(void)c192;
|
||||
(void)r192;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
virtual ble_error_t get_local_extended_oob_data(connection_handle_t handle,
|
||||
c192_t& c192, r192_t& r192, c256_t& c256, r256_t& r256) {
|
||||
(void)handle;
|
||||
(void)c192;
|
||||
(void)r192;
|
||||
(void)c256;
|
||||
(void)r256;
|
||||
return BLE_ERROR_NOT_IMPLEMENTED;
|
||||
}
|
||||
|
||||
/* Entry points for the underlying stack to report events back to the user. */
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
/* mbed Microcontroller Library
|
||||
* Copyright (c) 2006-2015 ARM Limited
|
||||
* Copyright (c) 2017-2018 ARM Limited
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
|
|||
Loading…
Reference in New Issue