Skip to main content

A cli for interacting with yopass backend

Project description

yopass-cli

Build Status

PyPI version

This is a command-line tool to interact with a (the) yopass backend created by Johan Haals. Even though it is possible to use the service via the web-frontend I felt the necessity of a cli tool to use this awesome software in our automation projects.

This cli tool uses sjcl (just like the web-frontend) to perform encryption on the client side thus preventing your secret from ever leaving your os in a cleartext form.

Installation

yopass-cli requires python3+ to run.

$ pip install --user yopass-cli

Make sure to have the following 2 environment variables set before using:

  • YOPASS_BACKEND_URL

  • YOPASS_FRONTEND_URL

      $ export YOPASS_BACKEND_URL=https://api.yopass.se
      $ export YOPASS_FRONTEND_URL=https://yopass.se
    

If you use your own server, the front and backend URLs can be the same. For example: https://yopass.domain.net

Usage

yopass-cli send [OPTIONS] SECRET
cat <filename> | yopass-cli send [OPTIONS]
echo "<my passphrase" | yopass-cli send [OPTIONS]
yopass-cli get [OPTIONS] SID PASSPHRASE

Send Options:

--expires [1h|1d|1w]
--outmode [verbose|one-click-link|short-link|id]
--outformat [plain|json]

Get Options:

--outformat [plain|json]

Todos

  • testing
  • proper README

License

MIT

Free Software, Hell Yeah!

Contribution is welcome :) 🍺Cheers 🍺

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

yopass-cli-0.0.5.tar.gz (3.6 kB view details)

Uploaded Source

File details

Details for the file yopass-cli-0.0.5.tar.gz.

File metadata

  • Download URL: yopass-cli-0.0.5.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for yopass-cli-0.0.5.tar.gz
Algorithm Hash digest
SHA256 f602b6ebc38ff1ccce292392dba35fd93b9e380b9467c06c017c504290477cff
MD5 5975fcbad1b14a0d0af945b3b84721ab
BLAKE2b-256 633d43950894e6953b524ade1afa077fa235ca1cb6a9b954d095980c3580b1fc

See more details on using hashes here.

Supported by

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