Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Auernhammer authored Mar 2, 2021
1 parent 71a8bef commit 1a1ab0b
Showing 1 changed file with 57 additions and 1 deletion.
58 changes: 57 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,65 @@
[![Go Reference](https://pkg.go.dev/badge/aead.dev/minisign.svg)](https://pkg.go.dev/aead.dev/minisign)

# minisign
minisign is a dead simple tool to sign files and verify signatures.
minisign is a dead simple tool to sign files and verify signatures.

```
$ minisign -G
Please enter a password to protect the secret key.
Enter Password:
Enter Password (one more time):
Deriving a key from the password in order to encrypt the secret key... done
The secret key was saved as ~/.minisign/minisign.key - Keep it secret!
The public key was saved as minisign.pub - That one can be public.
Files signed using this key pair can be verified with the following command:
minisign -Vm <file> -P RWSYKA736yqh+JrZ7cRDdWgck/WKtwW9ATBFmk8pQ1lHeUKXtV6uJ7Fu
```
```
$ minisign -Sm message.txt
Enter password:
Deriving a key from the password in order to decrypt the secret key... done
```
```
$ minisign -Vm message.txt
Signature and comment signature verified
Trusted comment: timestamp:1614718943 filename:message.txt
```

This is a Go implementation of the [original C implementation](https://github.com/jedisct1/minisign) by [Frank Denis](https://github.com/jedisct1).

## Usage

```
Usage:
minisign -G -p <pubKey> -s <secKey>
minisign -S [-H] [-x <signature>] [-s <secKey>] [-c <comment>] [-t <comment>] -m <file>...
minisign -V [-x <signature>] [-p <pubKey> | -P <pubKey>] [-o] [-q | -Q ] -m <file>
minisign -R -s <secKey> -p <pubKey>
Options:
-G Generate a new public/secret key pair.
-S Sign files with a secret key.
-V Verify files with a public key.
-m <file> The file to sign or verify.
-o Combined with -V, output the file after verification.
-H Combined with -S, pre-hash in order to sign large files.
-p <pubKey> Public key file (default: ./minisign.pub)
-P <pubKey> Public key as base64 string
-s <secKey> Secret key file (default: $HOME/.minisign/minisign.key)
-x <signature> Signature file (default: <file>.minisig)
-c <comment> Add a one-line untrusted comment.
-t <comment> Add a one-line trusted comment.
-q Quiet mode. Suppress output.
-Q Pretty quiet mode. Combined with -V, only print the trusted comment.
-R Re-create a public key file from a secret key.
-f Combined with -G or -R, overwrite any existing public/secret key pair.
-v Print version information.
```

## Library

```Go
Expand Down

0 comments on commit 1a1ab0b

Please sign in to comment.