.NET Core, ASP.NET Core Course, Session 8
1 like175 views
This document provides an overview of configuration in ASP.NET Core, including: - Configuration supports JSON, XML, INI, environment variables, command line arguments, and custom providers. - The configuration system provides access to key-value settings from multiple sources in a hierarchical structure. - Options patterns use classes to represent related settings that can be injected via IOptions and configured from appsettings. - The Secret Manager tool can store secrets during development without checking them into source control.
.NET Core, ASP.NET Core Course, Session 8
- 1. .NET Core + ASP.NET Core Training Course Session 8
- 2. .NET Core What we learned? Session 6, 7 Overview • Overview on HTTP Protocol • Introducing ASP.NET Core applications • Startup Class • Middleware in ASP.NET core • Working with Static Files • Error Handling • Logging
- 3. .NET Core What we’ll learn today? Session 8 Agenda • Working with Configuration • Working with app secrets
- 4. .NET Core Configuration in ASP.NET Core Configuration ASP.NET Core supports • JSON • XML • INI • environment variables • command line arguments • in-memory collection formats for storing application configuration data. We can also write our own custom configuration provider
- 5. .NET Core Getting and setting configuration settings Configuration – Getting Started ASP.NET Core’s configuration system has been re-architected from previous versions of ASP.NET, which relied on System.Configuration and XML configuration files like web.config. The new configuration model provides streamlined access to key/value based settings that can be retrieved from a variety of sources.
- 6. .NET Core Getting and setting configuration settings Configuration – Getting Started To work with settings, it is recommended to instantiate a Configuration in our application’s Startup class. If a name/value pair is written to Configuration, it is not persisted. We should configure at least one source in order for Configuration to function correctly.
- 7. .NET Core Getting and setting configuration settings Configuration – Getting Started
- 8. .NET Core hierarchical configuration settings Configuration – hierarchical It’s not unusual to store configuration values in a hierarchical structure, especially when using external files (e.g. JSON, XML, INI). values can be retrieved using a : separated key, starting from the root of the hierarchy
- 9. .NET Core Using the built-in sources Configuration – built-in sources We are not limited to using a single configuration source.
- 10. .NET Core Using the built-in sources Configuration – built-in sources The order in which configuration sources are specified is important, as this establishes the precedence with which settings will be applied if they exist in multiple locations. The IHostingEnvironment service is used to get the current environment. In the Development environment, the highlighted line of code above would look for a file named appsettings.Development.json and use its values, overriding any other values, if it’s present.
- 11. .NET Core Using the built-in sources Configuration – built-in sources
- 12. .NET Core reloadOnChange Configuration – reloadOnChange When specifying files as configuration sources, you can optionally specify whether changes to the file should result in the settings being reloaded. This is configured by passing in a true value for the reloadOnChange parameter when calling AddJsonFile or similar file-based extension methods. Warning You should never store passwords or other sensitive data in configuration provider code or in plain text configuration files.
- 13. .NET Core Configuration – Overriding values Overriding values
- 14. .NET Core Configuration – reloadOnChange Overriding values
- 15. .NET Core Using Options and configuration objects Configuration – Using Options The options pattern enables using custom options classes to represent a group of related settings. • A class needs to have a public read-write property for each setting and a constructor that does not take any parameters • Options can be injected into our application using the IOptions<TOptions> accessor service. • setup the IOptions<TOptions> service you call the AddOptions extension method during startup in our ConfigureServices method
- 16. .NET Core Using Options and configuration objects Configuration – Using Options
- 17. .NET Core Working with options Configuration – Working with options When you bind options to configuration, each property in your options type is bound to a configuration key of the form property:subproperty:.... For example, the MyOptions.Option1 property is bound to the key Option1, which is read from the option1 property in appsettings.json. Note that configuration keys are case insensitive. Use the AddSingleton<IConfigureOptions<TOptions>> extension method to register a custom IConfigureOptions<TOptions> service to configure options using objects that must be obtained from the service container (for example, to read settings from a database)
- 18. .NET Core Writing custom providers Configuration – Writing custom providers Implement the IConfigurationSource interface, which exposes a Build method. The build method configures and returns an IConfigurationProvider.
- 19. .NET Core Writing custom providers Configuration – Writing custom providers
- 20. .NET Core Writing custom providers Configuration – Writing custom providers By convention you can also add an AddEntityFrameworkConfiguration extension method for adding the configuration source
- 21. .NET Core Summery Configuration – Summery Required Package(s): • Microsoft.Extensions.Configuration.Json • Microsoft.Extensions.Configuration.Ini • Microsoft.Extensions.Configuration.Xml
- 22. .NET Core Summery Configuration – Summery Reading configuration keys: var val = Configuration.GetValue<int>("key-name", defaultValue: 10); For binding configuration structure to a class use: Microsoft.Extensions.Configuration.Binder
- 23. .NET Core Safe storage of app secrets during development Configuration – app secrets • Use the Secret Manager tool to keep secrets out of your code • We should never store passwords or other sensitive data in source code • We shouldn’t use production secrets in development and test mode • The Secret Manager tool helps prevent sensitive data from being checked into source control • The Secret Manager tool is a project tool that can be used to store secrets for a .NET Core project during development • The Secret Manager tool does not encrypt the stored secrets and should not be treated as a trusted store. It is for development purposes only
- 24. .NET Core Safe storage of app secrets during development Configuration – app secrets • Add SecretManager.Tools to the tools section of the project.json file and run dotnet restore • Test the Secret Manager tool by running the following command: • dotnet user-secrets –h "tools": { "Microsoft.AspNetCore.Razor.Tools": "1.0.0", "Microsoft.Extensions.SecretManager.Tools": "1.0.0" },
- 25. .NET Core Safe storage of app secrets during development Configuration – app secrets • The Secret Manager tool operates on project specific configuration settings that are stored in your user profile. To use user secrets the project must specify a userSecretsId value in its project.json file. The value of userSecretsId is arbitrary, but is generally unique to the project. • Add a userSecretsId for your project in its project.json file: • "userSecretsId": "aspnet-WebApp1-c23d27a4-eb88-4b18-9b77-2a93f3b15119", • Use the Secret Manager tool to set a secret. For example, in a command window from the project directory enter the following: • dotnet user-secrets set MySecret ValueOfMySecret
- 26. .NET Core Safe storage of app secrets during development Configuration – app secrets • dotnet user-secrets set MySecret ValueOfMySecret --project c:workWebApp1 Accessing user secrets via configuration You access Secret Manager secrets through the configuration system. Add the Microsoft.Extensions.Configuration.UserSecrets as a dependency in your project.json file and run dotnet restore. "Microsoft.Extensions.Configuration.UserSecrets": "1.0.0",
- 27. .NET Core Safe storage of app secrets during development Configuration – app secrets How the Secret Manager tool works The secret manager tool abstracts away the implementation details, such as where and how the values are stored. You can use the tool without knowing these implementation details. In the current version, the values are stored in a JSON configuration file in the user profile directory: • Windows: %APPDATA%microsoftUserSecrets<userSecretsId>secrets.json • Linux: ~/.microsoft/usersecrets/<userSecretsId>/secrets.json • Mac: ~/.microsoft/usersecrets/<userSecretsId>/secrets.json • The value of userSecretsId comes from the value specified in project.json