Home > PHP > Function > OpenSSL > openssl_pkey_export()

openssl_pkey_export()

openssl_pkey_export - Gets an exportable representation of a key into a string

Syntax

bool openssl_pkey_export (mixed $key, string &$out, string $passphrase, array $configargs)

Arguments

  • key
  • out
  • passphrase - The key is optionally protected by passphrase.
  • configargs - configargs 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 configargs.

Description

openssl_pkey_export() exports key as a PEM encoded string and stores it into out (which is passed by reference).

Version

PHP 4.2.0, 5

Return value

Returns TRUE on success or FALSE on failure.