The EventSslContext class

(PECL event >= 1.2.6-beta)

Introduction

Represents SSL_CTX structure. Provides methods and properties to configure the SSL context.

Class synopsis

final class EventSslContext {

/* Constants */

const int SSLv2_CLIENT_METHOD = 1;

const int SSLv3_CLIENT_METHOD = 2;

const int SSLv23_CLIENT_METHOD = 3;

const int TLS_CLIENT_METHOD = 4;

const int SSLv2_SERVER_METHOD = 5;

const int SSLv3_SERVER_METHOD = 6;

const int SSLv23_SERVER_METHOD = 7;

const int TLS_SERVER_METHOD = 8;

const int OPT_LOCAL_CERT = 1;

const int OPT_LOCAL_PK = 2;

const int OPT_PASSPHRASE = 3;

const int OPT_CA_FILE = 4;

const int OPT_CA_PATH = 5;

const int OPT_ALLOW_SELF_SIGNED = 6;

const int OPT_VERIFY_PEER = 7;

const int OPT_VERIFY_DEPTH = 8;

const int OPT_CIPHERS = 9;

/* Properties */

public string $local_cert;

public string $local_pk;

/* Methods */

public __construct( string $method , string $options )

}

Properties

local_cert: 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.
local_pk: Path to local private key file

Predefined Constants

EventSslContext::SSLv2_CLIENT_METHOD: SSLv2 client method. See SSL_CTX_new(3) man page.
EventSslContext::SSLv3_CLIENT_METHOD: SSLv3 client method. See SSL_CTX_new(3) man page.
EventSslContext::SSLv23_CLIENT_METHOD: SSLv23 client method. See SSL_CTX_new(3) man page.
EventSslContext::TLS_CLIENT_METHOD: TLS client method. See SSL_CTX_new(3) man page.
EventSslContext::SSLv2_SERVER_METHOD: SSLv2 server method. See SSL_CTX_new(3) man page.
EventSslContext::SSLv3_SERVER_METHOD: SSLv3 server method. See SSL_CTX_new(3) man page.
EventSslContext::SSLv23_SERVER_METHOD: SSLv23 server method. See SSL_CTX_new(3) man page.
EventSslContext::TLS_SERVER_METHOD: TLS server method. See SSL_CTX_new(3) man page.
EventSslContext::OPT_LOCAL_CERT: Key for an item of the options' array used in EventSslContext::__construct(). The option points to path of local certificate.
EventSslContext::OPT_LOCAL_PK: Key for an item of the options' array used in EventSslContext::__construct(). The option points to path of the private key.
EventSslContext::OPT_PASSPHRASE: Key for an item of the options' array used in EventSslContext::__construct(). Represents passphrase of the certificate.
EventSslContext::OPT_CA_FILE: Key for an item of the options' array used in EventSslContext::__construct(). Represents path of the certificate authority file.
EventSslContext::OPT_CA_PATH: Key for an item of the options' array used in EventSslContext::__construct(). Represents path where the certificate authority file should be searched for.
EventSslContext::OPT_ALLOW_SELF_SIGNED: Key for an item of the options' array used in EventSslContext::__construct(). Represents option that allows self-signed certificates.
EventSslContext::OPT_VERIFY_PEER: Key for an item of the options' array used in EventSslContext::__construct(). Represents option that tells Event to verify peer.
EventSslContext::OPT_VERIFY_DEPTH: Key for an item of the options' array used in EventSslContext::__construct(). Represents maximum depth for the certificate chain verification that shall be allowed for the SSL context.
EventSslContext::OPT_CIPHERS: Key for an item of the options' array used in EventSslContext::__construct(). Represents the cipher list for the SSL context.

EventSslContext::__construct — Constructs an OpenSSL context for use with Event classes

The EventSslContext class

Introduction

Class synopsis

Properties

Predefined Constants

Table of Contents