Skip to main content

.NET Core - (User) Secrets Exposed!

Managing credentials is hard. Developers try to keep development credentials separate from Production ones by using weird pre-processor directives or convoluted if...else statements. If you have ever worked with a development team, you know these quickly go out of hand. You might also have used environment variables to define configuration such as a database connection string. These work great but still cause some issue when moving between Windows and Linux OSes. For example, Bash does not like the : based hierarchical structure defined by .NET Core. So you have to replace the : with __ (double underscores). Environment variables are also harder to manage unless you are using a third party tool.

Fortunately, .NET Core 3.0 onward now ships with a built-in Secret Manager. These are called User Secrets and are stored on a per-user (duh!) basis typically at this path %APPDATA%\Microsoft\UserSecrets\<user_secrets_id>\secrets.json. We need not worry about the location of this file as all this is abstracted away from the user.

To enable user secrets on a project, run the following command while present in the same directory where .csproj is present:
dotnet user-secrets init
This adds a UserSecretsId element within a PropertyGroup of the .csproj file. By default, the inner text of UserSecretsId is a GUID. The inner text is arbitrary, but is unique to the project.

Next create a secret in a key/value combination. For example,
dotnet user-secrets set "ConnectionStrings:AppConfig" "MyConnString"
This user secret source is automatically inserted when CreateDefaultBuilder method is called and environment is Development.

To use this secret, you just have to call the Configuration indexer as you would call normally.
public void ConfigureServices(IServiceCollection services)
{ 
    _appConfig = Configuration["ConnectionStrings:AppConfig"]; 
}
To remove a secret or clear all secrets or list the secrets, use the corresponding remove, clear or list commands. If you are using Visual Studio, you can use the “Manage User Secrets” context menu to manage the secrets.

Note that user secrets does not replace any other means of inserting settings in your .NET application. You can still use them together just mindful of the fact that the order in which these settings are loaded defines overriding works.
builder.ConfigureAppConfiguration((hostingContext, config) => 
{ 
   ... 
   config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true) 

   // Added before AddUserSecrets to let user secrets override 
   // environment variables. 
   config.AddEnvironmentVariables(); 
}
User Secrets are a great addition to the .NET Core toolbox. They provide a standardized way of managing development secrets without the need to write any extra code or convoluted logic.

Comments

Popular posts from this blog

Integrating React with SonarQube using Azure DevOps Pipelines

In the world of automation, code quality is of paramount importance. SonarQube and Azure DevOps are two tools which solve this problem in a continuous and automated way. They play well for a majority of languages and frameworks. However, to make the integration work for React applications still remains a challenge. In this post we will explore how we can integrate a React application to SonarQube using Azure DevOps pipelines to continuously build and assess code quality. Creating the React Application Let's start at the beginning. We will use npx to create a Typescript based React app. Why Typescript? I find it easier to work and more maintainable owing to its strongly-typed behavior. You can very well follow this guide for jsx based applications too. We will use the fantastic Create-React-App (CRA) tool to create a React application called ' sonar-azuredevops-app '. > npx create-react-app sonar-azuredevops-app --template typescript Once the project creation is done, we

Centralized Configuration for .NET Core using Azure Cosmos DB and Narad

We are living in a micro services world. All these services are generally hosted in Docker container which are ephemeral. Moreover these service need to start themselves up, talk to each other, etc. All this needs configuration and there are many commercially available configuration providers like Spring Cloud Config Server, Consul etc. These are excellent tools which provide a lot more functionality than just storing configuration data. However all these have a weakness - they have a single point of failure - their storage mechanism be it a file system, database etc. There are ways to work around those but if you want a really simple place to store configuration values and at the same time make it highly available, with guaranteed global availability and millisecond reads, what can be a better tool than Azure Cosmos DB! So I set forth on this journey for ASP.NET Core projects to talk to Cosmos DB to retrieve their configuration data. For inspiration I looked at Steeltoe Con

App-pocalypse

Have you recently tried to shop on any Indian e-commerce website? If you have, you too would be frustrated by the constant nagging done by these sites to download their app. Myntra has gone ahead and shut its website down completely! Others like Flipkart won't let you browse any product in peace and will immediately try to "connect" you to their app - even when you are already at their site and trying to buy a product. Amazon India will release "app-only" offers and discounts. All this is done in the garb of making customer experience better. @mayankMSFT We direct users to the mobile App in order to provide better shopping experience. We have passed your feedback along. — flipkartsupport (@flipkartsupport) August 7, 2015 Only problem is that it makes user experience even worse. These companies are trying to lure the consumer into a walled garden so that they make bad, misinformed buying decisions . Let me elaborate. On a desktop browser