1 /* 2 * Copyright 2018 The WebRTC project authors. All Rights Reserved. 3 * 4 * Use of this source code is governed by a BSD-style license 5 * that can be found in the LICENSE file in the root of the source 6 * tree. An additional intellectual property rights grant can be found 7 * in the file PATENTS. All contributing project authors may 8 * be found in the AUTHORS file in the root of the source tree. 9 */ 10 11 #ifndef API_DTLS_TRANSPORT_INTERFACE_H_ 12 #define API_DTLS_TRANSPORT_INTERFACE_H_ 13 14 #include <memory> 15 #include <utility> 16 17 #include "absl/types/optional.h" 18 #include "api/ice_transport_interface.h" 19 #include "api/rtc_error.h" 20 #include "api/scoped_refptr.h" 21 #include "rtc_base/ref_count.h" 22 #include "rtc_base/ssl_certificate.h" 23 #include "rtc_base/system/rtc_export.h" 24 25 namespace webrtc { 26 27 // States of a DTLS transport, corresponding to the JS API specification. 28 // http://w3c.github.io/webrtc-pc/#dom-rtcdtlstransportstate 29 enum class DtlsTransportState { 30 kNew, // Has not started negotiating yet. 31 kConnecting, // In the process of negotiating a secure connection. 32 kConnected, // Completed negotiation and verified fingerprints. 33 kClosed, // Intentionally closed. 34 kFailed, // Failure due to an error or failing to verify a remote 35 // fingerprint. 36 kNumValues 37 }; 38 39 // This object gives snapshot information about the changeable state of a 40 // DTLSTransport. 41 class RTC_EXPORT DtlsTransportInformation { 42 public: 43 DtlsTransportInformation(); 44 explicit DtlsTransportInformation(DtlsTransportState state); 45 DtlsTransportInformation( 46 DtlsTransportState state, 47 absl::optional<int> tls_version, 48 absl::optional<int> ssl_cipher_suite, 49 absl::optional<int> srtp_cipher_suite, 50 std::unique_ptr<rtc::SSLCertChain> remote_ssl_certificates); 51 // Copy and assign 52 DtlsTransportInformation(const DtlsTransportInformation& c); 53 DtlsTransportInformation& operator=(const DtlsTransportInformation& c); 54 // Move 55 DtlsTransportInformation(DtlsTransportInformation&& other) = default; 56 DtlsTransportInformation& operator=(DtlsTransportInformation&& other) = 57 default; 58 state()59 DtlsTransportState state() const { return state_; } tls_version()60 absl::optional<int> tls_version() const { return tls_version_; } ssl_cipher_suite()61 absl::optional<int> ssl_cipher_suite() const { return ssl_cipher_suite_; } srtp_cipher_suite()62 absl::optional<int> srtp_cipher_suite() const { return srtp_cipher_suite_; } 63 // The accessor returns a temporary pointer, it does not release ownership. remote_ssl_certificates()64 const rtc::SSLCertChain* remote_ssl_certificates() const { 65 return remote_ssl_certificates_.get(); 66 } 67 68 private: 69 DtlsTransportState state_; 70 absl::optional<int> tls_version_; 71 absl::optional<int> ssl_cipher_suite_; 72 absl::optional<int> srtp_cipher_suite_; 73 std::unique_ptr<rtc::SSLCertChain> remote_ssl_certificates_; 74 }; 75 76 class DtlsTransportObserverInterface { 77 public: 78 // This callback carries information about the state of the transport. 79 // The argument is a pass-by-value snapshot of the state. 80 virtual void OnStateChange(DtlsTransportInformation info) = 0; 81 // This callback is called when an error occurs, causing the transport 82 // to go to the kFailed state. 83 virtual void OnError(RTCError error) = 0; 84 85 protected: 86 virtual ~DtlsTransportObserverInterface() = default; 87 }; 88 89 // A DTLS transport, as represented to the outside world. 90 // This object is created on the network thread, and can only be 91 // accessed on that thread, except for functions explicitly marked otherwise. 92 // References can be held by other threads, and destruction can therefore 93 // be initiated by other threads. 94 class DtlsTransportInterface : public rtc::RefCountInterface { 95 public: 96 // Returns a pointer to the ICE transport that is owned by the DTLS transport. 97 virtual rtc::scoped_refptr<IceTransportInterface> ice_transport() = 0; 98 // Returns information on the state of the DtlsTransport. 99 // This function can be called from other threads. 100 virtual DtlsTransportInformation Information() = 0; 101 // Observer management. 102 virtual void RegisterObserver(DtlsTransportObserverInterface* observer) = 0; 103 virtual void UnregisterObserver() = 0; 104 }; 105 106 } // namespace webrtc 107 108 #endif // API_DTLS_TRANSPORT_INTERFACE_H_ 109