Class Crypto

constructor

• new Crypto(): Bluestep.Crypto

  Returns Bluestep.Crypto

Readonlyjwts

createCertificate

• createCertificate(
      type: string,
      certificate: string | ByteArray | InputStream,
  ): Certificate

  Returns a Certificate using a provided type

  Parameters

  • type: string

    X.509
  • certificate: string | ByteArray | InputStream

    BEGIN CERTIFICATE----- XXXXXXXXXXXXXXXXXXXXXXXXXXX -----END CERTIFICATE-----

  Returns Certificate

createCertificates

• createCertificates(
      type: string,
      certs: string | ByteArray | InputStream,
  ): Collection<Certificate>

  Returns all Certificates in PKCS#7 or PkiPath formatted certificates

  Parameters

  • type: string

    X.509
  • certs: string | ByteArray | InputStream

    PKCS#7-formatted certificate

  Returns Collection<Certificate>

createPrivateKeyFromPKCS8

• createPrivateKeyFromPKCS8(
      privateKeyAlgorithm: string,
      privatePem: string,
  ): PrivateKey

  Returns a PrivateKey using a provided algorithm from a PEM encoded using PKCS8 and Base64.

  Parameters

  • privateKeyAlgorithm: string

    RSA
  • privatePem: string

    BEGIN PRIVATE KEY----- XXXXXXXXXXXXXXXXXXXXXXXXXXX -----END PRIVATE KEY-----

  Returns PrivateKey
• createPrivateKeyFromPKCS8(
      privateKeyAlgorithm: string,
      privateKeyBytes: ByteArray,
  ): PrivateKey

  Returns a PrivateKey using a provided algorithm from a PEM encoded using PKCS8 as bytes.

  Parameters

  • privateKeyAlgorithm: string

    RSA
  • privateKeyBytes: ByteArray

  Returns PrivateKey

createPublicKeyFrom509

• createPublicKeyFrom509(publicKeyAlgorithm: string, publicPem: string): PublicKey

  Returns a Public Key using a provided algorithm from a PEM encoded using 509 and Base64.

  Parameters

  • publicKeyAlgorithm: string

    RSA
  • publicPem: string

    BEGIN PUBLIC KEY----- XXXXXXXXXXXXXXXXXXXXXXXXXXX -----END PUBLIC KEY-----

  Returns PublicKey
• createPublicKeyFrom509(
      publicKeyAlgorithm: string,
      publicKeyBytes: ByteArray,
  ): PublicKey

  Returns a Public Key using a provided algorithm from a PEM encoded using 509 as bytes.

  Parameters

  • publicKeyAlgorithm: string

    RSA
  • publicKeyBytes: ByteArray

  Returns PublicKey

digestInputStream

• digestInputStream(input: InputStream, digest: MessageDigest): DigestInputStream

  Wraps a [[Java.IO.InputStream]] in a [[Java.IO.DigestInputStream]]

  Parameters

  • input: InputStream
  • digest: MessageDigest

  Returns DigestInputStream

digestOutputStream

• digestOutputStream(
      output: OutputStream,
      digest: MessageDigest,
  ): DigestOutputStream

  Wraps a [[Java.IO.OutputStream]] in a [[Java.IO.DigestOutputStream]]

  Parameters

  • output: OutputStream
  • digest: MessageDigest

  Returns DigestOutputStream

hash

• hash(hashAlgorithm: string, input: InputStream | Reader): MessageDigest

  Produce a hash using a provided digest algorithm and an InputStream. See also [[secureHash]].

  Parameters

  • hashAlgorithm: string

    Hash algorithm like SHA-256
  • input: InputStream | Reader

    What to create a hash from.

  Returns MessageDigest

  Example

  const salt = B.user.id;
  const secret = someInputStream;
  const hash = B.text.toBase64(B.crypto.hash('SHA-256', secret));
  Copy

• hash(hashAlgorithm: string, input: string | ByteArray): MessageDigest

  Produce a hash using a provided digest algorithm. See also [[secureHash]].

  Parameters

  • hashAlgorithm: string

    Hash algorithm like SHA-256
  • input: string | ByteArray

    What to create a hash from.

  Returns MessageDigest

  Example

  const salt = B.user.id;
  const secret = 'my secret';
  const hash = B.text.toHex(B.crypto.hash('SHA-256', secret + salt));
  Copy

mac

• mac(
      hashAlgorithm: string,
      input: InputStream | Reader,
      key: string | ByteArray,
  ): Mac

  Produce a hash using a provided mac algorithm and an InputStream.

  Parameters

  • hashAlgorithm: string

    Hash algorithm like HmacSHA256
  • input: InputStream | Reader

    What to create a hash from.
  • key: string | ByteArray

    Key to use when getting mac hash.

  Returns Mac

  Example

  const salt = B.user.id;
  const secret = someTypeOfInputStream;
  const hash = B.text.toBase64(B.crypto.mac('HmacSHA256', secret, 'password'));
  Copy

