Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md #24

Merged
merged 2 commits into from
Jun 6, 2023
Merged

Improve README.md #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65d38e4
Add new badges to README
Hpmason Jun 6, 2023
130da4b
Add section about injection methods
Hpmason Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,24 @@

# `retour` (a `detour` Fork)

[![Language (Rust)][rust-shield]][rust]

[![Crates.io][crates-badge]][crates-url]
[![docs.rs][docs-badge]][docs-url]
[![Lcense][license-badge]][license-url]
[![Cargo Check/Tests][actions-badge]][actions-url]
</div>

[crates-badge]: https://img.shields.io/crates/v/retour.svg
[crates-url]: https://crates.io/crates/retour

[docs-badge]: https://docs.rs/retour/badge.svg
[docs-url]: https://docs.rs/retour

[license-badge]: https://img.shields.io/crates/l/retour
[license-url]: ./LICENSE

[actions-badge]: https://github.com/Hpmason/retour-rs/actions/workflows/ci.yml/badge.svg
[actions-url]: https://github.com/Hpmason/retour-rs/actions/workflows/ci.yml

(Fork of original [detour-rs](https://github.com/darfink/detour-rs)
that works on nightly after nightly-2022-11-07)

Expand Down Expand Up @@ -115,6 +129,13 @@ Part of the library's external user interface was inspired by
[minhook-rs][minhook], created by [Jascha-N][minhook-author], and it contains
derivative code of his work.

## Injection Methods
This crate provides the ability to hook functions in other applications, but does not provide the utilities necessary for injecting/attaching to another process. If you're looking for ways to inject your hooking library here are some approaches you can look into:

- dll injection libraries such as [dll-syringe](https://crates.io/crates/dll-syringe)
- LD_PRELOAD on *nix platforms
- Various debuggers, including x64dbg and Cheat Engine

## Appendix

- *EIP relocation*
Expand All @@ -140,8 +161,6 @@ derivative code of his work.
trailing `NOP` instructions will be replaced, to make room for the detour.*

<!-- Links -->
[rust-shield]: https://img.shields.io/badge/powered%20by-rust-blue.svg?style=flat-square
[rust]: https://www.rust-lang.org
[minhook-author]: https://github.com/Jascha-N
[minhook]: https://github.com/Jascha-N/minhook-rs/
[detour-rs]: https://github.com/darfink/detour-rs
Expand Down
2 changes: 2 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@
//!
//! Beyond what is shown here, a trampoline is also generated so the original
//! function can be called regardless whether the function is hooked or not.
//!
//! For various injection methods, see the [README in the GitHub repo](https://github.com/Hpmason/retour-rs)

// Re-exports
pub use detours::*;
Expand Down