iv-org/inv_sig_helper
1
0
Fork 0
mirror of https://github.com/iv-org/inv_sig_helper.git synced 2024-10-06 19:03:36 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
40 Commits 1 Branch 0 Tags 207 KiB
Rust 95.6%
Dockerfile 4.4%
4d3cff6a16
Go to file
perennial 4d3cff6a16
Add Docker support and update README (#13) 
* add compose.yaml

* add Dockerfile

* update README

* Dockerfile: uncomment CMD instruction

* add .dockerignore

* Dockerfile: use scratch image for second stage

* Dockerfile: use newer OpenSSL version (3.0.9)

* Dockerfile: use Alpine-based Rust image to skip building OpenSSL

* Dockerfile: expose to localhost only by default

* Dockerfile: allow building for different architectures (AMD64 and ARM64)

Dockerfile now detects the architecture being used during the build process and templates in the correct Rust target architecture

* compose.yaml: include command line

* compose.yaml: listen on 127.0.0.1 only

* compose.yaml: remove healthcheck due to using scratch image

* README.md: restore old table format

* rename compose.yaml to docker-compose.yml

* docker-compose.yml: include version line

* update .dockerignore

* README.md: update Docker instructions to expose only on localhost

* add workflow to build and push container images to quay.io

* docker-compose.yml: harden configuration

* docker workflow: add paths-ignore section

* Dockerfile: let Rustup handle architecture detection

More flexible as the build process will now automatically adapt to whatever architecture the container is being built on, without needing to explicitly list out each supported architecture

* Docker: further security hardening

- Run as a non-privileged user within the scratch container
- Add security_opt: - no-new-privileges:true to docker-compose.yml

* Dockerfile: Switch to Debian-based images and simplify build command

- rust:1.80-alpine replaced with rust:1.80 for the builder stage
- alpine:3.20 replaced with debian:12.6-slim for the user-stage
- Build command simplified to use default target architecture

* Cargo.toml: correct note on optimisations

* docker-compose.yml: use quay.io image by default

* rename docker-compose.yml to docker-compose.yaml

* compose: build image from local repo by default

* Revert "Dockerfile: Switch to Debian-based images and simplify build command"

This reverts commit ff9a378564.

Reasons for reverting:
1. Compiling via musl is necessary to statically link dependencies and create a truly standalone Rust binary. [1]
2. Alpine-based Rust images are required for the build stage because such systems support dynamic linking, which is also needed for statically-linked binaries. [2]
3. Determining the target architecture and templating the correct value for the --target flag is necessary for the statically-linked binary to be built correctly. [2]

[1]: https://doc.rust-lang.org/1.13.0/book/advanced-linking.html#linux
[2]: https://github.com/rust-lang/rust/issues/40174#issuecomment-538791091
2024-08-14 12:58:44 +02:00
.github/workflows Add Docker support and update README (#13) 2024-08-14 12:58:44 +02:00
src GitHub workflow: Test the player script extractor every 2 hours 2024-08-09 15:09:05 +01:00
.dockerignore Add Docker support and update README (#13) 2024-08-14 12:58:44 +02:00
.gitignore Initial commit 2024-04-28 13:13:16 +01:00
Cargo.lock Bump openssl from 0.10.64 to 0.10.66 2024-07-25 13:43:14 +00:00
Cargo.toml Add Docker support and update README (#13) 2024-08-14 12:58:44 +02:00
docker-compose.yaml Add Docker support and update README (#13) 2024-08-14 12:58:44 +02:00
Dockerfile Add Docker support and update README (#13) 2024-08-14 12:58:44 +02:00
LICENSE Add LICENSE 2024-04-28 15:55:48 +01:00
README.md Add Docker support and update README (#13) 2024-08-14 12:58:44 +02:00

README.md

inv_sig_helper

inv_sig_helper is a Rust service that decrypts YouTube signatures and manages player information. It offers a TCP/Unix socket interface for signature decryption and related operations.

Features

  • Decrypt YouTube n and s signatures
  • Fetch and update YouTube player data
  • Provide signature timestamps and player status
  • Efficient signature decryption with multi-threaded JavaScript execution

Building and Running

Prerequisites

  • Rust 1.77 or later
  • Cargo
  • Patch
  • openssl-devel

Building

  1. Clone the repository and navigate to the project directory:

    git clone https://github.com/iv-org/inv_sig_helper.git
cd inv_sig_helper

  2. Build the project:

    cargo build --release

Running

The service can run in Unix socket mode (default) or TCP mode:

  1. Unix socket mode:

    ./target/release/inv_sig_helper_rust

    This creates a Unix socket at /tmp/inv_sig_helper.sock.

  2. TCP mode:

    ./target/release/inv_sig_helper_rust --tcp [IP:PORT]

    If no IP:PORT is given, it defaults to 127.0.0.1:12999.

Docker

A Dockerfile is included for containerized deployment.

  1. Build the image:

    docker build -t inv_sig_helper .

  2. Run the container:

    docker run -p 127.0.0.1:12999:12999 inv_sig_helper

    Or use Docker Compose:

    docker compose up

Protocol Format

All data-types bigger than 1 byte are stored in network endian (big-endian) unless stated otherwise.

Request Base

Name Size (bytes) Description
opcode 1 The operation code to perform, A list of operations currently supported (and their data) can be found in the Operations chapter
request_id 4 The ID for the current request, Used to distinguish responses in the current connection

The data afterwards depends on the supplied opcode, Please consult the Operations chapter for more information.

Response Base

Name Size (bytes) Description
request_id 4 The ID for the request that this response is meant for
size 4 Size of the response (excluding size of request id)

The data afterwards depends on the supplied opcode, Please consult the Operations chapter for more information.

Operations

FORCE_UPDATE (0x00)

Forces the server to re-fetch the YouTube player, and extract the necessary components from it (nsig function code, sig function code, signature timestamp).

Request

No additional data required

Response
Name Size (bytes) Description
status 2 The status code of the request: 0xF44F if successful, 0xFFFF if no updating is required (YouTube's player ID is equal to the server's current player ID), 0x0000 if an error occurred

DECRYPT_N_SIGNATURE (0x01)

Decrypt a provided n signature using the server's current nsig function code, and return the result (or an error).

Request
Name Size (bytes) Description
size 2 The size of the encrypted signature
string size The encrypted signature
Response
Name Size (bytes) Description
size 2 The size of the decrypted signature, 0x0000 if an error occurred
string size The decrypted signature

DECRYPT_SIGNATURE (0x02)

Decrypt a provided s signature using the server's current sig function code, and return the result (or an error).

Request
Name Size (bytes) Description
size 2 The size of the encrypted signature
string size The encrypted signature
Response
Name Size (bytes) Description
size 2 The size of the decrypted signature, 0x0000 if an error occurred
string size The decrypted signature

GET_SIGNATURE_TIMESTAMP (0x03)

Get the signature timestamp from the server's current player, and return it in the form of a 64-bit integer. If there's no player, it will return 0 in the timestamp (Please check with PLAYER_STATUS if the server has a player)

Request

No additional data required

Response
Name Size (bytes) Description
timestamp 8 The signature timestamp from the server's current player

PLAYER_STATUS (0x04)

Get the server's information about the current player.

Request

No additional data required

Response
Name Size (bytes) Description
has_player 1 If the server has a player, this variable will be 0xFF. or else, it will be 0x00
player_id 4 The server's current player ID. If the server has no player, this will always be 0x00000000

PLAYER_UPDATE_TIMESTAMP (0x05)

Get the time of the last player update, The time is represented as seconds since the last update

Request

No additional data required

Response
Name Size (bytes) Description
timestamp 8 Seconds since the last player update

License

This project is open source under the AGPL-3.0 license.