Kenneth Skovhede
0f81b42146
This PR adds support for locking files if the backend supports it. To activate locking, set the option `--file-lock-duration=30D` and the backup will lock the files. If the database is rebuilt with the intention of continuing the backups, use the option `--repair-refresh-lock-info` which will update lock information in the database after recreating the database. The locking works by asking the backend to lock files after a backup has completed. The implementation keeps track of which files are currently assigned a lock and prevents attempting to delete the files that are currently locked. Note that the bucket should not have a default lock policy as Duplicati needs to finish the backup before the locking is applied. In this initial version, Azure Blob Storage, B2, S3 and iDrive are supported with locking. The CLI is updated to allow setting locks on a specific version. The backend tool is updated to allow setting locks on specific files.
278 lines
13 KiB
C#
278 lines
13 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 Azure;
|
|
using Azure.Storage.Blobs.Models;
|
|
using Duplicati.Library.Interface;
|
|
using Duplicati.Library.Utility;
|
|
using Duplicati.Library.Utility.Options;
|
|
|
|
namespace Duplicati.Library.Backend.AzureBlob
|
|
{
|
|
// ReSharper disable once UnusedMember.Global
|
|
// This class is instantiated dynamically in the BackendLoader.
|
|
public class AzureBlobBackend : IStreamingBackend, ILockingBackend
|
|
{
|
|
/// <summary>
|
|
/// The access to Azure blob storage
|
|
/// </summary>
|
|
private readonly AzureBlobWrapper _azureBlob;
|
|
|
|
/// <summary>
|
|
/// The option to specify the Azure storage account name
|
|
/// </summary>
|
|
private const string AZURE_ACCOUNT_NAME_OPTION = "azure-account-name";
|
|
/// <summary>
|
|
/// The option to specify the Azure access key
|
|
/// </summary>
|
|
private const string AZURE_ACCESS_KEY_OPTION = "azure-access-key";
|
|
/// <summary>
|
|
/// The option to specify the Azure access SAS token
|
|
/// </summary>
|
|
private const string AZURE_ACCESS_SAS_TOKEN_OPTION = "azure-access-sas-token";
|
|
/// <summary>
|
|
/// The option to specify the archive classes
|
|
/// </summary>
|
|
private const string AZURE_ARCHIVE_CLASSES_OPTION = "azure-archive-classes";
|
|
/// <summary>
|
|
/// The option to specify the Azure access tier
|
|
/// </summary>
|
|
private const string AZURE_ACCESS_TIER_OPTION = "azure-access-tier";
|
|
/// <summary>
|
|
/// The option to specify the number of internal retries
|
|
/// </summary>
|
|
private const string AZURE_INTERNAL_RETRIES_OPTION = "azure-internal-retries";
|
|
|
|
/// <summary>
|
|
/// The default number of internal retries
|
|
/// </summary>
|
|
public const int DEFAULT_INTERNAL_RETRIES = 3;
|
|
|
|
/// <summary>
|
|
/// The default storage classes that are considered archive classes
|
|
/// </summary>
|
|
private static readonly IReadOnlySet<AccessTier> DEFAULT_ARCHIVE_CLASSES = new HashSet<AccessTier>([
|
|
AccessTier.Cold, AccessTier.Archive
|
|
]);
|
|
|
|
/// <summary>
|
|
/// List of access tiers
|
|
/// </summary>
|
|
private static readonly IEnumerable<AccessTier> ACCESS_TIERS =
|
|
typeof(AccessTier).GetProperties(System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Static)
|
|
.Where(x => x.PropertyType == typeof(AccessTier))
|
|
.Select(x => x.GetValue(null) as AccessTier?)
|
|
.WhereNotNull()
|
|
.ToArray();
|
|
|
|
// ReSharper disable once UnusedMember.Global
|
|
// This constructor is needed by the BackendLoader.
|
|
public AzureBlobBackend()
|
|
{
|
|
_azureBlob = null!;
|
|
}
|
|
|
|
// ReSharper disable once UnusedMember.Global
|
|
// This constructor is needed by the BackendLoader.
|
|
public AzureBlobBackend(string url, Dictionary<string, string?> options)
|
|
{
|
|
var uri = new Utility.Uri(url);
|
|
uri.RequireHost();
|
|
|
|
var containerName = (uri.Host ?? "").ToLowerInvariant();
|
|
|
|
var auth = AuthOptionsHelper.ParseWithAlias(options, uri, AZURE_ACCOUNT_NAME_OPTION, AZURE_ACCESS_KEY_OPTION);
|
|
var timeouts = TimeoutOptionsHelper.Parse(options);
|
|
|
|
var sasToken = options.GetValueOrDefault(AZURE_ACCESS_SAS_TOKEN_OPTION);
|
|
if (!auth.HasUsername)
|
|
throw new UserInformationException(Strings.AzureBlobBackend.NoStorageAccountName, "AzureNoAccountName");
|
|
|
|
if (!auth.HasPassword && string.IsNullOrWhiteSpace(sasToken))
|
|
throw new UserInformationException(Strings.AzureBlobBackend.NoAccessKeyOrSasToken, "AzureNoAccessKeyOrSasToken");
|
|
|
|
var archiveClasses = ParseStorageClasses(options.GetValueOrDefault(AZURE_ARCHIVE_CLASSES_OPTION));
|
|
var accessTierValue = options.GetValueOrDefault(AZURE_ACCESS_TIER_OPTION);
|
|
var accessTier = string.IsNullOrWhiteSpace(accessTierValue)
|
|
? null
|
|
// Warning: The cast here is required to avoid implicit casting null to AccessTier
|
|
: (AccessTier?)new AccessTier(accessTierValue);
|
|
var internalRetries = Library.Utility.Utility.ParseIntOption(options, AZURE_INTERNAL_RETRIES_OPTION, DEFAULT_INTERNAL_RETRIES);
|
|
_azureBlob = new AzureBlobWrapper(auth.Username!, auth.Password, sasToken, containerName, accessTier, archiveClasses, timeouts, internalRetries);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Parses the storage classes from the string
|
|
/// </summary>
|
|
/// <param name="storageClass">The storage class string</param>
|
|
/// <returns>The storage classes</returns>
|
|
private static IReadOnlySet<AccessTier> ParseStorageClasses(string? storageClass)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(storageClass))
|
|
return DEFAULT_ARCHIVE_CLASSES;
|
|
|
|
return new HashSet<AccessTier>(storageClass.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries).Select(x => new AccessTier(x)));
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
public string DisplayName => Strings.AzureBlobBackend.DisplayName;
|
|
|
|
/// <inheritdoc/>
|
|
public string ProtocolKey => "azure";
|
|
|
|
/// <inheritdoc/>
|
|
public bool SupportsStreaming => true;
|
|
|
|
/// <inheritdoc/>
|
|
public IAsyncEnumerable<IFileEntry> ListAsync(CancellationToken cancelToken)
|
|
=> _azureBlob.ListContainerEntriesAsync(cancelToken);
|
|
|
|
public async Task PutAsync(string remotename, string localname, CancellationToken cancelToken)
|
|
{
|
|
await using var fs = File.Open(localname,
|
|
FileMode.Open, FileAccess.Read, FileShare.Read);
|
|
await PutAsync(remotename, fs, cancelToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public Task PutAsync(string remotename, Stream input, CancellationToken cancelToken)
|
|
{
|
|
return WrapWithExceptionHandler(_azureBlob.AddFileStream(remotename, input, cancelToken));
|
|
}
|
|
|
|
public async Task GetAsync(string remotename, string localname, CancellationToken cancellationToken)
|
|
{
|
|
await using var fs = File.Open(localname,
|
|
FileMode.Create, FileAccess.Write,
|
|
FileShare.None);
|
|
await GetAsync(remotename, fs, cancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
public Task GetAsync(string remotename, Stream output, CancellationToken cancellationToken)
|
|
{
|
|
return WrapWithExceptionHandler(_azureBlob.GetFileStreamAsync(remotename, output, cancellationToken));
|
|
}
|
|
|
|
public Task DeleteAsync(string remotename, CancellationToken cancellationToken)
|
|
{
|
|
return WrapWithExceptionHandler(_azureBlob.DeleteObjectAsync(remotename, cancellationToken));
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public Task<DateTime?> GetObjectLockUntilAsync(string remotename, CancellationToken cancellationToken)
|
|
{
|
|
return _azureBlob.GetObjectLockUntilAsync(remotename, cancellationToken);
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public Task SetObjectLockUntilAsync(string remotename, DateTime lockUntilUtc, CancellationToken cancellationToken)
|
|
{
|
|
return WrapWithExceptionHandler(_azureBlob.SetObjectLockUntilAsync(remotename, lockUntilUtc, cancellationToken));
|
|
}
|
|
|
|
public IList<ICommandLineArgument> SupportedCommands
|
|
{
|
|
get
|
|
{
|
|
return [
|
|
new CommandLineArgument(AZURE_ACCOUNT_NAME_OPTION,
|
|
CommandLineArgument.ArgumentType.String,
|
|
Strings.AzureBlobBackend.StorageAccountNameDescriptionShort,
|
|
Strings.AzureBlobBackend.StorageAccountNameDescriptionLong,
|
|
null,
|
|
[AuthOptionsHelper.AuthUsernameOption]),
|
|
new CommandLineArgument(AZURE_ACCESS_KEY_OPTION,
|
|
CommandLineArgument.ArgumentType.Password,
|
|
Strings.AzureBlobBackend.AccessKeyDescriptionShort,
|
|
Strings.AzureBlobBackend.AccessKeyDescriptionLong,
|
|
null,
|
|
[AuthOptionsHelper.AuthPasswordOption]),
|
|
new CommandLineArgument(AZURE_ACCESS_SAS_TOKEN_OPTION,
|
|
CommandLineArgument.ArgumentType.Password,
|
|
Strings.AzureBlobBackend.SasTokenDescriptionShort,
|
|
Strings.AzureBlobBackend.SasTokenDescriptionLong),
|
|
new CommandLineArgument(AZURE_ARCHIVE_CLASSES_OPTION,
|
|
CommandLineArgument.ArgumentType.Flags,
|
|
Strings.AzureBlobBackend.ArchiveClassesDescriptionShort,
|
|
Strings.AzureBlobBackend.ArchiveClassesDescriptionLong,
|
|
string.Join(",", DEFAULT_ARCHIVE_CLASSES.Select(x => Library.Utility.Utility.FormatInvariantValue(x))),
|
|
null,
|
|
ACCESS_TIERS.Select(x => Library.Utility.Utility.FormatInvariantValue(x)).ToArray()),
|
|
new CommandLineArgument(AZURE_ACCESS_TIER_OPTION,
|
|
CommandLineArgument.ArgumentType.String,
|
|
Strings.AzureBlobBackend.AccessTierDescriptionShort,
|
|
Strings.AzureBlobBackend.AccessTierDescriptionLong,
|
|
"",
|
|
null,
|
|
ACCESS_TIERS.Select(x => x.ToString()).ToArray()),
|
|
new CommandLineArgument(AZURE_INTERNAL_RETRIES_OPTION,
|
|
CommandLineArgument.ArgumentType.Integer,
|
|
Strings.AzureBlobBackend.InternalRetriesDescriptionShort,
|
|
Strings.AzureBlobBackend.InternalRetriesDescriptionLong,
|
|
Library.Utility.Utility.FormatInvariantValue(DEFAULT_INTERNAL_RETRIES)),
|
|
.. TimeoutOptionsHelper.GetOptions()
|
|
];
|
|
}
|
|
}
|
|
|
|
public string Description => Strings.AzureBlobBackend.DescriptionV2;
|
|
|
|
public Task<string[]> GetDNSNamesAsync(CancellationToken cancelToken) => Task.FromResult(_azureBlob.DnsNames);
|
|
|
|
public Task TestAsync(CancellationToken cancellationToken)
|
|
=> this.TestReadWritePermissionsAsync(cancellationToken);
|
|
|
|
public Task CreateFolderAsync(CancellationToken cancellationToken)
|
|
{
|
|
return WrapWithExceptionHandler(_azureBlob.AddContainerAsync(cancellationToken));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Wraps the task with exception handling
|
|
/// </summary>
|
|
private async Task WrapWithExceptionHandler(Task task)
|
|
{
|
|
try
|
|
{
|
|
await task.ConfigureAwait(false);
|
|
}
|
|
catch (RequestFailedException e)
|
|
when (e.Status == 404
|
|
|| e.ErrorCode == BlobErrorCode.BlobNotFound
|
|
|| e.ErrorCode == BlobErrorCode.ResourceNotFound)
|
|
{
|
|
throw new FileMissingException(e.Message, e);
|
|
}
|
|
catch (RequestFailedException e)
|
|
when (e.ErrorCode == BlobErrorCode.ContainerNotFound
|
|
|| e.ErrorCode == BlobErrorCode.ContainerBeingDeleted
|
|
|| e.ErrorCode == BlobErrorCode.ContainerDisabled)
|
|
{
|
|
throw new FolderMissingException(e.Message, e);
|
|
}
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
|
|
}
|
|
}
|
|
}
|