php簽名認證

　　一、概述

　　　　　　　　開年第一篇，該篇主要講述了接口開發中，如何安全認證、如何用php簽名認證。

　　二、說說歷史

　　　　　　　　簽名認證是什么？為什么要做簽名認證？簽名認證哪里會用到？no、no、no.....是不是，是不是，一下子疑問就這么多了！沒事兒，通過追溯歷史，我們來明白這些。

　　　　　1、簽名認證是什么？

　　　　　　　　數字簽名是一種類似寫在紙上的普通的物理簽名，但是使用了公鑰加密領域的技術實現，用於鑒別數字信息的方法。一套數字簽名通常定義兩種互補的運算，一個用於簽名，另一個用於驗證。

數字簽名，就是只有信息的發送者才能產生的別人無法偽造的一段數字串，這段數字串同時也是對信息的發送者發送信息真實性的一個有效證明。

　　　　　　　　在這個以“數據為生命”的時代，每一個開發商都盡可能的收集客戶的數據建立自己的BI庫，各系統、各平台間數據的傳輸和調用變得非常普遍且非常重要；那么作為開發人員，我們不但要防止系統被攻擊被入侵，我們還要確保數據的安全和完整

　　　　   2、為什么要做簽名認證？

　　　　　　　　在使用http或者soap傳輸數據的時候，簽名作為其中一個參數，可以起到關鍵作用：1、鑒權（通過客戶的密鑰，服務端的密鑰匹配）；2、數據防篡改（參數是明文傳輸，將參數及密鑰加密作為簽名與服務器匹配）；下面來分析下具體的方式： 

　　　　　　　　將請求參數中的各個鍵值對按照key的字符串順序升序排列（大小寫敏感），把key和value拼成一串之后最后加上密鑰，組成key1value1key2value2PRIVATEKEY的格式，轉成utf-8編碼的字節序列后計算md5，作為請求的簽名。計算出來的簽名串應當全為小寫形式。如果某個參數的值為空，則此參數不參與簽名。 

　　　　  3、簽名認證哪里會用到？

　　　　　　　　最常見的使我們在開發接口的時候，為了不被非法訪問，往往我們會做簽名認證，比如支付接口......

　　　　　　　　然后就是第三方平台的開發，比如微信公眾平台......

　　三、流程分析

　　　　　　客戶端：首先我們為提供給用戶一份接口文檔，文檔里面我們給用戶提供api地址、簽名算法解析過程、數據說明。

　　　　　   服務端：進行客戶端檢驗，通常就是參數個數、格式驗證，app_key驗證（這個是博主這里使用的，這個app_key會交給用戶，用戶訪問接口的時候必須帶上該app_key），簽名結果驗證。

　　　　　　以我這次寫的為例子來描述一下整個流程：

　　　　　　　　用戶參照我們提供的接口文檔，請求我們的接口，用戶按照我們接口說明的簽名算法生成簽名串作為參數，然后帶上必要的參數（GET、POST），如果服務端驗證成功，則返回真實數據。

　　　　

　　　　　　　　在服務端：我們首要驗證提交參數的個數、格式是否正確，然后我們通過提交的參數用簽名算法生成一個簽名串，最后服務端生成的簽名串和客戶端提交過來的簽名串進行比較，成功返回真實數據。

　　四、上代碼

<?php 
namespace ceshi;

/**
 * 簽名認證算法
 * HMAC-SHA256加密方式
 * 登錄認證加入access_token:access-token通過登錄接口去獲取，通過刷新接口去刷新，需要注意返回的過期時間，要在過期時間之前刷新重新獲取access-token。目前約定所有接口都必須傳access-token，也就是用戶必須先登錄才可以看到相關內容
 * 隨機函數可換更好的方法-本實例隨機函數比較簡單，隨機性不夠
 * ApiSign類作為服務端，類以外的代碼作為客戶端示例代碼
 * author jiechengyang https://www.cnblogs.com/YangJieCheng/
 */
class ApiSign 
{
    CONST DELAY_TIME = 2000;
    CONST ACCESS_TOCEN_PATH = './access_token';

    private $_config = [];
    protected $AppKey = 'voBVVQxfMxDmhuxV70';
    protected $AppSecret = 'QJF5P8qWFJakF9Ve89ZcIstHKbkt5fVA';
    protected $timeout = 300;
    protected $algo = 'sha256';
    public $loginCheck = false;

    public function __construct($config, $loginCheck)
    {
        $this->_config = $config;
        empty($this->AppKey) && $this->AppKey = $this->generateRandomString();
        empty($this->AppSecret) && $this->AppSecret = $this->generateRangeNum();
        $this->loginCheck = $loginCheck;
        if ($this->init()) {
            echo '<span style="color:red" id="sign_success">恭喜，簽名認證成功</span><script type="text/javascript"></script>';
            echo <<<JS
                <script>
                    var colors = ['#ffff00', '#ff66ff', '#99cc33', '#66ff33', '#000000', '#FF83FA', '#CAE1FF'];
                    var tmp = 0;
                    var timer = setInterval(colorChanage, 1000);
                    function colorChanage()
                    {
                        if(tmp == colors.length) {
                            tmp = 0;
                        }
                        document.getElementById('sign_success').style.color = colors[tmp++];
                    }
                </script>
JS;
        }
    }

