OpenDDS::STUN::Message Struct Reference

#include <Stun.h>

Collaboration diagram for OpenDDS::STUN::Message:

Public Types
typedef std::vector< Attribute >	AttributesType
typedef AttributesType::const_iterator	const_iterator

Public Member Functions
	Message ()
void	generate_transaction_id ()
void	clear_transaction_id ()
void	append_attribute (const Attribute &attribute)
const_iterator	begin () const
const_iterator	end () const
ACE_UINT16	length () const
ACE_UINT16	length_for_message_integrity () const
std::vector< AttributeType >	unknown_comprehension_required_attributes () const
bool	get_mapped_address (ACE_INET_Addr &address) const
bool	get_priority (ACE_UINT32 &priority) const
bool	get_username (std::string &username) const
bool	has_message_integrity () const
bool	verify_message_integrity (const std::string &password) const
void	compute_message_integrity (const std::string &password, unsigned char message_integrity[20]) const
bool	has_error_code () const
ACE_UINT16	get_error_code () const
std::string	get_error_reason () const
bool	has_unknown_attributes () const
std::vector< AttributeType >	get_unknown_attributes () const
bool	has_fingerprint () const
ACE_UINT32	compute_fingerprint () const
bool	has_ice_controlled () const
bool	has_ice_controlling () const
bool	has_use_candidate () const
bool	get_guid_prefix (DCPS::GuidPrefix_t &guid_pefix) const

Public Attributes
Class	class_
Method	method
TransactionId	transaction_id
ACE_Message_Block *	block
std::string	password

Private Attributes
AttributesType	attributes_
ACE_UINT16	length_
ACE_UINT16	length_for_message_integrity_

Detailed Description

Definition at line 180 of file Stun.h.

Member Typedef Documentation

AttributesType

typedef std::vector<Attribute> OpenDDS::STUN::Message::AttributesType

Definition at line 181 of file Stun.h.

const_iterator

typedef AttributesType::const_iterator OpenDDS::STUN::Message::const_iterator

Definition at line 182 of file Stun.h.

Constructor & Destructor Documentation

Message()

OpenDDS::STUN::Message::Message ( )

inline

Definition at line 188 of file Stun.h.

  : class_(REQUEST), method(BINDING), block(0), length_(0), length_for_message_integrity_(0) {}

Member Function Documentation

append_attribute()

void OpenDDS::STUN::Message::append_attribute ( const Attribute &  attribute )

inline

Definition at line 195 of file Stun.h.

References OpenDDS::STUN::Attribute::length(), OpenDDS::STUN::MESSAGE_INTEGRITY, and OpenDDS::STUN::Attribute::type.

Referenced by OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck(), OpenDDS::ICE::Checklist::execute(), OpenDDS::ICE::EndpointManager::make_bad_request_error_response(), OpenDDS::ICE::EndpointManager::make_unauthorized_error_response(), OpenDDS::ICE::EndpointManager::make_unknown_attributes_error_response(), OpenDDS::STUN::operator>>(), OpenDDS::ICE::EndpointManager::request(), and OpenDDS::ICE::EndpointManager::server_reflexive_task().

  {
    attributes_.push_back(attribute);
    length_ += (4 + attribute.length() + 3) & ~3;

    if (attribute.type == MESSAGE_INTEGRITY) {
      length_for_message_integrity_ = length_;
    }
  }

begin()

const_iterator OpenDDS::STUN::Message::begin ( void  ) const

inline

Definition at line 205 of file Stun.h.

Referenced by OpenDDS::STUN::operator<<().

  {
    return attributes_.begin();
  }

clear_transaction_id()

void OpenDDS::STUN::Message::clear_transaction_id

(

)

Definition at line 611 of file Stun.cpp.

References ACE_OS::memset().

Referenced by OpenDDS::ICE::EndpointManager::EndpointManager().

{
  ACE_OS::memset(transaction_id.data, 0, sizeof(transaction_id.data));
}

compute_fingerprint()

