OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 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 NET_SSL_CHANNEL_ID_SERVICE_H_ | 5 #ifndef NET_SSL_CHANNEL_ID_SERVICE_H_ |
6 #define NET_SSL_CHANNEL_ID_SERVICE_H_ | 6 #define NET_SSL_CHANNEL_ID_SERVICE_H_ |
7 | 7 |
8 #include <map> | 8 #include <map> |
9 #include <string> | 9 #include <string> |
10 #include <vector> | 10 #include <vector> |
11 | 11 |
12 #include "base/basictypes.h" | 12 #include "base/basictypes.h" |
13 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
14 #include "base/memory/weak_ptr.h" | 14 #include "base/memory/weak_ptr.h" |
15 #include "base/threading/non_thread_safe.h" | 15 #include "base/threading/non_thread_safe.h" |
16 #include "base/time/time.h" | 16 #include "base/time/time.h" |
17 #include "net/base/completion_callback.h" | 17 #include "net/base/completion_callback.h" |
| 18 #include "net/base/net_errors.h" |
18 #include "net/base/net_export.h" | 19 #include "net/base/net_export.h" |
19 #include "net/ssl/channel_id_store.h" | 20 #include "net/ssl/channel_id_store.h" |
20 | 21 |
21 namespace base { | 22 namespace base { |
22 class TaskRunner; | 23 class TaskRunner; |
23 } | 24 } |
24 | 25 |
| 26 namespace crypto { |
| 27 class ECPrivateKey; |
| 28 } |
| 29 |
25 namespace net { | 30 namespace net { |
26 | 31 |
27 class ChannelIDServiceJob; | 32 class ChannelIDServiceJob; |
28 class ChannelIDServiceRequest; | 33 class ChannelIDServiceRequest; |
29 class ChannelIDServiceWorker; | 34 class ChannelIDServiceWorker; |
30 | 35 |
31 // A class for creating and fetching domain bound certs. They are used | 36 // A class for creating and fetching domain bound certs. They are used |
32 // to identify users' machines; their public keys are used as channel IDs in | 37 // to identify users' machines; their public keys are used as channel IDs in |
33 // http://tools.ietf.org/html/draft-balfanz-tls-channelid-00. | 38 // http://tools.ietf.org/html/draft-balfanz-tls-channelid-00. |
34 // As a result although certs are set to be invalid after one year, we don't | 39 // As a result although certs are set to be invalid after one year, we don't |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
78 ChannelIDStore* channel_id_store, | 83 ChannelIDStore* channel_id_store, |
79 const scoped_refptr<base::TaskRunner>& task_runner); | 84 const scoped_refptr<base::TaskRunner>& task_runner); |
80 | 85 |
81 ~ChannelIDService(); | 86 ~ChannelIDService(); |
82 | 87 |
83 // Returns the domain to be used for |host|. The domain is the | 88 // Returns the domain to be used for |host|. The domain is the |
84 // "registry controlled domain", or the "ETLD + 1" where one exists, or | 89 // "registry controlled domain", or the "ETLD + 1" where one exists, or |
85 // the origin otherwise. | 90 // the origin otherwise. |
86 static std::string GetDomainForHost(const std::string& host); | 91 static std::string GetDomainForHost(const std::string& host); |
87 | 92 |
88 // Tests whether the system time is within the supported range for | |
89 // certificate generation. This value is cached when ChannelIDService | |
90 // is created, so if the system time is changed by a huge amount, this may no | |
91 // longer hold. | |
92 bool IsSystemTimeValid() const { return is_system_time_valid_; } | |
93 | |
94 // Fetches the domain bound cert for the specified host if one exists and | 93 // Fetches the domain bound cert for the specified host if one exists and |
95 // creates one otherwise. Returns OK if successful or an error code upon | 94 // creates one otherwise. Returns OK if successful or an error code upon |
96 // failure. | 95 // failure. |
97 // | 96 // |
98 // On successful completion, |private_key| stores a DER-encoded | 97 // On successful completion, |private_key| stores a DER-encoded |
99 // PrivateKeyInfo struct, and |cert| stores a DER-encoded certificate. | 98 // PrivateKeyInfo struct, and |cert| stores a DER-encoded certificate. |
100 // The PrivateKeyInfo is always an ECDSA private key. | 99 // The PrivateKeyInfo is always an ECDSA private key. |
101 // | 100 // |
102 // |callback| must not be null. ERR_IO_PENDING is returned if the operation | 101 // |callback| must not be null. ERR_IO_PENDING is returned if the operation |
103 // could not be completed immediately, in which case the result code will | 102 // could not be completed immediately, in which case the result code will |
104 // be passed to the callback when available. | 103 // be passed to the callback when available. |
105 // | 104 // |
106 // |*out_req| will be initialized with a handle to the async request. This | 105 // |*out_req| will be initialized with a handle to the async request. This |
107 // RequestHandle object must be cancelled or destroyed before the | 106 // RequestHandle object must be cancelled or destroyed before the |
108 // ChannelIDService is destroyed. | 107 // ChannelIDService is destroyed. |
109 int GetOrCreateChannelID( | 108 int GetOrCreateChannelID(const std::string& host, |
110 const std::string& host, | 109 scoped_ptr<crypto::ECPrivateKey>* key, |
111 std::string* private_key, | 110 const CompletionCallback& callback, |
112 std::string* cert, | 111 RequestHandle* out_req); |
113 const CompletionCallback& callback, | |
114 RequestHandle* out_req); | |
115 | 112 |
116 // Fetches the domain bound cert for the specified host if one exists. | 113 // Fetches the domain bound cert for the specified host if one exists. |
117 // Returns OK if successful, ERR_FILE_NOT_FOUND if none exists, or an error | 114 // Returns OK if successful, ERR_FILE_NOT_FOUND if none exists, or an error |
118 // code upon failure. | 115 // code upon failure. |
119 // | 116 // |
120 // On successful completion, |private_key| stores a DER-encoded | 117 // On successful completion, |private_key| stores a DER-encoded |
121 // PrivateKeyInfo struct, and |cert| stores a DER-encoded certificate. | 118 // PrivateKeyInfo struct, and |cert| stores a DER-encoded certificate. |
122 // The PrivateKeyInfo is always an ECDSA private key. | 119 // The PrivateKeyInfo is always an ECDSA private key. |
123 // | 120 // |
124 // |callback| must not be null. ERR_IO_PENDING is returned if the operation | 121 // |callback| must not be null. ERR_IO_PENDING is returned if the operation |
125 // could not be completed immediately, in which case the result code will | 122 // could not be completed immediately, in which case the result code will |
126 // be passed to the callback when available. If an in-flight | 123 // be passed to the callback when available. If an in-flight |
127 // GetChannelID is pending, and a new GetOrCreateDomainBoundCert | 124 // GetChannelID is pending, and a new GetOrCreateDomainBoundCert |
128 // request arrives for the same domain, the GetChannelID request will | 125 // request arrives for the same domain, the GetChannelID request will |
129 // not complete until a new cert is created. | 126 // not complete until a new cert is created. |
130 // | 127 // |
131 // |*out_req| will be initialized with a handle to the async request. This | 128 // |*out_req| will be initialized with a handle to the async request. This |
132 // RequestHandle object must be cancelled or destroyed before the | 129 // RequestHandle object must be cancelled or destroyed before the |
133 // ChannelIDService is destroyed. | 130 // ChannelIDService is destroyed. |
134 int GetChannelID( | 131 int GetChannelID(const std::string& host, |
135 const std::string& host, | 132 scoped_ptr<crypto::ECPrivateKey>* key, |
136 std::string* private_key, | 133 const CompletionCallback& callback, |
137 std::string* cert, | 134 RequestHandle* out_req); |
138 const CompletionCallback& callback, | |
139 RequestHandle* out_req); | |
140 | 135 |
141 // Returns the backing ChannelIDStore. | 136 // Returns the backing ChannelIDStore. |
142 ChannelIDStore* GetChannelIDStore(); | 137 ChannelIDStore* GetChannelIDStore(); |
143 | 138 |
144 // Public only for unit testing. | 139 // Public only for unit testing. |
145 int cert_count(); | 140 int cert_count(); |
146 uint64 requests() const { return requests_; } | 141 uint64 requests() const { return requests_; } |
147 uint64 cert_store_hits() const { return cert_store_hits_; } | 142 uint64 key_store_hits() const { return key_store_hits_; } |
148 uint64 inflight_joins() const { return inflight_joins_; } | 143 uint64 inflight_joins() const { return inflight_joins_; } |
149 uint64 workers_created() const { return workers_created_; } | 144 uint64 workers_created() const { return workers_created_; } |
150 | 145 |
151 private: | 146 private: |
152 // Cancels the specified request. |req| is the handle stored by | 147 // Cancels the specified request. |req| is the handle stored by |
153 // GetChannelID(). After a request is canceled, its completion | 148 // GetChannelID(). After a request is canceled, its completion |
154 // callback will not be called. | 149 // callback will not be called. |
155 void CancelRequest(ChannelIDServiceRequest* req); | 150 void CancelRequest(ChannelIDServiceRequest* req); |
156 | 151 |
157 void GotChannelID(int err, | 152 void GotChannelID(int err, |
158 const std::string& server_identifier, | 153 const std::string& server_identifier, |
159 base::Time expiration_time, | 154 const std::string& private_key, |
160 const std::string& key, | 155 const std::string& public_key); |
161 const std::string& cert); | |
162 void GeneratedChannelID( | 156 void GeneratedChannelID( |
163 const std::string& server_identifier, | 157 const std::string& server_identifier, |
164 int error, | 158 int error, |
165 scoped_ptr<ChannelIDStore::ChannelID> channel_id); | 159 scoped_ptr<ChannelIDStore::ChannelID> channel_id); |
166 void HandleResult(int error, | 160 void HandleResult(int error, |
167 const std::string& server_identifier, | 161 const std::string& server_identifier, |
168 const std::string& private_key, | 162 const std::string& private_key, |
169 const std::string& cert); | 163 const std::string& public_key); |
170 | 164 |
171 // Searches for an in-flight request for the same domain. If found, | 165 // Searches for an in-flight request for the same domain. If found, |
172 // attaches to the request and returns true. Returns false if no in-flight | 166 // attaches to the request and returns true. Returns false if no in-flight |
173 // request is found. | 167 // request is found. |
174 bool JoinToInFlightRequest(const base::TimeTicks& request_start, | 168 bool JoinToInFlightRequest(const base::TimeTicks& request_start, |
175 const std::string& domain, | 169 const std::string& domain, |
176 std::string* private_key, | 170 scoped_ptr<crypto::ECPrivateKey>* key, |
177 std::string* cert, | |
178 bool create_if_missing, | 171 bool create_if_missing, |
179 const CompletionCallback& callback, | 172 const CompletionCallback& callback, |
180 RequestHandle* out_req); | 173 RequestHandle* out_req); |
181 | 174 |
182 // Looks for the domain bound cert for |domain| in this service's store. | 175 // Looks for the domain bound cert for |domain| in this service's store. |
183 // Returns OK if it can be found synchronously, ERR_IO_PENDING if the | 176 // Returns OK if it can be found synchronously, ERR_IO_PENDING if the |
184 // result cannot be obtained synchronously, or a network error code on | 177 // result cannot be obtained synchronously, or a network error code on |
185 // failure (including failure to find a domain-bound cert of |domain|). | 178 // failure (including failure to find a domain-bound cert of |domain|). |
186 int LookupChannelID(const base::TimeTicks& request_start, | 179 int LookupChannelID(const base::TimeTicks& request_start, |
187 const std::string& domain, | 180 const std::string& domain, |
188 std::string* private_key, | 181 scoped_ptr<crypto::ECPrivateKey>* key, |
189 std::string* cert, | |
190 bool create_if_missing, | 182 bool create_if_missing, |
191 const CompletionCallback& callback, | 183 const CompletionCallback& callback, |
192 RequestHandle* out_req); | 184 RequestHandle* out_req); |
193 | 185 |
194 scoped_ptr<ChannelIDStore> channel_id_store_; | 186 scoped_ptr<ChannelIDStore> channel_id_store_; |
195 scoped_refptr<base::TaskRunner> task_runner_; | 187 scoped_refptr<base::TaskRunner> task_runner_; |
196 | 188 |
197 // inflight_ maps from a server to an active generation which is taking | 189 // inflight_ maps from a server to an active generation which is taking |
198 // place. | 190 // place. |
199 std::map<std::string, ChannelIDServiceJob*> inflight_; | 191 std::map<std::string, ChannelIDServiceJob*> inflight_; |
200 | 192 |
201 uint64 requests_; | 193 uint64 requests_; |
202 uint64 cert_store_hits_; | 194 uint64 key_store_hits_; |
203 uint64 inflight_joins_; | 195 uint64 inflight_joins_; |
204 uint64 workers_created_; | 196 uint64 workers_created_; |
205 | 197 |
206 bool is_system_time_valid_; | |
207 | |
208 base::WeakPtrFactory<ChannelIDService> weak_ptr_factory_; | 198 base::WeakPtrFactory<ChannelIDService> weak_ptr_factory_; |
209 | 199 |
210 DISALLOW_COPY_AND_ASSIGN(ChannelIDService); | 200 DISALLOW_COPY_AND_ASSIGN(ChannelIDService); |
211 }; | 201 }; |
212 | 202 |
| 203 // This function is the opposite of ExportKeyPair. It takes DER encoded public |
| 204 // and private keys |public_key| and |private_key| and creates a |
| 205 // crypto::ECPrivateKey. If there is an issue creating the crypto::ECPrivateKey, |
| 206 // this function returns ERR_UNEXPECTED. Otherwise it returns OK. |
| 207 // |
| 208 // This function is only exposed here so that it can be used in unittests. |
| 209 NET_EXPORT_PRIVATE Error |
| 210 CreateECPrivateKeyFromSerializedKey(const std::string& public_key, |
| 211 const std::string& private_key, |
| 212 scoped_ptr<crypto::ECPrivateKey>* key_out); |
| 213 |
| 214 // Exports the public and private keys from the provided crypto::ECPrivateKey |
| 215 // |key| and writes them to |public_key| and |private_key|. If there's an error |
| 216 // calling ExportEncryptedPrivateKey or ExportPublicKey on the ECPrivateKey, |
| 217 // then this function returns ERR_PRIVATE_KEY_EXPORT_FAILED. Otherwise it |
| 218 // returns OK. |
| 219 // |
| 220 // This function is only exposed here so that it can be used in unittests. |
| 221 NET_EXPORT_PRIVATE int ExportKeyPair( |
| 222 const scoped_ptr<crypto::ECPrivateKey>& key, |
| 223 std::string* public_key, |
| 224 std::string* private_key); |
| 225 |
213 } // namespace net | 226 } // namespace net |
214 | 227 |
215 #endif // NET_SSL_CHANNEL_ID_SERVICE_H_ | 228 #endif // NET_SSL_CHANNEL_ID_SERVICE_H_ |
OLD | NEW |