Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 4.04 KB

README.md

File metadata and controls

80 lines (58 loc) · 4.04 KB
Raw

Get started with signals using C#.NET

In this tutorial for signals development using C# you'll submit sample signals to SAFE and create your own signal.

This tutorial will show you how to:

  1. Run sample application that generates signals and submits to SAFE.
  2. Check the results in SAFE.
  3. Create your own signal.
  4. Create a zip file for multiple signals and submit it to SAFE (Optional, use in case of bulk signals submission)

Pre-Requisites

How to run sample application

  1. Check out the signals repository to your machine from Github.
  2. Navigate to signals\csharp\src\ folder and open SignalsSampleApp.sln file in Visual studio 2022.
  3. Go to App project inside the solution and open appSettings.json
  4. Fill following properties in the json file
    1. SafeUrl-(Required) Base Url of the Safe Server.
    2. ApiUsername and ApiPassword (Required)- REST api credentials to access SAFE API's
    3. ExamplesDirectoryPath(Optional)- Directory path where sample signal json's reside. Path to be added in following manner ExamplesDirectoryPath-C:\\Users\\Username\\Desktop\\samples If this path is not set then default examples directory path will be picked.
    4. Click on Save
  5. In Visual studio click on Build and select Rebuild solution.
  6. Once successfully build, start the application by clicking on App button.
  7. Console should show the status and names of signals successfully submitted.

Check results on SAFE

  1. Login to SAFE and click on Technology->Assets from left navigation view.
  2. Search for asset MyVirtualMachine.acme.com and click on the asset.
  3. Scroll down to see list of controls that were sent using signal.

Create your own signal

See Signal specification

  1. Create instance of signal as per specification.
  2. Call library method SubmitSignal() using the signal created in step 1.

Create a zip file for multiple signals and submit it to SAFE

In a real world scenario to get an overall risk posture of an asset, it must have multiple security controls attached to it. Safe also supports bulk signal submission. Bulk submission can be used in case of submitting all signals related to single entity in bulk. To use this feature please follow the below steps:-.

  1. Create different signals as per signal specification applicable to an asset and save them as individual .json files.

  2. Create config.json with following code snippet

    {
  "assetMatchingCriteria": [
    "fqdn",
    "assetName",
    "ipAddress"
  ],
  "shouldImportAssets": true,
  "fullAssessmentForTypes": [
    "va"
  ]
}

    Only the above mentioned properties are accepted in SAFE from config.json

    Description about the properties

    • assetMatchingCriteria- Is used to match existing asset in SAFE based on the priority fqdn, assetName, ipAddress.
    • shouldImportAssets- will inform SAFE whether to import this asset on SAFE portal.
    • fullAssessmentForTypes- this will upload new set of security findings for a particular type of security context for an asset and old findings if present are discarded. It accepts array of strings containing SecurityType as mentioned in Enums

  3. Create a zip file consisting of files from step 1 and step 2.

  4. Now using the instance of communication class call SubmitSignalZip() with filepath as argument to this method.

  5. Zip should be posted successfully to the API.