Git Product home page Git Product logo

cryptme's Introduction

Description

Cryptme is a minimal, open source secret manager (think 1Password CLI). Other secrets/password management solutions exist, and may be the right choice for you. This one favors simplicity; it attempts to do one thing well, with source code simple enough for an interested individual to quickly understand.

Installation

  • Via gem
gem install cryptme
bundle exec cryptme

Usage

cryptme # lists available commands

Prefix the above command with bundle exec when using Bundler.

Contributing

Contributions are welcome - simply create a PR against master for open issues or enhancements.

Publishing (gem)

gem build cryptme.gemspec
gem push cryptme-X.X.X.gem

Publishing (macOS executable, under construction)

  • install ruby-packer as rubyc
  • rubyc bin/cryptme
  • CRYPTME_VERSION=cat lib/VERSION mv a.out "cryptme-${CRYPTME_VERSION}"

Integration testing with Docker (under construction)

  • install Docker
  • CRYPTME_VERSION=cat lib/VERSION docker build -t cryptme_integration_test --build-arg CRYPTME_EXECUTABLE="cryptme-${CRYPTME_VERSION}" . --no-cache
  • docker run cryptme_integration_test
  • docker
  • The default docker file will simply call cryptme, then exit. Verify that exit code is 0, or modify the dockerfile to start cryptme interactively

Upcoming features

TODO, top priority:

  • setup CI
  • installation by executable, Linux & Windows
  • improve error messaging and signal handling

TODO, nice to have:

Feature: smarter file location

  • always keep it in ~ ? permissions issues?
  • look for .cryptme file in current directory
  • or in given directory
  • after initialization, remember location in config file

more stable writing (handle IO failures)

Design and architecture decisions

  • for now, everything is decrypted at first , then encrypted before writing to disk
  • never stores password on disk

cryptme's People

Contributors

happythenewsad avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.