The InfoSec Agent is a security and privacy tool for Windows 10 and 11.
The InfoSec Agent project aims to improve the security and privacy of Windows computer users. Currently, there are applications available that do this, but they are mainly targeted at large companies. The goal of this project is to make this accessible to everyone. An application is being developed that collects information about the user's system to discover any security or privacy related vulnerabilities. The results will be presented to the user in a special dashboard, showing the current status of the system, including recommended actions to improve it.
This project is a collaborative effort involving nine students from Utrecht University in The Netherlands, in partnership with the Dutch IT company Guardian360. It serves as the Software Project for the Bachelor's Programme in Computing Sciences at the UU.
This project is also supported by funding from the SIDN Fund (Stichting Internet Domeinregistratie Nederland), the Dutch domain name registrar.
InfoSec-Agent is an Open-Source project licensed under the AGPL-3.0 License.
Feel free to report any bugs or issues you encounter. Your feedback is valuable and helps improve the InfoSec-Agent project.
The tray application and the reporting-page have to be built seperately.
Depending on the supplied build tags, the program can be built for development or production mode.
Supplying the prod build tag buils for production, otherwise it will build for development.
Building for production is only relevant when generating the installer for the program, explained further down this document.
In the scripts folder there are scripts located to easly build both applications for the desired mode.
To build the tray application for development, the default go build command can be used.
To build the reporting-page application for development, change the directory to the reporting-page and use wails build.
During development of the reporting-page, wails dev will build the application and run it, and then will watch for any modifications to the source code and rebuild/re-run on change.
From the terminal, within the InfoSec-Agent folder, run the command go run .
This will build and start the program and a new icon should appear in your system tray.
Clicking on the icon will show a menu containing actions that the program can execute. Any confirmations/messages/errors that the application sends will be sent to the log file located in the %AppData%/InfoSec-Agent directory. The reporting page has its own log file located in the same directory.
The program can be exited by selecting 'Quit' in the menu or by manually interrupting the command line (Ctrl + c)
From the terminal, within the InfoSec-Agent/reporting-page/frontend folder, run the command npm test which will run all test found in the current folder and all subfolders. The tests are located in the InfoSec-Agent/reporting-page/frontend/test folder and only tests defined with the .test.js extension will be run.
To receive a coverage report of the tests, run the command npm test -- --coverage, which will show a table containing coverage of files being tested by the tests.
If you wish to run a specific test, you can run the command npm test -- --testPathPattern=test/specific-test where you would change specific-test to the filename of the test you would like to run. To get coverage from this single test, add --coverage to the end of the command.
From the terminal, within the InfoSec-Agent folder, run the command go test ./... which will run all tests in the current folder and all subfolders.
If you wish to run a specific test, you can run the command go test -run regexp. This will only run the tests that match the regular expression.
The ESLint (for JavaScript) and Stylelint (for css) are installed trough npm.
The configuration for these linters is already defined in reporting-page/package.json and reporting-page/frontend/package.json
To install the linters, open a terminal in the InfoSec-Agent/reporting-page/frontend directory and run:
npm ciTo run ESlint on all JavaScript code, open a terminal in the InfoSec-Agent/reporting-page/frontend directory and run:
npx eslint **/*.jsTo run Stylelint on all CSS code, open a terminal in the InfoSec-Agent/reporting-page/frontend directory and run:
npx stylelint **/*.cssBoth linters accept a --fix flag, to let the linters fix all issues they are able to fix automatically.
Adding this flag will change the code files, make sure to inspect the changes before commiting/pushing them. Not all found issues can be fixed automatically, you may need to fix some issues yourself.
Configuration for these two linters can be found in the reporting-page/frontend/package.json file.
To install the golangci-lint binary on Windows run the following commands in git bash (not in a cmd or PowerShell terminal):
# binary will be $(go env GOPATH)/bin/golangci-lint
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.57.1See golangci-ci install documentation for more information about installation.
After installation of the golangci-lint binary, open an elevated PowerShell and run the following commands:
# This is the default installation path for git for Windows,
# you may need to change it to your own custom installation path
$Env:Path += ";C:\Program Files\Git\usr\bin"
[Environment]::SetEnvironmentVariable("Path", $env:Path, [System.EnvironmentVariableTarget]::Machine)The linter should now be installed, you can check the version of the linter by opening any terminal and running:
golangci-lint --versionTo run the linter, open a terminal in the root of the InfoSec-Agent repository and run:
golangci-lint runThe linter will output the found issues in the CLI and make a golangci-lint-report.json file. You can format this json using any (online) software you like.
To let the linter fix the found issues it is able to fix, open a terminal in the root of the InfoSec-Agent repository and run:
golangci-lint run --fixThis command will change the code files, make sure to inspect the changes before commiting/pushing them. Not all found issues can be fixed automatically, you may need to fix some issues yourself.
To run the linter only on new code (changes compared to the last commit) you can add the --new-from-rev=HEAD~1 flag to the command as well.
The resulting command would be:
golangci-lint run --new-from-rev=HEAD~1
# or
golangci-lint run --new-from-rev=HEAD~1 --fixConfiguration for golangci-lint can be found in the .golangci.yml file in the root of the repository.
All the following information applies to the reporting-page folder.
The build directory is used to house all the build files and assets for your application.
The structure is:
- bin - Output directory
- darwin - macOS specific files
- windows - Windows specific files
The windows directory contains the manifest and rc files used when building with wails build.
These may be customised for your application. To return these files to the default state, simply delete them and
build with wails build.
icon.ico- The icon used for the application. This is used when building usingwails build. If you wish to use a different icon, simply replace this file with your own. If it is missing, a newicon.icofile will be created using theappicon.pngfile in the build directory.installer/*- The files used to create the Windows installer. These are used when building usingwails build.info.json- Application details used for Windows builds. The data here will be used by the Windows installer, as well as the application itself (right-click the exe -> properties -> details)wails.exe.manifest- The main application manifest file.
This project can generate an installer for the InfoSec-Agent application using Inno Setup.
To generate the installer the following software has to be installed:
- Golang - To generate the executable for the system tray application.
- Wails - To generate the executable for the reporting page.
- Wails requires GoLang and NPM
- Inno Setup - To generate the installer itself.
- To use the installer script provided by this project, the Inno Setup directory has to be added to the Path, as the script calls Inno Setup's console-mode compiler, ISCC.exe
How the installer executable is generated is defined in the generate-installer.iss Inno Setup Script file. There is a generate-installer.ps1 PowerShell script, located in the scripts directory, to easily generate the installer. The easiest way to generate the installer is to run this script in a PowerShell instance.
To be able to execute the script, your PowerShell execution policy has to allow running scripts on your device (by default this is disabled in Windows).
For more information about PowerShell execution policies, read the Microsoft documentation. The easiest way to enable running scripts is to open an elevated PowerShell instance and run Set-ExecutionPolicy RemoteSigned.
The version of the software is set using a parameter given to the iscc command. The PowerShell scripts obtains the version information from the most recent git tag, as the tags indicate version numbers.
To generate the installer yourself, without using the provided PowerShell script, you first need to build both the tray and reporting-page executables for production.
There is a build-prod.bat script provided to easily do this.
To build for production, first run go generate to generate the .syso file, required to add the icon and version information to the binary.
After this you can build the executables with the prod build tag supplied.
Then, run the following command from the root of the repository:
iscc .\generate-installer.iss /DMyAppVersion=$VERSIONHere, the VERSION variable needs to be set beforehand to the desired version number.
This command will output a InfoSec-Agent-{Version number}-Setup.exe file in the root of the repository.