ACE_UINT32 OpenDDS::STUN::Message::compute_fingerprint

(

)

const

Definition at line 808 of file Stun.cpp.

References ACE_Message_Block::base(), ACE::crc32(), ACE_Message_Block::duplicate(), OpenDDS::STUN::encoding(), OpenDDS::STUN::HEADER_SIZE, ACE_Message_Block::length(), OpenDDS::STUN::Attribute::length(), ACE_Message_Block::rd_ptr(), ACE_Message_Block::release(), and ACE_Message_Block::wr_ptr().

Referenced by OpenDDS::STUN::operator<<(), and OpenDDS::STUN::operator>>().

{
  ACE_Message_Block* block = this->block->duplicate();
  block->rd_ptr(block->base());
  DCPS::Serializer serializer(block, encoding);

  // Resize for hashing.
  block->wr_ptr(block->base() + HEADER_SIZE + length() - 8);

  // Compute the CRC-32
  ACE_UINT32 crc = ACE::crc32(block->rd_ptr(), block->length());

  block->release();

  return crc ^ 0x5354554E;
}

compute_message_integrity()

void OpenDDS::STUN::Message::compute_message_integrity	(	const std::string &	password,
		unsigned char	message_integrity[20]
	)		const

Definition at line 719 of file Stun.cpp.

References ACE_Message_Block::base(), ACE_Message_Block::duplicate(), OpenDDS::STUN::encoding(), OpenDDS::STUN::HEADER_SIZE, ACE_Message_Block::length(), OpenDDS::STUN::Attribute::length(), ACE_Message_Block::rd_ptr(), ACE_Message_Block::release(), TheSecurityRegistry, and ACE_Message_Block::wr_ptr().

Referenced by OpenDDS::STUN::operator<<().

{
  ACE_Message_Block* block = this->block->duplicate();
  block->rd_ptr(block->base());
  DCPS::Serializer serializer(block, encoding);

  // Write the length and resize for hashing.
  block->wr_ptr(block->base() + 2);
  ACE_UINT16 message_length = length_for_message_integrity();
  serializer << message_length;
  block->wr_ptr(block->base() + HEADER_SIZE + length_for_message_integrity() - 24);

  // Compute the SHA1.
  TheSecurityRegistry->builtin_config()->get_utility()->hmac(message_integrity, block->rd_ptr(), block->length(), password);

  // Write the correct length.
  block->wr_ptr(block->base() + 2);
  message_length = length();
  serializer << message_length;

  block->release();
}

end()

const_iterator OpenDDS::STUN::Message::end ( void  ) const

inline

Definition at line 209 of file Stun.h.

Referenced by OpenDDS::STUN::operator<<().

  {
    return attributes_.end();
  }

generate_transaction_id()

void OpenDDS::STUN::Message::generate_transaction_id

(

)

Definition at line 606 of file Stun.cpp.

References TheSecurityRegistry.

Referenced by OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck(), OpenDDS::ICE::Checklist::execute(), and OpenDDS::ICE::EndpointManager::server_reflexive_task().

{
  TheSecurityRegistry->builtin_config()->get_utility()->generate_random_bytes(transaction_id.data, sizeof(transaction_id.data));
}

get_error_code()

ACE_UINT16 OpenDDS::STUN::Message::get_error_code

(

)

const

Definition at line 753 of file Stun.cpp.

References OpenDDS::STUN::ERROR_CODE.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::error_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::error_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::ERROR_CODE) {
      return pos->error.code;
    }
  }

  return 0;
}

get_error_reason()

std::string OpenDDS::STUN::Message::get_error_reason

(

)

const

Definition at line 764 of file Stun.cpp.

References OpenDDS::STUN::ERROR_CODE.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::error_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::error_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::ERROR_CODE) {
      return pos->error.reason;
    }
  }

  return std::string();
}

get_guid_prefix()

bool OpenDDS::STUN::Message::get_guid_prefix

(

DCPS::GuidPrefix_t &

guid_pefix

)

