gecko/netwerk/test/TestSTSParser.cpp

190 lines
7.9 KiB
C++

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "TestHarness.h"
#include <stdio.h>
#include "nsNetUtil.h"
#include "nsISiteSecurityService.h"
#define EXPECT_SUCCESS(rv, ...) \
PR_BEGIN_MACRO \
if (NS_FAILED(rv)) { \
fail(__VA_ARGS__); \
return false; \
} \
PR_END_MACRO
#define EXPECT_FAILURE(rv, ...) \
PR_BEGIN_MACRO \
if (NS_SUCCEEDED(rv)) { \
fail(__VA_ARGS__); \
return false; \
} \
PR_END_MACRO
#define REQUIRE_EQUAL(a, b, ...) \
PR_BEGIN_MACRO \
if (a != b) { \
fail(__VA_ARGS__); \
return false; \
} \
PR_END_MACRO
bool
TestSuccess(const char* hdr, bool extraTokens,
uint64_t expectedMaxAge, bool expectedIncludeSubdomains,
nsISiteSecurityService* sss)
{
nsCOMPtr<nsIURI> dummyUri;
nsresult rv = NS_NewURI(getter_AddRefs(dummyUri), "https://foo.com/bar.html");
EXPECT_SUCCESS(rv, "Failed to create URI");
uint64_t maxAge = 0;
bool includeSubdomains = false;
rv = sss->UnsafeProcessHeader(nsISiteSecurityService::HEADER_HSTS, dummyUri,
hdr, 0, &maxAge, &includeSubdomains);
EXPECT_SUCCESS(rv, "Failed to process valid header: %s", hdr);
REQUIRE_EQUAL(maxAge, expectedMaxAge, "Did not correctly parse maxAge");
REQUIRE_EQUAL(includeSubdomains, expectedIncludeSubdomains, "Did not correctly parse presence/absence of includeSubdomains");
if (extraTokens) {
REQUIRE_EQUAL(rv, NS_SUCCESS_LOSS_OF_INSIGNIFICANT_DATA,
"Extra tokens were expected when parsing, but were not encountered.");
} else {
REQUIRE_EQUAL(rv, NS_OK, "Unexpected tokens found during parsing.");
}
passed(hdr);
return true;
}
bool TestFailure(const char* hdr,
nsISiteSecurityService* sss)
{
nsCOMPtr<nsIURI> dummyUri;
nsresult rv = NS_NewURI(getter_AddRefs(dummyUri), "https://foo.com/bar.html");
EXPECT_SUCCESS(rv, "Failed to create URI");
rv = sss->UnsafeProcessHeader(nsISiteSecurityService::HEADER_HSTS, dummyUri,
hdr, 0, nullptr, nullptr);
EXPECT_FAILURE(rv, "Parsed invalid header: %s", hdr);
passed(hdr);
return true;
}
int
main(int32_t argc, char *argv[])
{
nsresult rv;
ScopedXPCOM xpcom("STS Parser Tests");
if (xpcom.failed())
return -1;
// Initialize a profile folder to ensure a clean shutdown.
nsCOMPtr<nsIFile> profile = xpcom.GetProfileDirectory();
if (!profile) {
fail("Couldn't get the profile directory.");
return -1;
}
// grab handle to the service
nsCOMPtr<nsISiteSecurityService> sss;
sss = do_GetService("@mozilla.org/ssservice;1", &rv);
NS_ENSURE_SUCCESS(rv, -1);
int rv0, rv1;
nsTArray<bool> rvs(24);
// *** parsing tests
printf("*** Attempting to parse valid STS headers ...\n");
// SHOULD SUCCEED:
rvs.AppendElement(TestSuccess("max-age=100", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-age =100", false, 100, false, sss));
rvs.AppendElement(TestSuccess(" max-age=100", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-age = 100 ", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-age = \"100\" ", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-age=\"100\"", false, 100, false, sss));
rvs.AppendElement(TestSuccess(" max-age =\"100\" ", false, 100, false, sss));
rvs.AppendElement(TestSuccess("\tmax-age\t=\t\"100\"\t", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-age = 100 ", false, 100, false, sss));
rvs.AppendElement(TestSuccess("maX-aGe=100", false, 100, false, sss));
rvs.AppendElement(TestSuccess("MAX-age =100", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-AGE=100", false, 100, false, sss));
rvs.AppendElement(TestSuccess("Max-Age = 100 ", false, 100, false, sss));
rvs.AppendElement(TestSuccess("MAX-AGE = 100 ", false, 100, false, sss));
rvs.AppendElement(TestSuccess("max-age=100;includeSubdomains", false, 100, true, sss));
rvs.AppendElement(TestSuccess("max-age=100\t; includeSubdomains", false, 100, true, sss));
rvs.AppendElement(TestSuccess(" max-age=100; includeSubdomains", false, 100, true, sss));
rvs.AppendElement(TestSuccess("max-age = 100 ; includeSubdomains", false, 100, true, sss));
rvs.AppendElement(TestSuccess("max-age = 100 ; includeSubdomains", false, 100, true, sss));
rvs.AppendElement(TestSuccess("maX-aGe=100; includeSUBDOMAINS", false, 100, true, sss));
rvs.AppendElement(TestSuccess("MAX-age =100; includeSubDomains", false, 100, true, sss));
rvs.AppendElement(TestSuccess("max-AGE=100; iNcLuDeSuBdoMaInS", false, 100, true, sss));
rvs.AppendElement(TestSuccess("Max-Age = 100; includesubdomains ", false, 100, true, sss));
rvs.AppendElement(TestSuccess("INCLUDESUBDOMAINS;MaX-AgE = 100 ", false, 100, true, sss));
// Turns out, the actual directive is entirely optional (hence the
// trailing semicolon)
rvs.AppendElement(TestSuccess("max-age=100;includeSubdomains;", true, 100, true, sss));
// these are weird tests, but are testing that some extended syntax is
// still allowed (but it is ignored)
rvs.AppendElement(TestSuccess("max-age=100 ; includesubdomainsSomeStuff", true, 100, false, sss));
rvs.AppendElement(TestSuccess("\r\n\t\t \tcompletelyUnrelated = foobar; max-age= 34520103 \t \t; alsoUnrelated;asIsThis;\tincludeSubdomains\t\t \t", true, 34520103, true, sss));
rvs.AppendElement(TestSuccess("max-age=100; unrelated=\"quoted \\\"thingy\\\"\"", true, 100, false, sss));
rv0 = rvs.Contains(false) ? 1 : 0;
if (rv0 == 0)
passed("Successfully Parsed STS headers with mixed case and LWS");
rvs.Clear();
// SHOULD FAIL:
printf("*** Attempting to parse invalid STS headers (should not parse)...\n");
// invalid max-ages
rvs.AppendElement(TestFailure("max-age", sss));
rvs.AppendElement(TestFailure("max-age ", sss));
rvs.AppendElement(TestFailure("max-age=p", sss));
rvs.AppendElement(TestFailure("max-age=*1p2", sss));
rvs.AppendElement(TestFailure("max-age=.20032", sss));
rvs.AppendElement(TestFailure("max-age=!20032", sss));
rvs.AppendElement(TestFailure("max-age==20032", sss));
// invalid headers
rvs.AppendElement(TestFailure("foobar", sss));
rvs.AppendElement(TestFailure("maxage=100", sss));
rvs.AppendElement(TestFailure("maxa-ge=100", sss));
rvs.AppendElement(TestFailure("max-ag=100", sss));
rvs.AppendElement(TestFailure("includesubdomains", sss));
rvs.AppendElement(TestFailure(";", sss));
rvs.AppendElement(TestFailure("max-age=\"100", sss));
// The max-age directive here doesn't conform to the spec, so it MUST
// be ignored. Consequently, the REQUIRED max-age directive is not
// present in this header, and so it is invalid.
rvs.AppendElement(TestFailure("max-age=100, max-age=200; includeSubdomains", sss));
rvs.AppendElement(TestFailure("max-age=100 includesubdomains", sss));
rvs.AppendElement(TestFailure("max-age=100 bar foo", sss));
rvs.AppendElement(TestFailure("max-age=100randomstuffhere", sss));
// All directives MUST appear only once in an STS header field.
rvs.AppendElement(TestFailure("max-age=100; max-age=200", sss));
rvs.AppendElement(TestFailure("includeSubdomains; max-age=200; includeSubdomains", sss));
rvs.AppendElement(TestFailure("max-age=200; includeSubdomains; includeSubdomains", sss));
// The includeSubdomains directive is valueless.
rvs.AppendElement(TestFailure("max-age=100; includeSubdomains=unexpected", sss));
// LWS must have at least one space or horizontal tab
rvs.AppendElement(TestFailure("\r\nmax-age=200", sss));
rv1 = rvs.Contains(false) ? 1 : 0;
if (rv1 == 0)
passed("Avoided parsing invalid STS headers");
return (rv0 + rv1);
}