{"id":26572411,"url":"https://github.com/gharib110/lyrebird","last_synced_at":"2025-03-23T00:34:31.102Z","repository":{"id":228536934,"uuid":"774270019","full_name":"Gharib110/lyrebird","owner":"Gharib110","description":"Lyrebird, Implementation of Obfs4,3,2, Scramblesuit and WebTunnel . Official Tor Project","archived":false,"fork":false,"pushed_at":"2025-03-14T14:48:29.000Z","size":163,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T15:45:33.103Z","etag":null,"topics":["obfs2","obfs3","obfs4","obfs4proxy","scramblesuit","tor","tunnel"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Gharib110.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","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-03-19T08:51:39.000Z","updated_at":"2025-03-14T14:48:33.000Z","dependencies_parsed_at":"2025-03-14T18:15:55.021Z","dependency_job_id":null,"html_url":"https://github.com/Gharib110/lyrebird","commit_stats":null,"previous_names":["gharib110/lyrebird"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gharib110%2Flyrebird","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gharib110%2Flyrebird/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gharib110%2Flyrebird/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gharib110%2Flyrebird/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gharib110","download_url":"https://codeload.github.com/Gharib110/lyrebird/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245040235,"owners_count":20551297,"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":["obfs2","obfs3","obfs4","obfs4proxy","scramblesuit","tor","tunnel"],"created_at":"2025-03-23T00:34:12.979Z","updated_at":"2025-03-23T00:34:31.078Z","avatar_url":"https://github.com/Gharib110.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## lyrebird - The obfourscator\n\n### What?\n\nThis is a look-like nothing obfuscation protocol that incorporates ideas and\nconcepts from Philipp Winter's ScrambleSuit protocol.  The obfs naming was\nchosen primarily because it was shorter, in terms of protocol ancestery obfs4\nis much closer to ScrambleSuit than obfs2/obfs3.\n\nThe notable differences between ScrambleSuit and obfs4:\n\n * The handshake always does a full key exchange (no such thing as a Session\n   Ticket Handshake).\n * The handshake uses the Tor Project's ntor handshake with public keys\n   obfuscated via the Elligator 2 mapping.\n * The link layer encryption uses NaCl secret boxes (Poly1305/XSalsa20).\n\nAs an added bonus, lyrebird also supports acting as an obfs2/3 client and\nbridge to ease the transition to the new protocol.\n\n### Why not extend ScrambleSuit?\n\nIt's my protocol and I'll obfuscate if I want to.\n\nSince a lot of the changes are to the handshaking process, it didn't make sense\nto extend ScrambleSuit as writing a server implementation that supported both\nhandshake variants without being obscenely slow is non-trivial.\n\n### Dependencies\n\nBuild time library dependencies are handled by the Go module automatically.\n\nIf you are on Go versions earlier than 1.11, you might need to run `go get -d\n./...` to download all the dependencies. Note however, that modules always use\nthe same dependency versions, while `go get -d` always downloads master.\n\n * Go 1.11.0 or later. Patches to support up to 2 prior major releases will\n   be accepted if they are not overly intrusive and well written.\n * See `go.mod`, `go.sum` and `go list -m -u all` for build time dependencies.\n\n### Installation\n\nTo build:\n\n\t`make build`\n\nTo install, copy `./lyrebird` to a permanent location\n(Eg: `/usr/local/bin`)\n\nClient side torrc configuration:\n```\nClientTransportPlugin obfs4 exec /usr/local/bin/lyrebird\n```\n\nBridge side torrc configuration:\n```\n# Act as a bridge relay.\nBridgeRelay 1\n\n# Enable the Extended ORPort\nExtORPort auto\n\n# Use lyrebird to provide the obfs4 protocol.\nServerTransportPlugin obfs4 exec /usr/local/bin/lyrebird\n\n# (Optional) Listen on the specified address/port for obfs4 connections as\n# opposed to picking a port automatically.\n#ServerTransportListenAddr obfs4 0.0.0.0:443\n```\n\n### Tips and tricks\n\n * On modern Linux systems it is possible to have lyrebird bind to reserved\n   ports (\u003c=1024) even when not running as root by granting the\n   `CAP_NET_BIND_SERVICE` capability with setcap:\n\n   `# setcap 'cap_net_bind_service=+ep' /usr/local/bin/lyrebird`\n\n * lyrebird can also act as an obfs2 and obfs3 client or server.  Adjust the\n   `ClientTransportPlugin` and `ServerTransportPlugin` lines in the torrc as\n   appropriate.\n\n * lyrebird can also act as a ScrambleSuit client.  Adjust the\n   `ClientTransportPlugin` line in the torrc as appropriate.\n\n * The autogenerated obfs4 bridge parameters are placed in\n   `DataDir/pt_state/obfs4_state.json`.  To ease deployment, the client side\n   bridge line is written to `DataDir/pt_state/obfs4_bridgeline.txt`.\n\n### Thanks\n\n * Loup Vaillant for motivating me to replace the Elligator implementation\n   and a body of code I could draw on to accelerate the replacement process.\n * David Fifield for goptlib.\n * Adam Langley for his initial Elligator implementation.\n * Philipp Winter for the ScrambleSuit protocol which provided much of the\n   design.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgharib110%2Flyrebird","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgharib110%2Flyrebird","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgharib110%2Flyrebird/lists"}