openapi.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "NIST CMVP Data API",
    "description": "Static JSON API for NIST Cryptographic Module Validation Program data. Auto-updated weekly via GitHub Actions. Unofficial project - see https://csrc.nist.gov/projects/cryptographic-module-validation-program for authoritative data.",
    "version": "3.0",
    "contact": {
      "url": "https://github.com/hackIDLE/nist-cmvp-api"
    }
  },
  "externalDocs": {
    "description": "Markdown API reference",
    "url": "https://hackidle.github.io/nist-cmvp-api/api/docs.md"
  },
  "servers": [
    {
      "url": "https://hackidle.github.io/nist-cmvp-api",
      "description": "GitHub Pages (production)"
    }
  ],
  "paths": {
    "/api/index.json": {
      "get": {
        "summary": "API index and endpoint listing",
        "operationId": "getIndex",
        "responses": {
          "200": {
            "description": "API discovery endpoint with available endpoints and feature flags",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Index"
                }
              }
            }
          }
        }
      }
    },
    "/api/metadata.json": {
      "get": {
        "summary": "Dataset metadata",
        "operationId": "getMetadata",
        "responses": {
          "200": {
            "description": "Generation timestamp, module counts, and data source information",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Metadata"
                }
              }
            }
          }
        }
      }
    },
    "/api/data-quality.json": {
      "get": {
        "summary": "Latest data quality report",
        "operationId": "getDataQuality",
        "responses": {
          "200": {
            "description": "Misses, refreshed records, fallback usage, changed certificates, and run-health checks",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DataQualityReport"
                }
              }
            }
          }
        }
      }
    },
    "/api/examples.json": {
      "get": {
        "summary": "Consumer examples",
        "operationId": "getExamples",
        "responses": {
          "200": {
            "description": "curl, Python, JavaScript, and agent-oriented examples for common queries",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExamplesResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/indexes/vendors.json": {
      "get": {
        "summary": "Vendor search index",
        "operationId": "getVendorIndex",
        "responses": {
          "200": {
            "description": "Certificate references keyed by vendor name",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchIndexResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/indexes/algorithms.json": {
      "get": {
        "summary": "Algorithm search index",
        "operationId": "getAlgorithmIndex",
        "responses": {
          "200": {
            "description": "Certificate references keyed by algorithm category",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchIndexResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/indexes/statuses.json": {
      "get": {
        "summary": "Status search index",
        "operationId": "getStatusIndex",
        "responses": {
          "200": {
            "description": "Certificate references keyed by validation status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchIndexResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/indexes/standards.json": {
      "get": {
        "summary": "Standard search index",
        "operationId": "getStandardIndex",
        "responses": {
          "200": {
            "description": "Certificate references keyed by FIPS standard",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchIndexResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/modules.json": {
      "get": {
        "summary": "Active validated cryptographic modules",
        "operationId": "getModules",
        "responses": {
          "200": {
            "description": "Currently 1086 active validated modules with enriched details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModulesResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/historical-modules.json": {
      "get": {
        "summary": "Historical (expired/revoked) cryptographic modules",
        "operationId": "getHistoricalModules",
        "responses": {
          "200": {
            "description": "Currently 4170 historical modules",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModulesResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/modules-in-process.json": {
      "get": {
        "summary": "Modules currently in the validation process",
        "operationId": "getModulesInProcess",
        "responses": {
          "200": {
            "description": "Currently 325 modules in process",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModulesInProcessResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/algorithms.json": {
      "get": {
        "summary": "Algorithm usage statistics across all certificates",
        "operationId": "getAlgorithms",
        "responses": {
          "200": {
            "description": "Algorithm counts and certificate mappings",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AlgorithmsResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/certificates/index.json": {
      "get": {
        "summary": "Certificate detail discovery index",
        "operationId": "getCertificateIndex",
        "responses": {
          "200": {
            "description": "Compact index of all per-certificate JSON detail files",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateIndexResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/certificates/{certificate}.json": {
      "get": {
        "summary": "Full certificate detail record",
        "operationId": "getCertificateDetail",
        "parameters": [
          {
            "name": "certificate",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Numeric CMVP certificate number"
          }
        ],
        "responses": {
          "200": {
            "description": "Certificate detail payload mirroring the NIST certificate page sections",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateDetailResponse"
                }
              }
            }
          },
          "404": {
            "description": "Certificate detail record not found"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Metadata": {
        "type": "object",
        "properties": {
          "generated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2026-05-15T02:49:52.984765Z"
          },
          "total_modules": {
            "type": "integer",
            "example": 1086
          },
          "total_historical_modules": {
            "type": "integer",
            "example": 4170
          },
          "total_modules_in_process": {
            "type": "integer",
            "example": 325
          },
          "total_certificates_with_algorithms": {
            "type": "integer",
            "example": 1630
          },
          "total_certificate_details": {
            "type": "integer",
            "example": 5256
          },
          "source": {
            "type": "string",
            "example": "https://csrc.nist.gov/projects/cryptographic-module-validation-program/validated-modules/search"
          },
          "modules_in_process_source": {
            "type": "string",
            "example": "https://csrc.nist.gov/Projects/cryptographic-module-validation-program/modules-in-process/modules-in-process-list"
          },
          "algorithm_source": {
            "type": "string",
            "example": "crawl4ai"
          },
          "algorithm_cache_version": {
            "type": "string",
            "example": "2026-04-15-legacy-v1"
          },
          "algorithm_extraction_schema_version": {
            "type": "string",
            "example": "1.0"
          },
          "extraction_metrics": {
            "type": "object",
            "additionalProperties": true
          },
          "version": {
            "type": "string",
            "example": "3.0"
          }
        }
      },
      "Module": {
        "type": "object",
        "description": "A FIPS 140-2/140-3 validated cryptographic module",
        "properties": {
          "Certificate Number": {
            "type": "string",
            "example": "5267"
          },
          "Certificate Number_url": {
            "type": "string",
            "example": "https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/5267"
          },
          "Module Name": {
            "type": "string",
            "example": "Intel FNIC Control Plane Cryptographic Module"
          },
          "Module Type": {
            "type": "string",
            "example": "Hardware"
          },
          "Validation Date": {
            "type": "string",
            "example": "05/13/2026"
          },
          "Vendor Name": {
            "type": "string",
            "example": "Intel Corporation"
          },
          "algorithm_extraction": {
            "type": "object",
            "additionalProperties": true
          },
          "caveat": {
            "type": "string",
            "example": "When operated in approved mode. No assurance of minimum security of SSPs (e.g., keys, bit strings) that are externally loaded, or of SSPs established with externally loaded SSPs."
          },
          "certificate_detail_url": {
            "type": "string",
            "example": "https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/5267"
          },
          "description": {
            "type": "string",
            "example": "Intel FNIC Control Plane Cryptographic Module provides hardware engines supporting cryptographic offload for AES, ECDSA, RSA, HMAC and SHA algorithms, and firmware component providing SPDM initialization, key exchange and secure manageability."
          },
          "detail_available": {
            "type": "boolean",
            "example": true
          },
          "embodiment": {
            "type": "string",
            "example": "SingleChip"
          },
          "module_name": {
            "type": "string",
            "example": "Intel FNIC Control Plane Cryptographic Module"
          },
          "module_type": {
            "type": "string",
            "example": "Hardware"
          },
          "overall_level": {
            "type": "integer",
            "example": 1
          },
          "security_policy_url": {
            "type": "string",
            "example": "https://csrc.nist.gov/CSRC/media/projects/cryptographic-module-validation-program/documents/security-policies/140sp5267.pdf"
          },
          "standard": {
            "type": "string",
            "example": "FIPS 140-3"
          },
          "status": {
            "type": "string",
            "example": "Active"
          },
          "sunset_date": {
            "type": "string",
            "example": "5/12/2031"
          },
          "algorithms": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "AES",
              "DRBG",
              "ECDSA"
            ]
          },
          "algorithms_detailed": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "AES-CBC A4995 Direction - Decrypt, Encrypt | Key Length - 128, 256 | SP 800-38A",
              "AES-CMAC A4995 Direction - Generation | Key Length - 128, 256 | SP 800-38B",
              "AES-CTR A4995 Direction - Decrypt, Encrypt | Key Length - 128, 256 | SP 800-38A"
            ]
          },
          "software_versions": {
            "type": "string",
            "nullable": true,
            "example": ""
          },
          "hardware_versions": {
            "type": "string",
            "nullable": true,
            "example": ""
          },
          "firmware_versions": {
            "type": "string",
            "nullable": true,
            "example": ""
          }
        }
      },
      "ModulesResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "modules": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Module"
            }
          }
        }
      },
      "ModulesInProcessResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "modules_in_process": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Module"
            }
          }
        }
      },
      "DataQualityReport": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "summary": {
            "type": "object",
            "additionalProperties": {
              "type": "integer"
            }
          },
          "update_monitor": {
            "type": "object",
            "additionalProperties": true
          },
          "misses": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "refreshed_records": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "fallback_usage": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "changed_certificates": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          }
        }
      },
      "ExamplesResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "base_url": {
            "type": "string"
          },
          "examples": {
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "SearchIndexReference": {
        "type": "object",
        "properties": {
          "certificate_number": {
            "type": "string"
          },
          "dataset": {
            "type": "string",
            "enum": [
              "active",
              "historical"
            ]
          },
          "path": {
            "type": "string",
            "example": "/api/certificates/5238.json"
          },
          "vendor_name": {
            "type": "string",
            "nullable": true
          },
          "module_name": {
            "type": "string",
            "nullable": true
          },
          "standard": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "algorithm_count": {
            "type": "integer"
          }
        }
      },
      "SearchIndexResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "index": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "key_count": {
            "type": "integer"
          },
          "entry_count": {
            "type": "integer"
          },
          "keys": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/SearchIndexReference"
              }
            }
          }
        }
      },
      "AlgorithmsResponse": {
        "type": "object",
        "properties": {
          "total_unique_algorithms": {
            "type": "integer"
          },
          "total_certificate_algorithm_pairs": {
            "type": "integer"
          },
          "algorithms": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "count": {
                  "type": "integer"
                },
                "certificates": {
                  "type": "array",
                  "items": {
                    "type": "integer"
                  }
                }
              }
            }
          },
          "metadata": {
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "CertificateIndexEntry": {
        "type": "object",
        "description": "Compact discovery row for a per-certificate detail JSON file",
        "properties": {
          "certificate_number": {
            "type": "string"
          },
          "dataset": {
            "type": "string",
            "enum": [
              "active",
              "historical"
            ]
          },
          "path": {
            "type": "string",
            "example": "/api/certificates/5238.json"
          },
          "nist_page_url": {
            "type": "string"
          },
          "certificate_detail_url": {
            "type": "string"
          },
          "security_policy_url": {
            "type": "string",
            "nullable": true
          },
          "vendor_name": {
            "type": "string",
            "nullable": true
          },
          "module_name": {
            "type": "string",
            "nullable": true
          },
          "standard": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "module_type": {
            "type": "string",
            "nullable": true
          },
          "overall_level": {
            "oneOf": [
              {
                "type": "integer"
              },
              {
                "type": "string"
              }
            ],
            "nullable": true
          },
          "validation_date": {
            "type": "string",
            "nullable": true
          },
          "validation_dates": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sunset_date": {
            "type": "string",
            "nullable": true
          },
          "algorithms": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "algorithm_count": {
            "type": "integer"
          },
          "algorithm_extraction_status": {
            "type": "string",
            "nullable": true
          },
          "algorithm_source": {
            "type": "string",
            "nullable": true
          },
          "detail_available": {
            "type": "boolean"
          }
        }
      },
      "CertificateIndexResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "total_certificates": {
            "type": "integer"
          },
          "certificate_paths": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "certificates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CertificateIndexEntry"
            }
          }
        }
      },
      "CertificateDetail": {
        "type": "object",
        "description": "Structured certificate detail record derived from the NIST certificate page",
        "properties": {
          "algorithm_extraction": {
            "type": "object",
            "additionalProperties": true
          },
          "caveat": {
            "type": "string",
            "example": "When operated with module AWS-LC Cryptographic Module (dynamic) validated to FIPS 140-3 under Cert. #5146 operating in approved mode, No assurance of minimum security of SSPs (e.g., keys, bit strings) that are externally loaded, or of SSPs established with externally loaded SSPs"
          },
          "certificate_detail_url": {
            "type": "string",
            "example": "https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/5256"
          },
          "certificate_number": {
            "type": "string",
            "example": "5256"
          },
          "dataset": {
            "type": "string",
            "example": "active"
          },
          "description": {
            "type": "string",
            "example": "MACsec and DWDM link encryption is used by AWS networking infrastructure to secure traffic across its core network consisting of long-distance and large-scale data communications across the globe. Traffic flowing across the AWS global network is protected by strong cryptography and meets regulatory requirements."
          },
          "embodiment": {
            "type": "string",
            "example": "MultiChipStand"
          },
          "firmware_versions": {
            "type": "string",
            "nullable": true,
            "example": ""
          },
          "generated_at": {
            "type": "string",
            "example": "2026-05-15T02:49:52.984765Z"
          },
          "hardware_versions": {
            "type": "string",
            "nullable": true,
            "example": ""
          },
          "module_name": {
            "type": "string",
            "example": "AWS Link Encryption Module"
          },
          "module_type": {
            "type": "string",
            "example": "Software-hybrid"
          },
          "nist_page_url": {
            "type": "string",
            "example": "https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/5256"
          },
          "overall_level": {
            "type": "integer",
            "example": 1
          },
          "related_files": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "security_level_exceptions": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "Non-invasive security: N/A",
              "Mitigation of other attacks: N/A"
            ]
          },
          "security_policy_url": {
            "type": "string",
            "example": "https://csrc.nist.gov/CSRC/media/projects/cryptographic-module-validation-program/documents/security-policies/140sp5256.pdf"
          },
          "software_versions": {
            "type": "string",
            "nullable": true,
            "example": ""
          },
          "standard": {
            "type": "string",
            "example": "FIPS 140-3"
          },
          "status": {
            "type": "string",
            "example": "Active"
          },
          "sunset_date": {
            "type": "string",
            "example": "5/4/2031"
          },
          "validation_date": {
            "type": "string",
            "example": "5/5/2026"
          },
          "validation_dates": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "5/5/2026"
            ]
          },
          "validation_history": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "vendor": {
            "type": "object",
            "additionalProperties": true
          },
          "vendor_name": {
            "type": "string",
            "example": "Amazon Web Services, Inc."
          },
          "algorithms": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "AES",
              "HMAC",
              "SHA"
            ]
          },
          "algorithms_detailed": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "AES-ECB | A1359 | Direction - EncryptKey Length - 128,256 | SP 800-38A",
              "AES-GCM | A1359 | Direction - Decrypt,EncryptIV Generation - ExternalKey Length - 128,256 | SP 800-38D",
              "AES-XPN | A1359 | Direction - Decrypt,EncryptKey Length - 128,256IV Generation - External | SP 800-38D"
            ]
          }
        }
      },
      "CertificateDetailResponse": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "properties": {
              "generated_at": {
                "type": "string",
                "format": "date-time"
              },
              "dataset": {
                "type": "string"
              },
              "source": {
                "type": "string"
              }
            }
          },
          "certificate": {
            "$ref": "#/components/schemas/CertificateDetail"
          }
        }
      },
      "Index": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "NIST CMVP API"
          },
          "description": {
            "type": "string",
            "example": "Static JSON API for NIST Cryptographic Module Validation Program data with certificate detail records and generated agent-facing documentation"
          },
          "base_url": {
            "type": "string",
            "example": "https://hackidle.github.io/nist-cmvp-api"
          },
          "endpoints": {
            "type": "object"
          },
          "documentation": {
            "type": "object"
          },
          "last_updated": {
            "type": "string",
            "format": "date-time"
          },
          "total_modules": {
            "type": "integer"
          },
          "total_historical_modules": {
            "type": "integer"
          },
          "total_modules_in_process": {
            "type": "integer"
          },
          "total_certificates_with_algorithms": {
            "type": "integer"
          },
          "total_certificate_details": {
            "type": "integer"
          },
          "features": {
            "type": "object"
          }
        }
      }
    }
  }
}