portunus 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e68d034c4896eb04c0540e5937ebe6cea88af51bd1ee0b66526d1e84eb92d6db
+  data.tar.gz: fb0c26ef7df5bdfdbf58feec0dbd13b222598f9f07196231fe06351d72d0f89a
+SHA512:
+  metadata.gz: 50e8be7b50b816b1c45d6743085004be1b9e6e6b3a64ed1de57836829d46f7d8b1bb5145483cf997b4d633693a7da84b9daea67d4b2484c1a6f88f0b48718a08
+  data.tar.gz: e2966752917367326122e3976662cde66810cfa536c0ebb19c71caf2a65eedb88b5832f7efeb0dac635eb7f19a28823fb0eebccf95553056c139fc40637bc66a

data/.gitignore

@@ -0,0 +1,3 @@
+log/*
+coverage
+log

data/.nvmrc

@@ -0,0 +1 @@
+v13.5.0

data/.travis.yml

@@ -0,0 +1,27 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=f40f50c1b06c16f8e703b01facaf313bcd0a7aa56100b9b077648607ca050833
+cache:
+  bundler: true
+language: ruby
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+before_install:
+  - nvm install                         # Install node version from .nvmrc
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+install: 
+  - bundle install --without production --path=${BUNDLE_PATH:-vendor/bundle}
+  - npm install
+before_script:
+  - bin/setup
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec spec/
+after_script:
+  - ./cc-test-reporter format-coverage -t simplecov -o coverage/codeclimate.backend.json coverage/backend/.resultset.json # Format backend coverage
+#  - ./cc-test-reporter format-coverage -t lcov -o coverage/codeclimate.frontend.json coverage/frontend/lcov.info  # Format frontend coverage
+  - ./cc-test-reporter sum-coverage coverage/codeclimate.*.json -p 1                  # Sum both coverage parts into coverage/codeclimate.json
+  - if [[ "$TRAVIS_TEST_RESULT" == 0 ]]; then ./cc-test-reporter upload-coverage; fi  # Upload coverage/codeclimate.json

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at colinpetruno@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in portunus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,189 @@
+PATH
+  remote: .
+  specs:
+    portunus (0.3.0)
+      aes
+      openssl (>= 2.1.0)
+      rails (>= 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    aes (0.5.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.4)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    debug_inspector (0.0.3)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    ipaddr (1.2.2)
+    json (2.3.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    openssl (2.1.2)
+      ipaddr
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
+    pry-stack_explorer (0.4.9.3)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.17)
+  codeclimate-test-reporter
+  portunus!
+  pry-rails
+  pry-stack_explorer
+  rails (>= 5.0.0)
+  rake (> 12.3.3)
+  rspec
+  simplecov (~> 0.17.1)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Colin Petruno
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,289 @@
+# Portunus
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/8370f4feb43195c73150/maintainability)](https://codeclimate.com/github/colinpetruno/portunus/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/8370f4feb43195c73150/test_coverage)](https://codeclimate.com/github/colinpetruno/portunus/test_coverage) [![Build Status](https://travis-ci.org/colinpetruno/portunus.svg?branch=master)](https://travis-ci.org/colinpetruno/portunus)
+
+Portunus is an opininated, object-oriented encryption engine built for Ruby on Rails 
+applications. It utilizes a KEK (Key Encryption Key) & DEK (Data
+Encryption Key) scheme. 
+
+KEK keys should be stored outside the application. Portunus provides a 
+few default adaptors for working with common deployment setups. While this
+is more secure than having unencrypted database data, the best use of 
+Portunus would connect to and do the encryption / decryption of your keys
+inside of an HSM. Portunus is easily extensible to accomplish this but it's
+not included due to the extensive variety of possible deployments.
+
+Lastly, Portnus has scripts included to do automatic rotation of these keys.
+It's important to rotate both master keys and data encryption keys. Scripts
+are included for both of these that can be scheduled via cron. 
+   
+## Background
+Privacy and security need to be considered from the very start of building an
+application. While web development has gotten more accessible, application
+security has not. Portunus is intended to be a drop in utility that requires
+just minutes of set up to ensure your app is using a DEK and KEK encryption 
+key to protect your database from several types of attacks. If you want to 
+go futher, it's easily extensible for your custom solution.  
+   
+## Installation
+
+### Install the gem
+
+
+    $ gem "portunus"
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install portunus
+
+Run the generator. This will create the required Portunus tables.
+
+    $ rails generate portunus:install
+    $ rails db:migrate
+
+Include the encryptable module on any of your models or add it to 
+`ApplicationRecord` to ensure all your models have access to field encryption.
+
+```ruby
+include Portunus::Encryptable
+```
+
+### Set up your master keys
+Portunus comes with two adaptors for your master keys, "credentials" and 
+"environment". This should cover the most common deploy scenarios. Before
+Portunus can function, enabled master keys need to be added. There is a 
+generator to create the keys for you to then install in the proper 
+location.
+
+    $ bundle exec rake portunus:generate_master_keys
+
+### Additional devise notes
+
+There is additional configuration required if you are using devise and 
+desire to encrypt your email column. Devise will by default downcase email 
+addresses. The downcasing performed by devise happens after the portunus 
+encryption and result in broken encrypted values. This behaviour needs to 
+be disabled from devise and you will need to handle the downcasing prior 
+to encryption.  
+
+
+   
+## Basic Configuration
+
+To enable encryption on a column, add the `encrypted_fields` method in the 
+model and give it the fields you want to encrypt.
+
+```ruby
+class Member < ApplicationRecord
+  encrypted_fields :email
+end
+```
+
+### Database level defaults
+
+Since the database does not have access to your encryption engine, default
+values will break the encryption. You need to ensure defaults for encrypted
+columns are set within your application logic.
+
+
+### Type casting
+
+In order to provide a simpler implementation in your app, Portunus has type 
+casting support. The encrypted data must be stored as strings. To utilize 
+Portunus with different types, you may specify the type on the field. 
+
+```ruby
+class User < ApplicationRecord
+  encrypted_fields :email, :firstname, birthdate: { type: :date }
+end
+```
+
+#### Supported types
+- Boolean (:boolean)
+- Date (:date)
+- DateTime (:datetime)
+- Float (:float)
+- Integer (:integer)
+- String (:string) (default)
+
+
+
+### Hashing
+
+Encrypted data cannot be searched. Portunus provides an automatic hash 
+mechanism for encrypted data. The hashing happens prior to validation on the
+model and will take your encrypted_field and put it into a column with a name
+of `hashed_encrypted_field`. 
+
+For instance, a migration for this may look like. 
+
+```ruby
+create_table :members do |t|
+  t.string :hashed_email, null: false
+  t.string :email, null: false
+end
+```
+
+and the model:
+
+```ruby
+class Member < ApplicationRecord
+  encrypted_fields :email
+end
+```
+
+#### Portunus::Hasher
+There is a class provided to perform the hashing that you can utilize to look up date.
+
+```ruby
+  User.find_by(email: ::Portunus::Hasher.for(params[:email])
+```
+&nbsp;  
+## Advanced Setup
+
+### Configuration block
+Portunus can be easily customized using a configuration initializer.
+
+```ruby
+Portunus.configuration do |config|
+  config.storage_adaptor = Portunus::StorageAdaptors::Credentials
+  config.encrypter = Portunus::Encrypters::OpenSslAes
+  config.max_key_duration = 1.month 
+end
+```
+
+#### Options
+- `storage_adaptor` - This is finds and looks up master keys.
+- `encrypter` - This is responsible for setting the encrypter that encrypts
+  decrypts the data. 
+- `max_key_duration` - Timeframe for how old you want to allow keys to exist for. 
+  Ideally your keys are constantly being rotated. Used in key rotation tasks.
+
+&nbsp;   
+## Storage adaptors
+
+Storage adaptors provide the interface to determine which master key to decrypt
+a data key. Portunus comes with two adaptors to access master keys out of the box.
+
+- **Portunus::StorageAdaptors::Environment**
+- **Portunus::StorageAdaptors::Credentials**
+
+We need to keep track of the following items:
+
+- **Key name** - This is what is stored on the data encryption key table to find the
+  master key
+- **Enabled** - Whether the key is enabled for new data keys. Note: If you disable a 
+  key, that just stops future keys from generating. Until all the keys are rotated,
+  do not remove the key. 
+- **Created date** - When the key was created to help track rotation duration
+
+The master key id is stored on the data key table. These adaptors work like hash
+maps. The key id is passed and a value is returned. The value for both default
+adaptors is the master key. However if you were writing for an environment where keys
+are stored inside an HSM the value could be the key id in the HSM. The encrypter
+would then take that key id and interface with the HSM. 
+
+Adaptors are easily registered in the config so you can take an existing one 
+and customize to your requirements. 
+
+### EnvironmentAdaptor
+Store and manage keys through any environment. Great for deployments like 
+Heroku. The environment adaptor needs multiple keys per master key to track
+the key value, date created and enabled.  
+
+
+### Credentials adaptor (default)
+This gets your master keys from your rails credential files. An example 
+structure is:
+
+```yaml
+portunus:
+  f9e59a8c17c5f430f17745a522ebc2b7:
+    key: 93a05a5ce18afb85162a34d552c953b3
+    enabled: true
+    created_at: "2020-03-13T12:11:11+01:00"
+  140f33e69f0647cbc14b64605f002ff6:
+    key: d2c2aa9b7aeff75513ca24efcd8b8dd3
+    enabled: true
+    created_at: "2020-03-13T12:11:11+01:00"
+```
+&nbsp;
+## Key rotation
+Portunus provides key rotation scripts to rotate DEKs, KEKs, and both at 
+once. The DEK rotation script will rotate keys every six months. If provided
+a force option as an environment variable it will rotate all the keys. The 
+KEK rotation will rotate all master keys. This will probably take a long time
+in many apps so therefore you can rotate the master keys invidually by 
+providing the key name. 
+
+
+    $ bundle exec rake portunus:rotate_deks
+    $ FORCE=true bundle exec rake portunus:rotate_deks
+    $ bundle exec rake portunus:rotate_keks
+    $ KEY_NAME=<keyname> bundle exec rake portunus:rotate_deks
+   
+&nbsp;  
+## Tips
+- Security is about applying layers. Using Portunus with the default 
+configuration helps protects against specific types of attacks. However, in the 
+event your complete environment is compromised there is not much that can
+be done. 
+- Providing seperation of concerns within your organization can help if you
+need the data to survive even if someone gets direct server access. Every 
+aspect of Portunus is easily configured to ensure this is possible for you.
+- When deciding how many master keys to use, keep the amount of data in mind.
+  Each key is responsible for encrypting a certain number of DEKs. The lower
+  this is kept the easier it will be to rotate. 
+- Schedule rotation often. The dek rotator can be run every day or on even
+  smaller intervals. 
+
+
+
+
+&nbsp;  
+## Improvements
+
+Some items I'd like to see added:
+
+- Migration support from an unencrypted to encrypted column
+- Google Cloud HSM Encrypter
+- Improve key rotations
+- Research better devise solution.
+- Different encrypters or key sources for different data rows 
+- Dashboard to show key usage and which keys can be removed
+- Automatic master key introduction and rotation
+
+&nbsp;  
+## Development
+
+After checking out the repo, run `bundle install to install dependencies. 
+
+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).
+&nbsp;  
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/colinpetruno/portunus. 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.
+&nbsp;  
+## License
+
+The gem is available as open source under the terms of 
+the [MIT License](https://opensource.org/licenses/MIT).
+&nbsp;  
+## Code of Conduct
+
+Everyone interacting in the Portunus project’s codebases, issue trackers, 
+chat rooms and mailing lists is expected to follow 
+the [code of conduct](https://github.com/[USERNAME]/portunus/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "portunus"
+
+# 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(__FILE__)

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/lib/Rakefile

@@ -0,0 +1,4 @@
+require 'my_gem'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/generators/install_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require "rails/generators/active_record/migration"
+
+module Portunus
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+      desc "Add the migrations for Porteus"
+
+      def copy_migrations
+        warn "Creating Migrations for Portunus Encryption"
+        migration_template(
+          "create_portunus.rb.erb",
+          "db/migrate/create_portunus.rb"
+        )
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end