stem-rs 1.1.2

A complete Rust library for Tor control protocol — build privacy-focused applications with type-safe, async-first APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

name: Tests

on:
  push:
  pull_request:
  workflow_dispatch:
  workflow_call:

env:
  CARGO_TERM_COLOR: always
  TOR_VERSION: "14.0.4"
  RUST_BACKTRACE: 1

jobs:
  unit-tests:
    name: Unit Tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy, rustfmt
      
      - name: Cache cargo registry
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-
      
      - name: Run clippy
        run: cargo clippy --all-targets --all-features -- -D warnings
      
      - name: Run unit tests
        run: cargo test --lib --verbose
      
      - name: Run doc tests
        run: cargo test --doc --verbose

  integration-tests:
    name: Integration Tests
    runs-on: ubuntu-latest
    needs: unit-tests
    steps:
      - uses: actions/checkout@v4
      
      - name: Install system dependencies
        run: sudo apt-get update && sudo apt-get install -y libevent-2.1-7
      
      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
      
      - name: Cache cargo registry
        uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-
      
      - name: Download and extract Tor Expert Bundle
        run: |
          mkdir -p tor-bundle
          cd tor-bundle
          curl -fsSL -o tor-expert-bundle.tar.gz \
            "https://archive.torproject.org/tor-package-archive/torbrowser/${{ env.TOR_VERSION }}/tor-expert-bundle-linux-x86_64-${{ env.TOR_VERSION }}.tar.gz"
          tar -xzf tor-expert-bundle.tar.gz
          chmod +x tor/tor
          mkdir -p tor/data
      
      - name: Create Tor configuration
        run: |
          cat > tor-bundle/torrc << 'EOF'
          ControlPort 9051
          CookieAuthentication 1
          CookieAuthFile ${{ github.workspace }}/tor-bundle/tor/control_auth_cookie
          DataDirectory ${{ github.workspace }}/tor-bundle/tor/data
          Log notice file ${{ github.workspace }}/tor-bundle/tor/tor.log
          SocksPort 9050
          DisableNetwork 0
          EOF
      
      - name: Start Tor in background
        run: |
          ./tor-bundle/tor/tor -f tor-bundle/torrc &
          echo $! > tor.pid
          echo "Tor PID: $(cat tor.pid)"
      
      - name: Wait for Tor bootstrap
        run: |
          echo "Waiting for Tor to bootstrap..."
          for i in {1..60}; do
            if [ -f tor-bundle/tor/control_auth_cookie ]; then
              echo "Cookie file found after ${i} seconds"
              break
            fi
            sleep 1
          done
          
          for i in {1..360}; do
            if grep -q "Bootstrapped 100%" tor-bundle/tor/tor.log 2>/dev/null; then
              echo "Tor bootstrapped successfully after ${i} seconds"
              break
            fi
            if [ $i -eq 120 ]; then
              echo "Tor bootstrap timeout"
              cat tor-bundle/tor/tor.log || true
              exit 1
            fi
            sleep 1
          done
      
      - name: Run integration tests
        env:
          TOR_CONTROL_PORT: 9051
          TOR_COOKIE_PATH: ${{ github.workspace }}/tor-bundle/tor/control_auth_cookie
          TOR_SOCKS_PORT: 9050
        run: cargo test --features integration --verbose -- --test-threads=1
      
      - name: Stop Tor
        if: always()
        run: |
          if [ -f tor.pid ]; then
            kill $(cat tor.pid) 2>/dev/null || true
            rm tor.pid
          fi
      
      - name: Upload Tor logs on failure
        if: failure()
        uses: actions/upload-artifact@v4
        with:
          name: tor-logs
          path: |
            tor-bundle/tor/tor.log
            tor-bundle/tor/data/