blob: 43e2a087a04d09624d37a33ea9876213c7f33057 [file] [log] [blame]
Patrik Höglund56d94522019-11-18 15:53:32 +01001/*
2 * Copyright 2004 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_TRANSPORT_STUN_H_
12#define API_TRANSPORT_STUN_H_
13
14// This file contains classes for dealing with the STUN protocol, as specified
15// in RFC 5389, and its descendants.
16
17#include <stddef.h>
18#include <stdint.h>
Harald Alvestrand07d83c82021-03-02 08:09:53 +000019
Harald Alvestrandbee64082020-11-12 11:17:41 +000020#include <functional>
Patrik Höglund56d94522019-11-18 15:53:32 +010021#include <memory>
22#include <string>
23#include <vector>
24
Harald Alvestrandbee64082020-11-12 11:17:41 +000025#include "absl/strings/string_view.h"
26#include "api/array_view.h"
Patrik Höglund56d94522019-11-18 15:53:32 +010027#include "rtc_base/byte_buffer.h"
28#include "rtc_base/ip_address.h"
29#include "rtc_base/socket_address.h"
30
31namespace cricket {
32
33// These are the types of STUN messages defined in RFC 5389.
Tommi408143d2022-06-01 15:29:31 +020034enum StunMessageType : uint16_t {
35 STUN_INVALID_MESSAGE_TYPE = 0x0000,
Patrik Höglund56d94522019-11-18 15:53:32 +010036 STUN_BINDING_REQUEST = 0x0001,
37 STUN_BINDING_INDICATION = 0x0011,
38 STUN_BINDING_RESPONSE = 0x0101,
39 STUN_BINDING_ERROR_RESPONSE = 0x0111,
Jonas Oreland63737a92019-11-21 15:12:14 +010040
Jonas Oreland9a52bd72019-12-11 11:35:48 +010041 // Method 0x80, GOOG-PING is a variant of STUN BINDING
42 // that is sent instead of a STUN BINDING if the binding
43 // was identical to the one before.
Jonas Oreland63737a92019-11-21 15:12:14 +010044 GOOG_PING_REQUEST = 0x200,
45 GOOG_PING_RESPONSE = 0x300,
46 GOOG_PING_ERROR_RESPONSE = 0x310,
Patrik Höglund56d94522019-11-18 15:53:32 +010047};
48
49// These are all known STUN attributes, defined in RFC 5389 and elsewhere.
50// Next to each is the name of the class (T is StunTAttribute) that implements
51// that type.
52// RETRANSMIT_COUNT is the number of outstanding pings without a response at
53// the time the packet is generated.
54enum StunAttributeType {
55 STUN_ATTR_MAPPED_ADDRESS = 0x0001, // Address
56 STUN_ATTR_USERNAME = 0x0006, // ByteString
57 STUN_ATTR_MESSAGE_INTEGRITY = 0x0008, // ByteString, 20 bytes
58 STUN_ATTR_ERROR_CODE = 0x0009, // ErrorCode
59 STUN_ATTR_UNKNOWN_ATTRIBUTES = 0x000a, // UInt16List
60 STUN_ATTR_REALM = 0x0014, // ByteString
61 STUN_ATTR_NONCE = 0x0015, // ByteString
62 STUN_ATTR_XOR_MAPPED_ADDRESS = 0x0020, // XorAddress
63 STUN_ATTR_SOFTWARE = 0x8022, // ByteString
64 STUN_ATTR_ALTERNATE_SERVER = 0x8023, // Address
65 STUN_ATTR_FINGERPRINT = 0x8028, // UInt32
Patrik Höglund56d94522019-11-18 15:53:32 +010066 STUN_ATTR_RETRANSMIT_COUNT = 0xFF00 // UInt32
67};
68
69// These are the types of the values associated with the attributes above.
70// This allows us to perform some basic validation when reading or adding
71// attributes. Note that these values are for our own use, and not defined in
72// RFC 5389.
73enum StunAttributeValueType {
74 STUN_VALUE_UNKNOWN = 0,
75 STUN_VALUE_ADDRESS = 1,
76 STUN_VALUE_XOR_ADDRESS = 2,
77 STUN_VALUE_UINT32 = 3,
78 STUN_VALUE_UINT64 = 4,
79 STUN_VALUE_BYTE_STRING = 5,
80 STUN_VALUE_ERROR_CODE = 6,
81 STUN_VALUE_UINT16_LIST = 7
82};
83
84// These are the types of STUN addresses defined in RFC 5389.
85enum StunAddressFamily {
86 // NB: UNDEF is not part of the STUN spec.
87 STUN_ADDRESS_UNDEF = 0,
88 STUN_ADDRESS_IPV4 = 1,
89 STUN_ADDRESS_IPV6 = 2
90};
91
92// These are the types of STUN error codes defined in RFC 5389.
93enum StunErrorCode {
94 STUN_ERROR_TRY_ALTERNATE = 300,
95 STUN_ERROR_BAD_REQUEST = 400,
96 STUN_ERROR_UNAUTHORIZED = 401,
97 STUN_ERROR_UNKNOWN_ATTRIBUTE = 420,
Patrik Höglund56d94522019-11-18 15:53:32 +010098 STUN_ERROR_STALE_NONCE = 438,
99 STUN_ERROR_SERVER_ERROR = 500,
100 STUN_ERROR_GLOBAL_FAILURE = 600
101};
102
103// Strings for the error codes above.
104extern const char STUN_ERROR_REASON_TRY_ALTERNATE_SERVER[];
105extern const char STUN_ERROR_REASON_BAD_REQUEST[];
106extern const char STUN_ERROR_REASON_UNAUTHORIZED[];
107extern const char STUN_ERROR_REASON_UNKNOWN_ATTRIBUTE[];
Patrik Höglund56d94522019-11-18 15:53:32 +0100108extern const char STUN_ERROR_REASON_STALE_NONCE[];
109extern const char STUN_ERROR_REASON_SERVER_ERROR[];
110
111// The mask used to determine whether a STUN message is a request/response etc.
112const uint32_t kStunTypeMask = 0x0110;
113
114// STUN Attribute header length.
115const size_t kStunAttributeHeaderSize = 4;
116
117// Following values correspond to RFC5389.
118const size_t kStunHeaderSize = 20;
119const size_t kStunTransactionIdOffset = 8;
120const size_t kStunTransactionIdLength = 12;
121const uint32_t kStunMagicCookie = 0x2112A442;
122constexpr size_t kStunMagicCookieLength = sizeof(kStunMagicCookie);
123
124// Following value corresponds to an earlier version of STUN from
125// RFC3489.
126const size_t kStunLegacyTransactionIdLength = 16;
127
128// STUN Message Integrity HMAC length.
129const size_t kStunMessageIntegritySize = 20;
Jonas Oreland63737a92019-11-21 15:12:14 +0100130// Size of STUN_ATTR_MESSAGE_INTEGRITY_32
131const size_t kStunMessageIntegrity32Size = 4;
Patrik Höglund56d94522019-11-18 15:53:32 +0100132
133class StunAddressAttribute;
134class StunAttribute;
135class StunByteStringAttribute;
136class StunErrorCodeAttribute;
Patrik Höglund56d94522019-11-18 15:53:32 +0100137class StunUInt16ListAttribute;
138class StunUInt32Attribute;
139class StunUInt64Attribute;
140class StunXorAddressAttribute;
141
142// Records a complete STUN/TURN message. Each message consists of a type and
143// any number of attributes. Each attribute is parsed into an instance of an
144// appropriate class (see above). The Get* methods will return instances of
145// that attribute class.
146class StunMessage {
147 public:
Tommi408143d2022-06-01 15:29:31 +0200148 // Constructs a StunMessage with an invalid type and empty, legacy length
149 // (16 bytes, RFC3489) transaction id.
Patrik Höglund56d94522019-11-18 15:53:32 +0100150 StunMessage();
Tommi408143d2022-06-01 15:29:31 +0200151
152 // Construct a `StunMessage` with a specific type and generate a new
153 // 12 byte transaction id (RFC5389).
154 explicit StunMessage(uint16_t type);
155
156 StunMessage(uint16_t type, absl::string_view transaction_id);
157
Patrik Höglund56d94522019-11-18 15:53:32 +0100158 virtual ~StunMessage();
159
Harald Alvestrand07d83c82021-03-02 08:09:53 +0000160 // The verification status of the message. This is checked on parsing,
161 // or set by AddMessageIntegrity.
162 enum class IntegrityStatus {
163 kNotSet,
164 kNoIntegrity, // Message-integrity attribute missing
165 kIntegrityOk, // Message-integrity checked OK
166 kIntegrityBad, // Message-integrity verification failed
167 };
168
Patrik Höglund56d94522019-11-18 15:53:32 +0100169 int type() const { return type_; }
170 size_t length() const { return length_; }
171 const std::string& transaction_id() const { return transaction_id_; }
172 uint32_t reduced_transaction_id() const { return reduced_transaction_id_; }
173
174 // Returns true if the message confirms to RFC3489 rather than
Harald Alvestrand07d83c82021-03-02 08:09:53 +0000175 // RFC5389. The main difference between the two versions of the STUN
Patrik Höglund56d94522019-11-18 15:53:32 +0100176 // protocol is the presence of the magic cookie and different length
Harald Alvestrand07d83c82021-03-02 08:09:53 +0000177 // of transaction ID. For outgoing packets the version of the protocol
Patrik Höglund56d94522019-11-18 15:53:32 +0100178 // is determined by the lengths of the transaction ID.
179 bool IsLegacy() const;
180
181 void SetType(int type) { type_ = static_cast<uint16_t>(type); }
Tommi408143d2022-06-01 15:29:31 +0200182 [[deprecated]] bool SetTransactionID(absl::string_view transaction_id) {
183 if (!IsValidTransactionId(transaction_id))
184 return false;
185 SetTransactionIdForTesting(transaction_id);
186 return true;
187 }
Patrik Höglund56d94522019-11-18 15:53:32 +0100188
Taylor Brandstetterfb4351b2020-03-23 16:00:31 -0700189 // Get a list of all of the attribute types in the "comprehension required"
190 // range that were not recognized.
191 std::vector<uint16_t> GetNonComprehendedAttributes() const;
192
Patrik Höglund56d94522019-11-18 15:53:32 +0100193 // Gets the desired attribute value, or NULL if no such attribute type exists.
194 const StunAddressAttribute* GetAddress(int type) const;
195 const StunUInt32Attribute* GetUInt32(int type) const;
196 const StunUInt64Attribute* GetUInt64(int type) const;
197 const StunByteStringAttribute* GetByteString(int type) const;
Jonas Oreland1721de12019-11-20 12:10:39 +0100198 const StunUInt16ListAttribute* GetUInt16List(int type) const;
Patrik Höglund56d94522019-11-18 15:53:32 +0100199
200 // Gets these specific attribute values.
201 const StunErrorCodeAttribute* GetErrorCode() const;
202 // Returns the code inside the error code attribute, if present, and
203 // STUN_ERROR_GLOBAL_FAILURE otherwise.
204 int GetErrorCodeValue() const;
205 const StunUInt16ListAttribute* GetUnknownAttributes() const;
206
207 // Takes ownership of the specified attribute and adds it to the message.
208 void AddAttribute(std::unique_ptr<StunAttribute> attr);
209
210 // Remove the last occurrence of an attribute.
211 std::unique_ptr<StunAttribute> RemoveAttribute(int type);
212
Jonas Oreland63737a92019-11-21 15:12:14 +0100213 // Remote all attributes and releases them.
214 void ClearAttributes();
215
Harald Alvestrand07d83c82021-03-02 08:09:53 +0000216 // Validates that a STUN message has a correct MESSAGE-INTEGRITY value.
217 // This uses the buffered raw-format message stored by Read().
218 IntegrityStatus ValidateMessageIntegrity(const std::string& password);
219
220 // Returns the current integrity status of the message.
221 IntegrityStatus integrity() const { return integrity_; }
222
223 // Shortcut for checking if integrity is verified.
224 bool IntegrityOk() const {
225 return integrity_ == IntegrityStatus::kIntegrityOk;
226 }
227
228 // Returns the password attribute used to set or check the integrity.
229 // Can only be called after adding or checking the integrity.
230 std::string password() const {
231 RTC_DCHECK(integrity_ != IntegrityStatus::kNotSet);
232 return password_;
233 }
Jonas Oreland63737a92019-11-21 15:12:14 +0100234
Patrik Höglund56d94522019-11-18 15:53:32 +0100235 // Adds a MESSAGE-INTEGRITY attribute that is valid for the current message.
Tommie83500e2022-06-03 14:28:59 +0200236 bool AddMessageIntegrity(absl::string_view password);
Patrik Höglund56d94522019-11-18 15:53:32 +0100237
Jonas Oreland63737a92019-11-21 15:12:14 +0100238 // Adds a STUN_ATTR_GOOG_MESSAGE_INTEGRITY_32 attribute that is valid for the
239 // current message.
240 bool AddMessageIntegrity32(absl::string_view password);
241
Jonas Oreland253d50f2019-11-28 17:08:07 +0100242 // Verify that a buffer has stun magic cookie and one of the specified
243 // methods. Note that it does not check for the existance of FINGERPRINT.
244 static bool IsStunMethod(rtc::ArrayView<int> methods,
245 const char* data,
246 size_t size);
247
Patrik Höglund56d94522019-11-18 15:53:32 +0100248 // Verifies that a given buffer is STUN by checking for a correct FINGERPRINT.
249 static bool ValidateFingerprint(const char* data, size_t size);
250
Tommi408143d2022-06-01 15:29:31 +0200251 // Generates a new 12 byte (RFC5389) transaction id.
252 static std::string GenerateTransactionId();
253
Patrik Höglund56d94522019-11-18 15:53:32 +0100254 // Adds a FINGERPRINT attribute that is valid for the current message.
255 bool AddFingerprint();
256
257 // Parses the STUN packet in the given buffer and records it here. The
258 // return value indicates whether this was successful.
259 bool Read(rtc::ByteBufferReader* buf);
260
261 // Writes this object into a STUN packet. The return value indicates whether
262 // this was successful.
263 bool Write(rtc::ByteBufferWriter* buf) const;
264
265 // Creates an empty message. Overridable by derived classes.
266 virtual StunMessage* CreateNew() const;
267
268 // Modify the stun magic cookie used for this STUN message.
269 // This is used for testing.
Tommi408143d2022-06-01 15:29:31 +0200270 [[deprecated]] void SetStunMagicCookie(uint32_t val);
271
272 // Change the internal transaction id. Used only for testing.
273 void SetTransactionIdForTesting(absl::string_view transaction_id);
Patrik Höglund56d94522019-11-18 15:53:32 +0100274
Artem Titov0e61fdd2021-07-25 21:50:14 +0200275 // Contruct a copy of `this`.
Jonas Oreland253d50f2019-11-28 17:08:07 +0100276 std::unique_ptr<StunMessage> Clone() const;
277
Artem Titov0e61fdd2021-07-25 21:50:14 +0200278 // Check if the attributes of this StunMessage equals those of `other`
279 // for all attributes that `attribute_type_mask` return true
Jonas Oreland253d50f2019-11-28 17:08:07 +0100280 bool EqualAttributes(const StunMessage* other,
281 std::function<bool(int type)> attribute_type_mask) const;
282
Harald Alvestrand07d83c82021-03-02 08:09:53 +0000283 // Expose raw-buffer ValidateMessageIntegrity function for testing.
284 static bool ValidateMessageIntegrityForTesting(const char* data,
285 size_t size,
286 const std::string& password) {
287 return ValidateMessageIntegrity(data, size, password);
288 }
289 // Expose raw-buffer ValidateMessageIntegrity function for testing.
290 static bool ValidateMessageIntegrity32ForTesting(
291 const char* data,
292 size_t size,
293 const std::string& password) {
294 return ValidateMessageIntegrity32(data, size, password);
295 }
296 // Validates that a STUN message in byte buffer form
297 // has a correct MESSAGE-INTEGRITY value.
298 // These functions are not recommended and will be deprecated; use
299 // ValidateMessageIntegrity(password) on the parsed form instead.
300 static bool ValidateMessageIntegrity(const char* data,
301 size_t size,
302 const std::string& password);
303 static bool ValidateMessageIntegrity32(const char* data,
304 size_t size,
305 const std::string& password);
306
Patrik Höglund56d94522019-11-18 15:53:32 +0100307 protected:
308 // Verifies that the given attribute is allowed for this message.
309 virtual StunAttributeValueType GetAttributeValueType(int type) const;
310
Jonas Oreland253d50f2019-11-28 17:08:07 +0100311 std::vector<std::unique_ptr<StunAttribute>> attrs_;
312
Patrik Höglund56d94522019-11-18 15:53:32 +0100313 private:
314 StunAttribute* CreateAttribute(int type, size_t length) /* const*/;
315 const StunAttribute* GetAttribute(int type) const;
Tommi408143d2022-06-01 15:29:31 +0200316 static bool IsValidTransactionId(absl::string_view transaction_id);
Jonas Oreland63737a92019-11-21 15:12:14 +0100317 bool AddMessageIntegrityOfType(int mi_attr_type,
318 size_t mi_attr_size,
Tommie83500e2022-06-03 14:28:59 +0200319 absl::string_view key);
Jonas Oreland63737a92019-11-21 15:12:14 +0100320 static bool ValidateMessageIntegrityOfType(int mi_attr_type,
321 size_t mi_attr_size,
322 const char* data,
323 size_t size,
324 const std::string& password);
Patrik Höglund56d94522019-11-18 15:53:32 +0100325
Tommi408143d2022-06-01 15:29:31 +0200326 uint16_t type_ = STUN_INVALID_MESSAGE_TYPE;
327 uint16_t length_ = 0;
Patrik Höglund56d94522019-11-18 15:53:32 +0100328 std::string transaction_id_;
Tommi408143d2022-06-01 15:29:31 +0200329 uint32_t reduced_transaction_id_ = 0;
330 uint32_t stun_magic_cookie_ = kStunMagicCookie;
Harald Alvestrand07d83c82021-03-02 08:09:53 +0000331 // The original buffer for messages created by Read().
332 std::string buffer_;
333 IntegrityStatus integrity_ = IntegrityStatus::kNotSet;
334 std::string password_;
Patrik Höglund56d94522019-11-18 15:53:32 +0100335};
336
337// Base class for all STUN/TURN attributes.
338class StunAttribute {
339 public:
340 virtual ~StunAttribute() {}
341
342 int type() const { return type_; }
343 size_t length() const { return length_; }
344
345 // Return the type of this attribute.
346 virtual StunAttributeValueType value_type() const = 0;
347
348 // Only XorAddressAttribute needs this so far.
349 virtual void SetOwner(StunMessage* owner) {}
350
351 // Reads the body (not the type or length) for this type of attribute from
352 // the given buffer. Return value is true if successful.
353 virtual bool Read(rtc::ByteBufferReader* buf) = 0;
354
355 // Writes the body (not the type or length) to the given buffer. Return
356 // value is true if successful.
357 virtual bool Write(rtc::ByteBufferWriter* buf) const = 0;
358
359 // Creates an attribute object with the given type and smallest length.
360 static StunAttribute* Create(StunAttributeValueType value_type,
361 uint16_t type,
362 uint16_t length,
363 StunMessage* owner);
364 // TODO(?): Allow these create functions to take parameters, to reduce
365 // the amount of work callers need to do to initialize attributes.
366 static std::unique_ptr<StunAddressAttribute> CreateAddress(uint16_t type);
367 static std::unique_ptr<StunXorAddressAttribute> CreateXorAddress(
368 uint16_t type);
369 static std::unique_ptr<StunUInt32Attribute> CreateUInt32(uint16_t type);
370 static std::unique_ptr<StunUInt64Attribute> CreateUInt64(uint16_t type);
371 static std::unique_ptr<StunByteStringAttribute> CreateByteString(
372 uint16_t type);
Jonas Oreland1721de12019-11-20 12:10:39 +0100373 static std::unique_ptr<StunUInt16ListAttribute> CreateUInt16ListAttribute(
374 uint16_t type);
Patrik Höglund56d94522019-11-18 15:53:32 +0100375 static std::unique_ptr<StunErrorCodeAttribute> CreateErrorCode();
376 static std::unique_ptr<StunUInt16ListAttribute> CreateUnknownAttributes();
377
378 protected:
379 StunAttribute(uint16_t type, uint16_t length);
380 void SetLength(uint16_t length) { length_ = length; }
381 void WritePadding(rtc::ByteBufferWriter* buf) const;
382 void ConsumePadding(rtc::ByteBufferReader* buf) const;
383
384 private:
385 uint16_t type_;
386 uint16_t length_;
387};
388
389// Implements STUN attributes that record an Internet address.
390class StunAddressAttribute : public StunAttribute {
391 public:
392 static const uint16_t SIZE_UNDEF = 0;
393 static const uint16_t SIZE_IP4 = 8;
394 static const uint16_t SIZE_IP6 = 20;
395 StunAddressAttribute(uint16_t type, const rtc::SocketAddress& addr);
396 StunAddressAttribute(uint16_t type, uint16_t length);
397
398 StunAttributeValueType value_type() const override;
399
400 StunAddressFamily family() const {
401 switch (address_.ipaddr().family()) {
402 case AF_INET:
403 return STUN_ADDRESS_IPV4;
404 case AF_INET6:
405 return STUN_ADDRESS_IPV6;
406 }
407 return STUN_ADDRESS_UNDEF;
408 }
409
410 const rtc::SocketAddress& GetAddress() const { return address_; }
411 const rtc::IPAddress& ipaddr() const { return address_.ipaddr(); }
412 uint16_t port() const { return address_.port(); }
413
414 void SetAddress(const rtc::SocketAddress& addr) {
415 address_ = addr;
416 EnsureAddressLength();
417 }
418 void SetIP(const rtc::IPAddress& ip) {
419 address_.SetIP(ip);
420 EnsureAddressLength();
421 }
422 void SetPort(uint16_t port) { address_.SetPort(port); }
423
424 bool Read(rtc::ByteBufferReader* buf) override;
425 bool Write(rtc::ByteBufferWriter* buf) const override;
426
427 private:
428 void EnsureAddressLength() {
429 switch (family()) {
430 case STUN_ADDRESS_IPV4: {
431 SetLength(SIZE_IP4);
432 break;
433 }
434 case STUN_ADDRESS_IPV6: {
435 SetLength(SIZE_IP6);
436 break;
437 }
438 default: {
439 SetLength(SIZE_UNDEF);
440 break;
441 }
442 }
443 }
444 rtc::SocketAddress address_;
445};
446
447// Implements STUN attributes that record an Internet address. When encoded
448// in a STUN message, the address contained in this attribute is XORed with the
449// transaction ID of the message.
450class StunXorAddressAttribute : public StunAddressAttribute {
451 public:
452 StunXorAddressAttribute(uint16_t type, const rtc::SocketAddress& addr);
453 StunXorAddressAttribute(uint16_t type, uint16_t length, StunMessage* owner);
454
455 StunAttributeValueType value_type() const override;
456 void SetOwner(StunMessage* owner) override;
457 bool Read(rtc::ByteBufferReader* buf) override;
458 bool Write(rtc::ByteBufferWriter* buf) const override;
459
460 private:
461 rtc::IPAddress GetXoredIP() const;
462 StunMessage* owner_;
463};
464
465// Implements STUN attributes that record a 32-bit integer.
466class StunUInt32Attribute : public StunAttribute {
467 public:
468 static const uint16_t SIZE = 4;
469 StunUInt32Attribute(uint16_t type, uint32_t value);
470 explicit StunUInt32Attribute(uint16_t type);
471
472 StunAttributeValueType value_type() const override;
473
474 uint32_t value() const { return bits_; }
475 void SetValue(uint32_t bits) { bits_ = bits; }
476
477 bool GetBit(size_t index) const;
478 void SetBit(size_t index, bool value);
479
480 bool Read(rtc::ByteBufferReader* buf) override;
481 bool Write(rtc::ByteBufferWriter* buf) const override;
482
483 private:
484 uint32_t bits_;
485};
486
487class StunUInt64Attribute : public StunAttribute {
488 public:
489 static const uint16_t SIZE = 8;
490 StunUInt64Attribute(uint16_t type, uint64_t value);
491 explicit StunUInt64Attribute(uint16_t type);
492
493 StunAttributeValueType value_type() const override;
494
495 uint64_t value() const { return bits_; }
496 void SetValue(uint64_t bits) { bits_ = bits; }
497
498 bool Read(rtc::ByteBufferReader* buf) override;
499 bool Write(rtc::ByteBufferWriter* buf) const override;
500
501 private:
502 uint64_t bits_;
503};
504
505// Implements STUN attributes that record an arbitrary byte string.
506class StunByteStringAttribute : public StunAttribute {
507 public:
508 explicit StunByteStringAttribute(uint16_t type);
Tommie83500e2022-06-03 14:28:59 +0200509 StunByteStringAttribute(uint16_t type, absl::string_view str);
Patrik Höglund56d94522019-11-18 15:53:32 +0100510 StunByteStringAttribute(uint16_t type, const void* bytes, size_t length);
511 StunByteStringAttribute(uint16_t type, uint16_t length);
512 ~StunByteStringAttribute() override;
513
514 StunAttributeValueType value_type() const override;
515
516 const char* bytes() const { return bytes_; }
Tommie83500e2022-06-03 14:28:59 +0200517 absl::string_view string_view() const {
518 return absl::string_view(bytes_, length());
519 }
Patrik Höglund56d94522019-11-18 15:53:32 +0100520
Tommie83500e2022-06-03 14:28:59 +0200521 [[deprecated]] std::string GetString() const {
522 return std::string(bytes_, length());
523 }
524
Patrik Höglund56d94522019-11-18 15:53:32 +0100525 void CopyBytes(const void* bytes, size_t length);
Tommie83500e2022-06-03 14:28:59 +0200526 void CopyBytes(absl::string_view bytes);
Patrik Höglund56d94522019-11-18 15:53:32 +0100527
528 uint8_t GetByte(size_t index) const;
529 void SetByte(size_t index, uint8_t value);
530
531 bool Read(rtc::ByteBufferReader* buf) override;
532 bool Write(rtc::ByteBufferWriter* buf) const override;
533
534 private:
535 void SetBytes(char* bytes, size_t length);
536
537 char* bytes_;
538};
539
540// Implements STUN attributes that record an error code.
541class StunErrorCodeAttribute : public StunAttribute {
542 public:
543 static const uint16_t MIN_SIZE;
544 StunErrorCodeAttribute(uint16_t type, int code, const std::string& reason);
545 StunErrorCodeAttribute(uint16_t type, uint16_t length);
546 ~StunErrorCodeAttribute() override;
547
548 StunAttributeValueType value_type() const override;
549
550 // The combined error and class, e.g. 0x400.
551 int code() const;
552 void SetCode(int code);
553
554 // The individual error components.
555 int eclass() const { return class_; }
556 int number() const { return number_; }
557 const std::string& reason() const { return reason_; }
558 void SetClass(uint8_t eclass) { class_ = eclass; }
559 void SetNumber(uint8_t number) { number_ = number; }
560 void SetReason(const std::string& reason);
561
562 bool Read(rtc::ByteBufferReader* buf) override;
563 bool Write(rtc::ByteBufferWriter* buf) const override;
564
565 private:
566 uint8_t class_;
567 uint8_t number_;
568 std::string reason_;
569};
570
571// Implements STUN attributes that record a list of attribute names.
572class StunUInt16ListAttribute : public StunAttribute {
573 public:
574 StunUInt16ListAttribute(uint16_t type, uint16_t length);
575 ~StunUInt16ListAttribute() override;
576
577 StunAttributeValueType value_type() const override;
578
579 size_t Size() const;
580 uint16_t GetType(int index) const;
581 void SetType(int index, uint16_t value);
582 void AddType(uint16_t value);
Jonas Oreland63737a92019-11-21 15:12:14 +0100583 void AddTypeAtIndex(uint16_t index, uint16_t value);
Patrik Höglund56d94522019-11-18 15:53:32 +0100584
585 bool Read(rtc::ByteBufferReader* buf) override;
586 bool Write(rtc::ByteBufferWriter* buf) const override;
587
588 private:
589 std::vector<uint16_t>* attr_types_;
590};
591
Jonas Oreland9a52bd72019-12-11 11:35:48 +0100592// Return a string e.g "STUN BINDING request".
593std::string StunMethodToString(int msg_type);
594
Patrik Höglund56d94522019-11-18 15:53:32 +0100595// Returns the (successful) response type for the given request type.
Artem Titov0e61fdd2021-07-25 21:50:14 +0200596// Returns -1 if `request_type` is not a valid request type.
Patrik Höglund56d94522019-11-18 15:53:32 +0100597int GetStunSuccessResponseType(int request_type);
598
599// Returns the error response type for the given request type.
Artem Titov0e61fdd2021-07-25 21:50:14 +0200600// Returns -1 if `request_type` is not a valid request type.
Patrik Höglund56d94522019-11-18 15:53:32 +0100601int GetStunErrorResponseType(int request_type);
602
603// Returns whether a given message is a request type.
604bool IsStunRequestType(int msg_type);
605
606// Returns whether a given message is an indication type.
607bool IsStunIndicationType(int msg_type);
608
609// Returns whether a given response is a success type.
610bool IsStunSuccessResponseType(int msg_type);
611
612// Returns whether a given response is an error type.
613bool IsStunErrorResponseType(int msg_type);
614
615// Computes the STUN long-term credential hash.
616bool ComputeStunCredentialHash(const std::string& username,
617 const std::string& realm,
618 const std::string& password,
619 std::string* hash);
620
Artem Titov0e61fdd2021-07-25 21:50:14 +0200621// Make a copy af `attribute` and return a new StunAttribute.
Patrik Höglund56d94522019-11-18 15:53:32 +0100622// This is useful if you don't care about what kind of attribute you
623// are handling.
624//
625// The implementation copies by calling Write() followed by Read().
626//
Artem Titov0e61fdd2021-07-25 21:50:14 +0200627// If `tmp_buffer` is supplied this buffer will be used, otherwise
Patrik Höglund56d94522019-11-18 15:53:32 +0100628// a buffer will created in the method.
629std::unique_ptr<StunAttribute> CopyStunAttribute(
630 const StunAttribute& attribute,
631 rtc::ByteBufferWriter* tmp_buffer_ptr = 0);
632
633// TODO(?): Move the TURN/ICE stuff below out to separate files.
634extern const char TURN_MAGIC_COOKIE_VALUE[4];
635
636// "GTURN" STUN methods.
637// TODO(?): Rename these methods to GTURN_ to make it clear they aren't
638// part of standard STUN/TURN.
639enum RelayMessageType {
640 // For now, using the same defs from TurnMessageType below.
641 // STUN_ALLOCATE_REQUEST = 0x0003,
642 // STUN_ALLOCATE_RESPONSE = 0x0103,
643 // STUN_ALLOCATE_ERROR_RESPONSE = 0x0113,
644 STUN_SEND_REQUEST = 0x0004,
645 STUN_SEND_RESPONSE = 0x0104,
646 STUN_SEND_ERROR_RESPONSE = 0x0114,
647 STUN_DATA_INDICATION = 0x0115,
648};
649
650// "GTURN"-specific STUN attributes.
651// TODO(?): Rename these attributes to GTURN_ to avoid conflicts.
652enum RelayAttributeType {
653 STUN_ATTR_LIFETIME = 0x000d, // UInt32
654 STUN_ATTR_MAGIC_COOKIE = 0x000f, // ByteString, 4 bytes
655 STUN_ATTR_BANDWIDTH = 0x0010, // UInt32
656 STUN_ATTR_DESTINATION_ADDRESS = 0x0011, // Address
657 STUN_ATTR_SOURCE_ADDRESS2 = 0x0012, // Address
658 STUN_ATTR_DATA = 0x0013, // ByteString
659 STUN_ATTR_OPTIONS = 0x8001, // UInt32
660};
661
662// A "GTURN" STUN message.
663class RelayMessage : public StunMessage {
Tommi408143d2022-06-01 15:29:31 +0200664 public:
665 using StunMessage::StunMessage;
666
Patrik Höglund56d94522019-11-18 15:53:32 +0100667 protected:
668 StunAttributeValueType GetAttributeValueType(int type) const override;
669 StunMessage* CreateNew() const override;
670};
671
672// Defined in TURN RFC 5766.
Tommi408143d2022-06-01 15:29:31 +0200673enum TurnMessageType : uint16_t {
Patrik Höglund56d94522019-11-18 15:53:32 +0100674 STUN_ALLOCATE_REQUEST = 0x0003,
675 STUN_ALLOCATE_RESPONSE = 0x0103,
676 STUN_ALLOCATE_ERROR_RESPONSE = 0x0113,
677 TURN_REFRESH_REQUEST = 0x0004,
678 TURN_REFRESH_RESPONSE = 0x0104,
679 TURN_REFRESH_ERROR_RESPONSE = 0x0114,
680 TURN_SEND_INDICATION = 0x0016,
681 TURN_DATA_INDICATION = 0x0017,
682 TURN_CREATE_PERMISSION_REQUEST = 0x0008,
683 TURN_CREATE_PERMISSION_RESPONSE = 0x0108,
684 TURN_CREATE_PERMISSION_ERROR_RESPONSE = 0x0118,
685 TURN_CHANNEL_BIND_REQUEST = 0x0009,
686 TURN_CHANNEL_BIND_RESPONSE = 0x0109,
687 TURN_CHANNEL_BIND_ERROR_RESPONSE = 0x0119,
688};
689
690enum TurnAttributeType {
691 STUN_ATTR_CHANNEL_NUMBER = 0x000C, // UInt32
692 STUN_ATTR_TURN_LIFETIME = 0x000d, // UInt32
693 STUN_ATTR_XOR_PEER_ADDRESS = 0x0012, // XorAddress
694 // TODO(mallinath) - Uncomment after RelayAttributes are renamed.
695 // STUN_ATTR_DATA = 0x0013, // ByteString
696 STUN_ATTR_XOR_RELAYED_ADDRESS = 0x0016, // XorAddress
697 STUN_ATTR_EVEN_PORT = 0x0018, // ByteString, 1 byte.
698 STUN_ATTR_REQUESTED_TRANSPORT = 0x0019, // UInt32
699 STUN_ATTR_DONT_FRAGMENT = 0x001A, // No content, Length = 0
700 STUN_ATTR_RESERVATION_TOKEN = 0x0022, // ByteString, 8 bytes.
701 // TODO(mallinath) - Rename STUN_ATTR_TURN_LIFETIME to STUN_ATTR_LIFETIME and
702 // STUN_ATTR_TURN_DATA to STUN_ATTR_DATA. Also rename RelayMessage attributes
703 // by appending G to attribute name.
704};
705
706// RFC 5766-defined errors.
707enum TurnErrorType {
708 STUN_ERROR_FORBIDDEN = 403,
709 STUN_ERROR_ALLOCATION_MISMATCH = 437,
710 STUN_ERROR_WRONG_CREDENTIALS = 441,
711 STUN_ERROR_UNSUPPORTED_PROTOCOL = 442
712};
713
714extern const int SERVER_NOT_REACHABLE_ERROR;
715
716extern const char STUN_ERROR_REASON_FORBIDDEN[];
717extern const char STUN_ERROR_REASON_ALLOCATION_MISMATCH[];
718extern const char STUN_ERROR_REASON_WRONG_CREDENTIALS[];
719extern const char STUN_ERROR_REASON_UNSUPPORTED_PROTOCOL[];
720class TurnMessage : public StunMessage {
Tommi408143d2022-06-01 15:29:31 +0200721 public:
722 using StunMessage::StunMessage;
723
Patrik Höglund56d94522019-11-18 15:53:32 +0100724 protected:
725 StunAttributeValueType GetAttributeValueType(int type) const override;
726 StunMessage* CreateNew() const override;
727};
728
729enum IceAttributeType {
730 // RFC 5245 ICE STUN attributes.
731 STUN_ATTR_PRIORITY = 0x0024, // UInt32
732 STUN_ATTR_USE_CANDIDATE = 0x0025, // No content, Length = 0
733 STUN_ATTR_ICE_CONTROLLED = 0x8029, // UInt64
734 STUN_ATTR_ICE_CONTROLLING = 0x802A, // UInt64
735 // The following attributes are in the comprehension-optional range
736 // (0xC000-0xFFFF) and are not registered with IANA. These STUN attributes are
737 // intended for ICE and should NOT be used in generic use cases of STUN
738 // messages.
739 //
740 // Note that the value 0xC001 has already been assigned by IANA to
741 // ENF-FLOW-DESCRIPTION
742 // (https://www.iana.org/assignments/stun-parameters/stun-parameters.xml).
743 STUN_ATTR_NOMINATION = 0xC001, // UInt32
744 // UInt32. The higher 16 bits are the network ID. The lower 16 bits are the
745 // network cost.
Jonas Orelandfa543642020-09-16 10:44:54 +0200746 STUN_ATTR_GOOG_NETWORK_INFO = 0xC057,
Patrik Höglund56d94522019-11-18 15:53:32 +0100747 // Experimental: Transaction ID of the last connectivity check received.
Jonas Orelandfa543642020-09-16 10:44:54 +0200748 STUN_ATTR_GOOG_LAST_ICE_CHECK_RECEIVED = 0xC058,
Jonas Oreland1721de12019-11-20 12:10:39 +0100749 // Uint16List. Miscellaneous attributes for future extension.
750 STUN_ATTR_GOOG_MISC_INFO = 0xC059,
Jonas Orelandfa543642020-09-16 10:44:54 +0200751 // Obsolete.
752 STUN_ATTR_GOOG_OBSOLETE_1 = 0xC05A,
753 STUN_ATTR_GOOG_CONNECTION_ID = 0xC05B, // Not yet implemented.
754 STUN_ATTR_GOOG_DELTA = 0xC05C, // Not yet implemented.
755 STUN_ATTR_GOOG_DELTA_ACK = 0xC05D, // Not yet implemented.
Jonas Oreland63737a92019-11-21 15:12:14 +0100756 // MESSAGE-INTEGRITY truncated to 32-bit.
757 STUN_ATTR_GOOG_MESSAGE_INTEGRITY_32 = 0xC060,
Patrik Höglund56d94522019-11-18 15:53:32 +0100758};
759
Jonas Oreland1721de12019-11-20 12:10:39 +0100760// When adding new attributes to STUN_ATTR_GOOG_MISC_INFO
761// (which is a list of uint16_t), append the indices of these attributes below
Jonas Oreland9a52bd72019-12-11 11:35:48 +0100762// and do NOT change the existing indices. The indices of attributes must be
Jonas Oreland1721de12019-11-20 12:10:39 +0100763// consistent with those used in ConnectionRequest::Prepare when forming a STUN
764// message for the ICE connectivity check, and they are used when parsing a
765// received STUN message.
Jonas Oreland219d8ce2020-01-15 15:29:48 +0100766enum class IceGoogMiscInfoBindingRequestAttributeIndex {
767 SUPPORT_GOOG_PING_VERSION = 0,
768};
Jonas Oreland9a52bd72019-12-11 11:35:48 +0100769
770enum class IceGoogMiscInfoBindingResponseAttributeIndex {
771 SUPPORT_GOOG_PING_VERSION = 0,
772};
Jonas Oreland1721de12019-11-20 12:10:39 +0100773
Patrik Höglund56d94522019-11-18 15:53:32 +0100774// RFC 5245-defined errors.
775enum IceErrorCode {
776 STUN_ERROR_ROLE_CONFLICT = 487,
777};
778extern const char STUN_ERROR_REASON_ROLE_CONFLICT[];
779
780// A RFC 5245 ICE STUN message.
781class IceMessage : public StunMessage {
Tommi408143d2022-06-01 15:29:31 +0200782 public:
783 using StunMessage::StunMessage;
784
Patrik Höglund56d94522019-11-18 15:53:32 +0100785 protected:
786 StunAttributeValueType GetAttributeValueType(int type) const override;
787 StunMessage* CreateNew() const override;
788};
789
790} // namespace cricket
791
792#endif // API_TRANSPORT_STUN_H_