format_codec.hh

Go to the documentation of this file.

/*
 * libkeepass - KeePass key database importer/exporter
 * Copyright (C) 2014 Christian Kindahl
 * Copyright (C) 2024 Dominik Krümpelmann
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <functional>
#include <istream>
#include <map>
#include <memory>
#include <mutex>
#include <ostream>
 
#include "libkeepass/export.hh"
 
namespace keepass {
 
class Database;
class Key;
class KdbFile;
 
namespace detail {
 
// Numeric ids must match the values of KeePass::Format (kKdb=1, kKdbx3=2,
// kKdbx4=3). They are duplicated here to keep this header independent of the
// unified API header and its include graph.
constexpr int kFormatKdb = 1;
constexpr int kFormatKdbx3 = 2;
constexpr int kFormatKdbx4 = 3;
 
struct FormatCodecOptions {
  bool write_kdbx4 = false;
 
  bool use_cached_key = true;
};
 
class LIBKEEPASS_API FormatCodec {
public:
  virtual ~FormatCodec() = default;
 
  virtual std::unique_ptr<Database> Import(std::istream& src, const Key& key) = 0;
 
  virtual void Export(std::ostream& dst, const Database& db, const Key& key) = 0;
};
 
using DatabaseSerializer = FormatCodec;
 
using FormatCodecFactory = std::function<std::unique_ptr<FormatCodec>(const FormatCodecOptions&)>;
 
class LIBKEEPASS_API FormatCodecRegistry final {
public:
  static FormatCodecRegistry& Instance();
 
  void Register(int format, FormatCodecFactory factory);
 
  std::unique_ptr<FormatCodec> Create(int format, const FormatCodecOptions& options) const;
 
  bool Contains(int format) const;
 
private:
  FormatCodecRegistry();
 
  mutable std::mutex mutex_;
  std::map<int, FormatCodecFactory> factories_;
};
 
} // namespace detail
} // namespace keepass