net/http/http_security_headers_unittest.cc

// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "base/base64.h"
#include "base/sha1.h"
#include "base/string_piece.h"
#include "crypto/sha2.h"
#include "net/base/net_log.h"
#include "net/base/test_completion_callback.h"
#include "net/http/http_security_headers.h"
#include "net/http/http_util.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace net {

namespace {

HashValue GetTestHashValue(uint8 label, HashValueTag tag) {
  HashValue hash_value(tag);
  memset(hash_value.data(), label, hash_value.size());
  return hash_value;
}

std::string GetTestPin(uint8 label, HashValueTag tag) {
  HashValue hash_value = GetTestHashValue(label, tag);
  std::string base64;
  base::Base64Encode(base::StringPiece(
      reinterpret_cast<char*>(hash_value.data()), hash_value.size()), &base64);

  switch (hash_value.tag) {
    case HASH_VALUE_SHA1:
      return std::string("pin-sha1=\"") + base64 + "\"";
    case HASH_VALUE_SHA256:
      return std::string("pin-sha256=\"") + base64 + "\"";
    default:
      NOTREACHED() << "Unknown HashValueTag " << hash_value.tag;
      return std::string("ERROR");
  }
}

};


class HttpSecurityHeadersTest : public testing::Test {
};


TEST_F(HttpSecurityHeadersTest, BogusHeaders) {
  base::Time now = base::Time::Now();
  base::Time expiry = now;
  bool include_subdomains = false;

  EXPECT_FALSE(ParseHSTSHeader(now, "", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "    ", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "abc", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "  abc", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "  abc   ", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "  max-age", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "  max-age  ", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=", &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "   max-age=", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "   max-age  =", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "   max-age=   ", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "   max-age  =     ", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "   max-age  =     xy", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "   max-age  =     3488a923", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488a923  ", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-ag=3488923", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-aged=3488923", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age==3488923", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "amax-age=3488923", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=-3488923", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923;", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923     e", &expiry,
                               &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now,
                               "max-age=3488923     includesubdomain",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923includesubdomains",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923=includesubdomains",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923 includesubdomainx",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923 includesubdomain=",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now,
                               "max-age=3488923 includesubdomain=true",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=3488923 includesubdomainsx",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now,
                               "max-age=3488923 includesubdomains x",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=34889.23 includesubdomains",
                               &expiry, &include_subdomains));
  EXPECT_FALSE(ParseHSTSHeader(now, "max-age=34889 includesubdomains",
                               &expiry, &include_subdomains));

  // Check the out args were not updated by checking the default
  // values for its predictable fields.
  EXPECT_EQ(now, expiry);
  EXPECT_FALSE(include_subdomains);
}

static void TestBogusPinsHeaders(HashValueTag tag) {
  base::Time now = base::Time::Now();
  base::Time expiry = now;
  HashValueVector hashes;
  HashValueVector chain_hashes;

  // Set some fake "chain" hashes
  chain_hashes.push_back(GetTestHashValue(1, tag));
  chain_hashes.push_back(GetTestHashValue(2, tag));
  chain_hashes.push_back(GetTestHashValue(3, tag));

  // The good pin must be in the chain, the backup pin must not be
  std::string good_pin = GetTestPin(2, tag);
  std::string backup_pin = GetTestPin(4, tag);

  EXPECT_FALSE(ParseHPKPHeader(now, "", chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "    ", chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "abc", chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "  abc", chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "  abc   ", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "  max-age", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "  max-age  ", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age=", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "   max-age=", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "   max-age  =", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "   max-age=   ", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "   max-age  =     ", chain_hashes,
                               &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "   max-age  =     xy", chain_hashes,
                               &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now,
                               "   max-age  =     3488a923",
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age=3488a923  ", chain_hashes,
                               &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now,
                               "max-ag=3488923pins=" + good_pin + "," +
                               backup_pin,
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-aged=3488923" + backup_pin,
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-aged=3488923; " + backup_pin,
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now,
                               "max-aged=3488923; " + backup_pin + ";" +
                               backup_pin,
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now,
                               "max-aged=3488923; " + good_pin + ";" +
                               good_pin,
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-aged=3488923; " + good_pin,
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age==3488923", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "amax-age=3488923", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age=-3488923", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age=3488923;", chain_hashes, &expiry,
                               &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age=3488923     e", chain_hashes,
                               &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now,
                               "max-age=3488923     includesubdomain",
                               chain_hashes, &expiry, &hashes));
  EXPECT_FALSE(ParseHPKPHeader(now, "max-age=34889.23", chain_hashes, &expiry,
                               &hashes));

  // Check the out args were not updated by checking the default
  // values for its predictable fields.
  EXPECT_EQ(now, expiry);
  EXPECT_EQ(hashes.size(), (size_t)0);
}

