Skip to content

Vrindisbacher/readme #54

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.

Sign up for GitHub

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

Merged
vrindisbacher merged 1 commit into from
Feb 18, 2026
Merged

Vrindisbacher/readme #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 3 additions & 185 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,193 +1,11 @@
# ![TockOS](http://www.tockos.org/assets/img/tock.svg "TockOS Logo")
# TickTock

This repository contains TickTock-a fork of the Tock OS that verifies memory isolation for user space processes. [Flux](https://github.com/flux-rs/flux) is used for the verification.

[![paper]](https://dl.acm.org/doi/epdf/10.1145/3731569.3764856)
You can find the paper [here](https://dl.acm.org/doi/epdf/10.1145/3731569.3764856).

The main verification bits can be found under the `kernel` directory, along with the arch directory. Specifically, `allocator.rs` contains the memory allocator referenced in the paper. `arch/cortex-m/src/mpu.rs` contains the MPU implementation for ARMv6m and ARMv7m devices. `arch/rv32i/src/pmp.rs` contains the MPU implementation for RISC devices.

You can find Lean proofs for SMT solver issues in this [repo](https://github.com/PLSysSec/vtock-lean). Verification of the ARM interrupt handlers and context switching code can be found in this [repo](https://github.com/PLSysSec/tock-veri-asm).

[![tock-ci](https://github.com/tock/tock/workflows/tock-ci/badge.svg)][tock-ci]
[![slack](https://img.shields.io/badge/slack-tockos-informational)][slack]
[![book](https://img.shields.io/badge/book-Tock_Book-green)][tock-book]

Tock is an embedded operating system designed for running multiple concurrent,
mutually distrustful applications on Cortex-M and RISC-V based embedded
platforms. Tock's design centers around protection, both from potentially
malicious applications and from device drivers. Tock uses two mechanisms to
protect different components of the operating system. First, the kernel and
device drivers are written in Rust, a systems programming language that provides
compile-time memory safety and type safety. Tock uses Rust to protect the kernel
(e.g. the scheduler and hardware abstraction layer) from platform specific
device drivers as well as isolate device drivers from each other. Second, Tock
uses memory protection units to isolate applications from each other and the
kernel.

[tock-ci]: https://github.com/tock/tock/actions?query=branch%3Amaster+workflow%3Atock-ci

Tock 2.x!
---------

Tock is now on its second major release! For a summary of the latest new
features and improvements, check out the [changelog](CHANGELOG.md).


Getting Started
---------------

There are a variety of resources for learning about Tock, contributing to the
project, and getting help.

- About Tock
- [The Tock Book][tock-book]: online tutorials and documentation
- [Getting Started with Secure Embedded Systems][book-systems]: Tock textbook
- Developing Tock
- [Tock API Docs][tockapidoc]
- [Contributing Guide](.github/CONTRIBUTING.md)
- [Code Review Guidelines](doc/CodeReview.md)
- Getting Help
- [Slack Channel][slack]
- [Email List](https://lists.tockos.org)
- [Tock Blog](https://www.tockos.org/blog/)
- [@talkingtock](https://twitter.com/talkingtock)

[slack]: https://join.slack.com/t/tockos/shared_invite/enQtNDE5ODQyNDU4NTE1LWVjNTgzMTMwYzA1NDI1MjExZjljMjFmOTMxMGIwOGJlMjk0ZTI4YzY0NTYzNWM0ZmJmZGFjYmY5MTJiMDBlOTk

[tock-book]: https://book.tockos.org

[book-systems]: https://link.springer.com/book/10.1007/978-1-4842-7789-8

[tockapidoc]: https://docs.tockos.org


Code of Conduct
---------------

The Tock project adheres to the Rust [Code of Conduct][coc].

All contributors, community members, and visitors are expected to familiarize
themselves with the Code of Conduct and to follow these standards in all
Tock-affiliated environments, which includes but is not limited to repositories,
chats, and meetup events. For moderation issues, please contact members of the
@tock/core-wg.

[coc]: https://www.rust-lang.org/conduct.html


Cite this Project
-----------------

<h4>Tock was presented at SOSP'17</h4>

Amit Levy, Bradford Campbell, Branden Ghena, Daniel B. Giffin, Pat Pannuto, Prabal Dutta, and Philip Levis. 2017. Multiprogramming a 64kB Computer Safely and Efficiently. In Proceedings of the 26th Symposium on Operating Systems Principles (SOSP ’17). Association for Computing Machinery, New York, NY, USA, 234–251. DOI: https://doi.org/10.1145/3132747.3132786

<p>
<details>
<summary>Bibtex</summary>
<pre>
@inproceedings{levy17multiprogramming,
title = {Multiprogramming a 64kB Computer Safely and Efficiently},
booktitle = {Proceedings of the 26th Symposium on Operating Systems Principles},
series = {SOSP'17},
year = {2017},
month = {10},
isbn = {978-1-4503-5085-3},
location = {Shanghai, China},
pages = {234--251},
numpages = {18},
url = {http://doi.acm.org/10.1145/3132747.3132786},
doi = {10.1145/3132747.3132786},
acmid = {3132786},
publisher = {ACM},
address = {New York, NY, USA},
conference-url = {https://www.sigops.org/sosp/sosp17/},
author = {Levy, Amit and Campbell, Bradford and Ghena, Branden and Giffin, Daniel B. and Pannuto, Pat and Dutta, Prabal and Levis, Philip},
}
</pre>
</details>
</p>


<p>This is the primary paper that describes the design considerations of Tock.</p>

<details>
<summary>Other Tock-related papers</summary>

<p>There are two shorter papers that look at potential limitations of the Rust language for embedded software development. The earlier PLOS paper lays out challenges and the later APSys paper lays out potential solutions. Some persons describing work on programming languages and type theory may benefit from these references, but generally, most work should cite the SOSP paper above.</p>
<h4><a href="http://doi.acm.org/10.1145/3124680.3124717">APSys: The Case for Writing a Kernel in Rust</a></h4>
<pre>
@inproceedings{levy17rustkernel,
title = {The Case for Writing a Kernel in Rust},
booktitle = {Proceedings of the 8th Asia-Pacific Workshop on Systems},
series = {APSys '17},
year = {2017},
month = {9},
isbn = {978-1-4503-5197-3},
location = {Mumbai, India},
pages = {1:1--1:7},
articleno = {1},
numpages = {7},
url = {http://doi.acm.org/10.1145/3124680.3124717},
doi = {10.1145/3124680.3124717},
acmid = {3124717},
publisher = {ACM},
address = {New York, NY, USA},
conference-url = {https://www.cse.iitb.ac.in/~apsys2017/},
author = {Levy, Amit and Campbell, Bradford and Ghena, Branden and Pannuto, Pat and Dutta, Prabal and Levis, Philip},
}</pre>

<h4><a href="http://dx.doi.org/10.1145/2818302.2818306">PLOS: Ownership is Theft: Experiences Building an Embedded OS in Rust</a></h4>
<pre>
@inproceedings{levy15ownership,
title = {Ownership is Theft: Experiences Building an Embedded {OS} in {R}ust},
booktitle = {Proceedings of the 8th Workshop on Programming Languages and Operating Systems},
series = {PLOS 2015},
year = {2015},
month = {10},
isbn = {978-1-4503-3942-1},
doi = {10.1145/2818302.2818306},
url = {http://dx.doi.org/10.1145/2818302.2818306},
location = {Monterey, CA},
publisher = {ACM},
address = {New York, NY, USA},
conference-url = {http://plosworkshop.org/2015/},
author = {Levy, Amit and Andersen, Michael P and Campbell, Bradford and Culler, David and Dutta, Prabal and Ghena, Branden and Levis, Philip and Pannuto, Pat},
}</pre>
<p>There is also a paper on the Tock security model. The threat model documentation in the docs/ folder is the source of truth for the current Tock threat model, but this paper represents a snapshot of the reasoning behind the Tock threat model and details how it compares to those in similar embedded OSes.</p>
<h4><a href="https://dx.doi.org/10.1145/3517208.3523752">EuroSec: Tiered Trust for useful embedded systems security</a></h4>
<pre>
@inproceedings{10.1145/3517208.3523752,
author = {Ayers, Hudson and Dutta, Prabal and Levis, Philip and Levy, Amit and Pannuto, Pat and Van Why, Johnathan and Watson, Jean-Luc},
title = {Tiered Trust for Useful Embedded Systems Security},
year = {2022},
isbn = {9781450392556},
publisher = {Association for Computing Machinery},
address = {New York, NY, USA},
url = {https://doi.org/10.1145/3517208.3523752},
doi = {10.1145/3517208.3523752},
booktitle = {Proceedings of the 15th European Workshop on Systems Security},
pages = {15–21},
numpages = {7},
keywords = {security, embedded systems, operating systems, IoT},
location = {Rennes, France},
series = {EuroSec '22}
}</pre>
</details>


License
-------

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
The original Tock repo can be found [here](https://github.com/tock/tock).
Loading