Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/public_html/vendor/cakephp/cakephp/src/Network/ |
Upload File : |
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 1.2.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Network;
use Cake\Core\InstanceConfigTrait;
use Cake\Network\Exception\SocketException;
use Cake\Validation\Validation;
use Exception;
use InvalidArgumentException;
/**
* CakePHP network socket connection class.
*
* Core base class for network communication.
*
* @mixin \Cake\Core\InstanceConfigTrait
*/
class Socket
{
use InstanceConfigTrait;
/**
* Object description
*
* @var string
*/
public $description = 'Remote DataSource Network Socket Interface';
/**
* Default configuration settings for the socket connection
*
* @var array
*/
protected $_defaultConfig = [
'persistent' => false,
'host' => 'localhost',
'protocol' => 'tcp',
'port' => 80,
'timeout' => 30
];
/**
* Reference to socket connection resource
*
* @var resource|null
*/
public $connection;
/**
* This boolean contains the current state of the Socket class
*
* @var bool
*/
public $connected = false;
/**
* This variable contains an array with the last error number (num) and string (str)
*
* @var array
*/
public $lastError = [];
/**
* True if the socket stream is encrypted after a Cake\Network\Socket::enableCrypto() call
*
* @var bool
*/
public $encrypted = false;
/**
* Contains all the encryption methods available
*
* SSLv2 and SSLv3 are deprecated, and should not be used as they
* have several published vulnerablilities.
*
* @var array
*/
protected $_encryptMethods = [
// @codingStandardsIgnoreStart
// @deprecated Will be removed in 4.0.0
'sslv2_client' => STREAM_CRYPTO_METHOD_SSLv2_CLIENT,
// @deprecated Will be removed in 4.0.0
'sslv3_client' => STREAM_CRYPTO_METHOD_SSLv3_CLIENT,
'sslv23_client' => STREAM_CRYPTO_METHOD_SSLv23_CLIENT,
'tls_client' => STREAM_CRYPTO_METHOD_TLS_CLIENT,
'tlsv10_client' => STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT,
'tlsv11_client' => STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT,
'tlsv12_client' => STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT,
// @deprecated Will be removed in 4.0.0
'sslv2_server' => STREAM_CRYPTO_METHOD_SSLv2_SERVER,
// @deprecated Will be removed in 4.0.0
'sslv3_server' => STREAM_CRYPTO_METHOD_SSLv3_SERVER,
'sslv23_server' => STREAM_CRYPTO_METHOD_SSLv23_SERVER,
'tls_server' => STREAM_CRYPTO_METHOD_TLS_SERVER,
'tlsv10_server' => STREAM_CRYPTO_METHOD_TLSv1_0_SERVER,
'tlsv11_server' => STREAM_CRYPTO_METHOD_TLSv1_1_SERVER,
'tlsv12_server' => STREAM_CRYPTO_METHOD_TLSv1_2_SERVER
// @codingStandardsIgnoreEnd
];
/**
* Used to capture connection warnings which can happen when there are
* SSL errors for example.
*
* @var array
*/
protected $_connectionErrors = [];
/**
* Constructor.
*
* @param array $config Socket configuration, which will be merged with the base configuration
* @see \Cake\Network\Socket::$_baseConfig
*/
public function __construct(array $config = [])
{
$this->setConfig($config);
}
/**
* Connect the socket to the given host and port.
*
* @return bool Success
* @throws \Cake\Network\Exception\SocketException
*/
public function connect()
{
if ($this->connection) {
$this->disconnect();
}
$hasProtocol = strpos($this->_config['host'], '://') !== false;
if ($hasProtocol) {
list($this->_config['protocol'], $this->_config['host']) = explode('://', $this->_config['host']);
}
$scheme = null;
if (!empty($this->_config['protocol'])) {
$scheme = $this->_config['protocol'] . '://';
}
$this->_setSslContext($this->_config['host']);
if (!empty($this->_config['context'])) {
$context = stream_context_create($this->_config['context']);
} else {
$context = stream_context_create();
}
$connectAs = STREAM_CLIENT_CONNECT;
if ($this->_config['persistent']) {
$connectAs |= STREAM_CLIENT_PERSISTENT;
}
set_error_handler([$this, '_connectionErrorHandler']);
$this->connection = stream_socket_client(
$scheme . $this->_config['host'] . ':' . $this->_config['port'],
$errNum,
$errStr,
$this->_config['timeout'],
$connectAs,
$context
);
restore_error_handler();
if (!empty($errNum) || !empty($errStr)) {
$this->setLastError($errNum, $errStr);
throw new SocketException($errStr, $errNum);
}
if (!$this->connection && $this->_connectionErrors) {
$message = implode("\n", $this->_connectionErrors);
throw new SocketException($message, E_WARNING);
}
$this->connected = is_resource($this->connection);
if ($this->connected) {
stream_set_timeout($this->connection, $this->_config['timeout']);
}
return $this->connected;
}
/**
* Configure the SSL context options.
*
* @param string $host The host name being connected to.
* @return void
*/
protected function _setSslContext($host)
{
foreach ($this->_config as $key => $value) {
if (substr($key, 0, 4) !== 'ssl_') {
continue;
}
$contextKey = substr($key, 4);
if (empty($this->_config['context']['ssl'][$contextKey])) {
$this->_config['context']['ssl'][$contextKey] = $value;
}
unset($this->_config[$key]);
}
if (!isset($this->_config['context']['ssl']['SNI_enabled'])) {
$this->_config['context']['ssl']['SNI_enabled'] = true;
}
if (empty($this->_config['context']['ssl']['peer_name'])) {
$this->_config['context']['ssl']['peer_name'] = $host;
}
if (empty($this->_config['context']['ssl']['cafile'])) {
$dir = dirname(dirname(__DIR__));
$this->_config['context']['ssl']['cafile'] = $dir . DIRECTORY_SEPARATOR .
'config' . DIRECTORY_SEPARATOR . 'cacert.pem';
}
if (!empty($this->_config['context']['ssl']['verify_host'])) {
$this->_config['context']['ssl']['CN_match'] = $host;
}
unset($this->_config['context']['ssl']['verify_host']);
}
/**
* socket_stream_client() does not populate errNum, or $errStr when there are
* connection errors, as in the case of SSL verification failure.
*
* Instead we need to handle those errors manually.
*
* @param int $code Code number.
* @param string $message Message.
* @return void
*/
protected function _connectionErrorHandler($code, $message)
{
$this->_connectionErrors[] = $message;
}
/**
* Get the connection context.
*
* @return null|array Null when there is no connection, an array when there is.
*/
public function context()
{
if (!$this->connection) {
return null;
}
return stream_context_get_options($this->connection);
}
/**
* Get the host name of the current connection.
*
* @return string Host name
*/
public function host()
{
if (Validation::ip($this->_config['host'])) {
return gethostbyaddr($this->_config['host']);
}
return gethostbyaddr($this->address());
}
/**
* Get the IP address of the current connection.
*
* @return string IP address
*/
public function address()
{
if (Validation::ip($this->_config['host'])) {
return $this->_config['host'];
}
return gethostbyname($this->_config['host']);
}
/**
* Get all IP addresses associated with the current connection.
*
* @return array IP addresses
*/
public function addresses()
{
if (Validation::ip($this->_config['host'])) {
return [$this->_config['host']];
}
return gethostbynamel($this->_config['host']);
}
/**
* Get the last error as a string.
*
* @return string|null Last error
*/
public function lastError()
{
if (!empty($this->lastError)) {
return $this->lastError['num'] . ': ' . $this->lastError['str'];
}
return null;
}
/**
* Set the last error.
*
* @param int $errNum Error code
* @param string $errStr Error string
* @return void
*/
public function setLastError($errNum, $errStr)
{
$this->lastError = ['num' => $errNum, 'str' => $errStr];
}
/**
* Write data to the socket.
*
* The bool false return value is deprecated and will be int 0 in the next major.
* Please code respectively to be future proof.
*
* @param string $data The data to write to the socket.
* @return int|false Bytes written.
*/
public function write($data)
{
if (!$this->connected && !$this->connect()) {
return false;
}
$totalBytes = strlen($data);
$written = 0;
while ($written < $totalBytes) {
$rv = fwrite($this->connection, substr($data, $written));
if ($rv === false || $rv === 0) {
return $written;
}
$written += $rv;
}
return $written;
}
/**
* Read data from the socket. Returns false if no data is available or no connection could be
* established.
*
* The bool false return value is deprecated and will be null in the next major.
* Please code respectively to be future proof.
*
* @param int $length Optional buffer length to read; defaults to 1024
* @return mixed Socket data
*/
public function read($length = 1024)
{
if (!$this->connected && !$this->connect()) {
return false;
}
if (!feof($this->connection)) {
$buffer = fread($this->connection, $length);
$info = stream_get_meta_data($this->connection);
if ($info['timed_out']) {
$this->setLastError(E_WARNING, 'Connection timed out');
return false;
}
return $buffer;
}
return false;
}
/**
* Disconnect the socket from the current connection.
*
* @return bool Success
*/
public function disconnect()
{
if (!is_resource($this->connection)) {
$this->connected = false;
return true;
}
$this->connected = !fclose($this->connection);
if (!$this->connected) {
$this->connection = null;
}
return !$this->connected;
}
/**
* Destructor, used to disconnect from current connection.
*/
public function __destruct()
{
$this->disconnect();
}
/**
* Resets the state of this Socket instance to it's initial state (before Object::__construct got executed)
*
* @param array|null $state Array with key and values to reset
* @return bool True on success
*/
public function reset($state = null)
{
if (empty($state)) {
static $initalState = [];
if (empty($initalState)) {
$initalState = get_class_vars(__CLASS__);
}
$state = $initalState;
}
foreach ($state as $property => $value) {
$this->{$property} = $value;
}
return true;
}
/**
* Encrypts current stream socket, using one of the defined encryption methods
*
* @param string $type can be one of 'ssl2', 'ssl3', 'ssl23' or 'tls'
* @param string $clientOrServer can be one of 'client', 'server'. Default is 'client'
* @param bool $enable enable or disable encryption. Default is true (enable)
* @return bool True on success
* @throws \InvalidArgumentException When an invalid encryption scheme is chosen.
* @throws \Cake\Network\Exception\SocketException When attempting to enable SSL/TLS fails
* @see stream_socket_enable_crypto
*/
public function enableCrypto($type, $clientOrServer = 'client', $enable = true)
{
if (!array_key_exists($type . '_' . $clientOrServer, $this->_encryptMethods)) {
throw new InvalidArgumentException('Invalid encryption scheme chosen');
}
$method = $this->_encryptMethods[$type . '_' . $clientOrServer];
// Prior to PHP 5.6.7 TLS_CLIENT was any version of TLS. This was changed in 5.6.7
// to fix backwards compatibility issues, and now only resolves to TLS1.0
//
// See https://github.com/php/php-src/commit/10bc5fd4c4c8e1dd57bd911b086e9872a56300a0
if (version_compare(PHP_VERSION, '5.6.7', '>=')) {
if ($method == STREAM_CRYPTO_METHOD_TLS_CLIENT) {
// @codingStandardsIgnoreStart
$method |= STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT;
// @codingStandardsIgnoreEnd
}
if ($method == STREAM_CRYPTO_METHOD_TLS_SERVER) {
// @codingStandardsIgnoreStart
$method |= STREAM_CRYPTO_METHOD_TLSv1_1_SERVER | STREAM_CRYPTO_METHOD_TLSv1_2_SERVER;
// @codingStandardsIgnoreEnd
}
}
try {
$enableCryptoResult = stream_socket_enable_crypto($this->connection, $enable, $method);
} catch (Exception $e) {
$this->setLastError(null, $e->getMessage());
throw new SocketException($e->getMessage(), null, $e);
}
if ($enableCryptoResult === true) {
$this->encrypted = $enable;
return true;
}
$errorMessage = 'Unable to perform enableCrypto operation on the current socket';
$this->setLastError(null, $errorMessage);
throw new SocketException($errorMessage);
}
}