{"id":24535306,"url":"https://github.com/icelain/sirang","last_synced_at":"2025-04-14T23:10:01.817Z","repository":{"id":269311566,"uuid":"903846788","full_name":"Icelain/sirang","owner":"Icelain","description":"An Experimental TCP Tunnel using QUIC for Transport","archived":false,"fork":false,"pushed_at":"2025-01-22T06:43:08.000Z","size":87,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T23:09:54.851Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Icelain.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-15T17:50:34.000Z","updated_at":"2025-03-08T10:58:14.000Z","dependencies_parsed_at":"2025-01-18T18:37:42.169Z","dependency_job_id":"df28892a-7554-4fe1-979c-dd2da2382adb","html_url":"https://github.com/Icelain/sirang","commit_stats":null,"previous_names":["icelain/sirang"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelain%2Fsirang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelain%2Fsirang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelain%2Fsirang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Icelain%2Fsirang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Icelain","download_url":"https://codeload.github.com/Icelain/sirang/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248975316,"owners_count":21192210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-22T12:17:02.823Z","updated_at":"2025-04-14T23:10:01.796Z","avatar_url":"https://github.com/Icelain.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# An Experimental TCP Tunnel over QUIC\n\n## Install\nInstall through cargo with ```cargo install sirang``` \u003cbr\u003e\n### OR \u003cbr\u003e\n\nInstall prebuilt binaries from the [Github Releases](https://github.com/Icelain/sirang/releases) page\n\n### OR \u003cbr\u003e\nClone the repo and compile with ```cargo build --release```\n\n## Running a Forward Tunnel\n\n### On your remote server:\n```\nsirang forward [GENERAL_OPTIONS] remote [OPTIONS] --key \u003cPATH\u003e --cert \u003cPATH\u003e --forwardaddr \u003cADDRESS\u003e\n```\nHere, ```--key``` and ```--cert``` and your tls key and tls certificate respectively.\n```--forwardaddr``` is the remote tcp_address you're forwarding your traffic to.\n\nBy default, the remote quic server starts on address `0.0.0.0:4433`.\nTo change this, you can specify the optional argument ```--quicaddr``` to start the quic server on your preferred address.\n\n### On your local machine:\n```\nsirang forward [GENERAL_OPTIONS] local [OPTIONS] --cert \u003cPATH\u003e --remoteaddr \u003cADDRESS\u003e\n```\nHere, ```--cert``` is the tls certificate of the remote server and ```--remoteaddr``` is the address of the remote quic server created with ```sirang forward remote```.\n\nBy default, the local tcp server starts on `127.0.0.1:8080`.\nTo change this, you can specify the optional argument ```--localaddr``` to start the tcp server on your preferred address.\n\n## Running a Reverse Tunnel\n\n### On your remote server:\n```\nsirang reverse [GENERAL_OPTIONS] remote [OPTIONS] --key \u003cPATH\u003e --cert \u003cPATH\u003e\n```\nHere, ```--key``` and ```--cert``` and your tls key and tls certificate respectively.\n\nBy default, the remote quic server starts on address `0.0.0.0:4433` and the default tcp server starts on address `0.0.0.0:5000`.\nTo change this, you can respectively specify the optional arguments ```--quicaddr``` and ```--tcpaddr``` to start the quic and tcp servers on your preferred addresses.\n\n### On your local machine:\n```\nsirang reverse [GENERAL_OPTIONS] local --cert \u003cPATH\u003e --localaddr \u003cADDRESS\u003e --remoteaddr \u003cADDRESS\u003e\n```\nHere, ```--cert``` is the tls certificate of the remote server and ```--remoteaddr``` is the address of the remote quic server created with ```sirang reverse remote```.\n\nThe argument ```--localaddr``` specifies the local tcp server you want to tunnel to.\n\n## General Options:\n\nTo turn on debug logging, use ```--debug``` before either command. \u003cbr/\u003e\nTo set the buffer size(in bytes), use ```--buffersize``` before either command. The default buffer size is 32KB.\n\n## Progress\n\n- [X] Functionality\n- [X] Debug Logging\n- [X] Testing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficelain%2Fsirang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficelain%2Fsirang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficelain%2Fsirang/lists"}