Repository: trailofbits/siderophile Branch: master Commit: 161b0239b35c Files: 33 Total size: 98.3 KB Directory structure: gitextract_3yon_1_h/ ├── .github/ │ ├── dependabot.yml │ └── workflows/ │ ├── ci.yml │ └── release.yml ├── .gitignore ├── .gitmodules ├── CARGO-GEIGER-LICENSE ├── CODEOWNERS ├── Cargo.toml ├── GEIGER-LICENSE ├── README.md ├── SIDEROPHILE-LICENSE ├── sample-badness.txt ├── src/ │ ├── callgraph_gen.rs │ ├── lib.rs │ ├── main.rs │ ├── mark_source.rs │ ├── trawl_source/ │ │ ├── ast_walker.rs │ │ └── mod.rs │ └── utils.rs └── tests/ ├── .gitignore ├── crate-uses-rust-toolchain/ │ ├── Cargo.toml │ └── src/ │ └── lib.rs ├── crate-uses-rust-toolchain_expected_badness.txt ├── gif_expected_badness.txt ├── inlining/ │ ├── Cargo.toml │ └── src/ │ └── main.rs ├── inlining_expected_badness.txt ├── librarycrate/ │ ├── Cargo.toml │ └── src/ │ └── lib.rs ├── librarycrate_expected_badness.txt ├── miniz_oxide_c_api_expected_badness.txt ├── run_tests.sh └── suffix_array_expected_badness.txt ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/dependabot.yml ================================================ version: 2 updates: - package-ecosystem: cargo directory: "/" schedule: interval: daily time: "10:00" open-pull-requests-limit: 10 - package-ecosystem: github-actions directory: / schedule: interval: daily open-pull-requests-limit: 99 rebase-strategy: "disabled" ================================================ FILE: .github/workflows/ci.yml ================================================ name: CI on: push: branches: - master pull_request: schedule: # run CI every day even if no PRs/merges occur - cron: "0 12 * * *" concurrency: group: ci-${{ github.ref }} cancel-in-progress: true jobs: lint: runs-on: ubuntu-latest steps: - name: Install LLVM run: | wget https://apt.llvm.org/llvm.sh chmod +x llvm.sh sudo ./llvm.sh 19 sudo apt install -y libpolly-19-dev - uses: actions/checkout@v6 - name: Format run: cargo fmt && git diff --exit-code - name: Lint run: cargo clippy - name: Cargo sort run: | cargo install cargo-sort cargo sort -c test: runs-on: ubuntu-latest steps: - name: Install LLVM run: | wget https://apt.llvm.org/llvm.sh chmod +x llvm.sh sudo ./llvm.sh 19 sudo apt install -y libpolly-19-dev - uses: actions/checkout@v6 with: submodules: recursive - name: Unit tests run: cargo test - name: Integration tests run: | cargo build --release cd tests ./run_tests.sh ================================================ FILE: .github/workflows/release.yml ================================================ on: release: types: - published name: release jobs: crate: runs-on: ubuntu-latest steps: - name: Install LLVM run: | wget https://apt.llvm.org/llvm.sh chmod +x llvm.sh sudo ./llvm.sh 17 sudo apt install -y libpolly-17-dev - uses: actions/checkout@v6 - name: login run: echo ${{ secrets.CRATES_IO_TOKEN }} | cargo login - name: publish run: cargo publish ================================================ FILE: .gitignore ================================================ # Siderophile related (mostly for tests) siderophile_out/ # Cargo/Rust related target/ **/*.rs.bk # Python related __pycache__ *.pyc # Others .DS_Store .idea ================================================ FILE: .gitmodules ================================================ [submodule "tests/gif"] path = tests/gif url = https://github.com/image-rs/image-gif.git [submodule "tests/miniz_oxide_c_api"] path = tests/miniz_oxide_c_api url = https://github.com/Frommi/miniz_oxide.git [submodule "tests/suffix_array"] path = tests/suffix_array url = https://github.com/hucsmn/suffix_array.git ================================================ FILE: CARGO-GEIGER-LICENSE ================================================ Copyright (c) 2018 Simon Heath Copyright (c) 2015-2016 Steven Fackler Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: CODEOWNERS ================================================ * @woodruffw ================================================ FILE: Cargo.toml ================================================ [package] name = "siderophile" version = "0.2.1" authors = [ "Michael Rosenberg ", "Claudia Richoux ", ] edition = "2021" license = "AGPL-3.0" description = "Find the ideal fuzz targets in a Rust codebase" repository = "https://github.com/trailofbits/siderophile" categories = ["command-line-utilities", "compilers"] keywords = ["cli", "llvm", "fuzzing", "security"] [package.metadata.release] dev-version = false publish = false # handled by GitHub Actions push = true [lib] name = "siderophile_callgraph" path = "src/lib.rs" [[bin]] name = "siderophile" path = "src/main.rs" [dependencies] anyhow = "1" cargo = "0.66.0" cargo-util = "0.2.4" env_logger = "0.11" glob = "0.3" llvm-ir = { version = "0.11.3", features = ["llvm-19"] } log = "0.4" quote = "1.0.29" regex = "1" rustc-demangle = "0.1" rustc_version = "0.4.0" structopt = "0.3" syn = { version = "2.0", features = ["full", "visit"] } tempfile = "3.6.0" walkdir = "2.5" ================================================ FILE: GEIGER-LICENSE ================================================ Copyright (c) 2018 Simon Heath Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README.md ================================================ # Siderophile [![CI](https://github.com/trailofbits/siderophile/actions/workflows/ci.yml/badge.svg)](https://github.com/trailofbits/siderophile/actions/workflows/ci.yml) [![Crates.io](https://img.shields.io/crates/v/siderophile)](https://crates.io/crates/siderophile) Siderophile finds the "most unsafe" functions in your Rust codebase, so you can fuzz them or refactor them out entirely. It checks the callgraph of each function in the codebase, estimates how many `unsafe` expressions are called in an evalutation of that function, then produces a list sorted by this value. Here's what Siderophile's output format looks like: ``` Badness Function 092 ::tempt_fate 064 ::defy_death [...] ``` "Badness" of a function is simply an approximation of how many unsafe expressions are evaluated during an evaluation of that function. For instance, marking unsafe functions with a `*`, suppose your function `f` calls functions `g*` and `h`. Furthermore, `h` calls `i*`. Then the badness of `f` is 2. Functions with high badness have a lot of opportunities to be memory unsafe. ## Installation Siderophile is [available via crates.io](https://crates.io/crates/siderophile), and can be installed with `cargo`: ```console cargo install siderophile ``` When you run that step, you *may* see an error from the `llvm-sys` crate: ```console error: No suitable version of LLVM was found system-wide or pointed to by LLVM_SYS_190_PREFIX. Consider using `llvmenv` to compile an appropriate copy of LLVM, and refer to the llvm-sys documentation for more information. llvm-sys: https://crates.io/crates/llvm-sys llvmenv: https://crates.io/crates/llvmenv error: could not compile `llvm-sys` due to previous error ``` This indicates that the build was unable to automatically find a copy of LLVM to link against. You can fix it by setting the `LLVM_SYS_190_PREFIX`. For example, for macOS with LLVM via Homebrew, you might do: ```console LLVM_SYS_190_PREFIX=$(brew --prefix)/opt/llvm@19/ cargo install siderophile ``` You _may_ run into other linker errors as well, e.g.: ``` = note: ld: library not found for -lzstd clang: error: linker command failed with exit code 1 (use -v to see invocation) ``` You can fix this by setting the `LIBRARY_PATH`. For example, for macOS with Homebrew: ```console LIBRARY_PATH=$(brew --prefix)/lib cargo install siderophile ``` To tie it all together: ```console LIBRARY_PATH=$(brew --prefix)/lib \ LLVM_SYS_190_PREFIX=$(brew --prefix)/opt/llvm@19/ cargo install siderophile ``` ### Building and installing from source Alternatively, if you'd like to build from source: ```console git clone https://github.com/trailofbits/siderophile && cd siderophile # TIP: include --release for a release build cargo build # optionally: install the built binary to cargo's default bin path cargo install --path . ``` You may need the same `LLVM_SYS_190_PATH` and `LIBRARY_PATH` overrides mentioned above. ## How to use Make sure that you followed the above steps, then do the following: 1. `cd` to the root directory of the crate you want to analyze 2. Run `siderophile --crate-name CRATENAME`, where `CRATENAME` is the name of the crate you want to analyze Functions are written to `stdout`, ordered by their badness. ## How it works Siderophile extends `cargo-geiger`, whose goal is to find unsafety at the crate-level. First, the callgraph is created by having `cargo` output the crate's bitcode, then parsing it to produce a callgraph and demangle the names into things that we can match with the source code. Next, Siderophile finds all the sources of the current crate, finds every Rust file in the sources, and parses each file individually using the `syn` crate. Each file is recursively combed through for unsafety occurring in functions, trait declarations, trait implementations, and submodules. Siderophile will output the path of these objects, along with an indication of what type of syntactic block they were found in. The list received from this step contains every unsafe block in every dependency of the crate, regardless of whether it's used. To narrow this down, Siderophile needs to compare its list to nodes in the callgraph of the crate. Using the callgraph produced in the first step, Siderophile checks which elements from the output are actually executed from the crate in question. This step (implemented in `src/callgraph_matching`) is not guaranteed to find everything, but it has shown good results against manual search. It is also not immune to false positives, although none have been found yet. The labels of the nodes that are found to be unsafe are used as input for the final step. The final step is to trace these unsafe nodes in the callgraph. For each node in the list, Siderophile will find every upstream node in the callgraph, and increment their badness by one, thus indicating that they use unsafety at some point in their execution. At the end of this process, all the nodes with nonzero badness are printed out, sorted in descending order by badness. ## Limitations Siderophile is _not_ guaranteed to catch all the unsafety in a crate's deps. Since things are only tagged at a source-level, Siderophile does not have the ability to inspect macros or resolve dynamically dispatched methods. Accordingly, this tool should not be used to "prove" that a crate contains no unsafety. ## Debugging To get debugging output from `siderophile`, set the `RUST_LOG` environment variable to `siderophile=XXX` where `XXX` can be `info`, `debug`, or `trace`. ## Thanks To [`cargo-geiger`](https://github.com/anderejd/cargo-geiger) and [`rust-praezi`](https://github.com/praezi/rust/) for current best practices. This project is mostly due to their work. ## License Siderophile is licensed and distributed under the AGPLv3 license. [Contact us](opensource@trailofbits.com) if you're looking for an exception to the terms. ================================================ FILE: SIDEROPHILE-LICENSE ================================================ Copyright (C) 2019 Trail of Bits Licensed under the GNU AGPL-3.0, copied below GNU AFFERO GENERAL PUBLIC LICENSE Version 3, 19 November 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU Affero General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Remote Network Interaction; Use with the GNU General Public License. Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . ================================================ FILE: sample-badness.txt ================================================ Badness Function 003 ::call 003 as actix_service::Service>::call 003 as futures::future::Future>::poll 003 ::call 003 as actix_service::Service>::call 003 as futures::future::Future>::poll 003 ::call 003 as actix_service::Service>::call 003 ::poll 002 as actix_service::Service>::poll_ready 002 ::drop 002 as actix_web::service::HttpServiceFactory>::register 002 as actix_web::service::ServiceFactory>::register 002 ::poll 002 ::poll 002 ::default 001 ::default 001 ::default 001 as actix_service::IntoNewService>::into_new_service 001 ::poll 001 ::new_service 001 ::drop 001 ::default 001 ::new_service 001 ::new_service 001 ::new_service 001 ::check ================================================ FILE: src/callgraph_gen.rs ================================================ use std::collections::HashMap; use std::collections::HashSet; use std::path::Path; use anyhow::{anyhow, Context}; use cargo::core::Workspace; use glob::glob; use llvm_ir::Name::Name; use llvm_ir::Operand::ConstantOperand; use llvm_ir::Terminator::CallBr; use llvm_ir::Terminator::Invoke; use llvm_ir::{instruction::Instruction, Module}; use regex::Regex; use rustc_demangle::demangle; use utils::LabelInfo; use crate::utils; // emit llvm IR. disable optimizations. just want debug info and call graph... #[allow(dead_code)] pub const RUSTFLAGS: &str = "-C lto=no -C opt-level=0 -C debuginfo=2 --emit=llvm-bc"; fn parse_ir_file(ir_path: &Path) -> anyhow::Result { // removes hex identifiers for short ids let re = Regex::new("(.*)::h[a-f0-9]{16}")?; let module = Module::from_bc_path(ir_path).map_err(|s| anyhow::anyhow!(s))?; let mut label_to_label_info: HashMap = HashMap::new(); let mut short_label_to_labels: HashMap> = HashMap::new(); for fun in module.functions { let dem_fun = demangle(&fun.name).to_string(); let short_fun = { let simplified = utils::simplify_trait_paths(&dem_fun.clone()); re.captures(&simplified) .map_or(simplified.clone(), |caps| caps[1].to_string()) }; short_label_to_labels .entry(short_fun.clone()) .or_default() .insert(dem_fun.clone()); let label_info = label_to_label_info.entry(dem_fun.clone()).or_default(); label_info.short_label = Some(short_fun); label_info.debugloc = fun.debugloc; // TODO: clean this up wow what a mess... for bb in fun.basic_blocks { for instr in bb.instrs { if let Instruction::Call(call) = instr { if let Some(ConstantOperand(op)) = call.function.right() { if let llvm_ir::constant::Constant::GlobalReference { name: Name(called_name), .. } = &*op { let dem_called = demangle(called_name).to_string(); label_to_label_info .entry(dem_called) .or_default() .caller_labels .insert(dem_fun.clone()); } } } } // TODO: something about this clone. prolly a match? if let Invoke(inv) = bb.term.clone() { if let Some(ConstantOperand(op)) = inv.function.right() { if let llvm_ir::constant::Constant::GlobalReference { name: Name(called_name), .. } = &*op { let dem_called = demangle(called_name).to_string(); label_to_label_info .entry(dem_called) .or_default() .caller_labels .insert(dem_fun.clone()); } } } if let CallBr(cbr) = bb.term { if let Some(ConstantOperand(op)) = cbr.function.right() { if let llvm_ir::constant::Constant::GlobalReference { name: Name(called_name), .. } = &*op { let dem_called = demangle(called_name).to_string(); label_to_label_info .entry(dem_called) .or_default() .caller_labels .insert(dem_fun.clone()); } } } } } Ok(utils::CallGraph { label_to_label_info, short_label_to_labels, }) } #[allow(clippy::missing_errors_doc)] pub fn gen_callgraph(ws: &Workspace, crate_name: &str) -> anyhow::Result { // find llvm IR file let mut file = ws.target_dir().into_path_unlocked(); file.push("debug"); file.push("deps"); file.push(format!("{}*.bc", str::replace(crate_name, "-", "_"))); let filestr = file .to_str() .ok_or_else(|| anyhow!("Failed to make file string for finding bytecode"))?; // TODO: error handle, test against other OS's let path = glob(filestr) .with_context(|| "Failed to read glob pattern")? .next() .ok_or_else(|| anyhow!("could not find bytecode file"))??; parse_ir_file(&path) } #[allow(clippy::missing_panics_doc, clippy::unwrap_used)] #[must_use] pub fn trace_unsafety( callgraph: &utils::CallGraph, crate_name: &str, tainted_function_names: &[String], ) -> HashMap { let mut tainted_function_labels = HashSet::new(); for t in tainted_function_names { let short_label = utils::simplify_trait_paths(t); if let Some(labels) = callgraph.short_label_to_labels.get(&short_label) { tainted_function_labels.extend(labels); } } let mut label_to_badness: HashMap = HashMap::new(); for tainted_function in tainted_function_labels { // traversal of the call graph from tainted node let mut queued_to_traverse: Vec = vec![tainted_function.to_string()]; let mut tainted_by: HashSet = HashSet::new(); tainted_by.insert(tainted_function.to_string()); while let Some(current_node) = queued_to_traverse.pop() { if let Some(label_info) = callgraph.label_to_label_info.get(¤t_node) { for caller_node in &label_info.caller_labels { if !tainted_by.contains(caller_node) { queued_to_traverse.push(caller_node.clone()); tainted_by.insert(caller_node.clone()); } } } } for tainted_by_node_id in &tainted_by { if let Some(label_info) = callgraph.label_to_label_info.get(tainted_by_node_id) { if let Some(shortlabel) = &label_info.short_label { label_to_badness .entry(shortlabel.to_string()) .and_modify(|e| e.0 += 1) .or_insert_with(|| (1, label_info.clone())); } } } } let mut ret_badness: HashMap = HashMap::new(); // To print this out, we have to dedup all the node labels, since multiple nodes can have the same label for (label, badness) in &label_to_badness { ret_badness .entry(utils::simplify_trait_paths(label)) .or_insert_with(|| (0, badness.1.clone())) .0 += badness.0; } // filter out any badness results that are not in the crate let re = Regex::new(&format!(r"^<*{}::", str::replace(crate_name, "-", "_"))).unwrap(); ret_badness.retain(|k, _| re.is_match(k)); ret_badness } ================================================ FILE: src/lib.rs ================================================ #![forbid(unsafe_code)] #![deny(clippy::unwrap_used, clippy::panic, clippy::expect_used, warnings)] #![deny(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)] mod callgraph_gen; mod utils; pub use callgraph_gen::{gen_callgraph, trace_unsafety}; pub use utils::{configure_rustup_toolchain, simplify_trait_paths, CallGraph}; ================================================ FILE: src/main.rs ================================================ #![forbid(unsafe_code)] #[macro_use] extern crate log; mod callgraph_gen; mod mark_source; mod trawl_source; mod utils; use std::collections::HashMap; use anyhow::{anyhow, bail}; use cargo::{ core::{Package, Workspace}, util::Filesystem, }; use structopt::{clap, StructOpt}; use tempfile::tempdir_in; #[derive(StructOpt, Debug)] #[structopt(setting = clap::AppSettings::DeriveDisplayOrder)] pub struct Args { #[structopt(long = "crate-name", value_name = "NAME")] /// Crate name (deprecated) crate_name: Option, #[structopt(long = "package", short = "p", value_name = "SPEC")] /// Package to be used as the root of the tree package: Option, #[structopt(long = "include-tests")] /// Count unsafe usage in tests. include_tests: bool, #[structopt(flatten)] mark_opts: mark_source::MarkOpts, } fn real_main(args: &Args) -> anyhow::Result> { let config = cargo::Config::default()?; let workspace_root = cargo::util::important_paths::find_root_manifest_for_wd(config.cwd())?; let ws = cargo::core::Workspace::new(&workspace_root, &config)?; let mut ws = if let Some(name) = &args.package { let package = find_package(&ws, name).ok_or_else(|| anyhow!("Could not find package `{}`", name))?; Workspace::ephemeral(package.clone(), &config, None, false)? } else { ws }; let tempdir = tempdir_in(config.cwd())?; ws.set_target_dir(Filesystem::new(tempdir.path().to_path_buf())); let crate_name = crate_name(&ws, &args.package)?; if let Some(deprecated_crate_name) = &args.crate_name { eprintln!("Warning: `--crate-name` is deprecated. Use `--package` instead."); if deprecated_crate_name != &crate_name { bail!( "Crate `{}` was specified, but crate `{}` was found", deprecated_crate_name, crate_name ); } } // new language, same horrible horrible hack. see PR#22 and related issues, this makes me sad.... utils::configure_rustup_toolchain(); // smoelius: `trawl_source::get_tainted` must be called before `callgraph_gen::gen_callgraph` // because `get_tainted` performs the build. let tainted = trawl_source::get_tainted(&config, &ws, &args.package, args.include_tests)?; let callgraph = callgraph_gen::gen_callgraph(&ws, &crate_name)?; Ok(callgraph_gen::trace_unsafety( &callgraph, &crate_name, &tainted, )) } fn find_package<'ws>(ws: &'ws Workspace, name: &str) -> Option<&'ws Package> { ws.members().find(|package| package.name() == name) } fn crate_name(ws: &Workspace, package: &Option) -> anyhow::Result { package.as_ref().cloned().map_or_else( || ws.current().map(|package| package.name().to_string()), Ok, ) } fn main() -> anyhow::Result<()> { env_logger::init(); let args = Args::from_args(); real_main(&args).and_then(|badness| { println!("Badness Function"); let mut badness_out_list: Vec<(&str, &u32)> = badness.iter().map(|(a, (b, _))| (a as &str, b)).collect(); badness_out_list.sort_by_key(|(a, b)| (u32::MAX - *b, *a)); for (label, badness) in badness_out_list { println!(" {badness:03} {label}"); } mark_source::mark_source(&args.mark_opts, &badness)?; Ok(()) }) } ================================================ FILE: src/mark_source.rs ================================================ use std::collections::HashMap; use std::fs::{copy, File}; use std::io::{BufRead, BufReader, LineWriter, Write}; use std::path::{Path, PathBuf}; use anyhow::{anyhow, Result}; use regex::Regex; use structopt::StructOpt; use tempfile::NamedTempFile; use crate::utils::LabelInfo; type BadnessMap = HashMap; #[derive(StructOpt, Debug)] pub struct MarkOpts { #[structopt(long = "mark", value_name = "TEXT")] /// Mark bad functions with TEXT mark: Option, #[structopt(long = "no-mark-closures")] /// Do not mark closures no_mark_closures: bool, #[structopt(long = "threshold", value_name = "BADNESS", default_value)] /// Minimum badness required to mark a function threshold: u32, } pub fn mark_source(opts: &MarkOpts, badness: &BadnessMap) -> Result<()> { let text = if let Some(text) = &opts.mark { text } else { return Ok(()); }; let grouped = group_by_path(badness); for entry in grouped { mark_path(opts, text, &entry.0, &entry.1)?; } Ok(()) } fn group_by_path(badness: &BadnessMap) -> HashMap { let mut grouped = HashMap::new(); for entry in badness { if let Some(debugloc) = &entry.1 .1.debugloc { let path = debugloc .directory .as_ref() .map_or(PathBuf::from(&debugloc.filename), |directory| { PathBuf::from(directory).join(&debugloc.filename) }); grouped .entry(path) .or_insert_with(HashMap::new) .insert(entry.0.clone(), entry.1.clone()); } } grouped } fn mark_path(opts: &MarkOpts, text: &str, path: &Path, badness: &BadnessMap) -> Result<()> { let line_numbers = extract_line_numbers(opts, badness); let source = File::open(path)?; let reader = BufReader::new(source); let tempfile = NamedTempFile::new()?; let mut writer = LineWriter::new(&tempfile); let spaces_pattern = Regex::new(r"^\s*")?; for (i, line) in reader.lines().enumerate() { let line = line?; if line_numbers.binary_search(&(i + 1)).is_ok() { let spaces = spaces_pattern .find(&line) .ok_or_else(|| anyhow!("Unexpected input"))? .as_str(); writeln!(writer, "{spaces}{text}")?; } writeln!(writer, "{line}")?; } drop(writer); copy(tempfile.path(), path)?; Ok(()) } fn extract_line_numbers(opts: &MarkOpts, badness: &BadnessMap) -> Vec { let mut line_numbers = badness .iter() .filter_map(|entry| { if (!opts.no_mark_closures || !entry.0.ends_with("{{closure}}")) && entry.1 .0 >= opts.threshold { entry .1 .1 .debugloc .as_ref() .map(|debugloc| debugloc.line as usize) } else { None } }) .collect::>(); line_numbers.sort_unstable(); line_numbers } ================================================ FILE: src/trawl_source/ast_walker.rs ================================================ #![forbid(unsafe_code)] use std::{ collections::VecDeque, error::Error, fmt, fs::File, io::{self, Read}, path::{Path, PathBuf}, string::FromUtf8Error, }; use quote::ToTokens; use syn::{ punctuated::Punctuated, visit, Expr, GenericArgument, ImplItemFn, ItemFn, ItemImpl, ItemMod, ItemTrait, PathArguments, TraitItemFn, }; /// A formatted list of Rust items that are unsafe pub struct UnsafeItems(pub(crate) Vec); #[allow(dead_code)] #[derive(Debug)] pub enum ScanFileError { Io(io::Error, PathBuf), Utf8(FromUtf8Error, PathBuf), Syn(syn::Error, PathBuf), } impl Error for ScanFileError {} /// Forward Display to Debug. See the crate root documentation. impl fmt::Display for ScanFileError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self, f) } } struct SiderophileSynVisitor { /// Where we log all the findings buf: Vec, /// Keeps track of what the current module path is (this includes trait defs and impls) cur_mod_path: VecDeque, /// Count unsafe usage inside tests include_tests: bool, } impl SiderophileSynVisitor { fn new(prefix: String, include_tests: bool) -> Self { let mut cur_mod_path = VecDeque::new(); cur_mod_path.push_back(prefix); let buf = Vec::new(); Self { buf, cur_mod_path, include_tests, } } } /// Will return true for #[cfg(test)] decorated modules. /// /// This function is a somewhat of a hack and will probably misinterpret more /// advanced cfg expressions. A better way to do this would be to let rustc emit /// every single source file path and span within each source file and use that /// as a general filter for included code. /// TODO: Investigate if the needed information can be emitted by rustc today. fn is_test_mod(i: &ItemMod) -> bool { i.attrs .iter() .filter(|attr| attr.path().is_ident("cfg")) .any(|attr| { attr.parse_nested_meta(|meta| { if meta.path.is_ident("test") { Ok(()) } else { // We drop this error anyways. Err(meta.error("Expected `cfg(test)`")) } }) .is_ok() }) } fn is_test_fn(i: &ItemFn) -> bool { i.attrs.iter().any(|attr| attr.path().is_ident("test")) } impl<'ast> visit::Visit<'ast> for SiderophileSynVisitor { fn visit_file(&mut self, i: &'ast syn::File) { syn::visit::visit_file(self, i); } /// Free-standing functions fn visit_item_fn(&mut self, i: &ItemFn) { // Exclude #[test] functions if not explicitly allowed if !self.include_tests && is_test_fn(i) { return; } self.cur_mod_path.push_back(i.sig.ident.to_string()); // See if this function is marked unsafe if i.sig.unsafety.is_some() { let pp = fmt_mod_path(&self.cur_mod_path); self.buf.push(pp); } trace!("entering function {:?}", i.sig.ident); visit::visit_item_fn(self, i); self.cur_mod_path.pop_back(); } fn visit_expr(&mut self, i: &Expr) { match i { Expr::Unsafe(i) => { let pp = fmt_mod_path(&self.cur_mod_path); self.buf.push(pp); visit::visit_expr_unsafe(self, i); } Expr::Closure(expr_closure) => { self.cur_mod_path.push_back("{{closure}}".to_string()); visit::visit_expr_closure(self, expr_closure); self.cur_mod_path.pop_back(); } Expr::Path(_) | Expr::Lit(_) => { // Do not count. The expression `f(x)` should count as one // expression, not three. } other => { visit::visit_expr(self, other); } } } fn visit_item_mod(&mut self, i: &ItemMod) { if !self.include_tests && is_test_mod(i) { return; } self.cur_mod_path.push_back(i.ident.to_string()); visit::visit_item_mod(self, i); self.cur_mod_path.pop_back(); } fn visit_item_impl(&mut self, i: &ItemImpl) { // unsafe trait impl's if let syn::Type::Path(ref for_path) = &*i.self_ty { let for_path = fmt_syn_path(for_path.path.clone()); if let Some((_, ref trait_path, _)) = i.trait_ { let trait_path = fmt_syn_path(trait_path.clone()); // Save the old path. We heavily modify the path for trait impls let old_cur_mod_path = self.cur_mod_path.clone(); // We want a trait impl to look like // ` as UncheckedOptionExt>::unchecked_unwrap` self.cur_mod_path.push_back(for_path); let fmt_cur_mod_path = fmt_mod_path(&self.cur_mod_path); let full_impl_path = format!("<{fmt_cur_mod_path} as {trait_path}>"); trace!("entering trait impl {}", trait_path); // The new path is just one component long, the whole thing in angled brackets self.cur_mod_path.clear(); self.cur_mod_path.push_back(full_impl_path); // Recurse visit::visit_item_impl(self, i); // Restore the old path self.cur_mod_path = old_cur_mod_path; trace!("exiting trait impl {}", trait_path); } else { // Regular impls look like `parking_lot::raw_mutex::RawMutex::unlock_slow` trace!("entering impl {}", for_path); self.cur_mod_path.push_back(for_path.clone()); visit::visit_item_impl(self, i); self.cur_mod_path.pop_back(); trace!("exiting impl {}", for_path); } } else { // I don't know what this case represents visit::visit_item_impl(self, i); } } fn visit_item_trait(&mut self, i: &ItemTrait) { // Unsafe traits self.cur_mod_path.push_back(i.ident.to_string()); visit::visit_item_trait(self, i); self.cur_mod_path.pop_back(); } fn visit_trait_item_fn(&mut self, i: &TraitItemFn) { // Unsafe default-implemented trait methods self.cur_mod_path.push_back(i.sig.ident.to_string()); visit::visit_trait_item_fn(self, i); self.cur_mod_path.pop_back(); } fn visit_impl_item_fn(&mut self, i: &ImplItemFn) { self.cur_mod_path.push_back(i.sig.ident.to_string()); // See if this method is unsafe if i.sig.unsafety.is_some() { let pp = fmt_mod_path(&self.cur_mod_path); self.buf.push(pp); } trace!("entering method {:?}", i.sig.ident); visit::visit_impl_item_fn(self, i); self.cur_mod_path.pop_back(); } } // LLVM callgraphs don't have lifetimes, so neither do we. This removes the 'a in things like // as DerefMut>::deref_mut fn without_lifetimes(mut path: syn::Path) -> syn::Path { for seg in path.segments.iter_mut() { if let PathArguments::AngleBracketed(ref mut generic_args) = seg.arguments { // First remove all the lifetime arguments from this path let non_lifetime_args = generic_args .args .iter() .filter(|a| !matches!(a, GenericArgument::Lifetime(_))); // Now go into every type in the generic arguments and remove their lifetimes too. This // handles examples like >>::from let stripped_args = non_lifetime_args.cloned().map(|a| { if let GenericArgument::Type(syn::Type::Path(mut ty_path)) = a { // Recurse into the path in the type parameter of the given path let stripped_path = without_lifetimes(ty_path.path); ty_path.path = stripped_path; GenericArgument::Type(syn::Type::Path(ty_path)) } else { a } }); generic_args.args = stripped_args.collect::>(); // Check if the new arglist is empty. If it is, remove the arglist, otherwise we get // things like http::header::name::HdrName<> if generic_args.args.is_empty() { seg.arguments = PathArguments::None; } } } path } // Formats a Rust path represented by a syn::Path object fn fmt_syn_path(path: syn::Path) -> String { let stripped_path = without_lifetimes(path); let token_trees = stripped_path.into_token_stream().into_iter(); let fmt_components: Vec = token_trees.map(|t| format!("{t}")).collect(); fmt_components.join("") } // Formats a module path represented by an ordered list of path components fn fmt_mod_path(mod_path: &VecDeque) -> String { let submods = mod_path.iter().cloned().collect::>(); submods.as_slice().join("::") } /// Scan a single file for `unsafe` usage. #[allow(clippy::unwrap_used)] pub fn find_unsafe_in_file( crate_name: &str, file_to_scan: &Path, include_tests: bool, ) -> Result { use syn::visit::Visit; trace!("in crate {}", crate_name); trace!("in file {:?}", file_to_scan); let src = std::ffi::OsString::from("src"); let src_cpt = std::path::Component::Normal(&src); // Get the module path of the file we're in right now let prefix_module_path = if file_to_scan.components().any(|c| c == src_cpt) { let mut mods: Vec = file_to_scan .components() .rev() .take_while(|c| c != &src_cpt) .map(|c| c.as_os_str().to_os_string().into_string().unwrap()) .map(|c| c.replace('-', "_")) .filter(|c| c != "lib.rs" && c != "mod.rs") .map(|mut c| { if let Some(i) = c.find('.') { c.truncate(i); } c }) .collect(); mods.reverse(); mods.join("::") } else { String::new() }; // This looks like `parking_lot_core::thread_parker::unix` let full_prefix = if prefix_module_path.is_empty() { crate_name.to_string() } else { [crate_name, &prefix_module_path].join("::") }; let mut in_file = File::open(file_to_scan).map_err(|e| ScanFileError::Io(e, file_to_scan.to_path_buf()))?; let mut src = vec![]; in_file .read_to_end(&mut src) .map_err(|e| ScanFileError::Io(e, file_to_scan.to_path_buf()))?; let src = String::from_utf8(src).map_err(|e| ScanFileError::Utf8(e, file_to_scan.to_path_buf()))?; let syntax = syn::parse_file(&src).map_err(|e| ScanFileError::Syn(e, file_to_scan.to_path_buf()))?; let mut vis = SiderophileSynVisitor::new(full_prefix, include_tests); vis.visit_file(&syntax); Ok(UnsafeItems(vis.buf)) } ================================================ FILE: src/trawl_source/mod.rs ================================================ mod ast_walker; use std::{ collections::{HashMap, HashSet}, env::set_var, ffi::OsString, io, path::{Path, PathBuf}, sync::{Arc, Mutex}, }; use anyhow::{anyhow, Context}; use cargo::{ core::{ compiler::{CompileMode, Executor, Unit}, manifest::TargetKind, package::PackageSet, Package, PackageId, Target, Workspace, }, ops::CompileOptions, util::CargoResult, }; use cargo_util::{paths, ProcessBuilder}; use walkdir::{self, WalkDir}; #[allow(dead_code)] #[derive(Debug)] pub enum RsResolveError { Walkdir(walkdir::Error), /// Like io::Error but with the related path. Io(io::Error, PathBuf), /// Would like cargo::Error here, but it's private, why? /// This is still way better than a panic though. Cargo(String), /// This should not happen unless incorrect assumptions have been made in /// `siderophile` about how the cargo API works. ArcUnwrap(), /// Failed to get the inner context out of the mutex. InnerContextMutex(String), /// Failed to parse a .dep file. DepParse(String, PathBuf), } impl Error for RsResolveError {} /// Forward Display to Debug. impl fmt::Display for RsResolveError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self, f) } } impl From> for RsResolveError { fn from(e: PoisonError) -> Self { Self::InnerContextMutex(e.to_string()) } } fn is_file_with_ext(entry: &walkdir::DirEntry, file_ext: &str) -> bool { if !entry.file_type().is_file() { return false; } let p = entry.path(); let ext = match p.extension() { Some(e) => e, None => return false, }; // to_string_lossy is ok since we only want to match against an ASCII // compatible extension and we do not keep the possibly lossy result // around. ext.to_string_lossy() == file_ext } // TODO: Make a wrapper type for canonical paths and hide all mutable access. /// Provides information needed to scan for crate root /// `#![forbid(unsafe_code)]`. /// The wrapped `PathBuf`s are canonicalized. enum RsFile { /// Library entry point source file, usually src/lib.rs LibRoot(PathBuf), /// Executable entry point source file, usually src/main.rs BinRoot(PathBuf), /// Not sure if this is relevant but let's be conservative for now. CustomBuildRoot(PathBuf), /// All other .rs files. Other(PathBuf), } impl RsFile { const fn as_path_buf(&self) -> &PathBuf { match self { Self::LibRoot(ref pb) | Self::BinRoot(ref pb) | Self::CustomBuildRoot(ref pb) | Self::Other(ref pb) => pb, } } } #[allow(clippy::expect_used)] pub fn find_rs_files_in_dir(dir: &Path) -> impl Iterator { let walker = WalkDir::new(dir).into_iter(); walker.filter_map(|entry| { let entry = entry.expect("walkdir error."); // TODO: Return result. if !is_file_with_ext(&entry, "rs") { return None; } Some( entry .path() .canonicalize() .expect("Error converting to canonical path"), ) // TODO: Return result. }) } #[allow(clippy::expect_used, clippy::unwrap_used)] fn find_rs_files_in_package(pack: &Package) -> Vec { // Find all build target entry point source files. let mut canon_targets = HashMap::new(); for t in pack.targets() { let path = match t.src_path().path() { Some(p) => p, None => continue, }; if !path.exists() { // A package published to crates.io is not required to include // everything. We have to skip this build target. continue; } let canon = path .canonicalize() // will Err on non-existing paths. .expect("canonicalize for build target path failed."); // FIXME let targets = canon_targets.entry(canon).or_insert_with(Vec::new); targets.push(t); } let mut out = Vec::new(); for p in find_rs_files_in_dir(pack.root()) { if !canon_targets.contains_key(&p) { out.push(RsFile::Other(p)); } } for (k, v) in canon_targets { for target in v { out.push(into_rs_code_file(target.kind(), k.clone())); } } out } const fn into_rs_code_file(kind: &TargetKind, path: PathBuf) -> RsFile { match kind { TargetKind::Lib(_) => RsFile::LibRoot(path), TargetKind::Bin => RsFile::BinRoot(path), TargetKind::Test | TargetKind::Bench | TargetKind::ExampleLib(_) | TargetKind::ExampleBin => RsFile::Other(path), TargetKind::CustomBuild => RsFile::CustomBuildRoot(path), } } fn find_rs_files_in_packages<'a>( packs: &'a [&Package], ) -> impl Iterator + 'a { packs.iter().flat_map(|pack| { find_rs_files_in_package(pack) .into_iter() .map(move |path| (pack.package_id(), path)) }) } /// This is mostly `PackageSet::get_many`. The only difference is that we don't panic when /// downloads fail #[allow(clippy::unwrap_used)] fn get_many<'a>( packs: &'a PackageSet, ids: impl IntoIterator, ) -> Vec<&'a Package> { let mut pkgs = Vec::new(); let mut downloads = packs.enable_download().unwrap(); for id in ids { match downloads.start(id) { // This might not return `Some` right away. It's still downloading. Ok(pkg_opt) => pkgs.extend(pkg_opt), Err(e) => warn!("Could not begin downloading {:?}, {:?}", id, e), } } while downloads.remaining() > 0 { // Packages whose `.start()` returned an `Ok(None)` earlier will return now match downloads.wait() { Ok(pkg) => pkgs.push(pkg), Err(e) => warn!("Failed to download package, {:?}", e), } } pkgs } /// Finds and outputs all unsafe things to the given file #[allow(clippy::panic)] pub fn find_unsafe_in_packages( packs: &PackageSet, mut rs_files_used: HashMap, allow_partial_results: bool, include_tests: bool, ) -> (HashMap, Vec) { let packs = get_many(packs, packs.package_ids()); let pack_code_files = find_rs_files_in_packages(&packs); let mut tainted_things = vec![]; for (pack_id, rs_code_file) in pack_code_files { let p = rs_code_file.as_path_buf(); // This .rs file path was found by intercepting rustc arguments or by parsing the .d files // produced by rustc. Here we increase the counter for this path to mark that this file has // been scanned. Warnings will be printed for .rs files in this collection with a count of // 0 (has not been scanned). If this happens, it could indicate a logic error or some // incorrect assumption in siderophile. if let Some(c) = rs_files_used.get_mut(p) { *c += 1; } let crate_name = pack_id.name().as_str().replace('-', "_"); match ast_walker::find_unsafe_in_file(&crate_name, p, include_tests) { Ok(ast_walker::UnsafeItems(items)) => { // Output unsafe items as we go tainted_things.extend(items); } Err(e) => { if allow_partial_results { warn!( "Failed to parse file: {}, {:?}. Continuing...", p.display(), e ); } else { panic!("Failed to parse file: {}, {:?} ", p.display(), e); } } } } (rs_files_used, tainted_things) } /// Trigger a `cargo build` and listen to the cargo/rustc communication to /// figure out which source files were used by the build. pub fn resolve_rs_file_deps( copt: &CompileOptions, ws: &Workspace, ) -> anyhow::Result> { let config = ws.config(); set_var("RUSTFLAGS", crate::callgraph_gen::RUSTFLAGS); let inner_arc = Arc::new(Mutex::new(CustomExecutorInnerContext::default())); { let cust_exec = CustomExecutor { cwd: config.cwd().to_path_buf(), inner_ctx: inner_arc.clone(), }; let exec: Arc = Arc::new(cust_exec); cargo::ops::compile_with_exec(ws, copt, &exec) .map_err(|e| RsResolveError::Cargo(e.to_string())) .with_context(|| "`compile_with_exec` failed")?; } let ws_root = ws.root().to_path_buf(); let inner_mutex = Arc::try_unwrap(inner_arc).map_err(|_| RsResolveError::ArcUnwrap())?; let (rs_files, out_dir_args) = { let ctx = inner_mutex.into_inner()?; (ctx.rs_file_args, ctx.out_dir_args) }; let mut hm = HashMap::::new(); for out_dir in out_dir_args { // TODO: Figure out if the `.d` dep files are used by one or more rustc // calls. It could be useful to know which `.d` dep files belong to // which rustc call. That would allow associating each `.rs` file found // in each dep file with a PackageId. for ent in WalkDir::new(&out_dir) { let ent = ent.map_err(RsResolveError::Walkdir)?; if !is_file_with_ext(&ent, "d") { continue; } let deps = parse_rustc_dep_info(ent.path()) .map_err(|e| RsResolveError::DepParse(e.to_string(), ent.path().to_path_buf()))?; let canon_paths = deps .into_iter() .flat_map(|t| t.1) .map(PathBuf::from) .map(|pb| ws_root.join(pb)) .map(|pb| pb.canonicalize().map_err(|e| RsResolveError::Io(e, pb))); for p in canon_paths { hm.insert(p?, 0); } } } for pb in rs_files { // rs_files must already be canonicalized hm.insert(pb, 0); } Ok(hm) } /// Copy-pasted (almost) from the private module `cargo::core::compiler::fingerprint`. /// /// TODO: Make a PR to the cargo project to expose this function or to expose /// the dependency data in some other way. fn parse_rustc_dep_info(rustc_dep_info: &Path) -> CargoResult)>> { let contents = paths::read(rustc_dep_info)?; contents .lines() .filter_map(|l| l.find(": ").map(|i| (l, i))) .map(|(line, pos)| { let target = &line[..pos]; let mut deps = line[pos + 2..].split_whitespace(); let mut ret = Vec::new(); while let Some(s) = deps.next() { let mut file = s.to_string(); while file.ends_with('\\') { file.pop(); file.push(' '); //file.push_str(deps.next().ok_or_else(|| { //internal("malformed dep-info format, trailing \\".to_string()) //})?); file.push_str( deps.next() .ok_or_else(|| anyhow!("malformed dep-info format, trailing \\"))?, ); } ret.push(file); } Ok((target.to_string(), ret)) }) .collect() } #[derive(Debug, Default)] struct CustomExecutorInnerContext { /// Stores all lib.rs, main.rs etc. passed to rustc during the build. rs_file_args: HashSet, /// Investigate if this needs to be intercepted like this or if it can be /// looked up in a nicer way. out_dir_args: HashSet, } use std::sync::PoisonError; /// A cargo Executor to intercept all build tasks and store all ".rs" file /// paths for later scanning. /// /// TODO: This is the place(?) to make rustc perform macro expansion to allow /// scanning of the the expanded code. (incl. code generated by build.rs). /// Seems to require nightly rust. #[derive(Debug)] struct CustomExecutor { /// Current work dir cwd: PathBuf, /// Needed since multiple rustc calls can be in flight at the same time. inner_ctx: Arc>, } use std::error::Error; use std::fmt; #[allow(dead_code)] #[derive(Debug)] enum CustomExecutorError { OutDirKeyMissing(String), OutDirValueMissing(String), InnerContextMutex(String), Io(io::Error, PathBuf), } impl Error for CustomExecutorError {} /// Forward Display to Debug. See the crate root documentation. impl fmt::Display for CustomExecutorError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Debug::fmt(self, f) } } impl Executor for CustomExecutor { /// In case of an `Err`, Cargo will not continue with the build process for /// this package. /// TODO: add doing things with `on_stdout_line` and `on_stderr_line` #[allow(clippy::case_sensitive_file_extension_comparisons)] fn exec( &self, command: &ProcessBuilder, _id: PackageId, _target: &Target, _mode: CompileMode, _on_stdout_line: &mut dyn FnMut(&str) -> CargoResult<()>, _on_stderr_line: &mut dyn FnMut(&str) -> CargoResult<()>, ) -> CargoResult<()> { let args: Vec<_> = command.get_args().collect(); let out_dir_key = OsString::from("--out-dir"); let out_dir_key_idx = args .iter() .position(|s| *s == &out_dir_key) .ok_or_else(|| CustomExecutorError::OutDirKeyMissing(command.to_string()))?; let out_dir = args .get(out_dir_key_idx + 1) .ok_or_else(|| CustomExecutorError::OutDirValueMissing(command.to_string())) .map(PathBuf::from)?; // This can be different from the cwd used to launch the wrapping cargo // plugin. Discovered while fixing // https://github.com/anderejd/cargo-geiger/issues/19 let cwd = command .get_cwd() .map_or_else(|| self.cwd.clone(), PathBuf::from); { // Scope to drop and release the mutex before calling rustc. let mut ctx = self .inner_ctx .lock() .map_err(|e| CustomExecutorError::InnerContextMutex(e.to_string()))?; for tuple in args .iter() .map(|s| (s, s.to_string_lossy().to_lowercase())) .filter(|t| t.1.ends_with(".rs")) { let raw_path = cwd.join(tuple.0); let p = raw_path .canonicalize() .map_err(|e| CustomExecutorError::Io(e, raw_path))?; ctx.rs_file_args.insert(p); } ctx.out_dir_args.insert(out_dir); } command.exec()?; Ok(()) } /// Queried when queuing each unit of work. If it returns true, then the /// unit will always be rebuilt, independent of whether it needs to be. fn force_rebuild(&self, _unit: &Unit) -> bool { true // Overriding the default to force all units to be processed. } } pub fn get_tainted( config: &cargo::Config, workspace: &cargo::core::Workspace, _package: &Option, include_tests: bool, ) -> anyhow::Result> { let (packages, _resolve) = cargo::ops::resolve_ws(workspace)?; let copt = CompileOptions::new(config, CompileMode::Build)?; let rs_files_used_in_compilation = resolve_rs_file_deps(&copt, workspace)?; let allow_partial_results = true; let (rs_files_scanned, tainted_things) = find_unsafe_in_packages( &packages, rs_files_used_in_compilation, allow_partial_results, include_tests, ); rs_files_scanned .iter() .filter(|(_k, v)| **v == 0) .for_each(|(k, _v)| { // TODO: Ivestigate if this is related to code generated by build // scripts and/or macros. Some of the warnings of this kind is // printed for files somewhere under the "target" directory. // TODO: Find out if we can lookup PackageId associated with each // `.rs` file used by the build, including the file paths extracted // from `.d` dep files. warn!("Dependency file was never scanned: {}", k.display()); }); Ok(tainted_things) } ================================================ FILE: src/utils.rs ================================================ use std::collections::{HashMap, HashSet}; use std::env; use std::process::Command; // This funciton takes a Rust module path like // `::as_fail and strips` // down the fully-qualified trait paths within to just the base trait name, like // `::as_fail` fn get_base_trait_name(after_as: &str) -> Option { //Read until the first ">" character, which marks the end of the trait path. We do not modify *rest let mut parts = after_as.split('>'); let path = parts.next()?; let mut rest: Vec<&str> = parts.collect(); // This is the "AsFail" in the example let basename: &str = path.split("::").collect::>().last()?; rest.insert(0, basename); Some(rest.join(">")) } #[allow(clippy::missing_panics_doc, clippy::unwrap_used)] #[must_use] pub fn simplify_trait_paths(path: &str) -> String { let parts: Vec<&str> = path.split(" as ").collect(); if parts.len() == 1 { path.to_string() } else { parts.into_iter() .enumerate() .map(|(i, after_as)| //Every other segment here is what comes before the " as ", which we do not modify. //So just append it to the list and move on if i % 2 == 0 {after_as.to_string()} else { get_base_trait_name(after_as).unwrap() } ) .collect::>() // Surgery complete. Stitch it all back up. .join(" as ") } } #[cfg(test)] mod tests { use crate::utils::simplify_trait_paths; #[test] fn test_1() { assert_eq!(simplify_trait_paths("<&mut std::collections::hash::table::RawTable as std::collections::hash::table::Put>::borrow_table_mut"), "<&mut std::collections::hash::table::RawTable as Put>::borrow_table_mut"); } #[test] fn test_2() { assert_eq!( simplify_trait_paths(" as core::ops::deref::Deref>::deref"), " as Deref>::deref" ); } #[test] fn test_3() { assert_eq!(simplify_trait_paths("::default_instance"), "::default_instance"); } #[test] fn test_4() { assert_eq!( simplify_trait_paths("::as_fail"), "::as_fail" ); } } #[derive(Clone, Default)] pub struct LabelInfo { pub short_label: Option, pub caller_labels: HashSet, pub debugloc: Option, } pub struct CallGraph { pub label_to_label_info: HashMap, pub short_label_to_labels: HashMap>, } #[allow(clippy::missing_panics_doc, clippy::expect_used, clippy::unwrap_used)] pub fn configure_rustup_toolchain() { let rsup_default = Command::new("rustup") .args(["show", "active-toolchain"]) .output() .expect("failed to run rustup to configure toolchain"); let utf8_toolchain = std::str::from_utf8(&rsup_default.stdout) .unwrap() .split_once(' ') .unwrap() .0; env::set_var("RUSTUP_TOOLCHAIN", utf8_toolchain); let rustc_version = rustc_version::version_meta().unwrap(); let rustc_llvm_version = rustc_version.llvm_version.unwrap(); assert_eq!( llvm_ir::llvm_version(), rustc_llvm_version.major.to_string(), "Siderophile was configured to use LLVM {}, but the default rustc emits LLVM {}.", llvm_ir::llvm_version(), rustc_llvm_version.major, ); } ================================================ FILE: tests/.gitignore ================================================ /output_badness.txt ================================================ FILE: tests/crate-uses-rust-toolchain/Cargo.toml ================================================ [package] name = "crate-uses-rust-toolchain" version = "0.1.0" authors = ["disconnect3d "] edition = "2018" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] bitvec = "0.15.2" ================================================ FILE: tests/crate-uses-rust-toolchain/src/lib.rs ================================================ // This program tests if we can use Siderophile with crates which dependencies // use the `rust-toolchain` file // (https://doc.rust-lang.org/stable/edition-guide/rust-2018/rustup-for-managing-rust-versions.html#managing-versions) // so it effectively tests if https://github.com/trailofbits/siderophile/issues/14 is fixed/handled // properly // // NOTE: It explicitly requires bitvec 0.15.2 as this version uses the `rust-toolchain` file. //// //// Below is an example output what happens when Siderophle is run on a crate that has //// `rust-toolchain` file. //// /* trawling source code of dependencies for unsafety Checking bitvec v0.15.2 Checking crate-uses-rust-toolchain v0.1.0 (/Users/dc/tob/projects/siderophile/tests/crate-use-rust-toolchain) error[E0463]: can't find crate for `bitvec` ] 1/2: crate-uses-rust-toolchain --> src/lib.rs:9:1 | 9 | extern crate bitvec; | ^^^^^^^^^^^^^^^^^^^^ can't find crate error: aborting due to previous error For more information about this error, try `rustc --explain E0463`. thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Cargo("Could not compile `crate-uses-rust-toolchain`.")', src/libcore/result.rs:1187:5 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace. */ extern crate bitvec; use bitvec::prelude::*; pub fn foo() { let bv = bitvec![BigEndian, u8; 0, 1, 0, 1]; println!("bv={:?}", bv); } ================================================ FILE: tests/crate-uses-rust-toolchain_expected_badness.txt ================================================ Badness Function 017 crate_uses_rust_toolchain::foo ================================================ FILE: tests/gif_expected_badness.txt ================================================ Badness Function 004 gif::reader::decoder::StreamingDecoder::update 003 gif::reader::decoder::StreamingDecoder::next_state 001 gif::common::Block::from_u8 001 gif::common::DisposalMethod::from_u8 001 gif::common::Extension::from_u8 ================================================ FILE: tests/inlining/Cargo.toml ================================================ [package] name = "inlining" version = "0.1.0" authors = ["disconnect3d "] edition = "2018" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] byteorder = "1.3.2" ================================================ FILE: tests/inlining/src/main.rs ================================================ // This test is there to check if Siderophile can properly taint and detect // unsafe calls when a given unsafe function can be inlined. // It also validates if Siderophile works on binary crates. // // This issue was mitigated in https://github.com/trailofbits/siderophile/pull/17/files#r352878953 PR // by removing the `-C inline-threshold=9999` flag from building Siderophile // // use std::io::Cursor; use byteorder::{BigEndian, ReadBytesExt}; pub fn main() { let v = vec![1, 2, 3, 4, 5, 6, 7, 8]; foobar(v); } pub fn foobar(v: Vec) { let mut rdr = Cursor::new(v); assert_eq!(0.01, rdr.read_f64::().unwrap()); } ================================================ FILE: tests/inlining_expected_badness.txt ================================================ Badness Function 001 inlining::foobar 001 inlining::main ================================================ FILE: tests/librarycrate/Cargo.toml ================================================ [package] name = "librarycrate" version = "0.1.0" authors = ["disconnect3d "] edition = "2018" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] byteorder = "1.3.2" ================================================ FILE: tests/librarycrate/src/lib.rs ================================================ // This test checks if Siderophile works fine on library crates. // use std::io::Cursor; use byteorder::{BigEndian, ReadBytesExt}; pub fn func() { let v = vec![1, 2, 3, 4, 5, 6, 7, 8]; foobar(v); } pub fn foobar(v: Vec) { let mut rdr = Cursor::new(v); assert_eq!(0.01, rdr.read_f64::().unwrap()); } ================================================ FILE: tests/librarycrate_expected_badness.txt ================================================ Badness Function 001 librarycrate::foobar 001 librarycrate::func ================================================ FILE: tests/miniz_oxide_c_api_expected_badness.txt ================================================ Badness Function 001 miniz_oxide_c_api::tdef::output_buffer_putter ================================================ FILE: tests/run_tests.sh ================================================ #!/bin/bash set -euo pipefail # smoelius: This script must be run from the `tests` subdirectory. TESTS=($(find . -type d -mindepth 1 -maxdepth 1 | cut -f2 -d/)) # https://stackoverflow.com/questions/5947742/how-to-change-the-output-color-of-printf-in-linux INFO='\033[1;33m' # Yellow OK='\033[0;32m' # Green WARN='\033[0;31m' # Red NC='\033[0m' # No Color echo -e "${INFO}[!!!] Tests that will be run (space-delimited): ${TESTS[*]}${NC}" echo -e "" for testdir in "${TESTS[@]}"; do echo -e "${INFO}[@@@] Going to run '${testdir}' test${NC}" echo "" pushd "${testdir}" rm -f ../output_badness.txt ../../target/release/siderophile --crate-name "${testdir}" > ../output_badness.txt if ! (diff ../${testdir}_expected_badness.txt ../output_badness.txt); then echo "" echo -e "${WARN}[!!!] Tests failed on $testdir: the expected_badness.txt does not match the output_badness.txt file!${NC}" exit 1 fi # smoelius: Verify that a temporary target directory was used. if [[ -e target ]]; then echo "" echo -e "${WARN}[+++] Found $testdir/target, which should not exist!${NC}" exit 1 fi popd done echo "" echo -e "${OK}[+++] Tests succeeded!${NC}" ================================================ FILE: tests/suffix_array_expected_badness.txt ================================================ Badness Function 064 suffix_array::construct::utils::suffixes_from_substrs 040 suffix_array::construct::saca 040 suffix_array::construct::sacak::sacak 040 suffix_array::construct::sacak::sort_lms_suffixes 040 suffix_array::sa::SuffixArray::new 040 suffix_array::sa::SuffixArray::set 038 suffix_array::construct::utils::rename_substrs 024 suffix_array::construct::sacak::sacak_u32s::sacak_u32s 024 suffix_array::construct::sacak::sacak_u32s::sort_lms_suffixes 003 suffix_array::construct::sacak::sacak_u32s::induce_by_lms 003 suffix_array::sa::SuffixArray::load_bytes 002 suffix_array::sa::SuffixArray::unchecked_load_bytes 001 suffix_array::construct::sacak::sacak_u32s::finish_head 001 suffix_array::construct::sacak::sacak_u32s::finish_tail 001 suffix_array::construct::sacak::sacak_u32s::insert_head 001 suffix_array::construct::sacak::sacak_u32s::insert_tail 001 suffix_array::construct::sacak::sacak_u32s::sa_move 001 suffix_array::construct::sacak::sacak_u32s::sort_lms_suffixes::{{closure}} 001 suffix_array::construct::utils::for_each_lms 001 suffix_array::sa::SuffixArray::unchecked_from_parts