@maiyunnet/kebab 7.6.1 → 7.6.3

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

@@ -1,31 +0,0 @@
-[**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

@@ -1,31 +0,0 @@
-[**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

@@ -1,83 +0,0 @@
-[**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

@@ -1,91 +0,0 @@
-[**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

@@ -1,91 +0,0 @@
-[**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

@@ -1,25 +0,0 @@
-[**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

@@ -1,43 +0,0 @@
-[**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`

package/doc/sc/api/lib/crypto/index.md

@@ -1,40 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../index.md) / lib/crypto
-
-# lib/crypto
-
-## Variables
-
-- [AES\_256\_CBC](variables/AES_256_CBC.md)
-- [AES\_256\_CTR](variables/AES_256_CTR.md)
-- [AES\_256\_ECB](variables/AES_256_ECB.md)
-- [AES\_256\_GCM](variables/AES_256_GCM.md)
-- [SM4\_CBC](variables/SM4_CBC.md)
-- [SM4\_CFB](variables/SM4_CFB.md)
-- [SM4\_ECB](variables/SM4_ECB.md)
-
-## Functions
-
-- [aesDecrypt](functions/aesDecrypt.md)
-- [aesEncrypt](functions/aesEncrypt.md)
-- [base64Decode](functions/base64Decode.md)
-- [base64Encode](functions/base64Encode.md)
-- [cipherDecrypt](functions/cipherDecrypt.md)
-- [cipherEncrypt](functions/cipherEncrypt.md)
-- [gcmDecrypt](functions/gcmDecrypt.md)
-- [gcmEncrypt](functions/gcmEncrypt.md)
-- [generateKeyPair](functions/generateKeyPair.md)
-- [hashHmac](functions/hashHmac.md)
-- [hashHmacFile](functions/hashHmacFile.md)
-- [privateDecrypt](functions/privateDecrypt.md)
-- [privateEncrypt](functions/privateEncrypt.md)
-- [publicDecrypt](functions/publicDecrypt.md)
-- [publicEncrypt](functions/publicEncrypt.md)
-- [sign](functions/sign.md)
-- [sm4Decrypt](functions/sm4Decrypt.md)
-- [sm4Encrypt](functions/sm4Encrypt.md)
-- [uuid](functions/uuid.md)
-- [verify](functions/verify.md)

package/doc/sc/api/lib/crypto/variables/AES_256_CBC.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_CBC
-
-# Variable: AES\_256\_CBC
-
-> `const` **AES\_256\_CBC**: `"aes-256-cbc"` = `'aes-256-cbc'`
-
-Defined in: [lib/crypto.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L146)
-
-一般不用，兼容性场景下用

package/doc/sc/api/lib/crypto/variables/AES_256_CTR.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_CTR
-
-# Variable: AES\_256\_CTR
-
-> `const` **AES\_256\_CTR**: `"aes-256-ctr"` = `'aes-256-ctr'`
-
-Defined in: [lib/crypto.ts:148](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L148)
-
-设置 iv 会自动切换为 CTR，流式下使用，非流直接使用 GCM

package/doc/sc/api/lib/crypto/variables/AES_256_ECB.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_ECB
-
-# Variable: AES\_256\_ECB
-
-> `const` **AES\_256\_ECB**: `"aes-256-ecb"` = `'aes-256-ecb'`
-
-Defined in: [lib/crypto.ts:144](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L144)
-
-勿使用，无 iv 默认，但勿使用

package/doc/sc/api/lib/crypto/variables/AES_256_GCM.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / AES\_256\_GCM
-
-# Variable: AES\_256\_GCM
-
-> `const` **AES\_256\_GCM**: `"aes-256-gcm"` = `'aes-256-gcm'`
-
-Defined in: [lib/crypto.ts:150](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L150)
-
-非流直接使用 GCM

package/doc/sc/api/lib/crypto/variables/SM4_CBC.md

@@ -1,11 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / SM4\_CBC
-
-# Variable: SM4\_CBC
-
-> `const` **SM4\_CBC**: `"sm4-cbc"` = `'sm4-cbc'`
-
-Defined in: [lib/crypto.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L154)

package/doc/sc/api/lib/crypto/variables/SM4_CFB.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / SM4\_CFB
-
-# Variable: SM4\_CFB
-
-> `const` **SM4\_CFB**: `"sm4-cfb"` = `'sm4-cfb'`
-
-Defined in: [lib/crypto.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L156)
-
-SM4 一般用这个，设置 iv，自动就切换成了这个

package/doc/sc/api/lib/crypto/variables/SM4_ECB.md

@@ -1,13 +0,0 @@
-[**Documents for @maiyunnet/kebab**](../../../index.md)
-
-***
-
-[Documents for @maiyunnet/kebab](../../../index.md) / [lib/crypto](../index.md) / SM4\_ECB
-
-# Variable: SM4\_ECB
-
-> `const` **SM4\_ECB**: `"sm4-ecb"` = `'sm4-ecb'`
-
-Defined in: [lib/crypto.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L153)
-
-SM4 如果未设置 iv，则默认这个