Skip to content

Commit cc33819

Browse files
committed
update readme && generate chapter-1.pdf
1 parent 07dd499 commit cc33819

File tree

2 files changed

+72
-2
lines changed

2 files changed

+72
-2
lines changed

README.md

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,73 @@
1-
# Dark Web Rust
1+
# 📚 Dark Web Rust
22

3-
A continuum work of the [black-hat-rust](https://github.com/skerkour/black-hat-rust) book.
3+
[![Work In Progress](https://img.shields.io/badge/Work%20In%20Progress-red)](https://github.com/wiseaidev)
4+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/wiseaidev)
5+
[![License](https://img.shields.io/badge/MIT-license-blue.svg)](https://opensource.org/licenses/MIT)
6+
[![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-1f425f.svg?logo=rust&logoColor=white)](https://www.rust-lang.org/)
7+
[![Jupyter Notebook](https://img.shields.io/badge/Jupyter-Notebook-blue.svg?logo=Jupyter&logoColor=orange)](https://jupyter.org/)
8+
[![Share On Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/wiseaidev/dark-web-rust&title=A%20hands-on%20book%20for%20abusing%20systems%20using%20Rust)
9+
[![Share On Ycombinator](https://img.shields.io/badge/share%20on-hacker%20news-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/wiseaidev/dark-web-rust&t=A%20hands-on%20book%20for%20abusing%20systems%20using%20Rust)
10+
[![Share On X](https://img.shields.io/badge/share%20on-X-03A9F4?logo=x)](https://twitter.com/share?url=https://github.com/wiseaidev/dark-web-rust&text=A%20hands-on%20book%20for%20abusing%20systems%20using%20Rust)
11+
[![Share On Meta](https://img.shields.io/badge/share%20on-meta-1976D2?logo=meta)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/wiseaidev/dark-web-rust)
12+
[![Share On Linkedin](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/shareArticle?url=https://github.com/wiseaidev/dark-web-rust&title=A%20hands-on%20book%20for%20abusing%20systems%20using%20Rust)
13+
14+
Welcome to the **Dark Web Rust** repository! This project is a continuum work of the [black-hat-rust](https://github.com/skerkour/black-hat-rust) book. Here, you'll delve into the world of networking, implementing low-level protocols, including IP, TCP, UDP, ICMP, and much more topics. The primary focus is on hands-on hacking methodologies, providing a comprehensive learning experience through Jupyter notebooks. Each chapter in this repository is also available in PDFs, Markdown, and other formats.
15+
16+
## 📝 Table of Contents
17+
18+
- [Installation](#-installation)
19+
- [Chapters](#-chapters)
20+
- [Licence](#-licence)
21+
- [Star History](#-star-history)
22+
23+
## 🚀 Installation
24+
25+
To use the notebooks in this repository, you need to set up your environment. Follow these steps to get started:
26+
27+
1. Clone the repository to your local machine:
28+
29+
```sh
30+
git clone https://github.com/wiseaidev/dark-web-rust.git
31+
```
32+
33+
1. Install the required dependencies and libraries. Make sure you have [`Rust`](https://rustup.rs/), [`Jupyter Notebook`](https://jupyter.org/install), and [`evcxr_jupyter`](https://github.com/evcxr/evcxr/blob/main/evcxr_jupyter/README.md) installed on your system.
34+
35+
```sh
36+
# Install a Rust toolchain (e.g. nightly):
37+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain nightly
38+
39+
# Install Jupyter Notebook
40+
pip install notebook
41+
42+
# Install evcxr_jupyter
43+
cargo install evcxr_jupyter
44+
evcxr_jupyter --install
45+
```
46+
47+
1. Navigate to the cloned repository:
48+
49+
```sh
50+
cd dark-web-rust/chapter-1
51+
```
52+
53+
1. Start Jupyter Notebook:
54+
55+
```sh
56+
jupyter notebook
57+
```
58+
59+
1. Access the notebooks in your web browser by clicking on the notebook file you want to explore.
60+
61+
## 📌 Chapters
62+
63+
| ID | Title | NB Pages | Topics | Open on GitHub | Launch on Binder | Read PDF |
64+
|----|---------------|-----------|:-------------|-------------|----------------|-------|
65+
| 1 | **Crafting a Rust-Based Network Sniffer** | 35 | - Introduction to Network Sniffers <br>- Rust for Network Programming <br>- The `socket2` Crate <br>- Fundamentals of Raw Network Packets in Rust | [![Github](https://img.shields.io/badge/launch-Github-181717.svg?logo=github&logoColor=white)](./chapter-1/chapter-1.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/wiseaidev/dark-web-rust/main?filepath=chapter-1/chapter-1.ipynb) | [![nbviewer](https://img.shields.io/badge/Read%20PDF-nbviewer-blue)](https://nbviewer.org/github/wiseaidev/dark-web-rust/tree/main/chapter-1/chapter-1.pdf) |
66+
67+
## 📜 License
68+
69+
This project is licensed under the [MIT](https://opensource.org/licenses/MIT). For more details, You can refer to the [LICENSE](LICENSE) file.
70+
71+
## 📈 Star History
72+
73+
[![Star History Chart](https://api.star-history.com/svg?repos=wiseaidev/dark-web-rust&type=Date)](https://star-history.com/#wiseaidev/dark-web-rust&Date)

chapter-1/chapter-1.pdf

246 KB
Binary file not shown.

0 commit comments

Comments
 (0)