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 - 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_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 FatBinary;
43class FunctionStarts;
44class LinkerOptHint;
45class MainCommand;
46class Routine;
48class SourceVersion;
49class SubFramework;
50class SubClient;
51class SymbolCommand;
52class ThreadCommand;
53class TwoLevelHints;
54class VersionMin;
55class RPathCommand;
56class LIEF_API Builder {
59 public: struct config_t {
62 bool linkedit = true;
63 };
64
65 Builder() = delete;
66
67 static ok_error_t write(Binary& binary, const std::string& filename);
68 static ok_error_t write(Binary& binary, const std::string& filename, config_t config);
69
70 static ok_error_t write(Binary& binary, std::vector<uint8_t>& out);
71 static ok_error_t write(Binary& binary, std::vector<uint8_t>& out, config_t config);
72
73 static ok_error_t write(Binary& binary, std::ostream& out);
74 static ok_error_t write(Binary& binary, std::ostream& out, config_t config);
75
76 static ok_error_t write(FatBinary& fat, const std::string& filename);
77 static ok_error_t write(FatBinary& fat, const std::string& filename, config_t config);
78
79 static ok_error_t write(FatBinary& fat, std::vector<uint8_t>& out);
80 static ok_error_t write(FatBinary& fat, std::vector<uint8_t>& out, config_t config);
81
82 static ok_error_t write(FatBinary& fat, std::ostream& out);
83 static ok_error_t write(FatBinary& fat, std::ostream& out, config_t config);
84
86 private:
87 LIEF_LOCAL ok_error_t build();
88
89 LIEF_LOCAL const std::vector<uint8_t>& get_build();
90 LIEF_LOCAL ok_error_t write(const std::string& filename) const;
91 LIEF_LOCAL ok_error_t write(std::ostream& os) const;
92
93 LIEF_LOCAL Builder(Binary& binary, config_t config);
94 LIEF_LOCAL Builder(std::vector<Binary*> binaries, config_t config);
95
96 LIEF_LOCAL static std::vector<uint8_t> build_raw(Binary& binary, config_t config);
97 LIEF_LOCAL static std::vector<uint8_t> build_raw(FatBinary& binary, config_t config);
98
99 template<typename T>
100 LIEF_LOCAL ok_error_t build();
101
102 LIEF_LOCAL ok_error_t build_fat();
103 LIEF_LOCAL ok_error_t build_fat_header();
104 LIEF_LOCAL ok_error_t build_load_commands();
105
106 template<typename T>
107 LIEF_LOCAL ok_error_t build_header();
108
109 template<typename T>
110 LIEF_LOCAL ok_error_t build_linkedit();
111
112 template<typename T>
113 LIEF_LOCAL ok_error_t build(DylibCommand& library);
114
115 template<typename T>
116 LIEF_LOCAL ok_error_t build(DylinkerCommand& linker);
117
118 template<class T>
119 LIEF_LOCAL ok_error_t build(VersionMin& version_min);
120
121 template<class T>
122 LIEF_LOCAL ok_error_t build(SourceVersion& source_version);
123
124 template<class T>
125 LIEF_LOCAL ok_error_t build(FunctionStarts& function_starts);
126
127 template<class T>
128 LIEF_LOCAL ok_error_t build(MainCommand& main_cmd);
129
130 template<class T>
131 LIEF_LOCAL ok_error_t build(Routine& routine);
132
133 template<class T>
134 LIEF_LOCAL ok_error_t build(RPathCommand& rpath_cmd);
135
136 template<class T>
137 LIEF_LOCAL ok_error_t build(DyldInfo& dyld_info);
138
139 template<class T>
140 LIEF_LOCAL ok_error_t build(SymbolCommand& symbol_command);
141
142 template<class T>
143 LIEF_LOCAL ok_error_t build(DynamicSymbolCommand& symbol_command);
144
145 template<class T>
146 LIEF_LOCAL ok_error_t build(DataInCode& datacode);
147
148 template<class T>
149 LIEF_LOCAL ok_error_t build(CodeSignature& code_signature);
150
151 template<class T>
152 LIEF_LOCAL ok_error_t build(SegmentSplitInfo& ssi);
153
154 template<class T>
155 LIEF_LOCAL ok_error_t build(SubFramework& sf);
156
157 template<class T>
158 LIEF_LOCAL ok_error_t build(SubClient& sf);
159
160 template<class T>
161 LIEF_LOCAL ok_error_t build(DyldEnvironment& de);
162
163 template<class T>
164 LIEF_LOCAL ok_error_t build(ThreadCommand& tc);
165
166 template<class T>
167 LIEF_LOCAL ok_error_t build(DyldChainedFixups& fixups);
168
169 template<class T>
170 LIEF_LOCAL ok_error_t build(DyldExportsTrie& exports);
171
172 template<class T>
173 LIEF_LOCAL ok_error_t build(TwoLevelHints& two);
174
175 template<class T>
176 LIEF_LOCAL ok_error_t build(LinkerOptHint& opt);
177
178 template<class T>
179 LIEF_LOCAL ok_error_t build(AtomInfo& opt);
180
181 template<class T>
182 LIEF_LOCAL ok_error_t build(CodeSignatureDir& sig);
183
184 template <typename T>
185 LIEF_LOCAL ok_error_t build_segments();
186
187 template<class T>
188 LIEF_LOCAL ok_error_t build(BuildVersion& bv);
189
190 template <typename T>
191 LIEF_LOCAL ok_error_t build_symbols();
192
193 LIEF_LOCAL ok_error_t build_uuid();
194
195 template <typename T>
196 LIEF_LOCAL ok_error_t update_fixups(DyldChainedFixups& fixups);
197
198 std::vector<Binary*> binaries_;
199 Binary* binary_ = nullptr;
200 mutable vector_iostream raw_;
201 uint64_t linkedit_offset_ = 0;
202 mutable vector_iostream linkedit_;
203 config_t config_;
204};
205
206} // namespace MachO
207} // namespace LIEF
208#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:58
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 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