1. HTTPS 数字证书简介
数字证书是网络安全的重要基础,它通过数字签名来保证数据的完整性和真实性。HTTPS 协议通过数字证书来保证通信的安全性,数字证书由数字证书机构(CA)颁发,购买商业版本的数字证书需要不菲的费用,周期也较长,在系统的开发和测试期间,可以使用自签名的数字证书,这种方式方便快速,也不需要费用,在系统正式部署以后,可以切换为正式的证书。
鸿蒙的 httpRequest 类支持配置自定义的 CA 证书,通过配置 CA 证书,可以不使用系统 CA 证书进行校验,从而实现对 HTTPS 证书的自选 CA 校验。在本系列的第 26 篇文章《鸿蒙网络编程系列 26-HTTPS 证书自选 CA 校验示例》中,使用 ArkTS 语言实现了自选 CA 校验,本节将使用仓颉语言实现类似的功能。
2. 仓颉版 HTTPS 证书自选 CA 校验演示
本示例运行后的页面如图所示:
选择系统 CA 校验模式,然后输入请求的地址,这个地址对应的服务器使用的是自签名证书,然后单击“请求”按钮,结果如图所示:
可以看到,请求是失败的,因为服务器使用的是自签名证书,而系统 CA 证书校验模式下,使用系统自带的 CA 证书对服务器证书进行校验,所以请求失败。
接下来选择自选 CA 校验模式,再单击“选择”按钮,选择服务器自签名证书对应的 CA 证书,如图所示:
单击“完成”按钮回到主界面,然后单击“请求”按钮,结果如图所示:
可以看到,这次请求成功,因为使用的是自选 CA 证书进行校验,CA 证书是服务器自签名证书对应的,所以请求成功。
3. 仓颉版 HTTPS 证书自选 CA 校验示例编写
下面详细介绍创建该示例的步骤(确保 DevEco Studio 已安装仓颉插件)。
步骤 1:创建[Cangjie]Empty Ability 项目。
步骤 2:在 module.json5 配置文件加上对权限的声明:
"requestPermissions": [
{
"name": "ohos.permission.INTERNET"
}
]
复制代码
这里添加了访问互联网的权限。
步骤 3:在 build-profile.json5 配置文件加上仓颉编译架构:
"cangjieOptions": {
"path": "./src/main/cangjie/cjpm.toml",
"abiFilters": ["arm64-v8a", "x86_64"]
}
复制代码
步骤 4:在 main_ability.cj 文件里添加如下的引用:
然后定义变量 globalContext:
var globalContext: Option<AbilityContext> = Option<AbilityContext>.None
复制代码
在 onCreate 函数里添加如下的代码:
globalContext = this.context
复制代码
步骤 5:在 index.cj 文件里添加如下的代码:
package ohos_app_cangjie_entry
import ohos.base.*
import ohos.component.*
import ohos.state_manage.*
import ohos.state_macro_manage.*
import std.collection.HashMap
import ohos.net.http.*
import ohos.file_picker.*
import ohos.ability.getStageContext
import ohos.ability.*
import ohos.file_fs.*
import std.time.DateTime
@Entry
@Component
class EntryView {
@State
var title: String = '仓颉版服务端证书CA校验方式示例';
//连接、通讯历史记录
@State
var msgHistory: String = ''
//请求的HTTPS地址
@State
var httpsUrl: String = ""
//服务端证书验证模式,默认系统CA
@State
var certVerifyType = 0
//是否显示选择CA的组件
@State
var selectCaShow: Visibility = Visibility.None
//是否选择了CA证书
@State
var isCaSelected: Bool = false
//选择的ca文件
@State
var caFileUri: String = ''
let scroller: Scroller = Scroller()
func build() {
Row {
Column {
Text(title).fontSize(14).fontWeight(FontWeight.Bold).width(100.percent).textAlign(TextAlign.Center).
padding(10)
Flex(FlexParams(justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center)) {
Column() {
Text("证书校验模式:").fontSize(14).width(120)
}
Column() {
Text("系统CA:").fontSize(14)
Radio(value: "0", group: 'rgVerify').checked(true).height(30).width(30).onChange(
{
isChecked => if (isChecked) {
this.certVerifyType = 0
}
})
}.width(100)
Column() {
Text("自选CA:").fontSize(14)
Radio(value: "1", group: 'rgVerify').checked(false).height(30).width(30).onChange(
{
isChecked => if (isChecked) {
this.certVerifyType = 1
}
})
}.width(100)
}.width(100.percent).padding(10)
Flex(FlexParams(justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center)) {
Text("服务端证书CA:").fontSize(14).flexGrow(1)
Button("选择").onClick {
evt => selectCaFile()
}.width(70).fontSize(14)
}.width(100.percent).padding(10).visibility(
if (certVerifyType == 1) {
Visibility.Visible
} else {
Visibility.None
})
Text(caFileUri).fontSize(11).width(100.percent).padding(10).visibility(
if (certVerifyType == 1) {
Visibility.Visible
} else {
Visibility.None
})
Flex(FlexParams(justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center)) {
Text("请求地址:").fontSize(14)
TextInput(text: httpsUrl).onChange({
value => httpsUrl = value
}).width(100).fontSize(11).flexGrow(1)
Button("请求").onClick {
evt => doHttpsRequest()
}.width(70).fontSize(14).flexGrow(0)
}.width(100.percent).padding(10)
Scroll(scroller) {
Text(msgHistory).textAlign(TextAlign.Start).padding(10).width(100.percent).backgroundColor(0xeeeeee)
}.align(Alignment.Top).backgroundColor(0xeeeeee).height(300).flexGrow(1).scrollable(
ScrollDirection.Vertical).scrollBar(BarState.On).scrollBarWidth(20)
}.width(100.percent).height(100.percent)
}.height(100.percent)
}
//选择自定义CA文件
func selectCaFile() {
let option = DocumentSelectOptions(maxSelectNumber: 1, selectMode: DocumentSelectMode.MIXED)
let documentPicker = DocumentViewPicker(globalContext.getOrThrow())
let documentSelectCallback = {
errorCode: Option<AsyncError>, data: Option<Array<String>> => match (errorCode) {
case Some(e) => msgHistory += "选择失败,错误码:${e.code}\r\n"
case _ => match (data) {
case Some(value) => this.caFileUri = value[0]
case _ => ()
}
}
}
documentPicker.select(documentSelectCallback, option: option)
}
//发起http请求
func doHttpsRequest() {
//http请求对象
let httpRequest = createHttp();
//请求配置
var opt = HttpRequestOptions(
method: RequestMethod.GET,
expectDataType: HttpDataType.STRING,
//如果选择自定义CA,就复制选择的文件到沙箱并返回沙箱路径,否则返回None
caPath: if (this.certVerifyType == 1) {
copy2SandboxDir(globalContext.getOrThrow(), this.caFileUri, getFileNameFromPath(this.caFileUri))
} else {
None
}
)
httpRequest.request(httpsUrl, httpsResponse, options: opt)
}
//Https请求的响应函数
func httpsResponse(err: ?BusinessException, response: ?HttpResponse) {
if (let Some(e) <- err) {
msgHistory += "请求失败:" + e.message + "\r\n"
}
if (let Some(resp) <- response) {
msgHistory += "响应码:${resp.responseCode.getValue()}\r\n"
msgHistory += resp.result.toString() + "\r\n"
}
}
public func getFileNameFromPath(filePath: String) {
let segments = filePath.split('/')
//文件名称
return segments[segments.size - 1]
}
//从文件读取二进制内容
public func readArrayBufferContentFromFile(fileUri: String) {
let file = FileFs.open(fileUri, mode: READ_ONLY.mode);
let fsStat = FileFs.stat(file.fd);
let buf = Array<UInt8>(fsStat.size, item: 0);
FileFs.read(file.fd, buf)
FileFs.fsync(file.fd)
FileFs.close(file);
return buf
}
//复制文件到沙箱目录
public func copy2SandboxDir(context: AbilityContext, srcUri: String, fileName: String): String {
//计划复制到的目标路径
let realUri = context.filesDir + "/" + fileName
let file = FileFs.open(srcUri);
FileFs.copyFile(file.fd, realUri)
FileFs.close(file)
return realUri
}
}
复制代码
步骤 6:编译运行,可以使用模拟器或者真机,在当前版本下,最好使用真机,笔者使用模拟器的文件选择窗口时有些显示问题。
步骤 7:按照本节第 2 部分“仓颉版 HTTPS 证书自选 CA 校验演示”操作即可。
4. 代码分析
本示例的关键在于用户证书和签名 CA 证书的匹配,必须确保用户证书是由指定的 CA 证书签名的,否则将无法通过证书校验。另外,因为文件访问权限的原因,需要将证书文件复制到沙箱目录,再通过沙箱目录的路径进行访问,复制到沙箱路径是由 copy2SandboxDir 函数实现的。
(本文作者原创,除非明确授权禁止转载)
本文源码地址:
https://gitee.com/zl3624/harmonyos_network_samples/tree/master/code/http/HttpsRequestDemo4Cj
本系列源码地址:
https://gitee.com/zl3624/harmonyos_network_samples
评论