Kenneth Skovhede
6c7843b332
This PR adds a unified way of supplying timeouts to each of the backends. It also adds an opt-in way of adding commonly used options, so parsing and usage can be standardized across multiple backends.
91 lines
3.9 KiB
C#
91 lines
3.9 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.
|
|
|
|
#nullable enable
|
|
using System.Collections.Generic;
|
|
using Duplicati.Library.Interface;
|
|
|
|
namespace Duplicati.Library.Utility.Options;
|
|
|
|
/// <summary>
|
|
/// Helper class for unified use of authentication settings
|
|
/// </summary>
|
|
public static class AuthOptionsHelper
|
|
{
|
|
/// <summary>
|
|
/// Gets the authentication options
|
|
/// </summary>
|
|
/// <param name="prefix">An optional prefix for the options</param>
|
|
/// <returns>The authentication options</returns>
|
|
public static CommandLineArgument[] GetOptions(string? prefix = null) =>
|
|
[
|
|
new CommandLineArgument($"{prefix}auth-username", CommandLineArgument.ArgumentType.String, Strings.AuthSettingsHelper.DescriptionAuthUsernameShort, Strings.AuthSettingsHelper.DescriptionAuthUsernameLong),
|
|
new CommandLineArgument($"{prefix}auth-password", CommandLineArgument.ArgumentType.Password, Strings.AuthSettingsHelper.DescriptionAuthPasswordShort, Strings.AuthSettingsHelper.DescriptionAuthPasswordLong)
|
|
];
|
|
|
|
/// <summary>
|
|
/// Structure to hold the authentication options
|
|
/// </summary>
|
|
/// <param name="Username">The username</param>
|
|
/// <param name="Password">The password</param>
|
|
public sealed record AuthOptions(string? Username, string? Password)
|
|
{
|
|
/// <summary>
|
|
/// Checks if the username has a value
|
|
/// </summary>
|
|
public bool HasUsername => !string.IsNullOrWhiteSpace(Username);
|
|
/// <summary>
|
|
/// Checks if the password has a value
|
|
/// </summary>
|
|
public bool HasPassword => !string.IsNullOrWhiteSpace(Password);
|
|
|
|
/// <summary>
|
|
/// Checks if the username and password are set
|
|
/// </summary>
|
|
/// <returns>True if the username and password are set</returns>
|
|
public bool IsValid() => HasUsername && HasPassword;
|
|
|
|
/// <summary>
|
|
/// Throws an exception if the username and password are not set
|
|
/// </summary>
|
|
public void RequireCredentials()
|
|
{
|
|
if (!IsValid())
|
|
throw new UserInformationException(Strings.AuthSettingsHelper.UsernameAndPasswordRequired, "UsernameAndPasswordRequired");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Parses the authentication options from a dictionary
|
|
/// </summary>
|
|
/// <param name="options">The dictionary to parse</param>
|
|
/// <param name="prefix">An optional prefix for the options</param>
|
|
/// <returns>The parsed authentication options</returns>
|
|
public static AuthOptions Parse(IReadOnlyDictionary<string, string?> options, string? prefix = null)
|
|
=> new AuthOptions(
|
|
options.GetValueOrDefault($"{prefix}auth-username"),
|
|
options.GetValueOrDefault($"{prefix}auth-password")
|
|
);
|
|
}
|
|
|
|
}
|