update documentation

notebooks/Enrollment_Login_Renewal_Simplified.ipynb

@@ -2,6 +2,18 @@
  "cells": [
   {
    "cell_type": "code",
+   "execution_count": 30,
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2025-03-28T15:06:18.878127Z",
+     "start_time": "2025-03-28T15:06:18.874618Z"
+    },
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
+   "outputs": [],
    "source": [
     "import sys\n",
     "import os\n",
@@ -15,20 +27,11 @@
     "\n",
     "def random_username() -> str:\n",
     "    return \"test_username\" + \"\".join([choice(ascii_lowercase) for _ in range(6)])\n"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "ExecuteTime": {
-     "end_time": "2025-03-28T15:06:18.878127Z",
-     "start_time": "2025-03-28T15:06:18.874618Z"
-    }
-   },
-   "outputs": [],
-   "execution_count": 30
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "## Initialize nKode API and Create Customer\n",
     "#### nKode Customer\n",
@@ -39,6 +42,18 @@
   },
   {
    "cell_type": "code",
+   "execution_count": 31,
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2025-03-28T15:06:18.896461Z",
+     "start_time": "2025-03-28T15:06:18.891125Z"
+    },
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
+   },
+   "outputs": [],
    "source": [
     "api = NKodeAPI()\n",
     "policy = NKodePolicy(\n",
@@ -53,20 +68,11 @@
     ")\n",
     "customer_id = api.create_new_customer(keypad_size, policy)\n",
     "customer = api.get_customer(customer_id)"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "ExecuteTime": {
-     "end_time": "2025-03-28T15:06:18.896461Z",
-     "start_time": "2025-03-28T15:06:18.891125Z"
-    }
-   },
-   "outputs": [],
-   "execution_count": 31
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "## nKode Enrollment\n",
     "Users enroll in three steps:\n",
@@ -79,72 +85,72 @@
    ]
   },
   {
+   "cell_type": "code",
+   "execution_count": 32,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2025-03-28T15:06:18.914254Z",
      "start_time": "2025-03-28T15:06:18.911798Z"
     }
    },
-   "cell_type": "code",
+   "outputs": [],
    "source": [
     "username = random_username()\n",
     "signup_session_id, set_keypad = api.generate_signup_keypad(customer_id, username)"
-   ],
-   "outputs": [],
-   "execution_count": 32
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Set nKode\n",
     "The client receives `user_icons`, `set_signup_keypad`\n"
    ]
   },
   {
+   "cell_type": "code",
+   "execution_count": 33,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2025-03-28T15:06:18.931791Z",
      "start_time": "2025-03-28T15:06:18.929028Z"
     }
    },
-   "cell_type": "code",
+   "outputs": [],
    "source": [
     "passcode_len = 4\n",
     "passcode_property_indices = np.random.choice(set_keypad.reshape(-1), size=passcode_len, replace=False).tolist()\n",
     "selected_keys_set = select_keys_with_passcode_values(passcode_property_indices, set_keypad, keypad_size.numb_of_keys)"
-   ],
-   "outputs": [],
-   "execution_count": 33
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### Confirm nKode\n",
     "The user enter then submits their key entry. The server returns the confirm_keypad, another index array and dispersion of the set_keypad."
    ]
   },
   {
+   "cell_type": "code",
+   "execution_count": 34,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2025-03-28T15:06:19.247638Z",
      "start_time": "2025-03-28T15:06:18.938601Z"
     }
    },
-   "cell_type": "code",
+   "outputs": [],
    "source": [
     "confirm_keypad = api.set_nkode(customer_id, selected_keys_set, signup_session_id)\n",
     "selected_keys_confirm = select_keys_with_passcode_values(passcode_property_indices, confirm_keypad, keypad_size.numb_of_keys)\n",
     "success = api.confirm_nkode(customer_id, selected_keys_confirm, signup_session_id)\n",
     "assert success"
-   ],
-   "outputs": [],
-   "execution_count": 34
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "### User Login\n",
     "1. Get login keypad\n",
@@ -152,25 +158,25 @@
    ]
   },
   {
+   "cell_type": "code",
+   "execution_count": 35,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2025-03-28T15:06:19.559753Z",
      "start_time": "2025-03-28T15:06:19.254675Z"
     }
    },
-   "cell_type": "code",
+   "outputs": [],
    "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",
     "success = api.login(customer_id, username, selected_keys_login)\n",
     "assert success"
-   ],
-   "outputs": [],
-   "execution_count": 35
+   ]
   },
   {
-   "metadata": {},
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "## Renew Properties\n",
     "Replace server-side ciphers keys and nkode hash with new values.\n",
@@ -180,60 +186,60 @@
    ]
   },
   {
+   "cell_type": "code",
+   "execution_count": 36,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2025-03-28T15:06:20.181548Z",
      "start_time": "2025-03-28T15:06:19.568067Z"
     }
    },
-   "cell_type": "code",
+   "outputs": [],
    "source": [
     "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",
     "assert success"
-   ],
-   "outputs": [],
-   "execution_count": 36
+   ]
   },
   {
+   "cell_type": "code",
+   "execution_count": 37,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2025-03-28T15:06:20.500050Z",
      "start_time": "2025-03-28T15:06:20.194912Z"
     }
    },
-   "cell_type": "code",
+   "outputs": [],
    "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",
     "success = api.login(customer_id, username, selected_keys_login)\n",
     "assert success"
-   ],
-   "outputs": [],
-   "execution_count": 37
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.6"
+   "pygments_lexer": "ipython3",
+   "version": "3.10.14"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
+ "nbformat_minor": 4
 }