Skip to main content

Parses ssh2 keys and converts to multiple formats.

Project description

ssh2_parse_key

ci documentation pypi version

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.


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

Installation

With pip:

python3.6 -m pip install ssh2_parse_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.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.

Development on the python version was done by Nigel Metheringham <nigelm@cpan.org>


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssh2_parse_key-0.8.0.tar.gz (19.0 kB view hashes)

Uploaded Source

Built Distribution

ssh2_parse_key-0.8.0-py3-none-any.whl (19.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page