General Settings

ByteHide Secrets Integration is a simple package that allows you to secure your sensitive data in your .NET projects. This guide will help you get started with ByteHide Secrets Integration in Visual Studio. without extra configurations or processes.

After installing the package and associating your account with the Project Token, your applications will be protected during compilation. It's that simple ✨. However, you can further customize your analysis by configuring the settings in the JSON file.

Configuration File

Name

The name of the configuration file.

{
  "Name": "My Configuration"
}

Project Token

The project token identifies your project in the ByteHide panel, facilitating synchronization with the web panel.

{
  "ProjectToken": "e34762f8-8ad6-0000-0000-000000000000"
}

Environment

The environment to sync secrets with. By default, it's set to

{
  "Environment": "develop"
}

Run Configuration

This configuration determines the protection applied to your application. By default, it's set to

{
  "RunConfiguration": "*"
}

Enabled

If you want to temporarily disable Secrets without uninstalling or deleting the configuration, use Enabled to pause the service indefinitely until you decide to enable it again. By default, it's set to True

{
  "Enabled": "False"
}

DisplayCode

If true will store the extract of code to show in the panel the accurate secret location. By default, it's set to False

{
  "DisplayCode": "True"
}

Throw On Error

If an error occurs during the protection process, you can choose to throw an exception or ignore it and continue the compilation.

{
  "ThrowOnError": "False"
}

Actions

You can configure actions to be executed after the protection process. For example, sending an email or webhook notification.

{
  "Actions": {
    "email": [
      "9b4d7b80-b705-0000-0000-000000000000"
    ],
    "webhook": [
      "9b59dbd9-3def-0000-0000-000000000000"
    ],
    "export": {
      "enabled": true,
      "encrypt": false,
      "prefix": "self_"
    }
  }
}

Export

You can export the secrets from the application to the cloud. You can choose to encrypt the keys of the secrets in the code and set a prefix for automatic replaced secrets.

{
  "export": {
    "enabled": true,
    "encrypt": false,
    "prefix": "self_"
  }
}

enabled: If you want to export the secrets from the application to the cloud, set this property to true. encrypt: If you want to encrypt the keys of the secrets in the code, set this property to true. prefix: The prefix that will be used for automatically replaced secrets. By default, it's set to _auto. If you don't want a prefix, set it to an empty string.