sassoftware / relic Goto Github PK

View Code? Open in Web Editor NEW

144.0 16.0 39.0 5.38 MB

Relic is a service and a tool for adding digital signatures to operating system packages for Linux and Windows

License: Apache License 2.0

Go 98.92% Shell 1.08% PowerShell 0.01%

relic's Introduction

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
Mach-O - macOS/iOS signed executables
DMG, PKG - macOS disk images / installer packages
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
Cloud services - AWS, Azure and Google Cloud managed keys
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, Windows and MacOS 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

Pre-built client binaries are available from the Github releases page. Alternately, relic can be built from source:

go install github.com/sassoftware/relic/v7@latest

The following build tags are also available:

clientonly - build a lightweight binary without standalone signing features

See doc/relic.yml for an example configuration.

Additional documentation

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

relic's People

Contributors

Stargazers

Watchers

relic's Issues

Mach-O signing problem with pkcs12

The signing configuration I used is this:

keys:
  devid:
    token: file
    keyfile: <path to p12 file>
    timestamp: true
    ispkcs12: true

tokens:
  file:
    type: file
timestamp:
  urls:
    - http://timestamp.apple.com/ts01

And this is the command:

relic sign -k devid -f <Mach-O binary> --hardened-runtime --config ./relic.yml

Signing succeeds, but when I verify with relic I get this:

> relic verify ./<Mach-O binary>
./<Mach-O binary> ERROR: validating timestamp: x509: “Timestamp Signer NWK1” certificate is not permitted for this usage
ERROR: 1 or more files did not validate

Verifying with codesign also fails:

> codesign -vvv ./macnotary
./<Mach-O binary>: CSSMERR_TP_NOT_TRUSTED
In architecture: x86_64

The relic version I have used:

relic version v7.6.2 (h1:rS44Lbv9G9eXsukknS4mSjIAuuX+lMq/FnStgmZlUv4=)

The host I ran this is: 14.2.1 (23C71) - MacOS Sonoma

Is this a bug, or there is a problem in the process I followed?

Apk Code Signning

Hi, i used relic.exe to sign a apk file nicely, but it contains only the APK Signature Scheme V2 which was introduced in Android 7.0.
How to sign a apk and contains both v1 and v2 signatures？

Include hardened-runtime flag during DMG signing

Currently DMG files are signed without hardened-runtime which may cause apple notarization process to fail. Can this flag be added to DMG signing logic?

Support for NuGet package signing

Would be great if Relic had support for NuGet package signing.

failed to parse pe sections for some file

go run main_client.go verify 03c05ac7e5dad2bf0026530453c04a73f6e5a1a9916b8b30e92292f4ae64879f
03c05ac7e5dad2bf0026530453c04a73f6e5a1a9916b8b30e92292f4ae64879f ERROR: PE sections are out of order
ERROR: 1 or more files did not validate
exit status 1

03c05ac7e5dad2bf0026530453c04a73f6e5a1a9916b8b30e92292f4ae64879f.zip

Adding support for description in Windows

SignTool provides a parameter called "description" which is used to display the name of the program in certain scenarios. It would be great if there was a possibility to specify the description as it is quite common to use it when signing files for Windows operating systems.

comdoc panic: runtime error: index out of range [-2]

package main

import (
	"io"
	"net/http"
	"os"

	"github.com/sassoftware/relic/v7/lib/comdoc"
)

func main() {
	f, err := os.CreateTemp("", "")
	if err != nil {
		panic(err)
	}
	resp, err := http.Get("https://github.com/decalage2/oletools/raw/master/tests/test-data/encrypted/dde-test-encrypt-standardpassword.xls")
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	if _, err := io.Copy(f, resp.Body); err != nil {
		panic(err)
	}

	doc, err := comdoc.WriteFile(f)
	if err != nil {
		panic(err)
	}

	var b [10000]byte
	if err := doc.AddFile("file", b[:]); err != nil {
		panic(err)
	}
	if err := doc.Close(); err != nil {
		panic(err)
	}
}

➜  asd git:(master) ✗ go run main.go
panic: runtime error: index out of range [-2]

goroutine 1 [running]:
github.com/sassoftware/relic/v7/lib/comdoc.freeSectors(...)
	/Users/gabriel.vasile/go/1.20.3/pkg/mod/github.com/sassoftware/relic/[email protected]/lib/comdoc/sectors.go:71
