Metadata-Version: 2.1
Name: addsshkeys
Version: 0.3.0
Summary: Add keys to SSH Agent
Home-page: https://github.com/kenkundert/addsshkeys
Author: Ken Kundert
Author-email: addsshkeys@nurdletech.com
License: GPLv3+
Download-URL: https://github.com/kenkundert/addsshkeys/tarball/master
Keywords: avendesora,ssh
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: appdirs
Requires-Dist: avendesora (>=1.12)
Requires-Dist: docopt
Requires-Dist: inform (>=1.14)
Requires-Dist: nestedtext (>=1.1)
Requires-Dist: pexpect

AddSSHkeys:  Add Keys to SSH Agent
==================================

| Version: 0.3.0
| Released: 2020-10-19
|

*AddSSHkeys* adds all of your keys to SSH Agent in one operation. It can work 
with `Avendesora <https://avendesora.readthedocs.io>`_ to keep your passphrases 
secure.

Please report all bugs and suggestions to addsshkeys@nurdletech.com

Getting Started
---------------

You download and install *AddSSHkeys* with::

    pip3 install --user addsshkeys

Once installed, you will need at least one configuration file.
Configurations are placed in: ~/.config/addsshkeys.
They are `NestedText <https://nestedtext.readthedocs.io>`_ files.
The default configuration is *config*; the default file is *config.nt*.

The following settings may be given in your config files.

**ssh_add**

The name of the command that adds keys to your SSH agent. By default, 'ssh-add' 
is used.

**ssh_keys**

This setting is required.  It contains a dictionary of dictionaries that 
contains information about each key.  The primary dictionary contains a name and 
the values for each key. The values are held in a dictionary that may contain 
three fields:

*paths*

This is required and contains the paths to one or more SSH private key files.  
It may be a list of strings, or a single string that is split.  If a relative 
path is given, it is relative to ~/.ssh.

*account*

This gives the name of the Avendesora account that holds passphrase for the 
keys. If present, Avendesora will be queried for the passphrase.

*passphrase*

This is required if *account* is not given, otherwise it is optional.  If 
*account* is given, it is the name of the passphrase field in Avendesora, which 
defaults to 'passcode'. If account is not given, it is the passphrase itself. In 
this case, the settings file should only be readable by the user.

**config_file_mask**

An integer that determines if a warning should be printed about the
config file permissions being too loose.  The permissions are only checked
if the file is found to contain a passphrase. Default is 0o077.  Set to
0o000 to disable the warning. Set to 0o077 to generate a warning if the
configuration directory is readable or writable by the group or others. Set
to 0o007 to generated a warning if the directory is readable or writable by
others.

Here is an example configuration file::

    ssh_keys:
        primary:
            paths: primary-ed25519 primary-rsa
            account: primary-ssh-key
        digitalocean:
            paths: digitalocean
            account: digitalocean-ssh-key
        github:
            paths: github
            passphrase: canard apply trousseau forgive
        backups:
            paths: dumper
            account: dumper-ssh-key


Running AddSSHkeys
------------------

Once configured, you can run *AddSSHkeys* with the default configuration using::

    addsshkeys

And you can run it with a particular configuration using::

    addsshkeys <config>

where ``<config>`` is the name of the configuration you wish to use (no need to 
give the .nt suffix).  In this way you can have several bundles of keys that you 
can load as needed.


Releases
--------
**Latest Development Version**:
    | Version: 0.3.0
    | Released: 2020-10-19


0.3 (2020-10-19)
    - allow config file to end with .nt suffix.

0.2 (2020-10-14)
    - update to latest version of NestedText

0.1 (2020-08-31)
    - convert to NestedText for settings file.


