keys_container.h

/* Copyright (c) 2016, 2025, Oracle and/or its affiliates.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.

   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License, version 2.0, for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */

#ifndef KEYS_CONTAINER_INCLUDED
#define KEYS_CONTAINER_INCLUDED

#include <sys/types.h>

#include <vector>
#include "map_helpers.h"
#include "my_inttypes.h"
#include "my_sharedlib.h"
#include "mysql/strings/m_ctype.h"
#include "plugin/keyring/common/i_keyring_io.h"
#include "plugin/keyring/common/i_keys_container.h"
#include "plugin/keyring/common/keyring_key.h"
#include "plugin/keyring/common/keyring_memory.h"
#include "plugin/keyring/common/logger.h"
#include "sql/sys_vars_shared.h"  //For PolyLock, AutoWLock, AutoRLock

namespace keyring {

class Keys_container : public IKeys_container {
 private:
  bool remove_keys_metadata(IKey *key);
  void store_keys_metadata(IKey *key);

 public:
  Keys_container(ILogger *logger);
  bool init(IKeyring_io *keyring_io, std::string keyring_storage_url) override;
  bool store_key(IKey *key) override;
  IKey *fetch_key(IKey *key) override;
  bool remove_key(IKey *key) override;
  std::string get_keyring_storage_url() override;
  void set_keyring_io(IKeyring_io *keyring_io) override;
  std::vector<Key_metadata> get_keys_metadata() override {
    return keys_metadata;
  }

  ~Keys_container() override;

  size_t get_number_of_keys() { return keys_hash->size(); }

  /** Internal function, returns the key from the internal hash, no locks */
  IKey *get_key_from_hash(IKey *key) override;

 protected:
  Keys_container(const Keys_container &);

  virtual void allocate_and_set_data_for_key(IKey *key,
                                             std::string *source_key_type,
                                             uchar *source_key_data,
                                             size_t source_key_data_size);
  bool load_keys_from_keyring_storage();
  void free_keys_hash();
  bool store_key_in_hash(IKey *key);
  bool remove_key_from_hash(IKey *key);
  virtual bool flush_to_backup();
  virtual bool flush_to_storage(IKey *key, Key_operation operation);

  using Key_hash = collation_unordered_map<std::string, std::unique_ptr<IKey>>;
  std::unique_ptr<Key_hash> keys_hash;
  std::vector<Key_metadata> keys_metadata;
  ILogger *logger;
  IKeyring_io *keyring_io;
  std::string keyring_storage_url;
};

}  // namespace keyring

#endif  // KEYS_CONTAINER_INCLUDED