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

feat(compliance): add KISA ISMS-P compliance framework #5086

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

Conversation

Jude-Bae
Copy link

  • Added support for KISA ISMS-P to Prowler.

  • Provided both English and Korean versions for broader accessibility.

Context

This PR aims to add one of Korea’s key security compliance frameworks, the Personal Information & Information Security Management System (ISMS-P) from the Korea Internet & Security Agency (KISA), to the Prowler Compliance list.

The KISA ISMS-P is a certification system that assesses and certifies the adequacy of information security and personal information protection management systems. Many companies in Korea consider compliance with and certification through ISMS-P essential for their operations.

Up until now, the Prowler Compliance list has lacked support for KISA ISMS-P, which led the team at MegazoneCloud (https://www.megazone.com/us) to contribute this addition. We hope this contribution will benefit Prowler users, particularly those in Korea.

Additionally, the KISA ISMS-P for Prowler will be provided in two versions: a default English version and a Korean version tailored for Korean users.

“Powered by Cloud Security Group within Cloud Technology Center at MegazoneCloud.”

Co-authored-by: ES Kim es.kim@megazone.com and Yenn yenn@megazone.com

  • ES Kim: Contributed to the overall development and implementation of the project.
  • Yenn: Assisted with code development and conducted research on ISMS-P compliance requirements.

Description

A total of 12 files were changed, with 9,097 lines of code inserted. The changes include the addition of both the English and Korean versions of KISA ISMS-P for AWS compliance.
The following files have been added or modified:

Dashboard Integration:
dashboard/compliance/kisa_isms-p_2023-korean_aws.py
dashboard/compliance/kisa_isms-p_2023_aws.py

Compliance Files:
prowler/compliance/aws/kisa_isms-p_2023-korean_aws.json
prowler/compliance/aws/kisa_isms-p_2023_aws.json

Output and Model Files:
prowler/lib/outputs/compliance/kisa_ismsp/init.py
prowler/lib/outputs/compliance/kisa_ismsp/kisa_ismsp.py
prowler/lib/outputs/compliance/kisa_ismsp/kisa_ismsp_aws.py
prowler/lib/outputs/compliance/kisa_ismsp/models.py

KISA ISMS-P related updates to existing files:
prowler/main.py: Added KISA ISMS-P related logic to Prowler's main execution file.
prowler/lib/check/compliance_models.py: Added KISA ISMS-P related data to the compliance models file.
prowler/lib/outputs/compliance/compliance.py: Added code to handle KISA ISMS-P outputs.
dashboard/common_methods.py: Defined additional common methods to process KISA ISMS-P data.

Checklist

  • Are there new checks included in this PR? No

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

- Added support for KISA ISMS-P to Prowler.

- Provided both English and Korean versions for broader accessibility.
@Jude-Bae Jude-Bae requested review from a team as code owners September 18, 2024 17:44
@sergargar
Copy link
Member

Hi @Jude-Bae, thanks for your contribution by adding on of the most important Korea’s security compliance frameworks!

@pedrooot will take care of this PR.

@sergargar
Copy link
Member

@Jude-Bae can you run our pre-commit and push the changes please?

You can install it by pre-commit install, thanks!

@Jude-Bae
Copy link
Author

@Jude-Bae can you run our pre-commit and push the changes please?

You can install it by pre-commit install, thanks!

Hi! @sergargar,

Thanks for the feedback! I’m currently commuting to work, but I’ll run the pre-commit checks and push the changes as soon as I’m at my desk. I’ll aim to get this done as quickly as possible.

Copy link

codecov bot commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 54.45545% with 46 lines in your changes missing coverage. Please review.

Project coverage is 89.01%. Comparing base (8caf8f7) to head (e45e839).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...er/lib/outputs/compliance/kisa_ismsp/kisa_ismsp.py 9.52% 38 Missing ⚠️
prowler/__main__.py 0.00% 6 Missing ⚠️
prowler/lib/outputs/compliance/compliance.py 33.33% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5086      +/-   ##
==========================================
- Coverage   89.12%   89.01%   -0.12%     
==========================================
  Files         974      977       +3     
  Lines       29856    29957     +101     
==========================================
+ Hits        26610    26667      +57     
- Misses       3246     3290      +44     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pedrooot
Copy link
Member

Hey! @Jude-Bae first of all, thanks for your contribution.

Prowler dashboards will be deprecated, soon just to let you know because you added some changes there.

Could you please fix the tests? Thanks!!

@Jude-Bae
Copy link
Author

Hey! @Jude-Bae first of all, thanks for your contribution.

Prowler dashboards will be deprecated, soon just to let you know because you added some changes there.

Could you please fix the tests? Thanks!!

Hi! @pedrooot Thanks for the heads-up regarding the dashboard changes! I’ll make sure to address the tests as soon as possible

@github-actions github-actions bot added output/asff Issues/PRs related with the ASFF output format integration/security-hub Issues/PRs related with the AWS Security Hub integration labels Sep 22, 2024
…-p_compliance

Keeping the feature/kisa-isms-p_compliance branch up to date with the latest changes from the upstream/master branch while PR prowler-cloud#5086 is under review. This merge ensures the branch remains in sync with the main repository and prevents potential conflicts.
@Jude-Bae
Copy link
Author

Hi @pedrooot,

I’ve updated the branch with the latest changes and also added the test cases you suggested earlier. However, the status checks are still showing as “Expected — Waiting for status to be reported.” Could you let me know if there’s anything I might have missed or if I need to follow any additional steps?

If necessary, please advise if I should consider reopening the PR or take any other action to resolve this.
Thanks again for your help!

@pedrooot
Copy link
Member

I just had to accept the re-run of the checks. Thanks for all the info! I'll review this PR later today.

@Jude-Bae
Copy link
Author

Jude-Bae commented Sep 23, 2024

Hi! @pedrooot,

I would like to address the situation regarding the Codecov report for the current PR. The low patch coverage percentage for the kisa_ismsp.py file seems to be a primary factor, but I have noticed that similar compliance files also report a patch coverage of 7 to 10%.

Could you please advise if I need to write additional test code for "kisa_ismsp.py" and similar files to improve coverage?
I have attached screenshots of the Codecov HTML report for reference.

If there are any additional steps I should take to facilitate the merging process, please let me know.

SCR-20240924-bepx
SCR-20240924-bdsv
SCR-20240924-bdnn
SCR-20240924-bdfw
Thank you for your guidance!

@pedrooot
Copy link
Member

Thank you for the report. For now, I don't need you to add more tests to this PR because I need to review it in depth to check how it works. As you can see, the percentage of tests associated with each compliance is similar to what you've obtained, so it should be correct 🔝

@pedrooot
Copy link
Member

If I need anything else I'll ping you, thanks in advance

@pedrooot
Copy link
Member

After reviewing the dashboard generated with this compliance, the numbers on the pass/fail bar are not appearing. Could you check how it works with other compliances? I'll show you the CIS example:

Screenshot 2024-09-23 at 18 05 31

Screenshot 2024-09-23 at 18 07 30

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integration/security-hub Issues/PRs related with the AWS Security Hub integration output/asff Issues/PRs related with the ASFF output format
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants