pg-aws_rds_iam 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49df62cf1db1c3fdbfdd25f515b65cea8335dec18e050581ef45a3005f4b6ad9
+  data.tar.gz: 322858372f9fdc7b80b8cf7aaecc131e97f80efa44f8879bfed02445ca786633
+SHA512:
+  metadata.gz: 76839858df3934b56f08cbb481d2d40b3e8e7993b0bed0e00b304a1fb608e21a544183a7664c32da17eb11ca5f1edae030da56bc75d6e346ae6e9ce0ed4c5009
+  data.tar.gz: 415384ef75576d6b0af3499d0ee8341415405b4717f63149fd8f5b5c0c0b50a268067907b9aed844e6f120fab57b10e795fa6b564c1f4e93e2e9489ca41aae70

data/.github/workflows/pull-request.yml

@@ -0,0 +1,90 @@
+name: pull-request
+
+on:
+  - pull_request
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+
+        pg:
+          - "0.18"
+          - "0.19"
+          - "0.20"
+          - "0.21"
+          - "1.0"
+          - "1.1"
+          - "1.2"
+
+        activerecord:
+          - "5.2"
+          - "6.0"
+
+    name: Ruby ${{ matrix.ruby }} | PG ${{ matrix.pg }} | ActiveRecord ${{ matrix.activerecord }}
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: ruby:${{ matrix.ruby }}-alpine
+
+    env:
+      BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle
+      ACTIVERECORD_VERSION: ${{ matrix.activerecord }}
+      PG_VERSION: ${{ matrix.pg }}
+
+    steps:
+      - name: Install dependencies
+        run: apk add build-base git postgresql-dev
+
+      - name: Check out source code
+        uses: actions/checkout@v2
+
+      - name: Install Bundler
+        run: bin/install-bundler
+
+      - name: Update Gemfile.lock
+        run: bin/bundle lock --update activerecord pg
+
+      - name: Compute cache key
+        id: cache-key
+        run: |
+          source /etc/os-release
+          postgresql_version=$(apk info --installed postgresql-dev --verbose)
+          printf \
+            "::set-output name=cache-key::alpine-%s-ruby-%s-%s\n" \
+            "${VERSION_ID}" \
+            "${RUBY_VERSION}" \
+            "${postgresql_version}"
+
+      - name: Cache gems
+        uses: actions/cache@v1
+        with:
+          key: ${{ steps.cache-key.outputs.cache-key }}-gems-${{ hashFiles('Gemfile.lock') }}
+          path: vendor/bundle
+
+      - name: Install gems
+        run: bin/bundle install
+        env:
+          BUNDLE_FROZEN: true
+          BUNDLE_JOBS: 4
+          BUNDLE_RETRY: 3
+
+      - name: Run RuboCop
+        run: bin/rake rubocop
+
+      - name: Run unit tests
+        run: bin/rake test:unit
+
+      - name: Run acceptance tests
+        run: bin/rake test:acceptance
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+          DATABASE_URL: ${{ secrets.DATABASE_URL }}
+          SECURITY_GROUP_ID: ${{ secrets.SECURITY_GROUP_ID }}

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.terraform/
+
+*.tfstate*
+*.tfvars
+.env

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - bin/bundle
+    - bin/rake
+    - bin/yard
+    - vendor/**/*
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - lib/pg/aws_rds_iam/auth_token_injector.rb
+    - lib/pg/aws_rds_iam/connection_info.rb
+    - lib/pg/aws_rds_iam/connection_info/**/*.rb
+    - lib/pg/aws_rds_iam/connection.rb
+    - test/**/*.rb
+
+Style/HashSyntax:
+  Exclude:
+    - Rakefile
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+## [0.1.0] - 2020-02-05
+
+### Added
+* A plugin for the [`pg` gem](https://rubygems.org/gems/pg) that adds support for [IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) when connecting to PostgreSQL databases hosted in Amazon RDS. ([#1](https://github.com/haines/pg-aws_rds_iam/pull/1))
+* ActiveRecord support. ([#3](https://github.com/haines/pg-aws_rds_iam/pull/3))
+
+[Unreleased]: https://github.com/haines/pg-aws_rds_iam/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/haines/pg-aws_rds_iam/compare/64168051a8ef5f32a13632d8ef0b7da00d0056bc...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,87 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at andrew@haines.org.nz.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate.
+A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior.
+No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time.
+This includes avoiding interactions in community spaces as well as external channels like social media.
+Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time.
+No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the project community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq.
+Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+["activerecord", "pg"].each do |gem_name|
+  gem_version = ENV["#{gem_name.upcase}_VERSION"]
+  gem gem_name, "~> #{gem_version}.0" if gem_version
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    pg-aws_rds_iam (0.1.0)
+      aws-sdk-rds (~> 1.0)
+      pg (>= 0.18, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+    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)
+    ansi (1.5.0)
+    ast (2.4.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.270.0)
+    aws-sdk-core (3.89.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.138.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-rds (1.76.0)
+      aws-sdk-core (~> 3, >= 3.71.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    builder (3.2.4)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jmespath (1.4.0)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pg (1.2.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    yard (0.9.24)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 5.2, < 7.0)
+  aws-sdk-ec2 (~> 1.137)
+  bundler (~> 2.0)
+  minitest (~> 5.14)
+  minitest-reporters (~> 1.4)
+  pg-aws_rds_iam!
+  pry (~> 0.12)
+  rake (~> 13.0)
+  rubocop (~> 0.79)
+  timecop (~> 0.9)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrew Haines
+
+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,127 @@
+# PG::AWS_RDS_IAM
+
+`PG::AWS_RDS_IAM` is a plugin for the [`pg` gem](https://rubygems.org/gems/pg) that adds support for [IAM authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) when connecting to PostgreSQL databases hosted in Amazon RDS.
+
+IAM authentication allows your application to connect to the database using secure, short-lived authentication tokens instead of a fixed password.
+This gives you greater security and eliminates the operational overhead of rotating passwords.
+
+## Installation
+
+Install manually:
+
+```console
+$ gem install pg-aws_rds_iam
+```
+
+or with Bundler:
+
+```console
+$ bundle add pg-aws_rds_iam
+```
+
+## Usage
+
+To use IAM authentication for your database connections, you need to
+
+1. enable IAM authentication for your database,
+2. provide your application with IAM credentials, and
+3. configure your application to generate authentication tokens.
+
+### 1. Enable IAM authentication for your database
+
+Start by configuring your database to allow IAM authentication using either the [AWS console](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Enabling.html#UsingWithRDS.IAMDBAuth.Enabling.Console) or the [`aws` CLI](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Enabling.html#UsingWithRDS.IAMDBAuth.Enabling.CLI).
+This doesn't require downtime so is safe to apply immediately, unless you already have pending modifications that require a database reboot.
+
+Next, [grant your database user the `rds_iam` role](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.DBAccounts.html#UsingWithRDS.IAMDBAuth.DBAccounts.PostgreSQL).
+
+### 2. Provide your application with IAM credentials
+
+The most secure way to grant your application permission to connect to your database is to use an IAM role.
+
+Start by [creating a service role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) if your application doesn't already have one.
+Then, create an [IAM policy granting the `rds-db:connect` permission](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.IAMPolicy.html) and attach it to the role.
+
+If you've created a new service role, you'll need to associate it with your application.
+The way to do this depends on where you are running your application:
+
+* for EC2 instances, [set up an instance profile](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html);
+* for EKS pods, [associate the IAM role with a Kubernetes service account](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html);
+* for ECS tasks, [configure a task role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html); or
+* for Lambda functions, [set the execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html).
+
+If you can't use a service role, then you can grant the permissions to an IAM user instead and supply the application with their access key through a [configuration profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) or via the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
+However, you won't get the full security and operational benefits of RDS IAM authentication, because the access key is a long-lived secret that you need to supply to the application securely and rotate periodically.
+
+### 3. Configure your application to generate authentication tokens
+
+You can use `PG::AWS_RDS_IAM`'s default authentication token generator if you are using a service role as described above, or if you configure your application using the standard AWS ways to provide [credentials](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html#aws-ruby-sdk-setting-credentials) and [region](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html#aws-ruby-sdk-setting-region).
+
+To use the default authentication token generator, set the `aws_rds_iam_auth_token_generator` connection parameter to `default`.
+You can set this parameter in
+
+* the query string of a connection URI:
+
+  ```
+  postgresql://andrew@postgresql.example.com:5432/blog?aws_rds_iam_auth_token_generator=default
+  ```
+
+* a `key=value` pair in a connection string:
+
+  ```
+  user=andrew host=postgresql.example.com port=5432 dbname=blog aws_rds_iam_auth_token_generator=default
+  ```
+
+* a `key: value` pair in a connection hash:
+
+  ```ruby
+  PG.connect(
+    user: "andrew",
+    host: "postgresql.example.com",
+    port: 5432,
+    dbname: "blog",
+    aws_rds_iam_auth_token_generator: "default"
+  )
+  ```
+
+* `database.yml`, if you're using Rails:
+
+  ```yaml
+  production:
+    adapter: postgresql
+    username: andrew
+    host: postgresql.example.com
+    port: 5432
+    database: blog
+    aws_rds_iam_auth_token_generator: default
+  ```
+
+If the default authentication token generator doesn't meet your needs, you can register an alternative with
+
+```ruby
+PG::AWS_IAM_RDS.auth_token_generators.add :custom do
+  PG::AWS_IAM_RDS::AuthTokenGenerator.new(credentials: ..., region: ...)
+end
+```
+
+To use this alternative authentication token generator, set the `aws_rds_iam_auth_token_generator` connection parameter to the name you registered it with (`custom`, in this example).
+
+The block you give to `add` must construct and return the authentication token generator, which can either be an instance of `PG::AWS_IAM_RDS::AuthTokenGenerator` or another object that returns a string token in response to `call(host:, port:, user:)`.
+The block will be called once, when the first token is generated, and the returned authentication token generator will be re-used to generate all future tokens.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bin/rake` 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 `bin/rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bin/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](https://github.com/haines/pg-aws_rds_iam).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/haines/pg-aws_rds_iam/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).