1 /*
2  * Copyright (C) 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include <stdint.h>
20 
21 #include <functional>
22 #include <map>
23 #include <memory>
24 #include <string>
25 #include <vector>
26 
27 #include <ziparchive/zip_archive.h>
28 
29 #include "verifier.h"
30 
31 enum class PackageType {
32   kMemory,
33   kFile,
34 };
35 
36 // This class serves as a wrapper for an OTA update package. It aims to provide the common
37 // interface for both packages loaded in memory and packages read from fd.
38 class Package : public VerifierInterface {
39  public:
40   static std::unique_ptr<Package> CreateMemoryPackage(
41       const std::string& path, const std::function<void(float)>& set_progress);
42   static std::unique_ptr<Package> CreateMemoryPackage(
43       std::vector<uint8_t> content, const std::function<void(float)>& set_progress);
44   static std::unique_ptr<Package> CreateFilePackage(const std::string& path,
45                                                     const std::function<void(float)>& set_progress);
46 
47   virtual ~Package() = default;
48 
49   virtual PackageType GetType() const = 0;
50 
51   virtual std::string GetPath() const = 0;
52 
53   // Opens the package as a zip file and returns the ZipArchiveHandle.
54   virtual ZipArchiveHandle GetZipArchiveHandle() = 0;
55 
56   // Updates the progress in fraction during package verification.
57   void SetProgress(float progress) override;
58 
59  protected:
60   // An optional function to update the progress.
61   std::function<void(float)> set_progress_;
62 };
63