Constructor Detail

Method Detail

• generatePrivateKey

   Jwk generatePrivateKey(KeyGenOptions options)

  Generates a private key using the SECP256K1 curve and ES256K algorithm.

  The generated key will have its key ID derived from the thumbprint and will be intended for signature use.

  Parameters:

  options - Options for key generation (currently unused, provided for possible future expansion).

  Returns:

  A Jwk representing the generated private key.

• computePublicKey

   Jwk computePublicKey(Jwk privateKey)

  Derives a public key from the private key provided. Applicable for asymmetric Key Generators only. Implementers of symmetric key generators should throw an UnsupportedOperation Exception

• privateKeyToBytes

   ByteArray privateKeyToBytes(Jwk privateKey)

  Converts a private key to bytes.

• publicKeyToBytes

   ByteArray publicKeyToBytes(Jwk publicKey)

  Converts a public key to bytes. Applicable for asymmetric KeyGenerator implementations only. Implementers of symmetric key generators should throw an UnsupportedOperation Exception

• bytesToPrivateKey

   Jwk bytesToPrivateKey(ByteArray privateKeyBytes)

  Converts a private key as bytes into a Jwk.

• bytesToPublicKey

   Jwk bytesToPublicKey(ByteArray publicKeyBytes)

  Converts a public key as bytes into a Jwk. Applicable for asymmetric Key Generators only. Implementers of symmetric key generators should throw an UnsupportedOperation Exception

• sign

   ByteArray sign(Jwk privateKey, ByteArray payload, SignOptions options)

  Deterministically signs the provided payload using the ECDSA (Elliptic Curve Digital Signature Algorithm) with the curve secp256k1.

  This function is designed to generate deterministic signatures, meaning that signing the same payload with the same private key will always produce the same signature.

  Parameters:

  privateKey - The private key used for signing, provided as a Jwk (JSON Web Key).

  payload - The byte array containing the data to be signed.

  options - Optional parameter to provide additional configuration for the signing process.

  Returns:

  A byte array representing the signature, generated by concatenating the r and s components of the ECDSA signature.

• verify

   Unit verify(Jwk publicKey, ByteArray signedPayload, ByteArray signature, VerifyOptions options)

  Verifies a signature against a given payload using the ECDSA (Elliptic Curve Digital Signature Algorithm) with the curve secp256k1. This function supports deterministic k-value generation through HMAC and SHA-256, ensuring consistent verification outcomes for identical payloads and signatures.

  Parameters:

  publicKey - The public key used for verification, provided as a Jwk (JSON Web Key).

  signedPayload - The byte array containing the data that was signed.

  signature - The byte array representing the signature to be verified against the payload.

  options - Optional parameter to provide additional configuration for the verification process.

• validateKey

   final Unit validateKey(Jwk key)

  Validates the provided Jwk (JSON Web Key) to ensure it conforms to the expected key type and format.

  This function checks the following:

  • The key must be an instance of ECKey.

  If any of these checks fail, this function throws an IllegalArgumentException with a descriptive error message.

  val jwk: Jwk = //...obtain or generate a Jwk
  try {
      Secp256k1.validateKey(jwk)
      // Key is valid, proceed with further operations...
  } catch (e: IllegalArgumentException) {
      // Handle invalid key...
  }

  Ensure to call this function before using a Jwk in cryptographic operations to safeguard against invalid key usage and potential vulnerabilities.

  Parameters:

  key - The Jwk to validate.

• compressPublicKey

   final ByteArray compressPublicKey(ByteArray publicKeyBytes)

  Compresses a public key represented by its X and Y coordinates concatenated in a single byte array.

  Assumes the input starts with a leading 0x04 byte, which is commonly used to denote an uncompressed public key in some elliptic curve representations.

  Parameters:

  publicKeyBytes - A byte array representing the public key, expected to be 65 bytes with the first byte being 0x04.

  Returns:

  The compressed public key as a byte array.

• inflatePublicKey

   final ByteArray inflatePublicKey(ByteArray publicKeyBytes)

  Inflates a compressed public key.

• getAlgorithm

   Jwa getAlgorithm()

  Indicates the algorithm intended to be used with the key.

• getCurve

   JwaCurve getCurve()

  The curve used for the key generation.

• getKeyType

   String getKeyType()

  KeyType in String format (OKP, EC, etc.).

• getPublicKeyXRange

   final IntRange getPublicKeyXRange()

  Range that defines the position of the X coordinate in an uncompressed public key byte array.

  The X coordinate is typically found in bytes 1 through 32 (inclusive) in the byte array representation of an uncompressed public key, assuming the first byte is reserved for the prefix (0x04).

• getPublicKeyYRange

   final IntRange getPublicKeyYRange()

  Range that defines the position of the Y coordinate in an uncompressed public key byte array.

  The Y coordinate is typically found in bytes 33 through 64 (inclusive) in the byte array representation of an uncompressed public key, following the X coordinate.