matrix-org / matrix-org/matrix.org
Suggestion: add a pointer to libolm on https://matrix.org/sdks/ (detailed suggestion inside)
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 616
- Forks
- 463
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 19
Description
Is your feature request related to a problem? Please describe.
I was looking at https://matrix.org/sdks/ since I'm contemplating implementing a matrix client. However, I don't use any of the languages listed, so I was looking for something with a C API. Since there is no such entry, my temporary conclusion was "oh so I guess I'd have to hand-roll E2EE, there goes the idea of ever getting this practically done." But that conclusion was wrong, since there is libolm. So while that isn't the equivalent of a full Matrix SDK, I think having it in the "Other" section as a "Roll your own with libolm (C)" entry might be a great pointer.
Describe the solution you'd like
I am suggesting to add an entry to the "Other" section of the Matrix SDK list at the bottom, named "Roll your own with libolm (C)". It could have the following description: "If you want to implement a Matrix client using another programming language than the ones with existing SDKs, or want to make a new SDK for your language, you can still use libolm to help you out if your language enables access to C libs via FFI. See here for more details: https://matrix.org/docs/guides/end-to-end-encryption-implementation-guide This should make a full implementation with E2EE support more feasible even without the use of a pre-existing Matrix SDK."
Describe alternatives you've considered
I mean the info is there, just not on that SDK page but rather: https://matrix.org/docs/guides/end-to-end-encryption-implementation-guide So I guess it was mostly on me for failing Google. However, such a pointer to libolm might be very helpful for people to realize they may not need to hand-roll the E2EE part entirely just because there is no Matrix SDK for their target language, so I think it could be of great value.
Additional context
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Matrix SDK list at https://matrix.org/sdks/ and review its Other section, then read the linked end-to-end encryption implementation guide for the libolm reference. Add the suggested libolm pointer and description, and verify that the entry and link render correctly on the SDK page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100