介紹
本Codelab針對用戶隱私安全,使用加密算法API對密碼進行加密存儲,模擬開發(fā)一個用戶注冊登錄應用。實現(xiàn)如下功能:
- 實現(xiàn)登錄、注冊、登錄成功頁面。
- 注冊的用戶數(shù)據(jù)保存到關(guān)系型數(shù)據(jù)庫。
- 登錄時通過查詢數(shù)據(jù)庫校驗用戶是否存在、密碼是否正確。
- 密碼通過加密算法保存和使用。
相關(guān)概念
- [加解密算法庫框架]:為屏蔽底層硬件和算法庫,向上提供統(tǒng)一的密碼算法庫加解密相關(guān)接口。
- [關(guān)系型數(shù)據(jù)庫]:關(guān)系型數(shù)據(jù)庫(Relational Database,RDB)是一種基于關(guān)系模型來管理數(shù)據(jù)的數(shù)據(jù)庫。
環(huán)境搭建
軟件要求
- [DevEco Studio]版本:DevEco Studio 3.1 Release。
- OpenHarmony SDK版本:API version 9。
硬件要求
- 開發(fā)板類型:[潤和RK3568開發(fā)板]。
- OpenHarmony系統(tǒng):3.2 Release。
環(huán)境搭建
完成本篇Codelab我們首先要完成開發(fā)環(huán)境的搭建,本示例以RK3568開發(fā)板為例,參照以下步驟進行:
- [獲取OpenHarmony系統(tǒng)版本]:標準系統(tǒng)解決方案(二進制)。以3.2 Release版本為例:
- 搭建燒錄環(huán)境。
- [完成DevEco Device Tool的安裝]
- [完成RK3568開發(fā)板的燒錄]
- 搭建開發(fā)環(huán)境。
- 開始前請參考[工具準備],完成DevEco Studio的安裝和開發(fā)環(huán)境配置。
- 開發(fā)環(huán)境配置完成后,請參考[使用工程向?qū)創(chuàng)建工程(模板選擇“Empty Ability”)。
- 工程創(chuàng)建完成后,選擇使用[真機進行調(diào)測]。
- 鴻蒙開發(fā)指導文檔:
gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md
點擊或者復制轉(zhuǎn)到。
代碼結(jié)構(gòu)解讀
HarmonyOS與OpenHarmony鴻蒙文檔籽料:mau123789是v直接拿
本篇Codelab只對核心代碼進行講解,對于完整代碼,我們會在gitee中提供。
├──entry/src/main/ets // 代碼區(qū)
│ ├──common
│ │ ├──constants
│ │ │ └──CommonConstants.ets // 公共常量類
│ │ └──utils
│ │ ├──AesUtil.ets // 加解密工具類
│ │ ├──DataTransformUtil.ets // 數(shù)據(jù)轉(zhuǎn)換工具類
│ │ ├──Logger.ets // 日志打印工具類
│ │ └──PromptUtil.ts // 彈窗工具類
│ ├──entryability
│ │ └──EntryAbility.ts // 程序入口類
│ ├──model
│ │ ├──RdbModel.ets // 數(shù)據(jù)庫業(yè)務(wù)處理文件
│ │ └──UserTableApi.ets // 用戶表具體業(yè)務(wù)文件
│ ├──pages
│ │ ├──Login.ets // 登錄頁
│ │ ├──Register.ets // 注冊頁
│ │ └──Welcome.ets // 歡迎頁
│ └──viewmodel
│ └──User.ets // 用戶實體類
└──entry/src/main/resources // 資源文件目錄
關(guān)系型數(shù)據(jù)庫
首先編寫創(chuàng)建表的SQL語句,其中user為表名、id為主鍵并自動遞增、username為用戶名、password為加密后的密碼、authTag為加解密認證信息。
// CommonConstants.ets
/**
* 創(chuàng)建表的SQL語句
*/
static readonly CREATE_TABLE_SQL: string = 'CREATE TABLE IF NOT EXISTS user(' +
'id INTEGER PRIMARY KEY AUTOINCREMENT, ' +
'username TEXT NOT NULL, ' +
'password TEXT NOT NULL, ' +
'authTag TEXT NOT NULL)';
在RdbModel的構(gòu)造方法中,調(diào)用getRdbStore方法創(chuàng)建數(shù)據(jù)庫。其中STORE_CONFIG為數(shù)據(jù)庫相關(guān)配置,sqlCreateTable為創(chuàng)建user用戶表所需的SQL語句。
// RdbModel.ets
import dataRdb from '@ohos.data.relationalStore';
...
export class RdbModel {
private rdbStore: dataRdb.RdbStore | null = null;
private tableName: string = '';
private sqlCreateTable: string = '';
...
constructor(tableName: string, sqlCreateTable: string, columns: Array< string >) {
this.tableName = tableName;
this.sqlCreateTable = sqlCreateTable;
this.columns = columns;
this.getRdbStore();
}
/**
* 獲取數(shù)據(jù)庫操作對象rdbStore.
*/
getRdbStore() {
let getPromiseRdb = dataRdb.getRdbStore(getContext(), { name: CommonConstants.DATABASE_NAME, securityLevel: dataRdb.SecurityLevel.S1 });
getPromiseRdb.then(rdbStore = > {
this.rdbStore = rdbStore;
this.rdbStore.executeSql(this.sqlCreateTable);
}).catch((err: Error) = > {
Logger.error(`getRdbStore err ${JSON.stringify(err)}`);
});
}
創(chuàng)建UserTableApi.ets文件,實例化RdbModel創(chuàng)建userTable對象。并對外提供可操作用戶數(shù)據(jù)表的API接口,包括插入數(shù)據(jù)、根據(jù)用戶名查詢用戶信息等方法。
// UserTableApi.ets
export class UserTableApi {
private userTable = new RdbModel(TABLE_NAME, CREATE_USER_TABLE, COLUMNS);
/**
* 將數(shù)據(jù)保存到數(shù)據(jù)庫中
*
* @param user 需要保存的User類型的數(shù)據(jù)對象
*/
insertUserData(user: User) {
this.userTable.insertData(user);
}
/**
* 根據(jù)用戶名查詢用戶信息
*
* @param username 查詢的用戶名
* @returns 查詢結(jié)果集
*/
async queryUserByUsername(username: string): Promise< User[] > {
let resultList: Array< User >;
// 過濾條件
let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
predicates.equalTo('username', username);
// 將查詢到的結(jié)果封裝成User對應的用戶信息
let ret = await this.userTable.query(predicates);
resultList = this.getListFromResultSet(ret);
return resultList;
}
...
}
密碼加解密
創(chuàng)建AesUtil工具類,封裝加解密相關(guān)邏輯。首先引入@ohos.security.cryptoFramework包,在構(gòu)造方法中初始化加解密算法框架所需的環(huán)境,包括密鑰規(guī)格的選擇、加解密規(guī)格的選擇等。本示例采用對稱AES加解密算法,密鑰長度為256位,分組模式為GCM。具體有以下步驟:
- 創(chuàng)建對稱密鑰生成器。
- 通過密鑰生成器生成對稱密鑰。
- 創(chuàng)建加解密生成器。
- 通過加解密生成器加密或解密數(shù)據(jù)。
說明: 對于對稱密鑰、非對稱密鑰、加解密算法模式。
// AesUtil.ets
import cryptoFramework from '@ohos.security.cryptoFramework';
...
class AesUtil {
private globalCipher: cryptoFramework.Cipher = cryptoFramework.createCipher(CommonConstants.GENERATOR_NAME;
private globalKey: cryptoFramework.SymKey = null;
/**
* 構(gòu)造函數(shù)初始化加解密環(huán)境、生成密鑰
*/
constructor() {
let symAlgName = CommonConstants.ENCRYPTION_MODE;
// 創(chuàng)建對稱密鑰生成器
let symKeyGenerator = cryptoFramework.createSymKeyGenerator(symAlgName);
// 通過密鑰生成器和keyMaterialBlob生成256位長度的對稱密鑰
let keyMaterialBlob = this.genKeyMaterialBlob(CommonConstants.KEY_DATA);
symKeyGenerator.convertKey(keyMaterialBlob, (err, symKey) = > {
if (err) {
Logger.error(`Convert symKey failed, ${err.code}, ${err.message}`);
return;
}
this.globalKey = symKey;
let cipherAlgName = CommonConstants.GENERATOR_NAME;
try {
// 生成加解密生成器
this.globalCipher = cryptoFramework.createCipher(cipherAlgName);
} catch (error) {
Logger.error(`createCipher failed, error is ${JSON.stringify(err)}`);
}
});
}
// 加密
async encrypt(content: string, authTag: string): Promise< string > {
...
}
// 解密
async decrypt(content: string, authTag: string): Promise< string > {
...
}
}
密碼加密
由于加密算法采用GCM分組模式,在加密前需要獲取GCM模式加解密所需的參數(shù)GcmParamsSpec。依次生成長度為12字節(jié)、8字節(jié)、16字節(jié)的DataBlob類型的數(shù)據(jù),并封裝成GcmParamsSpec對象。
// AesUtil.ets
class AesUtil {
...
/**
* 獲取GCM分組加解密所需的參數(shù)
*
* @returns 返回加密所需參數(shù)的promise實例
*/
async genGcmParamsSpec(): Promise< cryptoFramework.GcmParamsSpec > {
let ivBlob: cryptoFramework.DataBlob = this.genKeyMaterialBlob(CommonConstants.GCM_IV_DATA);
let aadBlob: cryptoFramework.DataBlob = this.genKeyMaterialBlob(CommonConstants.GCM_AAD_DATA);
let tagBlob: cryptoFramework.DataBlob = this.genKeyMaterialBlob(CommonConstants.GCM_TAG_DATA);
let gcmParamsSpec: cryptoFramework.GcmParamsSpec = {
iv: ivBlob,
aad: aadBlob,
authTag: tagBlob,
algName: `GcmParamsSpec`
};
return gcmParamsSpec;
}
/**
* 根據(jù)數(shù)據(jù)組生成DataBlob類型的數(shù)據(jù)
*
* @param data 需要封裝的數(shù)據(jù)
* @returns Blob DataBlob類型的數(shù)據(jù)
*/
genKeyMaterialBlob(data: Array< number >): cryptoFramework.DataBlob {
let keyMaterial = new Uint8Array(data);
return { data: keyMaterial };
}
}
在AesUtil.ets的encrypt方法中實現(xiàn)密碼加密邏輯。由于本示例加密數(shù)據(jù)量較小,所以這里直接使用update一步完成加密操作。若數(shù)據(jù)量較大,可通過update方法分段加密。主要實現(xiàn)以下步驟:
- 調(diào)用Cipher的init方法初始化加密環(huán)境。設(shè)置mode為ENCRYPT_MODE,傳入密鑰和生成的gcmParams。
- 將用戶輸入的密碼轉(zhuǎn)換為Uint8Array數(shù)組,進而封裝成DataBlob對象。
- 將封裝好的plainTextBlob傳入update方法中完成加密。
- 調(diào)用doFinal方法,傳入null,取出加密后的認證信息authTag。
- 取出Uint8Array類型的加密數(shù)據(jù)和authTag,轉(zhuǎn)換成Base64類型的字符串,封裝成User類型返回。
// AesUtil.ets
class AesUtil {
...
/**
* 加密
*
* @param content 加密內(nèi)容
* @returns 返回攜帶密文User對象的promise實例
*/
async encrypt(content: string): Promise< User > {
// 初始化加密環(huán)境
let mode = cryptoFramework.CryptoMode.ENCRYPT_MODE;
let gcmParams = await this.genGcmParamsSpec();
await this.globalCipher.init(mode, this.globalKey, gcmParams);
let plainTextBlob = {
// 字符串轉(zhuǎn)Uint8Array
data: DataTransformUtil.stringToUint8Array(content)
};
// 加密
let updateOutput: cryptoFramework.DataBlob = await this.globalCipher.update(plainTextBlob);
if (!updateOutput) {
return Promise.reject('encrypt updateOutput is null');
}
let authTag: cryptoFramework.DataBlob = await this.globalCipher.doFinal(null);
// Uint8Array轉(zhuǎn)base64
let encryptContent: string = DataTransformUtil.uint8ArrayToBase64(updateOutput.data);
let authTagContent: string = DataTransformUtil.uint8ArrayToBase64(authTag.data);
let user = new User(null, ``, encryptContent, authTagContent);
return user;
}
}
密碼解密
解密操作與加密類似,主要實現(xiàn)以下步驟:
- 調(diào)用Cipher的init方法初始化解密環(huán)境,設(shè)置mode為DECRYPT_MODE,傳入攜帶authTag認證信息的gcmParams。
- 將Base64類型密文轉(zhuǎn)換為Uint8Array數(shù)組,進而封裝成DataBlob對象。
- 將封裝好的plainTextBlob傳入doFinal方法中完成解密。
- 取出Uint8Array類型的解密數(shù)據(jù),轉(zhuǎn)換成字符串并返回。
// AesUtil.ets
class AesUtil {
...
/**
* 解密
*
* @param content 解密內(nèi)容
* @param authTag GCM 解密所需認證信息內(nèi)容
* @returns 返回解密內(nèi)容的promise實例
*/
async decrypt(content: string, authTag: string): Promise< string > {
// 初始化解密環(huán)境
let mode = cryptoFramework.CryptoMode.DECRYPT_MODE;
let gcmParams = await this.genGcmParamsSpec();
let authTagBlob: cryptoFramework.DataBlob = {
data: DataTransformUtil.base64ToUint8Array(authTag)
};
gcmParams.authTag = authTagBlob;
await this.globalCipher.init(mode, this.globalKey, gcmParams);
let plainTextBlob: cryptoFramework.DataBlob = {
// base64轉(zhuǎn)Uint8Array
data: DataTransformUtil.base64ToUint8Array(content)
};
// 解密
let finalOutput: cryptoFramework.DataBlob = await this.globalCipher.doFinal(plainTextBlob);
if (!finalOutput) {
return Promise.reject('decrypt finalOutput is null');
}
// Uint8Array轉(zhuǎn)字符串
let decryptContent = DataTransformUtil.uint8ArrayToString(finalOutput.data);
return decryptContent;
}
}
審核編輯 黃宇
-
字符串
+關(guān)注
關(guān)注
1文章
566瀏覽量
20389 -
鴻蒙
+關(guān)注
關(guān)注
56文章
2271瀏覽量
42508 -
HarmonyOS
+關(guān)注
關(guān)注
79文章
1949瀏覽量
29758 -
OpenHarmony
+關(guān)注
關(guān)注
25文章
3555瀏覽量
15776
發(fā)布評論請先 登錄
相關(guān)推薦
評論