OpenDDS::Security::SecurityConfig Class Reference

#include <SecurityConfig.h>

Inheritance diagram for OpenDDS::Security::SecurityConfig:

Collaboration diagram for OpenDDS::Security::SecurityConfig:

Public Member Functions
OPENDDS_STRING	name () const
Authentication_var	get_authentication () const
AccessControl_var	get_access_control () const
CryptoKeyExchange_var	get_crypto_key_exchange () const
CryptoKeyFactory_var	get_crypto_key_factory () const
CryptoTransform_var	get_crypto_transform () const
DCPS::RcHandle< Utility >	get_utility () const
HandleRegistry_rch	get_handle_registry (const DCPS::GUID_t &participant_id)
void	erase_handle_registry (const DCPS::GUID_t &participant_id)
void	get_properties (DDS::PropertyQosPolicy &properties) const
bool	qos_implies_security (const DDS::DomainParticipantQos &qos) const
	SecurityConfig (const OPENDDS_STRING &name, Authentication_var authentication_plugin, AccessControl_var access_ctrl_plugin, CryptoKeyExchange_var key_exchange_plugin, CryptoKeyFactory_var key_factory_plugin, CryptoTransform_var transform_plugin, DCPS::RcHandle< Utility > utility_plugin, const ConfigPropertyList &properties)
Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()
virtual void	_add_ref ()
virtual void	_remove_ref ()
long	ref_count () const
WeakObject *	_get_weak_object () const

Private Member Functions
	~SecurityConfig ()
typedef	OPENDDS_MAP_CMP (DCPS::GUID_t, HandleRegistry_rch, DCPS::GUID_tKeyLessThan) HandleRegistryMap

Private Attributes
const OPENDDS_STRING	name_
Authentication_var	authentication_plugin_
AccessControl_var	access_control_plugin_
CryptoKeyExchange_var	key_exchange_plugin_
CryptoKeyFactory_var	key_factory_plugin_
CryptoTransform_var	transform_plugin_
DCPS::RcHandle< Utility >	utility_plugin_
HandleRegistryMap	handle_registry_map_
ACE_Thread_Mutex	mutex_
ConfigPropertyList	properties_

Friends
class	SecurityRegistry
template<typename T , typename U >
DCPS::RcHandle< T >	DCPS::make_rch (U const &)

Additional Inherited Members
Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Detailed Description

Definition at line 50 of file SecurityConfig.h.

Constructor & Destructor Documentation

SecurityConfig()

OpenDDS::Security::SecurityConfig::SecurityConfig	(	const OPENDDS_STRING &	name,
		Authentication_var	authentication_plugin,
		AccessControl_var	access_ctrl_plugin,
		CryptoKeyExchange_var	key_exchange_plugin,
		CryptoKeyFactory_var	key_factory_plugin,
		CryptoTransform_var	transform_plugin,
		DCPS::RcHandle< Utility >	utility_plugin,
		const ConfigPropertyList &	properties
	)

Definition at line 20 of file SecurityConfig.cpp.

  : name_(name)
#ifdef OPENDDS_SECURITY
  , authentication_plugin_(authentication_plugin)
  , access_control_plugin_(access_ctrl_plugin)
  , key_exchange_plugin_(key_exchange_plugin)
  , key_factory_plugin_(key_factory_plugin)
  , transform_plugin_(transform_plugin)
  , utility_plugin_(utility_plugin)
#endif
  , properties_(properties)
{}

~SecurityConfig()

OpenDDS::Security::SecurityConfig::~SecurityConfig ( )

private

Definition at line 42 of file SecurityConfig.cpp.

References ACE_DEBUG, ACE_TEXT(), handle_registry_map_, LM_DEBUG, and OpenDDS::DCPS::security_debug.

{
#ifdef OPENDDS_SECURITY
  if (DCPS::security_debug.bookkeeping) {
    ACE_DEBUG((LM_DEBUG, ACE_TEXT("(%P|%t) {bookkeeping} ")
               ACE_TEXT("SecurityConfig::~SecurityConfig handle_registry_map_ %B\n"),
               handle_registry_map_.size()));
  }
#endif
}

Member Function Documentation

erase_handle_registry()

void OpenDDS::Security::SecurityConfig::erase_handle_registry ( const DCPS::GUID_t &  participant_id )

inline

Definition at line 113 of file SecurityConfig.h.

References ACE_DEBUG, ACE_GUARD, ACE_TEXT(), LM_DEBUG, name, OPENDDS_STRING, and OpenDDS::DCPS::security_debug.

