chore: ship Tor binary and use custom TorHandler #2366
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
leblowl
reviewed
Mar 15, 2024
packages/mobile/android/app/src/main/java/com/quietmobile/Backend/TorHandler.java
Show resolved
Hide resolved
leblowl
reviewed
Mar 15, 2024
packages/mobile/android/app/libtor/include/tor/org_torproject_jni_TorService.h
Outdated
Show resolved
Hide resolved
|
|
||
| We ship the binary [libtor.so](https://github.com/TryQuiet/quiet/blob/8924a5573ed11980ceeadb2f8dd1ce45169f03ee/packages/mobile/android/app/src/main/libs/arm64-v8a/libtor.so), which exposes certain native APIs through JNI. These are used to configure and run Tor. These JNI methods are directed to the official Guardian Project's library, forcing us to use our [wrapper](https://github.com/TryQuiet/quiet/blob/8924a5573ed11980ceeadb2f8dd1ce45169f03ee/packages/mobile/android/app/src/main/cpp/tor-wrapper.cpp) around it. It bridges C-level global namespace accessible libtor.so methods and exposes them through Quiet's app scope JNI interface, enabling its use without modifying the Tor source code itself. | ||
|
|
||
| ## Building the Tor Binary |
There was a problem hiding this comment.
Are we currently using the most recent release of Tor?
Are there any other notes it would be good to include for someone updating Tor in the future, about how to proceed?
|
|
||
| The Tor binary is designed to be a ready-made product and does not contain the SONAME property. This absence makes linking it to any other shared object, like our tor-wrapper, challenging. While building Tor, it is essential to remember to pass an extra linker flag to set the SONAME property for the compilation product. The entry point for building the Tor binary is [tor-droid-make.sh](https://github.com/guardianproject/tor-android/blob/master/tor-droid-make.sh), with a crucial step being `build_external_dependencies()`. It is advisable to modify the script and skip the `./gradlew` command build assembling, as it is not essential for acquiring the Tor binary. The script is important as it sets flags to enable the Android API in Tor. The prerequisites for building are listed [here](https://raw.githubusercontent.com/guardianproject/tor-android/master/BUILD). The output Tor binary will be located in `external/tor/lib/{ABI}/`. | ||
|
|
||
| ### Build Command |
There was a problem hiding this comment.
Would it be useful to automate building of Tor directly from their repository on each release for a given Tor version?
If so, how hard would this be?
packages/mobile/android/app/src/main/java/com/quietmobile/Backend/TorHandler.java
Show resolved
Hide resolved
leblowl
reviewed
Mar 19, 2024
|
For binaries from other projects, you can see this comment where I mentioned having an external-licenses directory (https://github.com/TryQuiet/quiet/pull/2366/files#r1531120795) ... since binaries are a bit different, we can create a file |
Closed
leblowl
added a commit
that referenced
this pull request
Mar 21, 2024
Co-authored-by: Lucas Leblow <lucas@quiet.chat>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solves #2328
Pull Request Checklist
(Optional) Mobile checklist
Please ensure you completed the following checks if you did any changes to the mobile package: