binary.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 <memory>
#include <mutex>
#include <ostream>
#include <string>
 
#include "libkeepass/detail/binary_source.hh"
#include "secure.hh"
#include "security.hh"
 
namespace keepass {
 
class LIBKEEPASS_API Binary final {
private:
  mutable std::mutex mutex_;
  mutable protect<secure_string> data_;
  mutable bool loaded_ = true;
  bool protected_ = false;
  bool compress_ = false;
  std::size_t size_ = 0;
  std::shared_ptr<const detail::BinarySource> source_;
 
public:
  explicit Binary(const protect<secure_string>& data);
 
  Binary(std::shared_ptr<const detail::BinarySource> source, bool protected_data,
         bool compress = false);
 
  Binary(const Binary& other);
 
  Binary& operator=(const Binary& other);
 
  bool Empty() const;
 
  std::size_t Size() const;
 
  const protect<secure_string>& data() const;
 
  void set_data(const protect<secure_string>& data);
 
  void load() const;
 
  bool is_loaded() const { return loaded_; }
 
  bool is_lazy() const { return source_ != nullptr; }
 
  bool is_protected() const { return protected_; }
 
  void WriteTo(std::ostream& dst) const;
 
  bool compress() const { return compress_; }
 
  void set_compress(bool compress) { compress_ = compress; }
 
  bool operator==(const Binary& other) const;
 
  bool operator!=(const Binary& other) const { return !(*this == other); }
};
 
} // namespace keepass