ThreemaGateway_Helper_Key

Complexity

Total Complexity

12

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getPublic()	0	17	3
A	getPublicShort()	0	7	2
A	checkPublic()	0	4	1
A	check()	0	5	1
A	getUserDisplay()	0	11	2
A	removeSuffix()	0	10	3

<?php
/**
 * Private/public key operations.
 *
 * @package ThreemaGateway
 * @author rugk
 * @copyright Copyright (c) 2015-2016 rugk
 * @license MIT
 */

class ThreemaGateway_Helper_Key
{
    /**
     * Returns the public key of a Threema ID.
     *
     * XenForo template helper: threemaidpubkey.
     *
     * @param  string            $threemaid Threema ID
     * @throws XenForo_Exception
     * @return string
     */
    public static function getPublic($threemaid)
    {
        if ($threemaid == '') {
            return '';
        }

        /** @var ThreemaGateway_Handler_Action_GatewayServer $gatewayHandlerServer */
        $gatewayHandlerServer = new ThreemaGateway_Handler_Action_GatewayServer;

        try {
            $publicKey = $gatewayHandlerServer->fetchPublicKey($threemaid);
        } catch (Exception $e) {
            throw new XenForo_Exception(new XenForo_Phrase('threemagw_threema_id_does_not_exist') . ' ' . $e->getMessage());
        }

        return $publicKey;
    }

    /**
     * Returns the short (user friendly) hash of the public key of a Threema ID.
     *
     * XenForo template helper: threemaidpubkeyshort.
     * Do not confuse this with {@link getUserDisplay()}. Here you have to pass
     * the Threema Id!
     *
     * @param  string $threemaid Threema ID
     * @return string
     */
    public static function getPublicShort($threemaid)
    {
        if ($threemaid == '') {
            return '';
        }
        return self::getUserDisplay(self::getPublic($threemaid));
    }

    /**
     * Checks whether a public key is valid.
     *
     * XenForo template helper: threemaisvalidpubkey.
     *
     * @param  string $pubKey Threema ID
     * @return bool
     */
    public static function checkPublic($pubKey)
    {
        return self::check($pubKey, 'public:');
    }

    /**
     * Checks whether a HEX-key is valid.
     *
     * XenForo template helper: threemaisvalidkey.
     *
     * @param string $publicKey the public key in hex
     * @param string $suffix    optional suffix (usually 'private:' or 'public:') (default: '')
     *
     * @return bool whether the key is valid (true) or not (false)
     */
    public static function check($publicKey, $suffix = '')
    {
        // RegExp: https://regex101.com/r/sU5tC8/1
        return (preg_match('/^(' . $suffix . ')?[[:alnum:]]{64}$/', $publicKey) === 1);
    }

    /**
     * Returns the short user-friendly hash of the public key.
     *
     * XenForo template helper: threemashortpubkey.
     * Do not confuse this with {@link getPublicShort()}. Here you have to pass
     * the public key!
     * This is the way the key is also displayed in the Threema app. For example
     * ECHOECHO is shown as `d30f795a904a213578baecc62c8611b5`. However the
     * full public key of it is:
     * `4a6a1b34dcef15d43cb74de2fd36091be99fbbaf126d099d47d83d919712c72b`
     *
     * @param string $publicKey The public key to format.
     *
     * @return string 32 hex characters
     */
    public static function getUserDisplay($publicKey)
    {
        //force key to be binary
        if (ctype_alnum($publicKey)) {
            $keyConverter = new ThreemaGateway_Handler_Action_KeyConverter;
            $publicKey    = $keyConverter->hexToBin($publicKey);
        }

        //create and return short hash
        return substr(hash('sha256', $publicKey), 0, 32);
    }

    /**
     * Removes the suffix if necessary.
     *
     * XenForo template helper: threemakeyremovesuffix.
     *
     * @param  string $keyHex The key in hex
     * @return string
     */
    public static function removeSuffix($keyHex)
    {
        /** @var string $keyTypeCheck */
        $keyTypeCheck = substr($keyHex, 0, 8);
        if ($keyTypeCheck == 'private:' || $keyTypeCheck == 'public:') {
            $keyHex = substr($keyHex, 8);
        }

        return $keyHex;
    }
}