TROEncryption

Overview

This class provides settings for encrypting and decrypting communication at the channel level. It's available via the Encryption property on all channels and servers.

Location

 

constructor Create    (declared in TROCustomEncryption)

Creates a new instance.

constructor Create

AssignTo  protected override    (declared in TROCustomEncryption)

Copies the properties of an object to a destination object.

procedure AssignTo(Dest: TPersistent)

Parameters:

  • Dest: destination object.

Decrypt  virtual    (declared in TROCustomEncryption)

procedure Decrypt(iCiphertext: TStream; iPlaintext: TStream)

Parameters:

  • iCiphertext:
  • iPlaintext:

Enclose  protected    (declared in TROCustomEncryption)

procedure Enclose(const iSourceStream: TStream; const iDestStream: TStream; iEncMethod: TROEncryptionMethod; isCompressed: Boolean; iKey: Ansistring)

Parameters:

  • iSourceStream:
  • iDestStream:
  • iEncMethod:
  • isCompressed:
  • iKey:

Encrypt  virtual    (declared in TROCustomEncryption)

Encrypts given stream

procedure Encrypt(iPlaintext: TStream; iCiphertext: TStream)

Parameters:

  • iPlaintext: Source
  • iCiphertext: Destination

EncryptionMethod    (declared in TROCustomEncryption)

Specifies the encryption method to be used (default is tetNone, no encryption).

property EncryptionMethod: TROEncryptionMethod read write

EncryptionRecvKey    (declared in TROCustomEncryption)

Specifies the key to be used for decrypting incoming messages.

property EncryptionRecvKey: TROCryptoKey read write

EncryptionSendKey    (declared in TROCustomEncryption)

Specifies the key to be used for encrypting outgoing messages.

property EncryptionSendKey: TROCryptoKey read write

Extract  protected    (declared in TROCustomEncryption)

function Extract(const iSourceStream: TStream; const iDestStream: TStream; iKey: Ansistring): Int64

Parameters:

  • iSourceStream:
  • iDestStream:
  • iKey:

isStreamEncrypted    (declared in TROCustomEncryption)

Checks state of stream

class function isStreamEncrypted(aStream: TStream): Boolean

Parameters:

  • aStream: Stream

OnAfterDecryption    (declared in TROCustomEncryption)

Fires after the decryption task has finished, giving you access to both the original (encrypted) and processed (decrypted) stream.

property OnAfterDecryption: TROEncryptionEvent read write
delegate: procedure OnAfterDecryption(Sender: TObject; OriginalStream: TStream; var ProcessedStream: TStream)

OnAfterDecryption

Fires after the decryption task has finished, giving you access to both the original (encrypted) and processed (decrypted) stream.

property OnAfterDecryption:

OnBeforeEncryption    (declared in TROCustomEncryption)

Fires before the encryption task starts.

property OnBeforeEncryption: TROEncryptionEvent read write
delegate: procedure OnBeforeEncryption(Sender: TObject; OriginalStream: TStream; var ProcessedStream: TStream)

OnBeforeEncryption

Fires before the encryption task starts.

property OnBeforeEncryption:

TriggerBeforeEncryptionEvent  protected virtual    (declared in TROCustomEncryption)

procedure TriggerBeforeEncryptionEvent(iOriginalStream: TStream; var iProcessedStream: TStream)

Parameters:

  • iOriginalStream:
  • iProcessedStream:

UseCompression    (declared in TROCustomEncryption)

Toggles whether outgoing messages will be automatically compressed if they exceed a specific size. Compression will only apply if the EncryptionMethod is set to a value other then tetNone.

property UseCompression: Boolean read write

 

EncryptionMethod    (declared in TROCustomEncryption)

Specifies the encryption method to be used (default is tetNone, no encryption).

property EncryptionMethod: TROEncryptionMethod read write

EncryptionRecvKey    (declared in TROCustomEncryption)

Specifies the key to be used for decrypting incoming messages.

property EncryptionRecvKey: TROCryptoKey read write

EncryptionSendKey    (declared in TROCustomEncryption)

Specifies the key to be used for encrypting outgoing messages.

property EncryptionSendKey: TROCryptoKey read write

OnAfterDecryption

Fires after the decryption task has finished, giving you access to both the original (encrypted) and processed (decrypted) stream.

property OnAfterDecryption:

OnBeforeEncryption

Fires before the encryption task starts.

property OnBeforeEncryption:

UseCompression    (declared in TROCustomEncryption)

Toggles whether outgoing messages will be automatically compressed if they exceed a specific size. Compression will only apply if the EncryptionMethod is set to a value other then tetNone.

property UseCompression: Boolean read write

 

isStreamEncrypted    (declared in TROCustomEncryption)

Checks state of stream

class function isStreamEncrypted(aStream: TStream): Boolean

Parameters:

  • aStream: Stream

 

constructor Create    (declared in TROCustomEncryption)

Creates a new instance.

constructor Create

AssignTo  protected override    (declared in TROCustomEncryption)

Copies the properties of an object to a destination object.

procedure AssignTo(Dest: TPersistent)

Parameters:

  • Dest: destination object.

Decrypt  virtual    (declared in TROCustomEncryption)

procedure Decrypt(iCiphertext: TStream; iPlaintext: TStream)

Parameters:

  • iCiphertext:
  • iPlaintext:

Enclose  protected    (declared in TROCustomEncryption)

procedure Enclose(const iSourceStream: TStream; const iDestStream: TStream; iEncMethod: TROEncryptionMethod; isCompressed: Boolean; iKey: Ansistring)

Parameters:

  • iSourceStream:
  • iDestStream:
  • iEncMethod:
  • isCompressed:
  • iKey:

Encrypt  virtual    (declared in TROCustomEncryption)

Encrypts given stream

procedure Encrypt(iPlaintext: TStream; iCiphertext: TStream)

Parameters:

  • iPlaintext: Source
  • iCiphertext: Destination

Extract  protected    (declared in TROCustomEncryption)

function Extract(const iSourceStream: TStream; const iDestStream: TStream; iKey: Ansistring): Int64

Parameters:

  • iSourceStream:
  • iDestStream:
  • iKey:

TriggerBeforeEncryptionEvent  protected virtual    (declared in TROCustomEncryption)

procedure TriggerBeforeEncryptionEvent(iOriginalStream: TStream; var iProcessedStream: TStream)

Parameters:

  • iOriginalStream:
  • iProcessedStream:

 

OnAfterDecryption    (declared in TROCustomEncryption)

Fires after the decryption task has finished, giving you access to both the original (encrypted) and processed (decrypted) stream.

property OnAfterDecryption: TROEncryptionEvent read write
delegate: procedure OnAfterDecryption(Sender: TObject; OriginalStream: TStream; var ProcessedStream: TStream)

OnBeforeEncryption    (declared in TROCustomEncryption)

Fires before the encryption task starts.

property OnBeforeEncryption: TROEncryptionEvent read write
delegate: procedure OnBeforeEncryption(Sender: TObject; OriginalStream: TStream; var ProcessedStream: TStream)

See Also