ncypher 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTRjMTEyYzk5MzAwZjg1YWEyOWJjYzhhOWE3MWJhZTVmZDY4YzFlMg==
+  data.tar.gz: !binary |-
+    Y2Y5ODBmNjRkNDgxMWExMjk0OWI4NGM2MTZkYTIwNGM4ZDNlNzZhNw==
+SHA512:
+  metadata.gz: !binary |-
+    NDk4MGY2YmM5NWQxZjAwNTI3MmFkMDczMTFlNjMyMGRlMTMxNTMwYTQ1OTE2
+    ZTVhMjIzZjFjNDFhYjMyN2MyOTFkNzdmMzM3ODg1OTYxOWUzZmQ4MDQxYTI0
+    YzU1ODkzZWE3NzY0MWFjN2E5OTFkZDZiMjU5N2Y1ZjdiYzlkNTc=
+  data.tar.gz: !binary |-
+    NWQ1Yzk1ZTgzMTI0MGJjYzUwMmI3ZDJmMjdiNDNlNThlZDI2MjRhMjE3ZThm
+    OGU1MmIzODM5OGEyN2QwNjM1OWE0ZmE2MWM2MzQ4YTA2ODYyNThkOGUyMjdl
+    YzhhNGUwYjFjMWVhZmU2NDBmODc3MmZlNWUyYjEyMWVjMGMxNWI=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.12.5
+script: rake
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "mBGWs5QFmmspHjc+qNywVywwu16KUT0GNqeSasAC3I8JraNTk7NDqOM9HBix67WaPvrY7t3qXTXi52pXhYciyV4tkqBSD5b8TreXQA/ABpvkZvGrbbBjfjHHZ7D0ilmmxnR1ygR07T0ozSvtWIrymOTbhQFfU7sGLwexn4ve7z0fWJEyMGcQJPA5h7gJmUtjgeTc0IO3Et4B8yiIIqdLs0zFRMAPx2WOeKJhaHHEvByViQsfuMsBxzbRrD6MTRqfMVSEPp5dAis0bdycbgwqJ9EEbtvEafBK5fmnbAUJmB6UI8HZ5pP6W7Z3Vz/br2h2LKOOlg7DvCFnDnG9sqT4wdVrjW1l7y6nNSKvtl8U3/Y4kjGPooBC8+tM574ym67KRRhZW4OgDh5bEc96dbpmCnrLZPjC6sDQkwro0VGZhCTqqkJ/pmVyrxKDHtY+fjcxL9vCNAobgKi0ribH65+SpE8/Y99CMxT4zSoCtyT1EwA4RK9JH1GGU2tndwev6NRGzoc14NwbwWihCsKBYxdc8Rl1IRX3DLxgOHT3NTeMhq7jQxlrypePajuqEdWeFVS0tK3unB01blW4IS7fWA7wAaV4+s5ao/OxhP3OEEORTxvq3dchnxvmGLoH8LdQS3pW93KYeZENACtJRLBghoLbkDGgLlG/Qjz5o+cfD520NGY="
+  gem: ncypher
+  on:
+    tags: true
+    repo: pcboy/ncypher

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at david.hagege@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ncypher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+#
+#          DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+#                  Version 2, December 2004
+#
+#  Copyright (C) 2004 Sam Hocevar
+#  14 rue de Plaisance, 75014 Paris, France
+#  Everyone is permitted to copy and distribute verbatim or modified
+#  copies of this license document, and changing it is allowed as long
+#  as the name is changed.
+#  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+#  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+#  0. You just DO WHAT THE FUCK YOU WANT TO.
+#
+#
+#  David Hagege <david.hagege@gmail.com>
+#

data/README.md

