szcaSDK

sofRequestCert sofGetCertBase64 sofSignDataByP1 sofSignDataByP7Attach sofGenRandom sofGetCertInfo

概述

szcaSDK封装了移动安全中间件对于证书的获取和数据的验签

使用此模块之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：szca
  • 参数：license、CAServerUrl、CACertificateUrl、certSource、keyType
  • 配置示例:

  • 字段描述:

    license：（必须配置）证书码。（需要应用的签名和包名）

    CAServerUrl：（必须配置）证书源的通信地址。

    CACertificateUrl：（必须配置）证书有效性查询地址

    certSource：证书源。

    keyType：（必须配置）密钥类型，“RSA”或是“SM2”

    注：license，CAServerUrl和CACertificateUrl的获取可通过电话咨询韩先生：135-0152-9815

sofInitialize

初始化

sofInitialize({params},function(ret, err))

account：

  • 类型：字符串
  • 描述：账号。

password：

  • 类型：字符串
  • 描述：密码

function(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  2.     status: true      //布尔型；true||false
  3.     msg: 返回初始化成功信息
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status: false     
  3.     msg: 返回失败信息
  4. }

示例代码

  1. var szcaSDK = api.require('szcaSDK');//需要先引入模块
  2. var param = {
  3.         account: accountValue,
  4.         password: passwordValue
  5.     }
  6.     //初始化证书
  7.     szcaSDK.sofInitialize(param, function (ret, err) {
  8.         if (ret.status) {
  9.             alert(ret.msg);
  10.         } else {
  11.             alert(err.msg);
  12.         }
  13.     };

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofRequestCert

下载证书

sofRequestCert({params} , function (ret, err))

params

authCode：

  • 类型：字符串
  • 描述：授权码

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg: 返回证书获取成功信息
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg: 返回证书获取失败信息
  4. }

示例代码

  1.  szcaSDK.sofRequestCert({
  2.    authCode:'155211949017037963' 
  3.  } , function (ret, err) {
  4.                         if (ret.status) {
  5.                             alert(ret.msg);
  6.                         } else {
  7.                             alert(err.msg);
  8.                         }
  9.                     });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofGetCertSerialNo

获取用户证书的序列号

sofGetCertSerialNo(function (ret, err))

function(ret, err)

ret：

  • 类型：JSON对象
  1. {
  2.    status:true
  3.    msg:获取序列号成功
  4.    certSerialNo:xxxxxxxxxxx
  5. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     status:false
  3.     msg:获取序列号失败
  4. }

示例代码

  1. szcaSDK.sofGetCertSerialNo(function (ret, err) {
  2.     if(ret.status){
  3.         alert(ret.certSerialNo);
  4.     }else{
  5.         alert(err.msg);
  6.     }
  7. });

可用性

Android系统

sofGetCertBase64

获取证书

sofGetCertBase64({params},function (ret, err))

params

certType:

  • 类型：整型
  • 描述：证书类型 1:签名证书 2:加密证书

function (ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg:获取用户证书成功
  4.    certBase64:xxxxxxxxxxx
  5. }

err：

  • 类型：JSON对象
  • 内部字段：

示例代码

  1. szcaSDK.sofGetCertBase64(function (ret, err) {
  2.         if(ret.status){
  3.             alert(ret.certBase64);
  4.         }else{
  5.             alert(err.msg);
  6.         }
  7.     });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofValidataCertificate

查询证书有效性

sofValidataCertificate(param, function (ret, err))

certSn：

  • 类型：字符串
  • 描述：用户证书序列号

function(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg:证书有效

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg:证书已过期
  4. }

示例代码

  1. var param = {
  2.                 certSn: certSerialNo
  3.             }
  4.             szcaSDK.sofValidataCertificate(param, function (ret, err) {
  5.                 if (ret.status) {
  6.                     alert(ret.msg);
  7.                 } else {
  8.                     alert(err.msg);
  9.                 }
  10.             });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofSignDataByP1

P1签名

sofSignDataByP1(param, function (ret, err))

params

srcStr：

  • 类型：字符串
  • 描述：要签名的源数据

