mysqli::ssl_set

mysqli_ssl_set

(PHP 5, PHP 7, PHP 8)

mysqli::ssl_set -- mysqli_ssl_set — Used for establishing secure connections using SSL

Description

Object-oriented style

public mysqli::ssl_set(
    ?string $key,
    ?string $certificate,
    ?string $ca_certificate,
    ?string $ca_path,
    ?string $cipher_algos
): bool

Procedural style

mysqli_ssl_set(
    mysqli $mysql,
    ?string $key,
    ?string $certificate,
    ?string $ca_certificate,
    ?string $ca_path,
    ?string $cipher_algos
): bool

Used for establishing secure connections using SSL. It must be called before mysqli_real_connect(). This function does nothing unless OpenSSL support is enabled.

Parameters

mysql

Procedural style only: A mysqli object returned by mysqli_connect() or mysqli_init()

key

The path name to the key file.

certificate

The path name to the certificate file.

ca_certificate

The path name to the certificate authority file.

ca_path

The pathname to a directory that contains trusted SSL CA certificates in PEM format.

cipher_algos

A list of allowable ciphers to use for SSL encryption.

Return Values

This function always returns true value. If SSL setup is incorrect mysqli_real_connect() will return an error when you attempt to connect.

See Also