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)

Decrypts source stream

procedure Decrypt(Source: TStream; Dest: TStream)

Parameters:

  • Source: Source
  • Dest: Destination

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(Source: TStream; Dest: TStream)

Parameters:

  • Source: Source
  • Dest: Destination

EncryptionMethod    (declared in TROCustomEncryption)

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

property EncryptionMethod: TROEncryptionMethod read write default tetNone

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)

Encrypts given stream

class function isStreamEncrypted(Source: TStream): Boolean

Parameters:

  • Source: Stream

OnAfterDecryption

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

property OnAfterDecryption: TROEncryptionEvent read write

OnBeforeEncryption

Fires before the encryption task starts.

property OnBeforeEncryption: TROEncryptionEvent read write

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 default False

 

EncryptionMethod    (declared in TROCustomEncryption)

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

property EncryptionMethod: TROEncryptionMethod read write default tetNone

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: TROEncryptionEvent read write

OnBeforeEncryption

Fires before the encryption task starts.

property OnBeforeEncryption: TROEncryptionEvent read write

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 default False

 

isStreamEncrypted    (declared in TROCustomEncryption)

Encrypts given stream

class function isStreamEncrypted(Source: TStream): Boolean

Parameters:

  • Source: 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)

Decrypts source stream

procedure Decrypt(Source: TStream; Dest: TStream)

Parameters:

  • Source: Source
  • Dest: Destination

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(Source: TStream; Dest: TStream)

Parameters:

  • Source: Source
  • Dest: Destination

Extract  protected    (declared in TROCustomEncryption)

function Extract(const iSourceStream: TStream; const iDestStream: TStream; iKey: AnsiString = ''): Int64

Parameters:

  • iSourceStream:
  • iDestStream:
  • iKey: