mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
919c8a7992
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329774 c90b9560-bf6c-de11-be94-00142212c4b1
418 lines
14 KiB
XML
418 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<phpdoc:classref xml:id="class.eventsslcontext" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<title>The EventSslContext class</title>
|
|
<titleabbrev>EventSslContext</titleabbrev>
|
|
<partintro>
|
|
<!-- {{{ EventSslContext intro -->
|
|
<section xml:id="eventsslcontext.intro">
|
|
&reftitle.intro;
|
|
<para>
|
|
Represents
|
|
<literal>SSL_CTX</literal>
|
|
structure. Provides methods and properties to configure the SSL context.
|
|
</para>
|
|
</section>
|
|
<!-- }}} -->
|
|
<section xml:id="eventsslcontext.synopsis">
|
|
&reftitle.classsynopsis;
|
|
|
|
<!-- {{{ Synopsis -->
|
|
<classsynopsis>
|
|
<ooclass>
|
|
<classname>EventSslContext</classname>
|
|
</ooclass>
|
|
<!-- {{{ Class synopsis -->
|
|
<classsynopsisinfo>
|
|
<ooclass>
|
|
<modifier>final</modifier>
|
|
<classname>EventSslContext</classname>
|
|
</ooclass>
|
|
</classsynopsisinfo>
|
|
<!-- }}} -->
|
|
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.sslv2-client-method">EventSslContext::SSLv2_CLIENT_METHOD</varname>
|
|
<initializer>1</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.sslv3-client-method">EventSslContext::SSLv3_CLIENT_METHOD</varname>
|
|
<initializer>2</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.sslv23-client-method">EventSslContext::SSLv23_CLIENT_METHOD</varname>
|
|
<initializer>3</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.tls-client-method">EventSslContext::TLS_CLIENT_METHOD</varname>
|
|
<initializer>4</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.sslv2-server-method">EventSslContext::SSLv2_SERVER_METHOD</varname>
|
|
<initializer>5</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.sslv3-server-method">EventSslContext::SSLv3_SERVER_METHOD</varname>
|
|
<initializer>6</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.sslv23-server-method">EventSslContext::SSLv23_SERVER_METHOD</varname>
|
|
<initializer>7</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.tls-server-method">EventSslContext::TLS_SERVER_METHOD</varname>
|
|
<initializer>8</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-local-cert">EventSslContext::OPT_LOCAL_CERT</varname>
|
|
<initializer>1</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-local-pk">EventSslContext::OPT_LOCAL_PK</varname>
|
|
<initializer>2</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-passphrase">EventSslContext::OPT_PASSPHRASE</varname>
|
|
<initializer>3</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-ca-file">EventSslContext::OPT_CA_FILE</varname>
|
|
<initializer>4</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-ca-path">EventSslContext::OPT_CA_PATH</varname>
|
|
<initializer>5</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-allow-self-signed">EventSslContext::OPT_ALLOW_SELF_SIGNED</varname>
|
|
<initializer>6</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-verify-peer">EventSslContext::OPT_VERIFY_PEER</varname>
|
|
<initializer>7</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-verify-depth">EventSslContext::OPT_VERIFY_DEPTH</varname>
|
|
<initializer>8</initializer>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>const</modifier>
|
|
<type>integer</type>
|
|
<varname linkend="eventsslcontext.constants.opt-ciphers">EventSslContext::OPT_CIPHERS</varname>
|
|
<initializer>9</initializer>
|
|
</fieldsynopsis>
|
|
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>string</type>
|
|
<varname linkend="eventsslcontext.props.local-cert">local_cert</varname>
|
|
</fieldsynopsis>
|
|
<fieldsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>string</type>
|
|
<varname linkend="eventsslcontext.props.local-pk">local_pk</varname>
|
|
</fieldsynopsis>
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.eventsslcontext')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
|
</classsynopsis>
|
|
<!-- }}} -->
|
|
</section>
|
|
<!-- {{{ EventSslContext properties -->
|
|
<section xml:id="eventsslcontext.props">
|
|
&reftitle.properties;
|
|
<variablelist>
|
|
<varlistentry xml:id="eventsslcontext.props.local-cert">
|
|
<term>
|
|
<varname>local_cert</varname>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Path to local certificate file on filesystem. It must be a PEM-encoded
|
|
file which contains certificate. It can optionally contain the
|
|
certificate chain of issuers.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.props.local-pk">
|
|
<term>
|
|
<varname>local_pk</varname>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Path to local private key file
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
<!-- {{{ EventSslContext constants -->
|
|
<section xml:id="eventsslcontext.constants">
|
|
&reftitle.constants;
|
|
<variablelist>
|
|
<varlistentry xml:id="eventsslcontext.constants.sslv2-client-method">
|
|
<term>
|
|
<constant>EventSslContext::SSLv2_CLIENT_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
SSLv2 client method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.sslv3-client-method">
|
|
<term>
|
|
<constant>EventSslContext::SSLv3_CLIENT_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
SSLv3 client method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.sslv23-client-method">
|
|
<term>
|
|
<constant>EventSslContext::SSLv23_CLIENT_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
SSLv23 client method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.tls-client-method">
|
|
<term>
|
|
<constant>EventSslContext::TLS_CLIENT_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
TLS client method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.sslv2-server-method">
|
|
<term>
|
|
<constant>EventSslContext::SSLv2_SERVER_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
SSLv2 server method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.sslv3-server-method">
|
|
<term>
|
|
<constant>EventSslContext::SSLv3_SERVER_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
SSLv3 server method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.sslv23-server-method">
|
|
<term>
|
|
<constant>EventSslContext::SSLv23_SERVER_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
SSLv23 server method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.tls-server-method">
|
|
<term>
|
|
<constant>EventSslContext::TLS_SERVER_METHOD</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
TLS server method. See
|
|
<literal>SSL_CTX_new(3)</literal>
|
|
man page.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-local-cert">
|
|
<term>
|
|
<constant>EventSslContext::OPT_LOCAL_CERT</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. The option points to path of local certificate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-local-pk">
|
|
<term>
|
|
<constant>EventSslContext::OPT_LOCAL_PK</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. The option points to path of the private key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-passphrase">
|
|
<term>
|
|
<constant>EventSslContext::OPT_PASSPHRASE</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents passphrase of the certificate.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-ca-file">
|
|
<term>
|
|
<constant>EventSslContext::OPT_CA_FILE</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents path of the certificate authority file.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-ca-path">
|
|
<term>
|
|
<constant>EventSslContext::OPT_CA_PATH</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents path where the certificate authority file should be
|
|
searched for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-allow-self-signed">
|
|
<term>
|
|
<constant>EventSslContext::OPT_ALLOW_SELF_SIGNED</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents option that allows self-signed certificates.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-verify-peer">
|
|
<term>
|
|
<constant>EventSslContext::OPT_VERIFY_PEER</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents option that tells Event to verify peer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-verify-depth">
|
|
<term>
|
|
<constant>EventSslContext::OPT_VERIFY_DEPTH</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents maximum depth for the certificate chain verification that
|
|
shall be allowed for the SSL context.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry xml:id="eventsslcontext.constants.opt-ciphers">
|
|
<term>
|
|
<constant>EventSslContext::OPT_CIPHERS</constant>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Key for an item of the options' array used in
|
|
<methodname>EventSslContext::__construct</methodname>
|
|
. Represents the cipher list for the SSL context.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<!-- }}} -->
|
|
</partintro>
|
|
|
|
&reference.event.entities.eventsslcontext;
|
|
|
|
</phpdoc:classref>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|