diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for amazonka-contrib-rds-utils + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# amazonka-contrib-rds-utils + +This library provides a Haskell equivalent of `aws rds generate-db-auth-token` +[CLI utility](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/generate-db-auth-token.html) +built on top of [`amazonka`](https://hackage.haskell.org/package/amazonka) library. + + +## Developer notes + +The following commands assume they are run from the provided Nix shell + +### Building the project + +``` +make build +``` diff --git a/amazonka-contrib-rds-utils.cabal b/amazonka-contrib-rds-utils.cabal new file mode 100644 --- /dev/null +++ b/amazonka-contrib-rds-utils.cabal @@ -0,0 +1,97 @@ +cabal-version: 3.0 +name: amazonka-contrib-rds-utils +version: 1.6.1.0 + +-- A short (one-line) description of the package. +-- synopsis: + +-- A longer description of the package. +-- description: + +-- A URL where users can report bugs. +-- bug-reports: +license: MPL-2.0 +license-file: LICENSE +author: Maxim Avanov +maintainer: maxim.avanov@gmail.com +synopsis: A Haskell equivalent of "aws rds generate-db-auth-token" +description: A Haskell equivalent of "aws rds generate-db-auth-token" CLI utility built on top of "amazonka" library. +homepage: https://github.com/avanov/amazonka-contrib-rds-utils +bug-reports: https://github.com/avanov/amazonka-contrib-rds-utils/issues +copyright: Copyright (c) 2021 Maxim Avanov +category: AWS + +extra-source-files: CHANGELOG.md + README.md + +library + exposed-modules: Network.AWS.RDS.Utils + + -- Modules included in this library but not exported. + -- other-modules: + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + build-depends: base >= 4.14.1.0 + , amazonka >= 1.6.1 + , amazonka-core + , amazonka-rds + , bytestring >= 0.9 + , lens >= 4.4 + , text >= 1.1 + , time >= 1.11 + + hs-source-dirs: src + + default-language: Haskell2010 + + default-extensions: OverloadedStrings + LambdaCase + QuasiQuotes + + ghc-options: -Wall + -Wcompat + -Wincomplete-record-updates + -Wincomplete-uni-patterns + -Wredundant-constraints + -fPIC + -static + -optl=-pthread + + cc-options: -static + + +executable generate-db-auth-token + hs-source-dirs: exe + main-is: Main.hs + + autogen-modules: Paths_amazonka_contrib_rds_utils + other-modules: Paths_amazonka_contrib_rds_utils + default-extensions: OverloadedStrings + LambdaCase + QuasiQuotes + + ghc-options: -Wall + -Wcompat + -Wincomplete-record-updates + -Wincomplete-uni-patterns + -Wredundant-constraints + -fPIC + -static + -optl=-pthread + -threaded + -rtsopts "-with-rtsopts=-N -I3 -M1.75G" + -feager-blackholing + + cc-options: -static + build-depends: + base >=4.12 && <5 + , bytestring + , amazonka + , amazonka-contrib-rds-utils + , lens + , optparse-applicative >= 0.16.1 + , text + if os(linux) + else + default-language: Haskell2010 diff --git a/exe/Main.hs b/exe/Main.hs new file mode 100644 --- /dev/null +++ b/exe/Main.hs @@ -0,0 +1,87 @@ +module Main where + +import Control.Lens ( (&) + , (.~) + ) +import Data.Text +import Data.ByteString ( hPut ) +import qualified Network.AWS.Auth as AWSAuth +import qualified Network.AWS.Env as AWSEnv +import System.Exit ( die ) +import System.IO ( stdout ) + +import Network.AWS ( LogLevel (Info) + , newLogger + ) +import qualified Network.AWS.RDS.Utils as RDSU + +import Options.Applicative + + +awsRegionEnvName :: Text +awsRegionEnvName = "AWS_REGION" + +-- | Works similarly to / aws rds generate-db-auth-token --hostname --port --username --region / +main :: IO () +main = run =<< execParser opts + where + opts = + info (awsCreds <**> helper) + ( fullDesc + <> progDesc "Generate a temporary access token for RDS" + <> header "generate-db-auth-token is a Haskell equivalent of 'aws rds generate-db-auth-token' CLI utility" + ) + +run :: AWSCreds -> IO () +run creds = do + lgr <- newLogger Info stdout + env <- AWSEnv.newEnv $ AWSAuth.FromEnv + AWSAuth.envAccessKey + AWSAuth.envSecretKey + (Just AWSAuth.envSessionToken) + (Just awsRegionEnvName) + + case (RDSU.regionFromText . pack . region $ creds) of + Left err -> die $ "Error: " <> err + Right reg -> do + token <- RDSU.generateDbAuthToken + ((env & AWSEnv.envLogger .~ lgr) & AWSEnv.envRegion .~ reg) + (hostname creds) + (port creds) + (username creds) + reg + hPut stdout token + + + +data AWSCreds = AWSCreds + { hostname :: RDSU.Endpoint + , port :: RDSU.Port + , username :: RDSU.DBUsername + , region :: String + } + +awsCreds :: Parser AWSCreds +awsCreds = AWSCreds + <$> strOption + ( long "hostname" + <> metavar "RDS_ENDPOINT" + <> help "RDS Endpoint could be found on AWS RDS web console" + ) + <*> option auto + ( long "port" + <> help "RDS Database Port" + <> showDefault + <> value 5432 + <> metavar "RDS_PORT" + ) + <*> strOption + ( long "username" + <> help "RDS Username" + <> metavar "RDS_USERNAME" + ) + <*> strOption + ( long "region" + <> help "AWS Region" + <> metavar "AWS_REGION" + ) diff --git a/src/Network/AWS/RDS/Utils.hs b/src/Network/AWS/RDS/Utils.hs new file mode 100644 --- /dev/null +++ b/src/Network/AWS/RDS/Utils.hs @@ -0,0 +1,134 @@ +{-# LANGUAGE TypeFamilies #-} -- required for 'Rs' +{-# LANGUAGE FlexibleInstances #-} -- required for ToQuery String +{-# OPTIONS_GHC -fno-warn-orphans #-} +module Network.AWS.RDS.Utils + ( generateDbAuthToken + , Endpoint + , Port + , DBUsername + , Region + , regionFromText + ) +where + +import Prelude hiding ( drop, length ) +import Control.Lens ( (^.) ) +import Control.Monad.Trans.AWS ( runResourceT, runAWST ) +import Data.ByteString ( ByteString, drop, length ) +import Data.ByteString.Char8 ( pack ) +import qualified Data.Text as T +import qualified Data.Time.Clock as Clock +import Network.AWS ( _svcPrefix + , within + ) +import qualified Network.AWS.RDS as RDS +import Network.AWS.Endpoint ( setEndpoint ) +import qualified Network.AWS.Env as Env +import qualified Network.AWS.Request as AWSReq +import qualified Network.AWS.Response as AWSResp +import Network.AWS.Data.Text ( fromText ) +import Network.AWS.Data.Path ( ToPath (..) + ) +import Network.AWS.Data.Query ( ToQuery (..) + , QueryString ( QList ) + ) +import Network.AWS.Data.Headers ( ToHeaders (..) + ) +import Network.AWS.Presign as Presign +import Network.AWS.Types ( Seconds (..) + , AWSRequest (..) + , Rs + , Service + , Region + ) + +type Endpoint = String +type Port = Int +type DBUsername = String +type Token = ByteString + +tokenExpiration :: Seconds +tokenExpiration = Seconds 900 -- 15 minutes + +serviceSigningName :: ByteString +serviceSigningName = "rds-db" + +thisService :: Service +thisService = RDS.rds { _svcPrefix = serviceSigningName } + +dropPrefix :: ByteString -> ByteString +dropPrefix = drop $ length "https://" + +-- Amazon docs: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html +-- Python implementation: https://github.com/boto/botocore/blob/77527250093fc97cbf078adab04bdd74b1fd3c03/botocore/signers.py#L409 +-- Go implementation: https://github.com/aws/aws-sdk-go/blob/e2d6cb448883e4f4fcc5246650f89bde349041ec/service/rds/rdsutils/connect.go#L36-L67 +-- | Generates RDS auth token that can be used as a temporary password for Postgres connections. +generateDbAuthToken :: Env.Env + -> Endpoint + -> Port + -> DBUsername + -> Region + -> IO Token +generateDbAuthToken env endp prt username region = do + -- it has some overhead, but we're just making sure we're composing a correct URL + let action = GetDBAuthToken $ PresignParams + { endpoint = endp + , port = prt + , dbUsername = username + } + + signingTime <- Clock.getCurrentTime + + runResourceT . runAWST env $ + within region $ do + val <- Presign.presignURL + (env ^. Env.envAuth) + (env ^. Env.envRegion) + signingTime + tokenExpiration + action + pure $ dropPrefix val + + +data PresignParams = PresignParams + { endpoint :: Endpoint + , port :: Port + , dbUsername :: DBUsername + } + + +newtype GetDBAuthTokenResponse = GetDBAuthTokenResponse ByteString + +newtype GetDBAuthToken = GetDBAuthToken PresignParams + +instance AWSRequest GetDBAuthToken where + type Rs GetDBAuthToken = GetDBAuthTokenResponse + + request (GetDBAuthToken params) = + AWSReq.defaultRequest svc (GetDBAuthToken params) where + svc = setEndpoint useHTTPS (pack . endpoint $ params) (port params) thisService + useHTTPS = True + + response = AWSResp.receiveBytes $ \_s _h x -> pure $ GetDBAuthTokenResponse x + + +instance ToPath GetDBAuthToken where + toPath _ = "" + + +instance ToQuery String where + toQuery = toQuery . pack + + +instance ToQuery GetDBAuthToken where + toQuery (GetDBAuthToken params) = QList (toQuery <$> xs) where + xs :: [(String, String)] + xs = [("Action", "connect"), ("DBUser", dbUsername params)] + + +instance ToHeaders GetDBAuthToken where + toHeaders _ = [] + + +regionFromText :: T.Text -> Either String Region +regionFromText = fromText