Skip to content

a13labs/sectool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sectool - Secure Tool for Managing SSH Key Pairs and Secrets

Build Status

License

sectool is a command-line tool written in Go that provides a secure and user-friendly way to manage SSH key pairs and secrets stored in a local vault. This tool is built using the Cobra CLI framework and is released under the MIT license.

Features

  • Manage SSH key pairs: Add, delete, list, lock, and unlock SSH key pairs.
  • Manage secrets: Store and retrieve key-value secrets in a local vault.
  • Security: Encrypts stored secrets to ensure sensitive information remains secure.
  • Easy-to-use: Clear and intuitive commands for effortless management of keys and secrets.
  • Makefile: The included Makefile simplifies building, testing, and other tasks.

Table of Contents

Installation

Before you begin, ensure you have Go installed on your system. You can install sectool using the following steps:

  1. Clone this repository:

    git clone https://github.com/your-username/sectool.git
  2. Navigate to the project directory:

    cd sectool
  3. Build the tool using the Makefile:

    make build
  4. You should now have the sectool binary in the project's root directory. You can move it to a directory in your system's PATH to make it accessible from anywhere.

Usage

SSH Key Pair Management

The ssh command group allows you to manage your SSH key pairs.

  • To add a new SSH key pair:

    sectool ssh add <key name>
  • To delete an existing SSH key pair:

    sectool ssh del <key name>
  • To initialize SSH key pair management:

    sectool ssh init <master password>
  • To list existing SSH key pairs:

    sectool ssh list
  • To lock all SSH key pairs:

    sectool ssh lock
  • To unlock all locked SSH key pairs:

    sectool ssh unlock

Secrets Vault

The vault command group allows you to manage secrets stored in the local vault.

  • To add a new secret:

    sectool vault set <key> <value>
  • To retrieve a secret:

    sectool vault get <key> [-export] [-quoted]
  • To delete a secret:

    sectool vault del <key>
  • To list all stored secrets:

    sectool vault list

Contributing

Contributions to sectool are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. See the Contribution Guidelines for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.