| OLD | NEW |
| 1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CONTENT_COMMON_ORIGIN_TRIALS_TRIAL_TOKEN_H_ | 5 #ifndef CONTENT_COMMON_ORIGIN_TRIALS_TRIAL_TOKEN_H_ |
| 6 #define CONTENT_COMMON_ORIGIN_TRIALS_TRIAL_TOKEN_H_ | 6 #define CONTENT_COMMON_ORIGIN_TRIALS_TRIAL_TOKEN_H_ |
| 7 | 7 |
| 8 #include <memory> |
| 8 #include <string> | 9 #include <string> |
| 9 | 10 |
| 10 #include "base/memory/scoped_ptr.h" | |
| 11 #include "base/strings/string_piece.h" | 11 #include "base/strings/string_piece.h" |
| 12 #include "base/time/time.h" | 12 #include "base/time/time.h" |
| 13 #include "content/common/content_export.h" | 13 #include "content/common/content_export.h" |
| 14 #include "url/origin.h" | 14 #include "url/origin.h" |
| 15 | 15 |
| 16 namespace content { | 16 namespace content { |
| 17 | 17 |
| 18 // The Experimental Framework (EF) provides limited access to experimental | 18 // The Experimental Framework (EF) provides limited access to experimental |
| 19 // features, on a per-origin basis (origin trials). This class defines the trial | 19 // features, on a per-origin basis (origin trials). This class defines the trial |
| 20 // token data structure, used to securely provide access to an experimental | 20 // token data structure, used to securely provide access to an experimental |
| 21 // feature. | 21 // feature. |
| 22 // | 22 // |
| 23 // Features are defined by string names, provided by the implementers. The EF | 23 // Features are defined by string names, provided by the implementers. The EF |
| 24 // code does not maintain an enum or constant list for feature names. Instead, | 24 // code does not maintain an enum or constant list for feature names. Instead, |
| 25 // the EF validates the name provided by the feature implementation against any | 25 // the EF validates the name provided by the feature implementation against any |
| 26 // provided tokens. | 26 // provided tokens. |
| 27 // | 27 // |
| 28 // More documentation on the token format can be found at | 28 // More documentation on the token format can be found at |
| 29 // https://docs.google.com/document/d/1v5fi0EUV_QHckVHVF2K4P72iNywnrJtNhNZ6i2NPt
0M | 29 // https://docs.google.com/document/d/1v5fi0EUV_QHckVHVF2K4P72iNywnrJtNhNZ6i2NPt
0M |
| 30 | 30 |
| 31 class CONTENT_EXPORT TrialToken { | 31 class CONTENT_EXPORT TrialToken { |
| 32 public: | 32 public: |
| 33 ~TrialToken(); | 33 ~TrialToken(); |
| 34 | 34 |
| 35 // Returns a token object if the string represents a well-formed token, or | 35 // Returns a token object if the string represents a signed well-formed token, |
| 36 // nullptr otherwise. (This does not mean that the token is valid, just that | 36 // or nullptr otherwise. (This does not mean that the token is currently |
| 37 // it can be parsed.) | 37 // valid, or appropriate for a given origin / feature, just that it is |
| 38 static scoped_ptr<TrialToken> Parse(const std::string& token_text); | 38 // correctly formatted and signed by the supplied public key, and can be |
| 39 // parsed.) |
| 40 static std::unique_ptr<TrialToken> From(const std::string& token_text, |
| 41 base::StringPiece public_key); |
| 39 | 42 |
| 40 // Returns true if this feature is appropriate for use by the given origin, | 43 // Returns true if this token is appropriate for use by the given origin, |
| 41 // for the given feature name. This does not check whether the signature is | 44 // for the given feature name, and has not yet expired. |
| 42 // valid, or whether the token itself has expired. | 45 bool IsValidForFeature(const url::Origin& origin, |
| 43 bool IsAppropriate(const url::Origin& origin, | 46 base::StringPiece feature_name, |
| 44 base::StringPiece feature_name) const; | 47 const base::Time& now) const; |
| 45 | 48 |
| 46 // Returns true if this token has a valid signature, and has not expired. | |
| 47 bool IsValid(const base::Time& now, base::StringPiece public_key) const; | |
| 48 | |
| 49 uint8_t version() { return version_; } | |
| 50 std::string signature() { return signature_; } | |
| 51 std::string data() { return data_; } | |
| 52 url::Origin origin() { return origin_; } | 49 url::Origin origin() { return origin_; } |
| 53 std::string feature_name() { return feature_name_; } | 50 std::string feature_name() { return feature_name_; } |
| 54 base::Time expiry_time() { return expiry_time_; } | 51 base::Time expiry_time() { return expiry_time_; } |
| 55 | 52 |
| 56 protected: | 53 protected: |
| 57 friend class TrialTokenTest; | 54 friend class TrialTokenTest; |
| 58 | 55 |
| 56 // Returns the payload of a signed token, or nullptr if the token is not |
| 57 // properly signed, or is not well-formed. |
| 58 static std::unique_ptr<std::string> Extract(const std::string& token_text, |
| 59 base::StringPiece public_key); |
| 60 |
| 61 // Returns a token object if the string represents a well-formed JSON token |
| 62 // payload, or nullptr otherwise. |
| 63 static std::unique_ptr<TrialToken> Parse(const std::string& token_json); |
| 64 |
| 59 bool ValidateOrigin(const url::Origin& origin) const; | 65 bool ValidateOrigin(const url::Origin& origin) const; |
| 60 bool ValidateFeatureName(base::StringPiece feature_name) const; | 66 bool ValidateFeatureName(base::StringPiece feature_name) const; |
| 61 bool ValidateDate(const base::Time& now) const; | 67 bool ValidateDate(const base::Time& now) const; |
| 62 bool ValidateSignature(base::StringPiece public_key) const; | |
| 63 | 68 |
| 64 static bool ValidateSignature(const std::string& signature_text, | 69 static bool ValidateSignature(base::StringPiece signature_text, |
| 65 const std::string& data, | 70 const std::string& data, |
| 66 base::StringPiece public_key); | 71 base::StringPiece public_key); |
| 67 | 72 |
| 68 private: | 73 private: |
| 69 TrialToken(uint8_t version, | 74 TrialToken(const url::Origin& origin, |
| 70 const std::string& signature, | |
| 71 const std::string& data, | |
| 72 const url::Origin& origin, | |
| 73 const std::string& feature_name, | 75 const std::string& feature_name, |
| 74 uint64_t expiry_timestamp); | 76 uint64_t expiry_timestamp); |
| 75 | 77 |
| 76 // The version number for this token. The version identifies the structure of | |
| 77 // the token, as well as the algorithm used to generate/validate the token. | |
| 78 // The version number is only incremented when incompatible changes are made | |
| 79 // to either the structure (e.g. adding a field), or the algorithm (e.g. | |
| 80 // changing the hash or signing algorithm). | |
| 81 // NOTE: The version number is not part of the token signature and validation. | |
| 82 // Thus it is possible to modify a token to use a different version from | |
| 83 // that used to generate the signature. To mitigate cross-version | |
| 84 // attacks, the signing key(s) should be changed whenever there are | |
| 85 // changes to the token structure or algorithms. | |
| 86 uint8_t version_; | |
| 87 | |
| 88 // The base64-encoded-signature portion of the token. For the token to be | |
| 89 // valid, this must be a valid signature for the data portion of the token, as | |
| 90 // verified by the public key in trial_token.cc. | |
| 91 std::string signature_; | |
| 92 | |
| 93 // The portion of the token string which is signed, and whose signature is | |
| 94 // contained in the signature_ member. | |
| 95 std::string data_; | |
| 96 | |
| 97 // The origin for which this token is valid. Must be a secure origin. | 78 // The origin for which this token is valid. Must be a secure origin. |
| 98 url::Origin origin_; | 79 url::Origin origin_; |
| 99 | 80 |
| 100 // The name of the experimental feature which this token enables. | 81 // The name of the experimental feature which this token enables. |
| 101 std::string feature_name_; | 82 std::string feature_name_; |
| 102 | 83 |
| 103 // The time until which this token should be considered valid. | 84 // The time until which this token should be considered valid. |
| 104 base::Time expiry_time_; | 85 base::Time expiry_time_; |
| 105 }; | 86 }; |
| 106 | 87 |
| 107 } // namespace content | 88 } // namespace content |
| 108 | 89 |
| 109 #endif // CONTENT_COMMON_ORIGIN_TRIALS_TRIAL_TOKEN_H_ | 90 #endif // CONTENT_COMMON_ORIGIN_TRIALS_TRIAL_TOKEN_H_ |
| OLD | NEW |