typo

_sidebar.md

@@ -1,6 +1,3 @@
-- [Create](/create.md)
+* [Email Flow](/emailflow.md)
-- [Sign](/sign.md)
+* [Offline Flow](/offline.md)
-- [Verify](/verify.md)
+* [Technical Notes](/technical.md)
-- [Offline Flow](/offline.md)
-- [Technical Notes](/technical.md)
-- [Techical Flow](/flow.md)

emailflow.md

@@ -0,0 +1,83 @@
+# Email Flow
+
+In creating an email flow that maintains PRIVACY and SECURITY whilst also being convenient to use, the following principles are observed:
+
+- Keypair must be generated client-side
+- Keypair must be protected by a strong password
+- It must be possible to change the password
+- It must be possible to work offline
+- Network traffic must not contain identifying metadata
+
+All of the above are achieved using a high level signup flow as follows:
+
+1. User provides email and long (min 21 chars) password
+2. These are used to encrypt a locally generated keypair 
+3. Email address, Public Key and encrypted backup are sent to the server
+4. Email address is validated 
+5. Account is activated
+
+The password is only used to encrypt/decrypt the local backup and is never stored or sent outside of the browser
+
+When performing a regular login, the flow is:
+
+1. Validate the email
+2. Provide the encrypted keypair for the user to unlock
+
+When performing a password reset:
+
+1. Change the pasword locally
+2. Re-encrypt the keypair using the new password
+3. Send the new backup to the server 
+
+
+All key signing / encryption operations happen on client side using [private class properties](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/Private_properties).
+
+## SIGNUP FLOW
+
+
+```mermaid
+sequenceDiagram
+    autoNumber
+    actor U as SIGit User
+    participant W as SIGit Website
+    participant D as Server
+    Participant DB 
+    Note over W,D: All comms encrypted with throwaway <br>(ephemeral) client keys and a <br>.well-known server key
+    U->>W: Click SIGNUP 
+    U->>W: Provide Email and Complex Password
+    Note over W: Validate Email<br>Ensure Complex Password<br>(Min 21 chars)
+
+    Note right of U: User is warned that they CANNOT<br>RESET PASSWORD, should USE <br>PASSWORD MANAGER etc
+
+    
+    Note over W: Nostr Keypair Generated <br> & Encrypted inside a <br> PRIVATE method,<br>with COMPLEX password.<br> Password variable is not <br>stored, sent or printed <br> anywhere. <br>Any sensitive variables <br>are immediately destroyed.
+    W->>D: Request account activation 
+    Note right of W: Event uses PoW and<br> encrypts PUBKEY, EMAIL,<br> and the encrypted BACKUP<br> to the dvm@sigit.io pubkey<br> using the ephemeral key
+    Note over D: Verify PoW, <br>event.created_at,<br>event.id
+    D -x DB: Check if email exists
+    Note over D: If email already exists, and <br>user.last_seen <> null then <br>send user to LOGIN.<br><br>If email exists and last_seen<br> is null, then DELETE the <br>current entry.<br><br> Otherwise#58;
+    D->>DB: Create DB entries
+    Note over DB: USER insert#58;<br>#128274;user.id=uid()<br>user.pubkey=lowcase($PUBKEY)<br>user.email=lowcase($EMAIL)<br>user.last_seen=null<br>user.created_at=now()<br>user.bkp=$BACKUP
+    Note over DB: SESSION insert#58;<br>#128274;session.pubkey="ephemeral pubkey"<br>session.email_code=INT (6 digits)<br>session.user_id=user.id<br>session.created_at=now()
+    D->>U: Send session.email_code via email
+    D->>W: Account created
+    Note left of D: Payload is the user.id and/or<br> an encrypted (and detailed)<br> error message
+    Note over W: Verify DVM pubkey, <br> event.created_at,<br>event.id
+    W->>U: Tell user to check email and<br>to open it in the <br> SAME BROWSER SESSION
+    Note over W: Screen to accept the 6 digits <br> is already displayed<br>(mobile optimised if relevant)
+    U->>W: User opens link or enters the code
+    W->>D: Verify Account
+    Note right of W: Event uses PoW and <br>encrypts both user_id <br>and email_code<br> to DVM pubkey
+    D -x DB: Check email_code where <br>session pk=event pk
+    D->>DB: If email_code matches, <br>update USER table where<br> session.user_id=user.id
+
+
+    Note over DB: USER update#58;<br>user.last_seen=now()
+    D->>W: Account activated
+    Note left of D: Payload is an empty string or<br> an encrypted (and detailed)<br> error message
+    Note over W: Verify DVM pubkey, <br> event.created_at,<br>event.id
+    W->>U: User is automatically logged in
+    Note over W: Ephemeral key is destroyed<br>Default relay list is broadcast<br> using the user pubkey
+```
+
+

flow.md

@@ -1,5 +0,0 @@
-# Techical Flow (WIP)
-
-Full sigit techical flow is visible on the diagram below:
-
-![](static/sigit-flow.drawio.png)

index.html

@@ -45,7 +45,12 @@
     -->
   <script src="static/assets/js/docsify.js"></script>
   <script src="static/assets/js/search.min.js"></script>
-
+  <script type="module">
+    import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
+    mermaid.initialize({ startOnLoad: true });
+    window.mermaid = mermaid;
+  </script>
+  <script src="//unpkg.com/docsify-mermaid@2.0.1/dist/docsify-mermaid.js"></script>
 </body>
 
 </html>

technical.md

@@ -100,3 +100,13 @@ A `Kind 30078` is also created, which contains a link to the blossom server, and
 NIP-78 requires a d-tag to provide some application context.  To avoid revealing metadata, the d tag will be the first 32 chars of the encrypted result of the string "938" plus the users npub.  
 
 
+## File Types
+
+All data is stored either on the relay(s) or on the blossome server(s).  File types include the following:
+
+
+* App Metadata Event - the kind 30078 (NIP-78) that lives on the relay
+* App Data Object - the encrypted JSON file that lives on the blossom server
+* Sigit Data Object - the encrypted meta.json file that lives on blossom
+* Sigit Files Zip - the encrypted zip file with all the unchanged files, that lives on blossom
+* Sigit Notification Event - the NIP-17 nostr event that lives on the relay