openssl_pkey_get_details - PHP code example

The PHP Function OpenSSL_Pkey_Get_Details

PHP has many built-in functions that can be used to perform specific tasks. Functions are blocks of statements that can be called and executed from within a script. These are a very powerful feature of the language that can be used to write efficient code that will perform a task in the way that you want it to.

One such function is the openssl_pkey_get_details function which can be used to return details about a private key. It will provide information like the key length in bits, the key type and the curve name. This can be useful for developers who use public-key encryption for their web applications.

The function can be used with other OpenSSL functions to get all the necessary details about a new private/public key pair. The main configuration argument args is used to set the various options for the function to create the key pair. It can be set to different values such as digest_alg, x509_extensions, req_extensions, pkey_size, private_key_bits, encrypt_type, encrypt_key_cipher and the curve_name.

The function also provides other configuration parameters for the generation process, including the signature algorithm and a file for the private key to be generated into. The output of the function will be a resource identifier, which can be passed on to other functions for further processing. This includes the openssl_pkey_sign() function to help in creating a cryptographic digital signature, and the openssl_csr_new() function to generate a CSR certificate. The return value of the function is an object of type OpenSSLAsymmetricKey if it succeeds, or false if it fails.

openssl_pkey_get_details example

    /** * @return array */
    public static function castOpensslX509($h, array $a, Stub $stub, bool $isNested)
    {
        $stub->cut = -1;
        $info = openssl_x509_parse($h, false);

        $pin = openssl_pkey_get_public($h);
        $pin = openssl_pkey_get_details($pin)['key'];
        $pin = \array_slice(explode("\n", $pin), 1, -2);
        $pin = base64_decode(implode('', $pin));
        $pin = base64_encode(hash('sha256', $pin, true));

        $a += [
            'subject' => new EnumStub(array_intersect_key($info['subject'], ['organizationName' => true, 'commonName' => true])),
            'issuer' => new EnumStub(array_intersect_key($info['issuer'], ['organizationName' => true, 'commonName' => true])),
            'expiry' => new ConstStub(date(\DateTimeInterface::ISO8601, $info['validTo_time_t']), $info['validTo_time_t']),
            'fingerprint' => new EnumStub([
                'md5' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'md5')), 2, ':', true)),
                'sha1' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'sha1')), 2, ':', true)),

$this->info['primary_port'] = $stream->getRemoteAddress()->getPort();
        $this->info['pretransfer_time'] = microtime(true) - $this->info['start_time'];
        $this->info['debug'] .= sprintf("* Connected to %s (%s) port %d\n", $request->getUri()->getHost(), $host, $this->info['primary_port']);

        if ((isset($this->info['peer_certificate_chain']) || $this->pinSha256) && null !== $tlsInfo = $stream->getTlsInfo()) {
            foreach ($tlsInfo->getPeerCertificates() as $cert) {
                $this->info['peer_certificate_chain'][] = openssl_x509_read($cert->toPem());
            }

            if ($this->pinSha256) {
                $pin = openssl_pkey_get_public($this->info['peer_certificate_chain'][0]);
                $pin = openssl_pkey_get_details($pin)['key'];
                $pin = \array_slice(explode("\n", $pin), 1, -2);
                $pin = base64_decode(implode('', $pin));
                $pin = base64_encode(hash('sha256', $pin, true));

                if (!\in_array($pin, $this->pinSha256, true)) {
                    throw new TransportException(sprintf('SSL public key does not match pinned public key for "%s".', $this->info['url']));
                }
            }
        }
        ($this->onProgress)();

'encrypt_key_cipher' => \OPENSSL_CIPHER_AES_256_CBC,
        ]);

        if ($key === false) {
            throw new JwtCertificateGenerationException('Failed to generate key');
        }

        if (!openssl_pkey_export($key, $privateKey, $passphrase)) {
            throw new JwtCertificateGenerationException('Failed to export private key');
        }

        $keyData = openssl_pkey_get_details($key);
        if ($keyData === false) {
            throw new JwtCertificateGenerationException('Failed to export public key');
        }

        return [$privateKey, $keyData['key']];
    }

    public function generate(string $privateKeyPath, string $publicKeyPath, ?string $passphrase = null): void
    {
        [$private, $public] = $this->generateString($passphrase);