Sop\CryptoEncoding\PEM

Complexity

Total Complexity

11

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	string()	0	5	1
A	__construct()	0	4	1
A	fromString()	0	11	3
A	data()	0	3	1
A	type()	0	3	1
A	fromFile()	0	7	3

<?php

declare(strict_types = 1);

namespace Sop\CryptoEncoding;

/**
 * Implements PEM file encoding and decoding.
 *
 * @see https://tools.ietf.org/html/rfc7468
 */
class PEM
{
    // well-known PEM types
    const TYPE_CERTIFICATE = 'CERTIFICATE';
    const TYPE_CRL = 'X509 CRL';
    const TYPE_CERTIFICATE_REQUEST = 'CERTIFICATE REQUEST';
    const TYPE_ATTRIBUTE_CERTIFICATE = 'ATTRIBUTE CERTIFICATE';
    const TYPE_PRIVATE_KEY = 'PRIVATE KEY';
    const TYPE_PUBLIC_KEY = 'PUBLIC KEY';
    const TYPE_ENCRYPTED_PRIVATE_KEY = 'ENCRYPTED PRIVATE KEY';
    const TYPE_RSA_PRIVATE_KEY = 'RSA PRIVATE KEY';
    const TYPE_RSA_PUBLIC_KEY = 'RSA PUBLIC KEY';
    const TYPE_EC_PRIVATE_KEY = 'EC PRIVATE KEY';
    const TYPE_PKCS7 = 'PKCS7';
    const TYPE_CMS = 'CMS';

    /**
     * Regular expression to match PEM block.
     *
     * @var string
     */
    const PEM_REGEX = '/' .
        /* line start */ '(?:^|[\r\n])' .
        /* header */     '-----BEGIN (.+?)-----[\r\n]+' .
        /* payload */    '(.+?)' .
        /* trailer */    '[\r\n]+-----END \\1-----' .
    '/ms';

    /**
     * Content type.
     *
     * @var string
     */
    protected $_type;

    /**
     * Payload.
     *
     * @var string
     */
    protected $_data;

    /**
     * Constructor.
     *
     * @param string $type Content type
     * @param string $data Payload
     */
    public function __construct(string $type, string $data)
    {
        $this->_type = $type;
        $this->_data = $data;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return $this->string();
    }

    /**
     * Initialize from a PEM-formatted string.
     *
     * @param string $str
     *
     * @throws \UnexpectedValueException If string is not valid PEM
     *
     * @return self
     */
    public static function fromString(string $str): self
    {
        if (!preg_match(self::PEM_REGEX, $str, $match)) {
            throw new \UnexpectedValueException('Not a PEM formatted string.');
        }
        $payload = preg_replace('/\s+/', '', $match[2]);
        $data = base64_decode($payload, true);
        if (false === $data) {
            throw new \UnexpectedValueException('Failed to decode PEM data.');
        }
        return new self($match[1], $data);
    }

    /**
     * Initialize from a file.
     *
     * @param string $filename Path to file
     *
     * @throws \RuntimeException If file reading fails
     *
     * @return self
     */
    public static function fromFile(string $filename): self
    {
        if (!is_readable($filename) ||
            false === ($str = file_get_contents($filename))) {
            throw new \RuntimeException("Failed to read {$filename}.");
        }
        return self::fromString($str);
    }

    /**
     * Get content type.
     *
     * @return string
     */
    public function type(): string
    {
        return $this->_type;
    }

    /**
     * Get payload.
     *
     * @return string
     */
    public function data(): string
    {
        return $this->_data;
    }

    /**
     * Encode to PEM string.
     *
     * @return string
     */
    public function string(): string
    {
        return "-----BEGIN {$this->_type}-----\n" .
            trim(chunk_split(base64_encode($this->_data), 64, "\n")) . "\n" .
            "-----END {$this->_type}-----";
    }
}