Referenced by OpenDDS::RTPS::Sedp::~Sedp().

  {
    ACE_GUARD(ACE_Thread_Mutex, g, mutex_);
    handle_registry_map_.erase(participant_id);

    if (DCPS::security_debug.bookkeeping) {
      ACE_DEBUG((LM_DEBUG, ACE_TEXT("(%P|%t) {bookkeeping} ")
                 ACE_TEXT("SecurityConfig::erase_handle_registry handle_registry_map_ (total %B)\n"),
                 handle_registry_map_.size()));
    }
  }

get_access_control()

AccessControl_var OpenDDS::Security::SecurityConfig::get_access_control ( ) const

inline

Definition at line 65 of file SecurityConfig.h.

Referenced by OpenDDS::RTPS::Sedp::init_security().

  {
    return access_control_plugin_;
  }

get_authentication()

Authentication_var OpenDDS::Security::SecurityConfig::get_authentication ( ) const

inline

Definition at line 60 of file SecurityConfig.h.

Referenced by OpenDDS::RTPS::Sedp::init_security().

  {
    return authentication_plugin_;
  }

get_crypto_key_exchange()

CryptoKeyExchange_var OpenDDS::Security::SecurityConfig::get_crypto_key_exchange ( ) const

inline

Definition at line 70 of file SecurityConfig.h.

Referenced by OpenDDS::RTPS::Sedp::create_datareader_crypto_tokens(), OpenDDS::RTPS::Sedp::create_datawriter_crypto_tokens(), OpenDDS::RTPS::Sedp::handle_datareader_crypto_tokens(), OpenDDS::RTPS::Sedp::handle_datawriter_crypto_tokens(), OpenDDS::RTPS::Sedp::init_security(), OpenDDS::RTPS::Sedp::local_has_remote_endpoint_token_i(), OpenDDS::RTPS::Sedp::local_has_remote_participant_token_i(), OpenDDS::RTPS::Sedp::remote_has_local_endpoint_token_i(), and OpenDDS::RTPS::Sedp::remote_has_local_participant_token_i().

  {
    return key_exchange_plugin_;
  }

get_crypto_key_factory()

CryptoKeyFactory_var OpenDDS::Security::SecurityConfig::get_crypto_key_factory ( ) const

inline

Definition at line 75 of file SecurityConfig.h.

Referenced by OpenDDS::RTPS::Sedp::disassociate(), OpenDDS::RTPS::Sedp::generate_remote_matched_reader_crypto_handle(), OpenDDS::RTPS::Sedp::generate_remote_matched_writer_crypto_handle(), OpenDDS::RTPS::Sedp::init_security(), and OpenDDS::RTPS::Sedp::remove_remote_crypto_handle().

  {
    return key_factory_plugin_;
  }

get_crypto_transform()

CryptoTransform_var OpenDDS::Security::SecurityConfig::get_crypto_transform ( ) const

inline

Definition at line 80 of file SecurityConfig.h.

  {
    return transform_plugin_;
  }

get_handle_registry()

HandleRegistry_rch OpenDDS::Security::SecurityConfig::get_handle_registry ( const DCPS::GUID_t &  participant_id )

inline

Definition at line 90 of file SecurityConfig.h.

References ACE_DEBUG, ACE_GUARD_RETURN, ACE_TEXT(), LM_DEBUG, and OpenDDS::DCPS::security_debug.

Referenced by OpenDDS::RTPS::Sedp::init_security().

  {
    HandleRegistry_rch handle_registry;

    ACE_GUARD_RETURN(ACE_Thread_Mutex, g, mutex_, handle_registry);

    HandleRegistryMap::const_iterator pos = handle_registry_map_.find(participant_id);
    if (pos != handle_registry_map_.end()) {
      handle_registry = pos->second;
    } else {
      handle_registry = DCPS::make_rch<HandleRegistry>();
      handle_registry_map_[participant_id] = handle_registry;

      if (DCPS::security_debug.bookkeeping) {
        ACE_DEBUG((LM_DEBUG, ACE_TEXT("(%P|%t) {bookkeeping} ")
                   ACE_TEXT("SecurityConfig::get_handle_registry handle_registry_map_ (total %B)\n"),
                   handle_registry_map_.size()));
      }
    }

    return handle_registry;
  }

get_properties()

void OpenDDS::Security::SecurityConfig::get_properties

(

DDS::PropertyQosPolicy &

properties

)

const

Definition at line 53 of file SecurityConfig.cpp.

References DDS::Property_t::name, properties_, DDS::Property_t::value, and DDS::PropertyQosPolicy::value.

