nexaas-cipher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80abb5b25e4c0a338fb72a7966797517f41b28e991908515486642cd468cdce5
+  data.tar.gz: ec5f8180e713ff98e09da3e5561590f28a04b17a1942959d7708487d4d570304
+SHA512:
+  metadata.gz: fdbe833f8488f886749104c36bd5d9a14cd4e02b40590d02d2cc6d27e592b3e5f3b1aac73fb1c6b63f0ccad6d2fd268ee6affaf54c21239ea71448a82bca93b7
+  data.tar.gz: 28e4c2203283229add96ec4eb575581cb11ea64ca61a6161e8516ab5a58accf08226bc8b0e804f8a6af9cf8111e358cb82c5921b8b8e93e3af5fd4e0044af08d

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    nexaas-cipher (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (12.3.1)
+    rdoc (6.0.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  nexaas-cipher!
+  pry-byebug (~> 3.6)
+  rake (~> 12.0)
+  rdoc (~> 6.0)
+  rspec (~> 3.6)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2013 Myfreecomm - Free Communities Consultoria Em Informatica Ltda
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,182 @@
+# Nexaas Cipher (Ruby)
+
+This is the official Ruby support for [Nexaas ID](https://id.nexaas.com) simple
+ciphering.
+
+`nexaas-cipher-ruby` RDoc documentation:
+<http://rubydoc.info/github/myfreecomm/nexaas-cipher-ruby/frames/>
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+    gem 'nexaas-cipher', require: 'nexaas'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nexaas-cipher
+
+## API
+
+### `Nexaas::Cipher::Salt`
+
+This resource manages the cipher salt. The minimal instantiation is:
+
+```ruby
+salt = Nexaas::Cipher::Salt.new(raw_salt_string)
+```
+
+If the salt string is coded in [Base64][base64], you still can use it:
+
+```ruby
+salt = Nexaas::Cipher::Salt.new(base64_salt_string, base64: true)
+```
+
+#### Methods
+
+`#salt?`
+: returns false if the salt is empty, true otherwise.
+
+`#salt`
+: returns the raw salt.
+
+`#salt(base64: true)`
+: returns the salt encoded in Base64. This parâmeter is valid for all variations
+  of this method.
+
+`#salt(code)`
+: returns the salt sized to fit the supplied code.
+
+`#salt(code, truncate: true)`
+: same before, but truncates the salt when the code is smaller than it.
+
+Example:
+
+```ruby
+irb> salt = Nexaas::Cipher::Salt.new('YWJjZGVm', base64: true)
+=> #<Nexaas::Cipher::Salt:0x0000563848195c40 @salt="abcdef">
+irb> salt.salt?
+=> true
+irb> salt.salt
+=> "abcdef"
+irb> salt.salt('test')
+=> "abcdef"
+irb> salt.salt('test', truncate: true)
+=> "abcd"
+irb> salt.salt('test', base64: true, truncate: true)
+=> "YWJjZA=="
+```
+
+### `Nexaas::Cipher::XorCrypter`
+
+This class allows to perform [XOR cipher][xor-cipher] encryption.
+Its constructor has the same signature as `Nexaas::Cipher::Salt`.
+
+#### Methods
+
+`#salt?`
+: returns false if its salt is empty, true otherwise.
+
+`#salt`
+: returns its internal `Nexaas::Cipher::Salt` object.
+
+`#encrypt(code, **options)`
+: encrypts the code using the salt. The `options` are passed to the `salt#salt`
+  method to get the effective salt string. It accepts an extra option,
+  `obfuscate`, that generates a random obfuscative string to be concatenated to
+  the code in order to fill the salt length when the code is smaller and is not
+  truncated, avoiding to expose it.
+
+`#decrypt(code, **options)`
+: does the same of `#encrypt`, but truncates the result code in the firt null
+  character. Useful when the cipher was generate with `obfuscate: true`.
+
+### `Nexaas::Cipher::IDCrypter`
+
+This is the same crypter used by Nexaas ID to deal with application signatures.
+
+It expects the code/cipher to be the
+[application secret][nexaas-id-application-data].
+
+Features:
+
+- The salt is always truncated and never obfuscated
+  (makes no sense on truncation).
+- On encryption, the code is expected to be Base64 by default,
+  and the generated cipher is **always** Base64.
+- On decryption, the cipher **must** be Base64,
+  and the determinated code is Base64 by default.
+
+#### Methods
+
+`#encrypt(code, base64: true)`
+: encrypt `code`. The `base64` controls if the `code` is Base64 or not (raw).
+
+`#decrypt(code, base64: true)`
+: decrypt `code`. The `base64` controls if the output is Base64 or not (raw).
+
+Using the default options, `#encrypt` and `decrypt` act the same:
+expecting a Base64 code and _xoring_ it with the salt.
+Since the XOR cipher is self-reversing,
+“encrypting” the generated cipher results in the original code.
+
+#### Example
+
+```ruby
+crypter = Nexaas::Cipher::IDCrypter.new(application.secret)
+
+signature = Base64.encode64(Random.urandom(12)).rstrip
+cipher = crypter.encrypt(signature)
+
+# Send cipher to Nexaas ID using the access token, and getting res(ponse) back
+# ...
+
+if res.params[:signature] == signature
+  puts 'OK, it is right!'
+  # ...
+end
+```
+
+### `Nexaas::Cipher::CrypterBase`
+
+Pretending to be an abstract class, it is used to inherit new crypters.
+
+The constructor passes its parameters to the `Nexaas::Cipher::Salt` one,
+and stores its instance for use.
+
+The subclasses supposed to implement the following protected methods:
+
+`#do_encrypt(code, **options)`
+: The routine to be performed for encryption.
+
+`#do_decrypt(code, **options)`
+: The routine to be performed for decryption.
+
+Notes:
+
+- The `code` is passed raw.
+- The `options` are the same passed to `#encrypt` and `#decrypt` methods.
+- The `base64:` options is **not** passed.
+  If it’s false (default), the code or cipher is passed raw through and back;
+  if it’s true, the supplied code is decoded from Base64 to raw before being
+  passed to the `#do_*` method, and de returned valueis encoded in Base64.
+
+#### Available methods
+
+`#salt?`
+: returns false if the salt is empty, true otherwise.
+
+`#salt`
+: returns the internal `Nexaas::Cipher::Salt` object.
+
+## Support
+
+This gem supports Ruby 2.5 or superior.
+
+[base64]: https://en.wikipedia.org/wiki/Base64
+[nexaas-id-application-data]: https://docs.id.nexaas.com/add-app#application-data
+[xor-cipher]: https://www.geeksforgeeks.org/xor-cipher/

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = 'nexaas-cipher'
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+  # rdoc.generator = 'darkfish'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec

data/config.reek

@@ -0,0 +1,12 @@
+DataClump:
+  enabled: false
+
+NilCheck:
+  enabled: false
+
+UncommunicativeParameterName:
+  enabled: false
+
+exclude_paths:
+  - spec
+  - vendor

data/lib/nexaas.rb

@@ -0,0 +1,3 @@
+# Nexaas: needed by Cipher submodule
+module Nexaas
+end

data/lib/nexaas/cipher.rb

@@ -0,0 +1,7 @@
+module Nexaas
+  # Cipher: containing some ciphering and crypting facilities
+  module Cipher
+  end
+end
+
+require 'nexaas/cipher/salt'

data/lib/nexaas/cipher/crypter_base.rb

@@ -0,0 +1,62 @@
+require 'nexaas/cipher/salt'
+
+module Nexaas
+  module Cipher
+    # CrypterBase: abstract class to support crypter classes
+    class CrypterBase
+      attr_reader :salt
+
+      def initialize(*args)
+        @salt = Salt.new(*args)
+      end
+
+      def encrypt(code, **options)
+        guarded_crypt(code, :do_encrypt, **options)
+      end
+
+      def decrypt(code, **options)
+        guarded_crypt(code, :do_decrypt, **options)
+      end
+
+      def salt?
+        salt.salt?
+      end
+
+      protected
+
+      def guarded_crypt(code, method, **options)
+        return if code.nil? || code.empty?
+        return code unless salt.salt?
+        start_encrypting(code, method, **options)
+      end
+
+      # base64 :reek:ControlParameter
+      # base64 :reek:BooleanParameter
+      #        :reek:LongParameterList
+      def start_encrypting(code, method, base64: false, **options)
+        if base64
+          b64_encrypt(code, method, **options)
+        else
+          do_crypt(code, method, **options)
+        end
+      end
+
+      def b64_encrypt(code, method, **options)
+        Base64.
+          encode64(do_crypt(Base64.decode64(code), method, **options)).
+          rstrip
+      end
+
+      def do_crypt(code, method, **options)
+        case method
+        when :do_encrypt
+          do_encrypt(code, **options)
+        when :do_decrypt
+          do_decrypt(code, **options)
+        else
+          raise ArgumentError(method)
+        end
+      end
+    end
+  end
+end

data/lib/nexaas/cipher/id_crypter.rb

@@ -0,0 +1,27 @@
+require 'nexaas/cipher/xor_crypter'
+
+module Nexaas
+  module Cipher
+    # IDCrypter: XOR cipher as used by Nexaas ID
+    class IDCrypter < XorCrypter
+      # base64 :reek:BooleanParameter
+      # base64 :reek:ControlParameter
+      def encrypt(code, base64: true)
+        return if code.nil? || code.empty?
+        code = Base64.encode64(code).rstrip unless base64
+        if salt?
+          super(code, base64: true, obfuscate: false, truncate: true)
+        else
+          code
+        end
+      end
+
+      # base64 :reek:BooleanParameter
+      # base64 :reek:ControlParameter
+      def decrypt(code, base64: true)
+        res = encrypt(code)
+        base64 || res.nil? ? res : Base64.decode64(res)
+      end
+    end
+  end
+end

data/lib/nexaas/cipher/salt.rb

@@ -0,0 +1,36 @@
+require 'base64'
+
+module Nexaas
+  module Cipher
+    # Salt: represents the disturber salt for ciphering
+    # :reek:BooleanParameter
+    # :reek:ControlParameter
+    class Salt
+      def initialize(salt, base64: false)
+        @salt = base64 ? Base64.decode64(salt) : salt
+      end
+
+      def salt(code = nil, base64: false, truncate: false)
+        return Base64.encode64(salt(code, truncate: truncate)).rstrip if base64
+        return @salt unless code
+        return "\0" * code.length if @salt.empty?
+        dup_salt(code, @salt, truncate)
+      end
+
+      def salt?
+        !@salt.empty?
+      end
+
+      private
+
+      # current :reek:FeatureEnvy
+      # current.length :reek:DuplicateMethodCall
+      def dup_salt(code, current, truncate)
+        expected_length = code.length
+        expected_length = [current.length, expected_length].max unless truncate
+        current <<= @salt while current.length < expected_length
+        current[0, expected_length]
+      end
+    end
+  end
+end

data/lib/nexaas/cipher/version.rb

@@ -0,0 +1,5 @@
+module Nexaas
+  module Cipher
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/nexaas/cipher/xor_crypter.rb

@@ -0,0 +1,37 @@
+require 'nexaas/cipher/crypter_base'
+
+module Nexaas
+  module Cipher
+    # XorCrypter: allows perform XOR cipher
+    class XorCrypter < CrypterBase
+      protected
+
+      # obfuscate :reek:BooleanParameter
+      def do_encrypt(code, obfuscate: false, **options)
+        self.class.xor_encrypt(salt.salt(code, **options), code, obfuscate)
+      end
+
+      def do_decrypt(code, **options)
+        do_encrypt(code, options).split("\0").first
+      end
+
+      class << self
+        # obfuscate :reek:ControlParameter
+        def xor_encrypt(key, code, obfuscate)
+          xor(obfuscate ? obfuscate_key(key, code) : code, key)
+        end
+
+        def xor(code, key)
+          key.unpack('C*').zip(code.unpack('C*')).
+            map { |fst, lst| fst ^ (lst || 0) }.
+            pack('C*')
+        end
+
+        def obfuscate_key(key, code)
+          len = key.length
+          (code + "\0" + Array(0..255).sample(len).pack('C*'))[0, len]
+        end
+      end
+    end
+  end
+end

data/nexaas-cipher.gemspec

@@ -0,0 +1,32 @@
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__), 'lib', 'nexaas', 'cipher', 'version.rb'])
+
+Gem::Specification.new do |spec|
+  spec.name        = 'nexaas-cipher'
+  spec.version     = Nexaas::Cipher::VERSION
+  spec.authors     = ['Rodrigo Cacilhas']
+  spec.email       = ['rodrigo.cacilhas@nexaas.com']
+  spec.description = 'A Ruby client for the Nexaas ID REST API'
+  spec.summary     = 'A Ruby client for the Nexaas ID REST API: https://id.nexaas.com/static/docs/'
+  spec.homepage    = 'https://github.com/myfreecomm/nexaas-cipher-ruby'
+  spec.license     = 'Apache-2.0'
+  spec.has_rdoc    = true
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w[lib]
+
+  # spec.add_dependency 'multi_json', '~> 1.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency "pry-byebug", "~> 3.6"
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rdoc', '~> 6.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+end

