blob: 46f2be40f43a67feb29c06638312505e9ce4de7c [file] [log] [blame]
/*
* Copyright (C) 2016-2018 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <unicode/uidna.h>
#include <wtf/Expected.h>
#include <wtf/Forward.h>
#include <wtf/URL.h>
struct UIDNA;
namespace WTF {
template<typename CharacterType> class CodePointIterator;
class URLParser {
WTF_MAKE_FAST_ALLOCATED;
public:
constexpr static int allowedNameToASCIIErrors =
UIDNA_ERROR_EMPTY_LABEL
| UIDNA_ERROR_LABEL_TOO_LONG
| UIDNA_ERROR_DOMAIN_NAME_TOO_LONG
| UIDNA_ERROR_LEADING_HYPHEN
| UIDNA_ERROR_TRAILING_HYPHEN
| UIDNA_ERROR_HYPHEN_3_4;
// Needs to be big enough to hold an IDN-encoded name.
// For host names bigger than this, we won't do IDN encoding, which is almost certainly OK.
constexpr static size_t hostnameBufferLength = 2048;
#define URLTextEncodingSentinelAllowingC0AtEndOfHash reinterpret_cast<const URLTextEncoding*>(-1)
WTF_EXPORT_PRIVATE static bool allValuesEqual(const URL&, const URL&);
WTF_EXPORT_PRIVATE static bool internalValuesConsistent(const URL&);
using URLEncodedForm = Vector<WTF::KeyValuePair<String, String>>;
WTF_EXPORT_PRIVATE static URLEncodedForm parseURLEncodedForm(StringView);
WTF_EXPORT_PRIVATE static String serialize(const URLEncodedForm&);
WTF_EXPORT_PRIVATE static bool isSpecialScheme(StringView);
WTF_EXPORT_PRIVATE static std::optional<String> maybeCanonicalizeScheme(StringView scheme);
static const UIDNA& internationalDomainNameTranscoder();
static bool isInUserInfoEncodeSet(UChar);
static std::optional<uint16_t> defaultPortForProtocol(StringView);
WTF_EXPORT_PRIVATE static std::optional<String> formURLDecode(StringView input);
private:
URLParser(String&&, const URL& = { }, const URLTextEncoding* = nullptr);
URL result() { return m_url; }
friend class URL;
URL m_url;
Vector<LChar> m_asciiBuffer;
bool m_urlIsSpecial { false };
bool m_urlIsFile { false };
bool m_hostHasPercentOrNonASCII { false };
bool m_didSeeSyntaxViolation { false };
String m_inputString;
const void* m_inputBegin { nullptr };
static constexpr size_t defaultInlineBufferSize = 2048;
using LCharBuffer = Vector<LChar, defaultInlineBufferSize>;
template<typename CharacterType> void parse(const CharacterType*, const unsigned length, const URL&, const URLTextEncoding*);
template<typename CharacterType> void parseAuthority(CodePointIterator<CharacterType>);
enum class HostParsingResult : uint8_t { InvalidHost, IPv6WithPort, IPv6WithoutPort, IPv4WithPort, IPv4WithoutPort, DNSNameWithPort, DNSNameWithoutPort, NonSpecialHostWithoutPort, NonSpecialHostWithPort };
template<typename CharacterType> HostParsingResult parseHostAndPort(CodePointIterator<CharacterType>);
template<typename CharacterType> bool parsePort(CodePointIterator<CharacterType>&);
void failure();
enum class ReportSyntaxViolation { No, Yes };
template<typename CharacterType, ReportSyntaxViolation reportSyntaxViolation = ReportSyntaxViolation::Yes>
void advance(CodePointIterator<CharacterType>& iterator) { advance<CharacterType, reportSyntaxViolation>(iterator, iterator); }
template<typename CharacterType, ReportSyntaxViolation = ReportSyntaxViolation::Yes>
void advance(CodePointIterator<CharacterType>&, const CodePointIterator<CharacterType>& iteratorForSyntaxViolationPosition);
template<typename CharacterType> bool takesTwoAdvancesUntilEnd(CodePointIterator<CharacterType>);
template<typename CharacterType> void syntaxViolation(const CodePointIterator<CharacterType>&);
template<typename CharacterType> bool isPercentEncodedDot(CodePointIterator<CharacterType>);
template<typename CharacterType> bool isWindowsDriveLetter(CodePointIterator<CharacterType>);
template<typename CharacterType> bool isSingleDotPathSegment(CodePointIterator<CharacterType>);
template<typename CharacterType> bool isDoubleDotPathSegment(CodePointIterator<CharacterType>);
template<typename CharacterType> bool shouldCopyFileURL(CodePointIterator<CharacterType>);
template<typename CharacterType> bool checkLocalhostCodePoint(CodePointIterator<CharacterType>&, UChar32);
template<typename CharacterType> bool isAtLocalhost(CodePointIterator<CharacterType>);
bool isLocalhost(StringView);
template<typename CharacterType> void consumeSingleDotPathSegment(CodePointIterator<CharacterType>&);
template<typename CharacterType> void consumeDoubleDotPathSegment(CodePointIterator<CharacterType>&);
template<typename CharacterType> void appendWindowsDriveLetter(CodePointIterator<CharacterType>&);
template<typename CharacterType> size_t currentPosition(const CodePointIterator<CharacterType>&);
template<typename UnsignedIntegerType> void appendNumberToASCIIBuffer(UnsignedIntegerType);
template<bool(*isInCodeSet)(UChar32), typename CharacterType> void utf8PercentEncode(const CodePointIterator<CharacterType>&);
template<typename CharacterType> void utf8QueryEncode(const CodePointIterator<CharacterType>&);
template<typename CharacterType> std::optional<LCharBuffer> domainToASCII(StringImpl&, const CodePointIterator<CharacterType>& iteratorForSyntaxViolationPosition);
template<typename CharacterType> LCharBuffer percentDecode(const LChar*, size_t, const CodePointIterator<CharacterType>& iteratorForSyntaxViolationPosition);
static LCharBuffer percentDecode(const LChar*, size_t);
static bool hasForbiddenHostCodePoint(const LCharBuffer&);
void percentEncodeByte(uint8_t);
void appendToASCIIBuffer(UChar32);
void appendToASCIIBuffer(const char*, size_t);
void appendToASCIIBuffer(const LChar* characters, size_t size) { appendToASCIIBuffer(reinterpret_cast<const char*>(characters), size); }
template<typename CharacterType> void encodeNonUTF8Query(const Vector<UChar>& source, const URLTextEncoding&, CodePointIterator<CharacterType>);
void copyASCIIStringUntil(const String&, size_t length);
bool copyBaseWindowsDriveLetter(const URL&);
StringView parsedDataView(size_t start, size_t length);
UChar parsedDataView(size_t position);
template<typename CharacterType> bool subdomainStartsWithXNDashDash(CodePointIterator<CharacterType>);
bool subdomainStartsWithXNDashDash(StringImpl&);
bool needsNonSpecialDotSlash() const;
void addNonSpecialDotSlash();
using IPv4Address = uint32_t;
void serializeIPv4(IPv4Address);
enum class IPv4ParsingError;
enum class IPv4PieceParsingError;
template<typename CharacterTypeForSyntaxViolation, typename CharacterType> Expected<IPv4Address, IPv4ParsingError> parseIPv4Host(const CodePointIterator<CharacterTypeForSyntaxViolation>&, CodePointIterator<CharacterType>);
template<typename CharacterType> Expected<uint32_t, URLParser::IPv4PieceParsingError> parseIPv4Piece(CodePointIterator<CharacterType>&, bool& syntaxViolation);
using IPv6Address = std::array<uint16_t, 8>;
template<typename CharacterType> std::optional<IPv6Address> parseIPv6Host(CodePointIterator<CharacterType>);
template<typename CharacterType> std::optional<uint32_t> parseIPv4PieceInsideIPv6(CodePointIterator<CharacterType>&);
template<typename CharacterType> std::optional<IPv4Address> parseIPv4AddressInsideIPv6(CodePointIterator<CharacterType>);
void serializeIPv6Piece(uint16_t piece);
void serializeIPv6(IPv6Address);
enum class URLPart;
template<typename CharacterType> void copyURLPartsUntil(const URL& base, URLPart, const CodePointIterator<CharacterType>&, const URLTextEncoding*&);
static size_t urlLengthUntilPart(const URL&, URLPart);
void popPath();
bool shouldPopPath(unsigned);
};
}