vrl 0.31.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

{
  "anchor": "encrypt_ip",
  "name": "encrypt_ip",
  "category": "IP",
  "description": "Encrypts an IP address, transforming it into a different valid IP address.\n\nSupported Modes:\n\n* AES128 - Scrambles the entire IP address using AES-128 encryption. Can transform between IPv4 and IPv6.\n* PFX (Prefix-preserving) - Maintains network hierarchy by ensuring that IP addresses within the same network are encrypted to addresses that also share a common network. This preserves prefix relationships while providing confidentiality.",
  "arguments": [
    {
      "name": "ip",
      "description": "The IP address to encrypt (v4 or v6).",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "key",
      "description": "The encryption key in raw bytes (not encoded). For AES128 mode, the key must be exactly 16 bytes. For PFX mode, the key must be exactly 32 bytes.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "mode",
      "description": "The encryption mode to use. Must be either `aes128` or `pfx`.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "internal_failure_reasons": [
    "`ip` is not a valid IP address.",
    "`mode` is not a supported mode (must be `aes128` or `pfx`).",
    "`key` length does not match the requirements for the specified mode (16 bytes for `aes128`, 32 bytes for `pfx`)."
  ],
  "examples": [
    {
      "title": "Encrypt IPv4 address with AES128",
      "source": "encrypt_ip!(\"192.168.1.1\", \"sixteen byte key\", \"aes128\")",
      "return": "72b9:a747:f2e9:72af:76ca:5866:6dcf:c3b0"
    },
    {
      "title": "Encrypt IPv6 address with AES128",
      "source": "encrypt_ip!(\"2001:db8::1\", \"sixteen byte key\", \"aes128\")",
      "return": "c0e6:eb35:6887:f554:4c65:8ace:17ca:6c6a"
    },
    {
      "title": "Encrypt IPv4 address with prefix-preserving mode",
      "source": "encrypt_ip!(\"192.168.1.1\", \"thirty-two bytes key for pfx use\", \"pfx\")",
      "return": "33.245.248.61"
    },
    {
      "title": "Encrypt IPv6 address with prefix-preserving mode",
      "source": "encrypt_ip!(\"2001:db8::1\", \"thirty-two bytes key for ipv6pfx\", \"pfx\")",
      "return": "88bd:d2bf:8865:8c4d:84b:44f6:6077:72c9"
    }
  ],
  "notices": [
    "The `aes128` mode implements the `ipcrypt-deterministic` algorithm from the IPCrypt\nspecification, while the `pfx` mode implements the `ipcrypt-pfx` algorithm. Both modes\nprovide deterministic encryption where the same input IP address encrypted with the\nsame key will always produce the same encrypted output."
  ],
  "pure": true
}