├── .github └── CODEOWNERS ├── .gitignore ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── audits.toml ├── guidelines.md ├── lints.rs ├── lints.toml └── media └── embark-logo-bg.jpg /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @repi 2 | /audits.toml @EmbarkStudios/rust-security -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2019 Embark Studios 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE. 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Embark Rust Ecosystem 2 | 3 | [![Embark logo](media/embark-logo-bg.jpg)](http://embark.games) 4 | 5 | High-level tracking and discussions about improving Rust and the Rust ecosystem for our game development use cases at [Embark](http://embark.games). 6 | 7 | Check out the __[Issues](https://github.com/EmbarkStudios/rust-ecosystem/issues)__ for active topics. And our [embark.dev](https://embark.dev) open source portal. 8 | 9 | ## Open Source 10 | 11 | Open source Rust projects we've created so far and are actively using and maintaining: 12 | 13 | Name | Description | Crates.io 14 | --- | --- | --- 15 | 🌋 [`ash-molten`](https://github.com/EmbarkStudios/ash-molten.git) | Statically linked MoltenVK for Vulkan on Mac using Ash | [![Latest version](https://img.shields.io/crates/v/ash-molten.svg)](https://crates.io/crates/ash-molten) 16 | 👷 [`buildkite-jobify`](https://github.com/EmbarkStudios/buildkite-jobify) | Kubekite, but in Rust, using configuration from your repos 17 | 📜 [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) | Cargo plugin to generate list of all licenses for a crate | [![Latest version](https://img.shields.io/crates/v/cargo-about.svg)](https://crates.io/crates/cargo-about) 18 | ❌ [`cargo-deny`](https://github.com/EmbarkStudios/cargo-deny) | Cargo plugin to help you manage large dependency graphs | [![Latest version](https://img.shields.io/crates/v/cargo-deny.svg)](https://crates.io/crates/cargo-deny) 19 | 🎁 [`cargo-fetcher`](https://github.com/EmbarkStudios/cargo-fetcher) | `cargo fetch` alternative for use in CI or other "clean" environments | [![Latest version](https://img.shields.io/crates/v/cargo-fetcher.svg)](https://crates.io/crates/cargo-fetcher) 20 | 🧠 [`cervo`](https://github.com/EmbarkStudios/cervo) | Middleware used for ML inference in our games. | [![Latest version](https://img.shields.io/crates/v/cervo.svg)](https://crates.io/crates/cervo) 21 | ⚙️ [`cfg-expr`](https://github.com/EmbarkStudios/cfg-expr) | A parser and evaluator for Rust `cfg()` expressions | [![Latest version](https://img.shields.io/crates/v/cfg-expr.svg)](https://crates.io/crates/cfg-expr) 22 | 📒 [`cloud-dns`](https://github.com/EmbarkStudios/cloud-dns) | Client to interact with Google Cloud DNS v1 | [![Latest version](https://img.shields.io/crates/v/cloud-dns.svg)](https://crates.io/crates/cloud-dns) | 23 | 🔥 [`crash-handling`](https://github.com/EmbarkStudios/crash-handling) | Collection of crates for catching and handling crashes 24 | ⛴️ [`discord-sdk`](https://github.com/EmbarkStudios/discord-sdk) | An open implementation of the Discord Game SDK in Rust | [![Latest version](https://img.shields.io/crates/v/discord-sdk.svg)](https://crates.io/crates/discord-sdk) 25 | 🌉 [`fsr-rs`](https://github.com/EmbarkStudios/fsr-rs) | Rust bindings for AMD FidelityFX™ Super Resolution | [![Latest version](https://img.shields.io/crates/v/fsr.svg)](https://crates.io/crates/fsr) 26 | 🚙 [`gsutil`](https://github.com/EmbarkStudios/gsutil) | A small, incomplete replacement for the official gsutil | [![Latest version](https://img.shields.io/crates/v/gsutil.svg)](https://crates.io/crates/gsutil) 27 | 💡 [`kajiya`](https://github.com/EmbarkStudios/kajiya) | Experimental real-time global illumination renderer 28 | 📦 [`krates`](https://github.com/EmbarkStudios/krates) | Creates graphs of crates from cargo metadata | [![Latest version](https://img.shields.io/crates/v/krates.svg)](https://crates.io/crates/krates) 29 | 🪞 [`mirror-mirror`](https://github.com/EmbarkStudios/mirror-mirror) | Powerful reflection library for Rust | [![Latest version](https://img.shields.io/crates/v/mirror-mirror.svg)](https://crates.io/crates/mirror-mirror) 30 | 🆙 [`octobors`](https://github.com/EmbarkStudios/octobors) | GitHub action for automerging PRs based on a few rules 31 | 🎳 [`physx`](https://github.com/EmbarkStudios/physx-rs) | Use [NVIDIA PhysX](https://github.com/NVIDIAGameWorks/PhysX) in Rust | [![Latest version](https://img.shields.io/crates/v/physx.svg)](https://crates.io/crates/physx) 32 | ⌛ [`poll-promise`](https://github.com/EmbarkStudios/poll-promise) | A Rust promise for games and immediate mode GUIs | [![Latest version](https://img.shields.io/crates/v/poll-promise.svg)](https://crates.io/crates/poll-promise) 33 | 🗜 [`presser`](https://github.com/EmbarkStudios/presser) | A helper crate for doing low-level data copies | [![Latest version](https://img.shields.io/crates/v/presser.svg)](https://crates.io/crates/presser) 34 | 💠 [`proto-gen`](https://github.com/EmbarkStudios/proto-gen) | A protobuf generation runner/cli using tonic build | [![Latest version](https://img.shields.io/crates/v/proto-gen.svg)](https://crates.io/crates/proto-gen) 35 | 🐦 [`puffin`](https://github.com/EmbarkStudios/puffin) | Simple instrumentation profiler for Rust | [![Latest version](https://img.shields.io/crates/v/puffin.svg)](https://crates.io/crates/puffin) 36 | 📓 [`relnotes`](https://github.com/EmbarkStudios/relnotes) | Automatic GitHub release notes | [![Latest version](https://img.shields.io/crates/v/relnotes.svg)](https://crates.io/crates/relnotes) 37 | 🐏 [`rpmalloc-rs`](https://github.com/EmbarkStudios/rpmalloc-rs) | Cross-platform Rust global memory allocator using [rpmalloc](https://github.com/rampantpixels/rpmalloc) | [![Latest version](https://img.shields.io/crates/v/rpmalloc.svg)](https://crates.io/crates/rpmalloc) 38 | 🐉 [`rust-gpu`](https://github.com/EmbarkStudios/rust-gpu) | Making Rust a first-class language & ecosystem for GPU code | 39 | 🌌 [`rymder`](https://github.com/EmbarkStudios/rymder) | Unofficial agones client | [![Latest version](https://img.shields.io/crates/v/rymder.svg)](https://crates.io/crates/rymder) 40 | 🆔 [`spdx`](https://github.com/EmbarkStudios/spdx) | Helper crate for SPDX expressions | [![Latest version](https://img.shields.io/crates/v/spdx.svg)](https://crates.io/crates/spdx) 41 | 🛠 [`spirv-tools-rs`](https://github.com/EmbarkStudios/spirv-tools-rs) | An unofficial wrapper for SPIR-V Tools | [![Latest version](https://img.shields.io/crates/v/spirv-tools.svg)](https://crates.io/crates/spirv-tools) 42 | 🔆 [`superluminal-perf`](https://github.com/EmbarkStudios/superluminal-perf-rs) | [Superluminal Performance](http://superluminal.eu) profiler integration | [![Latest version](https://img.shields.io/crates/v/superluminal-perf.svg)](https://crates.io/crates/superluminal-perf) 43 | 📂 [`tame-gcs`](https://github.com/EmbarkStudios/tame-gcs) | Google Cloud Storage functions that follows the sans-io approach | [![Latest version](https://img.shields.io/crates/v/tame-gcs.svg)](https://crates.io/crates/tame-gcs) 44 | 🔐 [`tame-oauth`](https://github.com/EmbarkStudios/tame-oauth) | Small OAuth crate that follows the sans-io approach | [![Latest version](https://img.shields.io/crates/v/tame-oauth.svg)](https://crates.io/crates/tame-oauth) 45 | 🧬 [`tame-oidc`](https://github.com/EmbarkStudios/tame-oidc) | Small OIDC crate that follows the sans-io approach | [![Latest version](https://img.shields.io/crates/v/tame-oidc.svg)](https://crates.io/crates/tame-oidc) 46 | 💩 [`tame-webpurify`](https://github.com/EmbarkStudios/tame-webpurify) | An incredibly small library to interact with the [webpurify](https://www.webpurify.com/documentation/) REST API | [![Latest version](https://img.shields.io/crates/v/tame-webpurify.svg)](https://crates.io/crates/tame-webpurify) 47 | 🎨 [`texture-synthesis`](https://github.com/EmbarkStudios/texture-synthesis) | Example-based texture synthesis generator and CLI example | [![Latest version](https://img.shields.io/crates/v/texture-synthesis.svg)](https://crates.io/crates/texture-synthesis) 48 | 🛠 [`tiny-bench`](https://github.com/EmbarkStudios/tiny-bench) | A tiny benchmarking library | [![Latest version](https://img.shields.io/crates/v/tiny-bench.svg)](https://crates.io/crates/tiny-bench) 49 | ⏱️ [`tracing-ext-ffi-subscriber`](https://github.com/EmbarkStudios/tracing-ext-ffi-subscriber) | Subscriber for passing spans to a profiling tool via FFI. | [![Latest version](https://img.shields.io/crates/v/tracing-ext-ffi-subscriber.svg)](https://crates.io/crates/tracing-ext-ffi-subscriber) 50 | 🪵️ [`tracing-logfmt`](https://github.com/EmbarkStudios/tracing-logfmt) | A logfmt formatter for tracing-subscriber. | [![Latest version](https://img.shields.io/crates/v/tracing-logfmt.svg)](https://crates.io/crates/tracing-logfmt) 51 | 💫 [`tryhard`](https://github.com/EmbarkStudios/tryhard) | Easily retry futures | [![Latest version](https://img.shields.io/crates/v/tryhard.svg)](https://crates.io/crates/tryhard) 52 | 53 | You can see all these crates on our [crates.io profile](https://crates.io/users/embark-studios). 54 | 55 | ### Contributing 56 | 57 | We encourage contributions to any of our open source projects. If you're not sure where to start, look at the GitHub issues on any of the above projects! 58 | 59 | Check out [`guidelines.md`](guidelines.md) for our guidelines & policies for how we develop in Rust. 60 | 61 | To make sure we keep a friendly and safe environment for everyone, we have a Contributor Code of Conduct. You can read this in any of our projects' repositories. By contributing to our projects, you agree to the code of conduct. 62 | 63 | ## Areas of Interest 64 | 65 | Areas that we are interested in or working on, and want to help see improved in Rust: 66 | 67 | * ☸ __[Distributed systems](https://areweasyncyet.rs/)__ - [async](https://rust-lang.github.io/async-book/), [tokio](https://tokio.rs/), [tonic](https://github.com/hyperium/tonic) 68 | 69 | * 🕹️ __[Game engine systems](http://arewegameyet.com/)__ - multiplayer, rendering, physics, audio, server, assets, workflows 70 | 71 | * 📦 __Developer experience__ - fast iteration with large projects/monorepos, distributed builds, debugging, profiling, IDE 72 | 73 | * 🛸 __[WebAssembly](https://webassembly.org/) and [WASI](https://hacks.mozilla.org/2019/03/standardizing-wasi-a-webassembly-system-interface/)__ - sandboxed safe Rust code on client, edge & cloud 74 | 75 | * 🤖 __[Machine learning](http://www.arewelearningyet.com/)__ - efficient inference, library bindings, training environments 76 | 77 | * 🚀 __High performance runtime__ - CPU job scheduling, code generation, optimizing crates 78 | 79 | * 📺📱 __Console & mobile platform support__ - PlayStation, Xbox, Android. [#18](https://github.com/EmbarkStudios/rust-ecosystem/issues/18) 80 | 81 | * 🏎 [__Rust on GPU__](https://shader.rs) - future compute & ML programming models beyond shaders, 82 | 83 | We track and discuss these from our perspective in the __[Issues](https://github.com/EmbarkStudios/rust-ecosystem/issues)__ for visibility and to get feedback, feel free to join in if you have ideas! 84 | 85 | Also check out the [Rust Game Development Working Group](https://github.com/rust-gamedev/wg). 86 | 87 | ## Work with us 88 | 89 | We're actively looking to collaborate with developers on the areas discussed in this repository. If you're interested in working on a specific issue or idea highlighted here, please reach out to us at [`opensource@embark-studios.com`](mailto:opensource@embark-studios.com) to discuss contracting opportunities or sponsorship. 90 | 91 | We are also [hiring](https://embark.games/jobs/) for full-time positions remotely within Europe or on-site in Stockholm or Malmö! 92 | 93 | Let's go! 🚀 94 | 95 | ## License 96 | 97 | Licensed under either of 98 | 99 | * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or ) 100 | * MIT license ([LICENSE-MIT](LICENSE-MIT) or ) 101 | 102 | at your option. 103 | 104 | ### Contribution 105 | 106 | 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. 107 | -------------------------------------------------------------------------------- /audits.toml: -------------------------------------------------------------------------------- 1 | # cargo-vet audits file 2 | # 3 | # see https://mozilla.github.io/cargo-vet/index.html for more info how cargo-vet works 4 | 5 | # ------------------------------------------- 6 | # our own crates that we develop and maintain 7 | # ------------------------------------------- 8 | 9 | [[wildcard-audits.ark-api]] 10 | who = "Johan Andersson " 11 | criteria = "safe-to-deploy" 12 | user-id = 52553 13 | start = "2021-01-01" 14 | end = "2024-05-23" 15 | notes = "Maintained by the Ark team at Embark" 16 | 17 | [[wildcard-audits.ark-api-ffi]] 18 | who = "Johan Andersson " 19 | criteria = "safe-to-deploy" 20 | user-id = 52553 21 | start = "2021-01-01" 22 | end = "2024-05-23" 23 | notes = "Maintained by the Ark team at Embark" 24 | 25 | [[wildcard-audits.ark-api-macros]] 26 | who = "Johan Andersson " 27 | criteria = "safe-to-deploy" 28 | user-id = 52553 29 | start = "2021-01-01" 30 | end = "2024-05-23" 31 | notes = "Maintained by the Ark team at Embark" 32 | 33 | [[wildcard-audits.ark-module]] 34 | who = "Johan Andersson " 35 | criteria = "safe-to-deploy" 36 | user-id = 52553 37 | start = "2021-01-01" 38 | end = "2024-05-23" 39 | notes = "Maintained by the Ark team at Embark" 40 | 41 | [[wildcard-audits.cervo]] 42 | who = "Tom Solberg " 43 | criteria = "safe-to-deploy" 44 | user-id = 52553 45 | start = "2021-01-01" 46 | end = "2024-05-23" 47 | notes = "Maintained by Embark" 48 | 49 | [[wildcard-audits.cervo-asset]] 50 | who = "Tom Solberg " 51 | criteria = "safe-to-deploy" 52 | user-id = 52553 53 | start = "2021-01-01" 54 | end = "2024-05-23" 55 | notes = "Maintained by Embark" 56 | 57 | [[wildcard-audits.cervo-core]] 58 | who = "Tom Solberg " 59 | criteria = "safe-to-deploy" 60 | user-id = 52553 61 | start = "2021-01-01" 62 | end = "2024-05-23" 63 | notes = "Maintained by Embark" 64 | 65 | [[wildcard-audits.cervo-nnef]] 66 | who = "Tom Solberg " 67 | criteria = "safe-to-deploy" 68 | user-id = 52553 69 | start = "2021-01-01" 70 | end = "2024-05-23" 71 | notes = "Maintained by Embark" 72 | 73 | [[wildcard-audits.cervo-onnx]] 74 | who = "Tom Solberg " 75 | criteria = "safe-to-deploy" 76 | user-id = 52553 77 | start = "2021-01-01" 78 | end = "2024-05-23" 79 | notes = "Maintained by Embark" 80 | 81 | [[wildcard-audits.cervo-runtime]] 82 | who = "Tom Solberg " 83 | criteria = "safe-to-deploy" 84 | user-id = 52553 85 | start = "2021-01-01" 86 | end = "2024-05-23" 87 | notes = "Maintained by Embark" 88 | 89 | [[wildcard-audits.egui-ark]] 90 | who = "Johan Andersson " 91 | criteria = "safe-to-deploy" 92 | user-id = 52553 93 | start = "2021-01-01" 94 | end = "2024-05-23" 95 | notes = "Maintained by the Ark team at Embark" 96 | 97 | [[wildcard-audits.kollect]] 98 | who = "Gray Olson " 99 | criteria = "safe-to-deploy" 100 | user-id = 52553 101 | start = "2021-01-01" 102 | end = "2024-05-23" 103 | notes = """ 104 | Maintained by the Ark team at Embark. 105 | Small crate with no dependencies and no ambient capabilities. 106 | """ 107 | 108 | [[wildcard-audits.macaw]] 109 | who = "Johan Andersson " 110 | criteria = "safe-to-deploy" 111 | user-id = 52553 112 | start = "2021-01-01" 113 | end = "2024-05-23" 114 | notes = "Maintained by the Ark team at Embark" 115 | 116 | [[wildcard-audits.perchance]] 117 | who = "Johan Andersson " 118 | criteria = "safe-to-deploy" 119 | user-id = 52553 120 | start = "2021-01-01" 121 | end = "2024-05-23" 122 | notes = "Maintained by the Ark team at Embark" 123 | 124 | [[wildcard-audits.physx]] 125 | who = "Tom Solberg " 126 | criteria = "safe-to-deploy" 127 | user-id = 52553 128 | start = "2021-01-01" 129 | end = "2024-05-23" 130 | notes = "Maintained by the Ark team at Embark" 131 | 132 | [[wildcard-audits.physx-sys]] 133 | who = "Tom Solberg " 134 | criteria = "safe-to-deploy" 135 | user-id = 52553 136 | start = "2021-01-01" 137 | end = "2024-05-23" 138 | notes = "Maintained by the Ark team at Embark. Note that this is a unsafe FFI layer on top of a complex C++ library so may be some unknown unsoundness, but we have been using it in games production for a couple of years" 139 | 140 | [[wildcard-audits.presser]] 141 | who = "Gray Olson " 142 | criteria = "safe-to-deploy" 143 | user-id = 52553 144 | start = "2021-01-01" 145 | end = "2024-05-23" 146 | notes = """ 147 | Small crate with no dependencies and no ambient capabilities. The safe interface of the crate 148 | is gated behind unsafe implementation of a core trait, and care must be taken to ensure that 149 | the relevant invariants are guaranteed when doing so. Maintained by the Ark team at Embark 150 | and used in production. 151 | """ 152 | 153 | [[wildcard-audits.puffin]] 154 | who = "Johan Andersson " 155 | criteria = "safe-to-deploy" 156 | user-id = 52553 157 | start = "2021-01-01" 158 | end = "2024-05-23" 159 | notes = "Maintained by Embark & emilk" 160 | 161 | [[wildcard-audits.puffin-imgui]] 162 | who = "Johan Andersson " 163 | criteria = "safe-to-deploy" 164 | user-id = 52553 165 | start = "2021-01-01" 166 | end = "2024-05-23" 167 | notes = "Maintained by Embark & emilk" 168 | 169 | [[wildcard-audits.puffin_egui]] 170 | who = "Johan Andersson " 171 | criteria = "safe-to-deploy" 172 | user-id = 52553 173 | start = "2021-01-01" 174 | end = "2024-05-23" 175 | notes = "Maintained by Embark & emilk" 176 | 177 | [[wildcard-audits.puffin_http]] 178 | who = "Johan Andersson " 179 | criteria = "safe-to-deploy" 180 | user-id = 52553 181 | start = "2021-01-01" 182 | end = "2024-05-23" 183 | notes = "Maintained by Embark & emilk" 184 | 185 | [[wildcard-audits.rymder]] 186 | who = "Jake Shadle " 187 | criteria = "safe-to-deploy" 188 | user-id = 52553 189 | start = "2021-01-01" 190 | end = "2024-05-23" 191 | notes = "Maintained by Embark" 192 | 193 | [[wildcard-audits.sadness-generator]] 194 | who = "Jake Shadle " 195 | criteria = "safe-to-deploy" 196 | user-id = 52553 197 | start = "2021-01-01" 198 | end = "2024-05-23" 199 | notes = """ 200 | Maintained by Embark. 201 | Note that this crate is explicitly for the purpose of testing aborting & crashing your application in different ways, 202 | which we use to verify that our crash reporting systems work properly 203 | """ 204 | 205 | [[wildcard-audits.saft]] 206 | who = "Niklas Nummelin " 207 | criteria = "safe-to-deploy" 208 | user-id = 52553 209 | start = "2021-01-01" 210 | end = "2024-05-23" 211 | notes = "Maintained by the Ark team at Embark" 212 | 213 | [[wildcard-audits.saft-sdf]] 214 | who = "Niklas Nummelin " 215 | criteria = "safe-to-deploy" 216 | user-id = 52553 217 | start = "2021-01-01" 218 | end = "2024-05-23" 219 | notes = "Maintained by the Ark team at Embark" 220 | 221 | [[wildcard-audits.ash-molten]] 222 | who = "Johan Andersson " 223 | criteria = "safe-to-deploy" 224 | user-id = 52553 225 | start = "2021-01-01" 226 | end = "2024-05-23" 227 | notes = """ 228 | Maintained by the Ark team at Embark. 229 | 230 | Tiny crate that with sane unsafe usage and no ambient runtime capabilities in the Rust code. 231 | 232 | Note it has a complex build setup where it downloads over HTTP a specific a pinned pre-built static binary for the C++ MoltenVK library. 233 | 234 | This audit does NOT cover the very large C++ MoltenVK codebase. 235 | """ 236 | 237 | [[wildcard-audits.spirv-std]] 238 | who = "eddyb " 239 | criteria = "safe-to-deploy" 240 | user-id = 52553 241 | start = "2021-01-01" 242 | end = "2024-05-23" 243 | notes = "Maintained by the rust-gpu team at Embark" 244 | 245 | [[wildcard-audits.spirv-std-macros]] 246 | who = "eddyb " 247 | criteria = "safe-to-deploy" 248 | user-id = 52553 249 | start = "2021-01-01" 250 | end = "2024-05-23" 251 | notes = "Maintained by the rust-gpu team at Embark" 252 | 253 | [[wildcard-audits.spirv-std-types]] 254 | who = "eddyb " 255 | criteria = "safe-to-deploy" 256 | user-id = 52553 257 | start = "2021-01-01" 258 | end = "2024-05-23" 259 | notes = "Maintained by the rust-gpu team at Embark" 260 | 261 | [[wildcard-audits.superluminal-perf]] 262 | who = "Johan Andersson " 263 | criteria = "safe-to-deploy" 264 | user-id = 52553 265 | start = "2021-01-01" 266 | end = "2024-05-23" 267 | notes = "I created and maintain this crate with Embark. It has been stable for 3 years, is for Windows only, and is a thin safe layer over FFI" 268 | 269 | [[wildcard-audits.superluminal-perf-sys]] 270 | who = "Johan Andersson " 271 | criteria = "safe-to-deploy" 272 | user-id = 52553 273 | start = "2020-01-01" 274 | end = "2024-05-23" 275 | notes = "I created and maintain this crate with Embark. It has been stable for 3 years, It is for Windows only and is an FFI layer over a pre-built static library provided by Superluminal.io" 276 | 277 | [[wildcard-audits.tame-webpurify]] 278 | who = "Mathias Tervo " 279 | criteria = "safe-to-deploy" 280 | user-id = 52553 281 | start = "2021-01-01" 282 | end = "2024-05-23" 283 | notes = "Maintained by Embark. sans-io network types for service, no unsafe or ambient capabilities" 284 | 285 | [[wildcard-audits.tiny-bench]] 286 | who = "Marcus Grass " 287 | criteria = "safe-to-run" 288 | user-id = 52553 289 | start = "2021-01-01" 290 | end = "2024-05-23" 291 | notes = "Maintained by Embark" 292 | 293 | [[wildcard-audits.tracing-logfmt]] 294 | who = "Fredrik Enestad " 295 | criteria = "safe-to-deploy" 296 | user-id = 52553 297 | start = "2021-01-01" 298 | end = "2024-05-23" 299 | notes = "Maintained by Embark. No unsafe or ambient capabilities" 300 | 301 | [[wildcard-audits.tryhard]] 302 | who = "David Pedersen " 303 | criteria = "safe-to-deploy" 304 | user-id = 52553 305 | start = "2021-01-01" 306 | end = "2024-05-23" 307 | notes = "Maintained by Embark. No unsafe usage or ambient capabilities" 308 | 309 | [[wildcard-audits.mirror-mirror]] 310 | who = "David Pedersen " 311 | criteria = "safe-to-deploy" 312 | user-id = 12432 313 | start = "2023-01-01" 314 | end = "2024-05-23" 315 | notes = "Maintained by Embark. No unsafe usage or ambient capabilities" 316 | 317 | [[wildcard-audits.mirror-mirror-macros]] 318 | who = "David Pedersen " 319 | criteria = "safe-to-deploy" 320 | user-id = 12432 321 | start = "2023-01-01" 322 | end = "2024-05-23" 323 | notes = "Maintained by Embark. No unsafe usage or ambient capabilities" 324 | 325 | [[wildcard-audits.cfg-expr]] 326 | who = "Jake Shadle " 327 | criteria = "safe-to-deploy" 328 | user-id = 52553 329 | start = "2020-01-01" 330 | end = "2024-05-23" 331 | notes = "Maintained by Embark. No unsafe usage or ambient capabilities" 332 | 333 | [[wildcard-audits.krates]] 334 | who = "Jake Shadle " 335 | criteria = "safe-to-deploy" 336 | user-id = 52553 337 | start = "2020-01-01" 338 | end = "2024-05-23" 339 | notes = """ 340 | Maintained by Embark. 341 | 342 | No unsafe usage but does allow calling of cargo via the cargo_metadata crate 343 | """ 344 | 345 | [[wildcard-audits.tame-gcs]] 346 | who = "Jake Shadle " 347 | criteria = "safe-to-deploy" 348 | user-id = 52553 349 | start = "2020-01-01" 350 | end = "2024-05-23" 351 | notes = "Maintained by Embark. No unsafe usage or ambient capabilities" 352 | 353 | [[wildcard-audits.spdx]] 354 | who = "Jake Shadle " 355 | criteria = "safe-to-deploy" 356 | user-id = 52553 357 | start = "2020-01-01" 358 | end = "2024-05-23" 359 | notes = "Maintained by Embark. No unsafe usage or ambient capabilities" 360 | 361 | [[wildcard-audits.discord-sdk]] 362 | who = "Jake Shadle " 363 | criteria = "safe-to-deploy" 364 | user-id = 52553 365 | start = "2021-01-01" 366 | end = "2024-05-23" 367 | notes = """ 368 | Maintained by Embark. 369 | 370 | No unsafe usage, but can get the path to the process it is running in 371 | """ 372 | 373 | [[wildcard-audits.crash-context]] 374 | who = "Jake Shadle " 375 | criteria = "safe-to-deploy" 376 | user-id = 52553 377 | start = "2023-01-01" 378 | end = "2024-05-23" 379 | notes = """ 380 | Maintained by Embark. 381 | 382 | This crate contains a large amount of unsafe code as it is provides assembly 383 | code for capturing CPU contexts, as well as a large chunk of unsafe code on 384 | MacOS for interacting with mach ports, but is fairly thoroughly tested. 385 | """ 386 | 387 | [[wildcard-audits.crash-handler]] 388 | who = "Jake Shadle " 389 | criteria = "safe-to-deploy" 390 | user-id = 52553 391 | start = "2023-01-01" 392 | end = "2024-05-23" 393 | notes = """ 394 | Maintained by Embark. 395 | 396 | This crate contains a large amount of unsafe code as it is interacting with OS 397 | signal/exception handling functionality, but is fairly thoroughly tested. Note 398 | on Linux targets, this also performs an interposition of pthread_create. 399 | """ 400 | 401 | [[wildcard-audits.minidumper]] 402 | who = "Jake Shadle " 403 | criteria = "safe-to-deploy" 404 | user-id = 52553 405 | start = "2023-01-01" 406 | end = "2024-05-23" 407 | notes = """ 408 | Maintained by Embark. 409 | 410 | This crate contains a large amount of unsafe code for implementing IPC between 2 411 | local processes, as well as calling into the minidump-writer crate which also 412 | contains a significant amount of unsafe to dump a processes state, but is fairly 413 | thoroughly tested. 414 | """ 415 | 416 | # ------------------------------------------------------------------ 417 | # third party crates we've done at least light audit / inspection of 418 | # ------------------------------------------------------------------ 419 | 420 | [[audits.tinyvec_macros]] 421 | who = "Johan Andersson " 422 | criteria = "safe-to-deploy" 423 | version = "0.1.0" 424 | notes = "Inspected it and is a tiny crate with single safe macro" 425 | 426 | [[audits.anyhow]] 427 | who = "Johan Andersson " 428 | criteria = "safe-to-deploy" 429 | version = "1.0.58" 430 | 431 | [[audits.anyhow]] 432 | who = "Johan Andersson " 433 | criteria = "safe-to-deploy" 434 | delta = "1.0.58 -> 1.0.66" 435 | notes = "New unsafe usage, looks sane. Expert maintainer" 436 | 437 | [[audits.cty]] 438 | who = "Johan Andersson " 439 | criteria = "safe-to-deploy" 440 | version = "0.2.2" 441 | notes = "Inspected it and is a tiny crate with just type definitions" 442 | 443 | [[audits.natord]] 444 | who = "Johan Andersson " 445 | criteria = "safe-to-deploy" 446 | version = "1.0.9" 447 | notes = "Inspected and it is a tiny crate with no unsafe or system interactions, just string comparisons" 448 | 449 | [[audits.pollster]] 450 | who = "Johan Andersson " 451 | criteria = "safe-to-deploy" 452 | version = "0.2.5" 453 | notes = "Inspected it and it is a minimal crate for blocking on futures and does nothing else" 454 | 455 | [[audits.serial_test]] 456 | who = "Johan Andersson " 457 | criteria = "safe-to-run" 458 | version = "0.6.0" 459 | 460 | [[audits.serial_test]] 461 | who = "Johan Andersson " 462 | criteria = "safe-to-run" 463 | delta = "0.6.0 -> 0.8.0" 464 | notes = "No unsafe and ambient capability with lock file creation is not exposed" 465 | 466 | [[audits.serial_test_derive]] 467 | who = "Johan Andersson " 468 | criteria = "safe-to-run" 469 | version = "0.6.0" 470 | 471 | [[audits.serial_test_derive]] 472 | who = "Johan Andersson " 473 | criteria = "safe-to-run" 474 | delta = "0.6.0 -> 0.8.0" 475 | notes = "No unsafe usage or ambient capabilities" 476 | 477 | [[audits.uname]] 478 | who = "Johan Andersson " 479 | criteria = "safe-to-deploy" 480 | version = "0.1.1" 481 | notes = "Inspected it and is tiny crate wrapping libc function with some unsafe usage for string handling" 482 | 483 | [[audits.webpki-roots]] 484 | who = "Johan Andersson " 485 | criteria = "safe-to-deploy" 486 | version = "0.22.4" 487 | notes = "Inspected it to confirm that it only contains data definitions and no runtime code" 488 | 489 | [[audits.rustdoc-json]] 490 | who = "Johan Andersson " 491 | criteria = "safe-to-run" 492 | version = "0.6.0" 493 | notes = "Fairly trivial crate that invokes rustdoc through Cargo, didn't spot any other visible ambient capabilities or unsafe usage" 494 | 495 | [[audits.rustdoc-json]] 496 | who = "Johan Andersson " 497 | criteria = "safe-to-run" 498 | delta = "0.6.0 -> 0.7.4" 499 | 500 | [[audits.rustdoc-json]] 501 | who = "Johan Andersson " 502 | criteria = "safe-to-run" 503 | delta = "0.7.4 -> 0.8.4" 504 | 505 | [[audits.rustdoc-json]] 506 | who = "Johan Andersson " 507 | criteria = "safe-to-run" 508 | delta = "0.8.4 -> 0.8.6" 509 | 510 | [[audits.rustdoc-json]] 511 | who = "Johan Andersson " 512 | criteria = "safe-to-run" 513 | delta = "0.8.6 -> 0.8.7" 514 | 515 | [[audits.rustdoc-types]] 516 | who = "Johan Andersson " 517 | criteria = "safe-to-run" 518 | version = "0.18.0" 519 | notes = "Contains just data definitions, no unsafe" 520 | 521 | [[audits.rustdoc-types]] 522 | who = "Johan Andersson " 523 | criteria = "safe-to-run" 524 | delta = "0.18.0 -> 0.20.0" 525 | notes = "Contains just data definitions, no unsafe" 526 | 527 | [[audits.rustdoc-types]] 528 | who = "Johan Andersson " 529 | criteria = "safe-to-run" 530 | delta = "0.20.0 -> 0.22.0" 531 | notes = "Contains just data definitions, no unsafe" 532 | 533 | [[audits.rustdoc-types]] 534 | who = "Johan Andersson " 535 | criteria = "safe-to-run" 536 | delta = "0.22.0 -> 0.23.0" 537 | notes = "Contains just data definitions, no unsafe" 538 | 539 | [[audits.public-api]] 540 | who = "Johan Andersson " 541 | criteria = "safe-to-run" 542 | version = "0.22.0" 543 | notes = "No unsafe code, does interact with Cargo and launches processes with rustdoc which at a casual inspection looks sane" 544 | 545 | [[audits.public-api]] 546 | who = "Johan Andersson " 547 | criteria = "safe-to-run" 548 | delta = "0.22.0 -> 0.23.0" 549 | 550 | [[audits.public-api]] 551 | who = "Johan Andersson " 552 | criteria = "safe-to-run" 553 | delta = "0.23.0 -> 0.26.0" 554 | 555 | [[audits.public-api]] 556 | who = "Johan Andersson " 557 | criteria = "safe-to-run" 558 | delta = "0.26.0 -> 0.29.1" 559 | 560 | [[audits.public-api]] 561 | who = "Johan Andersson " 562 | criteria = "safe-to-run" 563 | delta = "0.29.1 -> 0.30.0" 564 | 565 | [[audits.public-api]] 566 | who = "Johan Andersson " 567 | criteria = "safe-to-run" 568 | delta = "0.30.0 -> 0.31.1" 569 | 570 | [[audits.public-api]] 571 | who = "Johan Andersson " 572 | criteria = "safe-to-run" 573 | delta = "0.31.1 -> 0.31.2" 574 | 575 | [[audits.strum]] 576 | who = "Johan Andersson " 577 | criteria = "safe-to-deploy" 578 | version = "0.24.1" 579 | notes = "Tiny layer on top of the proc macro crate, found no unsafe or system usage" 580 | 581 | [[audits.strum_macros]] 582 | who = "Johan Andersson " 583 | criteria = "safe-to-deploy" 584 | version = "0.24.3" 585 | notes = "Proc macro. No unsafe or added ambient capabilities" 586 | 587 | [[audits.mimalloc]] 588 | who = "Johan Andersson " 589 | criteria = "safe-to-deploy" 590 | version = "0.1.31" 591 | notes = "Inspected it and it is a tiny crate implementing allocator wrapping a the allocator C++ sys crate but with simple unsafe code that looks sound" 592 | 593 | [[audits.nohash-hasher]] 594 | who = "Johan Andersson " 595 | criteria = "safe-to-deploy" 596 | version = "0.2.0" 597 | notes = "Tiny crate with no dependencies, no unsafe, and no ambient capabilities" 598 | 599 | [[audits.dolly]] 600 | who = "Johan Andersson " 601 | criteria = "safe-to-deploy" 602 | version = "0.3.1" 603 | notes = """ 604 | No unsafe and no dependencies except math (glam), used it in production since 2021. 605 | 606 | Written by Tomasz Stachowiak as side-project while employed with us at Embark Studios. 607 | """ 608 | 609 | [[audits.dolly]] 610 | who = "Johan Andersson " 611 | criteria = "safe-to-deploy" 612 | delta = "0.3.1 -> 0.4.0" 613 | notes = "No unsafe or added ambient capabilities" 614 | 615 | [[audits.similar-asserts]] 616 | who = "Johan Andersson " 617 | criteria = "safe-to-deploy" 618 | version = "1.2.0" 619 | notes = "Small crate with no unsafe or ambient capabilities" 620 | 621 | [[audits.cap-std]] 622 | who = "Johan Andersson " 623 | criteria = "safe-to-deploy" 624 | delta = "0.26.0 -> 0.26.1" 625 | notes = "No changes, only version bump" 626 | 627 | [[audits.ndk-context]] 628 | who = "Johan Andersson " 629 | criteria = "safe-to-deploy" 630 | version = "0.1.1" 631 | notes = "Tiny crate that initializes Android with FFI, looks sane. No other ambient capabilities" 632 | 633 | 634 | [[audits.egui]] 635 | who = "Johan Andersson " 636 | criteria = "safe-to-deploy" 637 | version = "0.18.0" 638 | notes = """ 639 | No unsafe usage or ambient capabilities itself, used in production since 2020. 640 | 641 | Written by Emil Ernerfeldt who used to work with us at Embark Studios. 642 | """ 643 | 644 | [[audits.egui]] 645 | who = "Johan Andersson " 646 | criteria = "safe-to-deploy" 647 | delta = "0.18.0 -> 0.19.0" 648 | notes = "No unsafe usage and no ambient capabilities" 649 | 650 | [[audits.epaint]] 651 | who = "Johan Andersson " 652 | criteria = "safe-to-deploy" 653 | violation = "<0.20.0" 654 | notes = "Specified crate license does not include licenses of embedded fonts if using default features or the `default_fonts` feature. Tracked in: https://github.com/emilk/egui/issues/2321" 655 | 656 | [[audits.emath]] 657 | who = "Johan Andersson " 658 | criteria = "safe-to-deploy" 659 | version = "0.18.0" 660 | notes = """ 661 | Math crate with no unsafe usage or ambient capabilities, used in production since 2020. 662 | 663 | Written by Emil Ernerfeldt who used to work with us at Embark Studios. 664 | """ 665 | 666 | [[audits.emath]] 667 | who = "Johan Andersson " 668 | criteria = "safe-to-deploy" 669 | delta = "0.18.0 -> 0.19.0" 670 | notes = "No unsafe usage and no ambient capabilities" 671 | 672 | [[audits.egui-winit]] 673 | who = "Johan Andersson " 674 | criteria = "safe-to-deploy" 675 | version = "0.18.0" 676 | notes = """ 677 | No unsafe usage, does layer with windowing system (which is the point of the crate). Used in production since 2020. 678 | Does optionally interact with clipboard, webbrowser, and screen-reader; but through separate crates. 679 | 680 | Written by Emil Ernerfeldt who used to work with us at Embark Studios. 681 | """ 682 | 683 | [[audits.egui-winit]] 684 | who = "Johan Andersson " 685 | criteria = "safe-to-deploy" 686 | delta = "0.18.0 -> 0.19.0" 687 | notes = "Minor sane unsafe usage and no new ambient capabilities" 688 | 689 | [[audits.raw-window-handle]] 690 | who = "Johan Andersson " 691 | criteria = "safe-to-deploy" 692 | delta = "0.4.3 -> 0.5.0" 693 | notes = "No new unsafe usage or ambient capabilities" 694 | 695 | [[audits.thiserror]] 696 | who = "Johan Andersson " 697 | criteria = "safe-to-deploy" 698 | version = "1.0.40" 699 | notes = "Wrapper over implementation crate, found no unsafe or ambient capabilities used" 700 | 701 | [[audits.thiserror-impl]] 702 | who = "Johan Andersson " 703 | criteria = "safe-to-deploy" 704 | version = "1.0.40" 705 | notes = "Found no unsafe or ambient capabilities used" 706 | 707 | [[audits.headers]] 708 | who = "Johan Andersson " 709 | criteria = "safe-to-deploy" 710 | version = "0.3.8" 711 | notes = "HTTP type definitions. Single sound unsafe usage, no ambient capabilities used" 712 | 713 | [[audits.convert_case]] 714 | who = "Johan Andersson " 715 | criteria = "safe-to-deploy" 716 | version = "0.4.0" 717 | notes = "No unsafe usage or ambient capabilities" 718 | 719 | [[audits.sentry-types]] 720 | who = "Johan Andersson " 721 | criteria = "safe-to-deploy" 722 | version = "0.30.0" 723 | notes = "Type definitions. No unsafe usage, can read files but only based on user-provided paths, no other ambient capabilities" 724 | 725 | [[audits.tap]] 726 | who = "Johan Andersson " 727 | criteria = "safe-to-deploy" 728 | version = "1.0.1" 729 | notes = "No unsafe usage or ambient capabilities" 730 | 731 | [[audits.unic-ucd-version]] 732 | who = "Johan Andersson " 733 | criteria = "safe-to-deploy" 734 | version = "0.9.0" 735 | notes = "Only few constants. No unsafe usage or other ambient capabilities" 736 | 737 | [[audits.cargo_metadata]] 738 | who = "Johan Andersson " 739 | criteria = "safe-to-deploy" 740 | delta = "0.15.3 -> 0.15.4" 741 | notes = "No notable changes" 742 | 743 | [[audits.cargo_metadata]] 744 | who = "Johan Andersson " 745 | criteria = "safe-to-deploy" 746 | delta = "0.15.4 -> 0.17.0" 747 | notes = "No notable changes" 748 | 749 | [[audits.toml_datetime]] 750 | who = "Johan Andersson " 751 | criteria = "safe-to-deploy" 752 | delta = "0.6.1 -> 0.6.2" 753 | notes = "No notable changes" 754 | 755 | [[audits.ident_case]] 756 | who = "Johan Andersson " 757 | criteria = "safe-to-deploy" 758 | version = "1.0.1" 759 | notes = "No unsafe usage or ambient capabilities" 760 | 761 | [[audits.png]] 762 | who = "Johan Andersson " 763 | criteria = "safe-to-deploy" 764 | version = "0.17.8" 765 | notes = "Forbids unsafe, no ambient capabilities" 766 | 767 | [[audits.vec1]] 768 | who = "Johan Andersson " 769 | criteria = "safe-to-deploy" 770 | version = "1.10.1" 771 | notes = "No unsafe usage or ambient capabilities" 772 | 773 | [[audits.rspirv-reflect]] 774 | who = "Johan Andersson " 775 | criteria = "safe-to-deploy" 776 | version = "0.8.0" 777 | notes = "No unsafe usage or ambient capabilities" 778 | 779 | [[audits.rspirv]] 780 | who = "Johan Andersson " 781 | criteria = "safe-to-deploy" 782 | version = "0.11.0+1.5.4" 783 | notes = "Single sound unsafe usage, no ambient capabilities" 784 | 785 | [[audits.embed-resource]] 786 | who = "Johan Andersson " 787 | criteria = "safe-to-run" 788 | version = "2.1.1" 789 | notes = "No unsafe usage, does use file system at time and runs resource compiler to embed it into executable which looks sound. Intended to be used only at build time" 790 | 791 | [[audits.num_enum]] 792 | who = "Johan Andersson " 793 | criteria = "safe-to-deploy" 794 | version = "0.5.11" 795 | notes = "No unsafe usage or ambient capabilities" 796 | 797 | [[audits.num_enum]] 798 | who = "Johan Andersson " 799 | criteria = "safe-to-deploy" 800 | delta = "0.5.11 -> 0.6.1" 801 | notes = "Minor changes" 802 | 803 | [[audits.num_enum]] 804 | who = "Johan Andersson " 805 | criteria = "safe-to-deploy" 806 | delta = "0.6.1 -> 0.7.0" 807 | 808 | [[audits.num_enum_derive]] 809 | who = "Johan Andersson " 810 | criteria = "safe-to-deploy" 811 | version = "0.5.11" 812 | notes = "Proc macro that generates some unsafe code for conversion but looks sound, no ambient capabilities" 813 | 814 | [[audits.num_enum_derive]] 815 | who = "Johan Andersson " 816 | criteria = "safe-to-deploy" 817 | delta = "0.5.11 -> 0.6.1" 818 | notes = "Minor changes" 819 | 820 | [[audits.num_enum_derive]] 821 | who = "Johan Andersson " 822 | criteria = "safe-to-deploy" 823 | delta = "0.6.1 -> 0.7.0" 824 | 825 | [[audits.cfg_aliases]] 826 | who = "Johan Andersson " 827 | criteria = "safe-to-deploy" 828 | version = "0.1.1" 829 | notes = "No unsafe usage or ambient capabilities" 830 | 831 | [[audits.derive_more]] 832 | who = "Johan Andersson " 833 | criteria = "safe-to-deploy" 834 | version = "0.99.17" 835 | notes = "No unsafe usage or ambient capabilities" 836 | 837 | [[audits.which]] 838 | who = "Johan Andersson " 839 | criteria = "safe-to-run" 840 | version = "4.4.0" 841 | notes = "Small build-time crate to find path of binary. Single unsafe usage, file system access, both look sound" 842 | 843 | [[audits.wasmbin-derive]] 844 | who = "Johan Andersson " 845 | criteria = "safe-to-deploy" 846 | version = "0.2.2" 847 | notes = "Proc macro. No unsafe usage or ambient capabilities" 848 | 849 | [[audits.version-compare]] 850 | who = "Johan Andersson " 851 | criteria = "safe-to-deploy" 852 | version = "0.1.1" 853 | notes = "No unsafe usage or ambient capabilities" 854 | 855 | [[audits.valuable]] 856 | who = "Johan Andersson " 857 | criteria = "safe-to-deploy" 858 | version = "0.1.0" 859 | notes = "No unsafe usage or ambient capabilities, sane build script" 860 | 861 | [[audits.vec_map]] 862 | who = "Johan Andersson " 863 | criteria = "safe-to-deploy" 864 | version = "0.8.2" 865 | notes = "No unsafe usage or ambient capabilities" 866 | 867 | [[audits.no-std-compat]] 868 | who = "Johan Andersson " 869 | criteria = "safe-to-deploy" 870 | version = "0.2.0" 871 | notes = "No unsafe usage or ambient capabilities" 872 | 873 | [[audits.no-std-compat]] 874 | who = "Johan Andersson " 875 | criteria = "safe-to-deploy" 876 | delta = "0.2.0 -> 0.4.1" 877 | 878 | [[audits.array-init]] 879 | who = "Johan Andersson " 880 | criteria = "safe-to-deploy" 881 | version = "2.1.0" 882 | notes = "Some unsafe usage but with safety comments and tests, and appear sound but didn't do detailed evaluation. No ambient capabilities" 883 | 884 | 885 | [[audits.assert-json-diff]] 886 | who = "Johan Andersson " 887 | criteria = "safe-to-run" 888 | version = "2.0.2" 889 | notes = "No unsafe usage or ambient capabilities" 890 | 891 | [[audits.async-recursion]] 892 | who = "Johan Andersson " 893 | criteria = "safe-to-deploy" 894 | version = "1.0.2" 895 | notes = "Proc macro. No unsafe usage or ambient capabilities" 896 | 897 | [[audits.quickcheck_macros]] 898 | who = "Johan Andersson " 899 | criteria = "safe-to-deploy" 900 | version = "1.0.0" 901 | notes = "Proc macro. No unsafe usage or ambient capabilities" 902 | 903 | [[audits.async-channel]] 904 | who = "Johan Andersson " 905 | criteria = "safe-to-deploy" 906 | version = "1.8.0" 907 | notes = "No unsafe usage or ambient capabilities" 908 | 909 | [[audits.autometrics]] 910 | who = "Johan Andersson " 911 | criteria = "safe-to-deploy" 912 | version = "0.4.1" 913 | notes = "Minor unsafe usage with safety comments, looks sound. No ambient capabilities" 914 | 915 | [[audits.autometrics]] 916 | who = "Johan Andersson " 917 | criteria = "safe-to-deploy" 918 | delta = "0.4.1 -> 0.5.0" 919 | 920 | [[audits.autometrics-macros]] 921 | who = "Johan Andersson " 922 | criteria = "safe-to-deploy" 923 | version = "0.4.1" 924 | notes = "No unsafe usage. Minor ambient capabilities with reading an environment variable" 925 | 926 | [[audits.autometrics-macros]] 927 | who = "Johan Andersson " 928 | criteria = "safe-to-deploy" 929 | delta = "0.4.1 -> 0.5.0" 930 | 931 | [[audits.jsonwebtoken]] 932 | who = "Johan Andersson " 933 | criteria = "safe-to-deploy" 934 | version = "8.3.0" 935 | notes = "No unsafe usage or ambient capabilities" 936 | 937 | [[audits.lewton]] 938 | who = "Johan Andersson " 939 | criteria = "safe-to-deploy" 940 | version = "0.10.2" 941 | notes = "No unsafe usage or ambient capabilities" 942 | 943 | [[audits.line-wrap]] 944 | who = "Johan Andersson " 945 | criteria = "safe-to-deploy" 946 | version = "0.1.1" 947 | notes = "No unsafe usage or ambient capabilities" 948 | 949 | [[audits.yaml-rust]] 950 | who = "Johan Andersson " 951 | criteria = "safe-to-deploy" 952 | version = "0.4.5" 953 | notes = "No unsafe usage or ambient capabilities" 954 | 955 | [[audits.toml]] 956 | who = "Johan Andersson " 957 | criteria = "safe-to-deploy" 958 | version = "0.7.4" 959 | notes = "No unsafe usage or ambient capabilities" 960 | 961 | [[audits.ittapi]] 962 | who = "Johan Andersson " 963 | criteria = "safe-to-deploy" 964 | version = "0.3.3" 965 | notes = "Lots of unsafe code for calling into C FFI functions, looks pretty simple and sound though. No ambient capabilities" 966 | 967 | [[audits.ittapi-sys]] 968 | who = "Johan Andersson " 969 | criteria = "safe-to-deploy" 970 | version = "0.3.3" 971 | notes = """ 972 | Builds C/asm dependency which this review has not audited in detail, but is well established from Intel. 973 | Exposes FFI types & functions generated through bindgen. No other logic. 974 | No ambient capabilities 975 | """ 976 | 977 | [[audits.lyon_geom]] 978 | who = "Johan Andersson " 979 | criteria = "safe-to-deploy" 980 | version = "1.0.4" 981 | notes = "No unsafe usage or ambient capabilities" 982 | 983 | [[audits.lyon_path]] 984 | who = "Johan Andersson " 985 | criteria = "safe-to-deploy" 986 | version = "1.0.3" 987 | notes = "Some unsafe usage in optimized iterators, looks sound. No ambient capabilities" 988 | 989 | [[audits.lyon_tessellation]] 990 | who = "Johan Andersson " 991 | criteria = "safe-to-deploy" 992 | version = "1.0.10" 993 | notes = "Single unsafe usage that looks sound. No ambient capabilities" 994 | 995 | [[audits.unicode_ident]] 996 | who = "Johan Andersson " 997 | criteria = "safe-to-deploy" 998 | version = "1.0.9" 999 | notes = "No unsafe usage or ambient capabilities" 1000 | 1001 | [[audits.similar]] 1002 | who = "Johan Andersson " 1003 | criteria = "safe-to-deploy" 1004 | version = "2.2.1" 1005 | notes = "No unsafe usage or ambient capabilities" 1006 | 1007 | [[audits.ttf-parser]] 1008 | who = "Johan Andersson " 1009 | criteria = "safe-to-deploy" 1010 | version = "0.19.0" 1011 | notes = "No unsafe usage (forbidden) or ambient capabilities" 1012 | 1013 | [[audits.ab_glyph]] 1014 | who = "Johan Andersson " 1015 | criteria = "safe-to-deploy" 1016 | version = "0.2.21" 1017 | notes = "No unsafe usage or ambient capabilities" 1018 | 1019 | [[audits.ogg]] 1020 | who = "Johan Andersson " 1021 | criteria = "safe-to-deploy" 1022 | version = "0.9.0" 1023 | notes = "No unsafe usage (forbidden) or ambient capabilities" 1024 | 1025 | [[audits.data-url]] 1026 | who = "Johan Andersson " 1027 | criteria = "safe-to-deploy" 1028 | version = "0.3.0" 1029 | notes = "No unsafe usage or ambient capabilities" 1030 | 1031 | [[audits.rustc-workspace-hack]] 1032 | who = "Johan Andersson " 1033 | criteria = "safe-to-deploy" 1034 | version = "1.0.0" 1035 | notes = "No unsafe usage or ambient capabilities. No functionality in it beyond a #[test]. " 1036 | 1037 | [[audits.android-activity]] 1038 | who = "Robert Bragg " 1039 | criteria = "safe-to-deploy" 1040 | version = "0.4.1" 1041 | notes = """Some unsafe usage for JNI/FFI, such as implementing extern \"C\" functions for 1042 | NativeActivity and to use the `ndk_sys` FFI bindings for the Android NDK libraries. 1043 | 1044 | The GameActivity backend depends on around 2k lines of third-party C/C++ code from Google 1045 | as well as around 500 lines of C++ code for the GameText (input method) support. 1046 | The C/C++ code is compiled with the `cc` crate. 1047 | 1048 | Although I have reviewed all of the C/C++ code for GameActivity + GameText there 1049 | could be unknown soundness issues in there or potentially in any of the Android 1050 | NDK APIs used, which are generally also implemented in C/C++. 1051 | 1052 | Written by Robert Bragg who now works at Embark Studios. 1053 | """ 1054 | 1055 | [[audits.mimalloc]] 1056 | who = "Johan Andersson " 1057 | criteria = "safe-to-deploy" 1058 | version = "0.1.37" 1059 | notes = "Tiny allocator layer on top of the C sys crate. No ambient capabilities" 1060 | 1061 | [[audits.case]] 1062 | who = "Johan Andersson " 1063 | criteria = "safe-to-deploy" 1064 | version = "1.0.0" 1065 | notes = "No unsafe usage or ambient capabilities. Stable for 4+ years" 1066 | 1067 | [[audits.gltf-json]] 1068 | who = "Johan Andersson " 1069 | criteria = "safe-to-deploy" 1070 | version = "1.2.0" 1071 | notes = "No unsafe usage or ambient capabilities" 1072 | 1073 | [[audits.gltf-derive]] 1074 | who = "Johan Andersson " 1075 | criteria = "safe-to-deploy" 1076 | version = "1.2.0" 1077 | notes = "Tiny proc marcro. No unsafe usage or ambient capabilities" 1078 | 1079 | [[audits.jni]] 1080 | who = "Robert Bragg " 1081 | criteria = "safe-to-deploy" 1082 | version = "0.21.1" 1083 | notes = """Aims to provide a safe JNI (Java Native Interface) API over the 1084 | unsafe `jni_sys` crate. 1085 | 1086 | This is a very general FFI abstraction for Java VMs with a lot of unsafe code 1087 | throughout the API. There are almost certainly some edge cases with its design 1088 | that could lead to unsound behaviour but it should still be considerably safer 1089 | than working with JNI directly. 1090 | 1091 | A lot of the unsafe usage relates to quite-simple use of `from_raw` APIs to 1092 | construct or cast wrapper types (around JNI pointers) which are fairly 1093 | straight-forward to verify/trust in context. 1094 | 1095 | Some unsafe code has good `// # Safety` documentation (this has been enforced for 1096 | newer code) but a lot of unsafe code doesn't document invariants that are 1097 | being relied on. 1098 | 1099 | The design depends on non-trivial named lifetimes across many APIs to associate 1100 | Java local references with JNI stack frames. 1101 | 1102 | The crate is not very actively maintained and was practically unmaintained for 1103 | over a year before the 0.20 release. 1104 | 1105 | Robert Bragg who now works at Embark Studios became the maintainer of this 1106 | crate in October 2022. 1107 | 1108 | In the process of working on the `jni` crate since becoming maintainer it's 1109 | worth noting that I came across multiple APIs that I found needed to be 1110 | re-worked to address safety issues, including ensuring that APIs that are not 1111 | implemented safely are correctly declared as `unsafe`. 1112 | 1113 | There has been a focus on improving safety in the last two release. 1114 | 1115 | The jni crate has been used in production with the Signal messaging application 1116 | for over two years: 1117 | https://github.com/signalapp/libsignal/blob/main/rust/bridge/jni/Cargo.toml 1118 | 1119 | # Some Notable Open Issues 1120 | - https://github.com/jni-rs/jni-rs/issues/422 - questions soundness of linking 1121 | multiple versions of jni crate into an application, considering the use 1122 | of (separately scoped) thread-local-storage to track thread attachments 1123 | - https://github.com/jni-rs/jni-rs/issues/405 - discusses the ease with which 1124 | code may expose the JVM to invalid booleans with undefined behaviour 1125 | """ 1126 | 1127 | [[audits.colorchoice]] 1128 | who = "Johan Andersson " 1129 | criteria = "safe-to-deploy" 1130 | version = "1.0.0" 1131 | notes = "No unsafe usage or ambient capabilities" 1132 | 1133 | [[audits.utf8parse]] 1134 | who = "Johan Andersson " 1135 | criteria = "safe-to-deploy" 1136 | version = "0.2.1" 1137 | notes = "Single unsafe usage that looks sound, no ambient capabilities" 1138 | 1139 | [[audits.spez]] 1140 | who = "Johan Andersson " 1141 | criteria = "safe-to-deploy" 1142 | version = "0.1.2" 1143 | notes = "Proc macro. No unsafe usage or ambient capabilities" 1144 | 1145 | [[audits.schemars]] 1146 | who = "Johan Andersson " 1147 | criteria = "safe-to-deploy" 1148 | version = "0.8.12" 1149 | notes = "No unsafe usage (forbidden) or ambient capabilities" 1150 | 1151 | [[audits.schemars_derive]] 1152 | who = "Johan Andersson " 1153 | criteria = "safe-to-deploy" 1154 | version = "0.8.12" 1155 | notes = "Proc macro. No unsafe usage (forbidden) or ambient capabilities" 1156 | 1157 | [[audits.typed-builder]] 1158 | who = "Johan Andersson " 1159 | criteria = "safe-to-deploy" 1160 | version = "0.12.0" 1161 | notes = "Proc macro. No unsafe usage or ambient capabilities" 1162 | 1163 | [[audits.typed-builder]] 1164 | who = "Johan Andersson " 1165 | criteria = "safe-to-deploy" 1166 | delta = "0.12.0 -> 0.14.0" 1167 | 1168 | [[audits.derive-new]] 1169 | who = "Johan Andersson " 1170 | criteria = "safe-to-deploy" 1171 | version = "0.5.9" 1172 | notes = "Proc macro. No unsafe usage or ambient capabilities" 1173 | 1174 | [[audits.google-cloud-googleapis]] 1175 | who = "Johan Andersson " 1176 | criteria = "safe-to-deploy" 1177 | version = "0.9.0" 1178 | notes = "No unsafe usage or ambient capabilities" 1179 | 1180 | [[audits.idna]] 1181 | who = "Johan Andersson " 1182 | criteria = "safe-to-deploy" 1183 | delta = "0.3.0 -> 0.4.0" 1184 | notes = "No unsafe usage or ambient capabilities" 1185 | 1186 | [[audits.png]] 1187 | who = "Johan Andersson " 1188 | criteria = "safe-to-deploy" 1189 | version = "0.17.9" 1190 | notes = "No unsafe usage (forbidden) or ambient capabilities" 1191 | 1192 | [[audits.png]] 1193 | who = "Johan Andersson " 1194 | criteria = "safe-to-deploy" 1195 | version = "0.17.9" 1196 | notes = "No unsafe usage (forbidden) or ambient capabilities" 1197 | 1198 | [[audits.postgres-types]] 1199 | who = "Johan Andersson " 1200 | criteria = "safe-to-deploy" 1201 | version = "0.2.5" 1202 | notes = "No unsafe usage or ambient capabilities. Only type definitions & conversions" 1203 | 1204 | [[audits.std_prelude]] 1205 | who = "Johan Andersson " 1206 | criteria = "safe-to-deploy" 1207 | version = "0.2.12" 1208 | notes = "No unsafe usage or ambient capabilities. Only re-exports std types. However I would not recommend using this crate as it is an unnecessary dependency and indirection, and makes it harder to audit other code over standard explicit std imports" 1209 | 1210 | [[audits.custom_debug]] 1211 | who = "Johan Andersson " 1212 | criteria = "safe-to-deploy" 1213 | version = "0.5.1" 1214 | notes = "No unsafe usage or ambient capabilities" 1215 | 1216 | [[audits.custom_debug_derive]] 1217 | who = "Johan Andersson " 1218 | criteria = "safe-to-deploy" 1219 | version = "0.5.1" 1220 | notes = "Proc macro. No unsafe usage or ambient capabilities" 1221 | 1222 | [[audits.multibase]] 1223 | who = "Johan Andersson " 1224 | criteria = "safe-to-deploy" 1225 | version = "0.9.1" 1226 | notes = "No unsafe usage or ambient capabilities" 1227 | 1228 | [[audits.scan_fmt]] 1229 | who = "Johan Andersson " 1230 | criteria = "safe-to-deploy" 1231 | version = "0.2.6" 1232 | notes = "No unsafe usage or ambient capabilities" 1233 | 1234 | [[audits.fixedvec]] 1235 | who = "Johan Andersson " 1236 | criteria = "safe-to-deploy" 1237 | version = "0.2.4" 1238 | notes = "No unsafe usage or ambient capabilities. Clean, simple, no dependencies, no std" 1239 | 1240 | [[audits.fdeflate]] 1241 | who = "Johan Andersson " 1242 | criteria = "safe-to-deploy" 1243 | version = "0.3.0" 1244 | notes = "No unsafe usage or ambient capabilities" 1245 | 1246 | [[audits.stringprep]] 1247 | who = "Johan Andersson " 1248 | criteria = "safe-to-deploy" 1249 | version = "0.1.2" 1250 | notes = "No unsafe usage or ambient capabilities. Old crate from released and unchanged from 2017" 1251 | 1252 | [[audits.hashbag]] 1253 | who = "Johan Andersson " 1254 | criteria = "safe-to-deploy" 1255 | version = "0.1.11" 1256 | notes = "No unsafe usage or ambient capabilities" 1257 | 1258 | # ------------------------------------------------------------------------------------------ 1259 | # third party crates that we haven't audited, but we trust the author and release process of 1260 | # ------------------------------------------------------------------------------------------ 1261 | 1262 | 1263 | [[trusted.cranelift-bforest]] 1264 | criteria = "safe-to-deploy" 1265 | user-id = 73222 # wasmtime-publish 1266 | start = "2023-01-01" 1267 | end = "2024-05-26" 1268 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1269 | 1270 | [[trusted.cranelift-codegen]] 1271 | criteria = "safe-to-deploy" 1272 | user-id = 73222 # wasmtime-publish 1273 | start = "2023-01-01" 1274 | end = "2024-05-26" 1275 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1276 | 1277 | [[trusted.cranelift-codegen-meta]] 1278 | criteria = "safe-to-deploy" 1279 | user-id = 73222 # wasmtime-publish 1280 | start = "2023-01-01" 1281 | end = "2024-05-26" 1282 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1283 | 1284 | [[trusted.cranelift-codegen-shared]] 1285 | criteria = "safe-to-deploy" 1286 | user-id = 73222 # wasmtime-publish 1287 | start = "2023-01-01" 1288 | end = "2024-05-26" 1289 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1290 | 1291 | [[trusted.cranelift-control]] 1292 | criteria = "safe-to-deploy" 1293 | user-id = 73222 # wasmtime-publish 1294 | start = "2023-01-01" 1295 | end = "2024-05-26" 1296 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1297 | 1298 | [[trusted.cranelift-entity]] 1299 | criteria = "safe-to-deploy" 1300 | user-id = 73222 # wasmtime-publish 1301 | start = "2023-01-01" 1302 | end = "2024-05-26" 1303 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1304 | 1305 | [[trusted.cranelift-frontend]] 1306 | criteria = "safe-to-deploy" 1307 | user-id = 73222 # wasmtime-publish 1308 | start = "2023-01-01" 1309 | end = "2024-05-26" 1310 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1311 | 1312 | [[trusted.cranelift-isle]] 1313 | criteria = "safe-to-deploy" 1314 | user-id = 73222 # wasmtime-publish 1315 | start = "2023-01-01" 1316 | end = "2024-05-26" 1317 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1318 | 1319 | [[trusted.cranelift-native]] 1320 | criteria = "safe-to-deploy" 1321 | user-id = 73222 # wasmtime-publish 1322 | start = "2023-01-01" 1323 | end = "2024-05-26" 1324 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1325 | 1326 | [[trusted.cranelift-wasm]] 1327 | criteria = "safe-to-deploy" 1328 | user-id = 73222 # wasmtime-publish 1329 | start = "2023-01-01" 1330 | end = "2024-05-26" 1331 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1332 | 1333 | [[trusted.wasi-cap-std-sync]] 1334 | criteria = "safe-to-deploy" 1335 | user-id = 73222 # wasmtime-publish 1336 | start = "2023-01-01" 1337 | end = "2024-05-26" 1338 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1339 | 1340 | [[trusted.wasi-common]] 1341 | criteria = "safe-to-deploy" 1342 | user-id = 73222 # wasmtime-publish 1343 | start = "2023-01-01" 1344 | end = "2024-05-26" 1345 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1346 | 1347 | [[trusted.wasmtime]] 1348 | criteria = "safe-to-deploy" 1349 | user-id = 73222 # wasmtime-publish 1350 | start = "2023-01-01" 1351 | end = "2024-05-26" 1352 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1353 | 1354 | [[trusted.wasmtime-asm-macros]] 1355 | criteria = "safe-to-deploy" 1356 | user-id = 73222 # wasmtime-publish 1357 | start = "2023-01-01" 1358 | end = "2024-05-26" 1359 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1360 | 1361 | [[trusted.wasmtime-cranelift]] 1362 | criteria = "safe-to-deploy" 1363 | user-id = 73222 # wasmtime-publish 1364 | start = "2023-01-01" 1365 | end = "2024-05-26" 1366 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1367 | 1368 | [[trusted.wasmtime-cranelift-shared]] 1369 | criteria = "safe-to-deploy" 1370 | user-id = 73222 # wasmtime-publish 1371 | start = "2023-01-01" 1372 | end = "2024-05-26" 1373 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1374 | 1375 | [[trusted.wasmtime-environ]] 1376 | criteria = "safe-to-deploy" 1377 | user-id = 73222 # wasmtime-publish 1378 | start = "2023-01-01" 1379 | end = "2024-05-26" 1380 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1381 | 1382 | [[trusted.wasmtime-jit]] 1383 | criteria = "safe-to-deploy" 1384 | user-id = 73222 # wasmtime-publish 1385 | start = "2023-01-01" 1386 | end = "2024-05-26" 1387 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1388 | 1389 | [[trusted.wasmtime-jit-debug]] 1390 | criteria = "safe-to-deploy" 1391 | user-id = 73222 # wasmtime-publish 1392 | start = "2023-01-01" 1393 | end = "2024-05-26" 1394 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1395 | 1396 | [[trusted.wasmtime-jit-icache-coherence]] 1397 | criteria = "safe-to-deploy" 1398 | user-id = 73222 # wasmtime-publish 1399 | start = "2023-01-01" 1400 | end = "2024-05-26" 1401 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1402 | 1403 | [[trusted.wasmtime-runtime]] 1404 | criteria = "safe-to-deploy" 1405 | user-id = 73222 # wasmtime-publish 1406 | start = "2023-01-01" 1407 | end = "2024-05-26" 1408 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1409 | 1410 | [[trusted.wasmtime-types]] 1411 | criteria = "safe-to-deploy" 1412 | user-id = 73222 # wasmtime-publish 1413 | start = "2023-01-01" 1414 | end = "2024-05-26" 1415 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1416 | 1417 | [[trusted.wasmtime-wasi]] 1418 | criteria = "safe-to-deploy" 1419 | user-id = 73222 # wasmtime-publish 1420 | start = "2023-01-01" 1421 | end = "2024-05-26" 1422 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1423 | 1424 | [[trusted.wiggle]] 1425 | criteria = "safe-to-deploy" 1426 | user-id = 73222 # wasmtime-publish 1427 | start = "2023-01-01" 1428 | end = "2024-05-26" 1429 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1430 | 1431 | [[trusted.wiggle-generate]] 1432 | criteria = "safe-to-deploy" 1433 | user-id = 73222 # wasmtime-publish 1434 | start = "2023-01-01" 1435 | end = "2024-05-26" 1436 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1437 | 1438 | [[trusted.wiggle-macro]] 1439 | criteria = "safe-to-deploy" 1440 | user-id = 73222 # wasmtime-publish 1441 | start = "2023-01-01" 1442 | end = "2024-05-26" 1443 | notes = "Maintained by Bytecode Alliance that we (Embark) are part of and we trust their review & release process on https://github.com/bytecodealliance/wasmtime" 1444 | -------------------------------------------------------------------------------- /guidelines.md: -------------------------------------------------------------------------------- 1 | [![Embark logo](media/embark-logo-bg.jpg)](http://embark.games) 2 | 3 | # Embark Rust development guidelines 4 | 5 | Guidelines and recommendations we use at [Embark](http://embark.games) for developing our [Rust 🦀](https://www.rust-lang.org/) projects. 6 | 7 | ## Guidelines 8 | 9 | This is not meant to be an exhaustive collection and resource of all best practices in Rust, that is best covered by the [Rust Book](https://doc.rust-lang.org/book/) and other references. Instead this is list of specific guidelines and recommendations that we've run into and want to highlight and standardize on within Embark. 10 | 11 | --- 12 | 13 | ### 001 - Run rustfmt on save 14 | 15 | __Motivation:__ We want to keep a consistent code base where we don't have to argue about style, so we use rustfmt on everything and verify on CI that it has been run. So highly recommend everyone to configure their editor to run rustfmt on save as it is more error prone to run it before commit. 16 | 17 | With VS Code this should be automatic for our repos, see [section](#visual-studio-code). 18 | 19 | --- 20 | 21 | ### 002 - Prefer synchronization primitives from [`parking_lot`](https://docs.rs/crate/parking_lot/0.7.1) instead of `std::sync` 22 | 23 | __Motivation:__ The `parking_lot` implementations are smaller, faster, and avoids poisioning errors which makes them more ergonomic and easier to use. 24 | 25 | Example old: 26 | 27 | ```rust 28 | use std::sync::{Mutex,RwLock}; 29 | let mutex = Mutex::new(1u32); 30 | *mutex.lock().unwrap() += 5; 31 | ``` 32 | 33 | Example new: 34 | 35 | ```rust 36 | use parking_lot::{Mutex,RwLock}; 37 | let mutex = Mutex::new(1u32); 38 | *mutex.lock() += 2; 39 | ``` 40 | 41 | __Todo:__ Would be great to automatically verify this through something like a custom clippy lint, or even better: have the `parking_lot` primitives eventually find their way into std. 42 | 43 | --- 44 | 45 | ### 003 - Opt-in for Clippy and Rust 2018 style warnings for every crate 46 | 47 | __Motivation:__ Keeps our code high quality and catches common errors and inefficiencies. We already verify on CI that clippy finds no warnings, and by opting in to warnings in every crate it also enables tools like RLS in VS Code to know that Clippy warnings 48 | 49 | Add this to the top of the main file (`lib.rs` or `bin.rs`) for all of our crates: 50 | 51 | ```rust 52 | #![warn(clippy::all)] 53 | #![warn(rust_2018_idioms)] 54 | ``` 55 | 56 | __Todo:__ Would be great if we could configure this globally for our workspace instead of for each crate (more error prone). [#22](https://github.com/EmbarkStudios/rust-ecosystem/issues/22). 57 | 58 | --- 59 | 60 | ## Development environments 61 | 62 | ### Visual Studio Code 63 | 64 | We primarily use [VS Code](https://code.visualstudio.com/) as development environment for Rust. 65 | 66 | Extensions: 67 | 68 | * Main: 69 | * [Rust analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) - language support for Rust 70 | * [Crates](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates) - easy Cargo.toml dependency version management 71 | * [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) - for debugging on Windows 72 | * [Native Debug](https://marketplace.visualstudio.com/items?itemName=webfreak.debug) - for debugging on Linux & Mac using GDB/LLDB 73 | * Other: 74 | * GitHub 75 | * GitHub Pull Requests 76 | * GitLens 77 | * Better TOML 78 | * markdownlint 79 | * Markdown Preview Github Styling 80 | * [Shader languages support for VS Code](https://marketplace.visualstudio.com/items?itemName=slevesque.shader) 81 | * [TODO Highlight](https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight) 82 | 83 | With VS Code this should be automatic for our repos, see as long as one has the Rust extension installed and our repo contains a `.vscode/settings.json` with: 84 | 85 | As we want to [run rustfmt on save](#001---run-rustfmt-on-save), all of our repos should have a `.vscode/settings.json` with: 86 | 87 | ```json 88 | { 89 | "editor.formatOnSave": true, 90 | } 91 | ``` 92 | -------------------------------------------------------------------------------- /lints.rs: -------------------------------------------------------------------------------- 1 | // BEGIN - Embark standard lints v6 for Rust 1.55+ 2 | // do not change or add/remove here, but one can add exceptions after this section 3 | // for more info see: 4 | #![deny(unsafe_code)] 5 | #![warn( 6 | clippy::all, 7 | clippy::await_holding_lock, 8 | clippy::char_lit_as_u8, 9 | clippy::checked_conversions, 10 | clippy::dbg_macro, 11 | clippy::debug_assert_with_mut_call, 12 | clippy::doc_markdown, 13 | clippy::empty_enum, 14 | clippy::enum_glob_use, 15 | clippy::exit, 16 | clippy::expl_impl_clone_on_copy, 17 | clippy::explicit_deref_methods, 18 | clippy::explicit_into_iter_loop, 19 | clippy::fallible_impl_from, 20 | clippy::filter_map_next, 21 | clippy::flat_map_option, 22 | clippy::float_cmp_const, 23 | clippy::fn_params_excessive_bools, 24 | clippy::from_iter_instead_of_collect, 25 | clippy::if_let_mutex, 26 | clippy::implicit_clone, 27 | clippy::imprecise_flops, 28 | clippy::inefficient_to_string, 29 | clippy::invalid_upcast_comparisons, 30 | clippy::large_digit_groups, 31 | clippy::large_stack_arrays, 32 | clippy::large_types_passed_by_value, 33 | clippy::let_unit_value, 34 | clippy::linkedlist, 35 | clippy::lossy_float_literal, 36 | clippy::macro_use_imports, 37 | clippy::manual_ok_or, 38 | clippy::map_err_ignore, 39 | clippy::map_flatten, 40 | clippy::map_unwrap_or, 41 | clippy::match_on_vec_items, 42 | clippy::match_same_arms, 43 | clippy::match_wild_err_arm, 44 | clippy::match_wildcard_for_single_variants, 45 | clippy::mem_forget, 46 | clippy::mismatched_target_os, 47 | clippy::missing_enforced_import_renames, 48 | clippy::mut_mut, 49 | clippy::mutex_integer, 50 | clippy::needless_borrow, 51 | clippy::needless_continue, 52 | clippy::needless_for_each, 53 | clippy::option_option, 54 | clippy::path_buf_push_overwrite, 55 | clippy::ptr_as_ptr, 56 | clippy::rc_mutex, 57 | clippy::ref_option_ref, 58 | clippy::rest_pat_in_fully_bound_structs, 59 | clippy::same_functions_in_if_condition, 60 | clippy::semicolon_if_nothing_returned, 61 | clippy::single_match_else, 62 | clippy::string_add_assign, 63 | clippy::string_add, 64 | clippy::string_lit_as_bytes, 65 | clippy::string_to_string, 66 | clippy::todo, 67 | clippy::trait_duplication_in_bounds, 68 | clippy::unimplemented, 69 | clippy::unnested_or_patterns, 70 | clippy::unused_self, 71 | clippy::useless_transmute, 72 | clippy::verbose_file_reads, 73 | clippy::zero_sized_map_values, 74 | future_incompatible, 75 | nonstandard_style, 76 | rust_2018_idioms 77 | )] 78 | // END - Embark standard lints v6 for Rust 1.55+ 79 | // crate-specific exceptions: 80 | #![allow()] 81 | -------------------------------------------------------------------------------- /lints.toml: -------------------------------------------------------------------------------- 1 | # add the below section to `.cargo/config.toml` 2 | 3 | [target.'cfg(all())'] 4 | rustflags = [ 5 | # BEGIN - Embark standard lints v6 for Rust 1.55+ 6 | # do not change or add/remove here, but one can add exceptions after this section 7 | # for more info see: 8 | "-Dunsafe_code", 9 | "-Wclippy::all", 10 | "-Wclippy::await_holding_lock", 11 | "-Wclippy::char_lit_as_u8", 12 | "-Wclippy::checked_conversions", 13 | "-Wclippy::dbg_macro", 14 | "-Wclippy::debug_assert_with_mut_call", 15 | "-Wclippy::doc_markdown", 16 | "-Wclippy::empty_enum", 17 | "-Wclippy::enum_glob_use", 18 | "-Wclippy::exit", 19 | "-Wclippy::expl_impl_clone_on_copy", 20 | "-Wclippy::explicit_deref_methods", 21 | "-Wclippy::explicit_into_iter_loop", 22 | "-Wclippy::fallible_impl_from", 23 | "-Wclippy::filter_map_next", 24 | "-Wclippy::flat_map_option", 25 | "-Wclippy::float_cmp_const", 26 | "-Wclippy::fn_params_excessive_bools", 27 | "-Wclippy::from_iter_instead_of_collect", 28 | "-Wclippy::if_let_mutex", 29 | "-Wclippy::implicit_clone", 30 | "-Wclippy::imprecise_flops", 31 | "-Wclippy::inefficient_to_string", 32 | "-Wclippy::invalid_upcast_comparisons", 33 | "-Wclippy::large_digit_groups", 34 | "-Wclippy::large_stack_arrays", 35 | "-Wclippy::large_types_passed_by_value", 36 | "-Wclippy::let_unit_value", 37 | "-Wclippy::linkedlist", 38 | "-Wclippy::lossy_float_literal", 39 | "-Wclippy::macro_use_imports", 40 | "-Wclippy::manual_ok_or", 41 | "-Wclippy::map_err_ignore", 42 | "-Wclippy::map_flatten", 43 | "-Wclippy::map_unwrap_or", 44 | "-Wclippy::match_on_vec_items", 45 | "-Wclippy::match_same_arms", 46 | "-Wclippy::match_wild_err_arm", 47 | "-Wclippy::match_wildcard_for_single_variants", 48 | "-Wclippy::mem_forget", 49 | "-Wclippy::mismatched_target_os", 50 | "-Wclippy::missing_enforced_import_renames", 51 | "-Wclippy::mut_mut", 52 | "-Wclippy::mutex_integer", 53 | "-Wclippy::needless_borrow", 54 | "-Wclippy::needless_continue", 55 | "-Wclippy::needless_for_each", 56 | "-Wclippy::option_option", 57 | "-Wclippy::path_buf_push_overwrite", 58 | "-Wclippy::ptr_as_ptr", 59 | "-Wclippy::rc_mutex", 60 | "-Wclippy::ref_option_ref", 61 | "-Wclippy::rest_pat_in_fully_bound_structs", 62 | "-Wclippy::same_functions_in_if_condition", 63 | "-Wclippy::semicolon_if_nothing_returned", 64 | "-Wclippy::single_match_else", 65 | "-Wclippy::string_add_assign", 66 | "-Wclippy::string_add", 67 | "-Wclippy::string_lit_as_bytes", 68 | "-Wclippy::string_to_string", 69 | "-Wclippy::todo", 70 | "-Wclippy::trait_duplication_in_bounds", 71 | "-Wclippy::unimplemented", 72 | "-Wclippy::unnested_or_patterns", 73 | "-Wclippy::unused_self", 74 | "-Wclippy::useless_transmute", 75 | "-Wclippy::verbose_file_reads", 76 | "-Wclippy::zero_sized_map_values", 77 | "-Wfuture_incompatible", 78 | "-Wnonstandard_style", 79 | "-Wrust_2018_idioms", 80 | # END - Embark standard lints v6 for Rust 1.55+ 81 | ] 82 | -------------------------------------------------------------------------------- /media/embark-logo-bg.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EmbarkStudios/rust-ecosystem/bc9f6c527108a8b79b74d44121aed574e7b5e526/media/embark-logo-bg.jpg --------------------------------------------------------------------------------