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

Create a 2.x release of mSCP #464

Open
snoopy82481 opened this issue Feb 13, 2025 · 4 comments
Open

Create a 2.x release of mSCP #464

snoopy82481 opened this issue Feb 13, 2025 · 4 comments

Comments

@snoopy82481
Copy link

Problem to solve

Ease of use and the ability to consolidate into a single API for easier and faster development of features

Intended users

Anyone who uses the project

Further details

By combining all the scripts into a single API all code is normalized and modularized for cleaner and easier code maintenance

Proposal

Create an API with all the functions and classes in modular files and imported into each additional module as needed.
All generic functions and classes are not copied into each new script created to do a single function
Standardize the code so that it follows development best practices:

  • Not using system python version (Outdated and prone to vulnerabilities)
  • Not using system ruby version (Outdated and prone to vulnerabilities)

Add GitHub actions to release new documentation upon change of yaml files
Add GitHub actions to test the codebase out during PR to verify that it continues to work as intended
Move all rules into a unified folder for all Apple OS's
Add schema validation for IDE's to properly validate the rule/baseline yaml's

Modular approach to build folder

  • With a change of the configuration file the build folder can be anywhere the user wants

Modular approach to module development

  • Should allow for faster and easier module creation for features

Documentation

Still need to write this

Testing

This is a fundamental rewrite of the application to use newer versions of Python, and Ruby Gem's files
Testing will include performing all the tasks that the current version does and verify that it works as intended

What does success look like, and how can we measure that?

Success is little to no end user functionality changes
All existing features are available
New features available

  • STIG Viewer 3.x cklb creation
  • XLSX file format over XLS

Links / references

Stephen's fork of macOS_security

@snoopy82481
Copy link
Author

There is a lot of this already done in the Link, there is still some work that needs to be done for the scap creation. All the new baselines need updated to the new schema, ALL the documentation needs written.

@robertgendler
Copy link
Collaborator

@snoopy82481 This is amazing fantastic work. Can you email me directly at [email protected]

@jmahlman
Copy link
Collaborator

@boberito, beat me to it! :D

@snoopy82481
Copy link
Author

@robertgendler shot it off to you. Kind of limited due to be a travel day after PI Planning.

I really hope I'm not overstepping too much without corresponding with you first on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants