Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SONiC Security Auditing HLD #1713

Open
wants to merge 14 commits into
base: master
Choose a base branch
from

Conversation

maipbui
Copy link
Contributor

@maipbui maipbui commented Jun 14, 2024

This design aims to enhance the auditing capabilities within SONiC operating system using audit daemon (auditd). Auditing is the process of recording and analyzing the events that occur on the device. Auditing can help to detect unauthorized access, configuration changes, malicious activity, or system errors. Auditing can also provide evidence for forensic investigations, compliance audits, or incident response.

Repo PR title State
sonic-buildimage Auditd enhancement YANG models GitHub issue/pull request detail
sonic-utilities Auditd Enhancement CLI GitHub issue/pull request detail
sonic-host-services Support auditd configuration GitHub issue/pull request detail

@maipbui maipbui changed the title SONiC Audit Enhancement SONiC Audit Enhancement HLD Jun 14, 2024
@qiluo-msft qiluo-msft requested a review from liuh-80 June 14, 2024 07:03
Signed-off-by: Mai Bui <maibui@microsoft.com>
@maipbui maipbui changed the title SONiC Audit Enhancement HLD SONiC Security Auditing HLD Aug 12, 2024
Signed-off-by: Mai Bui <maibui@microsoft.com>
@zhangyanzhao
Copy link
Collaborator

Signed-off-by: Mai Bui <maibui@microsoft.com>
Signed-off-by: Mai Bui <maibui@microsoft.com>
Signed-off-by: Mai Bui <maibui@microsoft.com>
Signed-off-by: Mai Bui <maibui@microsoft.com>
Signed-off-by: Mai Bui <maibui@microsoft.com>
@maipbui
Copy link
Contributor Author

maipbui commented Aug 22, 2024

According to Sonic team and community's feedback, addressed and added some additional topics to the HLD

  • Add Config DB improvement
  • Add YANG section
  • Add Audit rule ordering
  • Add test case for ordering of rules
  • Add test case for performance test
  • Add CPU/MEM utilization section
  • Support fine-grained control to add or remove an individual rule
  • Add Q&A, future improvements section

Signed-off-by: Mai Bui <maibui@microsoft.com>
xincunli-sonic
xincunli-sonic previously approved these changes Sep 13, 2024
Copy link
Contributor

@xincunli-sonic xincunli-sonic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Mai Bui <maibui@microsoft.com>
Signed-off-by: Mai Bui <maibui@microsoft.com>
@@ -37,7 +37,7 @@
## List of Tables
* [Table 1: Revision](#table-1-revision)
* [Table 2: Audit Rules Review](#table-2-audit-rules-review)
* [Table 3: Unit Test Cases](#table-3-unit-test-cases)
* [Table 3: Unt Test Cases](#table-3-unit-test-cases)
Copy link
Contributor

@qiluo-msft qiluo-msft Sep 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: Unt #Closed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

]
}
]
"critical_files": "enabled",
Copy link
Contributor

@qiluo-msft qiluo-msft Sep 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For ConfigDB, the word convention is enable/disable
For StateDB, the word convention is enabled/disabled. #Closed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, thanks!

Signed-off-by: Mai Bui <maibui@microsoft.com>
@maipbui maipbui requested review from liuh-80 and removed request for liuh-80 September 19, 2024 20:27
@maipbui
Copy link
Contributor Author

maipbui commented Sep 19, 2024

@liuh-80 @Yarden-Z @xincunli-sonic @venkatmahalingam @yxieca @prsunny @lguohan @StormLiangMS could you please help review the HLD? thanks

This reverts commit 9750acb.
Signed-off-by: Mai Bui <maibui@microsoft.com>
qiluo-msft
qiluo-msft previously approved these changes Sep 20, 2024
xincunli-sonic
xincunli-sonic previously approved these changes Sep 20, 2024
Signed-off-by: Mai Bui <maibui@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In Progress
Development

Successfully merging this pull request may close these issues.

4 participants