Welcome to the CLIP OS project documentation!

This is the documentation for the CLIP OS project, the tools and the OS architecture.

Status of the project

The CLIP OS project is still in beta stage. Please check out the project homepage and the project roadmap to know more about the CLIP OS project history, its current status and its objectives.

How to get started?

• If you wish to try CLIP OS, please check out the quick try guide.
• If you wish to build an image of the CLIP OS project, please check out the development environment setup and build instructions.
• If you wish to contribue to this project, please check out the How to contribute guide.
• If you wish to adapt this project to your specific use case, please check out the How to derive this project guide.

CLIP OS

• Architecture
  • System components and their interactions
• Security objectives
  • Hardware requirements
  • Hypotheses
  • Threat scenarios
  • Objectives
  • Assets summary
• Kernel
  • Objectives
  • Configuration
  • Compilation
  • Sysctl Security Tuning
  • Command line parameters
• Boot chain and integrity guarantees
  • On-disk layout
  • Boot chain order
  • Boot chain and rootfs integrity
  • Setup for testing
• System updates
  • Requirements
  • Threats considered
  • Implementation
  • Unaddressed threats and potential weaknesses
• Roadmap
  • 5.0 Alpha: Initial open source preview release
  • 5.0 Beta: Main security & service enabling release
  • 5.0: First stable release with multi-level support
  • Milestone features whose integration planning are yet to be determined
• Development and debug
  • Effect of instrumentation features

Development environment

• Quick try guide
• Environment setup
  • Global environment configuration requirements
  • Software dependencies
    • Dependencies installation on supported Linux-distributions
  • How to fetch the entire source tree?
• Building
  • Building the CLIP OS toolkit (cosmk)
  • Creating a config.toml for cosmk
  • Instrumentation features for testing
  • Building the full project
• Testing
  • Virtual testbed setup
  • Building a QEMU image and running using QEMU/KVM
  • Access to QEMU virtual machine over SSH
  • Access to vagrant virtual machine over SSH
  • Testing updates
  • Testing chrony
  • Testing rsyslog
• Build steps
  • Building the documentation
  • SDK
  • Core
  • EFI boot partition
  • Initial state for QEMU test image
  • QEMU image
  • Testbed environment setup
  • Testing the QEMU image
  • Caching and binary packages
• Source tree organization
  • .repo/
  • assets/
    • assets/distfiles/
    • assets/gentoo/
  • cache/
    • cache/<product>/<version>/<recipe>/binpkgs/
  • docs-src/
    • docs-src/clipos/
    • docs-src/toolkit/
  • manifest/
  • out/
    • out/<product>/<version>/<recipe>/
  • products/
    • products/clipos/
  • run/
  • src/
    • src/external/
    • src/platform/
    • src/portage/
  • toolkit/
    • toolkit/cosmk/
    • toolkit/helpers/
• Maintaining the Portage tree
  • Fetching the upstream Portage tree
  • Updating the Portage tree using portage-derive
• Maintaining the SDK
  • Grabbing a new Gentoo stage 3 tarball
  • Updating the SDK recipe
  • Rebuilding the SDK from scratch

Contributing

• How to contribute
  • Getting started
  • Bug reports
  • Submitting patches and code review
  • Low difficulty issues
  • Continuous integration
  • Discussion space
• How to derive this project