https://github.com/jedisct1/zig-minisign

Minisign reimplemented in Zig.
https://github.com/jedisct1/zig-minisign

crypto minisign signatures zig zig-package

Last synced: about 1 month ago
JSON representation

Minisign reimplemented in Zig.

• Host: GitHub
• URL: https://github.com/jedisct1/zig-minisign
• Owner: jedisct1
• License: other
• Created: 2020-12-05T21:33:09.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-23T11:29:21.000Z (3 months ago)
• Last Synced: 2024-06-23T12:37:25.695Z (3 months ago)
• Topics: crypto, minisign, signatures, zig, zig-package
• Language: Zig
• Homepage:
• Size: 94.7 KB
• Stars: 47
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-zig - zig-minisign🗒️Minisign reimplemented in Zig

README

        
# zig-minisign

A Zig implementation of [Minisign](https://jedisct1.github.io/minisign/).

`minizign` was primarily designed to verify signatures, although signing is likely to be implemented next.

## Compilation

Requires the current `master` version of [Zig](https://ziglang.org).

Compile with:

```sh

zig build -Doptimize=ReleaseSmall

```

for a size-optimized version, or

```sh

zig build -Doptimize=ReleaseFast

```

for a speed-optimized version.

## Usage

```text

Usage:

    -h, --help                  Display this help and exit

    -p, --publickey-path  Public key path to a file

    -P, --publickey     Public key, as a BASE64-encoded string

    -l, --legacy                Accept legacy signatures

    -m, --input           Input file

    -q, --quiet                 Quiet mode

    -V, --verify                Verify

    -C, --convert               Convert the given public key to SSH format

```

## Example

Verify `public-resolvers.md` using `public-resolvers.md.minisig` and the public key file `minisig.pub`:

```sh

minizign -p minisign.pub -Vm public-resolvers.md

```

Verify `public-resolvers.md` by directly providing the public key on the command-line:

```sh

minizign -P RWQf6LRCGA9i53mlYecO4IzT51TGPpvWucNSCh1CBM0QTaLn73Y7GFO3 -Vm public-resolvers.md

```

## SSH-encoded public keys

`minizign` can encode public keys in SSH format, so that they can be uploaded to GitHub:

```sh

minizign -p minisign.pub -C

```

```text

ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIHmlYecO4IzT51TGPpvWucNSCh1CBM0QTaLn73Y7GFO3 minisign key E7620F1842B4E81F

```

GitHub makes public SSH keys available at `https://github.com/.keys`.

SSH-encoded keys can be loaded by `minizign` the same way as native keys, with `-p `. They will be automatically recognized as such.

## Features

`minizign` supports prehashing (which can be forced if you know this is how the signature was created), has zero dependencies and can be cross-compiled to anything that Zig can cross-compile to, including WebAssembly.