TEST_F(HttpSecurityHeadersTest, ValidSTSHeaders) {
  base::Time now = base::Time::Now();
  base::Time expiry = now;
  base::Time expect_expiry = now;
  bool include_subdomains = false;

  EXPECT_TRUE(ParseHSTSHeader(now, "max-age=243", &expiry,
                              &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(243);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_FALSE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now, "  Max-agE    = 567", &expiry,
                              &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(567);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_FALSE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now, "  mAx-aGe    = 890      ", &expiry,
                              &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(890);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_FALSE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now, "max-age=123;incLudesUbdOmains", &expiry,
                              &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now, "incLudesUbdOmains; max-age=123", &expiry,
                              &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now, "   incLudesUbdOmains; max-age=123",
                              &expiry, &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now,
      "   incLudesUbdOmains; max-age=123; pumpkin=kitten", &expiry,
                                   &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now,
      "   pumpkin=894; incLudesUbdOmains; max-age=123  ", &expiry,
                                   &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now,
      "   pumpkin; incLudesUbdOmains; max-age=123  ", &expiry,
                                   &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now,
      "   pumpkin; incLudesUbdOmains; max-age=\"123\"  ", &expiry,
                                   &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now,
      "animal=\"squirrel; distinguished\"; incLudesUbdOmains; max-age=123",
                                   &expiry, &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(now, "max-age=394082;  incLudesUbdOmains",
                              &expiry, &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(394082);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(
      now, "max-age=39408299  ;incLudesUbdOmains", &expiry,
      &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(
      std::min(kMaxHSTSAgeSecs, static_cast<int64>(GG_INT64_C(39408299))));
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(
      now, "max-age=394082038  ; incLudesUbdOmains", &expiry,
      &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(
      std::min(kMaxHSTSAgeSecs, static_cast<int64>(GG_INT64_C(394082038))));
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(
      now, "  max-age=0  ;  incLudesUbdOmains   ", &expiry,
      &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(0);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);

  EXPECT_TRUE(ParseHSTSHeader(
      now,
      "  max-age=999999999999999999999999999999999999999999999  ;"
      "  incLudesUbdOmains   ", &expiry, &include_subdomains));
  expect_expiry = now + base::TimeDelta::FromSeconds(
      kMaxHSTSAgeSecs);
  EXPECT_EQ(expect_expiry, expiry);
  EXPECT_TRUE(include_subdomains);
}

static void TestValidPinsHeaders(HashValueTag tag) {
  base::Time now = base::Time::Now();
  base::Time expiry = now;
  base::Time expect_expiry = now;
  HashValueVector hashes;
  HashValueVector chain_hashes;

  // Set some fake "chain" hashes into chain_hashes
  chain_hashes.push_back(GetTestHashValue(1, tag));
  chain_hashes.push_back(GetTestHashValue(2, tag));
  chain_hashes.push_back(GetTestHashValue(3, tag));

  // The good pin must be in the chain, the backup pin must not be
  std::string good_pin = GetTestPin(2, tag);
  std::string backup_pin = GetTestPin(4, tag);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "max-age=243; " + good_pin + ";" + backup_pin,
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(243);
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "   " + good_pin + "; " + backup_pin + "  ; Max-agE    = 567",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(567);
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      good_pin + ";" + backup_pin + "  ; mAx-aGe    = 890      ",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(890);
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      good_pin + ";" + backup_pin + "; max-age=123;IGNORED;",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(123);
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "max-age=394082;" + backup_pin + ";" + good_pin + ";  ",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(394082);
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "max-age=39408299  ;" + backup_pin + ";" + good_pin + ";  ",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(
      std::min(kMaxHSTSAgeSecs, static_cast<int64>(GG_INT64_C(39408299))));
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "max-age=39408038  ;    cybers=39408038  ;  " +
          good_pin + ";" + backup_pin + ";   ",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(
      std::min(kMaxHSTSAgeSecs, static_cast<int64>(GG_INT64_C(394082038))));
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "  max-age=0  ;  " + good_pin + ";" + backup_pin,
      chain_hashes, &expiry, &hashes));
  expect_expiry = now + base::TimeDelta::FromSeconds(0);
  EXPECT_EQ(expect_expiry, expiry);

  EXPECT_TRUE(ParseHPKPHeader(
      now,
      "  max-age=999999999999999999999999999999999999999999999  ;  " +
          backup_pin + ";" + good_pin + ";   ",
      chain_hashes, &expiry, &hashes));
  expect_expiry = now +
      base::TimeDelta::FromSeconds(kMaxHSTSAgeSecs);
  EXPECT_EQ(expect_expiry, expiry);
}

TEST_F(HttpSecurityHeadersTest, BogusPinsHeadersSHA1) {
  TestBogusPinsHeaders(HASH_VALUE_SHA1);
}

TEST_F(HttpSecurityHeadersTest, BogusPinsHeadersSHA256) {
  TestBogusPinsHeaders(HASH_VALUE_SHA256);
}

TEST_F(HttpSecurityHeadersTest, ValidPinsHeadersSHA1) {
  TestValidPinsHeaders(HASH_VALUE_SHA1);
}

TEST_F(HttpSecurityHeadersTest, ValidPinsHeadersSHA256) {
  TestValidPinsHeaders(HASH_VALUE_SHA256);
}
};