data/spec/nexaas/cipher/id_crypter_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'nexaas/cipher/id_crypter'
+
+describe Nexaas::Cipher::IDCrypter do
+  context 'normal behavior without salt' do
+    let(:crypter) { described_class.new('') }
+
+    describe '#salt' do
+      it { expect(crypter.salt?).to be(false) }
+      it { expect(crypter.salt.salt).to be_empty }
+    end
+
+    describe '#encrypt' do
+      it { expect(crypter.encrypt(nil)).to be(nil) }
+      it { expect(crypter.encrypt('dGVzdA==')).to eq('dGVzdA==') }
+    end
+
+    describe '#decrypt' do
+      it { expect(crypter.decrypt(nil)).to be(nil) }
+      it { expect(crypter.decrypt('dGVzdA==')).to eq('dGVzdA==') }
+    end
+  end
+
+  context 'normal behavior with salt' do
+    let(:crypter) { described_class.new(salt) }
+    let(:salt) { 'iIl7wbZsP7Gd2WphNoo/64sdhwwrzEBh' }
+
+    describe '#salt' do
+      it { expect(crypter.salt?).to be(true) }
+      it { expect(crypter.salt.salt).to eq(salt) }
+    end
+
+    describe '#encrypt' do
+      it { expect(crypter.encrypt(nil)).to be(nil) }
+      it { expect(crypter.encrypt('dGVzdA==')).to eq('HSwfQw==') }
+
+      it 'should not obfuscate the salt' do
+        expect(crypter.encrypt('dGVzdDE=')).to eq(crypter.encrypt('dGVzdDE='))
+      end
+    end
+
+    describe '#decrypt' do
+      it { expect(crypter.decrypt(nil)).to be(nil) }
+      it { expect(crypter.decrypt('dGVzdA==')).to eq('HSwfQw==') }
+
+      it 'should not obfuscate the salt' do
+        expect(crypter.decrypt('dGVzdDE=')).to eq(crypter.decrypt('dGVzdDE='))
+      end
+    end
+  end
+
+  context 'altered behavior without salt' do
+    let(:crypter) { described_class.new('') }
+
+    describe '#encrypt' do
+      it { expect(crypter.encrypt(nil, base64: false)).to be(nil) }
+      it { expect(crypter.encrypt('test', base64: false)).to eq('dGVzdA==') }
+    end
+
+    describe '#decrypt' do
+      it { expect(crypter.decrypt(nil, base64: false)).to be(nil) }
+      it { expect(crypter.decrypt('dGVzdA==', base64: false)).to eq('test') }
+    end
+  end
+
+  context 'altered behavior with salt' do
+    let(:crypter) { described_class.new(salt) }
+    let(:salt) { 'iIl7wbZsP7Gd2WphNoo/64sdhwwrzEBh' }
+
+    describe '#encrypt' do
+      it { expect(crypter.encrypt(nil, base64: false)).to be(nil) }
+      it { expect(crypter.encrypt('test', base64: false)).to eq('HSwfQw==') }
+
+      it 'should not obfuscate the salt' do
+        expect(crypter.encrypt('test1', base64: false)).
+          to eq(crypter.encrypt('test1', base64: false))
+      end
+    end
+
+    describe '#decrypt' do
+      it { expect(crypter.decrypt(nil, base64: false)).to be(nil) }
+      it { expect(crypter.decrypt('HSwfQw==', base64: false)).to eq('test') }
+
+      it 'should not obfuscate the salt' do
+        expect(crypter.decrypt('dGVzdDE=', base64: false)).
+          to eq(crypter.decrypt('dGVzdDE=', base64: false))
+      end
+    end
+  end
+end

