capvalidator 0.1.0.dev4

Python module to validate a CAP message against the OASIS CAP 1.2 schema and verify the XML signature.

The CAP Validator

The Python module for ensuring the validity of CAP alerts.

Features

• Schema Validation: Ensure your CAP XML file follows the CAP v1.2 standard.
• Digital Signature Validation: Verify that the CAP XML file comes from a legitimate source and has not been tampered with.

Note: Currently, only certificates issued by a trused certificate authority (CA) are supported. This means signatures with a self-signed certificate will not pass the validation.

Getting Started

1. Installation

pip install capvalidator

2A. Using the API

We can perform a total validation of the CAP XML file using validate_cap_message(cap, strict).

• cap: The CAP alert XML byte string.
• strict: Whether or not signature validation is enforced. Defaults to True.

from capvalidator import validate_cap_message

# Read the CAP XML file as a byte string
with open(<cap-file-directory>, "rb") as f:
    cap = f.read()

# Perform the validation
result = validate_cap_message(cap, strict=True)

# Check the result
passed = result.passed
msg = result.msg

if not passed:
    # Logic for handling invalid CAP file

# Logic for handling valid CAP file

Or, alternatively, we can perform a more refined validation using check_schema(cap) and/or check_signature(cap):

from capvalidator import check_schema, check_signature

# Read the CAP XML file as a byte string
with open(<cap-file-directory>, "rb") as f:
    cap = f.read()

# Validate the schema
schema_result = check_schema(cap)

# Check the results
passed = schema_result.passed
msg = schema_result.msg

if not passed:
    # Logic for handling invalid CAP file

# Validate the signature
signature_result = check_signature(cap)

# Check the results
passed = signature_result.passed
msg = signature_result.msg

if not passed:
    # Logic for handling invalid CAP file

# Logic for handling valid CAP file

There is also a date extractor get_dates(cap) which you may find useful:

from capvalidator import get_dates

# Read the CAP XML file as a byte string
with open(<cap-file-directory>, "rb") as f:
    cap = f.read()

dts = get_dates(cap)

sent_date = dts.sent
effective_date = dts.effective
onset_date = dts.onset
expiry_date = dts.expiry

2B. Using the CLI

We can perform a total validation of the CAP XML file:

capvalidator validate <cap-file-directory>

By default this includes schema and signature validation.

To manually enable/disable enforcement of a valid XML signature, we can use the --strict or --no-strict arguments respectively:

capvalidator validate --strict <cap_file-directory> 

capvalidator validate --no-strict <cap_file-directory> 

Or, alternatively, for more refined validations we can use the --type argument:

capvalidator validate --type schema <cap-file-directory>

capvalidator validate --type signature <cap-file-directory>

Bugs and Issues

All bugs, enhancements and issues are managed on GitHub.

Contact

• Rory Burke