array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'context.ssl.php', 1 => 'SSL context options', 2 => 'SSL context option listing', ), 'up' => array ( 0 => 'context.php', 1 => 'Context options and parameters', ), 'prev' => array ( 0 => 'context.ftp.php', 1 => 'FTP context options', ), 'next' => array ( 0 => 'context.phar.php', 1 => 'Phar context options', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'language/context/ssl.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

SSL context options

SSL context options — SSL context option listing

Description

Context options for ssl:// and tls:// transports.

Options

peer_name string

Peer name to be used. If this value is not set, then the name is guessed based on the hostname used when opening the stream.

verify_peer bool

Require verification of SSL certificate used.

Defaults to true.

verify_peer_name bool

Require verification of peer name.

Defaults to true.

allow_self_signed bool

Allow self-signed certificates. Requires verify_peer.

Defaults to false

cafile string

Location of Certificate Authority file on local filesystem which should be used with the verify_peer context option to authenticate the identity of the remote peer.

capath string

If cafile is not specified or if the certificate is not found there, the directory pointed to by capath is searched for a suitable certificate. capath must be a correctly hashed certificate directory.

local_cert string

Path to local certificate file on filesystem. It must be a PEM encoded file which contains your certificate and private key. It can optionally contain the certificate chain of issuers. The private key also may be contained in a separate file specified by local_pk.

local_pk string

Path to local private key file on filesystem in case of separate files for certificate (local_cert) and private key.

passphrase string

Passphrase with which your local_cert file was encoded.

verify_depth int

Abort if the certificate chain is too deep.

Defaults to no verification.

ciphers string

Sets the list of available ciphers. The format of the string is described in » ciphers(1).

Defaults to DEFAULT.

capture_peer_cert bool

If set to true a peer_certificate context option will be created containing the peer certificate.

capture_peer_cert_chain bool

If set to true a peer_certificate_chain context option will be created containing the certificate chain.

SNI_enabled bool

If set to true server name indication will be enabled. Enabling SNI allows multiple certificates on the same IP address.

disable_compression bool

If set, disable TLS compression. This can help mitigate the CRIME attack vector.

peer_fingerprint string | array

Aborts when the remote certificate digest doesn't match the specified hash.

When a string is used, the length will determine which hashing algorithm is applied, either "md5" (32) or "sha1" (40).

When an array is used, the keys indicate the hashing algorithm name and each corresponding value is the expected digest.

security_level int

Sets the security level. If not specified the library default security level is used. The security levels are described in » SSL_CTX_get_security_level(3).

Available as of PHP 7.2.0 and OpenSSL 1.1.0.

Changelog

Version Description
7.2.0 Added security_level. Requires OpenSSL >= 1.1.0.

Notes

Note: Because ssl:// is the underlying transport for the https:// and ftps:// wrappers, any context options which apply to ssl:// also apply to https:// and ftps://.

Note: For SNI (Server Name Indication) to be available, then PHP must be compiled with OpenSSL 0.9.8j or greater. Use the OPENSSL_TLSEXT_SERVER_NAME to determine whether SNI is supported.

See Also