github.com/sassoftware/relic/v7/lib/comdoc.(*ComDoc).writeShortSAT(0x4?)
	/Users/gabriel.vasile/go/1.20.3/pkg/mod/github.com/sassoftware/relic/[email protected]/lib/comdoc/shortsector.go:51 +0x2e8
github.com/sassoftware/relic/v7/lib/comdoc.(*ComDoc).Close(0x1400006c000)
	/Users/gabriel.vasile/go/1.20.3/pkg/mod/github.com/sassoftware/relic/[email protected]/lib/comdoc/writer.go:87 +0x80
main.main()
	/Users/gabriel.vasile/tmp/comdocf/asd/main.go:34 +0x188
exit status 2

Incorrect memory page size computation for PE page hashes algorithm

The software incorrectly computes the page hashes for PE files. It uses the section alignment as a memory page size, which is incorrect. Instead, real architecture page size should be used: https://devblogs.microsoft.com/oldnewthing/20210510-00/?p=105200.

You can easily confirm this bug if you try to verify the page hashes for the C:\Windows\SysWOW64\kernel32.dll file on Windows 10, which uses the section alignment 0x10000, but the real page size is 0x1000:

c:\windows\syswow64\kernel32.dll ERROR: page hash mismatch

You should look at the image file header machine field. If it is IA64 (0x200), Alpha AXP (0x184) or Alpha AXP x64 (0x284), then the page size is 8K. Otherwise, the page size is 4K.

Documentation USB Keys

I'm having a lot of trouble as there is very little documentation and examples are next to impossible to find due to conflicting "New Relic" projects.

I have a SafeNet USB key, and I'm trying to sign an MSIX package on a mac.

From what I gather, I'm supposed to start the server on my local machine, and the client should connect to it. But the server instructions are specific to linux. Do I run this in a docker container and share the USB key to the docker container? Or is USB signing only supported from linux?

I'd be very grateful for some help, this seems to be our last hope to sign in CI as all other methods have failed.

fail to sign msi

Hi, i got to sign a .msi，but report error “
PS C:\Users\rango> relic.exe sign -k my_file_key -c C:\Users\rango\Documents\relic_config\relic.yml -f ..\..\testdata\setup.msi -d 9 ERROR: archive/tar: missed writing 3194 bytes
”
what dose this error mean.....😭

Dmg signer needs to be accessible outside the package

Hi,

Looks like Line 14 of signers/dmg/dmg.go needs to be capitalized to be accessible outside the package. This signer should follow the pattern of the other signers in the signers package and have the global variable capitalized.

signing RPMs with sha256 headers/payloads built with nfpm is not supported

Currently, this module only works for signing RPMs that have md5/sha1 digests. The output below was generated with rpm -Kv to inspect RPMs built with fpm vs nfpm respectively.

    Header SHA1 digest: OK
    MD5 digest: OK

However, RPMs built with nfpm are with sha256 digests:

  Header SHA256 digest: OK
  Payload SHA256 digest: OK

I have uploaded the RPM built with nfpm for your testing purpose: nfpm.zip. You can also rerun the following commands to regenerate the RPM yourself:

nfpm package --config test.yaml --packager rpm

You can further inspect the test RPM:

% rpm -Kv test-1.0.0.x86_64.rpm      
test-1.0.0.x86_64.rpm:
    Header SHA256 digest: OK
    Payload SHA256 digest: OK

% rpm -qpi  test-1.0.0.x86_64.rpm
Name        : test
Epoch       : 0
Version     : 1.0.0
Release     : 1
Architecture: x86_64
Install Date: (not installed)
Group       : 
Size        : 11
License     : MIT
Signature   : (none)
Source RPM  : test-1.0.0-1.src.rpm
Build Date  : Sat Aug 26 11:48:57 2023
Build Host  : buildkitsandbox
Packager    : test maintainer <[email protected]>
Vendor      : 
URL         : https://nfpm.goreleaser.com/
Summary     : Test RPM generated by nFPM
Description :
Test RPM generated by nFPM

please let me know if you need anything additional. Our use case here is to sign nfpm generated RPMs using SignRpmStream method. Currently these methods assumes md5 and sha1 digests by default.

If you try to sign the RPMs built with nfpm, you will get md5 digest mismatch error under current logic. This would be a nice feature as latest enterprise OS (e.g RHEL9) defaults to sha256 checksummed RPMs.

failed to parse some pkcs7 cert

explorer.exe.zip

