[crypto.decrypt]

crypto.decrypt is a slot in the crypto namespace, in Hyperlambda, the language of Magic Cloud. Decrypts data using the configured combination algorithm.

  • Value (crypto-encrypted-package), required: Encrypted package to decrypt and optionally verify
  • Returns: Resolves to the decrypted content as text or raw bytes when [raw] is true

Arguments

Required arguments come first, then the optional ones in the order they are declared.

Argument Type Required Description
[decryption-key] string|byte[] yes Private decryption key.
[verification-key] string|byte[] yes Public key used to verify the signature.
[raw] bool no Whether to return raw bytes instead of encoded text. Default: false.

JSON declaration

This is the complete declaration of crypto.decrypt, as the running system describes it. It is also published as slot.json.

JSON declaration
{
  "name": "crypto.decrypt",
  "description": "Decrypts data using the configured combination algorithm",
  "signature": {
    "input": {
      "kind": "crypto-encrypted-package",
      "description": "Encrypted package to decrypt and optionally verify",
      "required": true,
      "mode": "ValueOrExpression"
    },
    "children": {
      "decryption-key": {
        "type": "string|byte[]",
        "kind": "crypto-private-key",
        "description": "Private decryption key",
        "required": true,
        "mode": "ValueOrExpression",
        "cardinality": "ExactlyOne",
        "role": "Option",
        "projection": "Value"
      },
      "verification-key": {
        "type": "string|byte[]",
        "kind": "crypto-public-key",
        "description": "Public key used to verify the signature",
        "required": true,
        "mode": "ValueOrExpression",
        "cardinality": "ExactlyOne",
        "role": "Option",
        "projection": "Value"
      },
      "raw": {
        "type": "bool",
        "description": "Whether to return raw bytes instead of encoded text",
        "required": false,
        "mode": "ValueOrExpression",
        "cardinality": "ZeroOrOne",
        "default": "false",
        "role": "Option",
        "projection": "Value"
      }
    },
    "output": {
      "mode": "Value",
      "kind": "text,binary-content",
      "description": "Resolves to the decrypted content as text or raw bytes when [raw] is true"
    }
  }
}

← crypto.aes.encrypt all crypto.* slots crypto.encrypt →