Punkstar\Ssl\Reader

Complexity

Total Complexity

9

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

88.89%

Importance

Changes	7
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	readFromUrl()	0	46	4
A	readFromFile()	0	8	2
A	certResourceToString()	0	8	1
A	prepareReadFromUrlOptions()	0	8	2

<?php

namespace Punkstar\Ssl;

class Reader
{
    /**
     * Default connection timeout in seconds.
     */
    const DEFAULT_CONNECTION_TIMEOUT = 5;
    
    /**
     * Default port on which to expect https.
     */
    const DEFAULT_PORT = 443;
    
    /**
     * Option Flag: Name of option for defining a connection timeout.
     */
    const OPT_CONNECTION_TIMEOUT = 'connection_timeout';

    /**
     * Connect to a URL and retrieve the SSL certificate.
     *
     * Available options:
     *
     *     - connection_timeout: Timeout when connection to the URL, specified in seconds.
     *
     * @param $url
     * @param array $options
     * @return Certificate
     * @throws Exception
     */
    public function readFromUrl($url, array $options = []): Certificate
    {
        $urlHost = parse_url($url, PHP_URL_HOST);

        if ($urlHost === null) {
            $urlHost = $url;
        }
    
        $urlPort = parse_url($url, PHP_URL_PORT);
    
        if ($urlPort === null) {
            $urlPort = self::DEFAULT_PORT;
        }
    
        $options = $this->prepareReadFromUrlOptions($options);

        $streamContext = stream_context_create(array(
            'ssl' => array(
                'capture_peer_cert' => TRUE,
                'verify_peer'       => FALSE,
                'verify_peer_name'  => FALSE
            )
        ));

        $stream = @stream_socket_client(
            sprintf('ssl://%s:%d', $urlHost, $urlPort),
            $errorNumber,
            $errorString,
            $options[self::OPT_CONNECTION_TIMEOUT],
            STREAM_CLIENT_CONNECT,
            $streamContext
        );

        if ($stream) {
            $streamParams = stream_context_get_params($stream);

            $certResource = $streamParams['options']['ssl']['peer_certificate'];

            return new Certificate($this->certResourceToString($certResource));
        }
        
        throw new Exception(
            sprintf('Unable to connect to %s:%d', $urlHost, $urlPort),
            Exception::CONNECTION_PROBLEM
        );
    }
    
    /**
     * @param $file
     * @return Certificate
     * @throws Exception
     */
    public function readFromFile($file): Certificate
    {
        if (!file_exists($file)) {
            throw new Exception(sprintf("File '%s' does not exist", $file), Exception::FILE_NOT_FOUND);
        }

        return new Certificate(file_get_contents($file));
    }

    /**
     * @param $certResource
     * @return string
     */
    protected function certResourceToString($certResource): string
    {
        $output = null;

        openssl_x509_export($certResource, $output);

        return $output;
    }

    /**
     * @param $options
     * @return array
     */
    protected function prepareReadFromUrlOptions(array $options): array
    {
        if (!isset($options[self::OPT_CONNECTION_TIMEOUT])) {
            $options[self::OPT_CONNECTION_TIMEOUT] = self::DEFAULT_CONNECTION_TIMEOUT;
        }

        return $options;
    }
}