Directory Layout

This page describes the directory structure of the macOS Security Compliance Project repository.

---

Repository Structure

mSCP 2.0 (Beta)

mSCP 2.0 is currently in Beta

mSCP 2.0 is under active development and should not be used in production. Please report any issues to the project. For production deployments, refer to mSCP 1.0.

• Directoryconfig/

  • Directorydefault/

    • Directoryrules/ Individual rule YAML files

      • …
    • Directorysections/ Section definition files

      • …
    • Directorytemplates/ Documentation templates

      • …
    • Directoryimages/ Project images

      • …
    • Directorythemes/ Theme files

      • …
  • Directorycustom/

    • Directoryrules/ Custom rule overrides

      • …
    • Directorybaselines/ Generated/tailored baselines

      • …
    • Directorysections/ Custom section overrides

      • …
    • Directorytemplates/ Custom templates

      • …
    • Directoryimages/ Custom images

      • …
  • Directoryincludes/ Supporting YAML files and resources

    • …
  • Directorylocales/ Localization files

    • …
• Directorysrc/

  • Directorymscp/ Python CLI package

    • …
• Directoryschema/ YAML schema definitions

  • …
• Directorybuild/ Generated output files

  • …
• rules → config/default/rules (symlink)
• baselines → config/default/baselines (symlink)
• custom → config/custom (symlink)

mSCP 1.0

Always Use the Correct Branch

Each macOS version has its own branch (sequoia, sonoma, ventura, etc.). Never use the main branch — it won’t work for generating content.

• Directorybaselines/ Baseline YAML files for compliance frameworks

  • …
• Directorybuild/ Generated output files

  • …
• Directorycustom/ Organization-specific customizations

  • …
• Directoryincludes/ Supporting YAML libraries and resources

  • …
• Directoryrules/ Individual rule YAML files

  • …
• Directoryscripts/ Generation and utility scripts

  • …
• Directorysections/ Section definition files for guides

  • …
• Directorytemplates/ AsciiDoc templates for documentation

  • …

---

Rules Directory

The rules directory contains subdirectories organized by category:

mSCP 2.0 (Beta)

mSCP 2.0 is currently in Beta

mSCP 2.0 is under active development and should not be used in production. Please report any issues to the project. For production deployments, refer to mSCP 1.0.

Category	Description
audit/	OpenBSM auditing settings
auth/	Authentication and smartcard settings
icloud/	Apple iCloud and Apple ID configuration
os/	General operating system settings
pwpolicy/	Password policy enforcement
settings/	Application and service settings
system_settings/	System Settings configuration

mSCP 1.0

Always Use the Correct Branch

Each macOS version has its own branch (sequoia, sonoma, ventura, etc.). Never use the main branch — it won’t work for generating content.

Category	Description
audit/	OpenBSM auditing settings
auth/	Authentication and smartcard settings
icloud/	Apple iCloud and Apple ID configuration
os/	General operating system settings
pwpolicy/	Password policy enforcement
supplemental/	Additional supporting information
system_settings/	System Settings configuration

---

Custom Directory

mSCP 2.0 (Beta)

mSCP 2.0 is currently in Beta

mSCP 2.0 is under active development and should not be used in production. Please report any issues to the project. For production deployments, refer to mSCP 1.0.

• Directoryconfig/custom/

  • Directoryrules/ Custom rule overrides

    • …
  • Directorybaselines/ Generated and tailored baselines

    • …
  • Directorysections/ Custom section overrides

    • …
  • Directorytemplates/ Custom templates

    • …
  • Directoryimages/ Custom images

    • …

mSCP 1.0

Always Use the Correct Branch

Each macOS version has its own branch (sequoia, sonoma, ventura, etc.). Never use the main branch — it won’t work for generating content.

• Directorycustom/

  • Directoryrules/ Custom rule overrides

    • …
  • Directorysections/ Custom section overrides

    • …

Note

Custom files must use the same filename as the original to override during generation.

---

Next Steps

• Rule File Layout — Understand rule YAML structure
• Sections File Layout — Understand section YAML structure
• Includes Directory — Supporting files reference