Class CryptoKeyExchange

Class Documentation

class CryptoKeyExchange

Public Functions

inline virtual ~CryptoKeyExchange()
virtual bool create_local_participant_crypto_tokens(ParticipantCryptoTokenSeq &local_participant_crypto_tokens, const ParticipantCryptoHandle &local_participant_crypto, ParticipantCryptoHandle &remote_participant_crypto, SecurityException &exception) = 0

Creates Crypto Tokens containing the info to decrypt text encoded by the local Participant. To be sent to the remote participant.

Parameters:

  • local_participant_crypto_tokens – (out) Returned CryptoTokenSeq.

  • local_participant_crypto – CryptoHandle returned by a previous call to register_local_participant.

  • remote_participant_crypto – CryptoHangle returned by a previous call to register_remote_participant.

  • exception – (out) Security exception

Returns:

TRUE is successful.

virtual bool set_remote_participant_crypto_tokens(const ParticipantCryptoHandle &local_participant_crypto, ParticipantCryptoHandle &remote_participant_crypto, const ParticipantCryptoTokenSeq &remote_participant_tokens, SecurityException &exception) = 0

Configures the Cryptographic Plugin with the material needed to interpret messages coming from the remote crypto.

Parameters:

  • local_participant_crypto – CryptoHandle returned by a previous call to register_local_participant.

  • remote_participant_crypto – CryptoHandle returned by a previous call to register_matched_remote_participant.

  • remote_participant_tokens – CryptoToken sequence received from the remote Participant

  • exception – (out) Security exception

Returns:

TRUE if successful

virtual bool create_local_datawriter_crypto_tokens(DatawriterCryptoTokenSeq &local_datawriter_crypto_tokens, DatawriterCryptoHandle &local_datawriter_crypto, DatareaderCryptoHandle &remote_datareader_crypto, SecurityException &exception) = 0

Creates CryptoTokens containing the info to decrypt text encoded by the local DataWriter.

Parameters:

  • local_datawriter_crypto_tokens – (out) Returned CryptoSeq

  • local_datawriter_crypto – CryptoHandle returned by a previous call to register_local_datawriter.

  • remote_datareader_crypto – CryptoHandle returned by a previous call to register_matched_remote_datareader

  • exception – (out) Security exception

Returns:

TRUE if successful

virtual bool create_local_datareader_crypto_tokens(DatareaderCryptoTokenSeq &local_datareader_crypto_tokens, DatareaderCryptoHandle &local_datareader_crypto, DatawriterCryptoHandle &remote_datawriter_crypto, SecurityException &exception) = 0

Creates CryptoTokens containing the info to decrypt text encoded by the local DataReader.

Parameters:

  • local_datareader_crypto_tokens – (out)

  • local_datareader_crypto –

  • remote_datawriter_crypto –

  • exception – (out) Security exception

Returns:

TRUE if successful

virtual bool set_remote_datareader_crypto_tokens(DatawriterCryptoHandle &local_datawriter_crypto, DatareaderCryptoHandle &remote_datareader_crypto, const DatareaderCryptoTokenSeq &remote_datareader_tokens, SecurityException &exception) = 0

Configures the Cryptographic Plugin with the material needed to interpret messages coming from the remote DataReader.

Parameters:

  • local_datawriter_crypto –

  • remote_datareader_crypto –

  • remote_datareader_tokens –

  • exception – (out) Security exception

Returns:

TRUE if successful

virtual bool set_remote_datawriter_crypto_tokens(DatareaderCryptoHandle &local_datareader_crypto, DatawriterCryptoHandle &remote_datawriter_crypto, const DatawriterCryptoTokenSeq &remote_datawriter_tokens, SecurityException &exception) = 0

Configures the Cryptographic Plugin with the material needed to interpret messages coming from the remote DataWriter.

Parameters:

  • local_datareader_crypto –

  • remote_datawriter_crypto –

  • remote_datawriter_tokens –

  • exception – (out) Security exception

Returns:

TRUE if successful

virtual bool return_crypto_tokens(const CryptoTokenSeq &crypto_tokens, SecurityException &exception) = 0

Release resources associated with a CryptoTokenSeq

Parameters:

  • crypto_tokens –

  • exception – (out) Security exception

Returns:

TRUE if successful