aws-ssm-env 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02a1b7f6e19f94121b951fa081dab24f07a19b63
+  data.tar.gz: 91ea648fbd61babe279737fe07bf67d379976fa0
+SHA512:
+  metadata.gz: 1494b25e51d89ed45f473a373d462b6f84e9d7735c204e5e1ebb1e398470ee60c641c08c5f3b1f93dd29cc8fe56e3af8cb6f4512213f1cb9eb3674c0c3086958
+  data.tar.gz: 682c81baa1ff424184e5a2ac1e1b00698edda851e9b4118bb87d1ad966dc7c15f864cabc3ef190271f9cbe5e118162ace305ea0cfe1dcb274b667584f792e2ae

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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,272 @@
+# aws-ssm-env
+
+AWS EC2 Parameter Storeから取得したパラメータを環境変数として設定します。  
+
+デフォルトでは、パラメータ名の最後の階層が環境変数名として設定されます。  
+
+例えば、`/staging/secure/DB_PASSWORD`というパラメータ名であれば、`ENV['DB_PASSWORD']`にパラメータ値が設定されます。  
+この環境変数のネーミングはオプションでカスタマイズ可能です。(後述)
+
+## Installation
+
+```
+gem install aws-ssm-env
+```
+
+### Rails
+
+```ruby
+# Gemfile
+gem 'aws-ssm-env', group: :aws
+```
+
+```ruby
+# config/application.rb
+if defined?(AwsSsmEnv)
+  AwsSsmEnv.load(path: "/myapp/#{ENV['RAILS_ENV']}", recursive: true)
+end
+```
+
+### Other ruby program
+
+```ruby
+require 'aws-ssm-env'
+AwsSsmEnv.load!(begins_with: "myapp.ENV['RACK_ENV'].")
+```
+
+## Quick Start
+
+事前にAWS EC2 Parameter Storeにパラメータを登録しておく必要があります。
+
+```shell
+# 例) /myservice/staging/RDS_PASSWORDをSecureStringで登録
+aws ssm --region ap-northeast-1 put-parameter \
+  --name /myservice/staging/RDS_PASSWORD \
+  --type SecureString --value <secret value>
+```
+
+AWSの認証情報を設定します。例えば、以下のように環境変数を利用したり、
+
+```shell
+export AWS_ACCESS_KEY_ID=YOURACCESSKEYID
+export AWS_SECRET_ACCESS_KEY=YOURSECRETKEY
+bundle exec rails start
+```
+
+引数で`ssm_client_args`を渡したり、
+
+```ruby
+AwsSsmEnv.load(
+  fetch: "/myservice/#{ENV['RAILS_ENV']}",
+  ssm_client_args: {
+    access_key_id: 'ACCESS_KEY_ID',
+    secret_access_key: 'SECRET_ACCESS_KEY',
+    region: 'ap-northeast-1',
+  }
+)
+```
+
+`Aws.config`を利用することもできます。
+
+```ruby
+
+if defined?(AwsSsmEnv)
+  AWS.config({
+    access_key_id: 'ACCESS_KEY_ID',
+    secret_access_key: 'SECRET_ACCESS_KEY',
+    region: 'ap-northeast-1',
+  })
+  AwsSsmEnv.load(path: "/myservice/#{ENV['RAILS_ENV']}")
+end
+```
+
+詳細はaws-sdkのドキュメントを参照してください。
+
+## Usage
+
+`AwsSsmEnv#load`に渡すオプションの説明です。
+
+### decryption: [Boolean]
+
+SecureStringのパラメータを復号化するかどうかを表すフラグ。  
+`true`を指定した場合は取得したSecureStringパラメータの値は復号化されている。  
+`false`の場合は暗号化されたまた環境変数値として設定される。  
+なお、このためのgemなのでデフォルトは`true`(復号化する)。
+
+### overwrite: [Boolean]
+
+すでに設定されている環境変数を上書きするかどうかを指定する。  
+`true`を指定した場合、環境変数が設定されていても取得したパラメータ値で上書きする。  
+`false`を指定した場合はすでに設定されている環境変数を上書きしない。  
+デフォルトは`false`(上書きしない)。  
+なお、`AwsSsmEnv#load!`を実行した場合、このフラグは自動的に`true`になる。
+
+### client: [Aws::SSM::Client]
+
+`Aws::SSM::Client`のインスタンスを指定する。  
+すでに生成済みのインスタンスがある場合にそれを設定するためのオプション。  
+生成済みのインスタンスがない場合は`ssm_client_args`を利用する。
+
+### ssm_client_args: [Hash]
+
+`Aws::SSM::Client`のコンストラクタに渡すハッシュを指定する。  
+指定しなかった場合は引数なしで`Aws::SSM::Client.new`が呼ばれる。  
+環境変数やEC2インスタンスプロファイルによる認証情報を利用する場合は不要。
+
+### fetch: [Symbol, AwsSsmEnv::Fetcher, Object]
+
+パラメータ取得方法を指定する。  
+指定可能な値は`:path`, `:begins_with`または`AwsSsmEnv::Fetcher`を実装したクラスのインスタンス、`each`メソッドを
+持ったクラスのインスタンスのいずれか。  
+何も指定されていない場合は`:path`として扱われるが、後述の`begins_with`が指定されていた場合は自動的に`:begins_with`となる。
+
+#### :fetch => :path
+
+`:path`を指定した場合はパラメータ階層をパス指定で取得する`AwsSsmEnv::PathFetcher`が利用される。  
+この場合は後述の`path`引数が必須となる。また、後述の`recursive`引数を利用する。  
+この方法でパラメータを取得する場合は指定するパスに対して`ssm:GetParametersByPath`の権限が必要。
+以下、IAMポリシーの例を示す。
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": "ssm:GetParametersByPath",
+      "Resource": "arn:aws:ssm:YOUR_REGION:YOUR_ACCOUNT_ID:parameter/YOUR_PATH"
+    }
+  ]
+}
+```
+
+#### :fetch => :begins_with
+
+`:begins_with`を指定した場合はパラメータ名が指定した文字列から開始するパラメータを取得する`AwsSsmEnv::BeginsWithFetcher`が利用される。  
+この場合は後述の`begins_with`引数が必須となる。
+この方法でパラメータを取得する場合は指定するパスに対して`ssm:DescribeParameters`および`ssm:GetParameters`の権限が必要。
+以下、IAMポリシーの例を示す。
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": "ssm:DescribeParameters",
+      "Resource": "arn:aws:ssm:YOUR_REGION:YOUR_ACCOUNT_ID:parameter"
+    },
+    {
+      "Sid": "",
+      "Effect": "Allow",
+      "Action": "ssm:GetParameters",
+      "Resource": "arn:aws:ssm:YOUR_REGION:YOUR_ACCOUNT_ID:parameter/YOUR_PREFIX*"
+    }
+  ]
+}
+```
+
+#### other
+
+`fetch`に`AwsSsmEnv::Fetcher`を実装したクラスのインスタンス、もしくは`each`メソッドを持つインスタンスを指定した場合はそのインスタンスをそのまま利用する。
+
+### naming: [Symbol, AwsSsmEnv::NamingStrategy, Object]
+
+環境変数名を導出方法を指定する。  
+指定可能な値は`:basename`, `:snakecase`または`AwsSsmEnv::NamingStrategy`を実装したクラスのインスタンス、`parse_name`メソッドを持ったクラスのインスタンスのいずれか。  
+デフォルトは`:basename`。
+
+#### :naming => :basename or :naming => nil
+
+`naming`を指定しなかった場合、もしくは`:basename`を指定した場合はパラメータ階層の最後の階層を変数名とする`AwsSsmEnv::BasenameNamingStrategy`が利用される。  
+この場合、例えば`/myapp/production/DB_PASSWORD`というパラメータ名であれば`ENV['DB_PASSWORD']`にパラメータ値がインジェクションされる。
+
+#### :naming => :snakecase
+
+`:snakecase`を指定した場合はパラメータ名のスラッシュ区切りをアンダースコア区切りにした結果を大文字に変換して環境変数名とする`AwsSsmEnv::SnakeCaseNamingStrategy`が利用される。  
+この場合、例えば`/myapp/production/DB_PASSWORD`というパラメータ名であれば`ENV['MYAPP_PRODUCTION_DB_PASSWORD']`にパラメータ値がインジェクションされる。  
+後述の`removed_prefix`引数で除外する先頭文字列を指定することができる。  
+また、後述の`delimiter`オプションでアンダースコアに変換する文字を指定できる。  
+以下の例では`/myapp/production/db/password`というパラメータが`ENV['DB_PASSWORD']`にインジェクションされる。
+
+```ruby
+AwsSsmEnv.load(naming: :snakecase, removed_prefix: '/myapp/production')
+```
+
+#### other
+
+`AwsSsmEnv::NamingStrategy`を実装したクラスのインスタンス、もしくは`parse_name`メソッドを持つ  
+インスタンスを指定した場合はそのインスタンスをそのまま利用する。
+
+### path: [String]
+
+`fetch`に何も指定していない場合、もしくは`:path`を指定した場合は必須となる。  
+パラメータを取得するパス階層を指定する。  
+下の例では`/myapp/web/production`直下のパラメータが取得される。
+
+```ruby
+AwsSsmEnv.load(path: '/myapp/web/production')
+```
+
+#### recursive: [Boolean]
+
+`fetch`に何も指定していない場合、もしくは`:path`を指定した場合に利用する。  
+指定したパス階層以下のパラメータをすべて取得する。  
+下の例では`/myapp/web/production`以下すべてのパラメータが取得される。
+
+```ruby
+AwsSsmEnv.load(path: '/myapp/web/production', recursive: true)
+```
+
+### begins_with: [String, Array<String>]
+
+`fetch`に`:begins_with`を指定した場合は必須となる。  
+取得するパラメータ名のプレフィクスを指定する。配列で複数指定することも可能(OR条件となる)。  
+下の例では`myapp.web.production`で始まる名前のパラメータが取得される。
+
+```ruby
+AwsSsmEnv.load(path: 'myapp.web.production')
+```
+
+### removed_prefix: [String]
+
+`naming`に`:snakecase`を指定した場合に利用される。  
+環境変数名から除外するパラメータ名のプレフィクスを指定する。  
+`:removed_prefix`が指定されておらず、`:begins_with`もしくは`:path`が指定されていた場合はそれを利用する。
+
+### delimiter: [String, Regexp]
+
+`naming`に`:snakecase`を指定した場合に利用される。  
+アンダースコアに変換する文字列もしくは正規表現を指定する。  
+デフォルトはスラッシュ(`/`)。
+
+### fetch_size: [Integer]
+
+一度のAWS API実行で取得するパラメータ数を指定する。 `:path`指定の場合は最大値は`10`でデフォルトも`10`。  
+`:begins_with`指定の場合は最大値は`50`でデフォルトも`50`である。通常このパラメータを指定することはない。
+
+
+## Motivation
+
+RailsアプリケーションをECSで起動する場合、環境変数を渡すのが面倒だったので作りました。  
+
+## Security
+
+シークレット情報を取得するための権限を付与しなければならないため、セキュリティ運用には十分な注意が必要です。
+
+EC2インスタンスプロファイルが設定されていた場合、そのEC2上であればどのアカウントでもパラメータが見えるようになるため、  
+EC2インスタンスプロファイルとは別にIAMユーザを用意するなどセキュリティレベルを上げる工夫が必要です。  
+
+EC2にログインできるのが管理者のみであればファイルで持つのと大差ありません。
+
+`AWS Fargate`であればコンテナ上でコマンドの実行はできないので、シークレット情報が見られることはありません。
+
+## License
+
+Apache License 2.0
+
+## Contributors
+
+- Ryohei Sonoda <[sonodar](https://github.com/sonodar)>