openssl_pkcs12_export

Function • Misc changes in PHP 8.2

Exports a PKCS#12 Compatible Certificate Store File to variable.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2
Changed
PHP 8.3
PHP 8.4
PHP 8.5
PHP 8.6

openssl_pkcs12_export Function synopsis

openssl_pkcs12_export(
    OpenSSLCertificate|string $certificate,
    &$output,
    $private_key,
    string $passphrase,
    array $options = []
  ): bool

Parameters

$certificate

TypeOpenSSLCertificate|string

$output

Passed by reference

On success, this will hold the PKCS#12.

$private_key

Private key component of PKCS#12 file. See Public/Private Key parameters for a list of valid values.

$passphrase

Typestring

Encryption password for unlocking the PKCS#12 file.

$options

OptionalTypearrayDefault value[]

Optional array, other keys will be ignored.

Note that the parameter $output is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typebool

Returns true on success, false on failure

Changes to the openssl_pkcs12_export Function

PHP 8.2

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $x509 to $certificate
  • Parameter type added for parameter #1 ($certificate): OpenSSLCertificate|string
  • Parameter name of parameter #2 changed: $out to $output
  • Parameter name of parameter #3 changed: $priv_key to $private_key
  • Parameter name of parameter #4 changed: $pass to $passphrase
  • Parameter type added for parameter #4 ($passphrase): string
  • Parameter name of parameter #5 changed: $args to $options
  • Parameter type added for parameter #5 ($options): array
  • Parameter default value added for position #5 ($options): []
  openssl_pkcs12_export(
-     $x509,
+     OpenSSLCertificate|string $certificate,
-     &$out,
+     &$output,
-     $priv_key,
+     $private_key,
-     $pass,
+     string $passphrase,
-     $args
+     array $options = []
-   )
+   ): bool

openssl_pkcs12_export Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes