php8.5
Home/ Manual/ openssl / functions/ openssl_pkey_export_to_file

openssl_pkey_export_to_file

PHP function Edit on GitHub ✎

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

Gets an exportable representation of a key into a file

Description

openssl_pkey_export_to_file(OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $key, string $output_filename, string|null $passphrase = null, array|null $options = null): bool

openssl_pkey_export_to_file() saves an ascii-armoured (PEM encoded) rendition of key into the file named by output_filename.

Cnf

Parameters

key
output_filename

Path to the output file.

passphrase

The key can be optionally protected by a passphrase.

options

options can be used to fine-tune the export process by specifying and/or overriding options for the openssl configuration file. See openssl_csr_new() for more information about options.

Return Values

Success

Changelog

VersionDescription
8.0.0key accepts an OpenSSLAsymmetricKey or OpenSSLCertificate instance now; previously, a Resource of type OpenSSL key or OpenSSL X.509 was accepted.

Source: reference/openssl/functions/openssl-pkey-export-to-file.xml · from the official PHP manual (php/doc-en)