Configure the .NET Core agent
The standard configuration for all agents uses this order of precedence.
Depending on your situation, you can configure the .NET Core agent with:
Tip
Use the Contrast agent configuration editor to create or upload a YAML configuration file, validate YAML and get setting recommendations.
Configure the .NET Core agent for Azure App Service
When using Azure App Service, you can configure the .NET Core agent with:
The Azure Portal: Configure the .NET Core agent using environment variables.
Add all settings to the Application Settings section of the Configuration blade using environment variable syntax.
Environment variables in a web.config file: Place your overrides using the environment variable convention in the
<environmentVariables>
section of<aspNetCore>
element.A YAML configuration file: Upload the file to your Azure web application by including it in your application deployment or using the Kudu console.
In the Configuration\Application Settings blade, add a new application setting called
CONTRAST_CONFIG_PATH
with a value that points to this file.For example, to use the contrast_security.yaml file in the root of your application, add a new application setting with the key
CONTRAST_CONFIG_PATH
and value of D:\Home\site\wwwroot\contrast_security.yaml in Configuration\Application Settings. Application files in Azure App Service are deployed to D:\home\site\wwwroot.
See also
Configure .NET Core agent with environment variables
You can configure environment variables in several ways:
Under IIS, the
web.config
file can be used to configure application environment variablesUnder Azure App services, the Azure platform provides a UI to configure the web site's environment variables.
When developing, the
launchSettings.json
file can be used to configure the environment variables on launched applications.
Tip
You can convert any of the properties in the .NET Core YAML template to environment variables.
To change the agent's logging level (
agent.logger.level
) to "TRACE
", add a setting with keyCONTRAST__AGENT__LOGGER__LEVEL
and value "TRACE
".To change the agent's server name (
server.name
) to "MyServer", add a setting with keyCONTRAST__SERVER__NAME
and value "MyServer".
Here are some of the most common settings:
Environment variable | Purpose |
---|---|
CONTRAST__APPLICATION__NAME | Specify the application name reported to Contrast. |
CONTRAST__APPLICATION__GROUP | Specify the access group for this application. (You must have already created access groups.) |
CONTRAST__APPLICATION__SESSION_METADATA | Provide metadata which is used to create a new session ID in the Contrast web interface. Vulnerabilities discovered by the agent are associated with this new session. |
CONTRAST__SERVER__NAME | Specify the server name reported to Contrast. |
CONTRAST__SERVER__ENVIRONMENT | Specify in which environment the application is running (Development, QA and Production). |
See the .NET Core YAML template for a description of other available properties.
.NET Core YAML configuration template
Use this template to configure the .NET Core agent using a YAML configuration file. (Learn more about YAML configuration.)
Place your YAML file in the default location:
Windows:
C:/ProgramData/contrast/dotnet-core/contrast_security.yaml
Unix:
/etc/contrast/dotnet-core/contrast_security.yaml
https://docs.contrastsecurity.com/common-agent-config/dotnetcore_contrast_security.yaml