openssl_csr_new

Generates a CSR.

openssl_csr_new Function synopsis

openssl_csr_new(
    array $distinguished_names,
    &$private_key,
    ?array $options = null,
    ?array $extra_attributes = null
  ): OpenSSLCertificateSigningRequest|bool

Parameters

$distinguished_names

Typearray

The Distinguished Name or subject fields to be included in the certificate. The $distinguished_names is an associative array where the keys represent the attribute names of Distinguished Names and the values can either be strings (for single value) or arrays (if multiple values need to be set).

$private_key

Passed by reference

$private_key should be set to a private key that was previously generated by openssl_pkey_new (or otherwise obtained from the other openssl_pkey family of functions), or null variable. If its value is null variable, a new private key is generated based on the supplied $options and assigned to supplied variable. The corresponding public portion of the key will be used to sign the CSR.

$options

OptionalType?arrayDefault valuenull

By default, the information in your system openssl.conf is used to initialize the request; you can specify a configuration file section by setting the config_section_section key in $options. You can also specify an alternative OpenSSL configuration file by setting the value of the config key to the path of the file you want to use. The following keys, if present in $options behave as their equivalents in the openssl.conf, as listed in the table below.

$extra_attributes

OptionalType?arrayDefault valuenull

$extra_attributes is used to specify additional attributes for the CSR. It is an associative arrays where the keys are converted to OIDs and applied as CSR attributes.

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

Return value

TypeOpenSSLCertificateSigningRequest|bool

Returns the CSR on success, true if CSR creation is successful but signing fails or false on failure.