Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
Jianfeng Jiang 6c34db52b3 Bump only package version in Cargo.toml 2024-06-01 20:13:03 +08:00
.github/workflows Increase memory size and change boot mode in CI 2024-05-31 15:19:17 +08:00
.vscode Implement OSDK functionalities and opt-in OSDK for asterinas 2024-02-28 16:30:48 +08:00
docs Add dummy syscall sched_getaffinity 2024-06-01 20:10:09 +08:00
framework fix: enable timely delivery of POSIX signals while busy-looping 2024-06-01 20:08:11 +08:00
kernel Add dummy syscall sched_getaffinity 2024-06-01 20:10:09 +08:00
osdk Bump only package version in Cargo.toml 2024-06-01 20:13:03 +08:00
regression Add dummy syscall sched_getaffinity 2024-06-01 20:10:09 +08:00
tools Bump only package version in Cargo.toml 2024-06-01 20:13:03 +08:00
.code-workspace Enable the rust-analyzer for OSDK 2024-04-25 09:44:46 +08:00
.dockerignore Add version bumping mechanism 2023-08-14 10:45:01 +08:00
.gitignore Re-implement OSDK debugging fixes and other facilities upon the refactor 2024-04-25 09:44:46 +08:00
.licenserc.yaml Remove local tdx-guest crate 2024-04-29 10:13:04 +08:00
COPYRIGHT Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Cargo.lock Enable softirq mechanism 2024-05-31 16:05:58 +08:00
Cargo.toml Make ID allocator a separate crate and use it in the frame 2024-05-09 14:35:12 +08:00
Components.toml Rename aster-std to aster-nix 2024-02-06 10:43:40 +08:00
LICENSE-MPL Update the license to MPLv2 2023-12-26 17:43:45 +08:00
Makefile Make ID allocator a separate crate and use it in the frame 2024-05-09 14:35:12 +08:00
OSDK.toml Make stripping ELF optional for QEMU direct boot 2024-05-23 12:37:57 +08:00
README.md Bump version to 0.4.2 2024-04-01 17:26:49 +08:00
README_CN.md Bump version to 0.4.2 2024-04-01 17:26:49 +08:00
VERSION Bump version to 0.4.2 2024-04-01 17:26:49 +08:00
rust-toolchain.toml Update proper dep for builder in OSDK and allow publishing 2024-05-08 15:41:32 +08:00
rustfmt.toml Add rustfmt.toml configuration to adjust the format of imports 2024-02-26 10:03:45 +08:00

README.md

asterinas-logo
A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux
OSDK Test Kernel Test

English | 中文版

Introducing Asterinas

Asterinas is a secure, fast, and general-purpose OS kernel that provides Linux-compatible ABI. It can serve as a seamless replacement for Linux while enhancing memory safety and developer friendliness.

  • Asterinas prioritizes memory safety by employing Rust as its sole programming language and limiting the use of unsafe Rust to a clearly defined and minimal Trusted Computing Base (TCB). This innovative approach, known as the framekernel architecture, establishes Asterinas as a more secure and dependable kernel option.

  • Asterinas surpasses Linux in terms of developer friendliness. It empowers kernel developers to (1) utilize the more productive Rust programming language, (2) leverage a purpose-built toolkit called OSDK to streamline their workflows, and (3) choose between releasing their kernel modules as open source or keeping them proprietary, thanks to the flexibility offered by MPL.

While the journey towards a production-grade OS kernel can be challenging, we are steadfastly progressing towards our goal. Currently, Asterinas only supports x86-64 VMs. However, our aim for 2024 is to make Asterinas production-ready on x86-64 VMs.

Getting Started

Get yourself an x86-64 Linux machine with Docker installed. Follow the three simple steps below to get Asterinas up and running.

  1. Download the latest source code.
git clone https://github.com/asterinas/asterinas
  1. Run a Docker container as the development environment.
docker run -it --privileged --network=host --device=/dev/kvm -v ./asterinas:/root/asterinas asterinas/asterinas:0.4.2
  1. Inside the container, go to the project folder to build and run Asterinas.
make build
make run

If everything goes well, Asterinas is now up and running inside a VM.

The Book

See The Asterinas Book to learn more about the project.

License

Asterinas's source code and documentation primarily use the Mozilla Public License (MPL), Version 2.0. Select components are under more permissive licenses, detailed here. For the rationles behind the choice of MPL, see here.