Merge pull request #44 from donatieng/cordio-privacy

Security Manager PAL: Privacy implementation for Cordio

Author: pan-

features/FEATURE_BLE/ble/generic/GenericGap.h

@@ -23,6 +23,7 @@
 #include "ble/BLEProtocol.h"
 #include "ble/Gap.h"
 #include "ble/pal/PalGap.h"
+#include "ble/pal/PalSecurityManager.h"
 #include "ble/pal/GapEvents.h"
 #include "ble/pal/GapTypes.h"
 #include "ble/BLETypes.h"
@@ -55,11 +56,15 @@ class GenericGap : public ::Gap,
      *
      * @param generic_access_service Platform abstraction instance managing
      * the GATT generic access service.
+     * 
+     * @param pal_sm Security Manager Platform abstraction instance containing the base
+     * Security Manager primitives.
      */
     GenericGap(
         pal::EventQueue &event_queue,
         pal::Gap &pal_gap,
-        pal::GenericAccessService &generic_access_service
+        pal::GenericAccessService &generic_access_service,
+        pal::SecurityManager &pal_sm
     );
 
     /**
@@ -233,6 +238,39 @@ class GenericGap : public ::Gap,
      */
     virtual ble_error_t initRadioNotification(void);
 
+    /**
+     * @see Gap::enablePrivacy
+     */
+    virtual ble_error_t enablePrivacy(bool enable);
+
+    /**
+     * @see Gap::setPeripheralPrivacyConfiguration
+     */
+    virtual ble_error_t setPeripheralPrivacyConfiguration(
+        const PeripheralPrivacyConfiguration_t *configuration
+    );
+
+    /**
+     * @see Gap::getPeripheralPrivacyConfiguration
+     */
+    virtual ble_error_t getPeripheralPrivacyConfiguration(
+        PeripheralPrivacyConfiguration_t *configuration
+    );
+
+    /**
+     * @see Gap::setCentralPrivacyConfiguration
+     */
+    virtual ble_error_t setCentralPrivacyConfiguration(
+        const CentralPrivacyConfiguration_t *configuration
+    );
+
+    /**
+     * @see Gap::getCentralPrivacyConfiguration
+     */
+    virtual ble_error_t getCentralPrivacyConfiguration(
+        CentralPrivacyConfiguration_t *configuration
+    );
+
     /**
      * @see Gap::setAdvertisingData
      */
@@ -302,21 +340,45 @@ class GenericGap : public ::Gap,
 
     void on_unexpected_error(const pal::GapUnexpectedErrorEvent &e);
 
-    pal::own_address_type_t get_own_address_type();
+    enum AddressUseType_t {
+        CENTRAL_CONNECTION,
+        CENTRAL_SCAN,
+        PERIPHERAL_CONNECTABLE,
+        PERIPHERAL_NON_CONNECTABLE
+    };
+
+    pal::own_address_type_t get_own_address_type(AddressUseType_t address_use_type);
 
     bool initialize_whitelist() const;
 
+    ble_error_t update_address_resolution_setting();
+
+    void set_random_address_rotation(bool enable);
+
+    void update_random_address();
+
+    void on_address_rotation_timeout();
+
     pal::EventQueue& _event_queue;
     pal::Gap &_pal_gap;
     pal::GenericAccessService &_gap_service;
+    pal::SecurityManager &_pal_sm;
     BLEProtocol::AddressType_t _address_type;
     ble::address_t _address;
     pal::initiator_policy_t _initiator_policy_mode;
     pal::scanning_filter_policy_t _scanning_filter_policy;
     pal::advertising_filter_policy_t _advertising_filter_policy;
     mutable Whitelist_t _whitelist;
+    
+    bool _privacy_enabled;
+    PeripheralPrivacyConfiguration_t _peripheral_privacy_configuration;
+    CentralPrivacyConfiguration_t _central_privacy_configuration;
+    ble::address_t _random_static_identity_address;
+    bool _random_address_rotating;
+    
     mbed::Timeout _advertising_timeout;
     mbed::Timeout _scan_timeout;
+    mbed::Ticker _address_rotation_ticker;
     pal::ConnectionEventMonitor::EventHandler *_connection_event_handler;
 };
 

features/FEATURE_BLE/ble/pal/PalGap.h

@@ -649,6 +649,27 @@ struct Gap {
         disconnection_reason_t disconnection_reason
     ) = 0;
 
+    /** Check if privacy feature is supported by implementation
+     *  
+     * @return true if privacy is supported, false otherwise.
+     * 
+     * @note: See Bluetooth 5 Vol 3 Part C: 10.7 Privacy feature.
+     */ 
+    virtual bool is_privacy_supported() = 0;
+
+    /** Enable or disable private addresses resolution
+     *
+     * @param enable whether to enable private addresses resolution
+     *  
+     * @return BLE_ERROR_NONE if the request has been successfully sent or the
+     * appropriate error otherwise.
+     * 
+     * @note: See Bluetooth 5 Vol 2 PartE: 7.8.44 LE Set Address Resolution Enable command.
+     */
+    virtual ble_error_t set_address_resolution(
+        bool enable
+    ) = 0;
+
     /**
      * Register a callback which will handle Gap events.
      *