Module ssh

Functions or structs for dealing with SSH Certificates. Parsing, and creating certs happens here. This module is a heavily modified version of the sshkeys crate that adds certificate verification, and many other things to support that. The original licence for the code is in the source code provided

Structs

AllowedSigner

A type which represents an allowed signer entry. Please refer to [ssh-keygen-1.ALLOWED_SIGNERS] for more details about the format. [ssh-keygen-1.ALLOWED_SIGNERS]: https://man.openbsd.org/ssh-keygen.1#ALLOWED_SIGNERS

AllowedSigners

A type which represents a collection of allowed signer entries. Please refer to [ssh-keygen-1.ALLOWED_SIGNERS] for more details about the format. [ssh-keygen-1.ALLOWED_SIGNERS]: https://man.openbsd.org/ssh-keygen.1#ALLOWED_SIGNERS

Certificate

A type which represents an OpenSSH certificate key. Please refer to [PROTOCOL.certkeys] for more details about OpenSSH certificates. [PROTOCOL.certkeys]: https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.certkeys?annotate=HEAD

Curve

A type which represents a cryptographic curve.

EcdsaPrivateKey

ECDSA private key.

EcdsaPublicKey

ECDSA public key. The format of ECDSA public keys is described in RFC 5656, section 3.1.

EcdsaSkPrivateKey

Hardware backed ECDSA private key.

Ed25519PrivateKey

ED25519 private key.

Ed25519PublicKey

ED25519 public key. The format of ED25519 public keys is described in https://tools.ietf.org/html/draft-bjh21-ssh-ed25519-02

Ed25519SkPrivateKey

Hardware backed Ed25519 private key.

Fingerprint

A type that represents an OpenSSH public key fingerprint.

KeyType

KeyType represents the type of an OpenSSH key.

PrivateKey

A type which represents an OpenSSH private key.

PublicKey

A type which represents an OpenSSH public key.

Reader

A Reader is used for reading from a byte sequence representing an encoded OpenSSH public/private key or certificate.

RsaPrivateKey

RSA private key.

RsaPublicKey

RSA public key. The format of RSA public keys is described in RFC 4253, section 6.6

SshSignature

An SSH signature object from signing arbitrary data. This object has not been verified against a message so it is untrusted.

VerifiedSshSignature

An SSH signature that has an attached message we’ve successfully verified against the signature.

Writer

A Writer is used for encoding a key in OpenSSH compatible format.

Enums

AllowedSignerParsingError

A type to represent the different kinds of errors.

CertType

Represents the different types a certificate can be.

CurveKind

Represents the different kinds of supported curves.

FingerprintKind

The FingerprintKind enum represents the different fingerprint representation.

HashAlgorithm

The hash algorithm used to sign the data in the SshSignature

KeyTypeKind

A type which represents the various kinds of keys.

PrivateKeyKind

A type which represents the different kinds a public key can be.

PublicKeyKind

A type which represents the different kinds a public key can be.

Traits

SSHCertificateSigner

Types that implement this trait can be used to sign SSH certificates using the Certificate::sign function.