data/spec/nexaas/cipher/salt_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Nexaas::Cipher::Salt do
+  context 'empty salt' do
+    subject { described_class.new('') }
+
+    it { expect(subject.salt?).to be(false) }
+    it { expect(subject.salt).to be_empty }
+    it { expect(subject.salt('test')).to eq("\0\0\0\0") }
+    it { expect(subject.salt('test', base64: true)).to eq('AAAAAA==') }
+  end
+
+  context 'non-coded' do
+    subject { described_class.new('abc') }
+
+    it { expect(subject.salt?).to be(true) }
+    it { expect(subject.salt).to eq('abc') }
+
+    context 'full length' do
+      it { expect(subject.salt('te')).to eq('abc') }
+      it { expect(subject.salt('tes')).to eq('abc') }
+      it { expect(subject.salt('testtest')).to eq('abcabcab') }
+      it { expect(subject.salt('testtest', base64: true)).to eq('YWJjYWJjYWI=') }
+    end
+
+    context 'truncated' do
+      it { expect(subject.salt('te', truncate: true)).to eq('ab') }
+      it { expect(subject.salt('tes', truncate: true)).to eq('abc') }
+      it { expect(subject.salt('testtest', truncate: true)).to eq('abcabcab') }
+      it { expect(subject.salt('te', base64: true, truncate: true)).to eq('YWI=') }
+    end
+
+    context 'coded' do
+      subject { described_class.new('ZGVm', base64: true) }
+
+      it { expect(subject.salt?).to be(true) }
+      it { expect(subject.salt).to eq('def') }
+
+      context 'full length' do
+        it { expect(subject.salt('te')).to eq('def') }
+        it { expect(subject.salt('tes')).to eq('def') }
+        it { expect(subject.salt('testtest')).to eq('defdefde') }
+        it { expect(subject.salt('testtest', base64: true)).to eq('ZGVmZGVmZGU=') }
+      end
+
+      context 'truncated' do
+        it { expect(subject.salt('te', truncate: true)).to eq('de') }
+        it { expect(subject.salt('tes', truncate: true)).to eq('def') }
+        it { expect(subject.salt('testtest', truncate: true)).to eq('defdefde') }
+        it { expect(subject.salt('te', base64: true, truncate: true)).to eq('ZGU=') }
+      end
+    end
+  end
+end

