rust-guide

Guide to develop secure applications with Rust

French Cybersecurity Agency (ANSSI)

This projet is managed by ANSSI. To find out more, you can go to the page (in French) dedicated to the ANSSI open source strategy. You can also click on the badges above to learn more about their meaning.

Objectives

The objective of this document is to provide hints and recommendations for secure applications development using the Rust programming language.

It is not intended to be a course on how to write Rust programs, there are already plenty of good learning resources for this purpose (see the External references section below). The purpose is rather to guide the programmer and to inform them about certain pitfalls, especially in case they are involved in the development of applications with strong security requirements. These recommendations form a complement to the good level of trust the Rust language already provides. That said, reminders are sometimes necessary for clarity, and the experienced Rust programmer may rely solely on highlighted inserts (Rule, Recommendation, Warning, etc.).

It is currently an ongoing version and all contributions are welcome.

Reading the guide online

https://anssi-fr.github.io/rust-guide

Building the guide

Install mdbook and required preprocessor:

cargo install mdbook --git https://github.com/hg-anssi/mdBook.git --rev c5a35b9296c6d5e48570e30022bd69403050a9f4 --locked
cargo install --path ./mdbook-checklist --locked
cargo install --path ./mdbook-code-align --locked
cargo install --path ./mdbook-extensions --locked

Then build and open the book:

$ mdbook serve -o

Call for Contributions

See CONTRIBUTING.md.

Licence

This document is published under the Open Licence 2.0.

External references

• The Rust programming language
• The Rust book
• The Edition Guide
• Rust API Guidelines

One can also find an up-to-date list of various book resources about Rust and associated tools in the Rust documentation main page.