How to mask the values in query params of URL for Refit API Call in Logs

Question

This is my request :

public class GenerateTokenRequest
{
    [AliasAs("code")]
    public string Code { get; set; } = string.Empty;
    
    [AliasAs("secret")]
    public string Secret { get; set; } = string.Empty;
}

This is my Refit Interface :

public interface IAuthServiceRefitApi 
{
    [Post("/token")]
    Task<GenerateTokenResponse> GenerateTokenAsync(
        [Query] GenerateTokenRequest command,
        CancellationToken cancellationToken = default);
}

This method gets called and then it creates a URL like this :

https://some-url.com/oauth/token?code=SOME_CODE&secret=SOME_SECRET

I want to mask secret values and code with *** in my logs.

For properties that are part of the body, I have used the PiiString concept and then added a custom delegating handler.

But for properties that become part of the URL as query params, I am unable to do it.

Any suggestions on how I should achieve that?

Abhay Dedkawala · Accepted Answer · 2024-07-29 09:55:02Z

0

You have to pass variables directly in method like this:

public interface IAuthServiceRefitApi
{
    [Post("/token")]
    Task<GenerateTokenResponse> GenerateTokenAsync(string code, string secret, CancellationToken cancellationToken = default);
}

Using above code, Your URL will be this :

https://some-url.com/oauth/token?code=SOME_CODE&secret=SOME_SECRET

NOTE : As per your existing code, You have to pass JSON body with https://some-url.com/oauth/token URL.

answered Jul 29, 2024 at 9:55

Abhay Dedkawala

5033 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Hakuna Over a year ago

I want to mask those values in URL in my logs

Abhay Dedkawala Over a year ago

@Hakuna, Remove model GenerateTokenRequest & Directly use variables. Like this : Task<GenerateTokenResponse> GenerateTokenAsync(string code, string secret, CancellationToken cancellationToken = default)

Hakuna Over a year ago

How come that will mask the logs?

Hamlet Hakobyan · Accepted Answer · 2024-07-29 10:45:10Z

0

I assume that your question is not directly related to Refit. To mask some sensitive data in your logs you can use Serilog for logging and its enricher for sensitive data masking. Please refer to this

answered Jul 29, 2024 at 10:45

Hamlet Hakobyan

33.5k6 gold badges55 silver badges70 bronze badges

2 Comments

Hakuna Over a year ago

I am interested in the masking query params that packages only works for body params

Hamlet Hakobyan Over a year ago

Have you had a look at github.com/serilog-contrib/… ?

Collectives™ on Stack Overflow

How to mask the values in query params of URL for Refit API Call in Logs

2 Answers 2

3 Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related