alixinne / transmission-proxy

Authenticating proxy for the Transmission BitTorrent client

transmission-proxy

transmission-proxy is an OAuth2 / Basic auth proxy for the Transmission BitTorrent client, providing fine-grained ACL and per-user download folders for multi-user use cases.

Table of contents

• Configuration
• Running
• Author

Configuration

transmission-proxy requires a transmission-proxy.yaml file to be provided as input to configure:

• ACL rules: which identities are allowed what actions
• Providers: ways of authenticating users for mapping them to identities

Here's an example transmission-proxy.yaml which provides:

• Admin access to [email protected] (or admin basic auth user)
• Read-only access to [email protected] (or readonly basic auth user)
• Blocks access to anonymous users

For this configuration to be functional, you'll need to:

• Set the bcrypt hash of the password for basic auth users
• Generate a client_id/client_secret for a Google client application to enable Google OAuth from the console

# transmission-proxy.yaml
acl:
  rules:
    - identities:
        - provider: basic
          name: admin
        - provider: oauth2
          oauth2: google
          name: [email protected]
    - identities:
        - provider: basic
          name: readonly
        - provider: oauth2
          oauth2: google
          name: [email protected]
      allowed_methods:
        - torrent-get
        - session-get
        - session-stats
        - free-space
    - deny: true

providers:
  basic:
    enabled: true
    visible: false
    users:
      - username: admin
        password: "*bcrypt hash of the password*"
      - username: readonly
        password: "*bcrypt hash of the password*"
  oauth2:
    - auth_url: https://accounts.google.com/o/oauth2/v2/auth
      client_id: ...
      client_secret: ...
      email_path: $.email
      name: google
      token_url: https://www.googleapis.com/oauth2/v3/token
      userinfo_url: https://www.googleapis.com/oauth2/v3/userinfo

Running

You can run the proxy from its Docker image:

docker run -v transmission-proxy.yaml:/transmission-proxy.yaml:ro ghcr.io/alixinne/transmission-proxy

Check the available options with --help to configure integration with your existing transmission daemon.

Author

Alixinne [email protected]

transmission-proxy's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Use matchDepNames instead of matchPackageNames
• WARN: Package lookup failures

---

Warning

Renovate failed to look up the following dependencies: Failed to look up crate package transmission-rpc-client.

Files affected: crates/transmission-proxy/Cargo.toml

---

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update gcr.io/distroless/cc-debian12 docker digest to 3b75fdd
• chore(deps): update all non-major dependencies (anyhow, axum, base64, bcrypt, clap, color-eyre, cookie, docker.io/library/rust, handlebars, hyper, regex, reqwest, rust, serde, serde_bencode, serde_bytes, serde_json, serde_yaml, sha2, strum, thiserror, tokio, tower-cookies, tracing, tracing-subscriber, url, urlencoding)
• fix(deps): update rust crate handlebars to v6
• fix(deps): update rust crate hyper to v1
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

cargo

crates/transmission-proxy/Cargo.toml

• transmission-rpc-client 1.1.6
• async-session 3.0.0
• axum 0.6
• base64 0.21
• bcrypt 0.15
• clap 4.4
• color-eyre 0.6
• cookie 0.17
• handlebars 4.4
• hmac 0.12
• hyper 0.14
• jsonpath 0.1.1
• jwt 0.16
• oauth2 4.4.2
• rand 0.8
• regex 1.10
• reqwest 0.11
• secrecy 0.8
• serde 1
• serde_bencode 0.2
• serde_bytes 0.11
• serde_json 1
• serde_regex 1.1
• serde_yaml 0.9
• sha2 0.10
• strum 0.25
• thiserror 1.0
• tokio 1.33
• tower-cookies 0.9
• tracing 0.1
• tracing-error 0.2
• tracing-subscriber 0.3
• url 2.4
• urlencoding 2.1

crates/transmission-rpc-client/Cargo.toml

• serde 1
• serde_json 1
• strum 0.25
• reqwest 0.11
• thiserror 1
• url 2.4
• anyhow 1
• tokio 1.33

dockerfile

Dockerfile

• docker.io/library/rust 1.73.0
• gcr.io/distroless/cc-debian12 sha256:6714977f9f02632c31377650c15d89a7efaebf43bab0f37c712c30fc01edb973

github-actions

.github/workflows/build.yaml

• alixinne/github-workflows v1

regex

rust-toolchain.toml

• rust 1.73.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Add support for upstream daemon authentication

is there a way to configure it to connect to the upstream as a specific user/password?

Originally posted by @cannadayr in #1 (comment)

Example transmission-proxy.yaml for common uses?

Hello! I went thru your project and it seems really cool and might work for my use-case.

I'd like to use the proxy to provide read-only access to a transmission remote control.

Have you used this for anything similar? Would you be willing to share an example transmission-proxy.yaml I can test and modify?

Thanks,

• Rowan