add renew

docs/templates/encipher_decipher_renew_nkode.template.md

@@ -204,5 +204,71 @@ block-beta
     
     suc(("success")) 
     comp --"Equal"--> suc
+```
+
+### Renew nKode
+
+nKode renewal is a three step process:
+1. Renew Customer Properties
+2. Renew User Keys
+3. Refresh User on Login
+
+
+{% set md_tick = '`' %}
+```mermaid
+    flowchart
+    subgraph Renew Customer Properties
+        old_prop["`old customer property key:<br/>{{old_props}}`"]
+        new_prop["`new customer property key:<br/>{{new_props}}`"]
+        old_pos["`old customer position key:<br/>{{old_pos}}`"]
+        new_pos["`new customer position key:<br/>{{new_pos}}`"]
+        xor1(("XOR"))
+        xor2(("XOR"))
+        xor_prop["`xor property key:<br/>{{xor_props}}`"]
+        xor_pos["`xor position key:<br/>{{xor_pos}}`"]
+        old_prop --> xor1
+        new_prop --> xor1
+        xor1 --> xor_prop
+        old_pos --> xor2
+        new_pos --> xor2
+        xor2 --> xor_pos
+    end
+    
+    subgraph Renew User Keys 
+        users@{shape: procs, label: "users"}
+        users --> eachuser 
+        subgraph eachuser [for each user]
+            subgraph old user keys 
+                old_user_pos["`combined position key:<br/>{{user_position_key}}`"]
+                old_user_prop["`property key:<br/>{{user_property_key}}`"]
+                old_renew["renew: False"] 
+            end
+            xor3(("XOR"))
+            xor4(("XOR"))
+            old_user_pos --> xor3
+            xor_pos --> xor3
+            xor3 --> inter_user_pos
+            old_user_prop --> xor4
+            xor_prop --> xor4
+            xor4 --> inter_user_prop
+            subgraph inter_user[intermediate user keys]
+                inter_user_pos["`combined position key:<br/>{{inter_user_position}}`"]
+                inter_user_prop["`property key:<br/>{{inter_user_property_key}}`"]
+                inter_renew["renew: True"]
+            end
+        end
+        
+    end
+    
+    subgraph Refresh User on Login
+        login["First login post renew"]
+        inter_user --> login
+        subgraph new_user [New User Keys]
+            new_user_pos["`combined position key:<br/>{{new_user_position}}`"]
+            new_user_prop["`property key:<br/>{{new_user_property_key}}`"]
+            new_renew["renew: False"]
+        end
+        login --> new_user
+    end
     
 ```