@maiyunnet/kebab 7.6.0 → 7.6.1

package/doc/sc/api/lib/crypto/functions/generateKeyPair.md

@@ -0,0 +1,61 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / generateKeyPair
+
+# Function: generateKeyPair()
+
+> **generateKeyPair**(`type`, `options`): `Promise`\<\{ `private`: `string` \| `Buffer`\<`ArrayBufferLike`\>; `public`: `string` \| `Buffer`\<`ArrayBufferLike`\>; \}\>
+
+Defined in: [lib/crypto.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L18)
+
+创建非对称秘钥
+
+## Parameters
+
+### type
+
+`string`
+
+如 rsa/ec
+
+### options
+
+参数
+
+#### modulusLength?
+
+`number`
+
+#### namedCurve?
+
+`string`
+
+#### privateKeyEncoding?
+
+\{ `format?`: `"pem"` \| `"der"`; `type?`: `"pkcs8"` \| `"pkcs1"` \| `"sec1"`; \}
+
+#### privateKeyEncoding.format?
+
+`"pem"` \| `"der"`
+
+#### privateKeyEncoding.type?
+
+`"pkcs8"` \| `"pkcs1"` \| `"sec1"`
+
+#### publicKeyEncoding?
+
+\{ `format?`: `"pem"` \| `"der"`; `type?`: `"spki"` \| `"pkcs1"`; \}
+
+#### publicKeyEncoding.format?
+
+`"pem"` \| `"der"`
+
+#### publicKeyEncoding.type?
+
+`"spki"` \| `"pkcs1"`
+
+## Returns
+
+`Promise`\<\{ `private`: `string` \| `Buffer`\<`ArrayBufferLike`\>; `public`: `string` \| `Buffer`\<`ArrayBufferLike`\>; \}\>

package/doc/sc/api/lib/crypto/functions/hashHmac.md

@@ -0,0 +1,79 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / hashHmac
+
+# Function: hashHmac()
+
+## Call Signature
+
+> **hashHmac**(`algorithm`, `data`, `key?`, `format?`): `string`
+
+Defined in: [lib/crypto.ts:387](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L387)
+
+hash 或 hmac 加密
+
+### Parameters
+
+#### algorithm
+
+`string`
+
+哈希方式
+
+#### data
+
+源数据
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key?
+
+`CipherKey`
+
+设置则采用 hmac 加密
+
+#### format?
+
+`"hex"` | `"base64"`
+
+### Returns
+
+`string`
+
+## Call Signature
+
+> **hashHmac**(`algorithm`, `data`, `key`, `format`): `Buffer`
+
+Defined in: [lib/crypto.ts:388](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L388)
+
+hash 或 hmac 加密
+
+### Parameters
+
+#### algorithm
+
+`string`
+
+哈希方式
+
+#### data
+
+源数据
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+设置则采用 hmac 加密
+
+`CipherKey` | `undefined`
+
+#### format
+
+`"buffer"`
+
+### Returns
+
+`Buffer`

package/doc/sc/api/lib/crypto/functions/hashHmacFile.md

@@ -0,0 +1,79 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / hashHmacFile
+
+# Function: hashHmacFile()
+
+## Call Signature
+
+> **hashHmacFile**(`algorithm`, `path`, `key?`, `encoding?`): `Promise`\<`string` \| `false`\>
+
+Defined in: [lib/crypto.ts:406](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L406)
+
+hash 或 hmac 加密文件
+
+### Parameters
+
+#### algorithm
+
+`string`
+
+加密方式，如 md5、sha256、sm3 等
+
+#### path
+
+`string`
+
+文件路径
+
+#### key?
+
+`CipherKey`
+
+设置则采用 hmac 加密
+
+#### encoding?
+
+`"hex"` | `"base64"` | `"base64url"`
+
+### Returns
+
+`Promise`\<`string` \| `false`\>
+
+## Call Signature
+
+> **hashHmacFile**(`algorithm`, `path`, `key`, `encoding`): `Promise`\<`false` \| `Buffer`\<`ArrayBufferLike`\>\>
+
+Defined in: [lib/crypto.ts:407](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L407)
+
+hash 或 hmac 加密文件
+
+### Parameters
+
+#### algorithm
+
+`string`
+
+加密方式，如 md5、sha256、sm3 等
+
+#### path
+
+`string`
+
+文件路径
+
+#### key
+
+`CipherKey`
+
+设置则采用 hmac 加密
+
+#### encoding
+
+`"buffer"`
+
+### Returns
+
+`Promise`\<`false` \| `Buffer`\<`ArrayBufferLike`\>\>

