332 lines
14 KiB
C#
332 lines
14 KiB
C#
// Copyright (C) 2025, The Duplicati Team
|
|
// https://duplicati.com, hello@duplicati.com
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
|
|
using Amazon.S3;
|
|
using Amazon.S3.Model;
|
|
using Duplicati.Library.Common.IO;
|
|
using Duplicati.Library.Interface;
|
|
using Duplicati.Library.Utility;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Runtime.CompilerServices;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Duplicati.Library.Backend
|
|
{
|
|
/// <summary>
|
|
/// Helper class that fixes long list support and injects location headers, includes using directives etc.
|
|
/// </summary>
|
|
public class S3AwsClient : IS3Client
|
|
{
|
|
private static readonly string LOGTAG = Logging.Log.LogTagFromType<S3AwsClient>();
|
|
private const int ITEM_LIST_LIMIT = 1000;
|
|
|
|
private const string EXT_OPTION_PREFIX = "s3-ext-";
|
|
|
|
private readonly string m_locationConstraint;
|
|
private readonly string m_storageClass;
|
|
private AmazonS3Client m_client;
|
|
private readonly bool m_useChunkEncoding;
|
|
|
|
private readonly string m_dnsHost;
|
|
private readonly bool m_useV2ListApi;
|
|
|
|
public S3AwsClient(string awsID, string awsKey, string locationConstraint, string servername,
|
|
string storageClass, bool useSSL, bool disableChunkEncoding, Dictionary<string, string> options)
|
|
{
|
|
var cfg = S3AwsClient.GetDefaultAmazonS3Config();
|
|
cfg.UseHttp = !useSSL;
|
|
cfg.ServiceURL = (useSSL ? "https://" : "http://") + servername;
|
|
|
|
CommandLineArgumentMapper.ApplyArguments(cfg, options, EXT_OPTION_PREFIX);
|
|
|
|
m_client = new AmazonS3Client(awsID, awsKey, cfg);
|
|
|
|
m_useV2ListApi = string.Equals(options.GetValueOrDefault("list-api-version", "v1"), "v2", StringComparison.OrdinalIgnoreCase);
|
|
m_locationConstraint = locationConstraint;
|
|
m_storageClass = storageClass;
|
|
m_dnsHost = string.IsNullOrWhiteSpace(cfg.ServiceURL) ? null : new System.Uri(cfg.ServiceURL).Host;
|
|
m_useChunkEncoding = !disableChunkEncoding;
|
|
}
|
|
|
|
public Task AddBucketAsync(string bucketName, CancellationToken cancelToken)
|
|
{
|
|
var request = new PutBucketRequest
|
|
{
|
|
BucketName = bucketName,
|
|
};
|
|
|
|
if (!string.IsNullOrEmpty(m_locationConstraint))
|
|
request.BucketRegionName = m_locationConstraint;
|
|
|
|
return m_client.PutBucketAsync(request, cancelToken);
|
|
}
|
|
|
|
public static AmazonS3Config GetDefaultAmazonS3Config()
|
|
{
|
|
return new AmazonS3Config()
|
|
{
|
|
BufferSize = (int)Utility.Utility.DEFAULT_BUFFER_SIZE,
|
|
|
|
// If this is not set, accessing the property will trigger an expensive operation (~30 seconds)
|
|
// to get the region endpoint. The use of ARNs (Amazon Resource Names) doesn't appear to be
|
|
// critical for our usages.
|
|
// See: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
UseArnRegion = false,
|
|
};
|
|
}
|
|
|
|
private static readonly HashSet<string> EXCLUDED_EXTENDED_OPTIONS = new HashSet<string>([
|
|
nameof(AmazonS3Config.USEast1RegionalEndpointValue)
|
|
]);
|
|
|
|
/// <summary>
|
|
/// List of properties that are slow to read the default value from
|
|
/// </summary>
|
|
/// <remarks>Changes in this list will likely need to be reflected in AWSSecretProvider.cs</remarks>
|
|
private static readonly HashSet<string> SLOW_LOADING_PROPERTIES = new[] {
|
|
nameof(AmazonS3Config.RegionEndpoint),
|
|
nameof(AmazonS3Config.ServiceURL),
|
|
nameof(AmazonS3Config.MaxErrorRetry),
|
|
nameof(AmazonS3Config.DefaultConfigurationMode),
|
|
nameof(AmazonS3Config.Timeout),
|
|
nameof(AmazonS3Config.RetryMode),
|
|
}.ToHashSet();
|
|
|
|
public static IEnumerable<ICommandLineArgument> GetAwsExtendedOptions()
|
|
=> CommandLineArgumentMapper.MapArguments(GetDefaultAmazonS3Config(), prefix: EXT_OPTION_PREFIX, exclude: EXCLUDED_EXTENDED_OPTIONS, excludeDefaultValue: SLOW_LOADING_PROPERTIES)
|
|
.Cast<CommandLineArgument>()
|
|
.Select(x =>
|
|
{
|
|
x.LongDescription = $"Extended option {x.LongDescription}";
|
|
return x;
|
|
});
|
|
|
|
public virtual async Task GetFileStreamAsync(string bucketName, string keyName, System.IO.Stream target, CancellationToken cancelToken)
|
|
{
|
|
try
|
|
{
|
|
var objectGetRequest = new GetObjectRequest
|
|
{
|
|
BucketName = bucketName,
|
|
Key = keyName
|
|
};
|
|
|
|
using (var objectGetResponse = await m_client.GetObjectAsync(objectGetRequest).ConfigureAwait(false))
|
|
using (var s = objectGetResponse.ResponseStream)
|
|
{
|
|
// TODO: This does not work and throws InvalidOperationException()
|
|
try { s.ReadTimeout = (int)TimeSpan.FromMinutes(1).TotalMilliseconds; }
|
|
catch { }
|
|
|
|
await Utility.Utility.CopyStreamAsync(s, target, cancelToken).ConfigureAwait(false);
|
|
}
|
|
}
|
|
catch (AmazonS3Exception s3Ex)
|
|
{
|
|
if (s3Ex.StatusCode == System.Net.HttpStatusCode.NotFound)
|
|
throw new FileMissingException(string.Format("File {0} not found", keyName), s3Ex);
|
|
}
|
|
|
|
}
|
|
|
|
public string GetDnsHost()
|
|
{
|
|
return m_dnsHost;
|
|
}
|
|
|
|
public virtual async Task AddFileStreamAsync(string bucketName, string keyName, System.IO.Stream source,
|
|
CancellationToken cancelToken)
|
|
{
|
|
var objectAddRequest = new PutObjectRequest
|
|
{
|
|
BucketName = bucketName,
|
|
Key = keyName,
|
|
InputStream = source,
|
|
UseChunkEncoding = m_useChunkEncoding
|
|
};
|
|
if (!string.IsNullOrWhiteSpace(m_storageClass))
|
|
objectAddRequest.StorageClass = new S3StorageClass(m_storageClass);
|
|
|
|
try
|
|
{
|
|
await m_client.PutObjectAsync(objectAddRequest, cancelToken);
|
|
}
|
|
catch (AmazonS3Exception e)
|
|
{
|
|
//Catch "non-existing" buckets
|
|
if (e.StatusCode == System.Net.HttpStatusCode.NotFound ||
|
|
"NoSuchBucket".Equals(e.ErrorCode))
|
|
throw new FolderMissingException(e);
|
|
|
|
throw;
|
|
}
|
|
}
|
|
|
|
public Task DeleteObjectAsync(string bucketName, string keyName, CancellationToken cancellationToken)
|
|
{
|
|
var objectDeleteRequest = new DeleteObjectRequest
|
|
{
|
|
BucketName = bucketName,
|
|
Key = keyName
|
|
};
|
|
|
|
return m_client.DeleteObjectAsync(objectDeleteRequest, cancellationToken);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Lists the contents of a bucket, using a plugable API call
|
|
/// </summary>
|
|
/// <param name="bucketName">The bucket to list</param>
|
|
/// <param name="prefix">The prefix to list</param>
|
|
/// <param name="recursive">If true, the list is recursive</param>
|
|
/// <param name="cancellationToken">The cancellation token</param>
|
|
/// <returns>The list of files</returns>
|
|
public async IAsyncEnumerable<IFileEntry> ListBucketAsync(string bucketName, string prefix, bool recursive, [EnumeratorCancellation] CancellationToken cancellationToken)
|
|
{
|
|
var isTruncated = true;
|
|
string filename = null;
|
|
var delimiter = recursive ? "" : "/";
|
|
if (!string.IsNullOrWhiteSpace(prefix))
|
|
prefix = Util.AppendDirSeparator(prefix, "/");
|
|
|
|
//TODO: Figure out if this is the case with AWSSDK too
|
|
//Unfortunately S3 sometimes reports duplicate values when requesting more than one page of results
|
|
//So, track the files that have already been returned and skip any duplicates.
|
|
var alreadyReturned = new HashSet<string>();
|
|
|
|
//We truncate after ITEM_LIST_LIMIT elements, and then repeat
|
|
while (isTruncated)
|
|
{
|
|
ListObjectsV2Response listResponse;
|
|
try
|
|
{
|
|
if (m_useV2ListApi)
|
|
{
|
|
var listRequest = new ListObjectsV2Request
|
|
{
|
|
BucketName = bucketName,
|
|
Prefix = prefix,
|
|
ContinuationToken = filename,
|
|
MaxKeys = ITEM_LIST_LIMIT,
|
|
Delimiter = delimiter
|
|
};
|
|
listResponse = await m_client.ListObjectsV2Async(listRequest, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
else
|
|
{
|
|
// Use the V1 API
|
|
var listRequest = new ListObjectsRequest
|
|
{
|
|
BucketName = bucketName,
|
|
Prefix = prefix,
|
|
Marker = filename,
|
|
MaxKeys = ITEM_LIST_LIMIT,
|
|
Delimiter = delimiter
|
|
};
|
|
var listResponsev1 = await m_client.ListObjectsAsync(listRequest, cancellationToken).ConfigureAwait(false);
|
|
|
|
// Map the V1 response to the V2 response
|
|
listResponse = new ListObjectsV2Response
|
|
{
|
|
CommonPrefixes = listResponsev1.CommonPrefixes,
|
|
IsTruncated = listResponsev1.IsTruncated,
|
|
NextContinuationToken = listResponsev1.NextMarker,
|
|
S3Objects = listResponsev1.S3Objects
|
|
};
|
|
}
|
|
}
|
|
catch (AmazonS3Exception e)
|
|
{
|
|
if (e.StatusCode == System.Net.HttpStatusCode.NotFound ||
|
|
"NoSuchBucket".Equals(e.ErrorCode))
|
|
{
|
|
throw new FolderMissingException(e);
|
|
}
|
|
|
|
throw;
|
|
}
|
|
|
|
isTruncated = listResponse.IsTruncated;
|
|
filename = listResponse.NextContinuationToken;
|
|
|
|
foreach (var obj in listResponse.CommonPrefixes)
|
|
{
|
|
if (obj == prefix || !obj.StartsWith(prefix))
|
|
continue;
|
|
|
|
// Because the prefixes are returned, and not the folder objects
|
|
// we do not get the folder modification date
|
|
yield return new FileEntry(
|
|
obj.Substring(prefix.Length),
|
|
-1,
|
|
new DateTime(0),
|
|
new DateTime(0)
|
|
)
|
|
{ IsFolder = true };
|
|
}
|
|
|
|
foreach (var obj in listResponse.S3Objects.Where(obj => alreadyReturned.Add(obj.Key)))
|
|
{
|
|
// Skip self-prefix, this discards the folder modification date :/
|
|
if (obj.Key == prefix || !obj.Key.StartsWith(prefix))
|
|
continue;
|
|
|
|
yield return new FileEntry(
|
|
obj.Key.Substring(prefix.Length),
|
|
obj.Size,
|
|
obj.LastModified,
|
|
obj.LastModified
|
|
)
|
|
{ IsFolder = obj.Key.EndsWith("/") };
|
|
}
|
|
}
|
|
}
|
|
|
|
public async Task RenameFileAsync(string bucketName, string source, string target, CancellationToken cancelToken)
|
|
{
|
|
var copyObjectRequest = new CopyObjectRequest
|
|
{
|
|
SourceBucket = bucketName,
|
|
SourceKey = source,
|
|
DestinationBucket = bucketName,
|
|
DestinationKey = target
|
|
};
|
|
|
|
await m_client.CopyObjectAsync(copyObjectRequest, cancelToken).ConfigureAwait(false);
|
|
await DeleteObjectAsync(bucketName, source, cancelToken).ConfigureAwait(false);
|
|
}
|
|
|
|
#region IDisposable Members
|
|
|
|
public void Dispose()
|
|
{
|
|
if (m_client != null)
|
|
m_client.Dispose();
|
|
m_client = null;
|
|
}
|
|
|
|
#endregion
|
|
}
|
|
} |