Skip to content

README.md

Latest commit

 

History

History
81 lines (60 loc) · 4.34 KB

README.md

File metadata and controls

81 lines (60 loc) · 4.34 KB
page_type sample
languages
csharp
products
dotnet
description Customer key store for RMS Double Key Encryption
urlFragment

Customer Key Store to enable a second key for use in Azure RMS

The customer key store is used for double key encryption in Azure RMS. This key is kept under your control and not exposed to Microsoft.

Warning

IMPORTANT NOTICE: Please note that this project includes code for encryption libraries. You are responsible for complying with all applicable international and national laws that apply to this software, including the U.S. Export Administration Regulations, as well as end-user, end use and destination restrictions by U.S. and other governments.

Contents

Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.

File/folder Description
src Sample source code.
.gitignore Define what to ignore at commit time.
CHANGELOG.md List of changes to the sample.
CONTRIBUTING.md Guidelines for contributing to the sample.
README.md This README file.
LICENSE The license for the sample.

Prerequisites

Setup

  • In Visual Studio Code extensions install C# and nuget package manager

Running the sample

  • Load the project in Visual Studio Code
  • Open appsettings.json
  • Under 'AzureAd' section replace <tenantid> in 'ValidIssuers' with your Azure AD tenant ID
  • Under 'TestKeys' section modify the following:
    • Change the 'Name' value
    • Change the 'Id' value to contain a GUID
    • If running on prem then add a group in your Active Directory to 'AuthorizedRoles' that should be able to access this key. Roles should be comma delimited. Ex. "AuthorizedRoles": ["role1","role2"]
    • Or you can add a list of email address to 'AuthorizedEmailAddress' that should have access to the key Emails should be comma delimited. Ex. "AuthorizedEmailAddress": ["[email protected]","[email protected]"]
    • Remove whichever one you did not use - 'AuthorizedEmailAddress' or 'AuthorizedRoles'. Both cannot be present
    • Modify the value of 'PublicPem' to be a valid public key in PEM format, on a single line
    • Modify the value of 'PrivatePem' to be a valid private key in PEM format, on a single line
  • Go to Debug -> Start Debugging

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Coding Guidelines Capitalization Conventions