diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/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 [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. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/aws-configuration-tools.cabal b/aws-configuration-tools.cabal new file mode 100644 --- /dev/null +++ b/aws-configuration-tools.cabal @@ -0,0 +1,43 @@ +-- Initial aws-configuration-tools.cabal generated by cabal init. For +-- further documentation, see http://haskell.org/cabal/users-guide/ + +name: aws-configuration-tools +version: 0.1.0.0 +synopsis: Configuration types, parsers & renderers for AWS services +description: Configuration types, parsers & renderers for AWS services, using configuration-tools. +license: Apache-2.0 +license-file: LICENSE +author: Lars Kuhtz & Jon Sterling +maintainer: jon@jonmsterling.com +copyright: Copyright 2013-2015 PivotCloud, Inc. +category: Configuration, Cloud +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/alephcloud/hs-aws-configuration-tools.git + +source-repository this + type: git + location: https://github.com/alephcloud/hs-aws-configuration-tools.git + tag: 0.1.0.0 + + +library + exposed-modules: Configuration.Utils.Aws.Credentials + -- other-modules: + -- other-extensions: + build-depends: base >=4.7 && <5.0, + base-unicode-symbols, + configuration-tools >=0.2.12, + aws >=0.11, + aws-kinesis >=0.1.5, + aws-general >=0.2.2, + bytestring >=0.10.4.0, + text >=1.2.0.4, + mtl >=2.1.3.1, + transformers >=0.4.3.0 + hs-source-dirs: src + default-language: Haskell2010 diff --git a/src/Configuration/Utils/Aws/Credentials.hs b/src/Configuration/Utils/Aws/Credentials.hs new file mode 100644 --- /dev/null +++ b/src/Configuration/Utils/Aws/Credentials.hs @@ -0,0 +1,322 @@ +-- Copyright (c) 2013-2015 PivotCloud, Inc. +-- +-- Configuration.Utils.Aws.Credentials +-- +-- Please feel free to contact us at licensing@pivotmail.com with any +-- contributions, additions, or other feedback; we would love to hear from +-- you. +-- +-- 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. + +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE UnicodeSyntax #-} + +-- | +-- Module: Configuration.Utils.Aws.Credentials +-- Copyright: Copyright © 2013-2015 PivotCloud, Inc. +-- License: Apache-2.0 +-- Maintainer: Jon Sterling +-- Stability: experimental +-- +module Configuration.Utils.Aws.Credentials +( -- * Configuration Types + CredentialConfigKey(..) +, credentialConfigKeyId +, credentialConfigKeySecret +, validateCredentialConfigKey +, CredentialConfigFile(..) +, credentialConfigFileName +, credentialConfigKeyName +, validateCredentialConfigFile +, CredentialConfig(..) +, credentialConfigKey +, credentialConfigFile +, credentialConfigEnvironment +, credentialConfigInstanceMetadata +, defaultCredentialConfig +, pCredentialConfig +, pCredentialConfig_ +, validateCredentialConfig + + -- * Load Credentials +, credentialsFromConfig +, LoadCredentialsException(..) +) where + +import Aws + +import Configuration.Utils +import Configuration.Utils.Internal +import Configuration.Utils.Validation + +import Control.Exception +import Control.Monad +import Control.Monad.Error.Class +import Control.Monad.IO.Class +import Control.Monad.Unicode + +import Data.Maybe +import Data.Monoid.Unicode +import Data.Traversable +import Data.Typeable + +import qualified Data.ByteString.Char8 as B8 +import qualified Data.Text as T + +import Prelude.Unicode + +-- -------------------------------------------------------------------------- -- +-- Credential Configuration + +data CredentialConfigKey + = CredentialConfigKey + { _credentialConfigKeyId ∷ !B8.ByteString + , _credentialConfigKeySecret ∷ !B8.ByteString + } deriving (Show, Read, Eq, Ord, Typeable) + +credentialConfigKeyId ∷ Lens' CredentialConfigKey B8.ByteString +credentialConfigKeyId = lens _credentialConfigKeyId $ \a b → a { _credentialConfigKeyId = b } + +credentialConfigKeySecret ∷ Lens' CredentialConfigKey B8.ByteString +credentialConfigKeySecret = lens _credentialConfigKeySecret $ \a b → a { _credentialConfigKeySecret = b } + +validateCredentialConfigKey ∷ ConfigValidation CredentialConfigKey λ +validateCredentialConfigKey CredentialConfigKey{..} = do + validateNonEmpty "access_key_id" _credentialConfigKeyId + validateNonEmpty "access_key_secret" _credentialConfigKeySecret + +instance ToJSON CredentialConfigKey where + toJSON CredentialConfigKey{..} = object + [ "access_key_id" .= B8.unpack _credentialConfigKeyId + , "access_key_secret" .= B8.unpack _credentialConfigKeySecret + ] + +instance FromJSON CredentialConfigKey where + parseJSON = + withObject "CredentialConfigKey" $ \o → + CredentialConfigKey + <$> (B8.pack <$> o .: "access_key_id") + <*> (B8.pack <$> o .: "access_key_secret") + +data CredentialConfigFile + = CredentialConfigFile + { _credentialConfigFileName ∷ !FilePath + , _credentialConfigKeyName ∷ !T.Text + -- ^ default value is @"default"@ + } deriving (Show, Read, Eq, Ord, Typeable) + +credentialConfigFileName ∷ Lens' CredentialConfigFile FilePath +credentialConfigFileName = lens _credentialConfigFileName $ \a b → a { _credentialConfigFileName = b } + +credentialConfigKeyName ∷ Lens' CredentialConfigFile T.Text +credentialConfigKeyName = lens _credentialConfigKeyName $ \a b → a { _credentialConfigKeyName = b } + +validateCredentialConfigFile ∷ ConfigValidation CredentialConfigFile λ +validateCredentialConfigFile CredentialConfigFile{..} = + validateFileReadable "file_name" _credentialConfigFileName + +instance ToJSON CredentialConfigFile where + toJSON CredentialConfigFile{..} = object + [ "file_name" .= _credentialConfigFileName + , "key_name" .= _credentialConfigKeyName + ] + +instance FromJSON CredentialConfigFile where + parseJSON = + withObject "CredentialConfigFile" $ \o → + CredentialConfigFile + <$> o .: "file_name" + <*> o .:? "key_name" .!= "default" + + +-- | When parsed from configuration files or the command line the settings take +-- the following precedence: +-- +-- Explicit credential configuration gets precedence over credential file +-- configuration which has precedence over loading the credentials from the +-- environment over loading the credentials from the instance meta data. +-- +-- Any setting on the command line always has precedence over any setting in a +-- configuration file. +-- +-- If the configured file does not exist an parse error is triggered. Set this +-- value of '_credentialConfigFile' to 'Nothing' if you don't want to suppress +-- this error. +-- +data CredentialConfig + = CredentialConfig + { _credentialConfigKey ∷ !(Maybe CredentialConfigKey) + , _credentialConfigFile ∷ !(Maybe CredentialConfigFile) + , _credentialConfigEnvironment ∷ !Bool + , _credentialConfigInstanceMetadata ∷ !Bool + } deriving (Show, Eq, Ord) + +credentialConfigKey ∷ Lens' CredentialConfig (Maybe CredentialConfigKey) +credentialConfigKey = lens _credentialConfigKey $ \a b → a { _credentialConfigKey = b} + +credentialConfigFile ∷ Lens' CredentialConfig (Maybe CredentialConfigFile) +credentialConfigFile = lens _credentialConfigFile $ \a b → a { _credentialConfigFile = b} + +credentialConfigEnvironment ∷ Lens' CredentialConfig Bool +credentialConfigEnvironment = lens _credentialConfigEnvironment $ \a b → a { _credentialConfigEnvironment = b} + +credentialConfigInstanceMetadata ∷ Lens' CredentialConfig Bool +credentialConfigInstanceMetadata = lens _credentialConfigInstanceMetadata $ \a b → a { _credentialConfigInstanceMetadata = b} + +defaultCredentialConfig ∷ CredentialConfig +defaultCredentialConfig = CredentialConfig + { _credentialConfigKey = Nothing + , _credentialConfigFile = Nothing + , _credentialConfigEnvironment = False + , _credentialConfigInstanceMetadata = False + } + +validateCredentialConfig ∷ ConfigValidation CredentialConfig λ +validateCredentialConfig CredentialConfig{..} = do + void $ for _credentialConfigKey validateCredentialConfigKey + void $ for _credentialConfigFile validateCredentialConfigFile + unless (or enabledList) $ + throwError "at least one credentials configuration option must be configured" + + where + enabledList = + [ isJust _credentialConfigKey + , isJust _credentialConfigFile + , _credentialConfigEnvironment + , _credentialConfigInstanceMetadata + ] + +instance ToJSON CredentialConfig where + toJSON CredentialConfig{..} = object + [ "key" .= _credentialConfigKey + , "file" .= _credentialConfigFile + , "environment" .= _credentialConfigEnvironment + , "metadata" .= _credentialConfigInstanceMetadata + ] + +instance FromJSON (CredentialConfig → CredentialConfig) where + parseJSON = + withObject "CredentialConfig" $ \o → id + <$< credentialConfigKey ..: "key" % o + <*< credentialConfigFile ..: "file" % o + <*< credentialConfigEnvironment ..: "environment" % o + <*< credentialConfigInstanceMetadata ..: "metadata" % o + +-- | A command-line argument parser for 'CredentialConfig'. The @prefix@ +-- argument will be prepended directly onto the argument names. +-- +pCredentialConfig + ∷ String -- ^ prefix + → MParser CredentialConfig +pCredentialConfig prefix = id + <$< credentialConfigKey .:: fmap Just % pCredentialConfigKey + <*< credentialConfigFile .:: fmap Just % pCredentialConfigFile + <*< credentialConfigEnvironment .:: boolOption + % long (prefix ⊕ "credentials-from-environment") + ⊕ help "load AWS access credentials from environment variables (AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET)" + <*< credentialConfigInstanceMetadata .:: boolOption + % long (prefix ⊕ "credentials-from-metadata") + ⊕ help "load AWS access credentials from the instance metadata" + + where + pKeyId = + B8.pack <$> strOption + % long (prefix ⊕ "credentials-key-id") + ⊕ metavar "AWS_ACCESS_KEY_ID" + ⊕ help "Id of the AWS access key" + + pKeySecret = + B8.pack <$> strOption + % long (prefix ⊕ "credentials-key-secret") + ⊕ metavar "AWS_ACCESS_KEY_SECRET" + ⊕ help "Secret of the AWS access key" + + pCredentialConfigKey = + CredentialConfigKey <$> pKeyId <*> pKeySecret + + pKeyName = + T.pack <$> strOption + % long (prefix ⊕ "credentials-key-name") + ⊕ metavar "STRING" + ⊕ help "the name of the access key in the access key file" + ⊕ value (T.unpack credentialsDefaultKey) + + pFileName = + fileOption + % long (prefix ⊕ "credentials-key-file") + ⊕ help "the name of the file with access keys for the AWS API" + + pCredentialConfigFile = + CredentialConfigFile <$> pFileName <*> pKeyName + +-- | This is 'pCredentialConfig' with an empty prefix. +-- +pCredentialConfig_ ∷ MParser CredentialConfig +pCredentialConfig_ = pCredentialConfig "" + +data LoadCredentialsException + = LoadCredentialsFromFileFailed CredentialConfigFile + | LoadCredentialsFromEnvironementFailed + | LoadCredentialsFromInstanceMetadataFailed + | NoCredentialLoadingMethodSpecified + deriving (Eq, Show, Typeable) + +instance Exception LoadCredentialsException + +-- | Load Credentials according to the credential configuration +-- +-- Credentials are loaded with a precedence according to the order of +-- the record fields of 'CredentialConfig': +-- +-- 1. '_credentialConfigKey', loads the explicitely specified credentials, +-- +-- 2. '_credentialConfigFile', loads credentials with the given key name +-- from the given file, +-- +-- 3. '_credentialConfigEnvironment', loads credentials from the +-- environment varialbes @AWS_ACCESS_KEY_ID@ and @AWS_ACCESS_KEY_SECRET@), and +-- +-- 3. '_credentialConfigInstanceMetadata', load the credentials from the +-- EC2 instance metadata. +-- +-- It is an error if a particular method is specified in the configuration but +-- loading the credentials with that methods fails. +-- +credentialsFromConfig + ∷ (MonadError LoadCredentialsException m, MonadIO m) + ⇒ CredentialConfig + → m Credentials +credentialsFromConfig CredentialConfig{..} + | Just CredentialConfigKey{..} ← _credentialConfigKey = + liftIO $ makeCredentials _credentialConfigKeyId _credentialConfigKeySecret + + | Just ccf@(CredentialConfigFile file awsKeyName) ← _credentialConfigFile = + liftIO (loadCredentialsFromFile file awsKeyName) ≫= \case + Nothing → throwError $ LoadCredentialsFromFileFailed ccf + Just c → return c + + | _credentialConfigEnvironment = + liftIO loadCredentialsFromEnv ≫= \case + Nothing → throwError LoadCredentialsFromEnvironementFailed + Just c → return c + + | _credentialConfigInstanceMetadata = + liftIO loadCredentialsFromInstanceMetadata ≫= \case + Nothing → throwError LoadCredentialsFromInstanceMetadataFailed + Just c → return c + + | otherwise = throwError NoCredentialLoadingMethodSpecified +