// 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.Diagnostics; using System.Reflection; using System.Web; using Duplicati.Library.Interface; using Duplicati.Library.Utility; namespace Duplicati.Library.SecretProvider; /// /// Implementation of a secret provider that reads secrets from the Unix pass utility /// public class UnixPassProvider : ISecretProvider { /// public string Key => "pass"; /// public string DisplayName => Strings.UnixPassProvider.DisplayName; /// public string Description => Strings.UnixPassProvider.Description; /// public IList SupportedCommands => CommandLineArgumentMapper.MapArguments(new UnixPassProviderConfig()) .ToList(); /// /// The configuration for the secret provider; null if not initialized /// private UnixPassProviderConfig? _config; /// /// The configuration for the Unix pass provider /// private class UnixPassProviderConfig : ICommandLineArgumentMapper { /// /// The command to run to get a password /// public string PassCommand { get; set; } = "pass"; /// /// Gets the command line argument description for a member /// /// The name of the member /// The command line argument description, or null if the member is not a command line argument public static CommandLineArgumentDescriptionAttribute? GetCommandLineArgumentDescription(string name) => name switch { nameof(PassCommand) => new CommandLineArgumentDescriptionAttribute() { Name = "pass-command", Type = CommandLineArgument.ArgumentType.String, ShortDescription = Strings.UnixPassProvider.PassCommandDescriptionShort, LongDescription = Strings.UnixPassProvider.PassCommandDescriptionLong }, _ => null }; /// CommandLineArgumentDescriptionAttribute? ICommandLineArgumentMapper.GetCommandLineArgumentDescription(MemberInfo mi) => GetCommandLineArgumentDescription(mi.Name); } /// public Task InitializeAsync(System.Uri config, CancellationToken cancellationToken) { var args = HttpUtility.ParseQueryString(config.Query); _config = CommandLineArgumentMapper.ApplyArguments(new UnixPassProviderConfig(), args); return Task.CompletedTask; } /// public async Task> ResolveSecretsAsync(IEnumerable keys, CancellationToken cancellationToken) { if (_config is null) throw new InvalidOperationException("The UnixPassProvider has not been initialized"); var result = new Dictionary(); foreach (var key in keys) { var value = await GetString(key, _config, cancellationToken).ConfigureAwait(false); result[key] = value; } return result; } /// /// Gets a string from the pass utility /// /// The name of the secret /// The configuration for the Unix pass provider /// The cancellation token /// The secret private static async Task GetString(string name, UnixPassProviderConfig config, CancellationToken cancellationToken) { var psi = new ProcessStartInfo(config.PassCommand) { RedirectStandardOutput = true, RedirectStandardError = true, UseShellExecute = false, CreateNoWindow = true, }; psi.ArgumentList.Add("show"); psi.ArgumentList.Add(name); using var process = Process.Start(psi); if (process is null) throw new InvalidOperationException("Failed to start pass"); var output = await process.StandardOutput.ReadToEndAsync().ConfigureAwait(false); var error = await process.StandardError.ReadToEndAsync().ConfigureAwait(false); if (!string.IsNullOrWhiteSpace(error)) throw new UserInformationException($"Error running pass: {error}", "PassError"); if (process.ExitCode != 0) throw new UserInformationException($"pass failed with exit code {process.ExitCode}", "PassFailed"); if (string.IsNullOrWhiteSpace(output)) throw new UserInformationException("pass returned no output", "PassNoOutput"); return output.Trim(); } }