S3-Client.psm1
$AWS_PROFILE_PATH = "$HOME/.aws/" $AWS_CREDENTIALS_FILE = $AWS_PROFILE_PATH + "credentials" # workarounds for PowerShell issues if ($PSVersionTable.PSVersion.Major -lt 6) { Add-Type @" using System.Net; using System.Security.Cryptography.X509Certificates; public class TrustAllCertsPolicy : ICertificatePolicy { public bool CheckValidationResult( ServicePoint srvPoint, X509Certificate certificate, WebRequest request, int certificateProblem) { return true; } } "@ # Using .NET JSON Serializer as JSON serialization included in Invoke-WebRequest has a length restriction for JSON content Add-Type -AssemblyName System.Web.Extensions $global:javaScriptSerializer = New-Object System.Web.Script.Serialization.JavaScriptSerializer $global:javaScriptSerializer.MaxJsonLength = [System.Int32]::MaxValue $global:javaScriptSerializer.RecursionLimit = 99 } else { # unfortunately AWS Authentication is not RFC-7232 compliant (it is using semicolons in the value) # and PowerShell 6 enforces strict header verification by default # therefore disabling strict header verification until AWS fixed this $PSDefaultParameterValues.Add("Invoke-WebRequest:SkipHeaderValidation",$true) } ### Helper Functions ### function ConvertTo-SortedDictionary($HashTable) { #private $SortedDictionary = New-Object 'System.Collections.Generic.SortedDictionary[string, string]' foreach ($Key in $HashTable.Keys) { $SortedDictionary[$Key]=$HashTable[$Key] } Write-Output $SortedDictionary } function Get-SignedString { #private [CmdletBinding()] PARAM ( [parameter(Mandatory=$True, Position=0, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Key in Bytes.")][Byte[]]$Key, [parameter(Mandatory=$False, Position=1, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Unit of timestamp.")][String]$Message="", [parameter(Mandatory=$False, Position=2, HelpMessage="Algorithm to use for signing.")][ValidateSet("SHA1","SHA256")][String]$Algorithm="SHA256" ) PROCESS { if ($Algorithm -eq "SHA1") { $Signer = New-Object System.Security.Cryptography.HMACSHA1 } else { $Signer = New-Object System.Security.Cryptography.HMACSHA256 } $Signer.Key = $Key $Signer.ComputeHash([Text.Encoding]::UTF8.GetBytes($Message)) } } function Sign($Key,$Message) { #private $hmacsha = New-Object System.Security.Cryptography.HMACSHA256 $hmacsha.Key = $Key $hmacsha.ComputeHash([Text.Encoding]::UTF8.GetBytes($Message)) } function GetSignatureKey($Key, $Date, $Region, $Service) { #private $SignedDate = sign ([Text.Encoding]::UTF8.GetBytes(('AWS4' + $Key).toCharArray())) $Date $SignedRegion = sign $SignedDate $Region $SignedService = sign $SignedRegion $Service sign $SignedService "aws4_request" } function ConvertFrom-AwsConfigFile { #private [CmdletBinding()] PARAM ( [parameter( Mandatory=$True, Position=0, HelpMessage="AWS Config File")][String]$AwsConfigFile ) Process { if (!(Test-Path $AwsConfigFile)) { throw "Config file $AwsConfigFile does not exist!" } Write-Verbose "Reading AWS Configuration from $AwsConfigFile" $Content = Get-Content -Path $AwsConfigFile -Raw # convert to JSON structure # replace all carriage returns $Content = $Content -replace "\r","" # remove empty lines $Content = $Content -replace "(\n$)*", "" # remove profile string from profile section $Content = $Content -replace "profile ", "" # replace sections like s3 or iam where the line ends with a = with a JSON object including opening and closing curly brackets $Content = $Content -replace "([a-zA-Z0-9]+)\s*=\s*((?:\n .+)+)",'"$1":{ $2 },' $Content = $Content -replace "([a-zA-Z0-9]+)\s*=\s*\n","`"`$1`":{ },`n" $Content = $Content -replace "([a-zA-Z0-9]+)\s*=\s*\z",'"$1":{ },' # replace key value pairs with quoted key value pairs and replace = with : $Content = $Content -replace "\n\s*([^=^\s^`"]+)\s*=\s*([^\s^\n^}]*)","`n`"`$1`":`"`$2`"," # make sure that Profile is a Key Value inside the JSON Object $Content = $Content -replace "\[([^\]]+)\]([^\[]+)","{`"ProfileName`":`"`$1`",`$2},`n" # remove additional , before a closing curly bracket $Content = $Content -replace "\s*,\s*\n?}","}" # ensure that the complete output is an array consisting of multiple JSON objects $Content = $Content -replace "\A","[" $Content = $Content -replace "},?\s*\n?\s*\z","}]" $Config = ConvertFrom-Json -InputObject $Content Write-Output $Config } } function ConvertTo-AwsConfigFile { #private [CmdletBinding()] PARAM ( [parameter( Mandatory=$True, Position=0, HelpMessage="Configs to store in config file")][PSCustomObject]$Configs, [parameter( Mandatory=$True, Position=1, HelpMessage="AWS Config File")][String]$AwsConfigFile ) Process { if (!(Test-Path $AwsConfigFile)) { New-Item -Path $AwsConfigFile -ItemType File -Force } Write-Verbose "Writing AWS Configuration to $AwsConfigFile" if ($AwsConfigFile -match "credentials$") { foreach ($Config in $Configs) { $Output += "[$( $Config.ProfileName )]`n" $Output += "aws_access_key_id = $($Config.aws_access_key_id)`n" $Output += "aws_secret_access_key = $($Config.aws_secret_access_key)`n" } } else { foreach ($Config in $Configs) { if ($Config.ProfileName -eq "default") { $Output += "[$( $Config.ProfileName )]`n" } else { $Output += "[profile $( $Config.ProfileName )]`n" } $Properties = $Config.PSObject.Members | Where-Object { $_.MemberType -eq "NoteProperty" -and $_.Name -ne "ProfileName" -and $_.Value -isnot [PSCustomObject] } $Sections = $Config.PSObject.Members | Where-Object { $_.MemberType -eq "NoteProperty" -and $_.Name -ne "ProfileName" -and $_.Value -is [PSCustomObject]} foreach ($Property in $Properties) { $Output += "$($Property.Name) = $($Property.Value)`n" } foreach ($Section in $Sections) { $Output += "$($Section.Name) =`n" $Properties = $Section.Value.PSObject.Members | Where-Object { $_.MemberType -eq "NoteProperty" } foreach ($Property in $Properties) { $Output += " $($Property.Name) = $($Property.Value)`n" } } } } Write-Debug "Output:`n$Output" $Output | Out-File -FilePath $AwsConfigFile -NoNewline } } # helper function to convert datetime to unix timestamp function ConvertTo-UnixTimestamp { #private [CmdletBinding()] #private PARAM ( [parameter(Mandatory=$True, Position=0, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Date to be converted.")][DateTime[]]$Date, [parameter(Mandatory=$True, Position=1, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Unit of timestamp.")][ValidateSet("Seconds","Milliseconds")][String]$Unit="Milliseconds" ) BEGIN { $epoch = Get-Date -Year 1970 -Month 1 -Day 1 -Hour 0 -Minute 0 -Second 0 } PROCESS { if ($Unit="Seconds") { Write-Output ([math]::truncate($Date.ToUniversalTime().Subtract($epoch).TotalSeconds)) } else { Write-Output ([math]::truncate($Date.ToUniversalTime().Subtract($epoch).TotalMilliSeconds)) } } } # helper function to convert unix timestamp to datetime function ConvertFrom-UnixTimestamp { #private [CmdletBinding()] PARAM ( [parameter(Mandatory=$True, Position=0, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Timestamp to be converted.")][String]$Timestamp, [parameter(Mandatory=$True, Position=0, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Unit of timestamp.")][ValidateSet("Seconds","Milliseconds")][String]$Unit="Milliseconds", [parameter(Mandatory=$False, Position=1, HelpMessage="Optional Timezone to be used as basis for Timestamp. Default is system Timezone.")][System.TimeZoneInfo]$Timezone=[System.TimeZoneInfo]::Local ) PROCESS { $Timestamp = @($Timestamp) foreach ($Timestamp in $Timestamp) { if ($Unit -eq "Seconds") { $Date = [System.TimeZoneInfo]::ConvertTimeFromUtc(([datetime]'1/1/1970').AddSeconds($Timestamp),$Timezone) } else { $Date = [System.TimeZoneInfo]::ConvertTimeFromUtc(([datetime]'1/1/1970').AddMilliseconds($Timestamp),$Timezone) } Write-Output $Date } } } ### AWS Cmdlets ### <# .SYNOPSIS Retrieve SHA256 Hash for Payload .DESCRIPTION Retrieve SHA256 Hash for Payload #> function Global:Get-AwsHash { #private [CmdletBinding(DefaultParameterSetName="string")] PARAM ( [parameter( Mandatory=$False, Position=0, ParameterSetName="string", HelpMessage="String to hash")][String]$StringToHash="", [parameter( Mandatory=$True, Position=1, ParameterSetName="file", HelpMessage="File to hash")][System.IO.FileInfo]$FileToHash ) Process { $Hasher = [System.Security.Cryptography.SHA256]::Create() if ($FileToHash) { $Hash = Get-FileHash -Algorithm SHA256 -Path $FileToHash | Select-Object -ExpandProperty Hash } else { $Hash = ([BitConverter]::ToString($Hasher.ComputeHash([Text.Encoding]::UTF8.GetBytes($StringToHash))) -replace '-','').ToLower() } Write-Output $Hash } } <# .SYNOPSIS Create AWS Authentication Signature Version 2 for Request .DESCRIPTION Create AWS Authentication Signature Version 2 for Request #> function Global:New-AwsSignatureV2 { #private [CmdletBinding()] PARAM ( [parameter( Mandatory=$True, Position=0, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( Mandatory=$True, Position=1, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( Mandatory=$True, Position=2, HelpMessage="Endpoint hostname and optional port")][System.UriBuilder]$EndpointUrl, [parameter( Mandatory=$False, Position=3, HelpMessage="HTTP Request Method")][ValidateSet("OPTIONS","GET","HEAD","PUT","POST","DELETE","TRACE","CONNECT")][String]$Method="GET", [parameter( Mandatory=$False, Position=4, HelpMessage="URI")][String]$Uri="/", [parameter( Mandatory=$False, Position=6, HelpMessage="Content MD5")][String]$ContentMD5="", [parameter( Mandatory=$False, Position=7, HelpMessage="Content Type")][String]$ContentType="", [parameter( Mandatory=$False, Position=8, HelpMessage="Date")][String]$DateTime, [parameter( Mandatory=$False, Position=9, HelpMessage="Headers")][Hashtable]$Headers=@{}, [parameter( Mandatory=$False, Position=10, HelpMessage="Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=11, HelpMessage="Query String (unencoded)")][String]$QueryString ) Process { # this Cmdlet follows the steps outlined in https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html # initialization if (!$DateTime) { $DateTime = [DateTime]::UtcNow.ToString("yyyyMMddTHHmmssZ") } Write-Debug "Task 1: Constructing the CanonicalizedResource Element " $CanonicalizedResource = "" Write-Debug "1. Start with an empty string:`n$CanonicalizedResource" if ($BucketName -and $EndpointUrl.Host -match "^$BucketName") { $CanonicalizedResource += "/$BucketName" Write-Debug "2. Add the bucketname for virtual host style:`n$CanonicalizedResource" } else { Write-Debug "2. Bucketname already part of Url for path style therefore skipping this step" } # TODO: Think of a better way to get the properly encoded relative URI $CanonicalURI = ([System.UriBuilder]"$EndpointUrl$($Uri -replace '^/','')").Uri.PathAndQuery $CanonicalizedResource += $CanonicalURI Write-Debug "3. Append the path part of the un-decoded HTTP Request-URI, up-to but not including the query string:`n$CanonicalizedResource" if ($QueryString) { $CanonicalizedResource += "?$QueryString" } Write-Debug "4. Append the query string unencoded for signing:`n$CanonicalizedResource" Write-Debug "Task 2: Constructing the CanonicalizedAmzHeaders Element" Write-Debug "1. Filter for all headers starting with x-amz and are not x-amz-date" $AmzHeaders = $Headers.Clone() # remove all headers which do not start with x-amz $Headers.Keys | ForEach-Object { if ($_ -notmatch "x-amz" -or $_ -eq "x-amz-date") { $AmzHeaders.Remove($_) } } Write-Debug "2. Sort headers lexicographically" $SortedAmzHeaders = ConvertTo-SortedDictionary $AmzHeaders $CanonicalizedAmzHeaders = ($SortedAmzHeaders.GetEnumerator() | ForEach-Object { "$($_.Key.toLower()):$($_.Value)" }) -join "`n" if ($CanonicalizedAmzHeaders) { $CanonicalizedAmzHeaders = $CanonicalizedAmzHeaders + "`n" } Write-Debug "3. CanonicalizedAmzHeaders headers:`n$CanonicalizedAmzHeaders" Write-Debug "Task 3: String to sign" $StringToSign = "$Method`n$ContentMD5`n$ContentType`n$DateTime`n$CanonicalizedAmzHeaders$CanonicalizedResource" Write-Debug "1. StringToSign:`n$StringToSign" Write-Debug "Task 4: Signature" $SignedString = Get-SignedString -Key ([Text.Encoding]::UTF8.GetBytes($SecretKey)) -Message $StringToSign -Algorithm SHA1 $Signature = [Convert]::ToBase64String($SignedString) Write-Debug "1. Signature:`n$Signature" Write-Output $Signature } } <# .SYNOPSIS Create AWS Authentication Signature Version 4 for Request .DESCRIPTION Create AWS Authentication Signature Version 4 for Request #> function Global:New-AwsSignatureV4 { #private [CmdletBinding()] PARAM ( [parameter( Mandatory=$True, Position=0, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( Mandatory=$True, Position=1, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( Mandatory=$True, Position=2, HelpMessage="Endpoint hostname and optional port")][System.UriBuilder]$EndpointUrl, [parameter( Mandatory=$False, Position=3, HelpMessage="HTTP Request Method")][ValidateSet("OPTIONS","GET","HEAD","PUT","POST","DELETE","TRACE","CONNECT")][String]$Method="GET", [parameter( Mandatory=$False, Position=4, HelpMessage="URI")][String]$Uri="/", [parameter( Mandatory=$False, Position=5, HelpMessage="Canonical Query String")][String]$CanonicalQueryString, [parameter( Mandatory=$False, Position=6, HelpMessage="Date Time (yyyyMMddTHHmmssZ)")][String]$DateTime, [parameter( Mandatory=$False, Position=7, HelpMessage="Date String (yyyyMMdd)")][String]$DateString, [parameter( Mandatory=$False, Position=8, HelpMessage="Request payload hash")][String]$RequestPayloadHash, [parameter( Mandatory=$False, Position=9, HelpMessage="Region")][String]$Region="us-east-1", [parameter( Mandatory=$False, Position=10, HelpMessage="Region")][String]$Service="s3", [parameter( Mandatory=$False, Position=11, HelpMessage="Headers")][Hashtable]$Headers=@{}, [parameter( Mandatory=$False, Position=12, HelpMessage="Content type")][String]$ContentType ) Process { # this Cmdlet follows the steps outlined in http://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html # initialization if (!$RequestPayloadHash) { $RequestPayloadHash = Get-AwsHash -StringToHash "" } if (!$DateTime) { $DateTime = [DateTime]::UtcNow.ToString("yyyyMMddTHHmmssZ") } if (!$DateString) { $DateString = [DateTime]::UtcNow.ToString('yyyyMMdd') } Write-Debug "Task 1: Create a Canonical Request for Signature Version 4" # http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html Write-Debug "1. HTTP Request Method:`n$Method" # TODO: Think of a better way to get the properly encoded relative URI $CanonicalURI = ([System.UriBuilder]"$EndpointUrl$($Uri -replace '^/','')").Uri.PathAndQuery Write-Debug "2. Canonical URI:`n$CanonicalURI" Write-Debug "3. Canonical query string:`n$CanonicalQueryString" $SortedHeaders = ConvertTo-SortedDictionary $Headers $CanonicalHeaders = (($SortedHeaders.GetEnumerator() | ForEach-Object { "$($_.Key.toLower()):$($_.Value)" }) -join "`n") + "`n" Write-Debug "4. Canonical headers:`n$CanonicalHeaders" $SignedHeaders = $SortedHeaders.Keys.toLower() -join ";" Write-Debug "5. Signed headers:`n$SignedHeaders" Write-Debug "6. Hashed Payload`n$RequestPayloadHash" $CanonicalRequest = "$Method`n$CanonicalURI`n$CanonicalQueryString`n$CanonicalHeaders`n$SignedHeaders`n$RequestPayloadHash" Write-Debug "7. CanonicalRequest:`n$CanonicalRequest" $hasher = [System.Security.Cryptography.SHA256]::Create() $CanonicalRequestHash = ([BitConverter]::ToString($hasher.ComputeHash([Text.Encoding]::UTF8.GetBytes($CanonicalRequest))) -replace '-','').ToLower() Write-Debug "8. Canonical request hash:`n$CanonicalRequestHash" Write-Debug "Task 2: Create a String to Sign for Signature Version 4" # http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html $AlgorithmDesignation = "AWS4-HMAC-SHA256" Write-Debug "1. Algorithm designation:`n$AlgorithmDesignation" Write-Debug "2. request date value, specified with ISO8601 basic format in the format YYYYMMDD'T'HHMMSS'Z:`n$DateTime" $CredentialScope = "$DateString/$Region/$Service/aws4_request" Write-Debug "3. Credential scope:`n$CredentialScope" Write-Debug "4. Canonical request hash:`n$CanonicalRequestHash" $StringToSign = "$AlgorithmDesignation`n$DateTime`n$CredentialScope`n$CanonicalRequestHash" Write-Debug "StringToSign:`n$StringToSign" Write-Debug "Task 3: Calculate the Signature for AWS Signature Version 4" # http://docs.aws.amazon.com/general/latest/gr/sigv4-calculate-signature.html $SigningKey = GetSignatureKey $SecretKey $DateString $Region $Service Write-Debug "1. Signing Key:`n$([System.BitConverter]::ToString($SigningKey))" $Signature = ([BitConverter]::ToString((sign $SigningKey $StringToSign)) -replace '-','').ToLower() Write-Debug "2. Signature:`n$Signature" Write-Output $Signature } } <# .SYNOPSIS Get AWS URL .DESCRIPTION Get AWS URL .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER Method HTTP Request Method .PARAMETER EndpointUrl Endpoint URL .PARAMETER UrlStyle URL Style .PARAMETER Uri URI (e.g. / or /key) .PARAMETER Query Query .PARAMETER RequestPayload Request payload .PARAMETER Region Region .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Service Service (e.g. S3) .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER Headers Headers .PARAMETER ContentType Content type .PARAMETER BucketName Bucket name .PARAMETER Date Date .PARAMETER InFile File to read data from .PARAMETER Presign Presign URL .PARAMETER Expires Presign URL Expiration Date #> function Global:Get-AwsRequest { [CmdletBinding()] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( Mandatory=$False, Position=1, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( Mandatory=$False, Position=2, HelpMessage="HTTP Request Method")][ValidateSet("OPTIONS","GET","HEAD","PUT","POST","DELETE","TRACE","CONNECT")][String]$Method="GET", [parameter( Mandatory=$False, Position=3, HelpMessage="Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( Mandatory=$False, Position=4, HelpMessage="URL Style")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=5, HelpMessage="URI (e.g. / or /key)")][String]$Uri="/", [parameter( Mandatory=$False, Position=6, HelpMessage="Query")][Hashtable]$Query=@{}, [parameter( Mandatory=$False, Position=7, HelpMessage="Request payload")][String]$RequestPayload="", [parameter( Mandatory=$False, Position=8, HelpMessage="Region")][String]$Region="us-east-1", [parameter( Mandatory=$False, Position=9, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$False, Position=10, HelpMessage="Service (e.g. S3)")][String]$Service="s3", [parameter( Mandatory=$False, Position=11, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=12, HelpMessage="Headers")][Hashtable]$Headers=@{}, [parameter( Mandatory=$False, Position=13, HelpMessage="Content type")][String]$ContentType, [parameter( Mandatory=$False, Position=14, HelpMessage="Bucket name")][String]$BucketName, [parameter( Mandatory=$False, Position=15, HelpMessage="Date")][DateTime]$Date=[DateTime]::Now, [parameter( Mandatory=$False, Position=16, HelpMessage="File to read data from")][System.IO.FileInfo]$InFile, [parameter( Mandatory=$False, Position=17, HelpMessage="Presign URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=18, HelpMessage="Presign URL Expiration Date")][DateTime]$Expires=(Get-Date).AddHours(1) ) Begin { if (!$EndpointUrl) { if ($Region -eq "us-east-1" -or !$Region) { if ($UseDualstackEndpoint) { $EndpointUrl = [System.UriBuilder]::new("https://s3.dualstack.amazonaws.com") } else { $EndpointUrl = [System.UriBuilder]::new("https://s3.amazonaws.com") } } else { if ($UseDualstackEndpoint) { $EndpointUrl = [System.UriBuilder]::new("https://s3.dualstack.$Region.amazonaws.com") } else { $EndpointUrl = [System.UriBuilder]::new("https://s3.$Region.amazonaws.com") } } } else { # as we are modifying the endpoint URL, make sure to work on a new object and not modify the origianl object $EndpointUrl = [System.UriBuilder]::new($EndpointUrl.ToString()) } if ($UrlStyle -match "virtual" -and $BucketName) { Write-Verbose "Using virtual-hosted style URL" $EndpointUrl.host = $BucketName + '.' + $EndpointUrl.host } elseif ($UrlStyle -eq "auto" -and $EndpointUrl -match "amazonaws.com" -and $BucketName) { Write-Verbose "Using virtual-hosted style URL" $EndpointUrl.host = $BucketName + '.' + $EndpointUrl.host } elseif ($BucketName) { Write-Verbose "Using path style URL" $Uri = "/$BucketName" + $Uri } } Process { $DateTime = $Date.ToUniversalTime().ToString("yyyyMMddTHHmmssZ") $DateString = $Date.ToUniversalTime().ToString('yyyyMMdd') if ($InFile) { $RequestPayloadHash=Get-AwsHash -FileToHash $InFile } else { $RequestPayloadHash=Get-AwsHash -StringToHash $RequestPayload } if ($RequestPayload) { $Md5 = ([System.Security.Cryptography.MD5CryptoServiceProvider]::new().ComputeHash([System.Text.UTF8Encoding]::new().GetBytes($RequestPayload)) -replace "-","").ToLower() } else { $Md5 = $null } if (!$Headers["host"]) { $Headers["host"] = $EndpointUrl.Uri.Authority } if (!$Presign.IsPresent) { if ($SignerType -eq "AWS4") { if (!$Headers["x-amz-date"]) { $Headers["x-amz-date"] = $DateTime } } else { if (!$Headers["date"]) { $Headers["date"] = $DateTime } } if (!$Headers["x-amz-content-sha256"] -and $SignerType -eq "AWS4") { $Headers["x-amz-content-sha256"] = $RequestPayloadHash } if (!$Headers["content-type"] -and $ContentType) { $Headers["content-type"] = $ContentType } if (!$Headers["content-md5"] -and $Md5) { $Headers["content-md5"] = [Convert]::ToBase64String($Md5) } } $SortedHeaders = ConvertTo-SortedDictionary $Headers $SignedHeaders = $SortedHeaders.Keys.toLower() -join ";" if ($Presign.IsPresent) { if ($SignerType -eq "AWS4") { $RequestPayloadHash = "UNSIGNED-PAYLOAD" $ExpiresInSeconds = [Math]::Ceiling(($Expires - $Date).TotalSeconds) $CredentialScope = "$DateString/$Region/$Service/aws4_request" $Query["Action"] = $Method $Query["X-Amz-Algorithm"] = "AWS4-HMAC-SHA256" $Query["X-Amz-Credential"] = "$($AccessKey)/$($CredentialScope)" $Query["X-Amz-Date"] = $DateTime $Query["X-Amz-Expires"] = $ExpiresInSeconds $Query["X-Amz-SignedHeaders"] = $SignedHeaders } else { $ExpiresUnixTime = $Expires | ConvertTo-UnixTimestamp -Unit Seconds $Query["Expires"] = $ExpiresUnixTime $Query["AWSAccessKeyId"] = $AccessKey $DateTime = $ExpiresUnixTime } } $QueryString = "" $CanonicalQueryString = "" if ($Query.Keys.Count -ge 1) { # using Sorted Dictionary as query need to be sorted by encoded keys $SortedQuery = New-Object 'System.Collections.Generic.SortedDictionary[string, string]' foreach ($Key in $Query.Keys) { # Key and value need to be URL encoded separately $SortedQuery[$Key]=$Query[$Key] } # AWS V2 only requires specific queries to be included in signing process # and AWS V4 requires these queries to come after all other queries $SpecialQueryStrings = "partNumber|uploadId|versioning|location|acl|torrent|lifecycle|versionid|response-content-type|response-content-language|response-expires|response-cache-control|response-content-disposition|response-content-encoding" foreach ($Key in ($SortedQuery.Keys | Where-Object { $_ -notmatch $SpecialQueryStrings })) { $CanonicalQueryString += "$([System.Net.WebUtility]::UrlEncode($Key))=$([System.Net.WebUtility]::UrlEncode($SortedQuery[$Key]))&" } foreach ($Key in ($SortedQuery.Keys | Where-Object { $_ -match $SpecialQueryStrings })) { if ($SortedQuery[$Key]) { $QueryString += "$Key=$($SortedQuery[$Key])&" } else { $QueryString += "$Key&" } $CanonicalQueryString += "$([System.Net.WebUtility]::UrlEncode($Key))=$([System.Net.WebUtility]::UrlEncode($SortedQuery[$Key]))&" } $QueryString = $QueryString -replace "&`$","" $CanonicalQueryString = $CanonicalQueryString -replace "&`$","" } Write-Debug "Query String with selected Query components for S3 Signer: $QueryString" Write-Debug "Canonical Query String with all Query components for AWS Signer: $CanonicalQueryString" if ($SignerType -eq "AWS4") { Write-Verbose "Using AWS Signature Version 4" $Signature = New-AwsSignatureV4 -AccessKey $AccessKey -SecretKey $SecretKey -EndpointUrl $EndpointUrl -Region $Region -Uri $Uri -CanonicalQueryString $CanonicalQueryString -Method $Method -RequestPayloadHash $RequestPayloadHash -DateTime $DateTime -DateString $DateString -Headers $Headers Write-Debug "Task 4: Add the Signing Information to the Request" # http://docs.aws.amazon.com/general/latest/gr/sigv4-add-signature-to-request.html if (!$Presign.IsPresent) { $Headers["Authorization"]="AWS4-HMAC-SHA256 Credential=$AccessKey/$DateString/$Region/$Service/aws4_request,SignedHeaders=$SignedHeaders,Signature=$Signature" } } else { Write-Verbose "Using AWS Signature Version 2" $Signature = New-AwsSignatureV2 -AccessKey $AccessKey -SecretKey $SecretKey -EndpointUrl $EndpointUrl -Uri $Uri -Method $Method -ContentMD5 $ContentMd5 -ContentType $ContentType -DateTime $DateTime -Bucket $BucketName -QueryString $QueryString -Headers $Headers if (!$Presign.IsPresent) { $Headers["Authorization"] = "AWS $($AccessKey):$($Signature)" } } if ($Presign.IsPresent) { $UrlEncodedSignature = [System.Net.WebUtility]::UrlEncode($Signature) if ($SignerType -eq "AWS4") { $CanonicalQueryString += "&X-Amz-Signature=$UrlEncodedSignature" } else { $CanonicalQueryString += "&Signature=$UrlEncodedSignature" } } $EndpointUrl.Path = $Uri $EndpointUrl.Query = $CanonicalQueryString Write-Verbose "Request URI: $($EndpointUrl.Uri)" Write-Verbose "Request Headers: $($Headers | ConvertTo-Json)" $Request = [PSCustomObject]@{Method=$Method;Uri=$EndpointUrl.Uri;Headers=$Headers} Write-Output $Request } } <# .SYNOPSIS Invoke AWS Request .DESCRIPTION Invoke AWS Request #> function Global:Invoke-AwsRequest { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=1, HelpMessage="HTTP Request Method")][ValidateSet("OPTIONS","GET","HEAD","PUT","POST","DELETE","TRACE","CONNECT")][String]$Method="GET", [parameter( Mandatory=$False, Position=2, HelpMessage="Endpoint URI")][Uri]$Uri, [parameter( Mandatory=$False, Position=3, HelpMessage="Headers")][Hashtable]$Headers=@{}, [parameter( Mandatory=$False, Position=4, HelpMessage="Content type")][String]$ContentType, [parameter( Mandatory=$False, Position=5, HelpMessage="Request payload")][String]$Body="", [parameter( Mandatory=$False, Position=6, HelpMessage="File to read data from")][System.IO.FileInfo]$InFile, [parameter( Mandatory=$False, Position=7, HelpMessage="File to output result to")][System.IO.DirectoryInfo]$OutFile ) Begin { if ([environment]::OSVersion.Platform -match "Win") { # check if proxy is used $ProxyRegistry = "HKCU:\Software\Microsoft\Windows\CurrentVersion\Internet Settings" $ProxySettings = Get-ItemProperty -Path $ProxyRegistry if ($ProxySettings.ProxyEnable) { Write-Warning "Proxy Server $($ProxySettings.ProxyServer) configured in Internet Explorer may be used to connect to the endpoint!" } if ($ProxySettings.AutoConfigURL) { Write-Warning "Proxy Server defined in automatic proxy configuration script $($ProxySettings.AutoConfigURL) configured in Internet Explorer may be used to connect to the endpoint!" } } } Process { # check if untrusted SSL certificates should be ignored if ($SkipCertificateCheck.IsPresent) { if ($PSVersionTable.PSVersion.Major -lt 6) { [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy } else { if (!"Invoke-WebRequest:SkipCertificateCheck") { $PSDefaultParameterValues.Add("Invoke-WebRequest:SkipCertificateCheck",$true) } else { $PSDefaultParameterValues.'Invoke-WebRequest:SkipCertificateCheck'=$true } } } else { # currently there is no way to re-enable certificate check for the current session in PowerShell prior to version 6 if ($PSVersionTable.PSVersion.Major -ge 6) { if ("Invoke-WebRequest:SkipCertificateCheck") { $PSDefaultParameterValues.Remove("Invoke-WebRequest:SkipCertificateCheck") } } } # PowerShell 5 and early cannot skip certificate validation per request therefore we need to use a workaround if ($PSVersionTable.PSVersion.Major -lt 6 ) { if ($SkipCertificateCheck.isPresent) { $CurrentCertificatePolicy = [System.Net.ServicePointManager]::CertificatePolicy [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy } if ($Body) { if ($OutFile) { Write-Verbose "Body:`n$Body" Write-Verbose "Saving output in file $OutFile" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -Body ([System.Text.Encoding]::UTF8.GetBytes($Body)) -OutFile $OutFile } else { Write-Verbose "Body:`n$Body" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -Body ([System.Text.Encoding]::UTF8.GetBytes($Body)) } } else { if ($OutFile) { Write-Verbose "Saving output in file $OutFile" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -OutFile $OutFile } elseif ($InFile) { Write-Verbose "InFile:`n$InFile" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -InFile $InFile } else { $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers } } if ($SkipCertificateCheck.isPresent) { [System.Net.ServicePointManager]::CertificatePolicy = $CurrentCertificatePolicy } } else { if ($Body) { if ($OutFile) { Write-Verbose "Body:`n$Body" Write-Verbose "Saving output in file $OutFile" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -Body ([System.Text.Encoding]::UTF8.GetBytes($Body)) -OutFile $OutFile -SkipCertificateCheck:$SkipCertificateCheck -PreserveAuthorizationOnRedirect } else { Write-Verbose "Body:`n$Body" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -Body ([System.Text.Encoding]::UTF8.GetBytes($Body)) -SkipCertificateCheck:$SkipCertificateCheck -PreserveAuthorizationOnRedirect } } else { if ($OutFile) { Write-Verbose "Saving output in file $OutFile" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -OutFile $OutFile -SkipCertificateCheck:$SkipCertificateCheck -PreserveAuthorizationOnRedirect } elseif ($InFile) { Write-Verbose "InFile:`n$InFile" $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -InFile $InFile -SkipCertificateCheck:$SkipCertificateCheck -PreserveAuthorizationOnRedirect } else { $Result = Invoke-WebRequest -Method $Method -Uri $Uri -Headers $Headers -SkipCertificateCheck:$SkipCertificateCheck -PreserveAuthorizationOnRedirect } } } Write-Output $Result } } # TODO: Implement separate Update Cmdlet which does not overwrite values with defaults Set-Alias -Name Set-AwsProfile -Value Add-AwsConfig Set-Alias -Name New-AwsProfile -Value Add-AwsConfig Set-Alias -Name Add-AwsProfile -Value Add-AwsConfig Set-Alias -Name Update-AwsProfile -Value Add-AwsConfig Set-Alias -Name Set-AwsCredential -Value Add-AwsConfig Set-Alias -Name New-AwsCredential -Value Add-AwsConfig Set-Alias -Name Add-AwsCredential -Value Add-AwsConfig Set-Alias -Name Update-AwsCredential -Value Add-AwsConfig Set-Alias -Name Set-AwsConfig -Value Add-AwsConfig Set-Alias -Name New-AwsConfig -Value Add-AwsConfig Set-Alias -Name Update-AwsConfig -Value Add-AwsConfig <# .SYNOPSIS Add AWS Credentials .DESCRIPTION Add AWS Credentials .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER Credential Credential .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER Region Default Region to use for all requests made with these credentials .PARAMETER EndpointUrl Custom endpoint URL if different than AWS URL #> function Global:Add-AwsConfig { [CmdletBinding()] PARAM ( [parameter( Mandatory=$True, Position=0, ValueFromPipelineByPropertyName=$True, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="default", [parameter( Mandatory=$False, Position=1, ValueFromPipelineByPropertyName=$True, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation=$AWS_CREDENTIALS_FILE, [parameter( Mandatory=$False, Position=2, ValueFromPipelineByPropertyName=$True, HelpMessage="Credential")][PSCredential]$Credential, [parameter( Mandatory=$False, Position=3, ValueFromPipelineByPropertyName=$True, HelpMessage="S3 Access Key")][Alias("aws_access_key_id")][String]$AccessKey, [parameter( Mandatory=$False, Position=4, ValueFromPipelineByPropertyName=$True, HelpMessage="S3 Secret Access Key")][Alias("aws_secret_access_key")][String]$SecretKey, [parameter( Mandatory=$False, Position=5, ValueFromPipelineByPropertyName=$True, HelpMessage="Default Region to use for all requests made with these credentials")][String]$Region, [parameter( Mandatory=$False, Position=6, ValueFromPipelineByPropertyName=$True, HelpMessage="Custom endpoint URL if different than AWS URL")][Alias("endpoint_url")][System.UriBuilder]$EndpointUrl, [parameter( Mandatory=$False, Position=7, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum number of concurrent requests (Default: 10)")][Alias("max_concurrent_requests")][UInt16]$MaxConcurrentRequests, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum number of tasks in the task queue")][Alias("max_queue_size")][UInt16]$MaxQueueSize, [parameter( Mandatory=$False, Position=9, ValueFromPipelineByPropertyName=$True, HelpMessage="The size threshold where multipart uploads are used of individual files (Default: 8MB)")][Alias("multipart_threshold")][String]$MultipartThreshold, [parameter( Mandatory=$False, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="When using multipart transfers, this is the chunk size that is used for multipart transfers of individual files (Default: 8MB)")][Alias("multipart_chunksize")][String]$MultipartChunksize, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum bandwidth that will be consumed for uploading and downloading data to and from Amazon S3")][Alias("max_bandwidth")][String]$MaxBandwidth, [parameter( Mandatory=$False, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Use the Amazon S3 Accelerate endpoint for all s3 and s3api commands. S3 Accelerate must first be enabled on the bucket before attempting to use the accelerate endpoint. This is mutually exclusive with the use_dualstack_endpoint option.")][Alias("use_accelerate_endpoint")][Boolean]$UseAccelerateEndpoint, [parameter( Mandatory=$False, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Use the Amazon S3 dual IPv4 / IPv6 endpoint for all s3 commands. This is mutually exclusive with the use_accelerate_endpoint option.")][Alias("use_dualstack_endpoint")][Boolean]$UseDualstackEndpoint, [parameter( Mandatory=$False, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="Specifies which addressing style to use. This controls if the bucket name is in the hostname or part of the URL. Value values are: path, virtual, and auto. The default value is auto.")][Alias("addressing_style")][ValidateSet("auto","path","virtual")][String]$AddressingStyle, [parameter( Mandatory=$False, Position=15, ValueFromPipelineByPropertyName=$True, HelpMessage="Refers to whether or not to SHA256 sign sigv4 payloads. By default, this is disabled for streaming uploads (UploadPart and PutObject) when using https.")][Alias("payload_signing_enabled")][Boolean]$PayloadSigningEnabled, [parameter( Mandatory=$False, Position=1, HelpMessage="Enable or disable skipping of certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Boolean]$SkipCertificateCheck ) Process { $ConfigLocation = $ProfileLocation -replace "/[^/]+$", '/config' Write-Verbose "AccessKey $AccessKey" Write-Verbose "secretKey $SecretKey" if ($Credential) { $AccessKey = $Credential.UserName $SecretKey = $Credential.GetNetworkCredential().Password } if ($AccessKey -and $SecretKey) { try { $Credentials = ConvertFrom-AwsConfigFile -AwsConfigFile $ProfileLocation } catch { Write-Verbose "Retrieving credentials from $ProfileLocation failed" } if (($Credentials | Where-Object { $_.ProfileName -eq $ProfileName })) { $CredentialEntry = $Credentials | Where-Object { $_.ProfileName -eq $ProfileName } } else { $CredentialEntry = [PSCustomObject]@{ ProfileName = $ProfileName } } $CredentialEntry | Add-Member -MemberType NoteProperty -Name aws_access_key_id -Value $AccessKey -Force $CredentialEntry | Add-Member -MemberType NoteProperty -Name aws_secret_access_key -Value $SecretKey -Force Write-Debug $CredentialEntry $Credentials = @($Credentials | Where-Object { $_.ProfileName -ne $ProfileName }) + $CredentialEntry ConvertTo-AwsConfigFile -Config $Credentials -AwsConfigFile $ProfileLocation } try { $Configs = ConvertFrom-AwsConfigFile -AwsConfigFile $ConfigLocation } catch { Write-Verbose "Retrieving config from $ConfigLocation failed" } $Config = $Configs | Where-Object { $_.ProfileName -eq $ProfileName } if ($Config) { if (!$Config.S3) { $Config | Add-Member -MemberType NoteProperty -Name "S3" -Value ([PSCustomObject]@{}) } } else { $Config = [PSCustomObject]@{ ProfileName = $ProfileName;s3 = [PSCustomObject]@{} } } if ($Region -and $Region -ne "us-east-1") { $Config | Add-Member -MemberType NoteProperty -Name region -Value $Region -Force } if ($EndpointUrl) { $EndpointUrlString = $EndpointUrl -replace "(http://.*:80)",'$1' -replace "(https://.*):443",'$1' -replace "/$","" $Config.S3 | Add-Member -MemberType NoteProperty -Name endpoint_url -Value $EndpointUrlString -Force } if ($MaxConcurrentRequests -and $MaxConcurrentRequests -ne [Environment]::ProcessorCount) { $Config.S3 | Add-Member -MemberType NoteProperty -Name max_concurrent_requests -Value $MaxConcurrentRequests -Force } if ($MaxQueueSize -and $MaxQueueSize -ne 1000) { $Config.S3 | Add-Member -MemberType NoteProperty -Name max_queue_size -Value $MaxQueueSize -Force } if ($MultipartThreshold -and $MultipartThreshold -ne "8MB") { $Config.S3 | Add-Member -MemberType NoteProperty -Name multipart_threshold -Value $MultipartThreshold -Force } if ($MultipartChunksize -and $MultipartChunksize -ne "8MB") { $Config.S3 | Add-Member -MemberType NoteProperty -Name multipart_chunksize -Value $MultipartChunksize -Force } if ($MaxBandwidth) { $Config.S3 | Add-Member -MemberType NoteProperty -Name max_bandwidth -Value $MaxBandwidth -Force } if ($UseAccelerateEndpoint -and $UseDualstackEndpoint) { Throw "The parameters use_accelerate_endpoint and use_dualstack_endpoint are mutually exclusive!" } if ($UseAccelerateEndpoint -ne $null) { $Config.S3 | Add-Member -MemberType NoteProperty -Name use_accelerate_endpoint -Value $UseAccelerateEndpoint -Force } if ($UseDualstackEndpoint -ne $null) { $Config.S3 | Add-Member -MemberType NoteProperty -Name use_dualstack_endpoint -Value $UseDualstackEndpoint -Force } if ($AddressingStyle -and $AddressingStyle -ne "auto") { $Config.S3 | Add-Member -MemberType NoteProperty -Name addressing_style -Value $AddressingStyle -Force } if ($PayloadSigningEnabled -ne $null) { $Config.S3 | Add-Member -MemberType NoteProperty -Name payload_signing_enabled -Value $PayloadSigningEnabled -Force } if ($SkipCertificateCheck -ne $null) { $Config.S3 | Add-Member -MemberType NoteProperty -Name skip_certificate_check -Value $SkipCertificateCheck -Force } $Configs = @($Configs | Where-Object { $_.ProfileName -ne $ProfileName}) + $Config ConvertTo-AwsConfigFile -Config $Configs -AwsConfigFile $ConfigLocation } } Set-Alias -Name Get-AwsProfiles -Value Get-AwsConfigs Set-Alias -Name Get-AwsCredentials -Value Get-AwsConfigs <# .SYNOPSIS Get the AWS config for all profiles and if there is a connection to a StorageGRID, it includes the AWS config of the connected tenant .DESCRIPTION Get the AWS config for all profiles and if there is a connection to a StorageGRID, it includes the AWS config of the connected tenant .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials #> function Global:Get-AwsConfigs { [CmdletBinding()] PARAM ( [parameter( Mandatory=$False, Position=0, ValueFromPipelineByPropertyName=$True, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation=$AWS_CREDENTIALS_FILE ) Process { if (!$ProfileLocation) { $ProfileLocation = $AWS_CREDENTIALS_FILE } $ConfigLocation = $ProfileLocation -replace "/[^/]+$",'/config' if (!(Test-Path $ProfileLocation)) { Throw "Profile location $ProfileLocation does not exist!" } $Credentials = @() $Config = @() try { $Credentials = ConvertFrom-AwsConfigFile -AwsConfigFile $ProfileLocation } catch { Write-Verbose "Retrieving credentials from $ProfileLocation failed" } try { $Configs = ConvertFrom-AwsConfigFile -AwsConfigFile $ConfigLocation } catch { Write-Verbose "Retrieving credentials from $ConfigLocation failed" } foreach ($Credential in $Credentials) { $Config = $Configs | Where-Object { $_.ProfileName -eq $Credential.ProfileName } | Select-Object -First 1 if (!$Config) { $Config = [PSCustomObject]@{ProfileName=$Credential.ProfileName} $Configs = @($Configs) + $Config } if ($Credential.aws_access_key_id) { $Config | Add-Member -MemberType NoteProperty -Name aws_access_key_id -Value $Credential.aws_access_key_id -Force } if ($Credential.aws_secret_access_key) { $Config | Add-Member -MemberType NoteProperty -Name aws_secret_access_key -Value $Credential.aws_secret_access_key -Force } } foreach ($Config in $Configs) { $Output = [PSCustomObject]@{ProfileName = $Config.ProfileName;AccessKey = $Config.aws_access_key_id;SecretKey = $Config.aws_secret_access_key} if ($Config.S3.Region) { $Output | Add-Member -MemberType NoteProperty -Name Region -Value $Config.S3.Region } elseif ($Config.Region) { $Output | Add-Member -MemberType NoteProperty -Name Region -Value $Config.Region } else { $Output | Add-Member -MemberType NoteProperty -Name Region -Value "us-east-1" } if ($Config.S3.endpoint_url) { $Output | Add-Member -MemberType NoteProperty -Name EndpointUrl -Value $Config.S3.endpoint_url } else { $Output | Add-Member -MemberType NoteProperty -Name EndpointUrl -Value $Config.endpoint_url } if ($Config.S3.max_concurrent_requests) { $Output | Add-Member -MemberType NoteProperty -Name MaxConcurrentRequests -Value $Config.S3.max_concurrent_requests } elseif ($Config.max_concurrent_requests) { $Output | Add-Member -MemberType NoteProperty -Name MaxConcurrentRequests -Value $Config.max_concurrent_requests } else { $Output | Add-Member -MemberType NoteProperty -Name MaxConcurrentRequests -Value ([Environment]::ProcessorCount) } if ($Config.S3.max_queue_size) { $Output | Add-Member -MemberType NoteProperty -Name MaxQueueSize -Value $Config.S3.max_queue_size } elseif ($Config.max_queue_size) { $Output | Add-Member -MemberType NoteProperty -Name MaxQueueSize -Value $Config.max_queue_size } else { $Output | Add-Member -MemberType NoteProperty -Name MaxQueueSize -Value 1000 } if ($Config.S3.multipart_threshold) { $Output | Add-Member -MemberType NoteProperty -Name MultipartThreshold -Value $Config.S3.multipart_threshold } elseif ($Config.multipart_threshold) { $Output | Add-Member -MemberType NoteProperty -Name MultipartThreshold -Value $Config.multipart_threshold } else { $Output | Add-Member -MemberType NoteProperty -Name MultipartThreshold -Value "8MB" } if ($Config.S3.multipart_chunksize) { $Output | Add-Member -MemberType NoteProperty -Name MultipartChunksize -Value $Config.S3.multipart_chunksize } elseif ($Config.multipart_chunksize) { $Output | Add-Member -MemberType NoteProperty -Name MultipartChunksize -Value $Config.multipart_chunksize } else { $Output | Add-Member -MemberType NoteProperty -Name MultipartChunksize -Value "8MB" } if ($Config.S3.max_bandwidth) { $Output | Add-Member -MemberType NoteProperty -Name MaxBandwidth -Value $Config.S3.max_bandwidth } else { $Output | Add-Member -MemberType NoteProperty -Name MaxBandwidth -Value $Config.max_bandwidth } if ($Config.S3.use_accelerate_endpoint) { $Output | Add-Member -MemberType NoteProperty -Name UseAccelerateEndpoint -Value ([System.Convert]::ToBoolean($Config.S3.use_accelerate_endpoint)) } elseif ($Config.use_accelerate_endpoint) { $Output | Add-Member -MemberType NoteProperty -Name UseAccelerateEndpoint -Value ([System.Convert]::ToBoolean($Config.use_accelerate_endpoint)) } else { $Output | Add-Member -MemberType NoteProperty -Name UseAccelerateEndpoint -Value $false } if ($Config.S3.use_dualstack_endpoint) { $Output | Add-Member -MemberType NoteProperty -Name UseDualstackEndpoint -Value ([System.Convert]::ToBoolean($Config.S3.use_dualstack_endpoint)) } elseif ($Config.use_dualstack_endpoint) { $Output | Add-Member -MemberType NoteProperty -Name UseDualstackEndpoint -Value ([System.Convert]::ToBoolean($Config.use_dualstack_endpoint)) } else { $Output | Add-Member -MemberType NoteProperty -Name UseDualstackEndpoint -Value $false } if ($Config.S3.addressing_style) { $Output | Add-Member -MemberType NoteProperty -Name AddressingStyle -Value $Config.S3.addressing_style } elseif ($Config.addressing_style) { $Output | Add-Member -MemberType NoteProperty -Name AddressingStyle -Value $Config.addressing_style } else { $Output | Add-Member -MemberType NoteProperty -Name AddressingStyle -Value "auto" } if ($Config.S3.payload_signing_enabled) { $Output | Add-Member -MemberType NoteProperty -Name PayloadSigningEnabled -Value ([System.Convert]::ToBoolean($Config.S3.payload_signing_enabled)) } elseif ($Config.payload_signing_enabled) { $Output | Add-Member -MemberType NoteProperty -Name PayloadSigningEnabled -Value ([System.Convert]::ToBoolean($Config.payload_signing_enabled)) } else { $Output | Add-Member -MemberType NoteProperty -Name PayloadSigningEnabled -Value $false } if ($Config.S3.skip_certificate_check) { $Output | Add-Member -MemberType NoteProperty -Name SkipCertificateCheck -Value ([System.Convert]::ToBoolean($Config.S3.skip_certificate_check)) } elseif ($Config.skip_certificate_check) { $Output | Add-Member -MemberType NoteProperty -Name SkipCertificateCheck -Value ([System.Convert]::ToBoolean($Config.skip_certificate_check)) } else { $Output | Add-Member -MemberType NoteProperty -Name SkipCertificateCheck -Value $False } Write-Output $Output } } } Set-Alias -Name Get-AwsProfile -Value Get-AwsConfig Set-Alias -Name Get-AwsCredential -Value Get-AwsConfig <# .SYNOPSIS Get AWS config .DESCRIPTION Get AWS config If there is a connection to a StorageGRID, this is the AWS config of the connected tenant. If a profile is provided, it is the AWS config of the AWS profile. .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER Credential Credential .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID Account ID .PARAMETER Region Default Region to use for all requests made with these credentials .PARAMETER EndpointUrl Custom endpoint URL if different than AWS URL #> function Global:Get-AwsConfig { [CmdletBinding()] PARAM ( [parameter( Mandatory=$False, Position=0, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, ValueFromPipelineByPropertyName=$True, HelpMessage="AWS Profile to use which contains AWS credentials and settings")][Alias("Profile")][String]$ProfileName="default", [parameter( Mandatory=$False, Position=2, ValueFromPipelineByPropertyName=$True, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation=$AWS_CREDENTIALS_FILE, [parameter( Mandatory=$False, Position=3, ValueFromPipelineByPropertyName=$True, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( Mandatory=$False, Position=4, ValueFromPipelineByPropertyName=$True, HelpMessage="S3 Secret Access Key")][String]$SecretKey, [parameter( Mandatory=$False, Position=5, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID Account ID")][String]$AccountId, [parameter( Mandatory=$False, Position=6, ValueFromPipelineByPropertyName=$True, HelpMessage="Default Region to use for all requests made with these credentials")][String]$Region, [parameter( Mandatory=$False, Position=7, ValueFromPipelineByPropertyName=$True, HelpMessage="Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum number of concurrent requests (Default: 10)")][Alias("max_concurrent_requests")][UInt16]$MaxConcurrentRequests, [parameter( Mandatory=$False, Position=9, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum number of tasks in the task queue")][Alias("max_queue_size")][UInt16]$MaxQueueSize, [parameter( Mandatory=$False, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="The size threshold where multipart uploads are used of individual files (Default: 8MB)")][Alias("multipart_threshold")][String]$MultipartThreshold, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="When using multipart transfers, this is the chunk size that is used for multipart transfers of individual files (Default: 8MB)")][Alias("multipart_chunksize")][String]$MultipartChunksize, [parameter( Mandatory=$False, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum bandwidth that will be consumed for uploading and downloading data to and from Amazon S3")][Alias("max_bandwidth")][String]$MaxBandwidth, [parameter( Mandatory=$False, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Use the Amazon S3 Accelerate endpoint for all s3 and s3api commands. S3 Accelerate must first be enabled on the bucket before attempting to use the accelerate endpoint. This is mutually exclusive with the use_dualstack_endpoint option.")][Alias("use_accelerate_endpoint")][String]$UseAccelerateEndpoint, [parameter( Mandatory=$False, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="Use the Amazon S3 dual IPv4 / IPv6 endpoint for all s3 commands. This is mutually exclusive with the use_accelerate_endpoint option.")][Alias("use_dualstack_endpoint")][String]$UseDualstackEndpoint, [parameter( Mandatory=$False, Position=15, ValueFromPipelineByPropertyName=$True, HelpMessage="Specifies which addressing style to use. This controls if the bucket name is in the hostname or part of the URL. Value values are: path, virtual, and auto. The default value is auto.")][Alias("addressing_style")][ValidateSet("auto","path","virtual")][String]$AddressingStyle, [parameter( Mandatory=$False, Position=16, ValueFromPipelineByPropertyName=$True, HelpMessage="Refers to whether or not to SHA256 sign sigv4 payloads. By default, this is disabled for streaming uploads (UploadPart and PutObject) when using https.")][Alias("payload_signing_enabled")][String]$PayloadSigningEnabled, [parameter( Mandatory=$False, Position=1, HelpMessage="Enable or disable skipping of certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][String]$SkipCertificateCheck ) Begin { if (!$Server -and $CurrentSgwServer) { $Server = $CurrentSgwServer.PSObject.Copy() } } Process { $Config = [PSCustomObject]@{ProfileName = $ProfileName; AccessKey = $AccessKey; SecretKey = $SecretKey; Region = $Region; EndpointUrl = $EndpointUrl; MaxConcurrentRequests = $MaxConcurrentRequests; MaxQueueSize = $MaxQueueSize; MultipartThreshold = $MultipartThreshold; MultipartChunksize = $MultipartChunksize; MaxBandwidth = $MaxBandwidth; UseAccelerateEndpoint = $UseAccelerateEndpoint; UseDualstackEndpoint = $UseDualstackEndpoint; AddressingStyle = $AddressingStyle; PayloadSigningEnabled = $PayloadSigningEnabled; SkipCertificateCheck = $SkipCertificateCheck} if (!$ProfileName -and !$AccessKey -and !$Server) { $ProfileName = "default" } if ($ProfileName) { Write-Verbose "Profile $ProfileName specified, therefore returning AWS config of this profile" $Config = Get-AwsConfigs -ProfileLocation $ProfileLocation | Where-Object { $_.ProfileName -eq $ProfileName } if (!$Config) { Write-Verbose "Config for profile $ProfileName not found" return } } elseif ($AccessKey) { Write-Verbose "Access Key $AccessKey and Secret Access Key specified, therefore returning AWS config for the keys" } else { # if an explicit endpoint URL is provided, use instead of the one from provided server if ($Server.AccountId) { $AccountId = $Server.AccountId } if (!$EndpointUrl) { $EndpointUrl = $Server.S3EndpointUrl } if (!$Server.DisableAutomaticAccessKeyGeneration -and $AccountId) { Write-Verbose "No profile and no access key specified, but connected to StorageGRID tenant with Account ID $AccountId. Therefore using autogenerated temporary AWS credentials" if ($Server.AccessKeyStore[$AccountId].expires -ge (Get-Date).ToUniversalTime().AddMinutes(1) -or ($Server.AccessKeyStore[$AccountId] -and !$Server.AccessKeyStore[$AccountId].expires)) { $Credential = $Server.AccessKeyStore[$AccountId] | Sort-Object -Property expires | Select-Object -Last 1 Write-Verbose "Using existing Access Key $( $Credential.AccessKey )" } else { $Credential = New-SgwS3AccessKey -Server $Server -Expires (Get-Date).AddSeconds($Server.TemporaryAccessKeyExpirationTime) -AccountId $AccountId Write-Verbose "Created new temporary Access Key $( $Credential.AccessKey )" } $Config.AccessKey = $Credential.AccessKey $Config.SecretKey = $Credential.SecretAccessKey $Config.EndpointUrl = [System.UriBuilder]::new($EndpointUrl) } } if ($Region) { $Config.Region = $Region } elseif (!$Config.region) { $Config.Region = "us-east-1" } if ($EndpointUrl) { $Config.EndpointUrl = $EndpointUrl } if ($MaxConcurrentRequests) { $Config.MaxConcurrentRequests = $MaxConcurrentRequests } elseif (!$Config.MaxConcurrentRequests) { $Config.MaxConcurrentRequests = ([Environment]::ProcessorCount) } if ($MaxQueueSize) { $Config.MaxQueueSize = $MaxQueueSize } elseif (!$Config.MaxQueueSize) { $Config.MaxQueueSize = 1000 } if ($MultipartThreshold) { $Config.MultipartThreshold = $MultipartThreshold } elseif (!$Config.MultipartThreshold) { $Config.MultipartThreshold = "8MB" } if ($MultipartChunksize) { $Config.MultipartChunksize = $MultipartChunksize } elseif (!$Config.MultipartChunksize) { $MultipartChunksize = "8MB" } if ($MaxBandwidth) { $Config.MaxBandwidth = $MaxBandwidth } if ($UseAccelerateEndpoint) { $Config.UseAccelerateEndpoint = ([System.Convert]::ToBoolean($UseAccelerateEndpoint)) } elseif ($Config.UseAccelerateEndpoint -eq $null) { $UseAccelerateEndpoint = $false } if ($UseDualstackEndpoint) { $Config.UseDualstackEndpoint = ([System.Convert]::ToBoolean($UseDualstackEndpoint)) } elseif ($Config.UseDualstackEndpoint -eq $null) { $UseDualstackEndpoint = $false } if ($AddressingStyle) { $Config.AddressingStyle = $AddressingStyle } elseif (!$Config.AddressingStyle) { $AddressingStyle = "auto" } if ($PayloadSigningEnabled) { $Config.PayloadSigningEnabled = ([System.Convert]::ToBoolean($PayloadSigningEnabled)) } elseif ($Config.PayloadSigningEnabled -eq $null) { $PayloadSigningEnabled = $false } if ($SkipCertificateCheck) { $Config.SkipCertificateCheck = ([System.Convert]::ToBoolean($SkipCertificateCheck)) } elseif ($SkipCertificateCheck -eq $null) { $SkipCertificateCheck = $false } Write-Output $Config } } Set-Alias -Name Remove-AwsProfile -Value Remove-AwsConfig Set-Alias -Name Remove-AwsCredential -Value Remove-AwsConfig <# .SYNOPSIS Remove AWS Config .DESCRIPTION Remove AWS Config .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials #> function Global:Remove-AwsConfig { [CmdletBinding()] PARAM ( [parameter( Mandatory=$True, Position=0, HelpMessage="AWS Profile where config should be removed")][Alias("Profile")][String]$ProfileName, [parameter( Mandatory=$False, Position=1, ValueFromPipelineByPropertyName=$True, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation=$AWS_CREDENTIALS_FILE ) Process { $ConfigLocation = $ProfileLocation -replace "/[^/]+$",'/config' $Credentials = ConvertFrom-AwsConfigFile -AwsConfigFile $ProfileLocation $Credentials = $Credentials | Where-Object { $_.ProfileName -ne $ProfileName } ConvertTo-AwsConfigFile -Config $Credentials -AwsConfigFile $ProfileLocation $Configs = ConvertFrom-AwsConfigFile -AwsConfigFile $ConfigLocation $Configs = $Configs | Where-Object { $_.ProfileName -ne $ProfileName } ConvertTo-AwsConfigFile -Config $Configs -AwsConfigFile $ConfigLocation } } Set-Alias -Name Add-AwsPolicyStatement -Value New-AwsPolicy Set-Alias -Name New-IamPolicy -Value New-AwsPolicy Set-Alias -Name Add-IamPolicyStatement -Value New-AwsPolicy Set-Alias -Name New-S3BucketPolicy -Value New-AwsPolicy Set-Alias -Name Add-S3BucketPolicyStatement -Value New-AwsPolicy <# .SYNOPSIS Create new S3 Bucket Policy .DESCRIPTION Create new S3 Bucket Policy #> function Global:New-AwsPolicy { [CmdletBinding(DefaultParameterSetName = "PrincipalResourceAction")] PARAM ( [parameter( Mandatory = $False, Position = 0, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $True, HelpMessage = "S3 Bucket Policy to add statements to")][Alias("BucketPolicy","IamPolicy","AwsPolicy","Policy")][String]$PolicyString, [parameter( Mandatory = $False, Position = 1, HelpMessage = "The Sid element is optional. The Sid is only intended as a description for the user. It is stored but not interpreted by the StorageGRID Webscale system.")][String]$Sid, [parameter( Mandatory = $False, Position = 2, HelpMessage = "Use the Effect element to establish whether the specified operations are allowed or denied. You must identify operations you allow (or deny) on buckets or objects using the supported Action element keywords.")][ValidateSet("Allow", "Deny")][String]$Effect = "Allow", [parameter( Mandatory = $False, Position = 3, ParameterSetName = "PrincipalResourceAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject] [parameter( Mandatory = $False, Position = 3, ParameterSetName = "PrincipalResourceNotAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject] [parameter( Mandatory = $False, Position = 3, ParameterSetName = "PrincipalNotResourceAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject] [parameter( Mandatory = $False, Position = 3, ParameterSetName = "PrincipalNotResourceNotAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject]$Principal = "*", [parameter( Mandatory = $False, Position = 3, ParameterSetName = "NotPrincipalResourceAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject] [parameter( Mandatory = $False, Position = 3, ParameterSetName = "NotPrincipalResourceNotAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject] [parameter( Mandatory = $False, Position = 3, ParameterSetName = "NotPrincipalNotResourceAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject] [parameter( Mandatory = $False, Position = 3, ParameterSetName = "NotPrincipalNotResourceNotAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][PSCustomObject]$NotPrincipal, [parameter( Mandatory = $False, Position = 4, ParameterSetName = "PrincipalResourceAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder] [parameter( Mandatory = $False, Position = 4, ParameterSetName = "PrincipalResourceNotAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder] [parameter( Mandatory = $False, Position = 4, ParameterSetName = "NotPrincipalResourceAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder] [parameter( Mandatory = $False, Position = 4, ParameterSetName = "NotPrincipalResourceNotAction", HelpMessage = "The Resource element identifies buckets and objects. With it you can allow permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder]$Resource = "arn:aws:s3:::*", [parameter( Mandatory = $False, Position = 4, ParameterSetName = "PrincipalNotResourceAction", HelpMessage = "The NotResource element identifies buckets and objects. With it you can deny permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder] [parameter( Mandatory = $False, Position = 4, ParameterSetName = "PrincipalNotResourceNotAction", HelpMessage = "The NotResource element identifies buckets and objects. With it you can deny permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder] [parameter( Mandatory = $False, Position = 4, ParameterSetName = "NotPrincipalNotResourceAction", HelpMessage = "The NotResource element identifies buckets and objects. With it you can deny permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder] [parameter( Mandatory = $False, Position = 4, ParameterSetName = "NotPrincipalNotResourceNotAction", HelpMessage = "The NotResource element identifies buckets and objects. With it you can deny permissions to buckets and objects using the uniform resource name (URN) to identify the resource.")][System.UriBuilder]$NotResource, [parameter( Mandatory = $False, Position = 5, ParameterSetName = "PrincipalResourceAction", HelpMessage = "The Action element specifies a list of allowed actions and may allow all actions using a wildcard (e.g. s3:*).")][String[]] [parameter( Mandatory = $False, Position = 5, ParameterSetName = "PrincipalNotResourceAction", HelpMessage = "The Action element specifies a list of allowed actions and may allow all actions using a wildcard (e.g. s3:*).")][String[]] [parameter( Mandatory = $False, Position = 5, ParameterSetName = "NotPrincipalResourceAction", HelpMessage = "The Action element specifies a list of allowed actions and may allow all actions using a wildcard (e.g. s3:*).")][String[]] [parameter( Mandatory = $False, Position = 5, ParameterSetName = "NotPrincipalNotResourceAction", HelpMessage = "The Action element specifies a list of allowed actions and may allow all actions using a wildcard (e.g. s3:*).")][String[]]$Action = "s3:*", [parameter( Mandatory = $False, Position = 5, ParameterSetName = "PrincipalResourceNotAction", HelpMessage = "The NotAction element specifies a list of denied actions and may deny all actions using a wildcard (e.g. s3:*).")][String[]] [parameter( Mandatory = $False, Position = 5, ParameterSetName = "PrincipalNotResourceNotAction", HelpMessage = "The NotAction element specifies a list of denied actions and may deny all actions using a wildcard (e.g. s3:*).")][String[]] [parameter( Mandatory = $False, Position = 5, ParameterSetName = "NotPrincipalResourceNotAction", HelpMessage = "The NotAction element specifies a list of denied actions and may deny all actions using a wildcard (e.g. s3:*).")][String[]] [parameter( Mandatory = $False, Position = 5, ParameterSetName = "NotPrincipalNotResourceNotAction", HelpMessage = "The NotAction element specifies a list of denied actions and may deny all actions using a wildcard (e.g. s3:*).")][String[]]$NotAction, [parameter( Mandatory = $False, Position = 6, HelpMessage = "The Condition element is optional. Conditions allow you to build expressions to determine when a policy should be applied.")][String]$Condition ) Process { # see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html for details on Policies if ($CurrentSgwServer -and ($Resource -match "arn:aws" -or $NotResource -match "arn:aws")) { Write-Warning "Resource starts with arn:aws:" Write-Warning "If the policy is created for an S3 service different than AWS (e.g. StorageGRID),the Resource may need to be specified as:" if ($Resource) { Write-Warning ($Resource.ToString() -replace "arn:aws:","urn:sgws:") } else { Write-Warning ($NotResource.ToString() -replace "arn:aws:","urn:sgws:") } } if (!$PolicyString) { $Policy = [PSCustomObject]@{ Version = "2012-10-17"; Statement = @() } } else { $Policy = ConvertFrom-Json -InputObject $PolicyString } $Statement = [PSCustomObject]@{ Effect = $Effect } if ($Sid) { $Statement | Add-Member -MemberType NoteProperty -Name Sid -Value $Sid } if ($Principal) { $Statement | Add-Member -MemberType NoteProperty -Name Principal -Value $Principal } if ($NotPrincipal) { $Statement | Add-Member -MemberType NoteProperty -Name NotPrincipal -Value $NotPrincipal } if ($Resource) { $Statement | Add-Member -MemberType NoteProperty -Name Resource -Value $Resource.Uri.ToString() } if ($NotResource) { $Statement | Add-Member -MemberType NoteProperty -Name NotResource -Value $NotResource.Uri.ToString() } if ($Action) { $Statement | Add-Member -MemberType NoteProperty -Name Action -Value $Action } if ($NotAction) { $Statement | Add-Member -MemberType NoteProperty -Name NotAction -Value $NotAction } if ($Condition) { $Statement | Add-Member -MemberType NoteProperty -Name Condition -Value $Condition } $Policy.Statement += $Statement # convert to JSON $PolicyString = ConvertTo-Json -InputObject $Policy -Depth 10 Write-Output $PolicyString } } ### S3 Cmdlets ### ## Buckets ## <# .SYNOPSIS Get S3 Buckets .DESCRIPTION Get S3 Buckets .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name #> function Global:Get-S3Buckets { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS credentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Method = "GET" $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } Process { Write-Verbose "Retrieving all buckets" if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } $Uri = "/" if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Presign:$Presign -SignerType $SignerType -UseDualstackEndpoint:$UseDualstackEndpoint if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML]$Result.Content if ($Content.ListAllMyBucketsResult) { if ($BucketName) { $XmlBuckets = $Content.ListAllMyBucketsResult.Buckets.ChildNodes | Where-Object { $_.Name -eq [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() } } else { $XmlBuckets = $Content.ListAllMyBucketsResult.Buckets.ChildNodes } foreach ($XmlBucket in $XmlBuckets) { $Location = Get-S3BucketLocation -SkipCertificateCheck:$Config.SkipCertificateCheck -EndpointUrl $Config.EndpointUrl -Bucket $XmlBucket.Name -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Presign:$Presign -SignerType $SignerType -UseDualstackEndpoint:$UseDualstackEndpoint $UnicodeBucketName = [System.Globalization.IdnMapping]::new().GetUnicode($XmlBucket.Name) # ensure that we keep uppercase letters if ($UnicodeBucketName -eq $XmlBucket.Name) { $UnicodeBucketName = $XmlBucket.Name } $Bucket = [PSCustomObject]@{ BucketName = $UnicodeBucketName; CreationDate = $XmlBucket.CreationDate; OwnerId = $Content.ListAllMyBucketsResult.Owner.ID; OwnerDisplayName = $Content.ListAllMyBucketsResult.Owner.DisplayName; Region = $Location } Write-Output $Bucket } } } } elseif ($CurrentSgwServer.SupportedApiVersions -match "1" -and !$CurrentSgwServer.AccountId -and !$AccountId) { $Accounts = Get-SgwAccounts -Capabilities "s3" foreach ($Account in $Accounts) { Get-S3Buckets -Server $Server -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccountId $Account.Id -UseDualstackEndpoint:$UseDualstackEndpoint } } } } <# .SYNOPSIS Test if S3 Bucket exists .DESCRIPTION Test if S3 Bucket exists .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name .PARAMETER CheckAllRegions Check all regions - by default only the specified region (or us-east-1 if no region is specified) will be checked. #> function Global:Test-S3Bucket { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Check all regions - by default only the specified region (or us-east-1 if no region is specified) will be checked.")][Switch]$CheckAllRegions, [parameter( Mandatory=$False, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Force check of specified bucketname and do not convert it to IDN compatible string")][Switch]$Force ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "HEAD" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # if BucketName contains uppercase letters test if bucket was created correctly without uppercase letters or if it contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName -and -not $Force.IsPresent) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" Write-Output $BucketNameExists break } } if (-not $Force) { $BucketName = $PunycodeBucketName } if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers Write-Output $true } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName } else { Write-Output $false } } } } } } <# .SYNOPSIS Create S3 Bucket .DESCRIPTION Create S3 Bucket .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER BucketName Bucket Name .PARAMETER CannedAclName Canned ACL .PARAMETER PublicReadOnly If set, applies an ACL making the bucket public with read-only permissions .PARAMETER PublicReadWrite If set, applies an ACL making the bucket public with read-write permissions .PARAMETER Region Bucket Region .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Force Parameter is only used for compatibility with AWS Cmdlets and will be ignored #> function Global:New-S3Bucket { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=9, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=10, HelpMessage="Canned ACL")][Alias("CannedAcl","Acl")][String][ValidateSet("private","public-read","public-read-write","aws-exec-read","authenticated-read","bucket-owner-read","bucket-owner-full-control")]$CannedAclName, [parameter( Mandatory=$False, Position=11, HelpMessage="If set, applies an ACL making the bucket public with read-only permissions")][Switch]$PublicReadOnly, [parameter( Mandatory=$False, Position=12, HelpMessage="If set, applies an ACL making the bucket public with read-write permissions")][Switch]$PublicReadWrite, [parameter( Mandatory=$False, Position=13, HelpMessage="Bucket Region")][Alias("Location","LocationConstraint")][String]$Region, [parameter( Mandatory=$False, Position=14, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$False, Position=15, HelpMessage="Parameter is only used for compatibility with AWS Cmdlets and will be ignored")][Switch]$Force ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Method = "PUT" $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Config) { Throw "No S3 credentials found" } if (!$Region) { $Region = $Config.Region } # TODO: Implement CannedAcl, PublicReadOnly and PublicReadWrite # AWS does not allow to set LocationConstraint for default region us-east-1 if ($Region -and $Region -ne "us-east-1") { $RequestPayload = "<CreateBucketConfiguration xmlns=`"http://s3.amazonaws.com/doc/2006-03-01/`"><LocationConstraint>$Region</LocationConstraint></CreateBucketConfiguration>" } # Convert Bucket Name to IDN mapping to support Unicode Names and convert to lowercase $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { Write-Warning "BucketName $BucketName includes uppercase letters which MUST NOT be used. Converting BucketName to lowercase $PunycodeBucketName. AWS S3 and StorageGRID Webscale 11.1 do not support Buckets with uppercase letters!" } $BucketName = $PunycodeBucketName $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -RequestPayload $RequestPayload -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $RequestPayload -ErrorAction Stop } } } <# .SYNOPSIS Remove S3 Bucket .DESCRIPTION Remove S3 Bucket .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER Region Bucket Region .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER BucketName Bucket Name .PARAMETER Force Force deletion even if bucket is not empty .PARAMETER DeleteBucketContent If set, all remaining objects and/or object versions in the bucket are deleted proir to the bucket itself being deleted #> function Global:Remove-S3Bucket { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=10, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=12, HelpMessage="Force deletion even if bucket is not empty.")][Switch]$Force, [parameter( Mandatory=$False, Position=13, HelpMessage="If set, all remaining objects and/or object versions in the bucket are deleted proir to the bucket itself being deleted.")][Switch]$DeleteBucketContent ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "DELETE" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($Force -or $DeleteBucketContent) { Write-Verbose "Force parameter specified, removing all objects in the bucket before removing the bucket" Get-S3Objects -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -UrlStyle $UrlStyle -Bucket $BucketName -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint | Remove-S3Object -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } <# .SYNOPSIS Retrieve Bucket Encryption .DESCRIPTION Retrieve Bucket Encryption .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name #> function Global:Get-S3BucketEncryption { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{encryption=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } foreach ($Rule in $Content.ServerSideEncryptionConfiguration.Rule) { $Output = [PSCustomObject]@{SSEAlgorithm=$Rule.ApplyServerSideEncryptionByDefault.SSEAlgorithm; KMSMasterKeyID=$Rule.ApplyServerSideEncryptionByDefault.KMSMasterKeyID} Write-Output $Output } } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Get-S3BucketEncryption -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName } } } } } } <# .SYNOPSIS Set Bucket Encryption .DESCRIPTION Set Bucket Encryption .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name .PARAMETER SSEAlgorithm The server-side encryption algorithm to use. .PARAMETER KMSMasterKeyID The AWS KMS master key ID used for the SSE-KMS encryption. #> function Global:Set-S3BucketEncryption { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="The server-side encryption algorithm to use.")][ValidateSet("AES256","aws:kms")][String]$SSEAlgorithm, [parameter( Mandatory=$False, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="The AWS KMS master key ID used for the SSE-KMS encryption.")][System.UriBuilder]$KMSMasterKeyID ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{encryption=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Body = "<ServerSideEncryptionConfiguration xmlns=`"http://s3.amazonaws.com/doc/2006-03-01/`">" $Body += "<Rule>" $Body += "<ApplyServerSideEncryptionByDefault>" $Body += "<SSEAlgorithm>$SSEAlgorithm</SSEAlgorithm>" if ($KMSMasterKeyID) { $Body += "<KMSMasterKeyID>$KMSMasterKeyID</KMSMasterKeyID>" } $Body += "</ApplyServerSideEncryptionByDefault>" $Body += "</Rule>" $Body += "</ServerSideEncryptionConfiguration>" if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query -RequestPayload $Body if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $Body # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } foreach ($Rule in $Content.ServerSideEncryptionConfiguration.Rule) { $Output = [PSCustomObject]@{SSEAlgorithm=$Rule.ApplyServerSideEncryptionByDefault.SSEAlgorithm; KMSMasterKeyID=$Rule.ApplyServerSideEncryptionByDefault.KMSMasterKeyID} Write-Output $Output } } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Set-S3BucketEncryption -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName -SSEAlgorithm $SSEAlgorithm -KMSMasterKeyID $KMSMasterKeyID } } } } } } <# .SYNOPSIS Remove Bucket Encryption .DESCRIPTION Remove Bucket Encryption .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name #> function Global:Remove-S3BucketEncryption { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "DELETE" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{encryption=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Remove-S3BucketEncryption -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName } } } } } } Set-Alias -Name Get-S3BucketCorsConfigurationRule -Value Get-S3BucketCorsConfiguration Set-Alias -Name Get-S3BucketCors -Value Get-S3BucketCorsConfiguration Set-Alias -Name Get-S3CORSConfiguration -Value Get-S3BucketCorsConfiguration <# .SYNOPSIS Retrieve Bucket CORS Configuration .DESCRIPTION Retrieve Bucket CORS Configuration .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name .PARAMETER Id A unique identifier for the rule. #> function Global:Get-S3BucketCorsConfiguration { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="A unique identifier for the rule.")][ValidateLength(1,255)][String]$Id ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{cors=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } foreach ($Rule in $Content.CORSConfiguration.CORSRule) { $Output = [PSCustomObject]@{ BucketName = $BucketName Id = $Rule.Id AllowedMethod = $Rule.AllowedMethod AllowedOrigin = $Rule.AllowedOrigin AllowedHeader = $Rule.AllowedHeader MaxAgeSeconds = $Rule.MaxAgeSeconds ExposeHeader = $Rule.ExposeHeader } if (!$Id -or ($Id -and $Output.Id -match $Id)) { Write-Output $Output } } } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Get-S3BucketEncryption -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName } elseif ($_.Exception.Response.StatusCode -ne [System.Net.HttpStatusCode]::NotFound) { Throw $_ } } } } } } Set-Alias -Name Add-S3BucketCorsConfiguration -Value Add-S3BucketCorsConfigurationRule Set-Alias -Name Write-S3CorsConfiguration -Value Add-S3BucketCorsConfigurationRule Set-Alias -Name Add-S3BucketCorsRule -Value Add-S3BucketCorsConfigurationRule <# .SYNOPSIS Add Bucket CORS Configuration Rule .DESCRIPTION Add Bucket CORS Configuration Rule .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name .PARAMETER Id A unique identifier for the rule. .PARAMETER AllowedMethods The HTTP methods the origin shall be allowed to execute. .PARAMETER AllowedOrigins Origins which shall be allowed to execute. .PARAMETER AllowedHeaders Specifies which headers are allowed in a pre-flight OPTIONS request via the Access-Control-Request-Headers header. .PARAMETER MaxAgeSeconds The time in seconds that the browser is to cache the preflight response for the specified resource. .PARAMETER ExposeHeaders One or more headers in the response that the client is able to access from his applications (for example, from a JavaScript XMLHttpRequest object). #> function Global:Add-S3BucketCorsConfigurationRule { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="A unique identifier for the rule.")][ValidateLength(1,255)][String]$Id, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="The HTTP methods the origin shall be allowed to execute.")][ValidateSet("GET", "PUT", "HEAD", "POST", "DELETE")][Alias("AllowedMethod")][String[]]$AllowedMethods, [parameter( Mandatory=$True, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Origins which shall be allowed to execute.")][Alias("AllowedOrigin")][String[]]$AllowedOrigins, [parameter( Mandatory=$False, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="Specifies which headers are allowed in a pre-flight OPTIONS request via the Access-Control-Request-Headers header.")][Alias("AllowedHeader")][String[]]$AllowedHeaders, [parameter( Mandatory=$False, Position=15, ValueFromPipelineByPropertyName=$True, HelpMessage="The time in seconds that the browser is to cache the preflight response for the specified resource.")][Int]$MaxAgeSeconds, [parameter( Mandatory=$False, Position=16, ValueFromPipelineByPropertyName=$True, HelpMessage="One or more headers in the response that the client is able to access from his applications (for example, from a JavaScript XMLHttpRequest object).")][Alias("ExposeHeader")][String[]]$ExposeHeaders ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{cors=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $CorsConfigurationRules = @() $CorsConfigurationRules += Get-S3BucketCorsConfiguration -Server $Server -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -UrlStyle $UrlStyle -BucketName $BucketName $CorsConfigurationRule = [PSCustomObject]@{ ID = $Id AllowedMethod = $AllowedMethods AllowedOrigin = $AllowedOrigins AllowedHeader = $AllowedHeaders MaxAgeSeconds = $MaxAgeSeconds ExposeHeader = $ExposeHeaders } $CorsConfigurationRules += $CorsConfigurationRule $Body = "<CORSConfiguration>" foreach ($CorsConfigurationRule in $CorsConfigurationRules) { $Body += "<CORSRule>" if ($CorsConfigurationRule.Id) { $Body += "<ID>$($CorsConfigurationRule.Id)</ID>" } foreach ($AllowedMethod in $CorsConfigurationRule.AllowedMethod) { $Body += "<AllowedMethod>$AllowedMethod</AllowedMethod>" } foreach ($AllowedOrigin in $CorsConfigurationRule.AllowedOrigin) { $Body += "<AllowedOrigin>$AllowedOrigin</AllowedOrigin>" } foreach ($AllowedHeader in $CorsConfigurationRule.AllowedHeader) { $Body += "<AllowedHeader>$AllowedHeader</AllowedHeader>" } if ($MaxAgeSeconds) { $Body += "<MaxAgeSeconds>$($CorsConfigurationRule.MaxAgeSeconds)</MaxAgeSeconds>" } foreach ($ExposeHeader in $CorsConfigurationRule.ExposeHeader) { $Body += "<ExposeHeader>$ExposeHeader</ExposeHeader>" } $Body += "</CORSRule>" } $Body += "</CORSConfiguration>" Write-Verbose "Body:`n$Body" if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query -RequestPayload $Body if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $Body } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Set-S3BucketEncryption -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName -SSEAlgorithm $SSEAlgorithm -KMSMasterKeyID $KMSMasterKeyID } else { throw $_ } } } } } } <# .SYNOPSIS Remove Bucket CORS Configuration Rule .DESCRIPTION Remove Bucket CORS Configuration Rule .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name .PARAMETER Id A unique identifier for the rule. #> function Global:Remove-S3BucketCorsConfigurationRule { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="A unique identifier for the rule.")][ValidateLength(1,255)][String]$Id ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } # get all rules $CorsConfigurationRules = Get-S3BucketCorsConfiguration -Server $Server -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -UrlStyle $UrlStyle -BucketName $BucketName if (!($CorsConfigurationRules | Where-Object { $_.Id -eq $Id })) { Write-Warning "CORS Configuration Rule ID $Id does not exist" break } # remove the rule with the specified ID $CorsConfigurationRules = $CorsConfigurationRules | Where-Object { $_.Id -ne $Id } Remove-S3BucketCorsConfiguration -Server $Server -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -UrlStyle $UrlStyle -BucketName $BucketName # write all rules $CorsConfigurationRules | Add-S3BucketCorsConfigurationRule -Server $Server -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -UrlStyle $UrlStyle -BucketName $BucketName } } Set-Alias -Name Remove-S3BucketCors -Value Remove-S3BucketCorsConfiguration Set-Alias -Name Remove-S3CORSConfiguration -Value Remove-S3BucketCorsConfiguration <# .SYNOPSIS Remove Bucket CORS Configuration .DESCRIPTION Remove Bucket CORS Configuration .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER UseDualstackEndpoint Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values. .PARAMETER Region Bucket Region .PARAMETER BucketName Bucket Name #> function Global:Remove-S3BucketCorsConfiguration { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "DELETE" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{cors=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($Config) { $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ($CheckAllRegions.IsPresent -and [int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Get-S3BucketEncryption -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName } elseif ($_.Exception.Response.StatusCode -ne [System.Net.HttpStatusCode]::NotFound) { Throw $_ } } } } } } <# .SYNOPSIS Get S3 Bucket ACL .DESCRIPTION Get S3 Bucket ACL #> function Global:Get-S3BucketPolicy { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{policy=""} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Query $Query -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop Write-Output $Result.Content } } } Set-Alias -Name Add-S3BucketPolicy -Value Set-S3BucketPolicy Set-Alias -Name Write-S3BucketPolicy -Value Set-S3BucketPolicy <# .SYNOPSIS Replace S3 Bucket ACL .DESCRIPTION Replace S3 Bucket ACL #> function Global:Set-S3BucketPolicy { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="The bucket policy as a JSON document")][String]$Policy ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{policy=""} # pretty print JSON to simplify debugging $Policy = ConvertFrom-Json -InputObject $Policy | ConvertTo-Json -Depth 10 $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Query $Query -Region $Region -RequestPayload $Policy if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $Policy -ErrorAction Stop Write-Output $Result.Content } } } <# .SYNOPSIS Get S3 Bucket Versioning .DESCRIPTION Get S3 Bucket Versioning #> function Global:Get-S3BucketVersioning { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{versioning=""} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Query $Query -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } Write-Output $Content.VersioningConfiguration.Status } } } <# .SYNOPSIS Enable S3 Bucket Versioning .DESCRIPTION Enable S3 Bucket Versioning #> function Global:Enable-S3BucketVersioning { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{versioning=""} $RequestPayload = "<VersioningConfiguration xmlns=`"http://s3.amazonaws.com/doc/2006-03-01/`"><Status>Enabled</Status></VersioningConfiguration>" $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Query $Query -Bucket $BucketName -UrlStyle $UrlStyle -RequestPayload $RequestPayload -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $RequestPayload -ErrorAction Stop # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } Write-Output $Content.VersioningConfiguration.Status } } } <# .SYNOPSIS Suspend S3 Bucket Versioning .DESCRIPTION Suspend S3 Bucket Versioning #> function Global:Suspend-S3BucketVersioning { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{versioning=""} $RequestPayload = "<VersioningConfiguration xmlns=`"http://s3.amazonaws.com/doc/2006-03-01/`"><Status>Suspended</Status></VersioningConfiguration>" $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Query $Query -Bucket $BucketName -UrlStyle $UrlStyle -RequestPayload $RequestPayload -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $RequestPayload -ErrorAction Stop # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } Write-Output $Content.VersioningConfiguration.Status } } } Set-Alias -Name Get-S3BucketRegion -Value Get-S3BucketLocation <# .SYNOPSIS Get S3 Bucket Location .DESCRIPTION Get S3 Bucket Location #> function Global:Get-S3BucketLocation { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=9, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } Write-Verbose "Retrieving location for bucket $BucketName" # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/" $Query = @{location=""} # location requests must use path style, as virtual-host style will fail if the bucket is not in the same region as the request $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -UrlStyle "path" if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop # it seems AWS is sometimes not sending the Content-Type and then PowerShell does not parse the binary to string if (!$Result.Headers.'Content-Type') { $Content = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) } else { $Content = [XML]$Result.Content } $Location = $Content.LocationConstraint.InnerText if (!$Location) { # if no location is returned, bucket is in default region us-east-1 Write-Output "us-east-1" } else { Write-Output $Content.LocationConstraint.InnerText } } } } <# .SYNOPSIS Get S3 active Multipart Uploads for Bucket .DESCRIPTION Get S3 active Multipart Uploads for Bucket #> function Global:Get-S3MultipartUploads { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL. This Cmdlet always uses presigned URLs for best performance.")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=9, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$False, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=12, HelpMessage="Lists in-progress uploads only for those keys that begin with the specified prefix")][String]$Prefix, [parameter( Mandatory=$False, Position=13, HelpMessage="Encoding type (Only allowed value is url).")][String][ValidateSet("url")]$EncodingType="url", [parameter( Mandatory=$False, Position=14, HelpMessage="Maximum Number of parts to return")][Int][ValidateRange(0,1000)]$MaxUploads=0, [parameter( Mandatory=$False, Position=15, HelpMessage="Continuation part number marker")][String]$KeyMarker, [parameter( Mandatory=$False, Position=16, HelpMessage="Continuation part number marker")][String]$UploadIdMarker ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{uploads=""} if ($EncodingType) { $Query["encoding-type"] = $EncodingType } if ($MaxUploads -ge 1) { $Query["max-uploads"] = $MaxUploads } if ($KeyMarker) { $Query["key-marker"] = $KeyMarker } if ($UploadIdMarker) { $Query["upload-id-​marker"] = $UploadIdMarker } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML][System.Net.WebUtility]::UrlDecode($Result.Content) $UnicodeBucket = [System.Globalization.IdnMapping]::new().GetUnicode($Content.ListMultipartUploadsResult.Bucket) foreach ($Upload in $Content.ListMultipartUploadsResult.Upload) { $Upload = [PSCustomObject]@{BucketName=$UnicodeBucket; Key=$Upload.Key; UploadId=$Upload.UploadId; InitiatorId=$Upload.Initiator.Id; InitiatorDisplayName=$Upload.Initiator.DisplayName; OwnerId=$Upload.Owner.Id; OwnerDisplayName=$Upload.Owner.DisplayName; StorageClass=$Upload.StorageClass; Initiated=$Upload.Initiated} Write-Output $Upload } if ($Content.ListMultipartUploadsResult.IsTruncated -eq "true" -and $MaxUploads -eq 0) { Write-Verbose "1000 Uploads were returned and max uploads was not limited so continuing to get all uploads" Write-Debug "NextKeyMarker: $($Content.ListMultipartUploadsResult.NextKeyMarker)" Write-Debug "NextUploadIdMarker: $($Content.ListMultipartUploadsResult.NextUploadIdMarker)" Get-S3MultipartUploads -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -EndpointUrl $Config.EndpointUrl -Region $Region -SkipCertificateCheck:$Config.SkipCertificateCheck -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint -Bucket $BucketName -MaxUploads $MaxUploads -KeyMarker $Content.ListMultipartUploadsResult.NextKeyMarker -UploadIdMarker $Content.ListMultipartUploadsResult.UploadIdMarker } } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ([int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Get-S3MultipartUploads -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint -Bucket $BucketName -MaxUploads $MaxUploads -KeyMarker $Content.ListMultipartUploadsResult.NextKeyMarker -UploadIdMarker $Content.ListMultipartUploadsResult.UploadIdMarker -EncodingType $EncodingType } else { Throw $_ } } } } } ## Objects ## Set-Alias -Name Get-S3Object -Value Get-S3Objects <# .SYNOPSIS Get S3 Objects in Bucket .DESCRIPTION Get S3 Objects in Bucket #> function Global:Get-S3Objects { [CmdletBinding(DefaultParameterSetName="account")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=10, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=11, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=12, HelpMessage="Maximum Number of keys to return")][Int][ValidateRange(0,1000)]$MaxKeys=0, [parameter( Mandatory=$False, Position=13, HelpMessage="Bucket prefix for filtering")][Alias("Key")][String]$Prefix, [parameter( Mandatory=$False, Position=14, HelpMessage="Bucket prefix for filtering")][String]$Delimiter, [parameter( Mandatory=$False, Position=15, HelpMessage="Return Owner information (Only valid for list type 2).")][Switch]$FetchOwner=$False, [parameter( Mandatory=$False, Position=16, HelpMessage="Return key names after a specific object key in your key space. The S3 service lists objects in UTF-8 character encoding in lexicographical order (Only valid for list type 2).")][String]$StartAfter, [parameter( Mandatory=$False, Position=17, HelpMessage="Continuation token (Only valid for list type 1).")][String]$Marker, [parameter( Mandatory=$False, Position=18, HelpMessage="Continuation token (Only valid for list type 2).")][String]$ContinuationToken, [parameter( Mandatory=$False, Position=19, HelpMessage="Encoding type (Only allowed value is url).")][String][ValidateSet("url")]$EncodingType="url", [parameter( Mandatory=$False, Position=20, HelpMessage="Bucket list type.")][String][ValidateSet(1,2)]$ListType=1 ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Method = "GET" $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Config) { Throw "No S3 credentials found" } if (!$Region) { $Region = $Config.Region } $Query = @{} if ($Delimiter) { $Query["delimiter"] = $Delimiter } if ($EncodingType) { $Query["encoding-type"] = $EncodingType } if ($MaxKeys -ge 1) { $Query["max-keys"] = $MaxKeys } if ($Prefix) { $Query["prefix"] = $Prefix } # S3 supports two types for listing buckets, but only v2 is recommended, thus using list-type=2 query parameter if ($ListType -eq 1) { if ($Marker) { $Query["marker"] = $Marker } } else { $Query["list-type"] = 2 if ($FetchOwner) { $Query["fetch-owner"] = $FetchOwner } if ($StartAfter) { $Query["start-after"] = $StartAfter } if ($ContinuationToken) { $Query["continuation-token"] = $ContinuationToken } } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region -Query $Query -UseDualstackEndpoint:$UseDualstackEndpoint if ($DryRun) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML][System.Net.WebUtility]::UrlDecode($Result.Content) $Objects = $Content.ListBucketResult.Contents | Where-Object { $_ } Write-Verbose "ListBucketResult Name: $($Content.ListBucketResult.Name)" $UnicodeBucket = [System.Globalization.IdnMapping]::new().GetUnicode($Content.ListBucketResult.Name) if ($UnicodeBucket -match $BucketName) { $UnicodeBucket = $BucketName } foreach ($Object in $Objects) { $Object = [PSCustomObject]@{Bucket=$UnicodeBucket;Region=$Region;Key=$Object.Key;LastModified=(Get-Date $Object.LastModified);ETag=($Object.ETag -replace '"','');Size=[long]$Object.Size;OwnerId=$Object.Owner.ID;OwnerDisplayName=$Object.Owner.DisplayName;StorageClass=$Object.StorageClass} Write-Output $Object } if ($Content.ListBucketResult.IsTruncated -eq "true" -and $MaxKeys -eq 0) { Write-Verbose "1000 Objects were returned and max keys was not limited so continuing to get all objects" Write-Debug "NextMarker: $($Content.ListBucketResult.NextMarker)" Get-S3Objects -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -EndpointUrl $Config.EndpointUrl -Region $Region -SkipCertificateCheck:$Config.SkipCertificateCheck -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint -Bucket $BucketName -MaxKeys $MaxKeys -Prefix $Prefix -FetchOwner:$FetchOwner -StartAfter $StartAfter -ContinuationToken $Content.ListBucketResult.NextContinuationToken -Marker $Content.ListBucketResult.NextMarker } } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ([int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Get-S3Objects -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint -Bucket $BucketName -MaxKeys $MaxKeys -Prefix $Prefix -Delimiter $Delimiter -FetchOwner:$FetchOwner -StartAfter $StartAfter -Marker $Marker -ContinuationToken $ContinuationToken -EncodingType $EncodingType } else { Throw $_ } } } } } Set-Alias -Name Get-S3Version -Value Get-S3ObjectVersions Set-Alias -Name Get-S3Versions -Value Get-S3ObjectVersions <# .SYNOPSIS Get S3 Object Versions .DESCRIPTION Get S3 Object Versions #> function Global:Get-S3ObjectVersions { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=10, HelpMessage="Maximum Number of keys to return")][Int][ValidateRange(0,1000)]$MaxKeys=0, [parameter( Mandatory=$False, Position=11, HelpMessage="Bucket prefix for filtering")][String]$Prefix, [parameter( Mandatory=$False, Position=12, HelpMessage="Bucket prefix for filtering")][String][ValidateLength(1,1)]$Delimiter, [parameter( Mandatory=$False, Position=13, HelpMessage="Continuation token for keys.")][String]$KeyMarker, [parameter( Mandatory=$False, Position=14, HelpMessage="Continuation token for versions.")][String]$VersionIdMarker, [parameter( Mandatory=$False, Position=15, HelpMessage="Encoding type (Only allowed value is url).")][String][ValidateSet("url")]$EncodingType="url" ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } $Query = @{versions=""} # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($Delimiter) { $Query["delimiter"] = $Delimiter } if ($EncodingType) { $Query["encoding-type"] = $EncodingType } if ($MaxKeys -ge 1) { $Query["max-keys"] = $MaxKeys } if ($Prefix) { $Query["prefix"] = $Prefix } if ($KeyMarker) { $Query["key-marker"] = $KeyMarker } if ($VersionIdMarker) { $Query["version-id-marker"] = $VersionIdMarker } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Query $Query -Bucket $BucketName -UrlStyle $UrlStyle -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML]$Result.Content $Versions = $Content.ListVersionsResult.Version | Where-Object { $_ } $Versions | Add-Member -MemberType NoteProperty -Name Type -Value "Version" $DeleteMarkers = $Content.ListVersionsResult.DeleteMarker | Where-Object { $_ } $DeleteMarkers | Add-Member -MemberType NoteProperty -Name Type -Value "DeleteMarker" $Versions += $DeleteMarkers foreach ($Version in $Versions) { $Version | Add-Member -MemberType NoteProperty -Name OwnerId -Value $Version.Owner.Id $Version | Add-Member -MemberType NoteProperty -Name OwnerDisplayName -Value $Version.Owner.DisplayName $Version | Add-Member -MemberType NoteProperty -Name Region -Value $Region $Version.PSObject.Members.Remove("Owner") } $Versions | Add-Member -MemberType NoteProperty -Name Bucket -Value $Content.ListVersionsResult.Name Write-Output $Versions if ($Content.ListVersionsResult.IsTruncated -eq "true" -and $MaxKeys -eq 0) { Write-Verbose "1000 Versions were returned and max keys was not limited so continuing to get all Versions" Get-S3BucketVersions -Server $Server -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -EndpointUrl $Config.EndpointUrl -Region $Region -UrlStyle $UrlStyle -Bucket $BucketName -MaxKeys $MaxKeys -Prefix $Prefix -KeyMarker $Content.ListVersionsResult.NextKeyMarker -VersionIdMarker $Content.ListVersionsResult.NextVersionIdMarker } } } } <# .SYNOPSIS Get S3 Presigned URL .DESCRIPTION Get S3 Presigned URL #> function Global:Get-S3PresignedUrl { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=4, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=5, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=5, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=5, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=7, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=9, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object version ID")][String]$VersionId, [parameter( Mandatory=$False, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Metadata")][Hashtable]$Metadata, [parameter( Mandatory=$False, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Expiration Date of presigned URL (default 60 minutes from now)")][System.Datetime]$Expires=(Get-Date).AddHours(1), [parameter( Mandatory=$False, Position=14, HelpMessage="HTTP Request Method")][ValidateSet("OPTIONS","GET","HEAD","PUT","DELETE","TRACE","CONNECT")][String]$Method="GET" ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $Presign = $true if ($VersionId) { $Query = @{versionId=$VersionId} } else { $Query = @{} } if ($Metadata) { foreach ($Key in $Metadata.Keys) { $Key = $Key -replace "^x-amz-meta-","" $Query["x-amz-meta-$Key"] = $Metadata[$Key] } } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region -Expires $Expires Write-Output $AwsRequest.Uri.ToString() } } <# .SYNOPSIS Get S3 Object .DESCRIPTION Get S3 Object #> function Global:Get-S3ObjectMetadata { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$False, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Object version ID")][String]$VersionId ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "HEAD" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" if ($VersionId) { $Query = @{versionId=$VersionId} } else { $Query = @{} } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Headers = $Result.Headers $Metadata = @{} $CustomMetadata = @{} foreach ($MetadataKey in $Headers.Keys) { $Value = $Headers[$MetadataKey] if ($MetadataKey -match "x-amz-meta-") { $MetadataKey = $MetadataKey -replace "x-amz-meta-","" $CustomMetadata[$MetadataKey] = $Value } $Metadata[$MetadataKey] = $Value } # TODO: Implement missing Metadata $PartCount = ($Headers["ETag"] -split "-")[1] $Output = [PSCustomObject]@{Headers=$Headers; Metadata=$Metadata; CustomMetadata=$CustomMetadata; DeleteMarker=$null; AcceptRanges=$Headers.'Accept-Ranges' | Select-Object -First 1; Expiration=$Headers["x-amz-expiration"] | Select-Object -First 1; RestoreExpiration=$null; RestoreInProgress=$null; LastModified=$Headers.'Last-Modified' | Select-Object -First 1; ETag=$Headers.ETag -replace '"','' | Select-Object -First 1; MissingMeta=[int]$Headers["x-amz-missing-meta"] | Select-Object -First 1; VersionId=$Headers["x-amz-version-id"] | Select-Object -First 1; Expires=$null; WebsiteRedirectLocation=$null; ServerSideEncryptionMethod=$Headers["x-amz-server-side​-encryption"] | Select-Object -First 1; ServerSideEncryptionCustomerMethod=$Headers["x-amz-server-side​-encryption​-customer-algorithm"] | Select-Object -First 1; ServerSideEncryptionKeyManagementServiceKeyId=$Headers["x-amz-server-side-encryption-aws-kms-key-id"] | Select-Object -First 1; ReplicationStatus=$Headers["x-amz-replication-status"] | Select-Object -First 1; PartsCount=$PartCount; StorageClass=$Headers["x-amz-storage-class"] | Select-Object -First 1; } Write-Output $Output } } } Set-Alias -Name Get-S3Object -Value Read-S3Object <# .SYNOPSIS Read an S3 Object .DESCRIPTION Read an S3 Object #> function Global:Read-S3Object { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$False, Position=12, HelpMessage="Byte range to retrieve from object")][String]$Range, [parameter( Mandatory=$False, Position=13, HelpMessage="Path where object should be stored")][Alias("OutFile")][String]$Path ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $Headers = @{} if ($Range) { $Headers["Range"] = $Range } if ($Path) { $DirectoryPath = [System.IO.DirectoryInfo]$Path if ($DirectoryPath.Exists) { $Item = Get-Item $DirectoryPath if ($Item -is [FileInfo]) { $OutFile = $Item } else { $OutFile = Join-Path -Path $DirectoryPath -ChildPath $Key } } elseif ($DirectoryPath.Parent.Exists) { $OutFile = $DirectoryPath } else { Throw "Path $DirectoryPath does not exist and parent directory $($DirectoryPath.Parent) also does not exist" } } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -OutFile $OutFile -ErrorAction Stop Write-Output $Result.Content } } } <# .SYNOPSIS Write S3 Object .DESCRIPTION Write S3 Object #> function Global:Write-S3Object { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="ProfileAndFile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")] [parameter( ParameterSetName="ProfileAndContent", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="KeyAndFile", Mandatory=$True, Position=6, HelpMessage="S3 Access Key")] [parameter( ParameterSetName="KeyAndContent", Mandatory=$True, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="KeyAndFile", Mandatory=$True, Position=7, HelpMessage="S3 Secret Access Key")] [parameter( ParameterSetName="KeyAndContent", Mandatory=$True, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="AccountAndFile", Mandatory=$True, Position=6, HelpMessage="StorageGRID account ID to execute this command against")] [parameter( ParameterSetName="AccountAndContent", Mandatory=$True, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=11, ParameterSetName="ProfileAndFile", ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")] [parameter( Mandatory=$False, Position=11, ParameterSetName="KeyAndFile", ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")] [parameter( Mandatory=$False, Position=11, ParameterSetName="AccountAndFile", ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")] [parameter( Mandatory=$True, Position=11, ParameterSetName="ProfileAndContent", ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")] [parameter( Mandatory=$True, Position=11, ParameterSetName="KeyAndContent", ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")] [parameter( Mandatory=$True, Position=11, ParameterSetName="AccountAndContent", ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=12, ParameterSetName="ProfileAndFile", HelpMessage="Path where object should be stored")] [parameter( Mandatory=$True, Position=12, ParameterSetName="KeyAndFile", HelpMessage="Path where object should be stored")] [parameter( Mandatory=$True, Position=12, ParameterSetName="AccountAndFile", HelpMessage="Path where object should be stored")][Alias("Path","File")][System.IO.FileInfo]$InFile, [parameter( Mandatory=$True, Position=13, ParameterSetName="ProfileAndContent", HelpMessage="Content of object")] [parameter( Mandatory=$True, Position=13, ParameterSetName="KeyAndContent", HelpMessage="Content of object")] [parameter( Mandatory=$True, Position=13, ParameterSetName="AccountAndContent", HelpMessage="Content of object")][Alias("InputObject")][String]$Content, [parameter( Mandatory=$False, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="Metadata")][Hashtable]$Metadata ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } if ($InFile -and !$InFile.Exists) { Throw "File $InFile does not exist" } if (!$Key) { $Key = $InFile.Name } # if the file size is larger than the multipart threshold, then a multipart upload should be done if (!$Content -and $Config.MultipartThreshold -and $InFile.Length -ge $Config.MultipartThreshold) { Write-Verbose "Using multipart upload as file is larger than multipart threshold of $($Config.MultipartThreshold)" Write-S3MultipartUpload -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -UrlStyle $UrlStyle -BucketName $BucketName -Key $Key -InFile $InFile -Metadata $Metadata } # if the file size is larger than 5GB multipart upload must be used as PUT Object is only allowed up to 5GB files if ($InFile.Length -gt 5GB) { Write-Warning "Using multipart upload as PUT uploads are only allowed for files smaller than 5GB and file is larger than 5GB." Write-S3MultipartUpload -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -UrlStyle $UrlStyle -BucketName $BucketName -Key $Key -InFile $InFile -Metadata $Metadata } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } # TODO: Check MIME type of file if (!$InFile) { $ContentType = "text/plain" } $Headers = @{} if ($Metadata) { foreach ($MetadataKey in $Metadata.Keys) { $MetadataKey = $MetadataKey -replace "^x-amz-meta-","" $MetadataKey = $MetadataKey.toLower() $Headers["x-amz-meta-$MetadataKey"] = $Metadata[$MetadataKey] # TODO: check that metadata is valid HTTP Header } } Write-Verbose "Metadata:`n$($Headers | ConvertTo-Json)" $Uri = "/$Key" $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region -InFile $InFile -RequestPayload $Content -ContentType $ContentType -Headers $Headers if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -InFile $InFile -Body $Content -ContentType $ContentType } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ([int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." if ($InFile) { Write-S3Object -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName -Key $Key -InFile $InFile -Metadata $Metadata } else { Write-S3Object -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName -Key $Key -Content $Content -Metadata $Metadata } } else { Throw $_ } } Write-Output $Result.Content } } } <# .SYNOPSIS Initiate Multipart Upload .DESCRIPTION Initiate Multipart Upload .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER BucketName Bucket Name .PARAMETER Key Object key .PARAMETER Metadata Metadata #> function Global:Start-S3MultipartUpload { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket Region")][Alias("Location","LocationConstraint")][String]$Region, [parameter( Mandatory=$False, Position=10, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$False, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Metadata")][Hashtable]$Metadata ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "POST" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Config) { Throw "No S3 credentials found" } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Headers = @{} if ($Metadata) { foreach ($MetadataKey in $Metadata.Keys) { $MetadataKey = $MetadataKey -replace "^x-amz-meta-","" $MetadataKey = $MetadataKey.toLower() $Headers["x-amz-meta-$MetadataKey"] = $Metadata[$MetadataKey] # TODO: check that metadata is valid HTTP Header } } Write-Verbose "Metadata:`n$($Headers | ConvertTo-Json)" $Uri = "/$Key" $Query = @{uploads=""} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -RequestPayload $RequestPayload -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint -Uri $Uri -Headers $Headers -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $RequestPayload -ErrorAction Stop $Xml = [XML][System.Text.Encoding]::UTF8.GetString($Result.RawContentStream.ToArray()) $Content = $Xml.InitiateMultipartUploadResult $InitiateMultipartUploadResult = [PSCustomObject]@{Bucket=$Content.Bucket;Key=$Content.Key;UploadId=$Content.UploadId} Write-Output $InitiateMultipartUploadResult } } } <# .SYNOPSIS Abort Multipart Upload .DESCRIPTION Abort Multipart Upload .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER BucketName Bucket Name .PARAMETER Key Object key #> function Global:Stop-S3MultipartUpload { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket Region")][Alias("Location","LocationConstraint")][String]$Region, [parameter( Mandatory=$False, Position=10, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Multipart Upload ID")][String]$UploadId ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Method = "DELETE" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck if (!$Config) { Throw "No S3 credentials found" } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $Query = @{uploadId=$uploadId} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -RequestPayload $RequestPayload -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint -Uri $Uri -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } <# .SYNOPSIS Complete Multipart Upload .DESCRIPTION Complete Multipart Upload .PARAMETER Server StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used. .PARAMETER SkipCertificateCheck Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc. .PARAMETER Presign Use presigned URL .PARAMETER DryRun Do not execute request, just return request URI and Headers .PARAMETER SignerType AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication) .PARAMETER EndpointUrl Custom S3 Endpoint URL .PARAMETER ProfileName AWS Profile to use which contains AWS sredentials and settings .PARAMETER ProfileLocation AWS Profile location if different than .aws/credentials .PARAMETER AccessKey S3 Access Key .PARAMETER SecretKey S3 Secret Access Key .PARAMETER AccountId StorageGRID account ID to execute this command against .PARAMETER UrlStyle URL Style (Default: Auto) .PARAMETER BucketName Bucket Name .PARAMETER Key Object key #> function Global:Complete-S3MultipartUpload { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket Region")][Alias("Location","LocationConstraint")][String]$Region, [parameter( Mandatory=$False, Position=10, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Multipart Upload ID")][String]$UploadId, [parameter( Mandatory=$True, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Part Etags in the format partNumber=ETag")][System.Collections.Generic.SortedDictionary[int, string]]$Etags ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "POST" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Config) { Throw "No S3 credentials found" } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $RequestPayload = "<CompleteMultipartUpload xmlns=`"http://s3.amazonaws.com/doc/2006-03-01/`">" foreach ($Part in $Etags.Keys) { $RequestPayload += "<Part><ETag>$( $Etags[$Part] )</ETag><PartNumber>$Part</PartNumber></Part>" } $RequestPayload += "</CompleteMultipartUpload>" $Query = @{uploadId=$uploadId} $ContentType = "application/xml" $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Presign:$Presign -SignerType $SignerType -Bucket $BucketName -UrlStyle $UrlStyle -RequestPayload $RequestPayload -ContentType $ContentType -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint -Uri $Uri -Query $Query if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -Body $RequestPayload -ErrorAction Stop $Content = [XML][System.Net.WebUtility]::UrlDecode($Result.Content) $CompleteMultipartUploadResult = [PSCustomObject]@{ Location=$Content.CompleteMultipartUploadResult.Location; BucketName=$Content.CompleteMultipartUploadResult.Bucket; Key=$Content.CompleteMultipartUploadResult.Key; ETag=$Content.CompleteMultipartUploadResult.ETag} Write-Output $CompleteMultipartUploadResult } } } Set-Alias -Name Invoke-S3MultipartUpload -Value Write-S3MultipartUpload <# .SYNOPSIS Write S3 Object as Multipart Upload .DESCRIPTION Write S3 Object as Multipart Upload #> function Global:Write-S3MultipartUpload { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$True, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$True, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$True, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$True, Position=6, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$False, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key. If not provided, filename will be used")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=12, HelpMessage="Path where object should be stored")][Alias("Path","File")][System.IO.FileInfo]$InFile, [parameter( Mandatory=$False, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Metadata")][Hashtable]$Metadata, [parameter( Mandatory=$False, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="The maximum number of concurrent requests")][Alias("max_concurrent_requests")][UInt16]$MaxConcurrentRequests, [parameter( Mandatory=$False, Position=15, ValueFromPipelineByPropertyName=$True, HelpMessage="Multipart Part Chunksize")][ValidateRange(1,5GB)][int64]$Chunksize ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -MaxConcurrentRequests $MaxConcurrentRequests -MultipartChunksize $Chunksize -SkipCertificateCheck:$SkipCertificateCheck } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -MaxConcurrentRequests $MaxConcurrentRequests -MultipartChunksize $Chunksize -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } if ($InFile -and !$InFile.Exists) { Throw "File $InFile does not exist" } # TODO: Check MIME type of file if (!$Key) { $Key = $InFile.Name } $FileSize = $InFile.Length if ($Config.MaxConcurrentRequests) { $MaxRunspaces = $Config.MaxConcurrentRequests } else { $MaxRunspaces = [Environment]::ProcessorCount } Write-Verbose "Uploading maximum $MaxRunspaces parts in parallel" if ($Config.MultipartChunksize -gt 0) { # Chunksize must be at least 1/1000 of the file size, as max 1000 parts are allowed if (($FileSize / $Config.MultipartChunksize) -le 1000) { # division by one necessary as we need to convert string in number format (e.g. 16MB) to integer $Chunksize = ($Config.MultipartChunksize/ 1) } } if (!$Chunksize) { # S3 only allows 1000 parts, therefore we need to set the chunksize to something larger than 1GB if ($FileSize -gt 1TB) { $Chunksize = [Math]::Pow(2,[Math]::Ceiling([Math]::Log($FileSize/1000)/[Math]::Log(2))) } elseif ($FileSize -gt ([int64]$MaxRunspaces * 1GB)) { # chunksize of 1GB is optimal for fast, lossless connections which we assume $Chunksize = 1GB } elseif (($FileSize / $MaxRunspaces) -ge 8MB) { # if filesize is smaller than max number of runspaces times 1GB # then we need to make sure that we reduce the chunksize so that all runspaces are used $Chunksize = [Math]::Pow(2,[Math]::Floor([Math]::Log($FileSize/$MaxRunspaces)/[Math]::Log(2))) } else { # minimum chunksize for S3 is 5MB $Chunksize = 5MB } } Write-Verbose "Chunksize of $($Chunksize/1MB)MB will be used" $PartCount = [Math]::Ceiling($FileSize / $ChunkSize) Write-Verbose "File will be uploaded in $PartCount parts" Write-Verbose "Initiating Multipart Upload" $MultipartUpload = Start-S3MultipartUpload -SkipCertificateCheck:$Config.SkipCertificateCheck -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -Region $Region -BucketName $BucketName -Key $Key -Metadata $Metadata Write-Verbose "Multipart Upload ID: $($MultipartUpload.UploadId)" try { Write-Verbose "Initializing Runspace Pool" $CancellationTokenSource = [System.Threading.CancellationTokenSource]::new() $CancellationToken = $CancellationTokenSource.Token $CancellationTokenVariable = [System.Management.Automation.Runspaces.SessionStateVariableEntry]::new('CancellationToken',$CancellationToken,$Null) $PartUploadProgress = [Hashtable]::Synchronized(@{}) $PartUploadProgressVariable = [System.Management.Automation.Runspaces.SessionStateVariableEntry]::new('PartUploadProgress',$PartUploadProgress,$Null) $InitialSessionState = [System.Management.Automation.Runspaces.InitialSessionState]::CreateDefault() $InitialSessionState.Variables.Add($CancellationTokenVariable) $InitialSessionState.Variables.Add($PartUploadProgressVariable) $RunspacePool = [runspacefactory]::CreateRunspacePool(1, $MaxRunspaces, $InitialSessionState, $Host) $RunspacePool.Open() Write-Verbose "Initializing Memory Mapped File" $MemoryMappedFile = [System.IO.MemoryMappedFiles.MemoryMappedFile]::CreateFromFile($InFile, [System.IO.FileMode]::Open) Write-Verbose "Initializing Part Upload Jobs" $Etags = New-Object 'System.Collections.Generic.SortedDictionary[int, string]' $Jobs = New-Object System.Collections.ArrayList foreach ($PartNumber in 1..$PartCount) { $Runspace = [PowerShell]::Create() $Runspace.RunspacePool = $RunspacePool [void]$Runspace.AddScript({ Param ( [parameter( Mandatory=$True, Position=0, HelpMessage="Content Stream")][System.IO.Stream]$Stream, [parameter( Mandatory=$True, Position=1, HelpMessage="Request URI")][Uri]$Uri, [parameter( Mandatory=$True, Position=2, HelpMessage="Request Headers")][Hashtable]$Headers, [parameter( Mandatory=$True, Position=3, HelpMessage="Part number")][Int]$PartNumber, [parameter( Mandatory=$False, Position=4, HelpMessage="Skip Certificate Check")][Boolean]$SkipCertificateCheck ) if ($SkipCertificateCheck -and $PSVersionTable.PSVersion.Major -lt 6) { Add-Type @" using System.Net; using System.Security.Cryptography.X509Certificates; public class TrustAllCertsPolicy : ICertificatePolicy { public bool CheckValidationResult( ServicePoint srvPoint, X509Certificate certificate, WebRequest request, int certificateProblem) { return true; } } "@ [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy } elseif ($SkipCertificateCheck) { $HttpClientHandler = [System.Net.Http.HttpClientHandler]::new() $HttpClientHandler.ServerCertificateCustomValidationCallback = [System.Net.Http.HttpClientHandler]::DangerousAcceptAnyServerCertificateValidator } else { $HttpClientHandler = [System.Net.Http.HttpClientHandler]::new() } # using CryptoSteam to calculate the MD5 sum while uploading the part # this allows to only read the stream once and increases performance compared with other S3 clients $Md5 = [System.Security.Cryptography.MD5]::Create() $CryptoStream = [System.Security.Cryptography.CryptoStream]::new($Stream, $Md5, [System.Security.Cryptography.CryptoStreamMode]::Read) $HttpClient = [System.Net.Http.HttpClient]::new($HttpClientHandler) # set Timeout proportional to size of data to be uploaded (assuming at least 100 KByte/s) $HttpClient.Timeout = [Timespan]::FromSeconds([Math]::Ceiling($Stream.Length / 1KB / 100)) $PutRequest = [System.Net.Http.HttpRequestMessage]::new([System.Net.Http.HttpMethod]::Put,$Uri) $PutRequest.Headers.Add("Host",$Headers["Host"]) $StreamContent = [System.Net.Http.StreamContent]::new($CryptoStream) $StreamContent.Headers.ContentLength = $Stream.Length $PutRequest.Content = $StreamContent $Response = $HttpClient.SendAsync($PutRequest, $CancellationToken) # TODO: Report progress using stream position while ($Stream.Position -ne $Stream.Length -and !$CancellationToken.IsCancellationRequested -and !$Response.IsCanceled -and !$Response.IsFaulted -and !$Response.IsCompleted) { sleep 0.1 $PartUploadProgress.$PartNumber = $Stream.Position } $Etag = New-Object 'System.Collections.Generic.List[string]' [void]$Response.Result.Headers.TryGetValues("ETag",[ref]$Etag) $Etag = $Etag[0] -replace '"','' $CryptoStream.Dispose() $Md5Sum = [BitConverter]::ToString($Md5.Hash) -replace "-","" if ($Response.Result.StatusCode -ne "OK") { Write-Output $Response } elseif ($Etag -ne $MD5Sum) { $Output = [PSCustomObject]@{Etag=$Etag;MD5Sum=$MD5Sum} Write-Output $Output } else { Write-Output $Etag } $Response.Dispose() $PutRequest.Dispose() $StreamContent.Dispose() $Stream.Dispose() }) if (($PartNumber * $Chunksize) -gt $FileSize) { $ViewSize = $Chunksize - ($PartNumber * $Chunksize - $FileSize) } else { $ViewSize = $Chunksize } Write-Verbose "Creating File view from position $(($PartNumber -1) * $Chunksize) with size $ViewSize" $Stream = $MemoryMappedFile.CreateViewStream(($PartNumber - 1) * $Chunksize,$ViewSize) $AwsRequest = $MultipartUpload | Write-S3ObjectPart -SkipCertificateCheck:$Config.SkipCertificateCheck -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Region -Presign -DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -PartNumber $PartNumber -Stream $Stream $Parameters = @{ Stream = $Stream Uri = $AwsRequest.Uri Headers = $AwsRequest.Headers PartNumber = $PartNumber SkipCertificateCheck = $Config.SkipCertificateCheck } [void]$Runspace.AddParameters($Parameters) $Job = [PSCustomObject]@{ Pipe = $Runspace Status = $Runspace.BeginInvoke() PartNumber = $PartNumber } [void]$Jobs.Add($Job) } $PercentCompleted = 0 Write-Progress -Activity "Uploading file $($InFile.Name) to $BucketName/$Key" -Status "$PercentCompleted% Complete:" -PercentComplete $PercentCompleted $StartTime = Get-Date while ($Jobs.Status -ne $null) { $WrittenBytes = $PartUploadProgress.Clone().Values | Measure-Object -Sum | Select-Object -ExpandProperty Sum $PercentCompleted = [Math]::Floor($WrittenBytes / $InFile.Length * 10000) / 100 $Throughput = $WrittenBytes / ((Get-Date) - $StartTime).TotalSeconds / 1MB Write-Progress -Activity "Uploading file $($InFile.Name) to $BucketName/$Key" -Status "$PercentCompleted% Complete / $Throughput MiB/s" -PercentComplete $PercentCompleted sleep 1 $CompletedJobs = $Jobs | Where-Object { $_.Status.IsCompleted -eq $true } foreach ($Job in $CompletedJobs) { $Output = $Job.Pipe.EndInvoke($Job.Status) Write-Verbose "Output: $Output" if ($Output[0] -isnot [String]) { Write-Verbose (ConvertTo-Json -InputObject $Output) foreach ($Job in $Jobs) { $CancellationToken = $CancellationTokenSource.Cancel() $Job.Pipe.Stop() } throw "Upload of part $($Job.PartNumber) failed, Multipart Upload aborted" } $Etags[$Job.PartNumber] = $Output Write-Verbose "Part $($Job.PartNumber) has completed with ETag $Output" $Job.Pipe.Dispose() $Job.Status = $null } } } catch { Write-Verbose "Something has gone wrong, aborting Multipart Upload" $MultipartUpload | Stop-S3MultipartUpload -SkipCertificateCheck:$Config.SkipCertificateCheck -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -Region $Region throw } finally { Write-Verbose "Cleaning up" $MemoryMappedFile.Dispose() $RunspacePool.Close() $RunspacePool.Dispose() if ($Jobs.Status -ne $null) { $MultipartUpload | Stop-S3MultipartUpload -SkipCertificateCheck:$Config.SkipCertificateCheck -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -Region $Region } } Write-Progress -Activity "Uploading file $($InFile.Name) to $BucketName/$Key completed" -Completed $MultipartUpload | Complete-S3MultipartUpload -SkipCertificateCheck:$Config.SkipCertificateCheck -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -Region $Region -Etags $Etags } } <# .SYNOPSIS Write S3 Object Part .DESCRIPTION Write S3 Object Part #> function Global:Write-S3ObjectPart { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL. This Cmdlet always uses presigned URLs for best performance.")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Multipart Upload ID")][String]$UploadId, [parameter( Mandatory=$True, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Multipart part number (from 1 to 10000)")][ValidateRange(1,10000)][Int]$PartNumber, [parameter( Mandatory=$True, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="Content Stream")][System.IO.Stream]$Stream ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $Query = @{partNumber=$PartNumber;uploadId=$UploadId} $Headers = @{"Content-Length"=$Stream.Length} # Force Presign because it allows UNSIGNED_PAYLOAD and we do not want # to read the Stream to calculate a signature before uploading it for performance reasons # We also do not use Content-MD5 header because we only calculate the MD5 sum during the upload # again for performance reasons and then compare the calculated MD5 with the returned MD5/Etag $Presign = [Switch]::new($true) $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region -Headers $Headers if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { # using CryptoSteam to calculate the MD5 sum while uploading the part # this allows to only read the stream once and increases performance compared with other S3 clients $Md5 = [System.Security.Cryptography.MD5]::Create() $CryptoStream = [System.Security.Cryptography.CryptoStream]::new($Stream, $Md5, [System.Security.Cryptography.CryptoStreamMode]::Read) $HttpClient = [System.Net.Http.HttpClient]::new() $PutRequest = [System.Net.Http.HttpRequestMessage]::new([System.Net.Http.HttpMethod]::Put,$AwsRequest.Uri) $PutRequest.Headers.Add("Host",$AwsRequest.Headers["Host"]) $StreamContent = [System.Net.Http.StreamContent]::new($CryptoStream) $StreamContent.Headers.ContentLength = $Stream.Length $PutRequest.Content = $StreamContent $Response = $HttpClient.SendAsync($PutRequest) $Md5Sum = [BitConverter]::ToString($Md5.Hash) -replace "-","" Write-Output [PSCustomObject]@{ETag=$Md5Sum} #$Response.Dispose() $PutRequest.Dispose() $StreamContent.Dispose() $CryptoStream.Dispose() $Stream.Dispose() } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ([int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Write-S3Object -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -Bucket $BucketName -Key $Key -UploadId $UploadId -PartNumber $PartNumber -Stream $Stream } else { Throw $_ } } Write-Output $Result.Content } } } <# .SYNOPSIS Get S3 Object Parts .DESCRIPTION Get S3 Object Parts #> function Global:Get-S3ObjectParts { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL. This Cmdlet always uses presigned URLs for best performance.")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Multipart Upload ID")][String]$UploadId, [parameter( Mandatory=$False, Position=13, HelpMessage="Encoding type (Only allowed value is url).")][String][ValidateSet("url")]$EncodingType="url", [parameter( Mandatory=$False, Position=14, HelpMessage="Maximum Number of parts to return")][Int][ValidateRange(0,1000)]$MaxParts=0, [parameter( Mandatory=$False, Position=15, HelpMessage="Continuation part number marker")][Alias("Marker")][String]$PartNumberMarker ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $Query = @{uploadId=$UploadId} if ($EncodingType) { $Query["encoding-type"] = $EncodingType } if ($MaxParts -ge 1) { $Query["max-parts"] = $MaxParts } if ($PartNumberMarker) { $Query["part-number-marker"] = $PartNumberMarker } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { try { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML][System.Net.WebUtility]::UrlDecode($Result.Content) $Parts = $Content.ListPartsResult.Part | Where-Object { $_ } $UnicodeBucket = [System.Globalization.IdnMapping]::new().GetUnicode($Content.ListPartsResult.Bucket) foreach ($Part in $Parts) { $Part = [PSCustomObject]@{ Region=$Region; BucketName=$UnicodeBucket; Key=$Content.ListPartsResult.Key; UploadId=$Content.ListPartsResult.UploadId; InitiatorId=$Content.ListPartsResult.Initiator.ID; InitiatorDisplayName=$Content.ListPartsResult.Initiator.DisplayName; OwnerId=$Content.ListPartsResult.Owner.ID; OwernDisplayName=$Content.ListPartsResult.Owner.DisplayName; StorageClass=$Content.ListPartsResult.StorageClass; PartNumber=$Part.PartNumber; LastModified=$Part.LastModified; ETag=$Part.ETag; Size=$Part.Size} Write-Output $Part } if ($Content.ListPartsResult.IsTruncated -eq "true" -and $MaxParts -eq 0) { Write-Verbose "1000 Parts were returned and max parts was not limited so continuing to get all parts" Write-Debug "NextPartNumberMarker: $($Content.ListPartsResult.NextPartNumberMarker)" Get-S3ObjectParts -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -EndpointUrl $Config.EndpointUrl -Region $Region -SkipCertificateCheck:$Config.SkipCertificateCheck -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint -Bucket $BucketName -MaxParts $MaxParts -PartNumberMarker $Content.ListPartsResult.NextPartNumberMarker } } catch { $RedirectedRegion = New-Object 'System.Collections.Generic.List[string]' if ([int]$_.Exception.Response.StatusCode -match "^3" -and $_.Exception.Response.Headers.TryGetValues("x-amz-bucket-region",[ref]$RedirectedRegion)) { Write-Warning "Request was redirected as bucket does not belong to region $Region. Repeating request with region $($RedirectedRegion[0]) returned by S3 service." Get-S3ObjectParts -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $($RedirectedRegion[0]) -UrlStyle $UrlStyle -UseDualstackEndpoint:$UseDualstackEndpoint -Bucket $BucketName -MaxParts $MaxParts -PartNumberMarker $PartNumberMarker -EncodingType $EncodingType } else { Throw $_ } } } } } <# .SYNOPSIS Remove S3 Object .DESCRIPTION Remove S3 Object #> function Global:Remove-S3Object { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$False, Position=10, HelpMessage="Use the dualstack endpoint of the specified region. S3 supports dualstack endpoints which return both IPv6 and IPv4 values.")][Switch]$UseDualstackEndpoint, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$False, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Object version ID")][String]$VersionId ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "DELETE" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" if ($VersionId) { $Query = @{versionId=$VersionId} } else { $Query = @{} } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region -UseDualstackEndpoint:$UseDualstackEndpoint if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } <# .SYNOPSIS Copy S3 Object .DESCRIPTION Copy S3 Object #> function Global:Copy-S3Object { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][Alias("Object")][String]$Key, [parameter( Mandatory=$True, Position=12, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][String]$SourceBucket, [parameter( Mandatory=$True, Position=13, ValueFromPipelineByPropertyName=$True, HelpMessage="Object key")][String]$SourceKey, [parameter( Mandatory=$False, Position=14, ValueFromPipelineByPropertyName=$True, HelpMessage="Object version ID")][String]$SourceVersionId, [parameter( Mandatory=$False, Position=15, ValueFromPipelineByPropertyName=$True, HelpMessage="Object version ID")][ValidateSet("COPY","REPLACE")][String]$MetadataDirective="COPY", [parameter( Mandatory=$False, Position=16, ValueFromPipelineByPropertyName=$True, HelpMessage="Metadata")][Hashtable]$Metadata, [parameter( Mandatory=$False, Position=17, ValueFromPipelineByPropertyName=$True, HelpMessage="Copies the object if its entity tag (ETag) matches the specified Etag")][String]$Etag, [parameter( Mandatory=$False, Position=18, ValueFromPipelineByPropertyName=$True, HelpMessage="Copies the object if its entity tag (ETag) is different than the specified NotETag")][String]$NotEtag, [parameter( Mandatory=$False, Position=19, ValueFromPipelineByPropertyName=$True, HelpMessage="Copies the object if it hasn't been modified since the specified time")][DateTime]$UnmodifiedSince, [parameter( Mandatory=$False, Position=20, ValueFromPipelineByPropertyName=$True, HelpMessage="Copies the object if it has been modified since the specified time")][DateTime]$ModifiedSince, [parameter( Mandatory=$False, Position=21, ValueFromPipelineByPropertyName=$True, HelpMessage="S3 Storage Class")][ValidateSet("STANDARD","STANDARD_IA","REDUCED_REDUNDANCY")][String]$StorageClass, [parameter( Mandatory=$False, Position=22, ValueFromPipelineByPropertyName=$True, HelpMessage="Specifies whether the object tags are copied from the source object or replaced with tags provided in the request")][ValidateSet("COPY","REPLACE")][String]$TaggingDirective="COPY", [parameter( Mandatory=$False, Position=23, ValueFromPipelineByPropertyName=$True, HelpMessage="Object tags")][HashTable]$Tags, [parameter( Mandatory=$False, Position=24, ValueFromPipelineByPropertyName=$True, HelpMessage="Object tags")][ValidateSet("aws:kms","AES256")][String]$ServerSideEncryption ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Uri = "/$Key" $Headers = @{} $Headers["x-amz-copy-source"] = "/$BucketName/$Key" if ($VersionId) { $Headers["x-amz-copy-source"] += "?versionId=$VersionId" } $Headers["x-amz-metadata-directive"] = $MetadataDirective if ($Etag) { $Headers["x-amz-copy-source-if-match"] = $Etag } if ($NotEtag) { $Headers["x-amz-copy-source-if-none-match"] = $NotEtag } if ($UnmodifiedSince) { $Headers["x-amz-copy-source-if-unmodified-since"] = $UnmodifiedSince } if ($ModifiedSince) { $Headers["x-amz-copy-source-if-modified-since"] = $ModifiedSince } if ($StorageClass) { $Headers["x-amz-storage-class"] = $StorageClass } if ($TaggingDirective) { $Headers["x-amz-tagging-directive"] = $TaggingDirective } if ($ServerSideEncryption) { $Headers["x-amz-server-side​-encryption"] = $ServerSideEncryption } $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Headers $Headers -Region $Region if ($DryRun) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } # StorageGRID specific # <# .SYNOPSIS Get S3 Bucket Consistency Setting .DESCRIPTION Get S3 Bucket Consistency Setting #> function Global:Get-S3BucketConsistency { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{"x-ntap-sg-consistency"=""} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML]$Result.Content $BucketNameConsistency = [PSCustomObject]@{Bucket=$BucketName;Consistency=$Content.Consistency.InnerText} Write-Output $BucketNameConsistency } } } <# .SYNOPSIS Modify S3 Bucket Consistency Setting .DESCRIPTION Modify S3 Bucket Consistency Setting #> function Global:Update-S3BucketConsistency { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket Name")][Alias("Name","Bucket")][String]$BucketName, [parameter( Mandatory=$True, Position=11, HelpMessage="Bucket")][ValidateSet("all","strong-global","strong-site","default","available","weak")][String]$Consistency ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{"x-ntap-sg-consistency"=$Consistency} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } <# .SYNOPSIS Get S3 Bucket Storage Usage .DESCRIPTION Get S3 Bucket Storage Usage #> function Global:Get-S3StorageUsage { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, HelpMessage="StorageGRID account ID to execute this command against")][String]$AccountId ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } $Uri = "/" $Query = @{"x-ntap-sg-usage"=""} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML]$Result.Content $UsageResult = [PSCustomObject]@{CalculationTime=(Get-Date -Date $Content.UsageResult.CalculationTime);ObjectCount=$Content.UsageResult.ObjectCount;DataBytes=$Content.UsageResult.DataBytes;buckets=$Content.UsageResult.Buckets.ChildNodes} Write-Output $UsageResult } } } <# .SYNOPSIS Get S3 Bucket Last Access Time .DESCRIPTION Get S3 Bucket Last Access Time #> function Global:Get-S3BucketLastAccessTime { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "GET" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{"x-ntap-sg-lastaccesstime"=""} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Result = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop $Content = [XML]$Result.Content $BucketNameLastAccessTime = [PSCustomObject]@{Bucket=$BucketName;LastAccessTime=$Content.LastAccessTime.InnerText} Write-Output $BucketNameLastAccessTime } } } <# .SYNOPSIS Enable S3 Bucket Last Access Time .DESCRIPTION Enable S3 Bucket Last Access Time #> function Global:Enable-S3BucketLastAccessTime { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{"x-ntap-sg-lastaccesstime"="enabled"} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } <# .SYNOPSIS Disable S3 Bucket Last Access Time .DESCRIPTION Disable S3 Bucket Last Access Time #> function Global:Disable-S3BucketLastAccessTime { [CmdletBinding(DefaultParameterSetName="none")] PARAM ( [parameter( Mandatory=$False, Position=0, HelpMessage="StorageGRID Webscale Management Server object. If not specified, global CurrentSgwServer object will be used.")][PSCustomObject]$Server, [parameter( Mandatory=$False, Position=1, HelpMessage="Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.")][Switch]$SkipCertificateCheck, [parameter( Mandatory=$False, Position=2, HelpMessage="Use presigned URL")][Switch]$Presign, [parameter( Mandatory=$False, Position=3, HelpMessage="Do not execute request, just return request URI and Headers")][Switch]$DryRun, [parameter( Mandatory=$False, Position=4, HelpMessage="AWS Signer type (S3 for V2 Authentication and AWS4 for V4 Authentication)")][String][ValidateSet("S3","AWS4")]$SignerType="AWS4", [parameter( Mandatory=$False, Position=5, HelpMessage="Custom S3 Endpoint URL")][System.UriBuilder]$EndpointUrl, [parameter( ParameterSetName="profile", Mandatory=$False, Position=6, HelpMessage="AWS Profile to use which contains AWS sredentials and settings")][Alias("Profile")][String]$ProfileName="", [parameter( ParameterSetName="profile", Mandatory=$False, Position=7, HelpMessage="AWS Profile location if different than .aws/credentials")][String]$ProfileLocation, [parameter( ParameterSetName="keys", Mandatory=$False, Position=6, HelpMessage="S3 Access Key")][String]$AccessKey, [parameter( ParameterSetName="keys", Mandatory=$False, Position=7, HelpMessage="S3 Secret Access Key")][Alias("SecretAccessKey")][String]$SecretKey, [parameter( ParameterSetName="account", Mandatory=$False, Position=6, ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True, HelpMessage="StorageGRID account ID to execute this command against")][Alias("OwnerId")][String]$AccountId, [parameter( Mandatory=$False, Position=8, ValueFromPipelineByPropertyName=$True, HelpMessage="Region to be used")][String]$Region, [parameter( Mandatory=$False, Position=9, HelpMessage="Bucket URL Style (Default: Auto)")][String][ValidateSet("path","virtual","auto","virtual-hosted")]$UrlStyle="auto", [parameter( Mandatory=$True, Position=10, ValueFromPipelineByPropertyName=$True, HelpMessage="Bucket")][Alias("Name","Bucket")][String]$BucketName ) Begin { if (!$Server) { $Server = $Global:CurrentSgwServer } $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck $Method = "PUT" } Process { if ($AccountId) { $Config = Get-AwsConfig -Server $Server -EndpointUrl $EndpointUrl -ProfileName $ProfileName -ProfileLocation $ProfileLocation -AccessKey $AccessKey -SecretKey $SecretKey -AccountId $AccountId -SkipCertificateCheck:$SkipCertificateCheck } if (!$Region) { $Region = $Config.Region } # Convert Bucket Name to IDN mapping to support Unicode Names $PunycodeBucketName = [System.Globalization.IdnMapping]::new().GetAscii($BucketName).ToLower() # check if BucketName contains uppercase letters if ($PunycodeBucketName -match $BucketName -and $PunycodeBucketName -cnotmatch $BucketName) { $BucketNameExists = Test-S3Bucket -SkipCertificateCheck:$Config.SkipCertificateCheck -Presign:$Presign -DryRun:$DryRun -SignerType $SignerType -EndpointUrl $Config.EndpointUrl -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Region $Config.Region -UrlStyle $UrlStyle -Bucket $BucketName -Force if ($BucketNameExists) { Write-Warning "BucketName $BucketName includes uppercase letters which SHOULD NOT be used!" } else { $BucketName = $PunycodeBucketName } } else { $BucketName = $PunycodeBucketName } $Query = @{"x-ntap-sg-lastaccesstime"="disabled"} $AwsRequest = Get-AwsRequest -AccessKey $Config.AccessKey -SecretKey $Config.SecretKey -Method $Method -EndpointUrl $Config.EndpointUrl -Uri $Uri -Query $Query -Bucket $BucketName -Presign:$Presign -SignerType $SignerType -Region $Region if ($DryRun.IsPresent) { Write-Output $AwsRequest } else { $Null = Invoke-AwsRequest -SkipCertificateCheck:$Config.SkipCertificateCheck -Method $Method -Uri $AwsRequest.Uri -Headers $AwsRequest.Headers -ErrorAction Stop } } } # SIG # Begin signature block # MIIVAAYJKoZIhvcNAQcCoIIU8TCCFO0CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB # gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR # AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUKkPn/1FgPTfvlSVJgoqNlN3I # Caiggg/vMIIEmTCCA4GgAwIBAgIPFojwOSVeY45pFDkH5jMLMA0GCSqGSIb3DQEB # BQUAMIGVMQswCQYDVQQGEwJVUzELMAkGA1UECBMCVVQxFzAVBgNVBAcTDlNhbHQg # TGFrZSBDaXR5MR4wHAYDVQQKExVUaGUgVVNFUlRSVVNUIE5ldHdvcmsxITAfBgNV # BAsTGGh0dHA6Ly93d3cudXNlcnRydXN0LmNvbTEdMBsGA1UEAxMUVVROLVVTRVJG # aXJzdC1PYmplY3QwHhcNMTUxMjMxMDAwMDAwWhcNMTkwNzA5MTg0MDM2WjCBhDEL # MAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UE # BxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxKjAoBgNVBAMT # IUNPTU9ETyBTSEEtMSBUaW1lIFN0YW1waW5nIFNpZ25lcjCCASIwDQYJKoZIhvcN # AQEBBQADggEPADCCAQoCggEBAOnpPd/XNwjJHjiyUlNCbSLxscQGBGue/YJ0UEN9 # xqC7H075AnEmse9D2IOMSPznD5d6muuc3qajDjscRBh1jnilF2n+SRik4rtcTv6O # KlR6UPDV9syR55l51955lNeWM/4Og74iv2MWLKPdKBuvPavql9LxvwQQ5z1IRf0f # aGXBf1mZacAiMQxibqdcZQEhsGPEIhgn7ub80gA9Ry6ouIZWXQTcExclbhzfRA8V # zbfbpVd2Qm8AaIKZ0uPB3vCLlFdM7AiQIiHOIiuYDELmQpOUmJPv/QbZP7xbm1Q8 # ILHuatZHesWrgOkwmt7xpD9VTQoJNIp1KdJprZcPUL/4ygkCAwEAAaOB9DCB8TAf # BgNVHSMEGDAWgBTa7WR0FJwUPKvdmam9WyhNizzJ2DAdBgNVHQ4EFgQUjmstM2v0 # M6eTsxOapeAK9xI1aogwDgYDVR0PAQH/BAQDAgbAMAwGA1UdEwEB/wQCMAAwFgYD # VR0lAQH/BAwwCgYIKwYBBQUHAwgwQgYDVR0fBDswOTA3oDWgM4YxaHR0cDovL2Ny # bC51c2VydHJ1c3QuY29tL1VUTi1VU0VSRmlyc3QtT2JqZWN0LmNybDA1BggrBgEF # BQcBAQQpMCcwJQYIKwYBBQUHMAGGGWh0dHA6Ly9vY3NwLnVzZXJ0cnVzdC5jb20w # DQYJKoZIhvcNAQEFBQADggEBALozJEBAjHzbWJ+zYJiy9cAx/usfblD2CuDk5oGt # Joei3/2z2vRz8wD7KRuJGxU+22tSkyvErDmB1zxnV5o5NuAoCJrjOU+biQl/e8Vh # f1mJMiUKaq4aPvCiJ6i2w7iH9xYESEE9XNjsn00gMQTZZaHtzWkHUxY93TYCCojr # QOUGMAu4Fkvc77xVCf/GPhIudrPczkLv+XZX4bcKBUCYWJpdcRaTcYxlgepv84n3 # +3OttOe/2Y5vqgtPJfO44dXddZhogfiqwNGAwsTEOYnB9smebNd0+dmX+E/CmgrN # Xo/4GengpZ/E8JIh5i15Jcki+cPwOoRXrToW9GOUEB1d0MYwggVqMIIEUqADAgEC # AhEAsPVV6jnRNgfABcUA7um0CDANBgkqhkiG9w0BAQsFADB9MQswCQYDVQQGEwJH # QjEbMBkGA1UECBMSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHEwdTYWxmb3Jk # MRowGAYDVQQKExFDT01PRE8gQ0EgTGltaXRlZDEjMCEGA1UEAxMaQ09NT0RPIFJT # QSBDb2RlIFNpZ25pbmcgQ0EwHhcNMTcwNjI4MDAwMDAwWhcNMjAwNjI3MjM1OTU5 # WjCBqzELMAkGA1UEBhMCREUxDjAMBgNVBBEMBTg1NTUxMRwwGgYDVQQIDBNOb3Jk # cmhlaW4tV2VzdGZhbGVuMRIwEAYDVQQHDAlLaXJjaGhlaW0xFjAUBgNVBAkMDVNv # bm5lbmFsbGVlIDExIDAeBgNVBAoMF05ldEFwcCBEZXV0c2NobGFuZCBHbWJIMSAw # HgYDVQQDDBdOZXRBcHAgRGV1dHNjaGxhbmQgR21iSDCCASIwDQYJKoZIhvcNAQEB # BQADggEPADCCAQoCggEBAKnyWe0IrmZ8r6hU9qhoH7pNv9HTv67xaWRFcmeQilAS # F72E9oyFa65OTxdXoOpLD129692Rbaswbqy57P+qkj6MgBvTYFqBX9BZpnCOlCjw # YGQVWTj34fSxUtzxKISRI4wjvYT212T0deqhpJ/Oy1BlDik7WNiNncVZRHD2RfbH # qVZI37LaFGlSytG4z6VS7nUTGZLGay/IWEQIEwQ6AktWm696mSTKono680z7ZK2U # OGFneQVKagfzOIqD5ZFvlZjvC6z5181/oSEFtn5MMp71HoNd4ABYOrzldFUy0CPI # ruBB7yagUomtvLPFWux3OcA/pbJMK6EdAowrTQxxG1UCAwEAAaOCAbQwggGwMB8G # A1UdIwQYMBaAFCmRYP+KTfrr+aZquM/55ku9Sc4SMB0GA1UdDgQWBBTChARqgCg3 # JCwDL3vvWQz8tzA8XjAOBgNVHQ8BAf8EBAMCB4AwDAYDVR0TAQH/BAIwADATBgNV # HSUEDDAKBggrBgEFBQcDAzARBglghkgBhvhCAQEEBAMCBBAwRgYDVR0gBD8wPTA7 # BgwrBgEEAbIxAQIBAwIwKzApBggrBgEFBQcCARYdaHR0cHM6Ly9zZWN1cmUuY29t # b2RvLm5ldC9DUFMwQwYDVR0fBDwwOjA4oDagNIYyaHR0cDovL2NybC5jb21vZG9j # YS5jb20vQ09NT0RPUlNBQ29kZVNpZ25pbmdDQS5jcmwwdAYIKwYBBQUHAQEEaDBm # MD4GCCsGAQUFBzAChjJodHRwOi8vY3J0LmNvbW9kb2NhLmNvbS9DT01PRE9SU0FD # b2RlU2lnbmluZ0NBLmNydDAkBggrBgEFBQcwAYYYaHR0cDovL29jc3AuY29tb2Rv # Y2EuY29tMCUGA1UdEQQeMByBGmZsb3JpYW4uZmVsZGhhdXNAZ21haWwuY29tMA0G # CSqGSIb3DQEBCwUAA4IBAQBPLYiedwvRO7FPhAkDLqCKNWwRgRWaP5fA6X/bYjcu # eV2oAAaPGdhee5mZgpjqvzLDxLCZiLJ/Z9wCAhiK9C42Lgahbe7XOIM8NDV/MmGn # Mo2Ba+X9KYmyVlRV6bQsNDpnW4t7mWkh4JpV2LZbLluSrJ88SAqCsrZb1C49H5m5 # YdwFZUSIL8P19MSCDxPr0OC/3qX0dFcSEBIIBKtKF3mm9/Yind3SgkxoPfxViX2D # eK80uOmm2Gb7bOhSuzqjkvDG0INsF4zyTX4HldBJmQfKeQiD8RlF6DpUcm0AoChM # qCLwiJOHaHHYOOS7Busif3LkvIKd+tWtrg5fw7gZ0fU3MIIF4DCCA8igAwIBAgIQ # LnyHzA6TSlL+lP0ct800rzANBgkqhkiG9w0BAQwFADCBhTELMAkGA1UEBhMCR0Ix # GzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEa # MBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxKzApBgNVBAMTIkNPTU9ETyBSU0Eg # Q2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTMwNTA5MDAwMDAwWhcNMjgwNTA4 # MjM1OTU5WjB9MQswCQYDVQQGEwJHQjEbMBkGA1UECBMSR3JlYXRlciBNYW5jaGVz # dGVyMRAwDgYDVQQHEwdTYWxmb3JkMRowGAYDVQQKExFDT01PRE8gQ0EgTGltaXRl # ZDEjMCEGA1UEAxMaQ09NT0RPIFJTQSBDb2RlIFNpZ25pbmcgQ0EwggEiMA0GCSqG # SIb3DQEBAQUAA4IBDwAwggEKAoIBAQCmmJBjd5E0f4rR3elnMRHrzB79MR2zuWJX # P5O8W+OfHiQyESdrvFGRp8+eniWzX4GoGA8dHiAwDvthe4YJs+P9omidHCydv3Lj # 5HWg5TUjjsmK7hoMZMfYQqF7tVIDSzqwjiNLS2PgIpQ3e9V5kAoUGFEs5v7BEvAc # P2FhCoyi3PbDMKrNKBh1SMF5WgjNu4xVjPfUdpA6M0ZQc5hc9IVKaw+A3V7Wvf2p # L8Al9fl4141fEMJEVTyQPDFGy3CuB6kK46/BAW+QGiPiXzjbxghdR7ODQfAuADcU # uRKqeZJSzYcPe9hiKaR+ML0btYxytEjy4+gh+V5MYnmLAgaff9ULAgMBAAGjggFR # MIIBTTAfBgNVHSMEGDAWgBS7r34CPfqm8TyEjq3uOJjs2TIy1DAdBgNVHQ4EFgQU # KZFg/4pN+uv5pmq4z/nmS71JzhIwDgYDVR0PAQH/BAQDAgGGMBIGA1UdEwEB/wQI # MAYBAf8CAQAwEwYDVR0lBAwwCgYIKwYBBQUHAwMwEQYDVR0gBAowCDAGBgRVHSAA # MEwGA1UdHwRFMEMwQaA/oD2GO2h0dHA6Ly9jcmwuY29tb2RvY2EuY29tL0NPTU9E # T1JTQUNlcnRpZmljYXRpb25BdXRob3JpdHkuY3JsMHEGCCsGAQUFBwEBBGUwYzA7 # BggrBgEFBQcwAoYvaHR0cDovL2NydC5jb21vZG9jYS5jb20vQ09NT0RPUlNBQWRk # VHJ1c3RDQS5jcnQwJAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmNvbW9kb2NhLmNv # bTANBgkqhkiG9w0BAQwFAAOCAgEAAj8COcPu+Mo7id4MbU2x8U6ST6/COCwEzMVj # EasJY6+rotcCP8xvGcM91hoIlP8l2KmIpysQGuCbsQciGlEcOtTh6Qm/5iR0rx57 # FjFuI+9UUS1SAuJ1CAVM8bdR4VEAxof2bO4QRHZXavHfWGshqknUfDdOvf+2dVRA # GDZXZxHNTwLk/vPa/HUX2+y392UJI0kfQ1eD6n4gd2HITfK7ZU2o94VFB696aSdl # kClAi997OlE5jKgfcHmtbUIgos8MbAOMTM1zB5TnWo46BLqioXwfy2M6FafUFRun # UkcyqfS/ZEfRqh9TTjIwc8Jvt3iCnVz/RrtrIh2IC/gbqjSm/Iz13X9ljIwxVzHQ # NuxHoc/Li6jvHBhYxQZ3ykubUa9MCEp6j+KjUuKOjswm5LLY5TjCqO3GgZw1a6lY # YUoKl7RLQrZVnb6Z53BtWfhtKgx/GWBfDJqIbDCsUgmQFhv/K53b0CDKieoofjKO # Gd97SDMe12X4rsn4gxSTdn1k0I7OvjV9/3IxTZ+evR5sL6iPDAZQ+4wns3bJ9ObX # wzTijIchhmH+v1V04SF3AwpobLvkyanmz1kl63zsRQ55ZmjoIs2475iFTZYRPAmK # 0H+8KCgT+2rKVI2SXM3CZZgGns5IW9S1N5NGQXwH3c/6Q++6Z2H/fUnguzB9XIDj # 5hY5S6cxggR7MIIEdwIBATCBkjB9MQswCQYDVQQGEwJHQjEbMBkGA1UECBMSR3Jl # YXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHEwdTYWxmb3JkMRowGAYDVQQKExFDT01P # RE8gQ0EgTGltaXRlZDEjMCEGA1UEAxMaQ09NT0RPIFJTQSBDb2RlIFNpZ25pbmcg # Q0ECEQCw9VXqOdE2B8AFxQDu6bQIMAkGBSsOAwIaBQCgeDAYBgorBgEEAYI3AgEM # MQowCKACgAChAoAAMBkGCSqGSIb3DQEJAzEMBgorBgEEAYI3AgEEMBwGCisGAQQB # gjcCAQsxDjAMBgorBgEEAYI3AgEVMCMGCSqGSIb3DQEJBDEWBBQwsiZIjQazHVZc # bV28xiaiwtQaxzANBgkqhkiG9w0BAQEFAASCAQCXc3+FeOHBfKQwRjpNxsZu5KGW # gNpnppLc9Y+2kOT87gi+0FoIdynXoVCVJDLzA4/kIQOgsVW9AWZGR4Sa1x7+6jkP # tSqCTHyCbe2eWHVvUxoZw8MSZGYxJyvyrLETjQG0W6hVb4R3e8KStVvz86gXa7IX # vARjmn6MDGPj71seNaCv3MBgWbcH2Hh5NxEB73uIlAZAdDcvcYRXl8ewpEHe0Tnr # ngrHTPbXLJ1vTrmNB6MLSTMDIG8a2g0ogNP2UfJpkB3plVZRJ18yNSonaP4pLVDv # SYINBEgzgQZxKSwW9aZKJOpeBLaRNGWbsH5iUd54aJ4WbosBx3DEzB/f2YBXoYIC # QzCCAj8GCSqGSIb3DQEJBjGCAjAwggIsAgEBMIGpMIGVMQswCQYDVQQGEwJVUzEL # MAkGA1UECBMCVVQxFzAVBgNVBAcTDlNhbHQgTGFrZSBDaXR5MR4wHAYDVQQKExVU # aGUgVVNFUlRSVVNUIE5ldHdvcmsxITAfBgNVBAsTGGh0dHA6Ly93d3cudXNlcnRy # dXN0LmNvbTEdMBsGA1UEAxMUVVROLVVTRVJGaXJzdC1PYmplY3QCDxaI8DklXmOO # aRQ5B+YzCzAJBgUrDgMCGgUAoF0wGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAc # BgkqhkiG9w0BCQUxDxcNMTgwNTI2MjIzMTUxWjAjBgkqhkiG9w0BCQQxFgQU23hD # fHq4F9eOe1WUDzCbwt7ytuAwDQYJKoZIhvcNAQEBBQAEggEAfPaVm3oQbCO9XgEe # VCw8YJO0t2N6zN4Fqqn/k6Imx7fOpIoufJGUxmm+koTpFnilkXA1ucem/jGUbMqp # BMM+JQXa+aHbE9albsVwbEmnAMG6q90INlO8I8tlH5o7SJG7vRU1oTLZq+uNpyw6 # PH1J502+3tjb4dBqI4fGAsanRxCyPiYGrdaYf/JEFedVCUVC3H/FwwIvPverXb2i # To8Fl3WrdZyFDYMRt0upL8gLXVoGCVUsBrrIPlAAPLe9vxksMSolbHF4HBdoC/0F # Xmnx7EEwLxLevpNWSvijwf9x4wIcR6gdhsD97I7YuWItYsMnoR4VDAkTLIZzrtg5 # d9G4Kg== # SIG # End signature block |