git-annex/Remote/Helper/AWS.hs
Joey Hess fed5e00a18
fix default region reversion
Commit 215640096f caused the default
region for S3 to change to us-east-2. This was due to regionInfo having
an undocumented property that the first item in the list is for the
default region.

Avoid relying on regionInfo for defaultRegion.

Sponsored-by: Dartmouth College's DANDI project
2025-08-13 14:19:36 -04:00

107 lines
3.8 KiB
Haskell

{- Amazon Web Services common infrastructure.
-
- Copyright 2011-2025 Joey Hess <id@joeyh.name>
-
- Licensed under the GNU AGPL version 3 or higher.
-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TupleSections #-}
module Remote.Helper.AWS where
import Annex.Common
import Creds
import Types.ProposedAccepted
import Types.RemoteConfig
import qualified Data.Map as M
import qualified Data.ByteString as B
import qualified Data.Text as T
import Data.Text.Encoding (encodeUtf8)
import Data.Text (Text)
creds :: UUID -> CredPairStorage
creds u = CredPairStorage
{ credPairFile = literalOsPath (fromUUID u)
, credPairEnvironment = ("AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY")
, credPairRemoteField = s3credsField
}
s3credsField :: RemoteConfigField
s3credsField = Accepted "s3creds"
data Service = S3 | Glacier
deriving (Eq)
type Region = Text
regionMap :: Service -> M.Map Text Region
regionMap = M.fromList . regionInfo
defaultRegion :: Service -> Region
defaultRegion S3 = "US"
defaultRegion Glacier = "us-east-1"
data ServiceRegion = BothRegion Region | S3Region Region | GlacierRegion Region
{- The "US" and "EU" names are used as location constraints when creating a
- S3 bucket. -}
regionInfo :: Service -> [(Text, Region)]
regionInfo service = map (\(t, r) -> (t, fromServiceRegion r)) $
filter (matchingService . snd) $
concatMap (\(t, l) -> map (t,) l) regions
where
regions =
-- Based on the list at https://docs.aws.amazon.com/general/latest/gr/s3.html
[ ("US East (Ohio)", [S3Region "us-east-2"])
, ("US East (N. Virginia)", [S3Region "US", GlacierRegion "us-east-1"])
, ("US West (N. California)", [BothRegion "us-west-1"])
, ("US West (Oregon)", [BothRegion "us-west-2"])
, ("Africa (Cape Town)", [S3Region "af-south-1"])
, ("Asia Pacific (Hong Kong)", [S3Region "ap-east-1"])
, ("Asia Pacific (Hyderabad)", [S3Region "ap-south-2"])
, ("Asia Pacific (Jakarta)", [S3Region "ap-southeast-3"])
, ("Asia Pacific (Malaysia)", [S3Region "ap-southeast-5"])
, ("Asia Pacific (Melbourne)", [S3Region "ap-southeast-4"])
, ("Asia Pacific (Mumbai)", [S3Region "ap-south-1"])
, ("Asia Pacific (Osaka)", [S3Region "ap-northeast-3"])
, ("Asia Pacific (Seoul)", [S3Region "ap-northeast-2"])
, ("Asia Pacific (Singapore)", [S3Region "ap-southeast-1"])
, ("Asia Pacific (Sydney)", [S3Region "ap-southeast-2"])
, ("Asia Pacific (Taipei)", [S3Region "ap-east-2"])
, ("Asia Pacific (Thailand)", [S3Region "ap-southeast-7"])
, ("Asia Pacific (Tokyo)", [BothRegion "ap-northeast-1"])
, ("Canada (Central)", [S3Region "ca-central-1"])
, ("Canada West (Calgary)", [S3Region "ca-west-1"])
, ("EU (Frankfurt)", [BothRegion "eu-central-1"])
, ("EU (Ireland)", [S3Region "EU", GlacierRegion "eu-west-1"])
, ("Europe (London)", [S3Region "eu-west-2"])
, ("Europe (Milan)", [S3Region "eu-south-1"])
, ("Europe (Paris)", [S3Region "eu-west-3"])
, ("Europe (Spain)", [S3Region "eu-south-2"])
, ("Europe (Stockholm)", [S3Region "eu-north-1"])
, ("Europe (Zurich)", [S3Region "eu-central-2"])
, ("Israel (Tel Aviv)", [S3Region "il-central-1"])
, ("Mexico (Central)", [S3Region "mx-central-1"])
, ("Middle East (Bahrain)", [S3Region "me-south-1"])
, ("Middle East (UAE)", [S3Region "me-central-1"])
, ("South America (São Paulo)", [S3Region "sa-east-1"])
]
fromServiceRegion (BothRegion s) = s
fromServiceRegion (S3Region s) = s
fromServiceRegion (GlacierRegion s) = s
matchingService (BothRegion _) = True
matchingService (S3Region _) = service == S3
matchingService (GlacierRegion _) = service == Glacier
s3HostName :: Region -> B.ByteString
s3HostName "US" = "s3.amazonaws.com"
s3HostName "EU" = "s3-eu-west-1.amazonaws.com"
s3HostName "cn-north-1" = "s3.cn-north-1.amazonaws.com.cn"
s3HostName r = encodeUtf8 $ T.concat ["s3-", r, ".amazonaws.com"]
s3DefaultHost :: String
s3DefaultHost = "s3.amazonaws.com"