Home > PHP > Function > OpenSSL > openssl_pkey_get_private()

openssl_pkey_get_private()

openssl_pkey_get_private - Get a private key

Syntax

resource openssl_pkey_get_private (mixed $key, string $passphrase)

Arguments

  • key - key can be one of the following: a string having the format file://path/to/file.pem. The named file must contain a PEM encoded certificate/private key (it may contain both). A PEM formatted private key.
  • passphrase - The optional parameter passphrase must be used if the specified key is encrypted (protected by a passphrase).

Description

openssl_get_privatekey() parses key and prepares it for use by other functions.

Version

PHP 4.2.0, 5

Return value

Returns a positive key resource identifier on success, or FALSE on error.