Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove guard.net from core and keyvault secret provider #435

Merged
merged 2 commits into from
Sep 17, 2024
Merged

chore: remove guard.net from core and keyvault secret provider #435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31e2955
chore: remove guard.net from core and keyvault secret provider
stijnmoreels Sep 17, 2024
bb8d16c
pr-fix: fix remaining expected exception types
stijnmoreels Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/Arcus.Security.Core/Arcus.Security.Core.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@

<ItemGroup>
<PackageReference Include="Arcus.Observability.Telemetry.Core" Version="[3.0.0,4.0.0)" />
<PackageReference Include="Guard.Net" Version="3.0.0" />
<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="6.0.0" />
<PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
</ItemGroup>
Expand Down
79 changes: 56 additions & 23 deletions src/Arcus.Security.Core/Caching/CachedSecretProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
using System.Linq;
using System.Threading.Tasks;
using Arcus.Security.Core.Caching.Configuration;
using GuardNet;
using Microsoft.Extensions.Caching.Memory;

namespace Arcus.Security.Core.Caching
Expand All @@ -29,16 +28,15 @@ public class CachedSecretProvider : ICachedSecretProvider, IVersionedSecretProvi
/// <exception cref="ArgumentOutOfRangeException">Thrown when the <see cref="ICacheConfiguration.Duration"/> is not a positive time duration.</exception>
public CachedSecretProvider(ISecretProvider secretProvider, ICacheConfiguration cacheConfiguration, IMemoryCache memoryCache)
{
Guard.NotNull(secretProvider, nameof(secretProvider), "Requires a secret provider instance to include caching while retrieving secrets");
Guard.NotNull(memoryCache, nameof(memoryCache), "Requires a memory caching implementation to include caching while retrieving secrets");
Guard.NotNull(cacheConfiguration, nameof(cacheConfiguration), "Requires a configuration instance to influence the caching during the retrieval of secrets");
Guard.NotLessThan(cacheConfiguration.Duration, TimeSpan.Zero, nameof(cacheConfiguration),
"Requires a positive time duration in the cache configuration in which the caching should take place");

_secretProvider = secretProvider;
_cacheConfiguration = cacheConfiguration;

MemoryCache = memoryCache;
_secretProvider = secretProvider ?? throw new ArgumentNullException(nameof(secretProvider));
_cacheConfiguration = cacheConfiguration ?? throw new ArgumentNullException(nameof(cacheConfiguration));

if (_cacheConfiguration.Duration < TimeSpan.Zero)
{
throw new ArgumentOutOfRangeException(nameof(cacheConfiguration), cacheConfiguration.Duration, "Requires a positive time duration in the cache configuration in which the caching should take place");
}

MemoryCache = memoryCache ?? throw new ArgumentNullException(nameof(memoryCache));

CacheEntry = new MemoryCacheEntryOptions()
// Keep in cache for this time, reset time if accessed.
Expand Down Expand Up @@ -93,8 +91,11 @@ public CachedSecretProvider(ISecretProvider secretProvider) :
/// <exception cref="SecretNotFoundException">The secret was not found, using the given name</exception>
public Task<string> GetRawSecretAsync(string secretName)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the secret");

if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

return GetRawSecretAsync(secretName, ignoreCache: false);
}

Expand All @@ -108,7 +109,10 @@ public Task<string> GetRawSecretAsync(string secretName)
/// <exception cref="SecretNotFoundException">The secret was not found, using the given name</exception>
public Task<Secret> GetSecretAsync(string secretName)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the secret");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

return GetSecretAsync(secretName, ignoreCache: false);
}
Expand All @@ -124,7 +128,10 @@ public Task<Secret> GetSecretAsync(string secretName)
/// <exception cref="SecretNotFoundException">The secret was not found, using the given name</exception>
public async Task<string> GetRawSecretAsync(string secretName, bool ignoreCache)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the secret");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

Secret secret = await GetSecretAsync(secretName, ignoreCache);
return secret?.Value;
Expand All @@ -141,7 +148,10 @@ public async Task<string> GetRawSecretAsync(string secretName, bool ignoreCache)
/// <exception cref="SecretNotFoundException">The secret was not found, using the given name</exception>
public async Task<Secret> GetSecretAsync(string secretName, bool ignoreCache)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the secret");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

if (TryGetValueFromCache(secretName, ignoreCache, out Secret[] cachedSecret))
{
Expand Down Expand Up @@ -177,8 +187,15 @@ private bool TryGetValueFromCache(string secretName, bool ignoreCache, out Secre
/// <exception cref="SecretNotFoundException">Thrown when no secret was not found, using the given <paramref name="secretName"/>.</exception>
public async Task<IEnumerable<string>> GetRawSecretsAsync(string secretName, int amountOfVersions)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the versioned secrets");
Guard.NotLessThan(amountOfVersions, 1, nameof(amountOfVersions), "Requires at least 1 secret version to look up the versioned secrets");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

if (amountOfVersions < 1)
{
throw new ArgumentOutOfRangeException(nameof(amountOfVersions), amountOfVersions, "Requires at least 1 secret version to look up the versioned secrets");
}

IEnumerable<Secret> secrets = await GetSecretsAsync(secretName, amountOfVersions);
return secrets?.Select(secret => secret?.Value).ToArray();
Expand All @@ -194,8 +211,15 @@ public async Task<IEnumerable<string>> GetRawSecretsAsync(string secretName, int
/// <exception cref="SecretNotFoundException">Thrown when no secret was not found, using the given <paramref name="secretName"/>.</exception>
public async Task<IEnumerable<Secret>> GetSecretsAsync(string secretName, int amountOfVersions)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the versioned secrets");
Guard.NotLessThan(amountOfVersions, 1, nameof(amountOfVersions), "Requires at least 1 secret version to look up the versioned secrets");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

if (amountOfVersions < 1)
{
throw new ArgumentOutOfRangeException(nameof(amountOfVersions), amountOfVersions, "Requires at least 1 secret version to look up the versioned secrets");
}

if (_secretProvider is IVersionedSecretProvider versionProvider)
{
Expand Down Expand Up @@ -224,7 +248,10 @@ public async Task<IEnumerable<Secret>> GetSecretsAsync(string secretName, int am
/// <param name="secretName">The name of the secret that should be removed from the cache.</param>
public Task InvalidateSecretAsync(string secretName)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to invalidate the cached secret");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to invalidate the secret", nameof(secretName));
}

MemoryCache.Remove(secretName);
return Task.CompletedTask;
Expand All @@ -239,7 +266,10 @@ public Task InvalidateSecretAsync(string secretName)
/// <exception cref="SecretNotFoundException">Thrown when the secret was not found, using the given name.</exception>
public string GetRawSecret(string secretName)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the secret");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

Secret secret = GetSecret(secretName);
return secret?.Value;
Expand All @@ -254,7 +284,10 @@ public string GetRawSecret(string secretName)
/// <exception cref="SecretNotFoundException">Thrown when the secret was not found, using the given name.</exception>
public Secret GetSecret(string secretName)
{
Guard.NotNullOrWhitespace(secretName, nameof(secretName), "Requires a non-blank secret name to look up the secret");
if (string.IsNullOrWhiteSpace(secretName))
{
throw new ArgumentException("Requires a non-blank secret name to look up the secret", nameof(secretName));
}

if (TryGetValueFromCache(secretName, ignoreCache: false, out Secret[] cachedSecrets))
{
Expand Down
Loading
Loading