xref: /aosp_15_r20/system/libziparchive/zip_archive_private.h (revision adcb0a6279ea715828f9bc5e351569419e478774)
1*adcb0a62SAndroid Build Coastguard Worker /*
2*adcb0a62SAndroid Build Coastguard Worker  * Copyright (C) 2008 The Android Open Source Project
3*adcb0a62SAndroid Build Coastguard Worker  *
4*adcb0a62SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*adcb0a62SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*adcb0a62SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*adcb0a62SAndroid Build Coastguard Worker  *
8*adcb0a62SAndroid Build Coastguard Worker  *    http://www.apache.org/licenses/LICENSE-2.0
9*adcb0a62SAndroid Build Coastguard Worker  *
10*adcb0a62SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*adcb0a62SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*adcb0a62SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*adcb0a62SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*adcb0a62SAndroid Build Coastguard Worker  * limitations under the License.
15*adcb0a62SAndroid Build Coastguard Worker  */
16*adcb0a62SAndroid Build Coastguard Worker 
17*adcb0a62SAndroid Build Coastguard Worker #pragma once
18*adcb0a62SAndroid Build Coastguard Worker 
19*adcb0a62SAndroid Build Coastguard Worker #include <ziparchive/zip_archive.h>
20*adcb0a62SAndroid Build Coastguard Worker 
21*adcb0a62SAndroid Build Coastguard Worker #include <stdint.h>
22*adcb0a62SAndroid Build Coastguard Worker #include <stdlib.h>
23*adcb0a62SAndroid Build Coastguard Worker #include <unistd.h>
24*adcb0a62SAndroid Build Coastguard Worker 
25*adcb0a62SAndroid Build Coastguard Worker #include <memory>
26*adcb0a62SAndroid Build Coastguard Worker #include <utility>
27*adcb0a62SAndroid Build Coastguard Worker #include <vector>
28*adcb0a62SAndroid Build Coastguard Worker 
29*adcb0a62SAndroid Build Coastguard Worker #include "android-base/macros.h"
30*adcb0a62SAndroid Build Coastguard Worker #include "android-base/mapped_file.h"
31*adcb0a62SAndroid Build Coastguard Worker #include "android-base/memory.h"
32*adcb0a62SAndroid Build Coastguard Worker #include "zip_cd_entry_map.h"
33*adcb0a62SAndroid Build Coastguard Worker #include "zip_error.h"
34*adcb0a62SAndroid Build Coastguard Worker 
35*adcb0a62SAndroid Build Coastguard Worker class MappedZipFile {
36*adcb0a62SAndroid Build Coastguard Worker  public:
37*adcb0a62SAndroid Build Coastguard Worker   explicit MappedZipFile(int fd, off64_t length = -1, off64_t offset = 0);
38*adcb0a62SAndroid Build Coastguard Worker 
MappedZipFile(const void * address,size_t length)39*adcb0a62SAndroid Build Coastguard Worker   explicit MappedZipFile(const void* address, size_t length)
40*adcb0a62SAndroid Build Coastguard Worker       : base_ptr_(address), data_length_(static_cast<off64_t>(length)) {}
41*adcb0a62SAndroid Build Coastguard Worker 
42*adcb0a62SAndroid Build Coastguard Worker   int GetFileDescriptor() const;
43*adcb0a62SAndroid Build Coastguard Worker 
44*adcb0a62SAndroid Build Coastguard Worker   const void* GetBasePtr() const;
45*adcb0a62SAndroid Build Coastguard Worker 
46*adcb0a62SAndroid Build Coastguard Worker   off64_t GetFileOffset() const;
47*adcb0a62SAndroid Build Coastguard Worker 
48*adcb0a62SAndroid Build Coastguard Worker   off64_t GetFileLength() const;
49*adcb0a62SAndroid Build Coastguard Worker 
50*adcb0a62SAndroid Build Coastguard Worker   const uint8_t* ReadAtOffset(uint8_t* buf, size_t len, off64_t off) const;
51*adcb0a62SAndroid Build Coastguard Worker 
52*adcb0a62SAndroid Build Coastguard Worker  private:
53*adcb0a62SAndroid Build Coastguard Worker   std::unique_ptr<android::base::MappedFile> mapped_file_;
54*adcb0a62SAndroid Build Coastguard Worker 
55*adcb0a62SAndroid Build Coastguard Worker   const int fd_ = -1;
56*adcb0a62SAndroid Build Coastguard Worker   const off64_t fd_offset_ = 0;
57*adcb0a62SAndroid Build Coastguard Worker 
58*adcb0a62SAndroid Build Coastguard Worker   const void* base_ptr_ = nullptr;
59*adcb0a62SAndroid Build Coastguard Worker   mutable off64_t data_length_ = -1;
60*adcb0a62SAndroid Build Coastguard Worker };
61*adcb0a62SAndroid Build Coastguard Worker 
62*adcb0a62SAndroid Build Coastguard Worker class CentralDirectory {
63*adcb0a62SAndroid Build Coastguard Worker  public:
CentralDirectory(void)64*adcb0a62SAndroid Build Coastguard Worker   CentralDirectory(void) : base_ptr_(nullptr), length_(0) {}
65*adcb0a62SAndroid Build Coastguard Worker 
GetBasePtr()66*adcb0a62SAndroid Build Coastguard Worker   const uint8_t* GetBasePtr() const { return base_ptr_; }
67*adcb0a62SAndroid Build Coastguard Worker 
GetMapLength()68*adcb0a62SAndroid Build Coastguard Worker   size_t GetMapLength() const { return length_; }
69*adcb0a62SAndroid Build Coastguard Worker 
70*adcb0a62SAndroid Build Coastguard Worker   void Initialize(const void* map_base_ptr, off64_t cd_start_offset, size_t cd_size);
71*adcb0a62SAndroid Build Coastguard Worker 
72*adcb0a62SAndroid Build Coastguard Worker  private:
73*adcb0a62SAndroid Build Coastguard Worker   const uint8_t* base_ptr_;
74*adcb0a62SAndroid Build Coastguard Worker   size_t length_;
75*adcb0a62SAndroid Build Coastguard Worker };
76*adcb0a62SAndroid Build Coastguard Worker 
77*adcb0a62SAndroid Build Coastguard Worker struct ZipArchive {
78*adcb0a62SAndroid Build Coastguard Worker   // open Zip archive
79*adcb0a62SAndroid Build Coastguard Worker   mutable MappedZipFile mapped_zip;
80*adcb0a62SAndroid Build Coastguard Worker   const bool close_file;
81*adcb0a62SAndroid Build Coastguard Worker 
82*adcb0a62SAndroid Build Coastguard Worker   // mapped central directory area
83*adcb0a62SAndroid Build Coastguard Worker   off64_t directory_offset;
84*adcb0a62SAndroid Build Coastguard Worker   CentralDirectory central_directory;
85*adcb0a62SAndroid Build Coastguard Worker   std::unique_ptr<android::base::MappedFile> directory_map;
86*adcb0a62SAndroid Build Coastguard Worker 
87*adcb0a62SAndroid Build Coastguard Worker   // number of entries in the Zip archive
88*adcb0a62SAndroid Build Coastguard Worker   uint64_t num_entries;
89*adcb0a62SAndroid Build Coastguard Worker   std::unique_ptr<CdEntryMapInterface> cd_entry_map;
90*adcb0a62SAndroid Build Coastguard Worker 
91*adcb0a62SAndroid Build Coastguard Worker   ZipArchive(MappedZipFile&& map, bool assume_ownership);
92*adcb0a62SAndroid Build Coastguard Worker   ZipArchive(const void* address, size_t length);
93*adcb0a62SAndroid Build Coastguard Worker   ~ZipArchive();
94*adcb0a62SAndroid Build Coastguard Worker 
95*adcb0a62SAndroid Build Coastguard Worker   bool InitializeCentralDirectory(off64_t cd_start_offset, size_t cd_size);
96*adcb0a62SAndroid Build Coastguard Worker };
97*adcb0a62SAndroid Build Coastguard Worker 
98*adcb0a62SAndroid Build Coastguard Worker // Reads the unaligned data of type |T| and auto increment the offset.
99*adcb0a62SAndroid Build Coastguard Worker template <typename T>
ConsumeUnaligned(uint8_t ** address)100*adcb0a62SAndroid Build Coastguard Worker static T ConsumeUnaligned(uint8_t** address) {
101*adcb0a62SAndroid Build Coastguard Worker   auto ret = android::base::get_unaligned<T>(*address);
102*adcb0a62SAndroid Build Coastguard Worker   *address += sizeof(T);
103*adcb0a62SAndroid Build Coastguard Worker   return ret;
104*adcb0a62SAndroid Build Coastguard Worker }
105*adcb0a62SAndroid Build Coastguard Worker 
106*adcb0a62SAndroid Build Coastguard Worker template <typename T>
ConsumeUnaligned(const uint8_t ** address)107*adcb0a62SAndroid Build Coastguard Worker static T ConsumeUnaligned(const uint8_t** address) {
108*adcb0a62SAndroid Build Coastguard Worker   return ConsumeUnaligned<T>(const_cast<uint8_t**>(address));
109*adcb0a62SAndroid Build Coastguard Worker }
110*adcb0a62SAndroid Build Coastguard Worker 
111*adcb0a62SAndroid Build Coastguard Worker // Writes the unaligned data of type |T| and auto increment the offset.
112*adcb0a62SAndroid Build Coastguard Worker template <typename T>
EmitUnaligned(uint8_t ** address,T data)113*adcb0a62SAndroid Build Coastguard Worker void EmitUnaligned(uint8_t** address, T data) {
114*adcb0a62SAndroid Build Coastguard Worker   android::base::put_unaligned<T>(*address, data);
115*adcb0a62SAndroid Build Coastguard Worker   *address += sizeof(T);
116*adcb0a62SAndroid Build Coastguard Worker }
117