keepass.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 <cstddef>
#include <cstdint>
#include <istream>
#include <memory>
#include <ostream>
#include <string>
#include <vector>
 
#include "database.hh"
#include "key.hh"
#include "libkeepass/export.hh"
 
namespace keepass {
 
class KdbFile;
 
class LIBKEEPASS_API KeePass final {
public:
  enum class Format {
    kAuto,  
    kKdb,   
    kKdbx3, 
    kKdbx4  
  };
 
  KeePass();
 
 
  explicit KeePass(const Key& key);
 
 
  KeePass(const std::string& password, const std::string& keyfile = "");
 
 
  std::unique_ptr<Database> Open(const std::string& path);
 
 
  std::unique_ptr<Database> Open(std::istream& src);
 
 
  std::unique_ptr<Database> Open(const uint8_t* data, std::size_t size);
 
  std::unique_ptr<Database> Open(const std::vector<uint8_t>& data) {
    return Open(data.data(), data.size());
  }
 
 
  void Save(const std::string& path, const Database& db);
 
 
  void Save(std::ostream& dst, const Database& db);
 
 
  void Save(std::ostream& dst, const Database& db, const Key& key);
 
 
  void SaveAs(const std::string& path, const Database& db, const Key& new_key);
 
 
  void SaveAs(std::ostream& dst, const Database& db, const Key& new_key);
 
 
  void SaveAs(const std::string& path, const Database& db, const std::string& password,
              const std::string& keyfile = "");
 
 
  void SaveAs(std::ostream& dst, const Database& db, const std::string& password,
              const std::string& keyfile = "");
 
  void SetFormat(Format format) { format_ = format; }
 
  Format GetFormat() const { return format_; }
 
 
  static std::unique_ptr<Database> Create(const std::string& password = "",
                                          Format format = Format::kKdbx4,
                                          Database::Cipher cipher = Database::Cipher::kAes,
                                          Database::Kdf kdf = Database::Kdf::kArgon2id);
 
private:
  std::unique_ptr<Database> Import(std::istream& src, Format format);
  void Save(std::ostream& dst, const Database& db, Format format);
  static void SaveWithOptions(std::ostream& dst, const Database& db, const Key& key, Format format,
                              bool use_cached_key);
  Format ResolveOutputFormat(const std::string& path, const Database& db) const;
  Format ResolveStreamFormat(const Database& db) const;
 
  Key key_;
  Format format_ = Format::kAuto;
};
 
} // namespace keepass