chore: Update README.md to the current usage (#84)

* chore: Update README.md to the current usage

* chore: Pin the version of AzureSignTool to 3.0.0

.github/workflows/build_preview.yml

@@ -70,7 +70,7 @@ jobs:
  shell: bash
  run: dotnet publish -c Release --self-contained -r win-x64 -o packages/windows/x64 -p:PublishSingleFile=true -p:PublishTrimmed=true -p:InvariantGlobalization=true -p:DebugType=None -p:DebugSymbols=false -p:VersionSuffix=pr$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
  - name: Install signing tool
- run: dotnet tool install --global AzureSignTool
+ run: dotnet tool install --global AzureSignTool --version 3.0.0
  - name: Digitally sign executable
  env:
  CERT_APP_SECRET: ${{ secrets.AZUREKEYVAULTCLIENTSECRET }}

.github/workflows/build_release.yml

@@ -95,7 +95,7 @@ jobs:
  - name: Build windows x64
  run: dotnet publish -c Release --self-contained -r win-x64 -o packages\windows\x64 -p:PublishSingleFile=true -p:PublishTrimmed=true -p:InvariantGlobalization=true -p:DebugType=None -p:DebugSymbols=false -p:Version=${{ needs.create-release.outputs.release_version }}
  - name: Install signing tool
- run: dotnet tool install --global AzureSignTool
+ run: dotnet tool install --global AzureSignTool --version 3.0.0
  - name: Digitally sign executable
  env:
  CERT_APP_SECRET: ${{ secrets.AZUREKEYVAULTCLIENTSECRET }}

Program.cs

@@ -426,7 +426,7 @@ public static IEnumerable<Example> Examples
  UnParserSettings unParserSettings = new();
  unParserSettings.PreferShortName = true;
  yield return new Example("Output to a CSV file", unParserSettings,new Options { CsvFile = "out.csv" });
- yield return new Example("Output to elasticsearch (Preffered)", unParserSettings, new Options { ElasticsearchHost = "127.0.0.1" });
+ yield return new Example("Output to elasticsearch (Preferred)", unParserSettings, new Options { ElasticsearchHost = "127.0.0.1" });
  yield return new Example("Output to elasticsearch and CSV", unParserSettings, new Options { ElasticsearchHost = "127.0.0.1", CsvFile = "out.csv" });
  yield return new Example("Disable network discovery and provide manual networks", unParserSettings, new Options { ElasticsearchHost = "127.0.0.1", DisableNetworkDiscovery = true, Networks = new List<String>() { "192.168.12.0./23", "192.168.15.0/24" } });
  yield return new Example("Do not enumerate ACLs (FASTER)", unParserSettings, new Options { ElasticsearchHost = "127.0.0.1", DontEnumerateAcls = true });

README.md

@@ -90,27 +90,33 @@ Output to elasticsearch and CSV:
  SMBeagle -c out.csv -e 127.0.0.1
 Disable network discovery and provide manual networks:
  SMBeagle -D -e 127.0.0.1 -n 192.168.12.0./23 192.168.15.0/24
-Scan local filesystem too (SLOW):
- SMBeagle -e 127.0.0.1 -l
 Do not enumerate ACLs (FASTER):
  SMBeagle -A -e 127.0.0.1
 
  -c, --csv-file (Group: output) Output results to a CSV
  file by providing filepath
  -e, --elasticsearch-host (Group: output) Output results to
  elasticsearch by providing elasticsearch
- hostname (port is set to 9200
- automatically)
+ hostname (default port is 9200 , but can be
+ overridden)
+ --elasticsearch-port (Default: 9200) Define the elasticsearch
+ custom port if required
  -f, --fast Enumerate only one files permissions per
  directory
- -l, --scan-local-drives Scan local drives on this machine
- -L, --exclude-local-shares Do not scan local drives on this machine
+ -l, --scan-local-shares Scan the local shares on this machine
  -D, --disable-network-discovery Disable network discovery
- -n, --network Manually add network to scan
- -N, --exclude-network Exclude a network from scanning
+ -n, --network Manually add network to scan (multiple
+ accepted)
+ -N, --exclude-network Exclude a network from scanning (multiple
+ accepted)
  -h, --host Manually add host to scan
  -H, --exclude-host Exclude a host from scanning
  -q, --quiet Disable unneccessary output
+ -S, --exclude-share Do not scan shares with this name (multiple
+ accepted)
+ -s, --share Only scan shares with this name (multiple
+ accepted)
+ -E, --exclude-hidden-shares Exclude shares ending in $
  -v, --verbose Give more output
  -m, --max-network-cidr-size (Default: 20) Maximum network size to scan
  for SMB Hosts