LIEF: Library to Instrument Executable Formats Version 0.17.0
Loading...
Searching...
No Matches
MachO/Builder.hpp
Go to the documentation of this file.
1/* Copyright 2017 - 2025 R. Thomas
2 * Copyright 2017 - 2025 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_MACHO_BUIDLER_H
17#define LIEF_MACHO_BUIDLER_H
18
19#include <vector>
20
21#include "LIEF/errors.hpp"
22#include "LIEF/visibility.h"
23
24#include "LIEF/iostream.hpp"
25
26namespace LIEF {
27namespace MachO {
28
29class AtomInfo;
30class Binary;
31class BuildVersion;
32class CodeSignature;
34class DataInCode;
36class DyldEnvironment;
37class DyldExportsTrie;
38class DyldInfo;
39class DylibCommand;
40class DylinkerCommand;
42class EncryptionInfo;
43class FatBinary;
44class FunctionStarts;
45class LinkerOptHint;
46class MainCommand;
47class RPathCommand;
48class Routine;
50class SourceVersion;
51class SubClient;
52class SubFramework;
53class SymbolCommand;
54class ThreadCommand;
55class TwoLevelHints;
56class VersionMin;
57class LIEF_API Builder {
60 public: struct config_t {
63 bool linkedit = true;
64 };
65
66 Builder() = delete;
67
68 static ok_error_t write(Binary& binary, const std::string& filename);
69 static ok_error_t write(Binary& binary, const std::string& filename, config_t config);
70
71 static ok_error_t write(Binary& binary, std::vector<uint8_t>& out);
72 static ok_error_t write(Binary& binary, std::vector<uint8_t>& out, config_t config);
73
74 static ok_error_t write(Binary& binary, std::ostream& out);
75 static ok_error_t write(Binary& binary, std::ostream& out, config_t config);
76
77 static ok_error_t write(FatBinary& fat, const std::string& filename);
78 static ok_error_t write(FatBinary& fat, const std::string& filename, config_t config);
79
80 static ok_error_t write(FatBinary& fat, std::vector<uint8_t>& out);
81 static ok_error_t write(FatBinary& fat, std::vector<uint8_t>& out, config_t config);
82
83 static ok_error_t write(FatBinary& fat, std::ostream& out);
84 static ok_error_t write(FatBinary& fat, std::ostream& out, config_t config);
85
87 private:
88 LIEF_LOCAL ok_error_t build();
89
90 LIEF_LOCAL const std::vector<uint8_t>& get_build();
91 LIEF_LOCAL ok_error_t write(const std::string& filename) const;
92 LIEF_LOCAL ok_error_t write(std::ostream& os) const;
93
94 LIEF_LOCAL Builder(Binary& binary, config_t config);
95 LIEF_LOCAL Builder(std::vector<Binary*> binaries, config_t config);
96
97 LIEF_LOCAL static std::vector<uint8_t> build_raw(Binary& binary, config_t config);
98 LIEF_LOCAL static std::vector<uint8_t> build_raw(FatBinary& binary, config_t config);
99
100 template<typename T>
101 LIEF_LOCAL ok_error_t build();
102
103 LIEF_LOCAL ok_error_t build_fat();
104 LIEF_LOCAL ok_error_t build_fat_header();
105 LIEF_LOCAL ok_error_t build_load_commands();
106
107 template<typename T>
108 LIEF_LOCAL ok_error_t build_header();
109
110 template<typename T>
111 LIEF_LOCAL ok_error_t build_linkedit();
112
113 template<typename T>
114 LIEF_LOCAL ok_error_t build(DylibCommand& library);
115
116 template<typename T>
117 LIEF_LOCAL ok_error_t build(DylinkerCommand& linker);
118
119 template<class T>
120 LIEF_LOCAL ok_error_t build(VersionMin& version_min);
121
122 template<class T>
123 LIEF_LOCAL ok_error_t build(SourceVersion& source_version);
124
125 template<class T>
126 LIEF_LOCAL ok_error_t build(FunctionStarts& function_starts);
127
128 template<class T>
129 LIEF_LOCAL ok_error_t build(MainCommand& main_cmd);
130
131 template<class T>
132 LIEF_LOCAL ok_error_t build(Routine& routine);
133
134 template<class T>
135 LIEF_LOCAL ok_error_t build(RPathCommand& rpath_cmd);
136
137 template<class T>
138 LIEF_LOCAL ok_error_t build(DyldInfo& dyld_info);
139
140 template<class T>
141 LIEF_LOCAL ok_error_t build(SymbolCommand& symbol_command);
142
143 template<class T>
144 LIEF_LOCAL ok_error_t build(DynamicSymbolCommand& symbol_command);
145
146 template<class T>
147 LIEF_LOCAL ok_error_t build(DataInCode& datacode);
148
149 template<class T>
150 LIEF_LOCAL ok_error_t build(CodeSignature& code_signature);
151
152 template<class T>
153 LIEF_LOCAL ok_error_t build(SegmentSplitInfo& ssi);
154
155 template<class T>
156 LIEF_LOCAL ok_error_t build(SubFramework& sf);
157
158 template<class T>
159 LIEF_LOCAL ok_error_t build(SubClient& sf);
160
161 template<class T>
162 LIEF_LOCAL ok_error_t build(DyldEnvironment& de);
163
164 template<class T>
165 LIEF_LOCAL ok_error_t build(ThreadCommand& tc);
166
167 template<class T>
168 LIEF_LOCAL ok_error_t build(DyldChainedFixups& fixups);
169
170 template<class T>
171 LIEF_LOCAL ok_error_t build(DyldExportsTrie& exports);
172
173 template<class T>
174 LIEF_LOCAL ok_error_t build(TwoLevelHints& two);
175
176 template<class T>
177 LIEF_LOCAL ok_error_t build(LinkerOptHint& opt);
178
179 template<class T>
180 LIEF_LOCAL ok_error_t build(AtomInfo& opt);
181
182 template<class T>
183 LIEF_LOCAL ok_error_t build(CodeSignatureDir& sig);
184
185 template<class T>
186 LIEF_LOCAL ok_error_t build(EncryptionInfo& tc);
187
188 template <typename T>
189 LIEF_LOCAL ok_error_t build_segments();
190
191 template<class T>
192 LIEF_LOCAL ok_error_t build(BuildVersion& bv);
193
194 template <typename T>
195 LIEF_LOCAL ok_error_t build_symbols();
196
197 LIEF_LOCAL ok_error_t build_uuid();
198
199 template <typename T>
200 LIEF_LOCAL ok_error_t update_fixups(DyldChainedFixups& fixups);
201
202 std::vector<Binary*> binaries_;
203 Binary* binary_ = nullptr;
204 mutable vector_iostream raw_;
205 uint64_t linkedit_offset_ = 0;
206 mutable vector_iostream linkedit_;
207 config_t config_;
208};
209
210} // namespace MachO
211} // namespace LIEF
212#endif
Class which represents the LC_ATOM_INFO command.
Definition AtomInfo.hpp:36
Class which represents a MachO binary.
Definition MachO/Binary.hpp:86
Definition BuildVersion.hpp:34
Class used to rebuild a Mach-O file.
Definition MachO/Builder.hpp:59
static ok_error_t write(FatBinary &fat, std::ostream &out)
static ok_error_t write(Binary &binary, const std::string &filename)
static ok_error_t write(FatBinary &fat, std::vector< uint8_t > &out, config_t config)
static ok_error_t write(FatBinary &fat, const std::string &filename, config_t config)
static ok_error_t write(FatBinary &fat, const std::string &filename)
static ok_error_t write(FatBinary &fat, std::vector< uint8_t > &out)
static ok_error_t write(Binary &binary, std::ostream &out, config_t config)
static ok_error_t write(FatBinary &fat, std::ostream &out, config_t config)
~Builder()
Builder()=delete
static ok_error_t write(Binary &binary, std::vector< uint8_t > &out, config_t config)
static ok_error_t write(Binary &binary, std::ostream &out)
static ok_error_t write(Binary &binary, std::vector< uint8_t > &out)
static ok_error_t write(Binary &binary, const std::string &filename, config_t config)
Definition CodeSignatureDir.hpp:36
Definition CodeSignature.hpp:37
Interface of the LC_DATA_IN_CODE command This command is used to list slices of code sections that co...
Definition DataInCode.hpp:42
Class that represents the LC_DYLD_CHAINED_FIXUPS command.
Definition DyldChainedFixups.hpp:49
Class that represents a LC_DYLD_ENVIRONMENT command which is used by the Mach-O linker/loader to init...
Definition DyldEnvironment.hpp:34
Class that represents the LC_DYLD_EXPORTS_TRIE command.
Definition DyldExportsTrie.hpp:40
Class that represents the LC_DYLD_INFO and LC_DYLD_INFO_ONLY commands.
Definition DyldInfo.hpp:50
Class which represents a library dependency.
Definition DylibCommand.hpp:34
Class that represents the Mach-O linker, also named loader. Most of the time, DylinkerCommand::name()...
Definition DylinkerCommand.hpp:34
Class that represents the LC_DYSYMTAB command.
Definition DynamicSymbolCommand.hpp:40
Class that represents the LC_ENCRYPTION_INFO / LC_ENCRYPTION_INFO_64 commands.
Definition EncryptionInfo.hpp:35
Class which represent a Mach-O (fat) binary This object is also used for representing Mach-O binaries...
Definition FatBinary.hpp:36
Class which represents the LC_FUNCTION_STARTS command.
Definition FunctionStarts.hpp:39
Class which represents the LC_LINKER_OPTIMIZATION_HINT command.
Definition LinkerOptHint.hpp:37
Class that represent the LC_MAIN command. This kind of command can be used to determine the entrypoin...
Definition MainCommand.hpp:33
Class that represents the LC_RPATH command.
Definition RPathCommand.hpp:36
Class that represents the LC_ROUTINE/LC_ROUTINE64 commands. Accodring to the Mach-O loader....
Definition Routine.hpp:38
Class that represents the LoadCommand::TYPE::SEGMENT_SPLIT_INFO command.
Definition SegmentSplitInfo.hpp:35
Class that represents the MachO LoadCommand::TYPE::SOURCE_VERSION This command is used to provide the...
Definition SourceVersion.hpp:35
Class that represents the SubClient command. Accodring to the Mach-O loader.h documentation:
Definition SubClient.hpp:43
Class that represents the SubFramework command. Accodring to the Mach-O loader.h documentation:
Definition SubFramework.hpp:46
Class that represents the LC_SYMTAB command.
Definition SymbolCommand.hpp:35
Class that represents the LC_THREAD / LC_UNIXTHREAD commands and that can be used to get the binary e...
Definition ThreadCommand.hpp:41
Class which represents the LC_TWOLEVEL_HINTS command.
Definition TwoLevelHints.hpp:39
Class that wraps the LC_VERSION_MIN_MACOSX, LC_VERSION_MIN_IPHONEOS, ... commands.
Definition VersionMin.hpp:33
Namespace related to the LIEF's Mach-O module.
Definition Abstract/Header.hpp:36
LIEF namespace.
Definition Abstract/Binary.hpp:36
result< ok_t > ok_error_t
Opaque structure that is used by LIEF to avoid writing result<void> f(...). Instead,...
Definition errors.hpp:109
#define LIEF_API
Definition visibility.h:41
#define LIEF_LOCAL
Definition visibility.h:42