PHP Manual: openssl_public

Description

function openssl_public_encrypt(
    #[\SensitiveParameter] string $data,
    string &$encrypted_data,
    OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key,
    int $padding = OPENSSL_PKCS1_PADDING,
    ?string $digest_algo = null
): bool

openssl_public_encrypt() encrypts data with public public_key and stores the result into encrypted_data. Encrypted data can be decrypted via openssl_private_decrypt().

This function can be used e.g. to encrypt message which can be then read only by owner of the private key. It can be also used to store secure data in database.

Parameters

data
encrypted_data: This will hold the result of the encryption.
public_key: public_key must be the public key that corresponds to the private key that will be used to decrypt the data.
padding: padding can be one of OPENSSL_PKCS1_PADDING, OPENSSL_SSLV23_PADDING, OPENSSL_PKCS1_OAEP_PADDING, OPENSSL_NO_PADDING.
digest_algo: The digest algorithm for OAEP padding, or null to use the default algorithm.

Return Values

Returns true on success or false on failure.

Changelog

Version	Description
8.5.0	The optional parameter `digest_algo` has been added.
8.0.0	`public_key` accepts an OpenSSLAsymmetricKey or OpenSSLCertificate instance now; previously, a resource of type `OpenSSL key` or `OpenSSL X.509` was accepted.

openssl_public_encrypt

Description

Parameters

Return Values

Changelog

See Also