Download the PHP package craftpulse/craft-audit-kit without Composer
On this page you can find all versions of the php package craftpulse/craft-audit-kit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download craftpulse/craft-audit-kit
More information about craftpulse/craft-audit-kit
Files in craftpulse/craft-audit-kit
Package craft-audit-kit
Short Description Foundational, tamper-evident audit primitives for Craft CMS: a neutral audit event contract, a dispatch bus, a byte-deterministic SHA-256 hash-chain engine, export formatters, SIEM forwarders, and external anchoring. The shared compliance base for the CraftPulse ecosystem.
License MIT
Informations about the package craft-audit-kit
Audit Kit
Audit Kit gives Craft plugins a shared, tamper-evident audit foundation: a neutral audit event contract, a dispatch bus, and a byte-deterministic SHA-256 hash-chain engine, so every plugin on an install writes to one verifiable trail instead of inventing its own.
Audit Kit is a library-shipped Yii module, not a Craft plugin. It has no Plugin Store entry, never appears in Craft's installed-plugins list, has no control panel surface, and cannot be enabled or disabled. Its audience is developers building plugins that consume it.
Features
- A neutral audit event contract shared by every consuming plugin, with its shape frozen at 1.0.0.
- A dispatch bus that fans one recorded event out to every registered sink, isolating each sink from the others.
- A runtime event-type registry with fail-closed allowlists for
detailskeys. - A byte-deterministic canonicalizer and hash-chain writer, with serialized writes retried under contention.
- Chain verification with first-divergence reporting and retention-boundary tolerance.
- Streaming export to CSV, JSONL, JSON, HTML, and PDF.
- SIEM delivery over RFC 5424 syslog, signed webhooks, HTTP JSON, and S3.
- External anchoring through RFC 3161 timestamping and S3 Object Lock, with signed certificates of integrity.
- A standalone chain verifier that runs without Craft or Composer.
- An Auth Kit bridge that relays authentication events onto the audit bus.
Requirements
Craft CMS
Audit Kit requires Craft CMS 5.0.0 or greater.
PHP
Audit Kit requires PHP 8.2 or greater.
A consuming plugin
Audit Kit is never installed on its own. A consuming plugin requires the package and bootstraps the module by calling AuditKit::register().
Installation
Audit Kit is a library package. There is no Plugin Store entry and no plugin/install step.
You can add the package to your plugin using Composer and the command line.
-
Open your terminal and go to your plugin:
- Tell Composer to require the package:
Or add it as a requirement in your plugin's composer.json directly:
DDEV
If your project runs in DDEV, run the same command through DDEV from the project root:
Next steps
Requiring the package is not enough on its own. Audit Kit does nothing until a consuming plugin wires it up:
- Call
AuditKit::register()from your plugin'sinit(). - Call
AuditKit::getInstance()->getMigrator()->up()from yourInstallmigration'ssafeUp(). - Register a sink, or emit events onto the bus, or both.
See Installation and setup for the full wiring.
Documentation
Full documentation lives in docs/.
Licensing
Audit Kit is released under the MIT License. See LICENSE.md for the full text.
Support
File issues at github.com/craftpulse/craft-audit-kit/issues, or email [email protected].