Certificate Transparency: Notify STH Observers of known STHs

net/cert/sth_distributor.h

 // Copyright 2016 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.
 
 #ifndef NET_CERT_STH_DISTRIBUTOR_H_
 #define NET_CERT_STH_DISTRIBUTOR_H_
 
 #include "base/observer_list.h"
 #include "net/base/net_export.h"
 #include "net/cert/sth_observer.h"
 #include "net/cert/sth_reporter.h"
 
 namespace net {
 
 namespace ct {
 
+namespace internal {
+
+// Compares SignedTreeHeads by their log ID, to facilitate creation of a
+// map of STHs where there's only one STH for each log.
+struct STHLogIDComparator {
+  bool operator()(const SignedTreeHead& first, const SignedTreeHead& second);
+};
+
+}  // namespace internal

[Ryan Sleevi, 2016/05/12 19:51:28]

DESIGN: You don't need to expose this in a public class.

[Eran Messeri, 2016/05/13 09:04:08]

Done.

+
 // A proxy for delegating new STH notifications to all registered
 // observers.
 // For each |observer| registered with RegisterObserver, the
 // NewSTHObserved method will be called whenever the STHDistributor's
 // NewSTHObserved method is invoked.
 class NET_EXPORT STHDistributor : public STHObserver, public STHReporter {
  public:
   STHDistributor();
   ~STHDistributor() override;
 
   // STHObserver implementation.
   void NewSTHObserved(const SignedTreeHead& sth) override;
 
   // STHReporter implementation
+  // Registers |observer| for new STH notifications and invokes the
+  // new STH notification of this |observer| with observed STHs (one
+  // per log).
   void RegisterObserver(STHObserver* observer) override;
+
+  // Unregisters |observer|, should only be called with observers
+  // that were previously registered  via RegisterObserver;
   void UnregisterObserver(STHObserver* observer) override;
 
  private:
+  // Set of unique STHs from logs.
+  std::set<SignedTreeHead, internal::STHLogIDComparator> observed_sths_;

[Ryan Sleevi, 2016/05/12 19:51:28]

DESIGN: An std::set<> is pretty inefficient for your problem case, as it forces
a lot of dynamic allocation (for the red-black tree), forces the design issue
you see above (the internal), and doesn't substantially gain benefits.

We're talking a value of N < 10. A linear scan over a vector is perfectly fine

[Eran Messeri, 2016/05/13 09:04:08]

Done.

+
+  // The observers for new STH notifications.
   base::ObserverList<STHObserver> observer_list_;
 };
 
 }  // namespace ct
 
 }  // namespace net
 
 #endif  // NET_CERT_STH_DISTRIBUTOR_H_