Class StunMessage

A STUN message: method, class, transaction ID and attributes, parsed from or encoded to the wire with optional MESSAGE-INTEGRITY and FINGERPRINT.

Inheritance
object
StunMessage
Inherited Members
Namespace: Uniform.Stun.Protocol
Assembly: Uniform.Stun.Protocol.dll
Syntax
public sealed class StunMessage

Constructors

| Edit this page View Source

StunMessage(StunMethod, StunClass, byte[]?)

Create a message, with a random transaction ID unless given.

Declaration
public StunMessage(StunMethod method, StunClass messageClass, byte[]? transactionId = null)
Parameters
Type Name Description
StunMethod method
StunClass messageClass
byte[] transactionId

Fields

| Edit this page View Source

MagicCookie

The magic cookie every STUN message carries.

Declaration
public const uint MagicCookie = 554869826
Field Value
Type Description
uint

Properties

| Edit this page View Source

Attributes

The attributes, in order, without MESSAGE-INTEGRITY and FINGERPRINT, which Encode(byte[]?, bool) adds.

Declaration
public List<StunAttribute> Attributes { get; }
Property Value
Type Description
List<StunAttribute>
| Edit this page View Source

Class

The class.

Declaration
public StunClass Class { get; }
Property Value
Type Description
StunClass
| Edit this page View Source

ErrorCode

The code of the ERROR-CODE attribute, e.g. 401, or null when there is none.

Declaration
public int? ErrorCode { get; }
Property Value
Type Description
int?
| Edit this page View Source

Method

The method.

Declaration
public StunMethod Method { get; }
Property Value
Type Description
StunMethod
| Edit this page View Source

TransactionId

The 12-byte transaction ID that pairs a response with its request.

Declaration
public byte[] TransactionId { get; }
Property Value
Type Description
byte[]

Methods

| Edit this page View Source

Add(ushort, byte[])

Add an attribute.

Declaration
public StunMessage Add(ushort type, byte[] value)
Parameters
Type Name Description
ushort type
byte[] value
Returns
Type Description
StunMessage
| Edit this page View Source

Add(ushort, string)

Add a UTF-8 text attribute.

Declaration
public StunMessage Add(ushort type, string value)
Parameters
Type Name Description
ushort type
string value
Returns
Type Description
StunMessage
| Edit this page View Source

Add(ushort, uint)

Add a 32-bit number attribute, e.g. a LIFETIME.

Declaration
public StunMessage Add(ushort type, uint value)
Parameters
Type Name Description
ushort type
uint value
Returns
Type Description
StunMessage
| Edit this page View Source

AddError(int, string?)

Add an ERROR-CODE with code and its reason phrase; see StunErrorCodes.

Declaration
public StunMessage AddError(int code, string? reason = null)
Parameters
Type Name Description
int code
string reason
Returns
Type Description
StunMessage
| Edit this page View Source

CheckFingerprint(ReadOnlySpan<byte>)

Return whether datagram ends with a correct FINGERPRINT.

Declaration
public static bool CheckFingerprint(ReadOnlySpan<byte> datagram)
Parameters
Type Name Description
ReadOnlySpan<byte> datagram
Returns
Type Description
bool
| Edit this page View Source

CheckIntegrity(ReadOnlySpan<byte>, byte[])

Return whether datagram, this message as received, has a MESSAGE-INTEGRITY made with key.

Declaration
public static bool CheckIntegrity(ReadOnlySpan<byte> datagram, byte[] key)
Parameters
Type Name Description
ReadOnlySpan<byte> datagram
byte[] key
Returns
Type Description
bool
| Edit this page View Source

Encode(byte[]?, bool)

Return the message on the wire, followed by a MESSAGE-INTEGRITY with integrityKey when given, and a FINGERPRINT when asked.

Declaration
public byte[] Encode(byte[]? integrityKey = null, bool fingerprint = false)
Parameters
Type Name Description
byte[] integrityKey

Key of the HMAC-SHA1: an ICE password's bytes, or a long-term key from LongTermKey(string, string, string).
bool fingerprint

Whether to end with a FINGERPRINT, as ICE requires.
Returns
Type Description
byte[]
| Edit this page View Source

Get(ushort)

Return the first value of an attribute type, or null.

Declaration
public byte[]? Get(ushort type)
Parameters
Type Name Description
ushort type
Returns
Type Description
byte[]
| Edit this page View Source

GetText(ushort)

Return the first value of an attribute type as UTF-8 text, or null.

Declaration
public string? GetText(ushort type)
Parameters
Type Name Description
ushort type
Returns
Type Description
string
| Edit this page View Source

GetUInt32(ushort)

Return the first value of an attribute type as a 32-bit number, or null when missing or of another length.

Declaration
public uint? GetUInt32(ushort type)
Parameters
Type Name Description
ushort type
Returns
Type Description
uint?
| Edit this page View Source

IsStun(ReadOnlySpan<byte>)

Return whether a datagram looks like STUN: the first byte, as RFC 7983 tells it from DTLS and RTP, and the magic cookie.

Declaration
public static bool IsStun(ReadOnlySpan<byte> datagram)
Parameters
Type Name Description
ReadOnlySpan<byte> datagram
Returns
Type Description
bool
| Edit this page View Source

LongTermKey(string, string, string)

Return the key of long-term credentials, as TURN servers use: MD5 of username:realm:password. The inputs must already be SASLprep'ed; plain ASCII is.

Declaration
public static byte[] LongTermKey(string username, string realm, string password)
Parameters
Type Name Description
string username
string realm
string password
Returns
Type Description
byte[]
| Edit this page View Source

Parse(ReadOnlySpan<byte>)

Parse a message; null when it is not STUN or is malformed. MESSAGE-INTEGRITY and FINGERPRINT stay among the attributes, to check with CheckIntegrity(ReadOnlySpan<byte>, byte[]) and CheckFingerprint(ReadOnlySpan<byte>).

Declaration
public static StunMessage? Parse(ReadOnlySpan<byte> datagram)
Parameters
Type Name Description
ReadOnlySpan<byte> datagram
Returns
Type Description
StunMessage