DockerSecretsConfigurationSource.cs

namespace Microsoft.Extensions.Configuration.DockerSecrets
{
    using FileProviders;
    using System;

    /// <summary>
    /// An <see cref="ConfigurationProvider"/> for docker secrets.
    /// </summary>
    public class DockerSecretsConfigurationSource : IConfigurationSource
    {
        /// <summary>
        /// Constructor
        /// </summary>
        public DockerSecretsConfigurationSource()
        {
            IgnoreCondition = s => IgnorePrefix != null && s.StartsWith(IgnorePrefix);
        }

        /// <summary>
        /// The secrets directory which will be used if FileProvider is not set.
        /// </summary>
        public string SecretsDirectory { get; set; } = "/run/secrets";

        /// <summary>
        /// Gets or sets the docker secrets word separator.
        /// </summary>
        /// <value>
        /// The docker secrets word separator.
        /// </value>
        public string DockerSecretsWordSeparator { get; set; } = "__";

        /// <summary>
        /// The FileProvider representing the secrets directory.
        /// </summary>
        public IFileProvider FileProvider { get; set; }

        /// <summary>
        /// Docker secrets that start with this prefix will be excluded.
        /// </summary>
        public string IgnorePrefix { get; set; } = "ignore.";

        /// <summary>
        /// Used to determine if a file should be ignored using its name.
        /// </summary>
        public Func<string, bool> IgnoreCondition { get; set; }

        /// <summary>
        /// If false, will throw if the secrets directory doesn't exist.
        /// </summary>
        public bool Optional { get; set; }

        /// <summary>
        /// Builds the <see cref="DockerSecretsConfigurationProvider"/> for this source.
        /// </summary>
        /// <param name="builder">The <see cref="IConfigurationBuilder"/>.</param>
        /// <returns>A <see cref="DockerSecretsConfigurationProvider"/></returns>
        public IConfigurationProvider Build(IConfigurationBuilder builder) =>
            new DockerSecretsConfigurationProvider(this);
    }
}