the error message is

 asn1: structure error: tags don't match (16 vs {class:2 tag:1 length:719 isCompound:true}) {optional:false explicit:false application:false private:false defaultValue:<nil> tag:<nil> stringType:0 timeType:0 set:false omitEmpty:false} certificate @4

Is signing sign .app file for mac supported?

What could be the process of signing the .app file for mac? Should we individually sign all the executables within the .app file? Is there a standard process where we can get a reference to use relic to sign the .app file?

macOS signging

Hi! Have you looked at adding in macOS code signing support?

Unfortunately, I don't know if there are cross platform ways to do it. In my own tools, I'm using Exec to call out

Help : References to build a appx signer in Java

Hello,

I saw "relic" is able to sign appx packages. What was your references to develop it ?
I want to build a .appx signer in java but I found difficulties to find documentation about how theses types of files are signed.

Any help would be appreciated.

Thank you very much.

Maybe support for Apple Notarization

I'm sorry I can't put a patch up, but I wanted to mention that Apple now has a rest API for notarization. I think this creates the possibility of having relic do notary submissions.

https://developer.apple.com/videos/play/wwdc2022/10109 and https://developer.apple.com/documentation/notaryapi specifically.

Caveat -- it requires an S3 upload

Update code for more recent github.com/AzureAD/microsoft-authentication-library-for-go?

Hi. I'm packaging relic for Debian, in order to get sigstore's rekor into Debian. We have github.com/AzureAD/microsoft-authentication-library-for-go in Debian but it is newer than you use, and causes the build error below. Could you update the dependency to the latest version of github.com/AzureAD/microsoft-authentication-library-for-go and fix your code?

# github.com/sassoftware/relic/cmdline/remotecmd
src/github.com/sassoftware/relic/cmdline/remotecmd/azure.go:65:20: cannot use &dvCache{…} (value of type *dvCache) as cache.ExportReplace value in argument to public.WithCache: *dvCache does not implement cache.ExportReplace (wrong type for method Export)
		have Export(cache.Marshaler, string)
		want Export(context.Context, cache.Marshaler, cache.ExportHints) error
src/github.com/sassoftware/relic/cmdline/remotecmd/azure.go:79:12: not enough arguments in call to s.cli.Accounts
	have ()
	want (context.Context)
src/github.com/sassoftware/relic/cmdline/remotecmd/azure.go:79:12: assignment mismatch: 1 variable but s.cli.Accounts returns 2 values
github.com/Azure/go-autorest/autorest/azure/auth

Thanks,
Simon

comdoc writeat: negative offset

I'm not sure if this a bug in library code or a problem with the file that I used for test.

package main

import (
	"fmt"

	"github.com/sassoftware/relic/v7/lib/comdoc"
)

func main() {
	doc, err := comdoc.WritePath("xls.xls")
	if err != nil {
		fmt.Println(err)
	}

	if err := doc.AddFile("filename", []byte{1, 2, 3}); err != nil {
		fmt.Println(err)
	}
}

expected: doc.AddFile returns nil
what happened: doc.AddFile returns writeat xls.xls: negative offset

xls.xls

Nested signing of PE Executable

Hi,

Is it possible to sign PE Executables with both sha1 and sha256 digests? osslsigncode has a "-nest" option for this.

Thanks!

Support for signing multiple files at a time

First of all, let me say I've been testing Relic for our needs and have been very impressed by it. Documentation could be improved, but it only took a couple of hours to get something working.

One minor suggestion for improvement that would be useful, at least when running as a standalone signing tool would be able to provide multiple files to sign at a time (with the same signature type, of course), particularly if that can lead to performance improvements during the operation. For example, we often use SignTool passing in 16-20 files at a time, and it reduces total signing time by ~50% compared to signing them one at a time.

I took a quick look at the code and doesn't seem like the "take multiple files at a time" part would be too hard to do, though not sure about the performance part.

archive/tar: missed writing 500 bytes - JDK11

We're upgrading our installer from JDK8 to JDK11 and the generated MSI files can't be signed.

The error is:

archive/tar: missed writing 500 bytes

