summaryrefslogtreecommitdiffstats
path: root/tools/aapt2/ManifestValidator.cpp
blob: 123b9fae2fbaf8b5913994176d3da6b6fa9cf1a4 (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
216
217
/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "Logger.h"
#include "ManifestValidator.h"
#include "Maybe.h"
#include "Source.h"
#include "Util.h"

#include <androidfw/ResourceTypes.h>

namespace aapt {

ManifestValidator::ManifestValidator(const android::ResTable& table)
: mTable(table) {
}

bool ManifestValidator::validate(const Source& source, android::ResXMLParser* parser) {
    SourceLogger logger(source);

    android::ResXMLParser::event_code_t code;
    while ((code = parser->next()) != android::ResXMLParser::END_DOCUMENT &&
            code != android::ResXMLParser::BAD_DOCUMENT) {
        if (code != android::ResXMLParser::START_TAG) {
            continue;
        }

        size_t len = 0;
        const StringPiece16 namespaceUri(parser->getElementNamespace(&len), len);
        if (!namespaceUri.empty()) {
            continue;
        }

        const StringPiece16 name(parser->getElementName(&len), len);
        if (name.empty()) {
            logger.error(parser->getLineNumber())
                    << "failed to get the element name."
                    << std::endl;
            return false;
        }

        if (name == u"manifest") {
            if (!validateManifest(source, parser)) {
                return false;
            }
        }
    }
    return true;
}

Maybe<StringPiece16> ManifestValidator::getAttributeValue(android::ResXMLParser* parser,
                                                          size_t idx) {
    android::Res_value value;
    if (parser->getAttributeValue(idx, &value) < 0) {
        return StringPiece16();
    }

    const android::ResStringPool* pool = &parser->getStrings();
    if (value.dataType == android::Res_value::TYPE_REFERENCE) {
        ssize_t strIdx = mTable.resolveReference(&value, 0x10000000u);
        if (strIdx < 0) {
            return {};
        }
        pool = mTable.getTableStringBlock(strIdx);
    }

    if (value.dataType != android::Res_value::TYPE_STRING || !pool) {
        return {};
    }
    return util::getString(*pool, value.data);
}

Maybe<StringPiece16> ManifestValidator::getAttributeInlineValue(android::ResXMLParser* parser,
                                                                size_t idx) {
    android::Res_value value;
    if (parser->getAttributeValue(idx, &value) < 0) {
        return StringPiece16();
    }

    if (value.dataType != android::Res_value::TYPE_STRING) {
        return {};
    }
    return util::getString(parser->getStrings(), value.data);
}

bool ManifestValidator::validateInlineAttribute(android::ResXMLParser* parser, size_t idx,
                                                SourceLogger& logger,
                                                const StringPiece16& charSet) {
    size_t len = 0;
    StringPiece16 element(parser->getElementName(&len), len);
    StringPiece16 attributeName(parser->getAttributeName(idx, &len), len);
    Maybe<StringPiece16> result = getAttributeInlineValue(parser, idx);
    if (!result) {
        logger.error(parser->getLineNumber())
                << "<"
                << element
                << "> must have a '"
                << attributeName
                << "' attribute with a string literal value."
                << std::endl;
        return false;
    }
    return validateAttributeImpl(element, attributeName, result.value(), charSet,
                                 parser->getLineNumber(), logger);
}

bool ManifestValidator::validateAttribute(android::ResXMLParser* parser, size_t idx,
                                          SourceLogger& logger, const StringPiece16& charSet) {
    size_t len = 0;
    StringPiece16 element(parser->getElementName(&len), len);
    StringPiece16 attributeName(parser->getAttributeName(idx, &len), len);
    Maybe<StringPiece16> result = getAttributeValue(parser, idx);
    if (!result) {
        logger.error(parser->getLineNumber())
                << "<"
                << element
                << "> must have a '"
                << attributeName
                << "' attribute that points to a string."
                << std::endl;
        return false;
    }
    return validateAttributeImpl(element, attributeName, result.value(), charSet,
                                 parser->getLineNumber(), logger);
}

bool ManifestValidator::validateAttributeImpl(const StringPiece16& element,
                                              const StringPiece16& attributeName,
                                              const StringPiece16& attributeValue,
                                              const StringPiece16& charSet, size_t lineNumber,
                                              SourceLogger& logger) {
    StringPiece16::const_iterator badIter =
            util::findNonAlphaNumericAndNotInSet(attributeValue, charSet);
    if (badIter != attributeValue.end()) {
        logger.error(lineNumber)
                << "tag <"
                << element
                << "> attribute '"
                << attributeName
                << "' has invalid character '"
                << StringPiece16(badIter, 1)
                << "'."
                << std::endl;
        return false;
    }

    if (!attributeValue.empty()) {
        StringPiece16 trimmed = util::trimWhitespace(attributeValue);
        if (attributeValue.begin() != trimmed.begin()) {
            logger.error(lineNumber)
                    << "tag <"
                    << element
                    << "> attribute '"
                    << attributeName
                    << "' can not start with whitespace."
                    << std::endl;
            return false;
        }

        if (attributeValue.end() != trimmed.end()) {
            logger.error(lineNumber)
                    << "tag <"
                    << element
                    << "> attribute '"
                    << attributeName
                    << "' can not end with whitespace."
                    << std::endl;
            return false;
        }
    }
    return true;
}

constexpr const char16_t* kPackageIdentSet = u"._";

bool ManifestValidator::validateManifest(const Source& source, android::ResXMLParser* parser) {
    bool error = false;
    SourceLogger logger(source);

    const StringPiece16 kAndroid = u"android";
    const StringPiece16 kPackage = u"package";
    const StringPiece16 kSharedUserId = u"sharedUserId";

    ssize_t idx;

    idx = parser->indexOfAttribute(nullptr, 0, kPackage.data(), kPackage.size());
    if (idx < 0) {
        logger.error(parser->getLineNumber())
                << "missing package attribute."
                << std::endl;
        error = true;
    } else {
        error |= !validateInlineAttribute(parser, idx, logger, kPackageIdentSet);
    }

    idx = parser->indexOfAttribute(kAndroid.data(), kAndroid.size(),
                                   kSharedUserId.data(), kSharedUserId.size());
    if (idx >= 0) {
        error |= !validateInlineAttribute(parser, idx, logger, kPackageIdentSet);
    }
    return !error;
}

} // namespace aapt