piggy

README

Piggy

中文版：README_cn.md

In general, we like to store sensitive information such as passwords in memos. For IT developers, this is inconvenient. For example, the server's IP and password are stored in an encrypted memo. Each time you use it, you have to query it and copy it to the terminal for execution. And others can get some information by querying terminal history.

In addition, if you want to encrypt folders, or binary files, the memo is very inconvenient, you need to use other tools to support it.

Piggy tries to solve these problems. It is an encryption tool specially designed for IT practitioners. It uses the key-value mode which is familiar to most programmers, and the data is encrypted.

piggy has the following characteristics:

• Only-One-Password. Piggy manages passwords through the concept of masterKey. You only need one password, that can store a lot of sensitive information. Even if someone steals your computer, he can't get the information without this password.
• Support multiple data. Piggy supports not only text data, but also binary data, and even directories can be encrypted and stored.
• Limited time display. Many times, you may forget some information and just want to see it once. Piggy supports displaying information within a specified time. After the time passes, the information will be automatically erased (if it is displayed on the terminal, the output will be eliminated; if it is output to a file, the file will be deleted). Your sensitive information will not leave any trace on the computer.
• Execution module. By specifying some placeholders in the string, such as "ssh {svr.user}@{svr.ip}" to piggy, piggy will replace these placeholders ({svr.user} And {svr.ip}) with the corresponding value and executed. Of course, before execution, piggy will ask you to enter the password of svr. The support of placeholders is much more than that, it also supports functions such as variable definition, condition judgment, special placeholders, etc. See the documentation for details.

For more usage of piggy, please see document.

Piggy will continue to improve, increase its functions and improve safety.

Install

Piggy does not support Windows systems, only supports bash environment. (Unknown performance under Windows bash, it is not recommended to try) MacOS and Linux binaries are provided.

Piggy doesn't need any dependencies. Download binary package here for your system, After decompression, put the piggy executable file directly under the system`s PATH.

By running:

$ piggy help

If the help information is printed, the piggy installation is successful.

Document

See document

Build

Piggy is based on golang 1.13 and requires GO111MODULE.

The build process is very simple, just run make after clone on the system:

$ git clone https://github.com/groycat/piggy.git
$ cd piggy
$ make

Thanks

piggy is built on the following open-source libraries:

• cobra
• gopass

Thanks to the developers of these libraries.