function (ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1.  {
  2.    status:true
  3.    msg:返回签名成功信息
  4.    signature:xxxxxx   //签名后的数据
  5. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg:返回签名失败信息
  4. }

示例代码

  1. var param = {
  2.         srcStr: srcOriginData
  3.     }
  4. //P1格式签名
  5. szcaSDK.sofSignDataByP1(param, function (ret, err) {
  6.     if(ret.status){
  7.         signData = ret.signature;
  8.         alert(ret.signature);
  9.     }else{
  10.         alert(err.msg);
  11.     }
  12. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofVerifySignedDataByP1

P1格式验签

sofVerifySignedDataByP1(param, function (ret, err))

params

signature：

  • 类型：字符串
  • 描述：P1签名后的数据

srcStr

  • 类型：字符串
  • 描述：要验签的原始数据

certBase64

  • 类型：字符串
  • 描述：证书base64（本地验签可不传）

function(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg:返回验签成功信息
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg:返回验签失败信息
  4. }

示例代码

  1. var param = {
  2.         signature: signData,
  3.         srcStr: srcOriginData
  4.     }
  6. //P1格式验签
  7. szcaSDK.sofVerifySignedDataByP1(param,
  8.     function (ret, err) {
  9.             alert(ret.msg);
  10.         }else{
  11.             alert(err.msg);
  12.         }
  14.     });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofSignDataByP7Attach

sofSignDataByP7Attach(param, function (ret, err))

params

srcStr：

  • 类型：字符串
  • 描述：原始数据

detach：

  • 类型：布尔值
  • 描述：签名里是否带原文（iOS需要传，Android不需要，Android默认不带原文）

function (ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg:返回签名失败信息
  4. }
  1. var param = {
  2.         srcStr: srcOriginData
  3.         detach：true
  4.     }
  6. //P7格式签名
  8.     if(ret.status){
  9.         signData = ret.signature;
  10.         alert(ret.signature);
  11.     }else{
  12.         alert(err.msg);
  13.     }
  14. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofVerifySignedDataByP7Attach

P7格式验签

sofVerifySignedDataByP7Attach(param, function (ret, err))

params

signature：

  • 类型：字符串
  • 描述：P7签名后的数据

srcStr：

  • 类型：字符串
  • 描述：原文（iOS需要传，Android不需要）

function(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg:返回验签成功信息
  4. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg:返回验签失败信息
  4. }

示例代码

  1. var param = {
  2.         signDataBase64: signData,
  3.         srcStr:'深圳CA' //iOS需要传，Android不需要
  4.     }
  6. //P1格式验签
  7. szcaSDK.sofVerifySignedDataByP7Attach(param,
  8.     function (ret, err) {
  9.         if(ret.status){
  10.             alert(ret.msg);
  11.         }else{
  12.             alert(err.msg);
  13.         }
  14.     });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofGenRandom

生成随机数

sofGenRandom(function (ret, err))

function (ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg:返回生成随机数成功信息
  4.    random:xxxxxx
  5. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:false
  3.    msg:返回生成随机数失败信息
  4. }

示例代码

  1.  szcaSDK.sofGenRandom(
  2.                 function (ret, err) {
  3.                     if (ret.status) {
  4.                         alert(ret.random);
  5.                     } else {
  6.                         alert(err.msg);
  7.                     }
  8.                 });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sofWipeData

清空内存数据

sofWipeData()

示例代码

  1.  sofWipeData();

可用性

iOS系统

可提供的1.0.0及更高版本

sofGetCertInfo

获取用户证书信息

sofGetCertInfo(params , function (ret, err))

params

certBase64：

  • 类型：字符串
  • 描述：获取证书Base64

function(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.    status:true
  3.    msg:获取序列号成功
  4.    serialNum:xxxxxxxxxxx //证书序列号
  5.    subject:xxxxx //申请人主题
  6.    version:xxxx //版本
  7.    subjectName:xxxx //申请人名称
  8.    issure:xxxx //颁发机构主题
  9.    issureName:xxxxx //颁发机构名称
  10.    beforeTime:xxxx //有效期起始时间
  11.    afterTime:xxxx //有效期结束时间
  12.    algorithm:xxxx //证书算法
  13. }

err：

  • 类型：JSON对象
  • 内部字段：

示例代码

  1. szcaSDK.sofGetCertInfo({
  2.         certBase64: certBase64Srting
  3.     },function(ret,err) {
  4.         if (ret.status) {
  5.             alert('证书申请人主题主题：' + ret.subject + '证书序列号：' + ret.serialNum);
  6.             certSnNum = ret.serialNum;
  7.         } else {
  8.             alert(ret.msg);
  10.     });

可提供的1.0.0及更高版本