Use MIDIMessageQueue/IsValidWebMIDIData for MIDI byte stream validation

content/browser/renderer_host/media/midi_host.cc

 // Copyright (c) 2013 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 "content/browser/renderer_host/media/midi_host.h"
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/debug/trace_event.h"
 #include "base/process/process.h"
 #include "content/browser/browser_main_loop.h"
 #include "content/browser/child_process_security_policy_impl.h"
 #include "content/browser/media/media_internals.h"
 #include "content/common/media/midi_messages.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/media_observer.h"
 #include "content/public/browser/user_metrics.h"
 #include "media/midi/midi_manager.h"
+#include "media/midi/midi_message_queue.h"
 
 using media::MIDIManager;
 using media::MIDIPortInfoList;
 
 // The total number of bytes which we're allowed to send to the OS
 // before knowing that they have been successfully sent.
 static const size_t kMaxInFlightBytes = 10 * 1024 * 1024;  // 10 MB.
 
 // We keep track of the number of bytes successfully sent to
 // the hardware.  Every once in a while we report back to the renderer
 // the number of bytes sent since the last report. This threshold determines
 // how many bytes will be sent before reporting back to the renderer.
 static const size_t kAcknowledgementThresholdBytes = 1024 * 1024;  // 1 MB.
 
 static const uint8 kSysExMessage = 0xf0;
 
 namespace content {
+namespace {
+
+// A class to check if current child process security policy allows the the
+// renderer to use SysEx MIDI messages or not. This class fetches the policy
+// lazily and caches the result to avoid redundant access check.
+class CanSendMIDISysExMessageQuery {
+ public:
+  explicit CanSendMIDISysExMessageQuery(int renderer_process_id)
+      : renderer_process_id_(renderer_process_id),
+        value_(false),
+        initialized_(false) {
+  }
+
+  bool get() {
+    if (!initialized_) {
+      value_ = ChildProcessSecurityPolicyImpl::GetInstance()->
+          CanSendMIDISysExMessage(renderer_process_id_);
+      initialized_ = true;
+    }
+    return value_;
+  }
+
+ private:
+  const int renderer_process_id_;
+  bool value_;
+  bool initialized_;
+
+  DISALLOW_COPY_AND_ASSIGN(CanSendMIDISysExMessageQuery);
+};
+
+}  // namespace
 
 MIDIHost::MIDIHost(int renderer_process_id, media::MIDIManager* midi_manager)
     : renderer_process_id_(renderer_process_id),
       midi_manager_(midi_manager),
       sent_bytes_in_flight_(0),
       bytes_sent_since_last_acknowledgement_(0) {
 }
 
 MIDIHost::~MIDIHost() {
   if (midi_manager_)
@@ skipping 22 matching lines @@
   MIDIPortInfoList input_ports;
   MIDIPortInfoList output_ports;
 
   // Initialize devices and register to receive MIDI data.
   bool success = false;
   if (midi_manager_) {
     success = midi_manager_->StartSession(this);
     if (success) {
       input_ports = midi_manager_->input_ports();
       output_ports = midi_manager_->output_ports();
+      received_messages_queues_.clear();
+      received_messages_queues_.resize(input_ports.size());
     }
   }
 
   Send(new MIDIMsg_SessionStarted(
        client_id,
        success,
        input_ports,
        output_ports));
 }
 
 void MIDIHost::OnSendData(uint32 port,
                           const std::vector<uint8>& data,
                           double timestamp) {
   if (!midi_manager_)
     return;
 
   if (data.empty())
     return;
 
-  base::AutoLock auto_lock(in_flight_lock_);
+  CanSendMIDISysExMessageQuery can_send_sys_ex(renderer_process_id_);

[Takashi Toyoshima, 2013/11/19 01:08:37]

Can we make it a member variable?
IIRC, this code constructs an instance on stack, whenever this method is called.
We never want to add an extra latency for non-sysex messages here.

[yukawa, 2013/11/19 09:41:41]

Hmm, I think the construction cost of |can_send_sys_ex| is regrettable. It never
does any costly tasks until get() is called (and get() will never be called for
non-sysex message).

I'm not sure the policy is really immutable. Is it OK not to check the result of
 CanSendMIDISysExMessage(renderer_process_id_) whenever MIDIHost::OnSendData is
called?  If it's OK, why we don't store the result of CanSendMIDISysExMessage at
the constructor of MIDIHost in the constructor of MIDIHost.

[Takashi Toyoshima, 2013/11/19 12:49:59]

I see. It's ok to keep this code as is.

FYI, ChildSecurityPolicy is set just before calling OnStartSession. Originally
the policy database should be immutable for a session. But actually it can be
modified if the same renderer is going to open another session. This is a
limitation of Chrome security model.

 
-  // Sanity check that we won't send too much.
-  if (sent_bytes_in_flight_ > kMaxInFlightBytes ||
-      data.size() > kMaxInFlightBytes ||
-      data.size() + sent_bytes_in_flight_ > kMaxInFlightBytes)
-    return;
+  // Note: In the spec, |data| can be any number of complete MIDI messages.
+  // Running status is disallowed explicitly.
+  media::MIDIMessageQueue message_queue(false);
+  message_queue.Add(data);
+  std::vector<uint8> message;
+  while (true) {
+    message_queue.Get(&message);
+    if (message.empty())
+      break;
 
-  if (data[0] >= kSysExMessage) {
-    // Blink running in a renderer checks permission to raise a SecurityError in
-    // JavaScript. The actual permission check for security perposes happens
-    // here in the browser process.
-    if (!ChildProcessSecurityPolicyImpl::GetInstance()->CanSendMIDISysExMessage(
-        renderer_process_id_)) {
+    // Sanity check that we won't send too large message.

[Takashi Toyoshima, 2013/11/19 01:08:37]

Here, we concern the buffer size which may be allocated by MIDIManager.
So, in_flight_lock_ + message.size() > kMaxInFlightBytes is right check as
original code did.

[yukawa, 2013/11/19 09:41:41]

Done.

+    if (message.size() > kMaxInFlightBytes)

[Takashi Toyoshima, 2013/11/19 01:08:37]

This check looks redundant.

[yukawa, 2013/11/19 09:41:41]

I put this condition here as an early exit route because this condition does not
require |in_flight_lock_|.  Anyway, I'll adopt your suggestion.

+      continue;
+
+    if (message[0] == kSysExMessage && !can_send_sys_ex.get()) {
+      // Blink running in a renderer checks permission to raise a SecurityError
+      // in JavaScript. The actual permission check for security purposes
+      // happens here in the browser process.
       RecordAction(UserMetricsAction("BadMessageTerminate_MIDI"));
       BadMessageReceived();
       return;
     }
+
+    base::AutoLock auto_lock(in_flight_lock_);
+    // Sanity check that we won't send too much data.
+    if (sent_bytes_in_flight_ > kMaxInFlightBytes ||
+        message.size() + sent_bytes_in_flight_ > kMaxInFlightBytes)

[Takashi Toyoshima, 2013/11/19 01:08:37]

Same TODO here, and any reason to check twice?
I feel the latter check meets our expectation here, and former check looks
redundant.

[yukawa, 2013/11/19 09:41:41]

Done.
BTW, the redundancy came from the original code... 

[Takashi Toyoshima, 2013/11/19 12:49:59]

lol

+      return;
+    midi_manager_->DispatchSendMIDIData(this, port, message, timestamp);
+    sent_bytes_in_flight_ += message.size();
   }
-
-  midi_manager_->DispatchSendMIDIData(
-      this,
-      port,
-      data,
-      timestamp);
-
-  sent_bytes_in_flight_ += data.size();
 }
 
 void MIDIHost::ReceiveMIDIData(
     uint32 port,
     const uint8* data,
     size_t length,
     double timestamp) {
   TRACE_EVENT0("midi", "MIDIHost::ReceiveMIDIData");
 
-  // Check a process security policy to receive a system exclusive message.
-  if (length > 0 && data[0] >= kSysExMessage) {
-    if (!ChildProcessSecurityPolicyImpl::GetInstance()->CanSendMIDISysExMessage(
-        renderer_process_id_)) {
-      // MIDI devices may send a system exclusive messages even if the renderer
-      // doesn't have a permission to receive it. Don't kill the renderer as
-      // OnSendData() does.
-      return;
-    }
+  if (received_messages_queues_.size() <= port)
+    return;
+
+  // Lazy initialization
+  if (received_messages_queues_[port] == NULL)
+    received_messages_queues_[port] = new media::MIDIMessageQueue(true);
+
+  CanSendMIDISysExMessageQuery can_send_sys_ex(renderer_process_id_);

[Takashi Toyoshima, 2013/11/19 01:08:37]

ditto. I think we can share the same instance between sender side and receiver
side.

[yukawa, 2013/11/19 09:41:41]

See my previous comment.

[Takashi Toyoshima, 2013/11/19 12:49:59]

ok

+
+  received_messages_queues_[port]->Add(data, length);
+  std::vector<uint8> message;
+  while (true) {
+    received_messages_queues_[port]->Get(&message);
+    if (message.empty())
+      break;
+
+    // MIDI devices may send a system exclusive messages even if the renderer
+    // doesn't have a permission to receive it. Don't kill the renderer as
+    // OnSendData() does.
+    if (message[0] == kSysExMessage && !can_send_sys_ex.get())
+      continue;
+
+    // Send to the renderer.
+    Send(new MIDIMsg_DataReceived(port, message, timestamp));
   }
-
-  // Send to the renderer.
-  std::vector<uint8> v(data, data + length);
-  Send(new MIDIMsg_DataReceived(port, v, timestamp));
 }
 
 void MIDIHost::AccumulateMIDIBytesSent(size_t n) {
   {
     base::AutoLock auto_lock(in_flight_lock_);
     if (n <= sent_bytes_in_flight_)
       sent_bytes_in_flight_ -= n;
   }
 
   if (bytes_sent_since_last_acknowledgement_ + n >=
       bytes_sent_since_last_acknowledgement_)
     bytes_sent_since_last_acknowledgement_ += n;
 
   if (bytes_sent_since_last_acknowledgement_ >=
       kAcknowledgementThresholdBytes) {
     Send(new MIDIMsg_AcknowledgeSentData(
         bytes_sent_since_last_acknowledgement_));
     bytes_sent_since_last_acknowledgement_ = 0;
   }
 }
 
 }  // namespace content