Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tubone24/ssh_config_json

SSH Config JSON is dumping JSON for your ssh config include IdentityFiles and restoring those.
https://github.com/tubone24/ssh_config_json

aes backup pem ssh-config

Last synced: 1 day ago
JSON representation

SSH Config JSON is dumping JSON for your ssh config include IdentityFiles and restoring those.

Host: GitHub
URL: https://github.com/tubone24/ssh_config_json
Owner: tubone24
License: mit
Created: 2020-11-02T01:41:16.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-11-23T00:30:56.000Z (about 1 month ago)
Last Synced: 2024-12-23T23:30:30.463Z (3 days ago)
Topics: aes, backup, pem, ssh-config
Language: Python
Homepage: https://ssh-config-json.readthedocs.io/en/latest/
Size: 74.2 KB
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 20
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ===============

SSH Config JSON

===============

``SSH Config JSON`` is dumping JSON for your ssh config include IdentityFiles and restoring those.

------

.. image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat

   :target: https://github.com/tubone24/ebook_homebrew/blob/master/LICENSE

   :alt: LICENSE

.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

   :target: http://makeapullrequest.com

   :alt: PR Welcomes

.. image:: https://github.com/tubone24/ssh_config_json/workflows/TestingPythonPackage/badge.svg

   :target: https://github.com/tubone24/ssh_config_json/actions?query=workflow%3ATestingPythonPackage

   :alt: GitHub Actions

.. image:: https://coveralls.io/repos/github/tubone24/ssh_config_json/badge.svg?branch=main

   :target: https://coveralls.io/github/tubone24/ssh_config_json?branch=main

   :alt: Coverage

.. image:: https://img.shields.io/pypi/dm/ssh-config-json.svg

   :target: https://pypi.org/project/ssh-config-json/

   :alt: PyPI downloads

.. image:: https://img.shields.io/pypi/v/ssh-config-json.svg

   :target: https://pypi.org/project/ssh-config-json/

   :alt: pip Version

.. image:: https://img.shields.io/pypi/pyversions/ssh-config-json.svg

   :target: https://pypi.org/project/ssh-config-json/

   :alt: Python Version

.. image:: https://img.shields.io/pypi/format/ssh-config-json.svg

   :target: https://pypi.org/project/ssh-config-json/

   :alt: pip Format

.. image:: https://readthedocs.org/projects/ssh-config-json/badge/?version=latest

   :target: https://ssh-config-json.readthedocs.io/en/latest/?badge=latest

   :alt: Documentation Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

   :target: https://github.com/psf/black

   :alt: Black Format

``SSH Config JSON`` enables you to pack and restore your SSH Config and Private Key in JSON format,

allowing you to backup, put to CI and share with others in the project.

Features

========

* Dumping your SSH Config to JSON and restore it

* Packing up IdentityFiles with the JSON

* AES encrypting with the JSON to enable pushing and saving public GitHub Repository

Getting Started

===============

``SSH Config JSON`` uses ``The Python Package Index(Pypi)``, so that you can use ``pip`` installer.

pip installer

----------------------

.. code-block:: bash

   $ pip install ssh-config-json

Usage

=====

You can use global command ``scj`` .

Show help.

.. code-block:: bash

   $ scj -h

   SSH Config JSON

   Overview:

     Dump JSON for your ssh config include IdentityFiles and restore those.

   Usage:

     scj [-h|--help] [-v|--version]

     scj dump  [-c|--config=] [-i|--identityFile]　[-e|--encrypt] [--key=]

     scj restore  [-c|--config=] [-i|--identityFile]　[-d|--decrypt=]

   Options:

     dump                       : dump SSH Config file to JSON

     restore                    : Restore SSH Config file from JSON

                          : Dumped json file

     -h, --help                 : Help

     -v, --version              : Show version

     -c, --config=      : Specific SSH Config file path [default: ~/.ssh/config]

     -i, --identityFile         : Include IdentityFiles

     -e, --encrypt              : Encrypt JSON dump with AES

     --key=                : Set specify key string

     -d, --decrypt=        : Decrypt JSON dump with AES

Ex1) Dump your SSH Config to JSON

.. code-block:: bash

   $ scj dump dump_config.json

Ex2) Dump your SSH Config to JSON with IdentityFiles

.. code-block:: bash

   $ scj dump dump_config.json -i

Ex3) Restore JSON to SSH Config

.. code-block:: bash

   $ scj restore dump_config.json

Ex4) Restore JSON to SSH Config with IdentityFiles

.. code-block:: bash

   $ scj restore dump_config.json -i

Ex5) Dump your SSH Config to JSON with AES Encrypt

.. code-block:: bash

   $ scj dump dump_config.json -i -e

   Encrypt key: 1mado1wmf9amsie0jvo0kfmai9cjasfv # <= This is the "Key"!!

Ex6) Decrypt it

.. code-block:: bash

   $ scj restore dump_config.json -i -d 1mado1wmf9amsie0jvo0kfmai9cjasfv

Testing

=======

Unit Test

---------

Using pytest, if you want to unit testing.

.. code-block:: bash

   $ pytest

If you want to get coverage report, run coverage and check the report.

.. code-block:: bash

   $ coverage run --source=ssh_config_json -m pytest

   $ coverage report -m

Integration Test

----------------

Using pytest, if you want to do integrated tests with mark "--it".

.. code-block:: bash

   $ pytest --it

With tox

--------

With tox, you can test multiple python version.(only python 3.6, 3.7, 3.8)

.. code-block:: bash

   $ tox

Documents

=========

The Document is `HERE `_ written by mkdocs.

Licence

=======

This software is released under the MIT License, see LICENSE.