EncryptionPassword Property

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

ipworkss3_s3client_get($res, 12 );
ipworkss3_s3client_set($res, 12, $value );

Default Value



If this property is populated when CreateObject or GetObject is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type


Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S3 2020 PHP Edition - Version 20.0 [Build 8164]