FMIceLinkStunMessageIntegrityAttribute Class Reference

Inherits from	FMIceLinkStunAttribute : NSObject
Declared in	FMIceLinkStunMessageIntegrityAttribute.h FMIceLinkStunMessageIntegrityAttribute.m

Overview

The MESSAGE-INTEGRITY attribute contains an HMAC-SHA1 [RFC2104] of the STUN message. The MESSAGE-INTEGRITY attribute can be present in any STUN message type. Since it uses the SHA1 hash, the HMAC will be 20 bytes. The text used as input to HMAC is the STUN message, including the header, up to and including the attribute preceding the MESSAGE-INTEGRITY attribute. With the exception of the FINGERPRINT attribute, which appears after MESSAGE-INTEGRITY, agents MUST ignore all other attributes that follow MESSAGE-INTEGRITY.

`– description`

Returns a string that represents this instance.

@return A string that represents this instance.

- (NSString *)description

Discussion

Returns a string that represents this instance.

@return A string that represents this instance.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– getValueLength`

Gets the length of the attribute value.

@return

- (int)getValueLength

Discussion

Gets the length of the attribute value.

@return

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– initWithKeyBuffer:`

Initializes a new instance of the FMIceLinkStunMessageIntegrityAttribute class.

- (instancetype)initWithKeyBuffer:(NSMutableData *)keyBuffer

Parameters

`keyBuffer`	The key as a buffer.

Discussion

Initializes a new instance of the FMIceLinkStunMessageIntegrityAttribute class.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– isValidWithKeyBuffer:`

After creating a message-integrity attribute using the byte array representation, this method determines whether the supplied key is valid.

- (bool)isValidWithKeyBuffer:(NSMutableData *)keyBuffer

Parameters

`keyBuffer`	The key as a buffer.

Return Value

true if the key is valid; otherwise, false.

Discussion

After creating a message-integrity attribute using the byte array representation, this method determines whether the supplied key is valid.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– messageBuffer`

Gets the message buffer.

- (FMIceLinkDataBuffer *)messageBuffer

Discussion

Gets the message buffer.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`+ messageIntegrityAttributeWithKeyBuffer:`

Initializes a new instance of the FMIceLinkStunMessageIntegrityAttribute class.

+ (FMIceLinkStunMessageIntegrityAttribute *)messageIntegrityAttributeWithKeyBuffer:(NSMutableData *)keyBuffer

Parameters

`keyBuffer`	The key as a buffer.

Discussion

Initializes a new instance of the FMIceLinkStunMessageIntegrityAttribute class.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`+ readValueFromWithBuffer:offset:length:messageBuffer:`

Initializes a new instance of the FMIceLinkStunMessageIntegrityAttribute class.

+ (FMIceLinkStunMessageIntegrityAttribute *)readValueFromWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset length:(int)length messageBuffer:(FMIceLinkDataBuffer *)messageBuffer

Parameters

`buffer`	The buffer.
`offset`	The offset.
`length`	The length.
`messageBuffer`	The message buffer thus far. @return

Discussion

Initializes a new instance of the FMIceLinkStunMessageIntegrityAttribute class.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– setMessageBuffer:`

Sets the message buffer.

- (void)setMessageBuffer:(FMIceLinkDataBuffer *)value

Discussion

Sets the message buffer.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– typeValue`

Gets the type value.

- (int)typeValue

Discussion

Gets the type value.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h

`– writeValueToWithBuffer:offset:`

Writes the attribute value to a data buffer.

- (void)writeValueToWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset

Parameters

`buffer`	The buffer.
`offset`	The offset.

Discussion

Writes the attribute value to a data buffer.

Declared In

FMIceLinkStunMessageIntegrityAttribute.h