aead_test_schema.json

{
  "type": "object",
  "definitions": {
    "AeadTestGroup": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "AeadTest"
          ]
        },
        "ivSize": {
          "type": "integer",
          "description": "the IV size in bits"
        },
        "keySize": {
          "type": "integer",
          "description": "the keySize in bits"
        },
        "tagSize": {
          "type": "integer",
          "description": "the expected size of the tag in bits"
        },
        "tests": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/AeadTestVector"
          }
        }
      }
    },
    "AeadTestVector": {
      "type": "object",
      "properties": {
        "tcId": {
          "type": "integer",
          "description": "Identifier of the test case"
        },
        "comment": {
          "type": "string",
          "description": "A brief description of the test case"
        },
        "key": {
          "type": "string",
          "format": "HexBytes",
          "description": "the key"
        },
        "iv": {
          "type": "string",
          "format": "HexBytes",
          "description": "the nonce"
        },
        "aad": {
          "type": "string",
          "format": "HexBytes",
          "description": "additional authenticated data"
        },
        "msg": {
          "type": "string",
          "format": "HexBytes",
          "description": "the plaintext"
        },
        "ct": {
          "type": "string",
          "format": "HexBytes",
          "description": "the ciphertext (without iv and tag)"
        },
        "tag": {
          "type": "string",
          "format": "HexBytes",
          "description": "the authentication tag"
        },
        "result": {
          "type": "string",
          "description": "Test result",
          "enum": [
            "valid",
            "invalid",
            "acceptable"
          ]
        },
        "flags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of flags"
        }
      }
    }
  },
  "properties": {
    "algorithm": {
      "type": "string",
      "description": "the primitive tested in the test file"
    },
    "generatorVersion": {
      "type": "string",
      "description": "the version of the test vectors."
    },
    "header": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "additional documentation"
    },
    "notes": {
      "type": "object",
      "description": "a description of the labels used in the test vectors"
    },
    "numberOfTests": {
      "type": "integer",
      "description": "the number of test vectors in this test"
    },
    "schema": {
      "enum": [
        "aead_test_schema.json"
      ]
    },
    "testGroups": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/AeadTestGroup"
      }
    }
  }
}