Skip to content

DGS-22404 Add AppRole auth for HC Vault #2527

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

Merged
merged 2 commits into from
Oct 6, 2025
+44 −8
Merged

DGS-22404 Add AppRole auth for HC Vault #2527

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
7f93e5b
DGS-22404 Add AppRole auth for HC Vault
rayokota Oct 4, 2025
50125d2
Minor renaming
rayokota Oct 4, 2025
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
12 changes: 7 additions & 5 deletions src/Confluent.SchemaRegistry.Encryption.HcVault/HcVaultKmsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,22 @@ public class HcVaultKmsClient : IKmsClient

public string KekId { get; }
public string Namespace { get; }
public string TokenId { get; }


public HcVaultKmsClient(string kekId, string ns, string tokenId)
: this(kekId, ns, new TokenAuthMethodInfo(tokenId))
{
}

public HcVaultKmsClient(string kekId, string ns, IAuthMethodInfo authMethod)
{
KekId = kekId;
Namespace = ns;
TokenId = tokenId;


if (!kekId.StartsWith(HcVaultKmsDriver.Prefix))
{
throw new ArgumentException(string.Format($"key URI must start with {HcVaultKmsDriver.Prefix}"));
}
keyId = KekId.Substring(HcVaultKmsDriver.Prefix.Length);
IAuthMethodInfo authMethod = new TokenAuthMethodInfo(tokenId);
Uri uri = new Uri(keyId);
if (uri.Segments.Length == 0)
{
Expand Down
40 changes: 37 additions & 3 deletions src/Confluent.SchemaRegistry.Encryption.HcVault/HcVaultKmsDriver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
using System;
using System.Collections.Generic;
using VaultSharp.V1.AuthMethods;
using VaultSharp.V1.AuthMethods.AppRole;
using VaultSharp.V1.AuthMethods.Token;

namespace Confluent.SchemaRegistry.Encryption.HcVault
{
Expand All @@ -13,7 +16,9 @@ public static void Register()
public static readonly string Prefix = "hcvault://";
public static readonly string TokenId = "token.id";
public static readonly string Namespace = "namespace";

public static readonly string ApproleRoleId = "approle.role.id";
public static readonly string ApproleSecretId = "approle.secret.id";

public string GetKeyUrlPrefix()
{
return Prefix;
Expand All @@ -22,13 +27,42 @@ public string GetKeyUrlPrefix()
public IKmsClient NewKmsClient(IDictionary<string, string> config, string keyUrl)
{
config.TryGetValue(TokenId, out string tokenId);
config.TryGetValue(Namespace, out string ns);
if (tokenId == null)
{
tokenId = Environment.GetEnvironmentVariable("VAULT_TOKEN");
}
config.TryGetValue(Namespace, out string ns);
if (ns == null)
{
ns = Environment.GetEnvironmentVariable("VAULT_NAMESPACE");
}
return new HcVaultKmsClient(keyUrl, ns, tokenId);
config.TryGetValue(ApproleRoleId, out string roleId);
if (roleId == null)
{
roleId = Environment.GetEnvironmentVariable("VAULT_APPROLE_ROLE_ID");
}
config.TryGetValue(ApproleSecretId, out string secretId);
if (secretId == null)
{
secretId = Environment.GetEnvironmentVariable("VAULT_APPROLE_SECRET_ID");
}

IAuthMethodInfo authMethod;
if (roleId != null && secretId != null)
{
authMethod = new AppRoleAuthMethodInfo(roleId, secretId);
}
else if (tokenId != null)
{
authMethod = new TokenAuthMethodInfo(tokenId);
}
else
{
throw new ArgumentException($"Either {TokenId} or both {ApproleRoleId} and {ApproleSecretId} " +
$"must be provided in config or environment variables.");
}

return new HcVaultKmsClient(keyUrl, ns, authMethod);
}
}
}