libcrossystem/crossystem_vboot_interface.h

// Copyright 2023 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef LIBCROSSYSTEM_CROSSYSTEM_VBOOT_INTERFACE_H_
#define LIBCROSSYSTEM_CROSSYSTEM_VBOOT_INTERFACE_H_

#include <optional>
#include <string>

namespace crossystem {

class CrossystemVbootInterface {
 public:
  virtual ~CrossystemVbootInterface() = default;

  // Reads a system property integer.
  //
  // @param name The name of the target system property.
  // @return The property value, or |std::nullopt| if error.
  virtual std::optional<int> VbGetSystemPropertyInt(
      const std::string& name) const = 0;

  // Sets a system property integer.
  //
  // @param name The name of the target system property.
  // @param value The integer value to set.
  // @return |true| if it succeeds; |false| if it fails.
  virtual bool VbSetSystemPropertyInt(const std::string& name, int value) = 0;

  // Reads a system property string.
  //
  // @param name The name of the target system property.
  // @return The property value, or |std::nullopt| if error.
  virtual std::optional<std::string> VbGetSystemPropertyString(
      const std::string& name) const = 0;

  // Sets a system property string.
  //
  // @param name The name of the target system property.
  // @param value The string value to set.
  // @return |true| if it succeeds; |false| if it fails.
  virtual bool VbSetSystemPropertyString(const std::string& name,
                                         const std::string& value) = 0;
};

}  // namespace crossystem

#endif  // LIBCROSSYSTEM_CROSSYSTEM_VBOOT_INTERFACE_H_