Spork Documentation
Installation guides, configuration reference, and API documentation.
Installation
Requirements
- Linux x64 (glibc 2.17+)
- No runtime dependencies
Download
Spork is distributed as a single static binary. Downloads coming soon.
# Extract and install
tar xzf spork-pki-0.2.0-alpha-linux-x86_64.tar.gz
cd spork-pki-0.2.0-alpha
./spork-shell --version
Quick Start
Initialize a new CA with ML-DSA-65 (NIST security level 3):
# Initialize Root CA
spork init \
--type root \
--algorithm mldsa65 \
--subject "CN=My Root CA,O=Example,C=US" \
--validity-years 20
See the Quick Start tab for a complete walkthrough.
Configuration
Spork uses TOML for configuration. See the Configuration tab for full details.
# spork.toml
[ca]
path = "./pki/issuing"
algorithm = "ecdsa-p384"
[database]
type = "sqlite"
path = "spork.db"
[logging]
level = "info"
format = "json"
ACME Server
Spork includes a built-in ACME server compatible with certbot and other ACME clients. Available in v0.2.0-alpha.
# Start ACME server
spork-acme --ca ./pki/issuing --bind 0.0.0.0:8443
EST Enrollment
RFC 7030 Enrollment over Secure Transport for enterprise certificate enrollment. Available in v0.2.0-alpha.
# Start EST server
spork-est --ca ./pki/issuing --bind 0.0.0.0:8444
More Documentation Coming
Additional guides and API reference are in progress. See the main Spork page for current feature documentation.