matrix-org / matrix-org/matrix-rust-sdk
ffi: add documentation for OIDC Authentication Flow
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.3k
- Forks
- 500
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 106
Description
It has been next to impossible figuring out the intended flow of authentication used with OIDC related functions of this
SDK, especially for the Swift bindings.
It would be great if the functionality and intended usage could be documented somewhere, or an example could be given somewhere (like with basic with login) so that it is easier to get started with OIDC authentication both using the SDK directly and through the Swift bindings.
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 by tracing the SDK's OIDC-related functions and the Swift bindings, then compare them with the existing basic login example. Document the intended authentication flow and usage for both direct SDK consumers and Swift users, with an example showing how to get started.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, swift
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100