aion-s3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e2a5f113d1729577f5f289cd6d96acd4d530833fd6deffd840f0c54eae00ce7
+  data.tar.gz: 29fbc5075544c42f8269533ec46fcac2e38358bd3e524e11813d1ea59a96f5b1
+SHA512:
+  metadata.gz: 00cd42ac47c8339fcc2f4d1b640c42f055dc19ee95f30191cda8333843cc62797f82662600cbe2e65021e54b4cc201b6f69350e04b4ed709da97a0518843158a
+  data.tar.gz: dab3192475cc6c6e8cff389953b613ee0e2c2b03c06e7d1bd7f429cd6887325e99988e9d93a99f6f110a421672a7408e32c556b9281370662890a8fc22c01a3b

data/lib/aion-s3.rb

@@ -0,0 +1 @@
+require 'aion_s3'

data/lib/aion_s3.rb

@@ -0,0 +1,8 @@
+# This module provides utilities for compressing and encrypting data, as well as uploading
+# compliance locked objects to AWS s3.
+module AionS3
+end
+
+require 'aion_s3/packer'
+require 'aion_s3/uploader'
+require 'aion_s3/version'

data/lib/aion_s3/packer.rb

@@ -0,0 +1,120 @@
+require 'openssl'
+require 'zlib'
+require 'securerandom'
+
+module AionS3
+
+  # A <code>Packer</code> is a utility for packing and unpacking data.
+  # Packing applies compression and encryption to provided data.
+  # Unpacking applies decryption and decompression to provided data.
+  #
+  # Encryption uses cipher +AES-256-CBC+. The key is generated via a password provided when the <code>Packer</code> is initialized.
+  # The password must be a string at least 20 chars long.
+  #
+  # It is *very* important that the password is randomly generated.
+  class Packer
+
+    # @return [String]
+    attr_reader :password
+
+    # Returns a new Packer object with a key based on the given +password+.
+    # If no password is provided, a random password will be generated
+    # The password can later be read via #password.
+    #
+    # @param [String] password
+    def initialize(password = nil)
+      password ||= Packer.random_password
+      if password and password.size < 32
+        raise ArgumentError, 'Provided password must be at least 32 characters'
+      end
+      @key = OpenSSL::Digest.digest('sha256', password)
+      @password = password.freeze
+    end
+
+    # Encrypts data with +AES-256-CBC+ and returns it as a binary encoded string.
+    #
+    # @param [String] data
+    # @return [String] a binary encoded string
+    def encrypt(data)
+      _data = data
+      cipher = OpenSSL::Cipher::AES.new(256, :cbc).encrypt
+      cipher.key = @key
+      cipher.random_iv + cipher.update(_data) + cipher.final
+    end
+
+    # Decrypts data that have been encrypted using #encrypt(data) and returns it as a binary encoded string.
+    #
+    # @param [String] data
+    # @return [String] a binary encoded string
+    def decrypt(data)
+      _data = data
+      decipher = OpenSSL::Cipher::AES.new(256, :cbc).decrypt
+      decipher.key = @key
+      decipher.iv = _data.byteslice(0,16)
+      decipher.update(_data.byteslice(16, _data.bytesize - 16)) + decipher.final
+    end
+
+    # Decompresses data with zlib and returns it a binary encoded string.
+    #
+    # @param [String] data
+    # @return [String] a binary encoded string
+    def deflate(data)
+      Zlib::Deflate.deflate(data, Zlib::BEST_COMPRESSION)
+    end
+
+    # Compresses data with zlib and returns it a binary encoded string.
+    #
+    # @param [String] data
+    # @return [String] a binary encoded string
+    def inflate(data)
+      Zlib::Inflate.inflate(data)
+    end
+
+    # Compresses and encrypts given data.
+    #
+    # *Note*
+    # The ruby string's local encoding will be lost when packed.
+    # unpack(data) will always return a string with binary encoding.
+    #
+    # Example:
+    #
+    #   data = 'æøå'  # utf8 encoded string
+    #   str = unpack(pack(data))
+    #
+    #   puts str.bytes == data.bytes
+    #   puts str == data
+    #   puts str.encoding == data.encoding
+    #
+    # Produces:
+    #
+    #   true
+    #   false
+    #   false
+    #
+    # @param [String] data
+    # @return [String] a binary encoded string
+    def pack(data)
+      encrypt(deflate(data))
+    end
+
+    # Decrypts and decompresses given data.
+    #
+    # @param [Object] data
+    # @return [String] a binary encoded string
+    def unpack(data)
+      inflate(decrypt(data))
+    end
+
+    # Returns a base64 encoded string based on random bytes.
+    # The length will be <code>n * 2</code> characters.
+    #
+    # If +n+ is not defined, it will default to 24, which will generate a 32 character base64 encoded string.
+    #
+    # @param [Integer] n
+    # @return [String] a base64 encoded string
+    def self.random_password(n = 24)
+      SecureRandom.base64(n)
+    end
+
+  end
+end

data/lib/aion_s3/uploader.rb

@@ -0,0 +1,64 @@
+require 'aws-sdk-s3'
+
+module AionS3
+
+  # An <code>Uploader</code> is a utility for uploading data to s3.
+  # The Uploader supports compliance locking, where files are locked for update/deletion for a configured amount of time.
+  #
+  # The utility is a wrapper around <code>Aws::S3::Client</code>.
+  class Uploader
+
+    # @return [Aws::S3::Client]
+    attr_reader :client
+
+    # @param [String] bucket
+    # @param [Integer] lock_days
+    # @param [Hash] s3_options
+    def initialize(bucket, lock_days: 0, s3_options: {})
+      @client = Aws::S3::Client.new(s3_options)
+      @bucket = bucket
+      @lock_seconds = lock_days.to_i * 24 * 60 * 60
+    end
+
+    # Gets metadata from an object in s3.
+    #
+    # If a target is provided, the object data will be downloaded as well.
+    # +target+ must be a string with file path or an <code>IO</code> object.
+    #
+    # @param [String] key
+    # @param [String, IO] target
+    # @return [Aws::S3::Types::GetObjectOutput]
+    def get(key, target = nil)
+      @client.get_object(
+          bucket: @bucket,
+          key: key,
+          response_target: target
+      )
+    end
+
+    # Puts an object to s3.
+    #
+    # If <code>Uploader</code> was configured with lock_days > 0 a compliance lock will be put on the object.
+    #
+    # @param [String] key an urlsafe string
+    # @param [String, IO] body
+    # @return [Aws::S3::Types::PutObjectOutput]
+    def put(key, body)
+      options = {
+          bucket: @bucket,
+          key: key,
+          body: body,
+      }
+
+      if @lock_seconds > 0
+        options.reverse_merge!(
+            object_lock_mode: 'COMPLIANCE',
+            object_lock_retain_until_date: Time.now + @lock_seconds
+        )
+      end
+
+      @client.put_object(options)
+    end
+
+  end
+end

data/lib/aion_s3/version.rb

@@ -0,0 +1,3 @@
+module AionS3
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: aion-s3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Andersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+description: A tool for compressing, encrypting and uploading files to AWS S3
+email: michael@aion.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aion-s3.rb
+- lib/aion_s3.rb
+- lib/aion_s3/packer.rb
+- lib/aion_s3/uploader.rb
+- lib/aion_s3/version.rb
+homepage: https://github.com/aion-dk/aion-s3
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Aion S3
+test_files: []