const

Definition at line 858 of file Stun.cpp.

References OpenDDS::STUN::GUID_PREFIX.

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::GUID_PREFIX) {
      std::memcpy(guid_prefix, pos->guid_prefix, sizeof(guid_prefix));
      return true;
    }
  }

  return false;
}

get_mapped_address()

bool OpenDDS::STUN::Message::get_mapped_address

(

ACE_INET_Addr &

address

)

const

Definition at line 643 of file Stun.cpp.

References OpenDDS::STUN::MAPPED_ADDRESS, and OpenDDS::STUN::XOR_MAPPED_ADDRESS.

Referenced by OpenDDS::ICE::Checklist::success_response(), OpenDDS::ICE::EndpointManager::success_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::success_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::XOR_MAPPED_ADDRESS) {
      address = pos->mapped_address;
      return true;
    }
  }

  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::MAPPED_ADDRESS) {
      address = pos->mapped_address;
      return true;
    }
  }

  return false;
}

get_priority()

bool OpenDDS::STUN::Message::get_priority

(

ACE_UINT32 &

priority

)

const

Definition at line 662 of file Stun.cpp.

References OpenDDS::STUN::PRIORITY.

Referenced by OpenDDS::ICE::EndpointManager::request().

{
  bool flag = false;

  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::PRIORITY) {
      flag = true;
      priority = pos->priority;
      // Use the last.
    }
  }

  return flag;
}

get_unknown_attributes()

std::vector< AttributeType > OpenDDS::STUN::Message::get_unknown_attributes

(

)

const

Definition at line 786 of file Stun.cpp.

References OpenDDS::STUN::UNKNOWN_ATTRIBUTES.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::error_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::error_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::UNKNOWN_ATTRIBUTES) {
      return pos->unknown_attributes;
    }
  }

  return std::vector<AttributeType>();
}

get_username()

bool OpenDDS::STUN::Message::get_username

(

std::string &

username

)

const

Definition at line 677 of file Stun.cpp.

References OpenDDS::STUN::USERNAME.

Referenced by OpenDDS::ICE::EndpointManager::indication(), and OpenDDS::ICE::EndpointManager::request().

{
  bool flag = false;

  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::USERNAME) {
      flag = true;
      username = pos->username;
      // Use the last.
    }
  }

  return flag;
}

has_error_code()

bool OpenDDS::STUN::Message::has_error_code

(

)

const

Definition at line 742 of file Stun.cpp.

References OpenDDS::STUN::ERROR_CODE.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::error_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::error_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::ERROR_CODE) {
      return true;
    }
  }

  return false;
}

has_fingerprint()

bool OpenDDS::STUN::Message::has_fingerprint

(

)

const

Definition at line 797 of file Stun.cpp.

References OpenDDS::STUN::FINGERPRINT.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::indication(), OpenDDS::ICE::EndpointManager::request(), and OpenDDS::ICE::Checklist::success_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::FINGERPRINT) {
      return true;
    }
  }

  return false;
}

has_ice_controlled()

bool OpenDDS::STUN::Message::has_ice_controlled

(

)

const

Definition at line 825 of file Stun.cpp.

References OpenDDS::STUN::ICE_CONTROLLED.

Referenced by OpenDDS::ICE::EndpointManager::request().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::ICE_CONTROLLED) {
      return true;
    }
  }

  return false;
}

has_ice_controlling()

bool OpenDDS::STUN::Message::has_ice_controlling

(

)

const

Definition at line 836 of file Stun.cpp.

References OpenDDS::STUN::ICE_CONTROLLING.

Referenced by OpenDDS::ICE::EndpointManager::request().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::ICE_CONTROLLING) {
      return true;
    }
  }

  return false;
}

has_message_integrity()

bool OpenDDS::STUN::Message::has_message_integrity

(

)

const

Definition at line 692 of file Stun.cpp.