{
  // The names on the internal attributes of the PropertyQosPolicy are
  // strange, but value is a properties sequence

  // Allocate space and copy over the properties
  // Presumably this will not be truncating the property count
  out_properties.value.length(static_cast<CORBA::ULong>(properties_.size()));
  CORBA::ULong index = 0;
  for (ConfigPropertyList::const_iterator iProp = properties_.begin();
       iProp != properties_.end();
       ++iProp) {
    DDS::Property_t& out_prop = out_properties.value[index++];
    out_prop.name = iProp->first.c_str();
    out_prop.value = iProp->second.c_str();
  }
}

get_utility()

DCPS::RcHandle<Utility> OpenDDS::Security::SecurityConfig::get_utility ( ) const

inline

Definition at line 85 of file SecurityConfig.h.

  {
    return utility_plugin_;
  }

name()

OPENDDS_STRING OpenDDS::Security::SecurityConfig::name ( void  ) const

inline

Definition at line 53 of file SecurityConfig.h.

Referenced by qos_implies_security().

  {
    return name_;
  }

OPENDDS_MAP_CMP()

typedef OpenDDS::Security::SecurityConfig::OPENDDS_MAP_CMP ( DCPS::GUID_t  , HandleRegistry_rch  , DCPS::GUID_tKeyLessThan    )

private

qos_implies_security()

bool OpenDDS::Security::SecurityConfig::qos_implies_security

(

const DDS::DomainParticipantQos &

qos

)

const

Definition at line 71 of file SecurityConfig.cpp.

References DDS::Security::Properties::AccessGovernance, DDS::Security::Properties::AccessPermissions, DDS::Security::Properties::AccessPermissionsCA, DDS::Security::Properties::AuthIdentityCA, DDS::Security::Properties::AuthIdentityCertificate, DDS::Security::Properties::AuthPrivateKey, name(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, DDS::DomainParticipantQos::property, and DDS::PropertyQosPolicy::value.

                                                                                  {
  const DDS::PropertySeq& properties = qos.property.value;
  for (unsigned int idx = 0; idx != properties.length(); ++idx) {
    const char* name = properties[idx].name.in();
    if (std::strcmp(DDS::Security::Properties::AuthIdentityCA, name) == 0 ||
        std::strcmp(DDS::Security::Properties::AuthIdentityCertificate, name) == 0 ||
        std::strcmp(DDS::Security::Properties::AuthPrivateKey, name) == 0 ||
        std::strcmp(DDS::Security::Properties::AccessPermissionsCA, name) == 0 ||
        std::strcmp(DDS::Security::Properties::AccessGovernance, name) == 0 ||
        std::strcmp(DDS::Security::Properties::AccessPermissions, name) == 0) {
      return true;
    }
  }
  return false;
}

Friends And Related Function Documentation

DCPS::make_rch

template<typename T , typename U >

DCPS::RcHandle<T> DCPS::make_rch ( U const &  )

friend

SecurityRegistry

friend class SecurityRegistry

friend

Definition at line 143 of file SecurityConfig.h.

Member Data Documentation

access_control_plugin_

AccessControl_var OpenDDS::Security::SecurityConfig::access_control_plugin_

private

Definition at line 154 of file SecurityConfig.h.

authentication_plugin_

Authentication_var OpenDDS::Security::SecurityConfig::authentication_plugin_

private

Definition at line 153 of file SecurityConfig.h.

handle_registry_map_

HandleRegistryMap OpenDDS::Security::SecurityConfig::handle_registry_map_

private

Definition at line 160 of file SecurityConfig.h.

Referenced by ~SecurityConfig().

key_exchange_plugin_

CryptoKeyExchange_var OpenDDS::Security::SecurityConfig::key_exchange_plugin_

private

Definition at line 155 of file SecurityConfig.h.

key_factory_plugin_

CryptoKeyFactory_var OpenDDS::Security::SecurityConfig::key_factory_plugin_

private

Definition at line 156 of file SecurityConfig.h.

mutex_

ACE_Thread_Mutex OpenDDS::Security::SecurityConfig::mutex_

mutableprivate

Definition at line 161 of file SecurityConfig.h.

name_

const OPENDDS_STRING OpenDDS::Security::SecurityConfig::name_

private

Definition at line 150 of file SecurityConfig.h.

properties_

ConfigPropertyList OpenDDS::Security::SecurityConfig::properties_

private

Definition at line 164 of file SecurityConfig.h.

Referenced by get_properties().

transform_plugin_

CryptoTransform_var OpenDDS::Security::SecurityConfig::transform_plugin_

private

Definition at line 157 of file SecurityConfig.h.

utility_plugin_

DCPS::RcHandle<Utility> OpenDDS::Security::SecurityConfig::utility_plugin_

private

Definition at line 158 of file SecurityConfig.h.

---

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

• SecurityConfig.h
• SecurityConfig.cpp