Skip to content

fix(security): redact API key in UnifiClientOptions.ToString() #8

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
ChrisonSimtian merged 1 commit into from
Jun 1, 2026
Merged

fix(security): redact API key in UnifiClientOptions.ToString() #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions src/UnifiSharp/UnifiClientOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,12 @@ public sealed record UnifiClientOptions

return new UnifiClientOptions { BaseUrl = new Uri(baseUrl), ApiKey = apiKey, VerifyTls = verifyTls };
}

/// <summary>
/// Redacted representation. The synthesized record <c>ToString()</c> would
/// otherwise print <see cref="ApiKey"/>, leaking it into any log or
/// interpolated string. The key is never emitted.
/// </summary>
public override string ToString() =>
$"UnifiClientOptions {{ BaseUrl = {BaseUrl}, ApiKey = ***, VerifyTls = {VerifyTls} }}";
}
15 changes: 15 additions & 0 deletions tests/UnifiSharp.Tests/UnifiClientOptionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,19 @@ public void Create_builds_a_client()

Assert.NotNull(client);
}

[Fact]
public void ToString_does_not_leak_the_api_key()
{
var options = new UnifiClientOptions
{
BaseUrl = new Uri("https://192.168.1.1/proxy/network/integration/v1"),
ApiKey = "super-secret-api-key",
};

var text = options.ToString();

Assert.DoesNotContain("super-secret-api-key", text);
Assert.Contains("***", text);
}
}
Loading