{
 "cells": [
  {
   "cell_type": "code",
   "source": [
    "from src.nkode_api import NKodeAPI\n",
    "from src.models import NKodePolicy, KeypadSize\n",
    "from secrets import choice\n",
    "from string import ascii_lowercase\n",
    "import numpy as np\n",
    "import bcrypt\n",
    "import hashlib\n",
    "import base64\n",
    "from IPython.display import Markdown, display\n",
    "\n",
    "def random_username() -> str:\n",
    "    return \"test_username\" + \"\".join([choice(ascii_lowercase) for _ in range(6)])\n",
    "\n",
    "\n",
    "def select_keys_with_passcode_values(user_passcode_idxs: list[int], keypad: np.ndarray, props_per_key: int) -> list[int]:\n",
    "    indices = [np.where(keypad == prop)[0][0] for prop in user_passcode_idxs]\n",
    "    return [int(index // props_per_key) for index in indices]\n",
    "\n",
    "\n",
    "def keypad_view(keypad: np.ndarray, props_per_key: int):\n",
    "    interface_keypad =  keypad.reshape(-1, props_per_key)\n",
    "    for idx, key_vals in enumerate(interface_keypad):\n",
    "        print(f\"Key {idx}: {key_vals}\")\n"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.080558Z",
     "start_time": "2025-03-20T15:13:44.076372Z"
    }
   },
   "outputs": [],
   "execution_count": 41
  },
  {
   "cell_type": "code",
   "source": [
    "api = NKodeAPI()\n",
    "user_icons = np.array([\n",
    "    \"😀\", \"😂\", \"🥳\", \"😍\", \"🤓\",\n",
    "    \"😎\", \"🥺\", \"😡\", \"😱\", \"🤯\",\n",
    "    \"🥰\", \"😴\", \"🤔\", \"🙃\", \"😇\",\n",
    "    \"🤖\", \"👽\", \"👾\", \"🐱\", \"🐶\",\n",
    "    \"🦁\", \"🐻\", \"🐸\", \"🐙\", \"🦄\",\n",
    "    \"🌟\", \"⚡\", \"🔥\", \"🍕\", \"🎉\"\n",
    "])"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.090939Z",
     "start_time": "2025-03-20T15:13:44.088281Z"
    }
   },
   "outputs": [],
   "execution_count": 42
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### nKode Customer\n",
    "An nKode customer is business has employees (users). An nKode API can service many customers each with their own users.\n",
    "Each customer specifies a keypad size and a nkode policy.\n",
    "The keypad can't be dispersable (`numb_of_keys < properties_per_key`)"
   ]
  },
  {
   "cell_type": "markdown",
   "source": [
    "#### Customer Cipher Keys\n",
    "Each customer has unique cipher keys.\n",
    "These keys are used to encipher and decipher a user's nKode.\n",
    "There are two types of Customer Cipher Keys:\n",
    "1. property key: Combined with the user property key to get the server-side representation of a users icons.\n",
    "2. position key: Combined with the user position key to get the server-side representation the position in each key.\n"
   ],
   "metadata": {
    "collapsed": false
   }
  },