Asterinas is a secure, fast, and general-purpose OS kernel, written in Rust and providing Linux-compatible ABI.
Go to file
LI Qing ce2e0cee92 Refine Devpts with new metadata api 2024-06-11 18:09:23 +08:00
.github/workflows Convert vsock ci to manual trigger 2024-06-11 17:51:36 +08:00
.vscode
docs Subcommand `new` should not parse CommonArgs 2024-06-09 22:55:01 +08:00
framework Fix typos in API documentation 2024-06-09 22:57:14 +08:00
kernel Refine Devpts with new metadata api 2024-06-11 18:09:23 +08:00
osdk Not add project_type if the manifest is in workspace root 2024-06-09 22:55:01 +08:00
regression Convert vsock ci to manual trigger 2024-06-11 17:51:36 +08:00
tools Convert vsock ci to manual trigger 2024-06-11 17:51:36 +08:00
.code-workspace Enable the rust-analyzer for OSDK 2024-04-25 09:44:46 +08:00
.dockerignore
.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
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
LICENSE-MPL
Makefile Reuse Rxbuffer and update `qemu_args.sh` for vsock 2024-06-11 17:51:36 +08:00
OSDK.toml Convert vsock ci to manual trigger 2024-06-11 17:51:36 +08:00
README.md
README_CN.md
VERSION
rust-toolchain.toml Add description and license for align-ext 2024-06-09 22:57:14 +08:00
rustfmt.toml

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.