ssh2_parse_key 0.3.0

Parses ssh2 keys and converts to multiple formats.

SSH2 Key Parsing

Parses ssh2 public keys in either openssh or RFC4716/Secsh formats and converts to either format.

At this point any attempt to work with private keys will raise an exception.

• Free software: MIT license

• Documentation: https://ssh2-parse-key.readthedocs.io.

Features

• Reads public keys of the following encryption types:-

  • ssh-rsa

  • ssh-dss

  • ecdsa-sha2-nistp256

  • ssh-ed25519

• Reads either Openssh or RFC4716 format public keys

• Can read input sets with either or both formats in

• Can output either format for any key

Usage

To use SSH2 Key Parsing in a project:

from ssh2_parse_key import Ssh2Key

# although you can create the object from internal data the normal method
# would be to use the parse() or parse_file() which return a list of Ssh2Key objects.
# Ssh2Key objects are immutable.
# Load one or more keys in either openssh or RFC4716 from a file
keys = Ssh2Key.parse_file("/path/to/public_key")

# alternatively
data = Path("/path/to/public_key").read_text()
keys = Ssh2Key.parse(data)

# now those keys can be dealt with...
for public_key in keys:
    print(f"This is a {key.type} key")
    print(f"It uses {key.encryption} encryption")
    print(f"comment = {key.comment}")
    print(f"subject = {key.subject}")

    print("RFC4716 format representation")
    print(key.rfc4716)

    print("OpenSSH representation")
    print(key.openssh)

Credits

The package is strongly based on the perl Parse::SSH2::PublicKey module.

The class is built using Michael DeHaan’s ClassForge object system.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-05-07)

• First builds - never release on PyPI.

0.2.x (2020-09-25)

• First release

• Documentation build

• CI and release automation

0.3.x (2020-09-27)

• Fixed up documentation

• Added a few additional tests

• This is now reasonably presentable