We generate the MSI files with the wix toolset (https://wixtoolset.org/documentation/manual/v3/overview/alltools.html)

The way how we generate the MSIs is:

unzip jre.zip -d tmp
JREDIR=tmp/jdk-11.0.16.1+1-jre
echo "JRE=$JREDIR"
heat dir "$JREDIR" -o jre.wxs -sfrag -sreg -nologo -srd -gg -cg JreComponents -dr JreDir -var var.JreDir

# pick up java.exe File ID
JavaExeId=$(grep java.exe jre.wxs | grep -o "fil[0-9A-F]*")

candle -dJreDir="$JREDIR" -dWAR="$war" -dJavaExeId=$JavaExeId -nologo -ext WixUIExtension -ext WixUtilExtension -ext WixFirewallExtension jenkins.wxs jre.wxs
# '-sval' skips validation. without this, light somehow doesn't work on automated build environment
# set to -dcl:low during debug and -dcl:high for release
light -o @@ARTIFACTNAME@@.msi -sval -nologo -dcl:high -cultures:en-us -loc en_us.wxl -ext WixUIExtension -ext WixUtilExtension -ext WixFirewallExtension jenkins.wixobj jre.wixobj

If you're interested I can share the MSI installer with you for debug purposes.

If we use the JDK8 JRE, the signing process works fine, it only fails with JDK11.

Relic signing produces corrupted Advanced Installer MSI files

Issue Overview

When signing an Advanced Installer MSI file with Relic, the resulting signed MSI can no longer be executed. If I use SignTool.exe with the same installer and signing certificate then the MSI is successfully signed and not corrupted. This issue seems to be specific to Advanced Installer MSI files as Relic is able to sign other MSI files, such as those generated with WiX or MSIWrapper.

Reproduction Steps

NOTE: The requisite signing certificate, relic.yml, unsigned MSI and corrupted MSI files are all attached at the end of this report.

Creating a Signing Certificate

I used the following PowerShell script to generate a signing certificate:

$certProperties = @{
    DnsName         = "codesigning.local"
    CertStoreLocation = "Cert:\CurrentUser\My"
    KeyUsage        = "DigitalSignature"
    FriendlyName    = "My Code Signing Certificate"
    NotAfter        = (Get-Date).AddYears(5)
    Type            = "CodeSigningCert"
}

$cert = New-SelfSignedCertificate @certProperties

$password = ConvertTo-SecureString -String "password" -Force -AsPlainText
Export-PfxCertificate -Cert $cert.PSPath -FilePath "signingcert.pfx" -Password $password

Creating an Advanced Installer MSI

Download and install Advanced Installer.
Launch Advanced Installer and select "Installer Project | Simple"
Click "Build"
Save the AIP file to the location you want your MSI file.
The MSI file will now be created.

Signing MSI with Relic

relic.yml

tokens:
  file:
    type: file
    pin: password

keys:
  my_file_key:
    token: file
    keyfile: ./signingcert.pfx
    ispkcs12: true

timestamp:
  urls:
    - http://timestamp.digicert.com

Running Relic

relic sign --config relic.yml --file aitestinstaller.msi --output aitestinstallersigned.msi --key my_file_key

Executing the Installer

When attempting to execute the signed MSI, the following dialog is displayed:

Additional Information

Using SignTool.exe

signtool sign /f signingcert.pfx /p password /fd SHA256 /t http://timestamp.digicert.com /v aitestinstaller.msi

Test Files

RelicCorruptedMSITestFiles.zip

relic.yml (Relic Config)
signingcert.pfx (Signing Certificate)
aitestinstaller.msi (Original MSI File)
aitestinstallersigned.msi (Corrupted MSI File)

Arch Linux pkg.tar.zst/pkg.tar.xz support

Hi,
Is there any guide for adding a new pkg format? I would be willing to donate a patch for adding support for Arch Linux based distributions, but I don't know where to start :)

certificate does not match key in token

I'm having a "certificate does not match key in token" issue where the exponent is showing up as 65537 in relic token contents
and the certificate also shows 65537.

I dumped the objects in the SameKey function, and key.E is 16777472, while cert.Leaf.PublicKey.E is 65537, triggering an error (both N are identical and the token works with other apps)

Using a pkcs11 token with an RSA key.

relic/lib/certloader/certloader.go

Line 220 in ffc26ac

return nil, errors.New("certificate does not match key in token")

Extra info:

65537 seems to be a reserved/default value https://www.cryptsoft.com/pkcs11doc/v220/group__SEC__12__1__4__PKCS____1__RSA__KEY__PAIR__GENERATION.html

16777472 is 65537 when using the wrong endianness. So there might be an issue there.

I could try to compare with another token in my possession that was working correctly previously when using a different CA.