Configurable Settings - .NET Agent on Linux for Dynamic Analysis

How to apply changes to the Controller environment

Changes in the installation.yaml can be applied by running the install script or the upgrade script. Note that re-running the install script will delete any information that would have been stored previously.

Required fields in installation.yaml

Variable Name Key Value
Explanation of the Variable and Key Values
controller.name String This will be the identifier used in the VF Server UI. So, this should be as precise a name as possible, e.g. "UAT Viper" or "Prod App1"
controller.host String The controller.host is the address that the vFunction Server address with which the Controller will connect. The value needs to start with http:// or https://. The value can be an IP Address or a FQDN
controller.org_id
controller.app_id
controller.client_id
controller.client_secret 		Strings Once the Server is installed, the Admin can log into the UI and create the App. In the UI's Install Controller dialog box, the YAML values for the org_id, app_id, client_id and client_secret will be displayed. The values for this YAML file should be copied for the Server UI to here
controller.type String "dotnet"

Sample with required fields in installation.yaml

controller:
  name: Prod App1
  host: http://10.0.0.143
  org_id: 3cf59199-0a0a-0a0a-0a0a-7c63ffac776e
  app_id: 7b1ab58d-0a0a-0a0a-0a0a-098a113ad721
  client_id: 20761b99-0a0a-0a0a-0a0a-94c2e0bc1859
  client_secret: 6b5b7bc1-0a0a-0a0a-0a0a-2bd10db75e2f
  type: dotnet
  instrconf_additions:
    inclusions:
    exclusions:
server_application:
agent:
viper:
  port: 8091
  aseemblies:
    - /opt/dummy

Optional fields in installation.yaml

agent.application_command

Installation.yaml Configuration
Details

The Path in the Application Command will need to be escaped. This is why they example below includes two backslashes at each folder level.



agent:
   application_command: /opt/vfunction/vf-viper -ap
  • Used to input the command to start the Application from the Command Line
  • Used when the Agent parameters are added to the Environment System Variables
  • Ensures that only the relevant Dotnet Application is hooked and that other processes do not pick up the vFunction Startup Parameters.
  • Used typically in Azure App Services deployments
agent.application_name
Installation.yaml Configuration
Details
agent:
   application_name: vfunction-dotnet-app
  • Used in Azure App Services deployments when the Agent parameters are added to the Environment System Variables
  • Ensures that only the relevant Dotnet Application is hooked and that other processes do not pick up the vFunction Startup Parameters
agent.architecture
Installation.yaml Configuration
Details
agent:
   architecture: x86
  • Used in Azure App Services deployments to define whether the application is 32-bit or 64-bit
  • The two available strings that can be used for values are "x86" and "x64"
controller.agent_port
Installation.yaml Configuration
Details
controller:
   type: dotnet
   agent_port: 9778
  • If the agent_port identified is in use, change the port to use an unused port.
controller.client_certificate
Installation.yaml Configuration
Details
controller:
   client_certificate:
      crt: |
         -----BEGIN CERTIFICATE-----
         ...
         -----END CERTIFICATE-----
      key: |
         -----BEGIN PRIVATE KEY-----
         ...
         -----END PRIVATE KEY-----
  • Adding a Client Certificate and Key to the Controller allows for the vFunction Server and Controller to have some form of verification
  • The Controller loads and sends the Client Certificates to a Server that verifies the source of the traffic. That Server could be set up as an intermediary that manages token validation, such as an IBM DataPower Gateway, before being sent onto the vFunction Server
  • The vFunction Nginx Container could also be configured to "ssl_verify_client on" and point to the Client Certificate which would be loaded on the Nginx Container's filesystem somewhere like /etc/nginx/certs/ca.crt
  • Note that the indentation must be maintained when copy-and-pasting the Certificate and Key into the installation.yaml
controller.instance_id
Installation.yaml Configuration
Details
controller:
   instance_id: containerized
  • Used for containerized vFunction controllers
  • Can be set to any String value (e.g., ID1234)
  • Used to prevent an ongoing increase in the number of Down Controllers in the vFunction Server UI's Select Controllers page when Controllers are down
  • Maps a restarted controllers (i.e., a container that went down and came back up) with a controller in the down state that has the same ID
controller.tags
Installation.yaml Configuration
Details
controller:
   tags:
      - applicationName
      - moduleName
  • Tags can be used during Learning to make sure that Learning occurs on one or all Controllers with a specific Tag. This ensures that, even if a Controller with a specific UUID goes down, Learning will still occur on live Controllers with the desired Tag name

Updated on 23 Feb 2024