avb.h

Go to the documentation of this file.

//
// Copyright (C) 2023 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include "cuttlefish/common/libs/utils/result.h"
 
#include <sys/types.h>
 
#include <cstdint>
#include <string>
#include <vector>
 
#include "cuttlefish/common/libs/fs/shared_fd.h"
#include "cuttlefish/common/libs/utils/subprocess.h"
 
namespace cuttlefish {
 
// Taken from external/avb/avbtool.py; this define is not in the headers
inline constexpr uint64_t kMaxAvbMetadataSize = 69632ul;
 
struct ChainPartition {
  std::string name;
  std::string rollback_index;
  std::string key_path;
};
 
class Avb {
 public:
  Avb();
  Avb(std::string avbtool_path, std::string algorithm, std::string key);
 
  Result<void> AddHashFooter(const std::string& image_path,
                             const std::string& partition_name,
                             off_t partition_size_bytes) const;
  Result<std::string> InfoImage(const std::string& image_path) const;
  Result<void> MakeVbMetaImage(
      const std::string& output_path,
      const std::vector<ChainPartition>& chained_partitions,
      const std::vector<std::string>& included_partitions,
      const std::vector<std::string>& extra_arguments);
 
 private:
  Command GenerateAddHashFooter(const std::string& image_path,
                                const std::string& partition_name,
                                off_t partition_size_bytes) const;
  Command GenerateInfoImage(const std::string& image_path,
                            const SharedFD& output_path) const;
  Command GenerateMakeVbMetaImage(
      const std::string& output_path,
      const std::vector<ChainPartition>& chained_partitions,
      const std::vector<std::string>& included_partitions,
      const std::vector<std::string>& extra_arguments);
 
  std::string avbtool_path_;
  std::string algorithm_;
  std::string key_;
};
 
Result<void> EnforceVbMetaSize(const std::string& path);
 
}  // namespace cuttlefish