SM3-PHP國密標準SM3的原生PHP實現

SM3-PHP是國密標準SM3的原生PHP實現。

特點

1. 純原生?PHP?代碼，不額外依賴擴展項；
2. OOP?+?Composer?，更優雅，安裝更簡單；
3. 使用命名空間，防止變量名、方法名污染；
4. 引入了?Composer?的?PSR-4?規范，進行類的自動加載；
5. 使用?PSR-12?代碼規范
6. 代碼注釋完整， 可配合《?SM3密碼雜湊算法?》食用， 方便進一步學習和研究本算法。

要求

• 5.3 <=?php?< 7.2

7.2 之后版本理論通過，但因為 phpunit 的版本兼容性問題，沒有單元測試支撐

1.x 版本之后只會作為低版本兼容，2.x 及之后版本會對 PHP 更高版本做適配，使用更多新特性

安裝

本庫優先支持 Composer 安裝，但為了尊重使用習慣，也提供了直接下載壓縮包的方式。 但不得不說，Composer 式的以組件、包為單位的項目管理方式更加現代化、方便和優雅。

一、源碼解壓（不推薦）

1. 下載壓縮包

   提供了?.zip?和?.tar.gz?兩種格式的壓縮包， 壓縮包已經過 Composer 包的優化

   下載地址：https://github.com/DongyunLee/SM3-PHP/releases/latest

2. 解壓到項目中的任意位置

   • Windows：

     使用?winrar/7zip/Bandizip?等工具解壓

   • 類Unix：

     tar zxvf SM3-PHP.tar.gz
     # 或者
     unzip SM3-PHP.zip

    # 打包命令
    composer arch
    
    # 或 composer run-script arch

二、composer?安裝（強烈推薦）

1. 安裝?composer

   詳見 《如何安裝 Composer》

2. 安裝慢可更換中文鏡像

   由于大量先前的鏡像失效，所以目前(2019-11-25)推薦使用阿里云鏡像

   其實配置中已經把鏡像配置成了阿里云的鏡像。 但有效范圍畢竟只有這一個包。

   開發環境中還是建議進行下全局的配置。

   更換阿里云鏡像方式詳見拙筆 《向先行者致敬,迎接 Composer 的未來！》

3. composer require ch4o5/sm3-php

4. composer install

5. composer update

   下述?composer update?參數作為生產環境的優化，分析、調試和閱讀代碼無須使用

   參數簡單說明：

   1. --prefer-dist：優先構建好的包，而不是源碼
   2. --no-dev：不安裝require-dev中定義的包，減小包的大小
   3. --no-plugins：不安裝插件
   4. --with-dependencies：遞歸更新依賴的包
   5. --optimize-autoloader?/?-o：轉換 PSR-0/4 autoload 到 classmap 可以獲得更快的加載支持
   6. --classmap-authoritative:?推薦?使用后默認開啟?-o，并對所有類加速

快速開始

在根目錄中的?demo.php?中，進行了簡單地調用示范：

/**
 * demo @ sm3-php
 *
 * Code BY ch4o5
 * 10月. 12th 2019
 * Powered by PhpStorm
 */

// 1. 引入項目中 Composer 的 autoload.php
require 'vendor/autoload.php';
// 2. 如果使用源碼壓縮包方式安裝，則引入下面這句
// require '解壓后的SM3-PHP目錄/vendor/autoload.php';

// 直接調用提供的 sm3() 函數
$sm3 = sm3('abc');

// 使用它
echo $sm3;