    protected function init()
    {
        if (!isset($this->_config['_key']) 
            || !isset($this->_config['_sign'])
            || !isset($this->_config['_time'])
            || !isset($this->_config['_nonce'])
            || strlen($this->_config['_nonce']) !== 32
            ||  !is_numeric($this->_config['_time'])) {
                $this->callback(['message' => '請求參數不全, 或參數不規范'], 'error');
            }

        if (!isset($this->_config['_time']) || $this->getIsTimeOut()) {
            $this->callback(['message' => '請求超時'], 'error');
        }

        // 客戶端驗證
        $requestSignature = $this->_config['_sign'];
        $requestSignature = str_replace(' ', '+', $requestSignature);
        if($this->_config['_key'] !== $this->AppKey) {
            $this->callback(['message' => '非法的app_key'], 'error');
        }

        $signature = $this->generateSign($this->_config);
        if ($requestSignature != $signature) {
            $this->callback(['message' => '簽名錯誤'], 'error');
        }

          $accessToken = $this->getAccessToken();

          // 用戶登錄token驗證
          if ($this->loginCheck && $accessToken != $this->_config['access_token']) {
            $this->callback(['message' => 'access_token錯誤'], 'error');
          }

        return true;
    }

    private function callback($json=[], $status='ok')
    {
        $config = [
            'ok' => [200, '操作成功'],
            'error' => [300, '操作失敗'],
            'timeout' => [300, '操作超時'],
        ];
        $json['statusCode'] = $config[$status][0];
        !isset($json['message']) && $json['message'] = $config[$status][1];
        echo json_encode($json);
        exit;
    }

    private function getIsTimeOut()
    {
        if (abs($this->_config['_time'] - time()) > $this->timeout) {
            return true;
        }

        return false;
    }

   /**
     * 生成隨便數
     */
    public  function generateRangeNum($length = 32, $isToLower = false)
    {
        $str = $this->generateRandomString($length);
        if ($isToLower) {
            $str = strtolower($str);
        }

        return $str;
    }

    private function generateRandomString($length = 10) { 
        $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; 
        $randomString = ''; 
        for ($i = 0; $i < $length; $i++) { 
            $randomString .= $characters[rand(0, strlen($characters) - 1)]; 
        } 

        return $randomString; 
    }

    protected function generateSign($params)
    {
        if (isset($params['_sign'])) {
            unset($params['_sign']);
        }

        if($this->loginCheck && isset($params['access_token'])) {
            unset($params['access_token']);
        }

        ksort($params);
        $str = '';
        foreach ($params as $key => $value) {
            $str .= $key . '=' . $value . '&';
        }

        $str = rtrim($str, '&');

        return hash_hmac($this->algo, $str, $this->AppSecret, false);
    }

    public  function getAccessToken()
    {

        if (!file_exists(self::ACCESS_TOCEN_PATH)) {
            $json = ['value' => $this->_config['access_token'], 'expires_in' => 7200, 'time' => time()];
            file_put_contents(self::ACCESS_TOCEN_PATH, json_encode($json));
            return $this->_config['access_token'];
        }

        $accessToken = json_decode(file_get_contents(self::ACCESS_TOCEN_PATH), true);
        if (time() - $accessToken['time'] > $accessToken['expires_in'] - self::DELAY_TIME) {
            $json = ['value' => $this->_config['access_token'], 'expires_in' => 7200, 'time' => time()];
            file_put_contents(self::ACCESS_TOCEN_PATH, json_encode($json));
            return $this->_config['access_token'];
        }    

        return $accessToken['value'];    

    }
}

/**
 * 生成隨便數
 */
function generateRangeNum($length = 32, $isToLower = false)
{
    $str = generateRandomString($length);
    if ($isToLower) {
        $str = strtolower($str);
    }

    return $str;
}

function generateRandomString($length = 10) { 
    $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; 
    $randomString = ''; 
    for ($i = 0; $i < $length; $i++) { 
        $randomString .= $characters[rand(0, strlen($characters) - 1)]; 
    } 

    return $randomString; 
}

function generateSign($algo, $params, $AppSecret)
{
    if (isset($params['_sign'])) {
        unset($params['_sign']);
    }

    ksort($params);
    $str = '';
    foreach ($params as $key => $value) {
        $str .= $key . '=' . $value . '&';
    }

    $str = rtrim($str, '&');

    return hash_hmac($algo, $str, $AppSecret, false);
}

header("content-type:text/html;charset:utf-8");
$algo = 'sha256';
$AppKey = 'voBVVQxfMxDmhuxV70';
$AppKey = 'Rd1bW719zRbCXOBx3L';//---用於公司項目測試
$AppSecret = 'QJF5P8qWFJakF9Ve89ZcIstHKbkt5fVA';
$AppSecret = '73ZBAnbwVPDu0dvdlYE0RMvzsbhehejd';//---用於公司項目測試
$nonce = generateRangeNum(32);
$nonce = 'kj4ESP2Qcngaj3eAjpnrhCQR9g4yKnTM';//---用於公司項目測試
$loginCheck = false;
$params = [
    '_key' => $AppKey,
    '_time' => time(),
    '_nonce' => $nonce,
];
$sign = generateSign($algo, $params, $AppSecret);
echo $params['_time'],'<hr/>';//---用於公司項目測試
echo $sign;exit;//---用於公司項目測試
$params['_sign'] = $sign;

$loginCheck && $params['access_token'] = generateRangeNum(16);
// echo '<pre>';print_r($params);
$apiSignModel = new ApiSign($params, $loginCheck);