LIEF: Library to Instrument Executable Formats Version 0.15.1
Loading...
Searching...
No Matches
PE/Section.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2024 R. Thomas
2 * Copyright 2017 - 2024 Quarkslab
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#ifndef LIEF_PE_SECTION_H
17#define LIEF_PE_SECTION_H
18#include <ostream>
19#include <vector>
20#include <string>
21#include <set>
22
23#include "LIEF/visibility.h"
25#include "LIEF/enums.hpp"
26#include "LIEF/PE/enums.hpp"
27
28namespace LIEF {
29namespace PE {
30
31class Parser;
32class Builder;
33class Binary;
34
35namespace details {
36struct pe_section;
37}
38
41
42 friend class Parser;
43 friend class Builder;
44 friend class Binary;
45
46 public:
48 static constexpr size_t MAX_SECTION_NAME = 8;
49
50 enum class CHARACTERISTICS: uint64_t {
51 TYPE_NO_PAD = 0x00000008,
52 CNT_CODE = 0x00000020,
53 CNT_INITIALIZED_DATA = 0x00000040,
54 CNT_UNINITIALIZED_DATA = 0x00000080,
55 LNK_OTHER = 0x00000100,
56 LNK_INFO = 0x00000200,
57 LNK_REMOVE = 0x00000800,
58 LNK_COMDAT = 0x00001000,
59 GPREL = 0x00008000,
60 MEM_PURGEABLE = 0x00010000,
61 MEM_16BIT = 0x00020000,
62 MEM_LOCKED = 0x00040000,
63 MEM_PRELOAD = 0x00080000,
64 ALIGN_1BYTES = 0x00100000,
65 ALIGN_2BYTES = 0x00200000,
66 ALIGN_4BYTES = 0x00300000,
67 ALIGN_8BYTES = 0x00400000,
68 ALIGN_16BYTES = 0x00500000,
69 ALIGN_32BYTES = 0x00600000,
70 ALIGN_64BYTES = 0x00700000,
71 ALIGN_128BYTES = 0x00800000,
72 ALIGN_256BYTES = 0x00900000,
73 ALIGN_512BYTES = 0x00A00000,
74 ALIGN_1024BYTES = 0x00B00000,
75 ALIGN_2048BYTES = 0x00C00000,
76 ALIGN_4096BYTES = 0x00D00000,
77 ALIGN_8192BYTES = 0x00E00000,
78 LNK_NRELOC_OVFL = 0x01000000,
79 MEM_DISCARDABLE = 0x02000000,
80 MEM_NOT_CACHED = 0x04000000,
81 MEM_NOT_PAGED = 0x08000000,
82 MEM_SHARED = 0x10000000,
83 MEM_EXECUTE = 0x20000000,
84 MEM_READ = 0x40000000,
85 MEM_WRITE = 0x80000000
86 };
87
88 Section(const details::pe_section& header);
89 Section() = default;
90 Section(const std::vector<uint8_t>& data,
91 const std::string& name = "", uint32_t characteristics = 0);
92 Section(const std::string& name);
93
94 Section& operator=(const Section&) = default;
95 Section(const Section&) = default;
96 ~Section() override = default;
97
99 uint32_t sizeof_raw_data() const;
100
104 uint32_t virtual_size() const {
105 return virtual_size_;
106 }
107
109 span<const uint8_t> content() const override {
110 return content_;
111 }
112
115 return padding_;
116 }
117
119 uint32_t pointerto_raw_data() const;
120
126 uint32_t pointerto_relocation() const {
127 return pointer_to_relocations_;
128 }
129
133 uint32_t pointerto_line_numbers() const {
134 return pointer_to_linenumbers_;
135 }
136
138 uint16_t numberof_relocations() const {
139 return number_of_relocations_;
140 }
141
143 uint16_t numberof_line_numbers() const {
144 return number_of_linenumbers_;
145 }
146
150 uint32_t characteristics() const {
151 return characteristics_;
152 }
153
155 bool is_type(PE_SECTION_TYPES type) const;
156
158 const std::set<PE_SECTION_TYPES>& types() const;
159
162 return (characteristics() & static_cast<size_t>(c)) > 0;
163 }
164
166 std::vector<CHARACTERISTICS> characteristics_list() const;
167
169 void clear(uint8_t c);
170 void content(const std::vector<uint8_t>& data) override;
171
172 void name(std::string name) override;
173
174 void virtual_size(uint32_t virtual_sz) {
175 virtual_size_ = virtual_sz;
176 }
177
178 void pointerto_raw_data(uint32_t ptr);
179
180 void pointerto_relocation(uint32_t ptr) {
181 pointer_to_relocations_ = ptr;
182 }
183
184 void pointerto_line_numbers(uint32_t ptr) {
185 pointer_to_linenumbers_ = ptr;
186 }
187
188 void numberof_relocations(uint16_t nb) {
189 number_of_relocations_ = nb;
190 }
191
192 void numberof_line_numbers(uint16_t nb) {
193 number_of_linenumbers_ = nb;
194 }
195
196 void sizeof_raw_data(uint32_t sizeOfRawData);
197
198 void characteristics(uint32_t characteristics) {
199 characteristics_ = characteristics;
200 }
201
205
207 characteristics_ &= ~static_cast<size_t>(characteristic);
208 return *this;
209 }
210
212 characteristics_ |= static_cast<size_t>(characteristic);
213 return *this;
214 }
215
216 void accept(Visitor& visitor) const override;
217
218 LIEF_API friend std::ostream& operator<<(std::ostream& os, const Section& section);
219
220 private:
221 span<uint8_t> writable_content() {
222 return content_;
223 }
224
225 std::vector<uint8_t> content_;
226 std::vector<uint8_t> padding_;
227 uint32_t virtual_size_ = 0;
228 uint32_t pointer_to_relocations_ = 0;
229 uint32_t pointer_to_linenumbers_ = 0;
230 uint16_t number_of_relocations_ = 0;
231 uint16_t number_of_linenumbers_ = 0;
232 uint32_t characteristics_ = 0;
233 std::set<PE_SECTION_TYPES> types_ = {PE_SECTION_TYPES::UNKNOWN};
234};
235
237
238} // namespace PE
239} // namespace LIEF
240
242
243#endif
Class which represents a PE binary This is the main interface to manage and modify a PE executable.
Definition PE/Binary.hpp:52
Class that is used to rebuild a raw PE binary from a PE::Binary object.
Definition PE/Builder.hpp:45
Main interface to parse PE binaries. In particular the static functions: Parser::parse should be used...
Definition PE/Parser.hpp:47
Class which represents a PE section.
Definition PE/Section.hpp:40
void type(PE_SECTION_TYPES type)
void sizeof_raw_data(uint32_t sizeOfRawData)
Section(const Section &)=default
uint32_t pointerto_line_numbers() const
The file pointer to the beginning of line-number entries for the section. This is set to zero if ther...
Definition PE/Section.hpp:133
uint32_t pointerto_relocation() const
The file pointer to the beginning of the COFF relocation entries for the section. This is set to zero...
Definition PE/Section.hpp:126
Section & remove_characteristic(CHARACTERISTICS characteristic)
Definition PE/Section.hpp:206
const std::set< PE_SECTION_TYPES > & types() const
Deprecated do not use. It will likely change in a future release of LIEF.
friend std::ostream & operator<<(std::ostream &os, const Section &section)
Section & operator=(const Section &)=default
bool has_characteristic(CHARACTERISTICS c) const
Check if the section has the given CHARACTERISTICS.
Definition PE/Section.hpp:161
uint16_t numberof_line_numbers() const
No longer used in recent PE binaries produced by Visual Studio.
Definition PE/Section.hpp:143
Section(const std::vector< uint8_t > &data, const std::string &name="", uint32_t characteristics=0)
~Section() override=default
CHARACTERISTICS
Definition PE/Section.hpp:50
span< const uint8_t > content() const override
The actual content of the section.
Definition PE/Section.hpp:109
void clear(uint8_t c)
Fill the content of the section with the given char
void pointerto_raw_data(uint32_t ptr)
std::vector< CHARACTERISTICS > characteristics_list() const
List of the section characteristics as a std::set.
uint32_t characteristics() const
Characteristics of the section: it provides information about the permissions of the section when map...
Definition PE/Section.hpp:150
void name(std::string name) override
Change the section's name.
Section(const std::string &name)
void pointerto_relocation(uint32_t ptr)
Definition PE/Section.hpp:180
uint32_t sizeof_raw_data() const
Return the size of the data in the section.
span< const uint8_t > padding() const
Content of the section's padding area.
Definition PE/Section.hpp:114
void pointerto_line_numbers(uint32_t ptr)
Definition PE/Section.hpp:184
void characteristics(uint32_t characteristics)
Definition PE/Section.hpp:198
void virtual_size(uint32_t virtual_sz)
Definition PE/Section.hpp:174
void content(const std::vector< uint8_t > &data) override
Change section content.
uint32_t pointerto_raw_data() const
The offset of the section data in the PE file.
void add_type(PE_SECTION_TYPES type)
void remove_type(PE_SECTION_TYPES type)
void numberof_line_numbers(uint16_t nb)
Definition PE/Section.hpp:192
Section(const details::pe_section &header)
uint16_t numberof_relocations() const
No longer used in recent PE binaries produced by Visual Studio.
Definition PE/Section.hpp:138
bool is_type(PE_SECTION_TYPES type) const
Deprecated do not use. It will likely change in a future release of LIEF.
void accept(Visitor &visitor) const override
uint32_t virtual_size() const
Return the size of the data when mapped in memory.
Definition PE/Section.hpp:104
Section & add_characteristic(CHARACTERISTICS characteristic)
Definition PE/Section.hpp:211
void numberof_relocations(uint16_t nb)
Definition PE/Section.hpp:188
Class which represents an abstracted section.
Definition Abstract/Section.hpp:29
virtual std::string name() const
section's name
Definition Abstract/Section.hpp:44
Definition Visitor.hpp:224
#define ENABLE_BITMASK_OPERATORS(X)
Definition enums.hpp:24
PE_SECTION_TYPES
Common section type.
Definition PE/enums.hpp:666
const char * to_string(DataDirectory::TYPES e)
LIEF namespace.
Definition Abstract/Binary.hpp:32
tcb::span< ElementType, Extent > span
Definition span.hpp:22
#define LIEF_API
Definition visibility.h:41