about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Frazee <pfrazee@gmail.com>2022-06-15 20:26:41 -0500
committerPaul Frazee <pfrazee@gmail.com>2022-06-15 20:26:41 -0500
commit07b92a2180ca6600f09e03a85c8ca7a06d24cbfc (patch)
tree1f7fd65f7cbaf59ff93c92595dc04a22b0a079a7 /README.md
parent81441c3c265ae6e733365dcba01f7da650f5b1f9 (diff)
downloadvoidsky-07b92a2180ca6600f09e03a85c8ca7a06d24cbfc.tar.zst
Implement full auth flow in iOS
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 785060147..8ebb51f5e 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,11 @@ Uses:
 - [MobX](https://mobx.js.org/README.html) and [MobX State Tree](https://mobx-state-tree.js.org/)
 - [Async Storage](https://github.com/react-native-async-storage/async-storage)
 
+## TODOs
+
+- Handle the "unauthed" state better than changing route definitions
+  - Currently it's possible to get a 404 if the auth state changes
+
 ## Build instructions
 
 - Setup your environment [using the react native instructions](https://reactnative.dev/docs/environment-setup).
@@ -55,4 +60,8 @@ For native builds, we must provide a polyfill of `webcrypto`. We use [react-nati
 `./platform/polyfills.*.ts` adds polyfills to the environment. Currently this includes:
 
 - webcrypto
-- TextEncoder / TextDecoder
\ No newline at end of file
+- TextEncoder / TextDecoder
+
+### Auth flow
+
+The auth flow is based on a browser app which is specified by the `REACT_APP_AUTH_LOBBY` env var. The app redirects to that location with the UCAN request, and then waits for a redirect back. In the native platforms with proper support, it will do this using an in-app browser. In native without in-app browser, or in the Web platform, it will handle this with redirects. The ucan is extracted from the hash fragment of the "return url" which is provided either by the in-app browser in response or detected during initial setup in the case of redirects.
\ No newline at end of file