gd/hci/classic_security_manager.h

/*
 * Copyright 2019 The Android Open Source Project
 *
 * 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.
 */

#pragma once

#include "common/link_key.h"
#include "hci/address.h"
#include "hci/hci_packets.h"
#include "module.h"

namespace bluetooth {
namespace hci {

class ClassicSecurityCommandCallbacks {
 public:
  virtual ~ClassicSecurityCommandCallbacks() = default;
  // Invoked when controller sends Command Complete event
  virtual void OnCommandComplete(CommandCompleteView status) = 0;
};

class ClassicSecurityManager : public Module {
 public:
  ClassicSecurityManager();

  bool RegisterCallbacks(ClassicSecurityCommandCallbacks* callbacks, os::Handler* handler);

  void LinkKeyRequestReply(Address address, common::LinkKey link_key);
  void LinkKeyRequestNegativeReply(Address address);
  void PinCodeRequestReply(Address address, uint8_t len, std::string pin_code);
  void PinCodeRequestNegativeReply(Address address);
  void IoCapabilityRequestReply(Address address, IoCapability io_capability, OobDataPresent oob_present,
                                AuthenticationRequirements authentication_requirements);
  void IoCapabilityRequestNegativeReply(Address address, ErrorCode reason);
  void UserConfirmationRequestReply(Address address);
  void UserConfirmationRequestNegativeReply(Address address);
  void UserPasskeyRequestReply(Address address, uint32_t passkey);
  void UserPasskeyRequestNegativeReply(Address address);
  void RemoteOobDataRequestReply(Address address, std::array<uint8_t, 16> c, std::array<uint8_t, 16> r);
  void RemoteOobDataRequestNegativeReply(Address address);
  void ReadStoredLinkKey(Address address, ReadStoredLinkKeyReadAllFlag read_all_flag);
  void WriteStoredLinkKey(std::vector<KeyAndAddress> keys);
  void DeleteStoredLinkKey(Address address, DeleteStoredLinkKeyDeleteAllFlag delete_all_flag);
  void RefreshEncryptionKey(uint16_t connection_handle);
  void ReadSimplePairingMode();
  void WriteSimplePairingMode(Enable simple_pairing_mode);
  void ReadLocalOobData();
  void SendKeypressNotification(Address address, KeypressNotificationType notification_type);
  void ReadLocalOobExtendedData();
  void ReadEncryptionKeySize(uint16_t connection_handle);

  static const ModuleFactory Factory;

 protected:
  void ListDependencies(ModuleList* list) override;

  void Start() override;

  void Stop() override;

  std::string ToString() const override;

 private:
  struct impl;
  std::unique_ptr<impl> pimpl_;
};

}  // namespace hci
}  // namespace bluetooth