SSL-CONTEXT-OPTIONS(3) 1 SSL-CONTEXT-OPTIONS(3)
SSL context options - SSL context option listing
Context options for ssl:// and tls:// transports.
o $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.
o $verify_peer
boolean - Require verification of SSL certificate used. Defaults to TRUE.
o $verify_peer_name
boolean - Require verification of peer name. Defaults to TRUE.
o $allow_self_signed
boolean - Allow self-signed certificates. Requires $verify_peer. Defaults to FALSE
o $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.
o $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.
o $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.
o $passphrase
string - Passphrase with which your local_cert file was encoded.
o $CN_match
string - Common Name we are expecting. PHP will perform limited wildcard matching. If the Common Name does not match this, the
connection attempt will fail.
Note
This option is deprecated, in favour of $peer_name, as of PHP 5.6.0.
o $verify_depth
integer - Abort if the certificate chain is too deep. Defaults to no verification.
o $ciphers
string - Sets the list of available ciphers. The format of the string is described in ciphers(1). Defaults to DEFAULT.
o $capture_peer_cert
boolean - If set to TRUE a peer_certificate context option will be created containing the peer certificate.
o $capture_peer_cert_chain
boolean - If set to TRUE a peer_certificate_chain context option will be created containing the certificate chain.
o $SNI_enabled
boolean - If set to TRUE server name indication will be enabled. Enabling SNI allows multiple certificates on the same IP address.
o $SNI_server_name
string - If set, then this value will be used as server name for server name indication. If this value is not set, then the server
name is guessed based on the hostname used when opening the stream.
Note
This option is deprecated, in favour of $peer_name, as of PHP 5.6.0.
o $disable_compression
boolean - If set, disable TLS compression. This can help mitigate the CRIME attack vector.
o $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.
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 5.6.0 | |
| | |
| | Added $peer_fingerprint and $verify_peer_name. |
| | $verify_peer default changed to TRUE. |
| | |
|5.4.13 | |
| | |
| | Added $disable_compression. Requires OpenSSL >= |
| | 1.0.0. |
| | |
| 5.3.2 | |
| | |
| | Added $SNI_enabled and $SNI_server_name. |
| | |
| 5.0.0 | |
| | |
| | Added $capture_peer_cert, $capture_peer_chain |
| | and $ciphers. |
| | |
+--------+---------------------------------------------------+
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.
"Socket context options".
PHP Documentation Group SSL-CONTEXT-OPTIONS(3)