SIMKEY 开放平台

# U盾信息

# 读取公钥

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾ID
containerId string 容器ID
isSign boolean true签名公钥, false加密公钥
  1. 返回结果:
参数 数据类型 说明 备注
publicKeyInfo string 公钥
  1. 示例
simkey.sdk.getPublicKey({
   data: {
       uKeyId: "",
       containerId: "",
       isSign: true
   },
   success(res) {
       console.log("读取公钥", res.data.publicKeyInfo)
   },
   fail(err) {
       console.log("错误信息: %o", err)
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13

# 导入证书

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾ID
containerId string 容器ID
isSign boolean true签名公钥, false加密公钥
certData boolean 证书数据（base64 无空格换行）
  1. 返回结果:
参数 数据类型 说明 备注
importFlag string 公钥
  1. 示例
simkey.sdk.importCert({
   data: {
       uKeyId: "",
       containerId: "",
       isSign: true,
       certData: ""
   },
   success(res) {
       console.log("导入证书结果", res.data.importFlag)
   },
   fail(err) {
       console.log("错误信息: %o", err)
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 导入加密密钥对

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾ID
containerId string 容器ID
asymmetricAlgFlag string 签名公钥加密算法标识 1:RSA_1024,2:RSA_2048,3:SM2,4:SM2_V2
symmetricAlgFlag string 对称密钥算法标识 1:RSA_1024,2:RSA_2048,3:SM2,4:SM2_V2
symmetricKeyEncBySignPubKey string 签名公钥加密的对称密钥(16进制)
publicKey string 加密密钥对公钥(16进制)
privateKeyEncBySymmetricKey string 对称密钥加密的加密私钥（16进制）
userPin string 用户PIN
  1. 返回结果:
参数 数据类型 说明 备注
importFlag string 导入结果
  1. 示例
simkey.sdk.importEncryptKeyPair({
   data: {
       uKeyId: '',
       containerId: '',
       asymmetricAlgFlag: '',
       symmetricAlgFlag: '',
       symmetricKeyEncBySignPubKey: '',
       publicKey: '',
       privateKeyEncBySymmetricKey: '',
       userPin: ''
   },
   success(res) {
       console.log("导入结果", res.data.importFlag)
   },
   fail(err) {
       console.log("错误信息: %o", err)
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 读取证书

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾ID
containerId string 容器ID
isSign boolean true签名证书, false加密证书
  1. 返回结果:
参数 数据类型 说明 备注
certInfo string 证书
  1. 示例
simkey.sdk.getCert({
   data: {
       uKeyId: "",
       containerId: "",
       isSign: true
   },
   success(res) {
       console.log("读取证书", res.data.certInfo)
   },
   fail(err) {
       console.log("错误信息: %o", err)
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13

# 验证PIN

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾Id
userPin string 用户PIN
  1. 返回结果:
参数 数据类型 说明 备注
verifyPinFlag boolean 验证结果
  1. 示例
simkey.sdk.verifyPin({
   data: {
       uKeyId: "",
       userPin: ""
   },
   success(res) {
       console.log("校验成功", res.data.verifyPinFlag)
   },
   fail(err) {
       console.log("错误信息: %o", err)
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13

# 修改PIN

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾Id
newUserPin string 用户新PIN
  1. 返回结果:
参数 数据类型 说明 备注
changePinFlag boolean 修改结果
  1. 示例
simkey.sdk.changePin({
   data: {
       uKeyId: '',
       newUserPin: ''
   },
   success(res) {
       console.log("修改结果", res.data.changePinFlag)
   },
   fail(err) {
       console.log("错误信息: %o", err)
   }
});
1
2
3
4
5
6
7
8
9
10
11
12
13

# 私钥签名

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾Id
containerId string 容器Id
userPin string 用户PIN
dataHash string 签名数据hash
hashAlgorithm string 签名算法（MD5、SHA1、SM3、SHA256）
algFlag string 签名算法标识 1:RSA_1024,2:RSA_2048,3:SM2,4:SM2_V2
  1. 返回结果:
参数 数据类型 说明 备注
signHash string 签名后的16进制数据
  1. 示例
simkey.sdk.privateKeySignHash({
    data: {
        uKeyId: "",
        containerId: "",
        dataHash: "",
        userPin: "",
        hashAlgorithm: "",
        algFlag: ""
    },
    success(res) {
        console.log("签名值：", res.data.signHash)
    },
    fail(err) {
        console.log("错误信息: %o", err)
    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 私钥解密

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾Id
containerId string 容器Id
userPin string 用户PIN
cipherData string 待解密数据
isSign string true:签名私钥; false:加密私钥
asymmetricAlgFlag string 非对称算法标示 1: RSA1024 2: RSA2048 3:SM2
  1. 返回结果:
参数 数据类型 说明 备注
decryptInfo string 私钥解密后数据
  1. 示例
simkey.sdk.privateKeyDecrypt({
    data: {
        uKeyId: "",
        containerId: "",
        userPin: "",
        cipherData: "",
        isSign: "",
        asymmetricAlgFlag: ""
    },
    success(res) {
        console.log("私钥解密后数据：", res.data.decryptInfo)
    },
    fail(err) {
        console.log("错误信息: %o", err)
    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 生成p10格式的证书签名请求CSR

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾Id
containerId string 容器Id
userPin string 用户PIN
hashAlgFlag string 哈希算法标示 5: sha1 7: sm3 8: sha-256
asymmetricAlgFlag string 非对称算法标示 1: RSA1024 2: RSA2048 3:SM2
subject string 用户信息, 样例参考下面的例子"CN=SimkeyTest, OU=Simkey Dept, O=Simkey Dept OU, L=NanJing, ST=JiangSu, C=CN"
  1. 返回结果:
参数 数据类型 说明 备注
CSR string 申请证书P10格式数据（base64格式）
  1. 示例
simkey.sdk.createCSR({
    data: {
        uKeyId: '',
        containerId: '',
        userPin: '',
        hashAlgFlag: '',
        asymmetricAlgFlag: '',
        subject: ''
    },
    success(res) {
        console.log("申请证书P10格式数据：", res.data.CSR)
    },
    fail(err) {
        console.log("错误信息: %o", err)
    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 获取hash值

  1. 参数:
参数 数据类型 说明 备注
uKeyId string U盾ID
containerId string 容器ID
hashAlgFlag string 哈希算法标示 5: sha1 7: sm3 8: sha-256
sourceData string 源数据(Base64 无空格换行)
  1. 返回结果:
参数 数据类型 说明 备注
hashData string hash值
  1. 示例
simkey.service.getHash({
    data: {
        uKeyId: '',
        containerId: '',
        hashAlgFlag: '',
        sourceData: '',
    },
    success(res) {
        console.log("获取hash值:", res.data.hashData);
    },
    fail(err) {
        console.log("错误信息: %o", err);
    }
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14

← 密码模块 →