Skip to content

Commit

Permalink
Clarify SDK version containing Secret Manager tool (#6564)
Browse files Browse the repository at this point in the history
Fixes #6523

**Changes**
- Display the **Install the Secret Manager tool** section for all versions of ASP.NET Core, since it's not safe to assume the .NET Core SDK version being used.
- Include the specific SDK version number which includes the Secret Manager tool
- Add note about tool warning

[Internal Review Page](https://review.docs.microsoft.com/en-us/aspnet/core/security/app-secrets?branch=pr-en-us-6564&view=aspnetcore-2.0&tabs=windows#install-the-secret-manager-tool)
  • Loading branch information
scottaddie authored May 24, 2018
1 parent f809c37 commit 5ffd62e
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions aspnetcore/security/app-secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to store and retrieve sensitive information as app secret
manager: wpickett
ms.author: scaddie
ms.custom: mvc
ms.date: 05/16/2018
ms.date: 05/23/2018
ms.prod: asp.net-core
ms.technology: aspnet
ms.topic: article
Expand Down Expand Up @@ -43,7 +43,7 @@ The Secret Manager tool stores sensitive data during the development of an ASP.N
## 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. The values are stored in a [JSON](https://json.org/) configuration file in a system-protected user profile folder on the local machine:
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. The values are stored in a JSON configuration file in a system-protected user profile folder on the local machine:

# [Windows](#tab/windows)

Expand Down Expand Up @@ -72,9 +72,18 @@ Don't write code that depends on the location or format of data saved with the S
::: moniker range="<= aspnetcore-2.0"
## Install the Secret Manager tool

The Secret Manager tool is bundled with the .NET Core CLI in .NET Core SDK 2.1. For .NET Core SDK 2.0 and earlier, tool installation is necessary.
The Secret Manager tool is bundled with the .NET Core CLI as of .NET Core SDK 2.1.300. For .NET Core SDK versions before 2.1.300, tool installation is necessary.

Install the [Microsoft.Extensions.SecretManager.Tools](https://www.nuget.org/packages/Microsoft.Extensions.SecretManager.Tools/) NuGet package in your ASP.NET Core project:
> [!TIP]
> Run `dotnet --version` from a command shell to see the installed .NET Core SDK version number.
A warning is displayed if the .NET Core SDK being used includes the tool:

```console
The tool 'Microsoft.Extensions.SecretManager.Tools' is now included in the .NET Core SDK. Information on resolving this warning is available at (https://aka.ms/dotnetclitools-in-box).
```

Install the [Microsoft.Extensions.SecretManager.Tools](https://www.nuget.org/packages/Microsoft.Extensions.SecretManager.Tools/) NuGet package in your ASP.NET Core project. For example:

[!code-xml[](app-secrets/samples/1.x/UserSecrets/UserSecrets.csproj?name=snippet_CsprojFile&highlight=13-14)]

Expand Down

0 comments on commit 5ffd62e

Please sign in to comment.