package/doc/sc/api/lib/crypto/functions/privateDecrypt.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / privateDecrypt
+
+# Function: privateDecrypt()
+
+> **privateDecrypt**(`key`, `buffer`): `Buffer`
+
+Defined in: [lib/crypto.ts:135](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L135)
+
+非对称私钥解密
+
+## Parameters
+
+### key
+
+私钥
+
+`KeyLike` | `RsaPrivateKey`
+
+### buffer
+
+数据
+
+`string` | `ArrayBufferView`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Buffer`

package/doc/sc/api/lib/crypto/functions/privateEncrypt.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / privateEncrypt
+
+# Function: privateEncrypt()
+
+> **privateEncrypt**(`key`, `buffer`): `Buffer`
+
+Defined in: [lib/crypto.ts:113](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L113)
+
+非对称私钥加密
+
+## Parameters
+
+### key
+
+私钥
+
+`KeyLike` | `RsaPrivateKey`
+
+### buffer
+
+数据
+
+`string` | `ArrayBufferView`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Buffer`

package/doc/sc/api/lib/crypto/functions/publicDecrypt.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / publicDecrypt
+
+# Function: publicDecrypt()
+
+> **publicDecrypt**(`key`, `buffer`): `Buffer`
+
+Defined in: [lib/crypto.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L124)
+
+非对称公钥解密
+
+## Parameters
+
+### key
+
+公钥
+
+`KeyLike` | `RsaPublicKey` | `RsaPrivateKey`
+
+### buffer
+
+数据
+
+`string` | `ArrayBufferView`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Buffer`

package/doc/sc/api/lib/crypto/functions/publicEncrypt.md

@@ -0,0 +1,31 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / publicEncrypt
+
+# Function: publicEncrypt()
+
+> **publicEncrypt**(`key`, `buffer`): `Buffer`
+
+Defined in: [lib/crypto.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L102)
+
+非对称公钥加密
+
+## Parameters
+
+### key
+
+公钥
+
+`KeyLike` | `RsaPublicKey` | `RsaPrivateKey`
+
+### buffer
+
+数据
+
+`string` | `ArrayBufferView`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Buffer`

package/doc/sc/api/lib/crypto/functions/sign.md

@@ -0,0 +1,83 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / sign
+
+# Function: sign()
+
+## Call Signature
+
+> **sign**(`data`, `privateKey`, `format`, `algorithm?`): `string`
+
+Defined in: [lib/crypto.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L68)
+
+非对称加签
+
+### Parameters
+
+#### data
+
+`BinaryLike`
+
+数据
+
+#### privateKey
+
+私钥
+
+`KeyLike` | `SignKeyObjectInput` | `SignPrivateKeyInput` | `SignJsonWebKeyInput`
+
+#### format
+
+输出格式
+
+`"hex"` | `"base64"` | `"binary"`
+
+#### algorithm?
+
+`string`
+
+哈希方式
+
+### Returns
+
+`string`
+
+## Call Signature
+
+> **sign**(`data`, `privateKey`, `format?`, `algorithm?`): `Buffer`
+
+Defined in: [lib/crypto.ts:71](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L71)
+
+非对称加签
+
+### Parameters
+
+#### data
+
+`BinaryLike`
+
+数据
+
+#### privateKey
+
+私钥
+
+`KeyLike` | `SignKeyObjectInput` | `SignPrivateKeyInput` | `SignJsonWebKeyInput`
+
+#### format?
+
+`"buffer"`
+
+输出格式
+
+#### algorithm?
+
+`string`
+
+哈希方式
+
+### Returns
+
+`Buffer`

