Files
duplicati/Duplicati/Server/Duplicati.Server.Serialization/Interface/IBackup.cs
T
Kenneth Skovhede e009a0f3ec Remote source masking and encrypting
This PR adds masking to remote sources so the passwords are not leaked to the browser. The logic works the same as for TargetURL, where the sensitive fields are replaced by a password placeholder before being transmitted via the endpoints.

When data returns, the masking is removed by looking at the original source and the unmasked value is then encrypted before being stored in the database.

Since the sources is an array and not just a single field, the logic here uses the mount point as a "key" for figuring out which new sources map to the original sources. This is robust in the face of re-ordering, deletions and additions.

If there is just a single remote source (assumed most common) this will match even if the prefix does not, making it possible to change the prefix in this case.

For multi-remote sources, it is not possible to change the prefix without also re-typing all masked properties.

If there is a need later, we could extend the matching to look for how many unique protocols are there, and maybe servers as well to try to match better when the prefixes have been renamed.

There is a guard right before saving a source that rejects it if the source contains the placeholder so we ensure that even faulty logic cannot persist an invalid connection string.
2026-01-30 14:36:57 +01:00

103 lines
3.6 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 System.Collections.Generic;
namespace Duplicati.Server.Serialization.Interface
{
/// <summary>
/// All settings for a single backup
/// </summary>
public interface IBackup
{
/// <summary>
/// The backup ID
/// </summary>
string ID { get; set; }
/// <summary>
/// An external ID for tracking the backup, or null if not set
/// </summary>
string ExternalID { get; set; }
/// <summary>
/// The backup name
/// </summary>
string Name { get; set; }
/// <summary>
/// The backup description
/// </summary>
string Description { get; set; }
/// <summary>
/// The backup tags
/// </summary>
string[] Tags { get; set; }
/// <summary>
/// The backup target url
/// </summary>
string TargetURL { get; set; }
/// <summary>
/// The path to the local database
/// </summary>
string DBPath { get; }
/// <summary>
/// The backup source folders and files
/// </summary>
string[] Sources { get; set; }
/// <summary>
/// The backup settings
/// </summary>
ISetting[] Settings { get; set; }
/// <summary>
/// The filters applied to the source files
/// </summary>
IFilter[] Filters { get; set; }
/// <summary>
/// The backup metadata
/// </summary>
IDictionary<string, string> Metadata { get; set; }
/// <summary>
/// Gets a value indicating if this instance is not persisted to the database
/// </summary>
bool IsTemporary { get; }
/// <summary>
/// Removes sensitive information from the backup settings and target URL
/// </summary>
void RemoveSensitiveInformation();
/// <summary>
/// Masks sensitive information in the backup settings and target URL
/// </summary>
void MaskSensitiveInformation();
/// <summary>
/// Unmasks sensitive information in the backup settings and target URL
/// </summary>
/// <param name="previous">The previous backup configuration to restore sensitive information from</param>
void UnmaskSensitiveInformation(IBackup previous);
}
}