Util.AuditEvidenceGatherer
1.0.9
dotnet add package Util.AuditEvidenceGatherer --version 1.0.9
NuGet\Install-Package Util.AuditEvidenceGatherer -Version 1.0.9
<PackageReference Include="Util.AuditEvidenceGatherer" Version="1.0.9" />
<PackageVersion Include="Util.AuditEvidenceGatherer" Version="1.0.9" />
<PackageReference Include="Util.AuditEvidenceGatherer" />
paket add Util.AuditEvidenceGatherer --version 1.0.9
#r "nuget: Util.AuditEvidenceGatherer, 1.0.9"
#addin nuget:?package=Util.AuditEvidenceGatherer&version=1.0.9
#tool nuget:?package=Util.AuditEvidenceGatherer&version=1.0.9
Audit Evidence Gatherer
Set up
- Make sure you have PowerShell version 5.1+ with command
$PSVersionTable - AppSettings can be modified in appSettings.yaml.
- Targeted for .NET 6 runtime.
Use
Evidence Gathering
The program takes in command line arguments create-text or create-pdf, or both, and outputPath.
For example,
.\AuditEvidenceGatherer.exe create-text create-pdf --outputPath C:\\Users\\adamday\\AppData\\Local\\AuditEvG
Note: Be aware of escape characters in folder path
The outputPath flag is the directory that the .txt files will be output to for create-text. For create-pdf,
it should be the directory where the .txt files are located, and it will be the directory where the PDFs are output to.
You must make sure that the work item titles that you are planning to upload to Azure DevOps match exactly with configuration.
This means that workItemTitleWithoutEnvironment in appSettings.yaml should match with the work item title
(without the environment), e.g. "AC-02 (02) - On Box User Accounts." matches to "[MT/GCC] AC-02 (02) - On Box User Accounts"
work item title.
Text files of the output of the PowerShell commands will be created. Those text files will be converted into PDFs.
Errors are recorded in the output/logging/errors.txt file.
To run, execute the .exe file in a terminal with command line arguments.
Program outputs to relative path ./output/ if debug command line argument is passed
and absolute path specified in command line arguments.
You can specify the output path with command line flag --outputPath,
i.e. --outputPath C:\Users\adamday\AppData\Local\AuditEvG
Outputs are saved to files directed by logEventId in appSettings.yaml file.
PDFs will be created from the most recent text files.
If you are getting Unknown command errors, try formatting commands like
powershell -command "& {&'some-command' someParam}"; reference
Uploading Evidence
Uploading can be triggered with upload command line argument.
You must include the inputPath flag directory that contains the zip file you want to upload,
e.g. upload --inputPath C:\\Users\\adamday\\AppData\\Local\\AuditEvG
You must save the work item query in Azure DevOps and use that GUID.
This is not the temporary query ID.
The GUID can be found in the URL, for example in
https://o365trustcompliance.visualstudio.com/Trust/_queries/query/24f64b9a-5b7e-40a4-8053-5c7b80859aa8/
24f64b9a-5b7e-40a4-8053-5c7b80859aa8 is the query ID.
This GUID goes in workItemsQueryId in appSettings.yaml.
Zip file should be named output.zip.
The most recent PDF in each control folder will be uploaded.
environmentNameInWorkItemsTitle in appSettings.yaml is the environment the audit is happening in, for example "[MT/GCC]".
orgName and projectName is the org and project that the items are being uploaded to,
e.g. "o365trustcompliance" and "Trust"
You must make sure that the work item titles that you are planning to upload to Azure DevOps match exactly with configuration.
This means that workItemTitleWithoutEnvironment in appSettings.yaml should match with the work item title
(without the environment) and environmentNameInWorkItemsTitle should match the environment,
e.g. "AC-02 (02) - On Box User Accounts" and "[MT/GCC]" matches to "[MT/GCC] AC-02 (02) - On Box User Accounts"
work item title.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
-
net6.0
- Azure.Identity (>= 1.13.2)
- itext (>= 9.0.0)
- itext.bouncy-castle-adapter (>= 9.0.0)
- Microsoft.Extensions.Configuration (>= 9.0.2)
- Microsoft.Extensions.Configuration.FileExtensions (>= 9.0.2)
- Microsoft.Extensions.Configuration.Json (>= 9.0.2)
- Microsoft.Extensions.DependencyInjection (>= 9.0.2)
- Microsoft.PowerShell.SDK (>= 6.2.7)
- Microsoft.TeamFoundationServer.Client (>= 19.225.1)
- Microsoft.VisualStudio.Services.Client (>= 19.225.1)
- Microsoft.VisualStudio.Services.InteractiveClient (>= 19.225.1)
- Serilog (>= 4.2.0)
- Serilog.Expressions (>= 5.0.0)
- Serilog.Extensions.Logging (>= 9.0.0)
- Serilog.Sinks.Console (>= 6.0.0)
- Serilog.Sinks.File (>= 6.0.0)
- YamlDotNet (>= 16.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.