
使用NestJS和Prisma構建REST API:身份驗證
$app_key = str_replace('-', '', $originalUuid); // 唯一標識ID uuid
$timestamp = time();
$app_secret = sha1($app_key . '|'.$timestamp); // sha1(app_key + update_time)
$createData = [
'app_name' => '阿克蘇平臺',
'app_key' => $app_key,
'app_secret' => password_hash($app_secret, PASSWORD_DEFAULT), // 加密保存
'create_time' => $timestamp,
'update_time' => $timestamp
];
if(AppModel::create($createData)){
return response_json(200, 'ok');
}
// [1] 從請求頭中獲取簽名
$signature = $this->request->header()['x-resty-signature'] ?? '';
// [2] 簽名解析 獲取: 哈希算法 和 明文數據
list($hashType, $hashValue) = explode('=', $signature, 2);
// [3] 獲取請求的內容,格式為json字符換
$jsonContent = $this->request->getContent();
if(empty($jsonContent)) {
return response_json(400, '請求內容不能為空');
}
$arrayContent = json_decode($jsonContent, true);
if(!isset($arrayContent['app_key']) || !isset($arrayContent['timestamp'])) {
return response_json(400, '請求app_key timestamp不能為空');
}
if (($arrayContent['timestamp'] + 20) < time() ) {
return response_json(403, 'timestamp過期');
}
$appInfo = AppModel::where('app_key',$arrayContent['app_key'])->findOrEmpty();
if($appInfo->isEmpty()) {
return response_json(400, '無效的app_key');
}
// [4] 生成 appSecret
$appSecret = sha1($appInfo->app_key . '|'.$appInfo->update_time);
// [5] hash_hmac — 使用 HMAC 方法生成帶有密鑰的哈希值
$checkHash = hash_hmac($hashType, json_encode($arrayContent), $appSecret);
// [6] 簽名校驗
if ($checkHash != $hashValue) {
return response_json(403, '無效的簽名',$this->request->header());
}
return response_json(200, 'ok',$arrayContent);
在設計和實現API接口時,我們經常需要處理一些敏感數據,例如用戶的登錄密碼、銀行卡號、身份證號碼等。這些信息若以明文形式在網絡上傳輸,將面臨極大的安全風險,容易受到惡意監聽和數據泄露的威脅。
在設計和實現API接口時,我們經常需要處理一些敏感數據,例如用戶的登錄密碼、銀行卡號、轉賬金額和身份證號碼等。這些信息若以明文形式在網絡上傳輸,將面臨極大的安全風險,容易受到惡意監聽和數據泄露的威脅。
為了確保這些關鍵信息的安全,我們必須采取加密措施來保護數據的完整性和隱私性。以下是一些加強數據安全的建議:
SM4算法是一種分組密碼算法。其分組長度為128bit,密鑰長度也為128bit。加密算法與密鑰擴展算法均采用32輪非線性迭代結構,以字(32位)為單位進行加密運算,每一次迭代運算均為一輪變換函數F。SM4算法加/解密算法的結構相同,只是使用輪密鑰相反,其中解密輪密鑰是加密輪密鑰的逆序。
SM4加密方式類似于AES加密,為對稱加密,可以通過相應的秘鑰進行加密和解密
加密
$key = '35d251411ea04318565f0dbda6ffb6a8';
// 加密內容
$content = [
'name' => 'Tinywan',
'School' => 'ZheJiang University',
'age' => 24,
'github' => [
'url' => 'https://github.com/Tinywan',
'start' => 2000,
],
];
// 必須轉換為字符串
$content = json_encode($content, JSON_UNESCAPED_UNICODE);
$sm4 = new SM4($key);
$encryptContent = $sm4->encrypt($content);
var_dump($encryptContent);
// 加密內容:b4358f5860343dbf2089ba75ee55deca8d922a069413f39cb3f8b64c01048c780ba5f03290642505d65d79c59684d76cf42443047f547c9f29dc2a49f872a2719ce00539058ab1fb5830e8e0c10144b574a87118390baa765b3429ba7afe5d28
解密
$key = '35d251411ea04318565f0dbda6ffb6a8';
// 加密內容
$encryptContent = 'b4358f5860343dbf2089ba75ee55deca8d922a069413f39cb3f8b64c01048c780ba5f03290642505d65d79c59684d76cf42443047f547c9f29dc2a49f872a2719ce00539058ab1fb5830e8e0c10144b574a87118390baa765b3429ba7afe5d28';
$sm4 = new SM4($key);
$decryptedJsonContent = $sm4->decrypt($encryptContent);
print_r($decryptedJsonContent);
解密結果
{
"name": "Tinywan",
"School": "ZheJiang University",
"age": 24,
"github": {
"url": "https://github.com/Tinywan",
"start": 2021
}
}
可以通過 json_decode($decryptedJsonContent, true) ,轉換為數組使用
API接口響應格式的統一對于客戶端開發者來說非常重要,它有助于提高開發效率、降低出錯率,并能夠快速集成和調試接口。
以下是一些建議,用于確保API響應格式的統一性:
data
,這樣可以在不同的響應中保持一致性。total
(總記錄數)、perPage
(每頁記錄數)、currentPage
(當前頁碼)和totalPages
(總頁數)。通過以上措施,可以確保API接口的響應格式統一、清晰,并且易于客戶端開發者使用和集成。
案例
成功示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"code": 0,
"msg": "success",
"data": {
"token_type": "Bearer",
"expires_in": 7200,
"access_token": "XXXXXXXXXXX"
}
}
異常實例
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"code": 0,
"msg": "應用信息不存在",
"data": {}
}
本文章轉載微信公眾號@開源技術小棧