Home > PHP > Function > OpenSSL > openssl_csr_new()

openssl_csr_new()

openssl_csr_new - Generates a CSR

Syntax

mixed openssl_csr_new (array $dn, resource &$privkey, array $configargs, array $extraattribs)

Arguments

  • dn - The Distinguished Name to be used in the certificate.
  • privkey - privkey 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). The corresponding public portion of the key will be used to sign the CSR.
  • configargs - By default, the information in your system openssl.confis used to initialize the request; you can specify a configuration file section by setting the config_section_sectionkey of configargs. You can also specify an alternative openssl configuration file by setting the value of the configkey to the path of the file you want to use. The following keys, if present in configargs behave as their equivalents in the openssl.conf, as listed in the table below. Configuration overrides configargs key type openssl.confequivalent description digest_alg string default_md Selects which digest method to use x509_extensions string x509_extensions Selects which extensions should be used when creating an x509 certificate req_extensions string req_extensions Selects which extensions should be used when creating a CSR private_key_bits integer default_bits Specifies how many bits should be used to generate a private key private_key_type integer none Specifies the type of private key to create. This can be one of OPENSSL_KEYTYPE_DSA, OPENSSL_KEYTYPE_DH or OPENSSL_KEYTYPE_RSA. The default value is OPENSSL_KEYTYPE_RSA which is currently the only supported key type. encrypt_key boolean encrypt_key Should an exported key (with passphrase) be encrypted?
  • extraattribs - extraattribs is used to specify additional configuration options for the CSR. Both dn and extraattribs are associative arrays whose keys are converted to OIDs and applied to the relevant part of the request.

Description

openssl_csr_new() generates a new CSR (Certificate Signing Request) based on the information provided by dn, which represents the Distinguished Name to be used in the certificate.

Version

PHP 4.2.0, 5

Return value

Returns the CSR.