• mac(
      macAlgorithm: string,
      input: string | ByteArray,
      key: string | ByteArray,
  ): Mac

  Produce a hash using a provided mac algorithm.

  Parameters

  • macAlgorithm: string

    Mac algorithm like HmacSHA256
  • input: string | ByteArray

    What to create a hash from.
  • key: string | ByteArray

    Key to use when getting mac hash.

  Returns Mac

  Example

  const salt = B.user.id;
  const secret = 'my secret';
  const hash = B.toBase64(B.crypto.mac('HmacSHA256', secret + salt));
  Copy

• mac(macAlgorithm: string, key: string | string[] | ByteArray): Mac

  Returns a [[Java.crypto.Mac]] using a provided mac algorithm.

  Parameters

  • macAlgorithm: string

    Mac algorithm like HmacSHA256
  • key: string | string[] | ByteArray

    Key to use when getting mac hash.

  Returns Mac

messageDigest

• messageDigest(digestAlgorithm: string): MessageDigest

  Returns a [[Java.crypto.MessageDigest]] using a provided MessageDigest algorithm.

  Parameters

  • digestAlgorithm: string

    Hash algorithm like SHA-256

  Returns MessageDigest

pemToBytes

• pemToBytes(pem: string): ByteArray

  Returns a Java.ByteArray from a pem

  Parameters

  • pem: string

    BEGIN PRIVATE KEY----- XXXXXXXXXXXXXXXXXXXXXXXXXXX -----END PRIVATE KEY-----

  Returns ByteArray

sign

• sign(
      signingAlgorithm: string,
      stringToSign: string,
      privateKey: PrivateKey,
  ): string

  Returns a signature in Base64 signed using a PrivateKey and updated with stringToSign

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • stringToSign: string
  • privateKey: PrivateKey

  Returns string
• sign(
      signingAlgorithm: string,
      dataToSign: ByteArray,
      privateKey: PrivateKey,
  ): ByteArray

  Returns a signature as bytes using a PrivateKey and dataToSign

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • dataToSign: ByteArray
  • privateKey: PrivateKey

  Returns ByteArray

signature

• signature(signingAlgorithm: string): Signature

  Returns a Signature using a provided algorithm.

  Parameters

  • signingAlgorithm: string

    SHA256withRSA

  Returns Signature
• signature(signingAlgorithm: string, provider: string): Signature

  Returns a Signature using a provided algorithm.

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • provider: string

    Provider name

  Returns Signature
• signature(signingAlgorithm: string, provider: Provider): Signature

  Returns a Signature using a provided algorithm.

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • provider: Provider

  Returns Signature
• signature(
      signingAlgorithm: string,
      stringToSign: string,
      privateKey: PrivateKey,
  ): Signature

  Returns a Signature signed using a PrivateKey and updated with stringToSign.

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • stringToSign: string
  • privateKey: PrivateKey

  Returns Signature
• signature(
      signingAlgorithm: string,
      dataToSign: ByteArray,
      privateKey: PrivateKey,
  ): Signature

  Returns a Signature signed using a PrivateKey and updated with dataToSign

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • dataToSign: ByteArray
  • privateKey: PrivateKey

  Returns Signature
• signature(signingAlgorithm: string, certificate: Certificate): Signature

  Returns a Signature using a Certificate

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • certificate: Certificate

  Returns Signature
• signature(signingAlgorithm: string, publicKey: PublicKey): Signature

  Returns a Signature using a PublicKey

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • publicKey: PublicKey

  Returns Signature

verify

• verify(
      signingAlgorithm: string,
      data: string,
      signature: string,
      certificate: Certificate,
  ): boolean

  Verifies a Signature using a Certificate and updated with data to verify with a signature.

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • data: string
  • signature: string
  • certificate: Certificate

  Returns boolean
• verify(
      signingAlgorithm: string,
      data: ByteArray,
      certificate: Certificate,
  ): boolean

  Verifies a Signature using a Certificate and updated with data

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • data: ByteArray
  • certificate: Certificate

  Returns boolean
• verify(
      signingAlgorithm: string,
      data: string,
      signature: string,
      publicKey: PublicKey,
  ): boolean

  Verifies a Signature using a PublicKey and updated with data to verify with a signature.

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • data: string
  • signature: string
  • publicKey: PublicKey

  Returns boolean
• verify(signingAlgorithm: string, data: ByteArray, publicKey: PublicKey): boolean

  Verifies a Signature using a PublicKey and updated with data

  Parameters

  • signingAlgorithm: string

    SHA256withRSA
  • data: ByteArray
  • publicKey: PublicKey

  Returns boolean