summaryrefslogtreecommitdiffstats
path: root/src/corelib/plugin/qmachparser.cpp
blob: db4453dffebe8c9450ecac686835c7f98bb4a53d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
/****************************************************************************
**
** Copyright (C) 2016 Intel Corporation.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmachparser_p.h"

#if defined(Q_OF_MACH_O)

#include <qendian.h>

#include <mach-o/loader.h>
#include <mach-o/fat.h>

QT_BEGIN_NAMESPACE

#if defined(Q_PROCESSOR_X86_64)
#  define MACHO64
static const cpu_type_t my_cputype = CPU_TYPE_X86_64;
#elif defined(Q_PROCESSOR_X86_32)
static const cpu_type_t my_cputype = CPU_TYPE_X86;
#elif defined(Q_PROCESSOR_POWER_64)
#  define MACHO64
static const cpu_type_t my_cputype = CPU_TYPE_POWERPC64;
#elif defined(Q_PROCESSOR_POWER_32)
static const cpu_type_t my_cputype = CPU_TYPE_POWERPC;
#elif defined(Q_PROCESSOR_ARM_64)
#  define MACHO64
static const cpu_type_t my_cputype = CPU_TYPE_ARM64;
#elif defined(Q_PROCESSOR_ARM)
static const cpu_type_t my_cputype = CPU_TYPE_ARM;
#else
#  error "Unknown CPU type"
#endif

#ifdef MACHO64
#  undef MACHO64
typedef mach_header_64 my_mach_header;
typedef segment_command_64 my_segment_command;
typedef section_64 my_section;
static const uint32_t my_magic = MH_MAGIC_64;
#else
typedef mach_header my_mach_header;
typedef segment_command my_segment_command;
typedef section my_section;
static const uint32_t my_magic = MH_MAGIC;
#endif

Q_DECL_COLD_FUNCTION
static QLibraryScanResult ns(const QString &reason, const QString &library, QString *errorString)
{
    if (errorString)
        *errorString = QLibrary::tr("'%1' is not a valid Mach-O binary (%2)")
                .arg(library, reason.isEmpty() ? QLibrary::tr("file is corrupt") : reason);
    return {};
}

QLibraryScanResult  QMachOParser::parse(const char *m_s, ulong fdlen, const QString &library, QString *errorString)
{
    // The minimum size of a Mach-O binary we're interested in.
    // It must have a full Mach header, at least one segment and at least one
    // section. It's probably useless with just the "qtmetadata" section, but
    // it's valid nonetheless.
    // A fat binary must have this plus the fat header, of course.
    static const size_t MinFileSize = sizeof(my_mach_header) + sizeof(my_segment_command) + sizeof(my_section);
    static const size_t MinFatHeaderSize = sizeof(fat_header) + 2 * sizeof(fat_arch);

    if (Q_UNLIKELY(fdlen < MinFileSize))
        return ns(QLibrary::tr("file too small"), library, errorString);

    // find out if this is a fat Mach-O binary first
    const my_mach_header *header = nullptr;
    const fat_header *fat = reinterpret_cast<const fat_header *>(m_s);
    if (fat->magic == qToBigEndian(FAT_MAGIC)) {
        // find our architecture in the binary
        const fat_arch *arch = reinterpret_cast<const fat_arch *>(fat + 1);
        if (Q_UNLIKELY(fdlen < MinFatHeaderSize)) {
            return ns(QLibrary::tr("file too small"), library, errorString);
        }

        int count = qFromBigEndian(fat->nfat_arch);
        if (Q_UNLIKELY(fdlen < sizeof(*fat) + sizeof(*arch) * count))
            return ns(QString(), library, errorString);

        for (int i = 0; i < count; ++i) {
            if (arch[i].cputype == qToBigEndian(my_cputype)) {
                // ### should we check the CPU subtype? Maybe on ARM?
                uint32_t size = qFromBigEndian(arch[i].size);
                uint32_t offset = qFromBigEndian(arch[i].offset);
                if (Q_UNLIKELY(size > fdlen) || Q_UNLIKELY(offset > fdlen)
                        || Q_UNLIKELY(size + offset > fdlen) || Q_UNLIKELY(size < MinFileSize))
                    return ns(QString(), library, errorString);

                header = reinterpret_cast<const my_mach_header *>(m_s + offset);
                fdlen = size;
                break;
            }
        }
        if (!header)
            return ns(QLibrary::tr("no suitable architecture in fat binary"), library, errorString);

        // check the magic again
        if (Q_UNLIKELY(header->magic != my_magic))
            return ns(QString(), library, errorString);
    } else {
        header = reinterpret_cast<const my_mach_header *>(m_s);
        fat = 0;

        // check magic
        if (header->magic != my_magic)
            return ns(QLibrary::tr("invalid magic %1").arg(qFromBigEndian(header->magic), 8, 16, QLatin1Char('0')),
                      library, errorString);
    }

    // from this point on, everything is in host byte order

    // (re-)check the CPU type
    // ### should we check the CPU subtype? Maybe on ARM?
    if (header->cputype != my_cputype) {
        if (fat)
            return ns(QString(), library, errorString);
        return ns(QLibrary::tr("wrong architecture"), library, errorString);
    }

    // check the file type
    if (Q_UNLIKELY(header->filetype != MH_BUNDLE && header->filetype != MH_DYLIB))
        return ns(QLibrary::tr("not a dynamic library"), library, errorString);

    // find the __TEXT segment, "qtmetadata" section
    const my_segment_command *seg = reinterpret_cast<const my_segment_command *>(header + 1);
    ulong minsize = sizeof(*header);

    for (uint i = 0; i < header->ncmds; ++i,
         seg = reinterpret_cast<const my_segment_command *>(reinterpret_cast<const char *>(seg) + seg->cmdsize)) {
        // We're sure that the file size includes at least one load command
        // but we have to check anyway if we're past the first
        if (Q_UNLIKELY(fdlen < minsize + sizeof(load_command)))
            return ns(QString(), library, errorString);

        // cmdsize can't be trusted until validated
        // so check it against fdlen anyway
        // (these are unsigned operations, with overflow behavior specified in the standard)
        minsize += seg->cmdsize;
        if (Q_UNLIKELY(fdlen < minsize) || Q_UNLIKELY(fdlen < seg->cmdsize))
            return ns(QString(), library, errorString);

        const uint32_t MyLoadCommand = sizeof(void *) > 4 ? LC_SEGMENT_64 : LC_SEGMENT;
        if (seg->cmd != MyLoadCommand)
            continue;

        // is this the __TEXT segment?
        if (strcmp(seg->segname, "__TEXT") == 0) {
            const my_section *sect = reinterpret_cast<const my_section *>(seg + 1);
            for (uint j = 0; j < seg->nsects; ++j) {
                // is this the "qtmetadata" section?
                if (strcmp(sect[j].sectname, "qtmetadata") != 0)
                    continue;

                // found it!
                if (Q_UNLIKELY(fdlen < sect[j].offset) || Q_UNLIKELY(fdlen < sect[j].size)
                        || Q_UNLIKELY(fdlen < sect[j].offset + sect[j].size))
                    return ns(QString(), library, errorString);

                qsizetype pos = reinterpret_cast<const char *>(header) - m_s + sect[j].offset;
                return { pos, qsizetype(sect[j].size) };
            }
        }

        // other type of segment
        seg = reinterpret_cast<const my_segment_command *>(reinterpret_cast<const char *>(seg) + seg->cmdsize);
    }

    // No .qtmetadata section was found
    if (errorString)
        *errorString = QLibrary::tr("'%1' is not a Qt plugin").arg(library);
    return {};
}

QT_END_NAMESPACE

#endif