@@ -0,0 +1,69 @@
+[![Code Climate](https://codeclimate.com/github/pcboy/ncypher/badges/gpa.svg)](https://codeclimate.com/github/pcboy/ncypher)
+[![codebeat badge](https://codebeat.co/badges/411b2b78-0734-40ec-9ca2-4383f66cf92f)](https://codebeat.co/projects/github-com-pcboy-ncypher)
+[![Build Status](https://travis-ci.org/pcboy/ncypher.svg)](https://travis-ci.org/pcboy/ncypher)
+
+# Ncypher
+
+Ncypher is a gem to help you to encrypt your credentials in your ruby apps in a safe manner.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ncypher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ncypher
+
+## Basic Usage
+
+First generate a new encryption key. Typically this key needs to be in your .gitignore.
+You don't want it to be pushed to the repository. This file will be used by ncypher each time you need to encrypt/decrypt something. You need to call it `.ncypher_key` and put it in the current folder or any other folder before. (i.e ~/.ncypher_key is fine for instance).
+```
+$> ncypher generate_key > .ncypher_key
+```
+You can also set the env variable `NCYPHER_KEY` to that generated key (i.e `export NCYPHER_KEY=kSzARCAw9uv/LQ1o75k5ica1oCpZBUCpP99Sy+s6L2c=`) instead of saving it to a file 
+
+To encrypt a new password (or anything else):
+```
+$> ncypher encrypt 'p4$$w0rd'
+deB7ba27qR470UetK/HW47dYMN7p9hguuDiVt59U+Bly6cfQcjgbw/ui/2hBhCEa
+```
+
+Now you can directy put in your .yaml files:
+```
+defaults: &defaults
+  my_password: <%= Ncypher::Ncypher.decrypt('lXEwfKv4dEjmK0kojEAnikNsLCsVCtSMiR2aSfM6uUXYn2DzCZ3O7SA9HaGnMp/kEEsI') %>
+```
+
+And Ncypher::Ncypher.decrypt will magically use your key in `.ncypher_key` to decrypt that password at runtime. 
+Note, you can also use the decrypt parameter in the ncypher binary to do the decryption:
+```
+$> ncypher decrypt deB7ba27qR470UetK/HW47dYMN7p9hguuDiVt59U+Bly6cfQcjgbw/ui/2hBhCEa 
+p4$$w0rd 
+```
+So in the end:
+```
+$> ncypher decrypt `ncypher encrypt 'p4$$w0rd'`
+p4$$w0rd
+```
+
+:)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pcboy/ncypher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ncypher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/ncypher

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'ncypher'
+
+SUB_COMMANDS = %w(generate_key encrypt decrypt)
+
+if ARGV.empty?
+  STDERR.puts "Ncypher a credential encryption tool"
+  STDERR.puts "usage: ncypher generate_key"
+  STDERR.puts "usage: ncypher key"
+  STDERR.puts "usage: ncypher encrypt <text>"
+  STDERR.puts "usage: ncypher decrypt <text>"
+  abort
+end
+
+cmd = ARGV.shift
+case cmd
+  when "generate_key"
+    puts Ncypher::Ncypher.new.generate_key
+  when "key"
+    puts Ncypher::Ncypher.new.key_b64
+  when "encrypt"
+    if text = ARGV.shift
+      puts Ncypher::Ncypher.new.encrypt(text)
+    else
+      STDERR.puts "usage: Ncypher encrypt <text>"
+    end
+  when "decrypt"
+    if text = ARGV.shift
+      puts Ncypher::Ncypher.new.decrypt(text)
+    else
+      STDERR.puts "usage: Ncypher decrypt <text>"
+    end
+end

data/lib/ncypher/version.rb

@@ -0,0 +1,3 @@
+module Ncypher
+  VERSION = "0.5.0"
+end

data/lib/ncypher.rb

@@ -0,0 +1,73 @@
+require "ncypher/version"
+
+require 'base64'
+require 'rbnacl/libsodium'
+require 'rbnacl'
+
+module Ncypher
+
+  class Ncypher
+
+    def initialize(key_filename: '.ncypher_key')
+      @key_filename = key_filename
+    end
+
+    def decrypt(ciphertext_b64)
+      box.decrypt(Base64.strict_decode64(ciphertext_b64.strip))
+    end
+
+    def encrypt(plaintext)
+      Base64.strict_encode64(box.encrypt(plaintext))
+    end
+
+    def generate_key
+      generated_key = RbNaCl::Random.random_bytes(RbNaCl::SecretBox.key_bytes)
+      Base64.strict_encode64(generated_key)
+    end
+
+    def key
+      saved_key = ENV['NCYPHER_KEY'] || find_keyfile
+      abort "Can't find .ncypher_key file or NCYPHER_KEY env variable" if saved_key.nil?
+      Base64.strict_decode64(saved_key.strip)
+    end
+
+    def key_b64
+      Base64.strict_encode64 key
+    end
+
+    def self.decrypt(cyphertext_b64)
+      Ncypher.new.decrypt cyphertext_b64
+    end
+
+    def self.encrypt(plaintext)
+      Ncypher.new.encrypt plaintext
+    end
+
+    def self.generate_key
+      Ncypher.new.generate_key
+    end
+
+    def self.key
+      Ncypher.new.key
+    end
+
+    def self.key_b64
+      Ncypher.new.key_b64
+    end
+
+    private
+    def box
+      RbNaCl::SimpleBox.from_secret_key(key)
+    end
+
+    def find_keyfile(folder: '.')
+      path = "#{folder}/#{@key_filename}"
+      return File.read(path) if File.exist?(path)
+      return nil if folder == '/'
+      folder = File.expand_path("#{folder}/../")
+      find_keyfile(folder: folder)
+    end
+
+  end
+
+end

data/ncypher.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ncypher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ncypher"
+  spec.version       = Ncypher::VERSION
+  spec.authors       = ["David Hagege"]
+  spec.email         = ["david.hagege@gmail.com"]
+
+  spec.summary       = %q{Ncypher lets you encrypt/decrypt credentials in a safe and transparent way}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/pcboy/ncypher"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = 'WTFPL'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency 'rbnacl-libsodium', '~> 1.0'
+  spec.add_dependency 'rbnacl', '~> 3.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: ncypher
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- David Hagege
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- david.hagege@gmail.com
+executables:
+- ncypher
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/ncypher
+- lib/ncypher.rb
+- lib/ncypher/version.rb
+- ncypher.gemspec
+homepage: https://github.com/pcboy/ncypher
+licenses:
+- WTFPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ncypher lets you encrypt/decrypt credentials in a safe and transparent way
+test_files: []