package/doc/sc/api/lib/crypto/functions/sm4Decrypt.md

@@ -0,0 +1,91 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / sm4Decrypt
+
+# Function: sm4Decrypt()
+
+## Call Signature
+
+> **sm4Decrypt**(`encrypt`, `key`, `iv`, `method`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:372](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L372)
+
+SM4 解密
+
+### Parameters
+
+#### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### iv
+
+`string`
+
+向量 16 个英文字母和数字
+
+#### method
+
+`string`
+
+加密方法
+
+#### output
+
+`"buffer"`
+
+### Returns
+
+`false` \| `Buffer`\<`ArrayBufferLike`\>
+
+## Call Signature
+
+> **sm4Decrypt**(`encrypt`, `key`, `iv?`, `method?`, `output?`): `string` \| `false`
+
+Defined in: [lib/crypto.ts:373](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L373)
+
+SM4 解密
+
+### Parameters
+
+#### encrypt
+
+需解密的字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### iv?
+
+`string`
+
+向量 16 个英文字母和数字
+
+#### method?
+
+`string`
+
+加密方法
+
+#### output?
+
+`"binary"`
+
+### Returns
+
+`string` \| `false`

package/doc/sc/api/lib/crypto/functions/sm4Encrypt.md

@@ -0,0 +1,91 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / sm4Encrypt
+
+# Function: sm4Encrypt()
+
+## Call Signature
+
+> **sm4Encrypt**(`original`, `key`, `iv`, `method`, `output`): `false` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [lib/crypto.ts:259](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L259)
+
+SM4 加密
+
+### Parameters
+
+#### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### iv
+
+`string`
+
+向量 16 个英文字母和数字
+
+#### method
+
+`string`
+
+加密方法
+
+#### output
+
+`"buffer"`
+
+### Returns
+
+`false` \| `Buffer`\<`ArrayBufferLike`\>
+
+## Call Signature
+
+> **sm4Encrypt**(`original`, `key`, `iv?`, `method?`, `output?`): `string` \| `false`
+
+Defined in: [lib/crypto.ts:260](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L260)
+
+SM4 加密
+
+### Parameters
+
+#### original
+
+原始字符串
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+#### key
+
+`CipherKey`
+
+密钥 32 个英文字母和数字
+
+#### iv?
+
+`string`
+
+向量 16 个英文字母和数字
+
+#### method?
+
+`string`
+
+加密方法
+
+#### output?
+
+`"base64"`
+
+### Returns
+
+`string` \| `false`

package/doc/sc/api/lib/crypto/functions/uuid.md

@@ -0,0 +1,25 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / uuid
+
+# Function: uuid()
+
+> **uuid**(`options?`): `string`
+
+Defined in: [lib/crypto.ts:459](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L459)
+
+生成 uuid
+
+## Parameters
+
+### options?
+
+`RandomUUIDOptions`
+
+选项
+
+## Returns
+
+`string`

package/doc/sc/api/lib/crypto/functions/verify.md

@@ -0,0 +1,43 @@
+[**Documents for @maiyunnet/kebab**](../../../index.md)
+
+***
+
+[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / verify
+
+# Function: verify()
+
+> **verify**(`data`, `object`, `signature`, `algorithm`): `boolean`
+
+Defined in: [lib/crypto.ts:89](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L89)
+
+非对称验签
+
+## Parameters
+
+### data
+
+`BinaryLike`
+
+数据
+
+### object
+
+证书
+
+`KeyLike` | `VerifyKeyObjectInput` | `VerifyPublicKeyInput` | `VerifyJsonWebKeyInput`
+
+### signature
+
+`ArrayBufferView`
+
+签名
+
+### algorithm
+
+`string` = `'sha256'`
+
+哈希方式
+
+## Returns
+
+`boolean`