README
¶
relic is a multi-tool and server for package signing and working with hardware security modules (HSMs).
Package types
- RPM - RedHat packages
- DEB - Debian packages
- JAR - Java archives
- EXE (PE/COFF) - Windows executable
- MSI - Windows installer
- appx, appxbundle - Windows universal application
- CAB - Windows cabinet file
- CAT - Windows security catalog
- XAP - Silverlight and legacy Windows Phone applications
- PS1, PS1XML, MOF, etc. - Microsoft Powershell scripts and modules
- manifest, application - Microsoft ClickOnce manifest
- VSIX - Visual Studio extension
- APK - Android package
- PGP - inline, detached or cleartext signature of data
Token types
relic can work with several types of token:
- pkcs11 - Industry standard PKCS#11 HSM interface using shared object files
- scdaemon - The GnuPG scdaemon service can enable access to OpenPGP cards (such as Yubikey NEO)
- file - Private keys stored in a password-protected file
Features
Relic is primarily meant to operate as a signing server, allowing clients to authenticate with a TLS certificate and sign packages remotely. It can also be used as a standalone signing tool.
Other features include:
- Generating and importing keys in the token
- Importing certificate chains from a PKCS#12 file
- Creating X509 certificate signing requests (CSR) and self-signed certificates
- Limited X509 CA support -- signing CSRs and cross-signing certificates
- Creating simple PGP public keys
- RSA and ECDSA supported for all signature types
- Verify signatures, certificate chains and timestamps on all supported package types
- Sending audit logs to an AMQP broker, with an optional sealing signature
- Save token PINs in the system keyring
Platforms
Linux and Windows are supported. Other platforms probably work as well.
relic is tested using libsofthsm2 and Gemalto SafeNet Network HSM (Luna SA). Every vendor PKCS#11 implementation has quirks, so if relic doesn't work with your hardware please submit a pull request.
Installation
- Install ltdl development headers, i.e.
a.
dnf install libtool-ltdl-devel
or b.apt-get install libltdl-dev
go get github.com/sassoftware/relic
relic can also be built as a client-only tool, removing the dependency on ltdl, by building with -tags pure
or by disabling cgo.
See distro/linux/relic.yml for an example configuration.
Related projects
- SoftHSMv2 - file-based PKCS#11 implementation for testing https://github.com/opendnssec/SoftHSMv2
- uts-server - timestamping server for testing https://github.com/kakwa/uts-server
- osslsigncode - Signs EXEs, MSIs, and CABs using openssl https://sourceforge.net/projects/osslsigncode/
- fb-util-for-appx - Builds signed APPX archives https://github.com/facebook/fb-util-for-appx
- OpenVsixSignTool - Sign VSIX extensions using an Azure key vault https://github.com/vcsjones/OpenVsixSignTool
Reference specifications
- PE/COFF specification - https://www.microsoft.com/en-us/download/details.aspx?id=19509
- Authenticode PE specification - http://download.microsoft.com/download/9/c/5/9c5b2167-8017-4bae-9fde-d599bac8184a/Authenticode_PE.docx
- Microsoft ClickOnce manifest structure - https://msdn.microsoft.com/en-us/library/dd947276(v=office.12).aspx
- Microsoft Compound File format (for MSI) - https://msdn.microsoft.com/en-us/library/dd942138.aspx
- Alternate reference for compound document format from OpenOffice - https://www.openoffice.org/sc/compdocfileformat.pdf
Directories
¶
Path | Synopsis |
---|---|
cmdline
|
|
internal
|
|
lib
|
|
atomicfile
Implement atomic write-rename file pattern.
|
Implement atomic write-rename file pattern. |
binpatch
A means of conveying a series of edits to binary files.
|
A means of conveying a series of edits to binary files. |
comdoc
Microsoft Compound Document File Reference: https://www.openoffice.org/sc/compdocfileformat.pdf ERRATA: The above document says the 0th sector is always 512 bytes into the file.
|
Microsoft Compound Document File Reference: https://www.openoffice.org/sc/compdocfileformat.pdf ERRATA: The above document says the 0th sector is always 512 bytes into the file. |
pkcs7
PKCS#7 is a specification for signing or encrypting data using ASN.1 structures.
|
PKCS#7 is a specification for signing or encrypting data using ASN.1 structures. |
pkcs8
PKCS#8 is a specification for encoding private keys into an ASN.1 structure.
|
PKCS#8 is a specification for encoding private keys into an ASN.1 structure. |
pkcs9
PKCS#9 is a specification for trusted timestamping.
|
PKCS#9 is a specification for trusted timestamping. |
redblack
Simple, incomplete red-black tree implementation meant only to rebuild the directory tree of a CDF file.
|
Simple, incomplete red-black tree implementation meant only to rebuild the directory tree of a CDF file. |
xmldsig
Implements a useful subset of the xmldsig specification for creating signatures over XML documents.
|
Implements a useful subset of the xmldsig specification for creating signatures over XML documents. |