References OpenDDS::STUN::MESSAGE_INTEGRITY.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::indication(), OpenDDS::ICE::EndpointManager::request(), and OpenDDS::ICE::Checklist::success_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::MESSAGE_INTEGRITY) {
      return true;
    }
  }

  return false;
}

has_unknown_attributes()

bool OpenDDS::STUN::Message::has_unknown_attributes

(

)

const

Definition at line 775 of file Stun.cpp.

References OpenDDS::STUN::UNKNOWN_ATTRIBUTES.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::error_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::error_response().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::UNKNOWN_ATTRIBUTES) {
      return true;
    }
  }

  return false;
}

has_use_candidate()

bool OpenDDS::STUN::Message::has_use_candidate

(

)

const

Definition at line 847 of file Stun.cpp.

References OpenDDS::STUN::USE_CANDIDATE.

Referenced by OpenDDS::ICE::EndpointManager::request().

{
  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::USE_CANDIDATE) {
      return true;
    }
  }

  return false;
}

length()

ACE_UINT16 OpenDDS::STUN::Message::length ( void  ) const

inline

Definition at line 213 of file Stun.h.

Referenced by OpenDDS::STUN::operator<<(), OpenDDS::STUN::operator>>(), and OpenDDS::DCPS::RtpsUdpTransport::IceEndpoint::send().

  {
    return length_;
  }

length_for_message_integrity()

ACE_UINT16 OpenDDS::STUN::Message::length_for_message_integrity ( ) const

inline

Definition at line 217 of file Stun.h.

  {
    return length_for_message_integrity_;
  }

unknown_comprehension_required_attributes()

std::vector< AttributeType > OpenDDS::STUN::Message::unknown_comprehension_required_attributes

(

)

const

Definition at line 616 of file Stun.cpp.

References OpenDDS::STUN::ERROR_CODE, OpenDDS::STUN::MAPPED_ADDRESS, OpenDDS::STUN::MESSAGE_INTEGRITY, OpenDDS::STUN::PRIORITY, OpenDDS::STUN::UNKNOWN_ATTRIBUTES, OpenDDS::STUN::USE_CANDIDATE, OpenDDS::STUN::USERNAME, and OpenDDS::STUN::XOR_MAPPED_ADDRESS.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::indication(), OpenDDS::ICE::EndpointManager::request(), OpenDDS::ICE::Checklist::success_response(), OpenDDS::ICE::EndpointManager::success_response(), and OpenDDS::ICE::ServerReflexiveStateMachine::success_response().

{
  std::vector<AttributeType> retval;

  for (AttributesType::const_iterator pos = attributes_.begin(), limit = attributes_.end(); pos != limit; ++pos) {
    const AttributesType::value_type& attribute = *pos;
    switch (attribute.type) {
    case MAPPED_ADDRESS:
    case USERNAME:
    case MESSAGE_INTEGRITY:
    case ERROR_CODE:
    case UNKNOWN_ATTRIBUTES:
    case XOR_MAPPED_ADDRESS:
    case PRIORITY:
    case USE_CANDIDATE:
      break;

    default:
      if (attribute.type < 0x8000) {
        retval.push_back(attribute.type);
      }
    }
  }

  return retval;
}

verify_message_integrity()

bool OpenDDS::STUN::Message::verify_message_integrity

(

const std::string &

password

)

const

Definition at line 703 of file Stun.cpp.

References memcmp(), and OpenDDS::STUN::MESSAGE_INTEGRITY.

Referenced by OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::indication(), OpenDDS::ICE::EndpointManager::request(), and OpenDDS::ICE::Checklist::success_response().

{
  bool verified = false;

  for (STUN::Message::const_iterator pos = begin(), limit = end(); pos != limit; ++pos) {
    if (pos->type == STUN::MESSAGE_INTEGRITY) {
      unsigned char computed_message_integrity[20];
      compute_message_integrity(password, computed_message_integrity);
      verified = memcmp(computed_message_integrity, pos->message_integrity, 20) == 0;
      // Use the last.
    }
  }

  return verified;
}

