Class KavenRSA

constructor

• new KavenRSA(publicKey?: string, privateKey?: string): KavenRSA

  Parameters

  • OptionalpublicKey: string
  • OptionalprivateKey: string

  Returns KavenRSA

ReadonlyPrivateKey

ReadonlyPublicKey

Decrypt

• Decrypt(
      data: Buffer,
      padding?: number,
      oaepHash?: string,
  ): Buffer<ArrayBufferLike>

  Parameters

  • data: Buffer
  • padding: number = constants.RSA_PKCS1_OAEP_PADDING
  • oaepHash: string = "sha256"

  Returns Buffer<ArrayBufferLike>

DecryptBigData

• DecryptBigData<T = unknown>(
      data: string,
      encoding?: BufferEncoding,
      padding?: number,
      oaepHash?: string,
  ): T

  Type Parameters

  • T = unknown

  Parameters

  • data: string
  • encoding: BufferEncoding = "base64"
  • padding: number = constants.RSA_PKCS1_OAEP_PADDING
  • oaepHash: string = "sha256"

  Returns T

DecryptFromString

• DecryptFromString<T = unknown>(
      data: string,
      encoding?: BufferEncoding,
      padding?: number,
      oaepHash?: string,
  ): T

  Type Parameters

  • T = unknown

  Parameters

  • data: string
  • encoding: BufferEncoding = "base64"
  • padding: number = constants.RSA_PKCS1_OAEP_PADDING
  • oaepHash: string = "sha256"

  Returns T

Encrypt

• Encrypt(
      data: Buffer,
      padding?: number,
      oaepHash?: string,
  ): Buffer<ArrayBufferLike>

  Parameters

  • data: Buffer
  • padding: number = constants.RSA_PKCS1_OAEP_PADDING
  • oaepHash: string = "sha256"

  Returns Buffer<ArrayBufferLike>

EncryptBigData

• EncryptBigData<T>(
      data: T,
      encoding?: BufferEncoding,
      padding?: number,
      oaepHash?: string,
  ): string

  Type Parameters

  • T

  Parameters

  • data: T
  • encoding: BufferEncoding = "base64"
  • padding: number = constants.RSA_PKCS1_OAEP_PADDING
  • oaepHash: string = "sha256"

  Returns string

EncryptToString

• EncryptToString<T>(
      data: T,
      encoding?: BufferEncoding,
      padding?: number,
      oaepHash?: string,
  ): string

  Type Parameters

  • T

  Parameters

  • data: T
  • encoding: BufferEncoding = "base64"
  • padding: number = constants.RSA_PKCS1_OAEP_PADDING
  • oaepHash: string = "sha256"

  Returns string

Sign

• Sign(
      data: Buffer,
      algorithm?: string,
      padding?: number,
      saltLength?: number,
  ): Buffer<ArrayBufferLike>

  Parameters

  • data: Buffer
  • algorithm: string = "sha256"
  • padding: number = constants.RSA_PKCS1_PSS_PADDING
  • saltLength: number = constants.RSA_PSS_SALTLEN_DIGEST

  Returns Buffer<ArrayBufferLike>

SignToString

• SignToString<T>(
      data: T,
      encoding?: BufferEncoding,
      algorithm?: string,
      padding?: number,
      saltLength?: number,
  ): string

  Type Parameters

  • T

  Parameters

  • data: T
  • encoding: BufferEncoding = "base64"
  • algorithm: string = "sha256"
  • padding: number = constants.RSA_PKCS1_PSS_PADDING
  • saltLength: number = constants.RSA_PSS_SALTLEN_DIGEST

  Returns string

Verify

• Verify(
      data: Buffer,
      signature: Buffer,
      algorithm?: string,
      padding?: number,
      saltLength?: number,
  ): boolean

  Parameters

  • data: Buffer
  • signature: Buffer
  • algorithm: string = "sha256"
  • padding: number = constants.RSA_PKCS1_PSS_PADDING
  • saltLength: number = constants.RSA_PSS_SALTLEN_DIGEST

  Returns boolean

VerifyFromString

• VerifyFromString<T>(
      data: T,
      signature: string,
      encoding?: BufferEncoding,
      algorithm?: string,
      padding?: number,
      saltLength?: number,
  ): boolean

  Type Parameters

  • T

  Parameters

  • data: T
  • signature: string
  • encoding: BufferEncoding = "base64"
  • algorithm: string = "sha256"
  • padding: number = constants.RSA_PKCS1_PSS_PADDING
  • saltLength: number = constants.RSA_PSS_SALTLEN_DIGEST

  Returns boolean

StaticCreate

• Create(bits?: number, exponent?: number): KavenRSA

  Parameters

  • bits: number = 4096
  • exponent: number = 65537

  Returns KavenRSA