blackoutsecure/Blackout Secure Security TXT Generator

Generate RFC 9116-compliant security.txt for responsible vulnerability disclosure. Automated deployment with GitHub Actions.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
public_dirDirectory to write security.txt (default: dist). File will be placed in .well-known/ subdirectory per RFC 9116.nodist
site_urlPublic base URL of the site, e.g., https://example.com. Used for canonical URI (optional).no
security_contactContact method(s) for security vulnerability reports (REQUIRED per RFC 9116). Comma-separated list. Must be a URI: mailto:, https://, or tel:. Auto-converts emails. Example: security@example.com,https://example.com/securityyes
security_expiresExpiration date for security.txt validity. Formats: ISO 8601 (2026-12-31T23:59:59Z), days (180d), months (6m), years (1y). Default: 180d (6 months). RFC 9116 recommends < 1 year (365 days).no180d
security_acknowledgmentsOptional: URL(s) to security researchers hall of fame page. Must use https://. Comma-separated for multiple.no
security_canonicalOptional: Canonical URI(s) where this file is located. Must use https://. Auto-generated from site_url if not provided. Comma-separated for multiple.no
security_encryptionOptional: URL(s) to OpenPGP encryption key for secure communication. Must use https:// or openpgp4fpr: scheme. Comma-separated for multiple.no
security_hiringOptional: URL(s) to security-related job postings. Must use https://. Comma-separated for multiple.no
security_policyOptional: URL(s) to vulnerability disclosure policy page. Must use https://. Comma-separated for multiple.no
security_preferred_languagesOptional: Comma-separated language codes for preferred report languages (e.g., "en, es, fr"). Uses RFC 5646 language tags.no
security_commentsInclude RFC 9116 reference comments at the top of security.txtnotrue
upload_artifactsUpload generated security.txt as GitHub artifactsnotrue
artifact_nameName of the GitHub artifact when upload_artifacts is enablednosecuritytxt
artifact_retention_daysNumber of days to retain the artifact (1-90). Leave empty for default (35 days)no
debugDebug: Display generated security.txt contentnofalse
namedescription
security_pathPath to the generated security.txt