Member Data Documentation

attributes_

AttributesType OpenDDS::STUN::Message::attributes_

private

Definition at line 245 of file Stun.h.

block

ACE_Message_Block* OpenDDS::STUN::Message::block

Definition at line 241 of file Stun.h.

Referenced by OpenDDS::RTPS::Spdp::SpdpTransport::handle_input(), and OpenDDS::DCPS::RtpsUdpReceiveStrategy::receive_bytes_helper().

class_

Class OpenDDS::STUN::Message::class_

Definition at line 184 of file Stun.h.

Referenced by OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck(), OpenDDS::ICE::Checklist::execute(), OpenDDS::ICE::EndpointManager::make_bad_request_error_response(), OpenDDS::ICE::EndpointManager::make_unauthorized_error_response(), OpenDDS::ICE::EndpointManager::make_unknown_attributes_error_response(), OpenDDS::STUN::operator<<(), OpenDDS::STUN::operator>>(), OpenDDS::ICE::EndpointManager::receive(), OpenDDS::ICE::ServerReflexiveStateMachine::receive(), OpenDDS::ICE::EndpointManager::request(), and OpenDDS::ICE::EndpointManager::server_reflexive_task().

length_

ACE_UINT16 OpenDDS::STUN::Message::length_

private

Definition at line 246 of file Stun.h.

length_for_message_integrity_

ACE_UINT16 OpenDDS::STUN::Message::length_for_message_integrity_

private

Definition at line 247 of file Stun.h.

method

Method OpenDDS::STUN::Message::method

Definition at line 185 of file Stun.h.

Referenced by OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck(), OpenDDS::ICE::EndpointManager::error_response(), OpenDDS::ICE::ServerReflexiveStateMachine::error_response(), OpenDDS::ICE::Checklist::execute(), OpenDDS::ICE::EndpointManager::indication(), OpenDDS::ICE::EndpointManager::make_bad_request_error_response(), OpenDDS::ICE::EndpointManager::make_unauthorized_error_response(), OpenDDS::ICE::EndpointManager::make_unknown_attributes_error_response(), OpenDDS::STUN::operator<<(), OpenDDS::STUN::operator>>(), OpenDDS::ICE::EndpointManager::request(), OpenDDS::ICE::EndpointManager::server_reflexive_task(), and OpenDDS::ICE::EndpointManager::success_response().

password

std::string OpenDDS::STUN::Message::password

Definition at line 242 of file Stun.h.

Referenced by OpenDDS::ICE::ConnectivityCheck::ConnectivityCheck(), OpenDDS::ICE::Checklist::execute(), OpenDDS::ICE::EndpointManager::make_bad_request_error_response(), OpenDDS::ICE::EndpointManager::make_unauthorized_error_response(), OpenDDS::ICE::EndpointManager::make_unknown_attributes_error_response(), OpenDDS::STUN::operator<<(), and OpenDDS::ICE::EndpointManager::request().

transaction_id

TransactionId OpenDDS::STUN::Message::transaction_id

Definition at line 186 of file Stun.h.

Referenced by OpenDDS::ICE::Checklist::do_next_check(), OpenDDS::ICE::Checklist::error_response(), OpenDDS::ICE::EndpointManager::error_response(), OpenDDS::ICE::ServerReflexiveStateMachine::is_response(), OpenDDS::ICE::EndpointManager::make_bad_request_error_response(), OpenDDS::ICE::EndpointManager::make_unauthorized_error_response(), OpenDDS::ICE::EndpointManager::make_unknown_attributes_error_response(), OpenDDS::STUN::operator<<(), OpenDDS::ICE::operator==(), OpenDDS::STUN::operator>>(), OpenDDS::ICE::EndpointManager::request(), OpenDDS::ICE::Checklist::succeeded(), OpenDDS::ICE::Checklist::success_response(), and OpenDDS::ICE::EndpointManager::success_response().

---

The documentation for this struct was generated from the following files:

• Stun.h
• Stun.cpp