ossl_cryptor 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3a1c8ed0b9e337462bc675eee6160730a45ff30b
4
+ data.tar.gz: 7edc3408714bbcc5d2621c81f7ea8a09781b7c5d
5
+ SHA512:
6
+ metadata.gz: bbe00744c045f7fa41404267837abfb4284cf539638bd464ac5710e37d9535ff70a4d67119023cd669b089058bb2bab5e1d791428983e39d05ad08d119068ee5
7
+ data.tar.gz: 664fbf2030abda35fb958261c40d227d2522a41b402a976943611bcfc253ecb2c83100868ba898ec5bd6a972544a4a4f0d00c527310cc49849bf155811377cc7
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.8
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ 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, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in ossl_cryptor.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 h.shigemoto
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # OsslCryptor
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ossl_cryptor`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'ossl_cryptor'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install ossl_cryptor
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ossl_cryptor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "ossl_cryptor"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,147 @@
1
+ require "ossl_cryptor/version"
2
+ require "ossl_cryptor/cipher_generator"
3
+ require "base64"
4
+
5
+ module OsslCryptor
6
+
7
+ # DES Mode.
8
+ DES = "DES"
9
+ # AES Mode.
10
+ AES = "AES-256-CBC"
11
+
12
+ # Crypt class
13
+ class Cryptor
14
+
15
+ # constructor.
16
+ # @param [String] mode cipher mode.
17
+ # @param [Hash] key_iv key and iv. key_iv[:key] = key, key_iv[:iv] = iv
18
+ # @param [String] pass password
19
+ # @param [String] salt salt data. if salt is nil, use random salt.
20
+ # @param [String] key_iv_hash use hash algorithm when key and iv generate.
21
+ def initialize(mode, key_iv=nil, pass=nil, salt=nil, key_iv_hash=nil)
22
+
23
+ # if invalid mode, raise error.
24
+ if (AES != mode) && (DES != mode)
25
+ raise OpenSSL::Cipher::CipherError "invalid mode : #{mode}"
26
+ end
27
+
28
+ # generate cipher instance.
29
+ @cipher = setup(mode, key_iv, pass, salt, key_iv_hash)
30
+ @mode = mode
31
+ end
32
+
33
+ # reset cipher instance.
34
+ def reset
35
+ @cipher = setup(@mode, @key)
36
+ end
37
+
38
+ # encrypt value.
39
+ # @param [String] value encrypt value.
40
+ # @return [String] encrypt result value.
41
+ def encrypt(value, encode_base64=true)
42
+
43
+ # prepare encrypt.
44
+ @cipher.encrypt
45
+
46
+ # encrypt.
47
+ encrypt_value = @cipher.update(value) + @cipher.final
48
+ # encode base64.
49
+ if encode_base64
50
+ encrypt_value = Base64.encode64(encrypt_value)
51
+ end
52
+
53
+ encrypt_value
54
+ end
55
+
56
+ # decrypt value.
57
+ # @param [String] value decrypt value.
58
+ # @return [String] decrypt result value.
59
+ def decrypt(value, decode_base64=true)
60
+
61
+ # prepare decrypt.
62
+ @cipher.decrypt
63
+
64
+ # decode base64.
65
+ if decode_base64
66
+ value = Base64.decode64(value)
67
+ end
68
+
69
+ if @mode == AES
70
+ @cipher.padding = 0
71
+ end
72
+
73
+ # decrypt.
74
+ decrypt_value = @cipher.update(value) + @cipher.final
75
+ decrypt_value
76
+ end
77
+
78
+ # get crypt mode.
79
+ # @return [String] mode
80
+ def mode
81
+ @mode
82
+ end
83
+
84
+ # get key and iv.
85
+ # @return [Hash] key and iv. key_iv[:key] = key, key_iv[:iv] = iv
86
+ def key_iv
87
+ @key_iv
88
+ end
89
+
90
+ private
91
+
92
+ # setup cipher instance.
93
+ # @param [String] mode cipher mode.
94
+ # @param [Hash] key_iv key and iv. key_iv[:key] = key, key_iv[:iv] = iv
95
+ # @param [String] pass password, if pass = nil, use CipherGenerator::DEFAULT_PASS
96
+ # @param [String] salt salt data. if salt = nil, use random salt.
97
+ # @param [String] key_iv_hash use hash algorithm when key and iv generate. if key_iv_hash = nil, use CipherGenerator::DEFAULT_KEY_IV_HASH
98
+ # @return [Cipher] cipher instance.
99
+ def setup (mode, key_iv=nil, pass=nil, salt=nil, key_iv_hash=nil)
100
+
101
+ # generate OpenSSL::Cipher instance.
102
+ cipher = CipherGenerator.generate_cipher(mode)
103
+
104
+ # if key_iv = nil, generate key and iv.
105
+ if key_iv.nil?
106
+ pass = pass.nil? ? CipherGenerator::DEFAULT_PASS : pass
107
+ salt = salt.nil? ? get_default_salt(mode) : salt
108
+ hash = key_iv_hash.nil? ? CipherGenerator::DEFAULT_KEY_IV_HASH : key_iv_hash
109
+ key_len = cipher.key_len + cipher.iv_len
110
+ key_iv_str = OpenSSL::PKCS5.pbkdf2_hmac(pass, salt, 2000, key_len, hash)
111
+ key = key_iv_str[0, cipher.key_len]
112
+ iv = key_iv_str[cipher.key_len, key_len]
113
+ cipher.key = key
114
+ cipher.iv = iv
115
+ @key_iv = { key: key, iv: iv }
116
+ else
117
+ cipher.key = key_iv[:key]
118
+ cipher.iv = key_iv[:iv]
119
+ @key_iv = key_iv
120
+ end
121
+
122
+ cipher
123
+ end
124
+
125
+ # get default sold depend on mode.
126
+ # @param [String] mode cipher mode.
127
+ # @return [String] default salt.
128
+ def get_default_salt(mode)
129
+
130
+ default_salt = nil
131
+
132
+ if mode == AES
133
+ default_salt = OpenSSL::Random.random_bytes(8)
134
+ elsif mode == DES
135
+ default_salt = OpenSSL::Random.random_bytes(2)
136
+ end
137
+
138
+ default_salt
139
+ end
140
+ end
141
+
142
+ # get available crypt mode.
143
+ # @return [String] availabe cipher.
144
+ def self.available
145
+ "#{AES}, #{DES}"
146
+ end
147
+ end
@@ -0,0 +1,18 @@
1
+ require "openssl"
2
+
3
+ # Cipher instance generator.
4
+ module CipherGenerator
5
+
6
+ # default pass.
7
+ DEFAULT_PASS = "ossl_cryptor"
8
+
9
+ # default hash algorithm.
10
+ DEFAULT_KEY_IV_HASH = "sha256"
11
+
12
+ # generate cipher instance.
13
+ # @return [Cipher] cipher instance.
14
+ def self.generate_cipher(mode)
15
+ cipher = OpenSSL::Cipher.new(mode)
16
+ cipher
17
+ end
18
+ end
@@ -0,0 +1,3 @@
1
+ module OsslCryptor
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'ossl_cryptor/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "ossl_cryptor"
8
+ spec.version = OsslCryptor::VERSION
9
+ spec.authors = ["h.shigemoto"]
10
+ spec.email = ["corporation.ore@gmail.com"]
11
+
12
+ spec.summary = %q{This gem provide crypt by AES-256-CBC and DES.}
13
+ spec.description = %q{This gem provide crypt by AES-256-CBC and DES. Use openssl lib. But now, only DES of properly available.}
14
+ spec.homepage = "https://github.com/h-shigemoto/ossl_cryptor"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ # end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.10"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ spec.add_development_dependency "rspec"
33
+ end
metadata ADDED
@@ -0,0 +1,102 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ossl_cryptor
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - h.shigemoto
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-26 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: This gem provide crypt by AES-256-CBC and DES. Use openssl lib. But now,
56
+ only DES of properly available.
57
+ email:
58
+ - corporation.ore@gmail.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".rspec"
65
+ - ".travis.yml"
66
+ - CODE_OF_CONDUCT.md
67
+ - Gemfile
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - lib/ossl_cryptor.rb
74
+ - lib/ossl_cryptor/cipher_generator.rb
75
+ - lib/ossl_cryptor/version.rb
76
+ - ossl_cryptor.gemspec
77
+ homepage: https://github.com/h-shigemoto/ossl_cryptor
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.6.3
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: This gem provide crypt by AES-256-CBC and DES.
101
+ test_files: []
102
+ has_rdoc: