# README

sigtool/sign - Ed25519 signature calculation and verification

This is a small library that makes it easier to create and serialize Ed25519 keys, and sign, verify files using those keys. The library uses mmap(2) to read and process very large files.

The companion program sigtool uses this library.

License

GPL v2.0

# Functions

Debug

Enable debugging of this module; level > 0 elicits debug messages on os.Stderr.

MakePrivateKey

Make a private key from bytes 'yml' using optional caller provided getpw() function to read the password if needed.

MakePublicKey

Parse a serialized public in 'yml' and return the resulting public key instance.

MakePublicKeyFromString

Make a public key from a string.

NewDecryptor

Create a new decryption context and if 'pk' is given, check that it matches the sender.

NewEncryptor

Create a new Encryption context for encrypting blocks of size 'blksize'.

NewPrivateKey

NewPrivateKey generates a new Ed25519 private key.

ParseAuthorizedKeys

ParseAuthorizedKeys parses a public key from an authorized_keys file used in OpenSSH according to the sshd(8) manual page.

ReadPrivateKey

Read the private key in 'fn', optionally decrypting it using password 'pw' and create new instance of PrivateKey.

ReadPublicKey

Read the public key from 'fn' and create new instance of PublicKey.

ReadSignature

Read serialized signature from file 'fn' and construct a Signature object.

# Constants

PKHashLength

Length of Ed25519 Public Key Hash.