gws-client
Advanced tools
用于web前端调用GZCA数字证书客户端UKEY证书应用接口，调用前需确保已安装GZCA数字证书客户端并启动，支持TypeScript。
Install with npm
npm install gws-client --save
Install with yarn
yarn add gws-client
Install with pnpm
pnpm add gws-client
使用包管理器
import { GwsService } from "gws-client";
const gwsService = new GwsService(gwsServiceConfig);
import { createService } from "gws-client";
async function foo() {
const gwsService = await createService(gwsServiceConfig);
}
使用本地文件
import { GwsService } from "./index.es.js"; // SDK文件地址
const gwsService = new GwsService(gwsServiceConfig);
import { createService } from "./index.es.js"; // SDK文件地址
async function foo() {
const gwsService = await createService(gwsServiceConfig);
}
<script src="./index.umd.js"></script>
const gwsService = new GWS_CLIENT.GwsService(gwsServiceConfig);
async function foo() {
const gwsService = await GWS_CLIENT.createService(gwsServiceConfig);
}
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| isRememberPin | 可选，是否记住pin码 | Boolean | false |
| pinPolicy | 可选，口令安全策略 | 0 | 1| 2| 3 | 0 |
| onOpen | 可选，socket连接成功回调 | (event: Event) => void | -- |
| onError | 可选，socket错误时回调 | (event: Event) => void | -- |
| onClose | 可选，socket关闭时回调 | (event: Event) => void | -- |
| onMessage | 可选，socket收到消息时回调 | (data: Record<string, any>) => void | -- |
| onUkeyChange | 可选，Ukey插入拔出时回调 | (event: {type: 'remove' | 'insert', data: CertType}) => void | -- |
| theme | 可选，弹窗主题色 | String | #409eff |
链式调用
// PKCS1签名
import { createService } from "gws-client";
function pkcs1Sign() {
createService(gwsServiceConfig).then((gwsService) => {
gwsService
.pkcs1Sign({ Data: "hello world" })
.then((res) => {
console.log("签名值", res);
})
.catch((error) => {
console.log("签名失败原因", error);
});
});
}
同步调用
// PKCS1签名
import { createService } from "gws-client";
async function pkcs1Sign() {
try {
const gwsService = await createService();
const res = await gwsService.pkcs1Sign({ Data: "hello world" });
console.log("签名值", res);
} catch (error) {
console.log("签名失败原因", error);
}
}
断开socket连接
destroy
type Destroy = () => void;
重新连接socket，可重新传入新配置
restart
type Restart = (config?: GwsServiceConfigType) => void;
获取签名证书，可获取证书CN项，证书CertB64，sn
getSignatureCert
type GetSignatureCert = (cert?: CertType) => Promise<CertType>;
获取签名证书列表
getSignatureCertList
type GetSignatureCertList = () => Promise<CertType[]>;
获取加密证书，可获取证书CN项，证书CertB64，sn
getEncryptionCert
type GetEncryptionCert = (cert?: CertType) => Promise<CertType>;
获取加密证书列表
getEncryptionCertList
type GetEncryptionCertList = () => Promise<CertType[]>;
获取证书详情，可获取证书公钥CertPublicKey，证书序列号CertSerial，证书有效期CertValidTime
getCertInfo
type GetCertInfo = (params: {
CertB64: string;
}) => Promise<Record<string, unknow>>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| CertB64 | 必填，证书Base64 | String | -- |
PKCS1签名，返回签名值
pkcs1Sign
type Pkcs1Sign = (
params: { Data: string; IsLogin?: string },
curCert?: CertType
) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待签名原文 | String | -- |
| IsLogin | 可选，证书登录状态 | Y | N | -- |
PKCS1验签，传入curCert时使用该证书，返回验签结果，true为验签成功，验签失败时返回Promise.reject
pkcs1VerifySignature
type Pkcs1VerifySignature = (
params: {
CertB64?: string;
Data: string;
SignData: string;
},
curCert?: CertType
) => Promise<boolean>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待签名原文 | String | -- |
| SignData | 必填，Base64编码的签名值 | String | -- |
| CertB64 | 可选，Base64编码的签名证书 | String | -- |
PKCS1 base64签名，传入curCert时使用该证书，返回签名值
pkcs1Base64Sign
type Pkcs1Base64Sign = (params: {
Data?: string;
DataB64?: string;
IsLogin?: string;
}) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 与DataB64二选一，待签名原文 | String | -- |
| DataB64 | 与Data二选一 ， Base64编码的待签名原文，同时存在时使用DataB64 | String | -- |
| IsLogin | 可选，证书登录状态 | Y | N | -- |
PKCS1 base64验签，返回验签结果，true为验签成功，验签失败时返回Promise.reject
pkcs1Base64VerifySignature
type Pkcs1Base64VerifySignature = (params: {
Data?: string;
DataB64?: string;
SignData: string;
CertB64?: string;
}) => Promise<boolean>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 与DataB64二选一，待签名原文 | String | -- |
| DataB64 | 与Data二选一 ， Base64编码的待签名原文，同时存在时使用DataB64 | String | -- |
| SignData | 必填，Base64编码的签名值 | String | -- |
| CertB64 | 可选，Base64编码的签名证书 | String | -- |
PKCS1哈希签名，返回签名值
pkcs1HashSign
type Pkcs1HashSign = (
params: {
DataB64: string;
HashAlg?: string;
IsLogin?: string；
},
curCert?: CertType
) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| DataB64 | 必填，Base64编码带签名原文的预处理哈希 | String | -- |
| HashAlg | 可选，哈希算法 | sm3 | sha1| sha256 | sm3 |
| IsLogin | 可选，证书登录状态 | Y | N | -- |
PKCS1哈希验签，返回验签结果，传入curCert时使用该证书，true为验签成功，验签失败时返回Promise.reject
pkcs1Base64VerifySignature
type Pkcs1Base64VerifySignature = (params: {
DataB64: string;
SignData: string;
CertB64?: string;
HashAlg?: string;
}) => Promise<boolean>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| DataB64 | 必填，Base64编码的待签名的原文预处理哈希 | String | -- |
| SignData | 必填，签名值 | String | -- |
| CertB64 | 可选，Base64编码的签名证书 | String | -- |
| HashAlg | 可选，哈希算法 | sm3 | sha1| sha256 | sm3 |
PKCS7签名，返回签名值
pkcs7Sign
type Pkcs7Sign = (
params: {
Data?: string;
DataB64?: string;
IsDetached: string;
IsLogin?: string;
},
curCert?: CertType
) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 与DataB64二选一，待签名原文 | String | -- |
| DataB64 | 与Data二选一 ， Base64编码的待签名原文，同时存在时使用DataB64 | String | -- |
| IsDetached | 必填，Y为detach，N为attach，attach模式签名值带了原文 | Y | N | -- |
| IsLogin | 可选，证书登录状态 | Y | N | -- |
PKCS7验签，返回验签结果，传入curCert时使用该证书，true为验签成功，验签失败时返回Promise.reject
pkcs7VerifySignature
type Pkcs7VerifySignature = (params: {
Data?: string;
DataB64?: string;
SignData: string;
}) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 与DataB64二选一，待签名原文 | String | -- |
| DataB64 | 与Data二选一 ， Base64编码的待签名原文，同时存在时使用DataB64 | String | -- |
| SignData | 必填，签名值 | String | -- |
base64编码，返回base64编码内容
base64Encode
type Base64Encode = (params: { Data: string }) => string;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，base64待编码内容 | String | -- |
base64解码，返回base64解码内容
base64Decode
type Base64Decode = (params: { DataB64: string }) => string;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| DataB64 | 必填，base64待解码内容 | String | -- |
SM3哈希，返回SM3哈希值
sm3Hash
type Sm3Hash = (params: { Data: string }) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待计算杂凑值的原文 | String | -- |
SM3 B64哈希
sm3HexHash
type Sm3HexHash = (params: { DataB64: string }) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| DataB64 | 必填，待计算杂凑值的原文base64 | String | -- |
SM3 文件哈希
sm3FileHash
type Sm3FileHash = (params: { SrcFile: string }) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| SrcFile | 必填，待计算杂凑值的本地文件全路径。建议使用正斜杠（/） | String | -- |
SM3哈希加密
sm3HashEncryption
type Sm3HashEncryption = (params: {
Data?: string;
DataB64?: string;
Key?: string;
KeyB64?: string;
}) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 与DataB64二选一，待加密原文 | String | -- |
| DataB64 | 与Data二选一 ， Base64编码的待加密原文，同时存在时使用DataB64 | String | -- |
| Key | 与KeyB64二选一，密钥 | String | -- |
| KeyB64 | 与Key二选一 ， base64编码的密钥，同时存在时使用KeyB64 | String | -- |
PKCS7加密，返回加密字符串
pkcs7Encryption
type Pkcs7Encryption = (params: {
Data?: string;
DataB64?: string;
Key: string;
}) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 与DataB64二选一，待加密原文 | String | -- |
| DataB64 | 与Data二选一 ， Base64编码的待加密原文，同时存在时使用DataB64 | String | -- |
| CertB64List | 必填，加密证书base64，多个以|连接 | String | -- |
PKCS7解密，返回解密字符串
pkcs7Decryption
type Pkcs7Decryption = (params: {
DataB64: string;
shouldDecodeBase64?: boolean;
IsLogin?: string;
}) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| DataB64 | 必填，待解密原文 | String | -- |
| shouldDecodeBase64 | 可选，是否需要base64解码 | Boolean | -- |
| IsLogin | 可选，证书登录状态 | Y | N | -- |
非对称加密，返回加密字符串
asymmetricDecryption
type AsymmetricDecryption = (params: { Data: string；IsLogin?: string }) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待解密原文 | String | -- |
| CertB64 | 可选，加密证书B64 | String | -- |
| IsLogin | 可选，证书登录状态 | Y | N | -- |
非对称解密，返回解密字符串
asymmetricDecryption
type AsymmetricDecryption = (
params: { Data: string },
curCert?: CertType
) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待解密原文 | String | -- |
SM4对称加密，传入curCert时使用该证书，返回加密字符串，加密密钥
sm4Encryption
type Sm4Encryption = (params: {
Data: string;
}) => Promise<{ Data: string; KeyB64: string }>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待加密原文 | String | -- |
| 属性 | 说明 | 类型 |
|---|---|---|
| Data | 加密密文 | String |
| KeyB64 | Base64对称密钥 | String |
SM4对称解密，返回解密字符串
sm4Decryption
type Sm4Decryption = (params: {
Data: string;
KeyB64: string;
}) => Promise<string>;
| 属性 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| Data | 必填，待解密原文 | String | -- |
| KeyB64 | 必填，Base64对称密钥 | String | -- |
获取印章列表，传入curCert时使用该证书，可获取印章SealId
getSealList
type getSealList = (
curCert?: CertType
) => Promise<{ cert: CertType; sealList: SealType[] }>;
FAQs
gws client
We found that gws-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Former RubyGems maintainers have launched The Gem Cooperative, a new community-run project aimed at rebuilding open governance in the Ruby ecosystem.
Security News
An opt-in lazy import keyword aims to speed up Python startups, especially CLIs, without the ecosystem-wide risks that sank PEP 690.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.