panda3d.core.OEncryptStream

class OEncryptStream

Bases: ostream

An input stream object that uses OpenSSL to encrypt data to another destination stream on-the-fly.

Attach an OEncryptStream to an existing ostream that will accept encrypted data, and write your unencrypted source data to the OEncryptStream.

Seeking is not supported.

Inheritance diagram

Inheritance diagram of OEncryptStream

__init__() → None
__init__(dest: ostream, owns_dest: bool, password: str) → None
property algorithm
Getter

Returns the encryption algorithm that was read from the stream.

Setter

Specifies the encryption algorithm that should be used for future calls to open(). The default is whatever is specified by the encryption-algorithm config variable. The complete set of available algorithms is defined by the current version of OpenSSL.

If an invalid algorithm is specified, there is no immediate error return code, but open() will fail.

Return type

string

close() → OEncryptStream

Resets the EncryptStream to empty, but does not actually close the dest ostream unless owns_dest was true.

Return type

OEncryptStream

property iteration_count
Getter

Returns the value that was was read from the stream.

Setter

Specifies the number of times to repeatedly hash the key before writing it to the stream in future calls to open(). Its purpose is to make it computationally more expensive for an attacker to search the key space exhaustively. This should be a multiple of 1,000 and should not exceed about 65 million; the value 0 indicates just one application of the hashing algorithm.

The default is whatever is specified by the encryption-iteration-count config variable.

Return type

int

property key_length
Getter

Returns the encryption key length, in bits, that was read from the stream.

Setter

Specifies the length of the key, in bits, that should be used to encrypt the stream in future calls to open(). The default is whatever is specified by the encryption-key-length config variable.

If an invalid key_length for the chosen algorithm is specified, there is no immediate error return code, but open() will fail.

Return type

int

open(dest: ostream, owns_dest: bool, password: str) → OEncryptStream
Return type

OEncryptStream

setAlgorithm(algorithm: str) → None

Specifies the encryption algorithm that should be used for future calls to open(). The default is whatever is specified by the encryption-algorithm config variable. The complete set of available algorithms is defined by the current version of OpenSSL.

If an invalid algorithm is specified, there is no immediate error return code, but open() will fail.

setIterationCount(iteration_count: int) → None

Specifies the number of times to repeatedly hash the key before writing it to the stream in future calls to open(). Its purpose is to make it computationally more expensive for an attacker to search the key space exhaustively. This should be a multiple of 1,000 and should not exceed about 65 million; the value 0 indicates just one application of the hashing algorithm.

The default is whatever is specified by the encryption-iteration-count config variable.

setKeyLength(key_length: int) → None

Specifies the length of the key, in bits, that should be used to encrypt the stream in future calls to open(). The default is whatever is specified by the encryption-key-length config variable.

If an invalid key_length for the chosen algorithm is specified, there is no immediate error return code, but open() will fail.