// 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.Runtime.Versioning;
using System.Text;
using Duplicati.Library.Interface;
using Duplicati.Library.Logging;
using secrets.DBus;
using Tmds.DBus.Protocol;
namespace Duplicati.Library.SecretProvider.LibSecret;
///
/// Implementation of the secret collection for libsecret
///
[SupportedOSPlatform("Linux")]
public class SecretCollection : IDisposable
{
private static readonly string LogTag = Log.LogTagFromType();
///
/// The secrets service
///
private readonly secretsService _secretsService;
///
/// The service instance
///
private readonly Service _service;
///
/// The session instance
///
private readonly Session _session;
///
/// The collection instance
///
private readonly Collection _collection;
///
/// Whether the collection is locked
///
private bool _locked;
///
/// Creates a new secret collection
///
/// The secrets service
/// The service instance
/// The session instance
/// The collection instance
/// Whether the collection is locked
private SecretCollection(secretsService secretsService, Service service, Session session, Collection collection, bool locked)
{
_secretsService = secretsService;
_service = service;
_session = session;
_collection = collection;
_locked = locked;
}
///
/// Creates a new secret collection
///
/// The collection name
/// The cancellation token
/// The created secret collection
public static async Task CreateAsync(string collectionName, CancellationToken cancellationToken)
{
var connection = Connection.Session;
var secretsService = new secretsService(connection, "org.freedesktop.secrets");
var service = secretsService.CreateService("/org/freedesktop/secrets");
var (_, sessionPath) = await service.OpenSessionAsync("plain", "").ConfigureAwait(false);
collectionName ??= "";
var collectionPath = (await service.GetCollectionsAsync().ConfigureAwait(false))
.FirstOrDefault(c => c.ToString().EndsWith(collectionName, StringComparison.OrdinalIgnoreCase));
if (!collectionPath.ToString().EndsWith(collectionName, StringComparison.OrdinalIgnoreCase))
throw new UserInformationException($"Collection {collectionName} not found", "CollectionNotFound");
var session = secretsService.CreateSession(sessionPath);
var collection = secretsService.CreateCollection(collectionPath.ToString());
var locked = await collection.GetLockedAsync().ConfigureAwait(false);
return new SecretCollection(secretsService, service, session, collection, locked);
}
///
/// Unlocks the collection
///
/// The task to await
public async Task UnlockAsync()
{
if (!_locked)
return;
var (unlocked, prompt) = await _service.UnlockAsync([_collection.Path]);
if (prompt != null && prompt != "/")
{
var promptInstance = _secretsService.CreatePrompt(prompt);
var completedTask = new TaskCompletionSource();
// Set up callback
using var result = await promptInstance.WatchCompletedAsync((exception, result) =>
{
if (exception != null)
completedTask.TrySetException(exception);
else if (result.Dismissed)
completedTask.TrySetResult(false);
else
completedTask.TrySetResult(true);
}).ConfigureAwait(false);
// Prompt
await promptInstance.PromptAsync(Guid.NewGuid().ToString()).ConfigureAwait(false);
// Wait for prompt to be dismissed or completed
var done = await completedTask.Task.ConfigureAwait(false);
if (!done)
throw new UserInformationException("Dimissed collection unlock prompt", "UnlockDismissed");
// Unlock again, so we have the handles
(unlocked, prompt) = await _service.UnlockAsync([_collection.Path]);
}
if (unlocked.Length == 0)
throw new UserInformationException("Failed to unlock collection", "UnlockFailed");
}
///
/// Obtains the secrets from the collection
///
/// The labels to look for
/// The string comparer
/// The dictionary of secrets
public async Task> GetSecretsAsync(IEnumerable labels, StringComparer comparer)
{
var attributes = new Dictionary();
var collection = _secretsService.CreateCollection(_collection.Path);
var entries = await collection.SearchItemsAsync(attributes).ConfigureAwait(false);
var result = new Dictionary(comparer);
var missing = labels.ToHashSet(comparer);
if (missing.Count == 0)
return result;
// Enumerate all items in the collection
foreach (var r in entries)
{
var item = _secretsService.CreateItem(r);
try
{
var label = await item.GetLabelAsync().ConfigureAwait(false);
if (missing.Contains(label))
{
var (sessionPath, _, secret, contentType) = await item.GetSecretAsync(_session.Path).ConfigureAwait(false);
result[label] = Encoding.Default.GetString(secret);
missing.Remove(label);
if (missing.Count == 0)
break;
}
}
catch (Exception ex)
{
Log.WriteWarningMessage(LogTag, "SecretLookupError", ex, "Failed to get returned secret");
}
}
if (missing.Count > 0)
throw new UserInformationException($"Missing secrets: {string.Join(", ", missing)}", "MissingSecrets");
return result;
}
///
public void Dispose()
{
try { _session.CloseAsync().Wait(); } catch { }
}
}