nilnice / payment

src/Alipay/Traits/SecurityTrait.php

<?php

namespace Nilnice\Payment\Alipay\Traits;

use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Nilnice\Payment\Constant;
use Nilnice\Payment\Exception\InvalidKeyException;

trait SecurityTrait
{
    /**
     * Generate signature.
     *
     * @param array $array
     * @param null  $key

Are you sure the doc-type for parameter $key is correct as it would always require null to be passed?

     *
     * @return string
     *
     * @throws \Nilnice\Payment\Exception\InvalidKeyException
     */
    public static function generateSign(array $array, $key = null) : string
    {
        if ($key === null) {
            throw new InvalidKeyException(
                'Invalid Alipay [private key] configuration.',
                Constant::ALI_PAY_PRIVATE_KEY_INVALID
            );
        }

        if (Str::endsWith($key, '.pem')) {
            $key = openssl_pkey_get_private($key);
        } else {
            $key = self::getKey($key, false);
        }

        $data = self::getSignContent($array);
        openssl_sign($data, $sign, $key, OPENSSL_ALGO_SHA256);

        return base64_encode($sign);
    }

    /**
     * Get signature content.
     *
     * @param array $array
     * @param bool  $isVerify
     *
     * @return string
     */
    public static function getSignContent(
        array $array,
        $isVerify = false
    ) : string {
        $to = $array['charset'] ?? 'GB2312';
        $array = self::toEncoding($array, $to);
        ksort($array);

        $string = '';
        foreach ($array as $key => $val) {
            if ($isVerify && $key !== 'sign' && $key !== 'sign_type') {
                $string .= $key . '=' . $val . '&';
            }
            if (! $isVerify
                && $val !== ''
                && null !== $val
                && $key !== 'sign'
                && 0 !== strpos($val, '@')
            ) {
                $string .= $key . '=' . $val . '&';
            }
        }

        return rtrim($string, '&');
    }

    /**
     * Verify signature.
     *
     * @param array       $array
     * @param string|null $key
     * @param bool        $isSync
     * @param string|null $sign
     *
     * @return bool
     *
     * @throws \Nilnice\Payment\Exception\InvalidKeyException
     */
    public static function verifySign(
        array $array,
        $key = null,
        $isSync = false,
        $sign = null
    ) : bool {
        if ($key === null) {
            throw new InvalidKeyException(
                'Invalid Alipay [public key] configuration.',
                Constant::ALI_PAY_PUBLIC_KEY_INVALID
            );
        }

        if (Str::endsWith($key, '.pem')) {
            $key = openssl_pkey_get_public($key);
        } else {
            $key = self::getKey($key);
        }

        $sign = $sign ?? Arr::get($array, 'sign');
        $data = $isSync
            ? mb_convert_encoding(
                json_encode($array, JSON_UNESCAPED_UNICODE),
                'GB2312',
                'UTF-8')
            : self::getSignContent($array, true);
        $sign = base64_decode($sign);

        return openssl_verify($data, $sign, $key, OPENSSL_ALGO_SHA256) === 1;
    }

    /**
     * To encoding.
     *
     * @param array  $array
     * @param string $to
     * @param string $from
     *
     * @return array
     */
    public static function toEncoding(
        array $array,
        $to = 'GB2312',
        $from = 'UTF-8'
    ) : array {
        $data = [];
        foreach ($array as $key => $val) {
            if (\is_array($val)) {
                $data[$key] = self::toEncoding((array)$val, $to, $from);
            } else {
                $data[$key] = mb_convert_encoding($val, $to, $from);
            }
        }

        return $data;
    }

    /**
     * Get key.
     *
     * @param string $key
     * @param bool   $isPublicKey
     *
     * @return string
     */
    public static function getKey(
        string $key,
        bool $isPublicKey = true
    ) : string {
        $char = $isPublicKey ? 'PUBLIC' : 'RSA PRIVATE';
        $format = "-----BEGIN %s KEY-----\n%s\n-----END %s KEY-----";
        $key = wordwrap($key, 64, PHP_EOL, true);
        $string = sprintf($format, $char, $key, $char);

        return $string;
    }
}