Skip to content

Commit 9750acb

Browse files
committed
address comments
Signed-off-by: Mai Bui <[email protected]>
1 parent 30eec43 commit 9750acb

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

doc/audit/security_auditing_HLD.md

+37-37
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
## List of Tables
3838
* [Table 1: Revision](#table-1-revision)
3939
* [Table 2: Audit Rules Review](#table-2-audit-rules-review)
40-
* [Table 3: Unt Test Cases](#table-3-unit-test-cases)
40+
* [Table 3: Unit Test Cases](#table-3-unit-test-cases)
4141
* [Table 4: System Test Cases](#table-4-system-test-cases)
4242

4343
## Revision
@@ -127,7 +127,7 @@ The database to be used is Config DB. A new AUDIT table will be added to the Con
127127
key = AUDIT|config ; Audit configuration settings
128128
; field = value
129129
groupid = 1*255VCHAR ; Name of the audit rule group
130-
groupvalue = enabled / disabled ; Indicates whether the entire audit rule group is enabled or disabled
130+
groupvalue = enable / disable ; Indicates whether the entire audit rule group is enabled or disabled
131131
```
132132

133133
##### 3.3.1.2 Config DB JSON Sample
@@ -136,22 +136,22 @@ The predefined list of rules in Section 3.2 will be **enabled** by default, whil
136136
{
137137
"AUDIT": {
138138
"config": {
139-
"critical_files": "enabled",
140-
"dns_changes": "enabled",
141-
"time_changes": "enabled",
142-
"shutdown_reboot": "enabled",
143-
"cron_changes": "enabled",
144-
"modules_changes": "enabled",
145-
"auth_logs": "enabled",
146-
"bin_changes": "enabled",
147-
"user_group_management": "enabled",
148-
"file_deletion": "enabled",
149-
"log_changes": "enabled",
150-
"docker_changes": "enabled",
151-
"process_audit": "enabled",
152-
"network_activity": "enabled",
153-
"socket_activity": "enabled",
154-
"custom_audit": "disabled"
139+
"critical_files": "enable",
140+
"dns_changes": "enable",
141+
"time_changes": "enable",
142+
"shutdown_reboot": "enable",
143+
"cron_changes": "enable",
144+
"modules_changes": "enable",
145+
"auth_logs": "enable",
146+
"bin_changes": "enable",
147+
"user_group_management": "enable",
148+
"file_deletion": "enable",
149+
"log_changes": "enable",
150+
"docker_changes": "enable",
151+
"process_audit": "enable",
152+
"network_activity": "enable",
153+
"socket_activity": "enable",
154+
"custom_audit": "disable"
155155
}
156156
}
157157
}
@@ -165,37 +165,37 @@ Once the AUDIT table is populated in the Config DB, the corresponding entries ca
165165
166166
127.0.0.1:6379[4]> hgetall AUDIT|config
167167
1) "critical_files"
168-
2) "enabled"
168+
2) "enable"
169169
3) "dns_changes"
170-
4) "enabled"
170+
4) "enable"
171171
5) "time_changes"
172-
6) "enabled"
172+
6) "enable"
173173
7) "shutdown_reboot"
174-
8) "enabled"
174+
8) "enable"
175175
9) "cron_changes"
176-
10) "enabled"
176+
10) "enable"
177177
11) "modules_changes"
178-
12) "enabled"
178+
12) "enable"
179179
13) "auth_logs"
180-
14) "enabled"
180+
14) "enable"
181181
15) "bin_changes"
182-
16) "enabled"
182+
16) "enable"
183183
17) "user_group_management"
184-
18) "enabled"
184+
18) "enable"
185185
19) "file_deletion"
186-
20) "enabled"
186+
20) "enable"
187187
21) "log_changes"
188-
22) "enabled"
188+
22) "enable"
189189
23) "docker_changes"
190-
24) "enabled"
190+
24) "enable"
191191
25) "process_audit"
192-
26) "enabled"
192+
26) "enable"
193193
27) "network_activity"
194-
28) "enabled"
194+
28) "enable"
195195
29) "socket_activity"
196-
30) "enabled"
196+
30) "enable"
197197
31) "custom_audit"
198-
32) "disabled"
198+
32) "disable"
199199
```
200200

201201
#### 3.3.2 YANG model
@@ -238,14 +238,14 @@ module sonic-audit {
238238
239239
leaf groupvalue {
240240
type enumeration {
241-
enum "enabled" {
241+
enum "enable" {
242242
description "Audit rule is enabled.";
243243
}
244-
enum "disabled" {
244+
enum "disable" {
245245
description "Audit rule is disabled.";
246246
}
247247
}
248-
description "Status of the audit rule group (enabled or disabled).";
248+
description "Status of the audit rule group (enable or disable).";
249249
}
250250
}
251251
/* end of list config */

0 commit comments

Comments
 (0)