remoting/protocol/jingle_session.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef REMOTING_PROTOCOL_JINGLE_SESSION_H_
   6 #define REMOTING_PROTOCOL_JINGLE_SESSION_H_
   7
   8 #include <list>
   9 #include <map>
  10 #include <set>
  11 #include <string>
  12
  13 #include "base/memory/ref_counted.h"
  14 #include "base/timer/timer.h"
  15 #include "crypto/rsa_private_key.h"
  16 #include "net/base/completion_callback.h"
  17 #include "remoting/protocol/authenticator.h"
  18 #include "remoting/protocol/datagram_channel_factory.h"
  19 #include "remoting/protocol/jingle_messages.h"
  20 #include "remoting/protocol/session.h"
  21 #include "remoting/protocol/session_config.h"
  22 #include "remoting/protocol/transport.h"
  23 #include "remoting/signaling/iq_sender.h"
  24
  25 namespace net {
  26 class Socket;
  27 class StreamSocket;
  28 }  // namespace net
  29
  30 namespace remoting {
  31 namespace protocol {
  32
  33 class SecureChannelFactory;
  34 class ChannelMultiplexer;
  35 class JingleSessionManager;
  36 class PseudoTcpChannelFactory;
  37
  38 // JingleSessionManager and JingleSession implement the subset of the
  39 // Jingle protocol used in Chromoting. Instances of this class are
  40 // created by the JingleSessionManager.
  41 class JingleSession : public base::NonThreadSafe,
  42                       public Session,
  43                       public DatagramChannelFactory,
  44                       public Transport::EventHandler {
  45  public:
  46   ~JingleSession() override;
  47
  48   // Session interface.
  49   void SetEventHandler(Session::EventHandler* event_handler) override;
  50   ErrorCode error() override;
  51   const std::string& jid() override;
  52   const CandidateSessionConfig* candidate_config() override;
  53   const SessionConfig& config() override;
  54   void set_config(scoped_ptr<SessionConfig> config) override;
  55   StreamChannelFactory* GetTransportChannelFactory() override;
  56   StreamChannelFactory* GetMultiplexedChannelFactory() override;
  57   void Close() override;
  58
  59   // DatagramChannelFactory interface.
  60   void CreateChannel(const std::string& name,
  61                      const ChannelCreatedCallback& callback) override;
  62   void CancelChannelCreation(const std::string& name) override;
  63
  64   // Transport::EventHandler interface.
  65   void OnTransportIceCredentials(Transport* transport,
  66                                  const std::string& ufrag,
  67                                  const std::string& password) override;
  68   void OnTransportCandidate(Transport* transport,
  69                             const cricket::Candidate& candidate) override;
  70   void OnTransportRouteChange(Transport* transport,
  71                               const TransportRoute& route) override;
  72   void OnTransportFailed(Transport* transport) override;
  73   void OnTransportDeleted(Transport* transport) override;
  74
  75  private:
  76   friend class JingleSessionManager;
  77
  78   typedef std::map<std::string, Transport*> ChannelsMap;
  79   typedef base::Callback<void(JingleMessageReply::ErrorType)> ReplyCallback;
  80
  81   explicit JingleSession(JingleSessionManager* session_manager);
  82
  83   // Start connection by sending session-initiate message.
  84   void StartConnection(const std::string& peer_jid,
  85                        scoped_ptr<Authenticator> authenticator,
  86                        scoped_ptr<CandidateSessionConfig> config);
  87
  88   // Passes transport info to a new |channel| in case it was received before the
  89   // channel was created.
  90   void AddPendingRemoteTransportInfo(Transport* channel);
  91
  92   // Called by JingleSessionManager for incoming connections.
  93   void InitializeIncomingConnection(const JingleMessage& initiate_message,
  94                                     scoped_ptr<Authenticator> authenticator);
  95   void AcceptIncomingConnection(const JingleMessage& initiate_message);
  96
  97   // Sends |message| to the peer. The session is closed if the send fails or no
  98   // response is received within a reasonable time. All other responses are
  99   // ignored.
 100   void SendMessage(const JingleMessage& message);
 101
 102   // Iq response handler.
 103   void OnMessageResponse(JingleMessage::ActionType request_type,
 104                          IqRequest* request,
 105                          const buzz::XmlElement* response);
 106
 107   // Creates empty |pending_transport_info_message_| and schedules timer for
 108   // SentTransportInfo() to sent the message later.
 109   void EnsurePendingTransportInfoMessage();
 110
 111   // Sends transport-info message with candidates from |pending_candidates_|.
 112   void SendTransportInfo();
 113
 114   // Response handler for transport-info responses. Transport-info timeouts are
 115   // ignored and don't terminate connection.
 116   void OnTransportInfoResponse(IqRequest* request,
 117                                const buzz::XmlElement* response);
 118
 119   // Called by JingleSessionManager on incoming |message|. Must call
 120   // |reply_callback| to send reply message before sending any other
 121   // messages.
 122   void OnIncomingMessage(const JingleMessage& message,
 123                          const ReplyCallback& reply_callback);
 124
 125   // Message handlers for incoming messages.
 126   void OnAccept(const JingleMessage& message,
 127                 const ReplyCallback& reply_callback);
 128   void OnSessionInfo(const JingleMessage& message,
 129                      const ReplyCallback& reply_callback);
 130   void OnTerminate(const JingleMessage& message,
 131                    const ReplyCallback& reply_callback);
 132   void ProcessTransportInfo(const JingleMessage& message);
 133
 134   // Called from OnAccept() to initialize session config.
 135   bool InitializeConfigFromDescription(const ContentDescription* description);
 136
 137   // Called after the initial incoming authenticator message is processed.
 138   void ContinueAcceptIncomingConnection();
 139
 140   // Called after subsequent authenticator messages are processed.
 141   void ProcessAuthenticationStep();
 142
 143   // Called after the authenticating step is finished.
 144   void ContinueAuthenticationStep();
 145
 146   // Called when authentication is finished.
 147   void OnAuthenticated();
 148
 149   // Terminates the session and sends session-terminate if it is
 150   // necessary. |error| specifies the error code in case when the
 151   // session is being closed due to an error.
 152   void CloseInternal(ErrorCode error);
 153
 154   // Sets |state_| to |new_state| and calls state change callback.
 155   void SetState(State new_state);
 156
 157   // Returns true if the state of the session is not CLOSED or FAILED
 158   bool is_session_active();
 159
 160   JingleSessionManager* session_manager_;
 161   std::string peer_jid_;
 162   scoped_ptr<CandidateSessionConfig> candidate_config_;
 163   Session::EventHandler* event_handler_;
 164
 165   std::string session_id_;
 166   State state_;
 167   ErrorCode error_;
 168
 169   scoped_ptr<SessionConfig> config_;
 170
 171   scoped_ptr<Authenticator> authenticator_;
 172
 173   // Pending Iq requests. Used for all messages except transport-info.
 174   std::set<IqRequest*> pending_requests_;
 175
 176   // Pending transport-info requests.
 177   std::list<IqRequest*> transport_info_requests_;
 178
 179   ChannelsMap channels_;
 180   scoped_ptr<PseudoTcpChannelFactory> pseudotcp_channel_factory_;
 181   scoped_ptr<SecureChannelFactory> secure_channel_factory_;
 182   scoped_ptr<ChannelMultiplexer> channel_multiplexer_;
 183
 184   scoped_ptr<JingleMessage> pending_transport_info_message_;
 185   base::OneShotTimer<JingleSession> transport_info_timer_;
 186
 187   // Pending remote transport info received before the local channels were
 188   // created.
 189   std::list<JingleMessage::IceCredentials> pending_remote_ice_credentials_;
 190   std::list<JingleMessage::NamedCandidate> pending_remote_candidates_;
 191
 192   base::WeakPtrFactory<JingleSession> weak_factory_;
 193
 194   DISALLOW_COPY_AND_ASSIGN(JingleSession);
 195 };
 196
 197 }  // namespace protocol
 198 }  // namespace remoting
 199
 200 #endif  // REMOTING_PROTOCOL_JINGLE_SESSION_H_