
  {
   "cell_type": "code",
   "source": [
    "policy = NKodePolicy(\n",
    "    max_nkode_len=10,\n",
    "    min_nkode_len=4,\n",
    "    distinct_positions=0,\n",
    "    distinct_properties=4,\n",
    ")\n",
    "keypad_size = KeypadSize(\n",
    "    numb_of_keys = 5,\n",
    "    props_per_key = 6\n",
    ")\n",
    "customer_id = api.create_new_customer(keypad_size, policy)\n",
    "customer = api.customers[customer_id]\n",
    "print(f\"Customer Position Key: {customer.cipher.position_key}\")\n",
    "print(f\"Customer Properties Key:\")\n",
    "customer_prop_keypad = customer.cipher.property_key.reshape(-1, keypad_size.props_per_key)\n",
    "for idx, key_vals in enumerate(customer_prop_keypad):\n",
    "    print(f\"{key_vals}\")\n",
    "position_properties_dict = dict(zip(customer.cipher.position_key, customer_prop_keypad.T))\n",
    "print(f\"Position to Properties Map:\")\n",
    "for pos_val, props in position_properties_dict.items():\n",
    "    print(f\"{pos_val}: {props}\")"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.107060Z",
     "start_time": "2025-03-20T15:13:44.100773Z"
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Customer Position Key: [22504 45127 46010 30773 46509 63084]\n",
      "Customer Properties Key:\n",
      "[38076  5253 43656 24035 57980 18197]\n",
      "[56754 21362 27799 42374 57145 46164]\n",
      "[56031 10476 13741 23847 57450 42577]\n",
      "[63205 55476 58864 29925  9463 58182]\n",
      "[61997 24583  9269 19956 55576 32892]\n",
      "Position to Properties Map:\n",
      "22504: [38076 56754 56031 63205 61997]\n",
      "45127: [ 5253 21362 10476 55476 24583]\n",
      "46010: [43656 27799 13741 58864  9269]\n",
      "30773: [24035 42374 23847 29925 19956]\n",
      "46509: [57980 57145 57450  9463 55576]\n",
      "63084: [18197 46164 42577 58182 32892]\n"
     ]
    }
   ],
   "execution_count": 43
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.127687Z",
     "start_time": "2025-03-20T15:13:44.125028Z"
    }
   },
   "cell_type": "code",
   "source": [
    "user_icon_keypad = user_icons.reshape(-1, keypad_size.props_per_key)\n",
    "pos_icons_dict = dict(zip(customer.cipher.position_key, user_icon_keypad.T))\n",
    "print(\"Position Value to Icons Map:\")\n",
    "for pos_val, icons in pos_icons_dict.items():\n",
    "    print(f\"{pos_val}: {icons}\")\n"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Position Value to Icons Map:\n",
      "22504: ['😀' '🥺' '🤔' '🐱' '🦄']\n",
      "45127: ['😂' '😡' '🙃' '🐶' '🌟']\n",
      "46010: ['🥳' '😱' '😇' '🦁' '⚡']\n",
      "30773: ['😍' '🤯' '🤖' '🐻' '🔥']\n",
      "46509: ['🤓' '🥰' '👽' '🐸' '🍕']\n",
      "63084: ['😎' '😴' '👾' '🐙' '🎉']\n"
     ]
    }
   ],
   "execution_count": 44
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### User Signup\n",
    "Users can create an nKode with these steps:\n",
    "1. Generate a randomly shuffled keypad\n",
    "2. Set user nKode\n",
    "3. Confirm user nKode\n",
    "\n",
    "#### Generate Keypad\n",
    " For the server to determine the users nKode, the user's keypad must be dispersable.\n",
    " To make the keypad dispersable, the server will randomly drop key positions so the number of properties per key is equal to the number of keys.\n",
    " In our case, the server drops 1 key position to give us a 5 X 5 keypad with possible index values ranging from 0-29.\n",
    "   - Run the cell below over and over to see it change. Notice that values never move out of their columns just their rows.\n",
    "   - each value in the keypad is the index value of a customer properties\n",
    "   - the user never learns their server-side properties"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.156638Z",
     "start_time": "2025-03-20T15:13:44.150222Z"
    }
   },
   "cell_type": "code",
   "source": [
    "signup_session_id, set_signup_keypad = api.generate_signup_keypad(customer_id)\n",
    "display(Markdown(\"\"\"### Icon Keypad\"\"\"))\n",
    "keypad_view(user_icons[set_signup_keypad], keypad_size.numb_of_keys)\n",
    "display(Markdown(\"\"\"### Index Keypad\"\"\"))\n",
    "keypad_view(set_signup_keypad, keypad_size.numb_of_keys)\n",
    "display(Markdown(\"\"\"### Customer Properties Keypad\"\"\"))\n",
    "keypad_view(customer.cipher.property_key[set_signup_keypad], keypad_size.numb_of_keys)"
   ],
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ],
      "text/markdown": "### Icon Keypad"
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Key 0: ['🦄' '🦁' '🐻' '🤓' '👾']\n",
      "Key 1: ['🥺' '⚡' '🔥' '🍕' '🎉']\n",
      "Key 2: ['🐱' '😱' '🤖' '👽' '🐙']\n",
      "Key 3: ['😀' '🥳' '😍' '🐸' '😴']\n",
      "Key 4: ['🤔' '😇' '🤯' '🥰' '😎']\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ],
      "text/markdown": "### Index Keypad"
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Key 0: [24 20 21  4 17]\n",
      "Key 1: [ 6 26 27 28 29]\n",
      "Key 2: [18  8 15 16 23]\n",
      "Key 3: [ 0  2  3 22 11]\n",
      "Key 4: [12 14  9 10  5]\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ],
      "text/markdown": "### Customer Properties Keypad"
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Key 0: [61997 58864 29925 57980 42577]\n",
      "Key 1: [56754  9269 19956 55576 32892]\n",
      "Key 2: [63205 27799 23847 57450 58182]\n",
      "Key 3: [38076 43656 24035  9463 46164]\n",
      "Key 4: [56031 13741 42374 57145 18197]\n"
     ]
    }
   ],
   "execution_count": 45
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Set nKode\n",
    "The client receives `user_icons`, `set_signup_keypad`\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.190448Z",
     "start_time": "2025-03-20T15:13:44.187214Z"
    }
   },
   "cell_type": "code",
   "source": [
    "username = random_username()\n",
    "passcode_len = 4\n",
    "passcode_property_indices = np.random.choice(set_signup_keypad.reshape(-1), size=passcode_len, replace=False).tolist()\n",
    "selected_keys_set = select_keys_with_passcode_values(passcode_property_indices, set_signup_keypad, keypad_size.numb_of_keys)\n",
    "print(f\"User Passcode Indices: {passcode_property_indices}\")\n",
    "print(f\"User Passcode Icons: {user_icons[passcode_property_indices]}\")\n",
    "print(f\"User Passcode Server-side properties: {customer.cipher.property_key[passcode_property_indices]}\")\n",
    "print(f\"Selected Keys: {selected_keys_set}\")"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "User Passcode Indices: [4, 9, 5, 18]\n",
      "User Passcode Icons: ['🤓' '🤯' '😎' '🐱']\n",
      "User Passcode Server-side properties: [57980 42374 18197 63205]\n",
      "Selected Keys: [0, 4, 4, 2]\n"
     ]
    }
   ],
   "execution_count": 46
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Confirm nKode\n",
    "Submit the set key entry to render the confirm keypad."
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.516570Z",
     "start_time": "2025-03-20T15:13:44.208909Z"
    }
   },
   "cell_type": "code",
   "source": [
    "confirm_keypad = api.set_nkode(username, customer_id, selected_keys_set, signup_session_id)\n",
    "keypad_view(confirm_keypad, keypad_size.numb_of_keys)\n",
    "selected_keys_confirm = select_keys_with_passcode_values(passcode_property_indices, confirm_keypad, keypad_size.numb_of_keys)\n",
    "print(f\"Selected Keys\\n{selected_keys_confirm}\")\n",
    "success = api.confirm_nkode(username, customer_id, selected_keys_confirm, signup_session_id)\n",
    "assert success"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Key 0: [18 20 27 10 11]\n",
      "Key 1: [24 14 15 22 29]\n",
      "Key 2: [12  2 21 28 23]\n",
      "Key 3: [ 0 26  9 16 17]\n",
      "Key 4: [6 8 3 4 5]\n",
      "Selected Keys\n",
      "[4, 3, 4, 0]\n"
     ]
    }
   ],
   "execution_count": 47
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": "### Inferring an nKode selection"
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.527802Z",
     "start_time": "2025-03-20T15:13:44.524844Z"
    }
   },
   "cell_type": "code",
   "source": [
    "for idx in range(passcode_len):\n",
    "    selected_key_set = selected_keys_set[idx]\n",
    "    selected_set_key_idx = set_signup_keypad.reshape(-1, keypad_size.numb_of_keys)[selected_key_set]\n",
    "    print(f\"Set Key     {idx}: {user_icons[selected_set_key_idx]}\")\n",
    "    selected_key_confirm = selected_keys_confirm[idx]\n",
    "    selected_confirm_key_idx = confirm_keypad.reshape(-1, keypad_size.numb_of_keys)[selected_key_confirm]\n",
    "    print(f\"Confirm Key {idx}: {user_icons[selected_confirm_key_idx]}\")\n",
    "    print(f\"Overlapping icon {user_icons[passcode_property_indices[idx]]}\")"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Set Key     0: ['🦄' '🦁' '🐻' '🤓' '👾']\n",
      "Confirm Key 0: ['🥺' '😱' '😍' '🤓' '😎']\n",
      "Overlapping icon 🤓\n",
      "Set Key     1: ['🤔' '😇' '🤯' '🥰' '😎']\n",
      "Confirm Key 1: ['😀' '⚡' '🤯' '👽' '👾']\n",
      "Overlapping icon 🤯\n",
      "Set Key     2: ['🤔' '😇' '🤯' '🥰' '😎']\n",
      "Confirm Key 2: ['🥺' '😱' '😍' '🤓' '😎']\n",
      "Overlapping icon 😎\n",
      "Set Key     3: ['🐱' '😱' '🤖' '👽' '🐙']\n",
      "Confirm Key 3: ['🐱' '🦁' '🔥' '🥰' '😴']\n",
      "Overlapping icon 🐱\n"
     ]
    }
   ],
   "execution_count": 48
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "## User Cipher\n",
    "\n",
    "Users have 4 cipher keys:\n",
    "1. property_key: The counterpart to the `customer_prop_key`. A user's server-side passcode is composed of elements in `user_prop_key XOR customer_prop_key`.\n",
    "2. pass_key: The passcode key is used to encipher user passcode\n",
    "3. combined_position_key: The combined position key is `user_pos_key XOR customer_pos_key`.\n",
    "4. mask_key: The mask key used to encipher user nKode\n",
    "\n",
    "\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.546871Z",
     "start_time": "2025-03-20T15:13:44.540903Z"
    }
   },
   "cell_type": "code",
   "source": [
    "from src.user_cipher import UserCipher\n",
    "user_cipher = UserCipher.create(keypad_size, customer.cipher.position_key, customer.nkode_policy.max_nkode_len)\n",
    "user_prop_key_keypad = user_cipher.property_key.reshape(-1, keypad_size.props_per_key)"
   ],
   "outputs": [],
   "execution_count": 49
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.565168Z",
     "start_time": "2025-03-20T15:13:44.562664Z"
    }
   },
   "cell_type": "code",
   "source": "print(f\"Property Key:\\n{user_prop_key_keypad}\")",
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Property Key:\n",
      "[[21364 17750 43270 40570  2897 64106]\n",
      " [64901 60553 23487 56910 22974 27412]\n",
      " [49276 36687 58910 60854 56432 64908]\n",
      " [17816  7963 33663 13564 43318 39697]\n",
      " [ 6300 40793 34908 48633 47026 16580]]\n"
     ]
    }
   ],
   "execution_count": 50
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.583641Z",
     "start_time": "2025-03-20T15:13:44.581757Z"
    }
   },
   "cell_type": "code",
   "source": "print(f\"Passcode Key: {user_cipher.pass_key}\")",
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Passcode Key: [65482 44549 30799 45221 44404  5844 32654 14244 48015 17243]\n"
     ]
    }
   ],
   "execution_count": 51
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.624946Z",
     "start_time": "2025-03-20T15:13:44.622774Z"
    }
   },
   "cell_type": "code",
   "source": "print(f\"Mask Key: {user_cipher.mask_key}\")",
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Mask Key: [36463 57168 30740 46459 21013 40282 33046 14986 26644    13]\n"
     ]
    }
   ],
   "execution_count": 52
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.653291Z",
     "start_time": "2025-03-20T15:13:44.651215Z"
    }
   },
   "cell_type": "code",
   "source": "print(f\"Combined Position Key: {user_cipher.combined_position_key}\")",
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Combined Position Key: [32765 21433 32527 38517 27021 45380]\n"
     ]
    }
   ],
   "execution_count": 53
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.682695Z",
     "start_time": "2025-03-20T15:13:44.680482Z"
    }
   },
   "cell_type": "code",
   "source": "print(f\"User Position Key = combined_pos_key XOR customer_pos_key: {user_cipher.combined_position_key ^ customer.cipher.position_key}\")",
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "User Position Key = combined_pos_key XOR customer_pos_key: [10261 58366 52405 60992 56352 18216]\n"
     ]
    }
   ],
   "execution_count": 54
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.713223Z",
     "start_time": "2025-03-20T15:13:44.710535Z"
    }
   },
   "cell_type": "code",
   "source": [
    "position_properties_dict = dict(zip(user_cipher.combined_position_key, user_prop_key_keypad.T))\n",
    "print(f\"Combined Position to Properties Map:\")\n",
    "for pos_val, props in position_properties_dict.items():\n",
    "    print(f\"{pos_val}: {props}\")"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Combined Position to Properties Map:\n",
      "32765: [21364 64901 49276 17816  6300]\n",
      "21433: [17750 60553 36687  7963 40793]\n",
      "32527: [43270 23487 58910 33663 34908]\n",
      "38517: [40570 56910 60854 13564 48633]\n",
      "27021: [ 2897 22974 56432 43318 47026]\n",
      "45380: [64106 27412 64908 39697 16580]\n"
     ]
    }
   ],
   "execution_count": 55
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "#### Encipher Mask\n",
    "1. Get the `padded_passcode_position_indices`; padded with random position indices to equal length `max_nkode_len`.\n",
    "2. Recover the `user_position_key`. Recall `user.cipher.combined_position_key = user_position_key XOR customer.cipher.positon_key`\n",
    "3. Order the `user_position_key` by the `padded_passcode_position_indices`\n",
    "4. Mask the `ordered_user_position_key`\n",
    "5. Base 64 encode the mask"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:44.732450Z",
     "start_time": "2025-03-20T15:13:44.729920Z"
    }
   },
   "cell_type": "code",
   "source": [
    "padded_passcode_position_indices = customer.cipher.get_passcode_position_indices_padded(list(passcode_property_indices), customer.nkode_policy.max_nkode_len)\n",
    "user_position_key = user_cipher.combined_position_key ^ customer.cipher.position_key\n",
    "ordered_user_position_key = user_position_key[padded_passcode_position_indices]\n",
    "mask = ordered_user_position_key ^ user_cipher.mask_key\n",
    "encoded_mask = user_cipher.encode_base64_str(mask)"
   ],
   "outputs": [],
   "execution_count": 56
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "#### Encipher Passcode\n",
    "1. Compute `combined_property_key`\n",
    "2. Recover `user_passcode = ordered_combined_proptery_key`; order by passcode_property_indices\n",
    "3. Zero pad `user_pascode`\n",
    "4. Encipher `user_passcode` with `user.cipher.pass_key`\n",
    "5. Hash `ciphered_passcode`"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:45.055535Z",
     "start_time": "2025-03-20T15:13:44.751147Z"
    }
   },
   "cell_type": "code",
   "source": [
    "combined_prop_key = customer.cipher.property_key ^ user_cipher.property_key\n",
    "user_passcode = combined_prop_key[passcode_property_indices]\n",
    "pad_len = customer.nkode_policy.max_nkode_len - passcode_len\n",
    "padded_passcode = np.concatenate((user_passcode, np.zeros(pad_len, dtype=user_passcode.dtype)))\n",
    "ciphered_passcode = padded_passcode ^ user_cipher.pass_key\n",
    "passcode_prehash = base64.b64encode(hashlib.sha256(ciphered_passcode.tobytes()).digest())\n",
    "passcode_hash = bcrypt.hashpw(passcode_prehash, bcrypt.gensalt(rounds=12)).decode(\"utf-8\")"
   ],
   "outputs": [],
   "execution_count": 57
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### User Login\n",
    "1. Get login keypad\n",
    "2. Select keys with passcode icons (in our case, passcode property indices)\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:45.367717Z",
     "start_time": "2025-03-20T15:13:45.061644Z"
    }
   },
   "cell_type": "code",
   "source": [
    "login_keypad = api.get_login_keypad(username, customer_id)\n",
    "keypad_view(login_keypad, keypad_size.props_per_key)\n",
    "selected_keys_login = select_keys_with_passcode_values(passcode_property_indices, login_keypad, keypad_size.props_per_key)\n",
    "print(f\"User Passcode: {passcode_property_indices}\\n\")\n",
    "print(f\"Selected Keys:\\n {selected_keys_login}\\n\")\n",
    "success = api.login(customer_id, username, selected_keys_login)\n",
    "assert success"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Key 0: [24 13 20 21  4 17]\n",
      "Key 1: [ 6  1 26 27 28 29]\n",
      "Key 2: [18  7  8 15 16 23]\n",
      "Key 3: [ 0 19  2  3 22 11]\n",
      "Key 4: [12 25 14  9 10  5]\n",
      "User Passcode: [4, 9, 5, 18]\n",
      "\n",
      "Selected Keys:\n",
      " [0, 4, 4, 2]\n",
      "\n"
     ]
    }
   ],
   "execution_count": 58
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "## Validate Login Key Entry\n",
    "- decipher user mask and recover nkode position values\n",
    "- get presumed properties from key selection and position values\n",
    "- compare with hash"
   ]
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Decipher Mask\n",
    "Recover nKode position values:\n",
    "- decode mask from base64 to int\n",
    "- ordered_user_position_key = mask ^ mask_key\n",
    "- user_position_key = user.cipher.co\n",
    "- deduce the set indices"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:45.379898Z",
     "start_time": "2025-03-20T15:13:45.377353Z"
    }
   },
   "cell_type": "code",
   "source": [
    "login_keypad = api.get_login_keypad(username, customer_id)\n",
    "selected_keys_login = select_keys_with_passcode_values(passcode_property_indices, login_keypad, keypad_size.props_per_key)\n",
    "user = api.customers[customer_id].users[username]\n",
    "mask = user.cipher.decode_base64_str(user.enciphered_passcode.mask)\n",
    "ordered_user_position_key = mask ^ user.cipher.mask_key\n",
    "user_position_key = customer.cipher.position_key ^ user.cipher.combined_position_key"
   ],
   "outputs": [],
   "execution_count": 59
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "#### Get Presumed Properties\n",
    "- Get the passcode position indices (within the keys)\n",
    "- Get the presumed property indices from the key and position within the key"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:45.391901Z",
     "start_time": "2025-03-20T15:13:45.389499Z"
    }
   },
   "cell_type": "code",
   "source": [
    "passcode_position_indices = [int(np.where(user_position_key == pos)[0][0]) for pos in ordered_user_position_key[:passcode_len]]\n",
    "presumed_property_indices = customer.users[username].user_keypad.get_prop_idxs_by_keynumb_setidx(selected_keys_login, passcode_position_indices)\n",
    "assert passcode_property_indices == presumed_property_indices\n"
   ],
   "outputs": [],
   "execution_count": 60
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": "### Compare Enciphered Passcodes\n"
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:45.711702Z",
     "start_time": "2025-03-20T15:13:45.407474Z"
    }
   },
   "cell_type": "code",
   "source": [
    "valid_nkode = user.cipher.compare_nkode(presumed_property_indices, customer.cipher, user.enciphered_passcode.code)\n",
    "assert valid_nkode"
   ],
   "outputs": [],
   "execution_count": 61
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "## Renew Properties\n",
    "1. Renew Customer Properties\n",
    "2. Renew User Keys\n",
    "3. Refresh User on Login\n",
    "\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:46.331470Z",
     "start_time": "2025-03-20T15:13:45.715778Z"
    }
   },
   "cell_type": "code",
   "source": [
    "def print_user_enciphered_code():\n",
    "    mask = api.customers[customer_id].users[username].enciphered_passcode.mask\n",
    "    code = api.customers[customer_id].users[username].enciphered_passcode.code\n",
    "    print(f\"mask: {mask}, code: {code}\\n\")\n",
    "\n",
    "print(\"Old User Cipher and Mask\")\n",
    "print_user_enciphered_code()\n",
    "api.renew_keys(customer_id) # Steps 1 and 2\n",
    "login_keypad = api.get_login_keypad(username, customer_id)\n",
    "selected_keys_login = select_keys_with_passcode_values(passcode_property_indices, login_keypad, keypad_size.props_per_key)\n",
    "success = api.login(customer_id, username, selected_keys_login) # Step 3\n",
    "print(\"New User Cipher and Mask\")\n",
    "print_user_enciphered_code()\n",
    "assert success"
   ],
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Old User Cipher and Mask\n",
      "mask: xetVN/8taK1lhtrDjt4w0M4pprQ=, code: $2b$12$6JzDrPs.dAb0iOIvm8afKuwf.Z8qKtg89Nnhx..tlBOD5y1MYMR4y\n",
      "\n",
      "New User Cipher and Mask\n",
      "mask: WsKTIcZVngijEKlMfoF2UG5Rz9I=, code: $2b$12$jvQ..z4tPFII5dLXP0D2LOPrypDSB7yoRH6E0SZPO/yIIcZVtgCTS\n",
      "\n"
     ]
    }
   ],
   "execution_count": 62
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Renew Customer Keys\n",
    "The customer cipher keys are replaced."
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:46.344092Z",
     "start_time": "2025-03-20T15:13:46.339802Z"
    }
   },
   "cell_type": "code",
   "source": [
    "old_props = customer.cipher.property_key.copy()\n",
    "old_pos = customer.cipher.position_key.copy()\n",
    "customer.cipher.property_key = np.random.choice(2 ** 16, size=keypad_size.total_props, replace=False)\n",
    "customer.cipher.position_key = np.random.choice(2 ** 16, size=keypad_size.props_per_key, replace=False)\n",
    "new_props = customer.cipher.property_key\n",
    "new_pos = customer.cipher.position_key"
   ],
   "outputs": [],
   "execution_count": 63
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Renew User\n",
    "User property and position keys go through an intermediate phase.\n",
    "#### user.cipher.combined_position_key\n",
    "- user_combined_position_key = user_combined_position_key XOR  pos_xor\n",
    "- user_combined_position_key = (user_position_key XOR old_customer_position_key) XOR (old_customer_position_key XOR new_customer_position_key)\n",
    "- user_combined_position_key = user_position_key XOR new_customer_position_key\n",
    "#### user.cipher.combined_position_key\n",
    "- user_property_key = user_property_key XOR props_xor\n",
    "- user_property_key = user_property_key XOR old_customer_property_key XOR new_customer_property_key\n"
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:46.361420Z",
     "start_time": "2025-03-20T15:13:46.359046Z"
    }
   },
   "cell_type": "code",
   "source": [
    "props_xor = new_props ^ old_props\n",
    "pos_xor = new_pos ^ old_pos\n",
    "for user in customer.users.values():\n",
    "    user.renew = True\n",
    "    user.cipher.combined_position_key = user.cipher.combined_position_key ^ pos_xor\n",
    "    user.cipher.property_key = user.cipher.property_key ^ props_xor"
   ],
   "outputs": [],
   "execution_count": 64
  },
  {
   "metadata": {},
   "cell_type": "markdown",
   "source": [
    "### Refresh User Keys\n",
    "After a user's first successful login, the renew flag is checked. If it's true, the user's cipher is replaced with a new cipher."
   ]
  },
  {
   "metadata": {
    "ExecuteTime": {
     "end_time": "2025-03-20T15:13:46.679562Z",
     "start_time": "2025-03-20T15:13:46.371777Z"
    }
   },
   "cell_type": "code",
   "source": [
    "if user.renew:\n",
    "    user.cipher = UserCipher.create(\n",
    "        customer.cipher.keypad_size,\n",
    "        customer.cipher.position_key,\n",
    "        user.cipher.max_nkode_len\n",
    "    )\n",
    "    user.enciphered_passcode = user.cipher.encipher_nkode(presumed_property_indices, customer.cipher)\n",
    "    user.renew = False"
   ],
   "outputs": [],
   "execution_count": 65
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}