Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marest94 committed Feb 27, 2024
1 parent aa7af43 commit db90b30
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
4 changes: 2 additions & 2 deletions doc/TRUEConnector/default-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ TRUE Connector comes pre-configured with following:
* Disabled Clearing House
* Disabled validate protocol in Forward-To header
* Disabled CheckSum validation
* Disabled Firewall
* Disabled Self Description validation
* Enabled Firewall
* Enabled Self Description validation


If you wish to change this configuration, please check chapter [Modifying configuration](../modifyingConfiguration/modify-configuration.md)
7 changes: 5 additions & 2 deletions doc/advancedConfiguration/os-logs-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,15 @@ In addition to configuring access to system logs, it's important to establish ru
- **Create Monitoring Rules with auditctl**: `auditctl` is a command-line utility that allows you to interact with the Linux audit framework, enabling you to define rules for monitoring system activities, for more details please refer to [manual page](https://manpages.ubuntu.com/manpages/xenial/en/man8/auditctl.8.html). When setting up monitoring for the TRUE Connector, you can use `auditctl` to create specific rules that define which files or directories to monitor and what actions to audit.
For example, you can use the following command to create a rule for monitoring all files within the TRUE Connector directory: `auditctl -w /path/to/TRUEConnector/* -k trueconnector`
For example, you can use the following command to create a rule for monitoring all files within the TRUE Connector directory: `auditctl -w /path/to/TRUEConnector -p war -k trueconnector`
In this command:
- `-w /path/to/TRUEConnector/*` specifies the path to the TRUE Connector directory and the asterisk (`*`) wildcard to monitor all files within it.
- `-k trueconnector` assigns a unique key (`trueconnector`) to the rule for easier identification in audit logs.
- `-p war ` makes sure that all write, attribute change and read operations are logged.
- `-k trueconnector` assigns a unique key (`trueconnector`) which makes the changes searchable via ausearch.
The logs can be searched by using ausearch on the key: `ausearch -ts today -k trueconnector`
***NOTE:*** Make sure to replace `/path/to/TRUEConnector/` with the actual location where the TRUE Connector is deployed.
Expand Down
2 changes: 1 addition & 1 deletion doc/configuration-list-evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document contains an iterative table providing details on the certification

| TRUE Connector version | Release Date | Submodules version | Source code | Evaluation evidence|
|:-----------------------:|:--------------:|:-----------------------------------------------------------------------:|:----------:|:-------------------|
| v1.0.7 | 2023-02-22 | ECC (v1.14.8), DataApp (v0.3.8), UCApp (v1.7.9), PIP (v1.0.0) |[Link](https://github.com/Engineering-Research-and-Development/true-connector/releases/tag/v1.0.7) |Teams meetings, Email conversations |
| v1.0.7 | 2023-02-27 | ECC (v1.14.8), DataApp (v0.3.8), UCApp (v1.7.9), PIP (v1.0.0) |[Link](https://github.com/Engineering-Research-and-Development/true-connector/releases/tag/v1.0.7) |Teams meetings, Email conversations |
| v1.0.6 | 2023-01-26 | ECC (v1.14.7), DataApp (v0.3.8), UCApp (v1.7.8), PIP (v1.0.0) |[Link](https://github.com/Engineering-Research-and-Development/true-connector/releases/tag/v1.0.6) |TRUE Connector evaluation clarification points TC/v1/v2/v3/v4/v5/v6, Email conversations |
| v1.0.5 | 2022-12-13 | ECC (v1.14.6), DataApp (v0.3.7), UCApp (v1.7.8), PIP (v1.0.0) |[Link](https://github.com/Engineering-Research-and-Development/true-connector/releases/tag/v1.0.5) | JIRA issues, Email conversations |
| v1.0.4 | 2022-11-17 | ECC (v1.14.6), DataApp (v0.3.7), UCApp (v1.7.8), PIP (v1.0.0) |[Link](https://github.com/Engineering-Research-and-Development/true-connector/releases/tag/v1.0.4) |JIRA issues, Email conversations |
Expand Down
10 changes: 5 additions & 5 deletions doc/modifyingConfiguration/selfdescriptionvalidation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Enable Self Description Validation <a href="#seldesrptionvalidation" id="seldesrptionvalidation"></a>

To enable self description validation, set following property to true:
Self description validation is enabled by default, and connector will check does received self description document contains next fields: ***Connector ID, Security Profile, PublicKey***

```
VALIDATE_SELF_DESCRIPTION=true
```
To disable self description validation, set following property to false:

By enabling this property, connector will check does received self description document contains next fields: ***Connector ID, Security Profile, PublicKey***
```
VALIDATE_SELF_DESCRIPTION=false
```

0 comments on commit db90b30

Please sign in to comment.