aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJ08nY2024-07-24 18:41:17 +0200
committerJ08nY2024-07-24 18:41:17 +0200
commitfd4e4f7d03fc407392696ee4972079ba592f62ec (patch)
treebce08fa5d9f124a27024ab7a9bc8631cf507f8ea
parent24d1ba404d7b0e0ebcb9b8e64fb797ca66cb6f48 (diff)
downloadpyecsca-notebook-fd4e4f7d03fc407392696ee4972079ba592f62ec.tar.gz
pyecsca-notebook-fd4e4f7d03fc407392696ee4972079ba592f62ec.tar.zst
pyecsca-notebook-fd4e4f7d03fc407392696ee4972079ba592f62ec.zip
Add more links to docs.
-rw-r--r--codegen.ipynb4
-rw-r--r--configuration_space.ipynb6
-rw-r--r--re/formulas.ipynb2
-rw-r--r--simulation.ipynb2
4 files changed, 7 insertions, 7 deletions
diff --git a/codegen.ipynb b/codegen.ipynb
index a54b42d..04dca39 100644
--- a/codegen.ipynb
+++ b/codegen.ipynb
@@ -7,7 +7,7 @@
"# Code generation\n",
"\n",
"**pyecsca** can generate C implementations of ECC crypto for several microprocessor targets, which\n",
- "are defined by the `Platform` enum."
+ "are defined by the [Platform](../api/pyecsca.codegen.common.rst#pyecsca.codegen.common.Platform) enum."
]
},
{
@@ -27,7 +27,7 @@
"metadata": {},
"source": [
"To generate an implementation we need an actual configuration which the implementation should\n",
- "implement, which is stored inside the `Configuration` and `DeviceConfiguration` classes. "
+ "implement, which is stored inside the [Configuration](../api/pyecsca.ec.configuration.rst#pyecsca.ec.configuration.Configuration) and [DeviceConfiguration](../api/pyecsca.codegen.common.rst#pyecsca.codegen.common.DeviceConfiguration) classes. "
]
},
{
diff --git a/configuration_space.ipynb b/configuration_space.ipynb
index cc5e636..854b51b 100644
--- a/configuration_space.ipynb
+++ b/configuration_space.ipynb
@@ -43,7 +43,7 @@
{
"cell_type": "markdown",
"metadata": {},
- "source": "It is represented by the [`Configuration`](api/pyecsca.ec.configuration.rst#pyecsca.ec.configuration.Configuration) class."
+ "source": "It is represented by the [Configuration](../api/pyecsca.ec.configuration.rst#pyecsca.ec.configuration.Configuration) class."
},
{
"cell_type": "markdown",
@@ -51,7 +51,7 @@
"source": [
"## Enumerating configurations\n",
"\n",
- "The possible configurations can be generated using the [`all_configurations()`](api/pyecsca.ec.configuration.html#pyecsca.ec.configuration.all_configurations) function.\n",
+ "The possible configurations can be generated using the [all_configurations()](../api/pyecsca.ec.configuration.rst#pyecsca.ec.configuration.all_configurations) function.\n",
"The whole space of configurations is quite huge.\n",
"\n",
"<div class=\"alert alert-warning\">\n",
@@ -151,7 +151,7 @@
"metadata": {},
"source": [
"We see that when we fixed all parameters except for the scalar multiplier arguments \n",
- "(see the [`LTRMultiplier`](api/pyecsca.ec.mult.binary.html#pyecsca.ec.mult.binary.LTRMultiplier) constructor) we obtained 1280 configurations. That number expresses all of the possible ways to use addition formulas for the `projective` coordinate system in the binary left-to-right multiplier as well as internal options of that multiplier:\n",
+ "(see the [LTRMultiplier](../api/pyecsca.ec.mult.binary.rst#pyecsca.ec.mult.binary.LTRMultiplier) constructor) we obtained 1280 configurations. That number expresses all of the possible ways to use addition formulas for the `projective` coordinate system in the binary left-to-right multiplier as well as internal options of that multiplier:\n",
"\n",
" - whether it is \"complete\" in a sense that it starts processing at a constant bit (the bit-length od the order)\n",
" - whether it is \"double-and-add-always\"\n",
diff --git a/re/formulas.ipynb b/re/formulas.ipynb
index 39e1cfc..c6bc76f 100644
--- a/re/formulas.ipynb
+++ b/re/formulas.ipynb
@@ -87,7 +87,7 @@
"metadata": {},
"source": [
"## The formulas\n",
- "The following formulas were collected from open-source cryptographic libraries and are stored in the core package of the **pyecsca** toolkit. For a full overview of implementation choices done by open-source ECC libraries, see [this page](libraries.html)."
+ "The following formulas were collected from open-source cryptographic libraries and are stored in the core package of the **pyecsca** toolkit. For a full overview of implementation choices done by open-source ECC libraries, see [this page](/libraries.rst)."
]
},
{
diff --git a/simulation.ipynb b/simulation.ipynb
index 97db137..97a0880 100644
--- a/simulation.ipynb
+++ b/simulation.ipynb
@@ -6,7 +6,7 @@
"source": [
"# Simulation\n",
"\n",
- "**pyecsca** is able to simulate computation of key generation, ECDH and ECDSA while tracing particular actions performed by the implementation as well as intermediate values. These traces are collected by the context (see the `Context` and `DefaultContext` classes). There is always one context active. For performance reasons, by default no context is active.\n",
+ "**pyecsca** is able to simulate computation of key generation, ECDH and ECDSA while tracing particular actions performed by the implementation as well as intermediate values. These traces are collected by the context (see the [Context](../api/pyecsca.ec.context.rst#pyecsca.ec.context.Context) and [DefaultContext](../api/pyecsca.ec.context.rst#pyecsca.ec.context.DefaultContext) classes). There is always one context active. For performance reasons, by default no context is active.\n",
"\n",
"These traces are useful for attacks which rely on computing particular intermediate values during the ECC computation."
]