SSZcreate/Pentab_server / .agents/skills/cybersecurity/skills/implementing-api-schema-validation-security
implementing-api-schema-validation-security
VerifiedImplements API schema validation using OpenAPI Specification and JSON Schema documents, enforced both at the API gateway (runtime) and during development (shift-left), to lock down request/response contracts and reject unknown properties. Use when preventing injection attacks (SQLi, XSS, XXE), blocking mass assignment, or stopping data leakage through unvalidated API responses.
| File | Kind | Size |
|---|---|---|
| LICENSE | other | 11.0 KB |
| SKILL.md | skill md | 13.5 KB |
| references/api-reference.md | markdown | 1.5 KB |
| scripts/agent.py | script | 6.9 KB |
scripts/agent.py
View on GitHub#!/usr/bin/env python3
"""Agent for auditing API schema validation security using OpenAPI specs."""
import json
import argparse
from datetime import datetime
try:
import yaml
except ImportError:
yaml = None
try:
import jsonschema
except ImportError:
jsonschema = None
def load_openapi_spec(spec_path):
"""Load an OpenAPI specification file."""
with open(spec_path) as f:
if spec_path.endswith((".yaml", ".yml")):
return yaml.safe_load(f)
return json.load(f)
def audit_schema_validation(spec):
"""Audit OpenAPI spec for missing schema validation."""
findings = []
paths = spec.get("paths", {})
for path, methods in paths.items():
for method, details in methods.items():
if method in ("get", "post", "put", "patch", "delete"):
request_body = details.get("requestBody", {})
if method in ("post", "put", "patch") and not request_body:
findings.append({
"path": path, "method": method.upper(),
"issue": "no_request_body_schema", "severity": "HIGH",
})
elif request_body:
content = request_body.get("content", {})
for media, media_def in content.items():
schema = media_def.get("schema", {})
if not schema:
findings.append({
"path": path, "method": method.upper(),
"issue": "empty_request_schema", "severity": "HIGH",
})
elif schema.get("additionalProperties") is not False:
findings.append({
"path": path, "method": method.upper(),
"issue": "additional_properties_allowed",
"severity": "MEDIUM",
"risk": "mass_assignment",
})
params = details.get("parameters", [])
for param in params:
if not param.get("schema"):
findings.append({
"path": path, "method": method.upper(),
"parameter": param.get("name"),
"issue": "parameter_no_schema", "severity": "MEDIUM",
})
elif param.get("schema", {}).get("type") == "string":
schema = param["schema"]
if not schema.get("maxLength") and not schema.get("pattern"):
findings.append({
"path": path, "method": method.upper(),
"parameter": param.get("name"),
"issue": "string_no_max_length", "severity": "MEDIUM",
"risk": "injection",
})
responses = details.get("responses", {})
for code, resp in responses.items():
content = resp.get("content", {})
for media, media_def in content.items():
schema = media_def.get("schema", {})
if not schema:
findings.append({
"path": path, "method": method.upper(),
"response_code": code,
"issue": "no_response_schema", "severity": "MEDIUM",
"risk": "data_exposure",
})
return findings
def check_security_definitions(spec):
"""Check security scheme definitions in OpenAPI spec."""
findings = []
version = spec.get("openapi", spec.get("swagger", ""))
if version.startswith("3"):
security_schemes = spec.get("components", {}).get("securitySchemes", {})
else:
security_schemes = spec.get("securityDefinitions", {})
if not security_schemes:
findings.append({"issue": "no_security_schemes_defined", "severity": "CRITICAL"})
global_security = spec.get("security", [])
if not global_security:
findings.append({"issue": "no_global_security", "severity": "HIGH"})
paths = spec.get("paths", {})
for path, methods in paths.items():
for method, details in methods.items():
if method in ("get", "post", "put", "patch", "delete"):
op_security = details.get("security")
if op_security == []:
findings.append({
"path": path, "method": method.upper(),
"issue": "security_explicitly_disabled", "severity": "CRITICAL",
})
return findings
def validate_request_payload(schema_path, payload_path):
"""Validate a request payload against a JSON schema."""
if jsonschema is None:
return {"error": "jsonschema not installed"}
with open(schema_path) as f:
schema = json.load(f)
with open(payload_path) as f:
payload = json.load(f)
errors = []
v = jsonschema.Draft7Validator(schema)
for error in v.iter_errors(payload):
errors.append({
"path": list(error.path),
"message": error.message,
"schema_path": list(error.schema_path),
})
return {"valid": len(errors) == 0, "errors": errors}
def main():
parser = argparse.ArgumentParser(description="API Schema Validation Security Agent")
parser.add_argument("--spec", help="OpenAPI spec file (JSON/YAML)")
parser.add_argument("--schema", help="JSON Schema for validation")
parser.add_argument("--payload", help="Request payload to validate")
parser.add_argument("--output", default="schema_validation_report.json")
parser.add_argument("--action", choices=["audit", "security", "validate", "full"],
default="full")
args = parser.parse_args()
report = {"generated_at": datetime.utcnow().isoformat(), "findings": {}}
if args.spec:
spec = load_openapi_spec(args.spec)
if args.action in ("audit", "full"):
f = audit_schema_validation(spec)
report["findings"]["schema_audit"] = f
print(f"[+] Schema validation issues: {len(f)}")
if args.action in ("security", "full"):
f = check_security_definitions(spec)
report["findings"]["security_schemes"] = f
print(f"[+] Security definition issues: {len(f)}")
if args.action == "validate" and args.schema and args.payload:
result = validate_request_payload(args.schema, args.payload)
report["findings"]["validation"] = result
print(f"[+] Validation: {'PASS' if result.get('valid') else 'FAIL'}")
with open(args.output, "w") as fout:
json.dump(report, fout, indent=2, default=str)
print(f"[+] Report saved to {args.output}")
if __name__ == "__main__":
main()
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 465k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 465k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 465k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 192k | Updated | Claude CodeCodex | Verified | Install |