data/spec/nexaas/cipher/xor_crypter_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'nexaas/cipher/xor_crypter'
+
+describe Nexaas::Cipher::XorCrypter do
+  let(:crypter) { described_class.new(salt, base64: true) }
+
+  context 'without salt' do
+    let(:salt) { '' }
+
+    it { expect(crypter.salt?).to be(false) }
+    it { expect(crypter.encrypt(nil)).to be(nil) }
+    it { expect(crypter.encrypt('test')).to eq('test') }
+    it { expect(crypter.encrypt('test', trucate: true)).to eq('test') }
+    it { expect(crypter.encrypt('test', ofuscate: true)).to eq('test') }
+    it { expect(crypter.encrypt('AA==', base64: true)).to eq('AA==') }
+  end
+
+  context 'with salt' do
+    let(:salt) { '0LhN0KgMsNksgZQmfYCjweg68cRxCr9086IzcqM1f6w=' }
+
+    describe '#salt' do
+      it { expect(crypter.salt?).to be(true) }
+      it { expect(crypter.salt.salt(base64: true)).to eq(salt) }
+    end
+
+    describe '#encrypt' do
+      it { expect(crypter.encrypt(nil)).to be(nil) }
+
+      it 'should truncate' do
+        expect(crypter.encrypt('test1', truncate: true)).
+        to eq("\xa4\xdd>\xa4\x99".force_encoding('ASCII-8BIT'))
+      end
+
+      it 'should not obfuscate the salt' do
+        expect(crypter.encrypt('test1')).to eq(crypter.encrypt('test1'))
+      end
+
+      it 'should obfuscate the salt' do
+        expect(crypter.encrypt('test1', obfuscate: true)).
+          not_to eq(crypter.encrypt('test1', obfuscate: true))
+      end
+    end
+
+    describe '#decrypt' do
+      it { expect(crypter.decrypt(crypter.encrypt('test1'))).to eq('test1') }
+      it { expect(crypter.decrypt(crypter.encrypt('test1', truncate: true))).to match(/\Atest1/) }
+      it { expect(crypter.decrypt(crypter.encrypt('test1', obfuscate: true))).to eq('test1') }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'nexaas/cipher'
+require 'pry'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+  c.example_status_persistence_file_path = '.rspec_persistence'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: nexaas-cipher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Cacilhas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: A Ruby client for the Nexaas ID REST API
+email:
+- rodrigo.cacilhas@nexaas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- config.reek
+- lib/nexaas.rb
+- lib/nexaas/cipher.rb
+- lib/nexaas/cipher/crypter_base.rb
+- lib/nexaas/cipher/id_crypter.rb
+- lib/nexaas/cipher/salt.rb
+- lib/nexaas/cipher/version.rb
+- lib/nexaas/cipher/xor_crypter.rb
+- nexaas-cipher.gemspec
+- spec/nexaas/cipher/id_crypter_spec.rb
+- spec/nexaas/cipher/salt_spec.rb
+- spec/nexaas/cipher/xor_crypter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/myfreecomm/nexaas-cipher-ruby
+licenses:
+- Apache-2.0
+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.7.6
+signing_key: 
+specification_version: 4
+summary: 'A Ruby client for the Nexaas ID REST API: https://id.nexaas.com/static/docs/'
+test_files:
+- spec/nexaas/cipher/id_crypter_spec.rb
+- spec/nexaas/cipher/salt_spec.rb
+- spec/nexaas/cipher/xor_crypter_spec.rb
+- spec/spec_helper.rb