Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
docs/build/
docs/_build/
*.swp
__pycache__/
*.pyc
26 changes: 22 additions & 4 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,10 @@ a.headerlink { display: none; }
/* ── Product cards (full-width vertical rows) ─────────────────────────── */
#cryptnox-hardware-wallet,
#cryptnox-cli,
#cryptnox-sdk-for-python {
#cryptnox-sdk-for-python,
#cryptnox-sdk-for-esp32,
#cryptnox-sdk-for-arduino,
#cryptnox-sdk-for-c {
background: #fff;
border-bottom: 1px solid #e1e4e5;
padding: 1.5rem 0;
Expand Down Expand Up @@ -165,7 +168,10 @@ a.headerlink { display: none; }
/* ── Card heading (h2) ────────────────────────────────────────────────── */
#cryptnox-hardware-wallet h2,
#cryptnox-cli h2,
#cryptnox-sdk-for-python h2 {
#cryptnox-sdk-for-python h2,
#cryptnox-sdk-for-esp32 h2,
#cryptnox-sdk-for-arduino h2,
#cryptnox-sdk-for-c h2 {
font-size: 1.05rem;
font-weight: 700;
color: #2c3e50;
Expand All @@ -177,7 +183,10 @@ a.headerlink { display: none; }
/* ── Card description ─────────────────────────────────────────────────── */
#cryptnox-hardware-wallet p,
#cryptnox-cli p,
#cryptnox-sdk-for-python p {
#cryptnox-sdk-for-python p,
#cryptnox-sdk-for-esp32 p,
#cryptnox-sdk-for-arduino p,
#cryptnox-sdk-for-c p {
color: #6b7a8a;
font-size: 0.9rem;
line-height: 1.6;
Expand All @@ -189,6 +198,9 @@ a.headerlink { display: none; }
#cryptnox-hardware-wallet ul,
#cryptnox-cli ul,
#cryptnox-sdk-for-python ul,
#cryptnox-sdk-for-esp32 ul,
#cryptnox-sdk-for-arduino ul,
#cryptnox-sdk-for-c ul,
#other-resources ul {
list-style: disc !important;
padding-left: 1.5rem !important;
Expand All @@ -200,6 +212,9 @@ a.headerlink { display: none; }
#cryptnox-hardware-wallet ul li,
#cryptnox-cli ul li,
#cryptnox-sdk-for-python ul li,
#cryptnox-sdk-for-esp32 ul li,
#cryptnox-sdk-for-arduino ul li,
#cryptnox-sdk-for-c ul li,
#other-resources ul li {
list-style: disc !important;
margin-left: 0 !important;
Expand All @@ -208,7 +223,10 @@ a.headerlink { display: none; }

#cryptnox-hardware-wallet ul li p,
#cryptnox-cli ul li p,
#cryptnox-sdk-for-python ul li p {
#cryptnox-sdk-for-python ul li p,
#cryptnox-sdk-for-esp32 ul li p,
#cryptnox-sdk-for-arduino ul li p,
#cryptnox-sdk-for-c ul li p {
margin: 0;
color: #6b7a8a;
}
Expand Down
1 change: 0 additions & 1 deletion docs/source/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{%- if show_copyright %}
<p style="margin-bottom: 0.75rem;">&#169; Copyright {{ copyright }}.</p>
{%- endif %}
<a href="https://cryptnox.com/legal-notices/">Privacy Policy</a> &nbsp;|&nbsp; <a href="#">Cookie Policy</a>
5 changes: 4 additions & 1 deletion docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,10 @@
var items = [
{ anchor: '#cryptnox-hardware-wallet', title: 'Cryptnox Hardware Wallet' },
{ anchor: '#cryptnox-cli', title: 'Cryptnox CLI' },
{ anchor: '#cryptnox-sdk-for-python', title: 'Cryptnox SDK for Python' }
{ anchor: '#cryptnox-sdk-for-python', title: 'Cryptnox SDK for Python' },
{ anchor: '#cryptnox-sdk-for-esp32', title: 'Cryptnox SDK for ESP32' },
{ anchor: '#cryptnox-sdk-for-arduino', title: 'Cryptnox SDK for Arduino' },
{ anchor: '#cryptnox-sdk-for-c', title: 'Cryptnox SDK for C++' }
];

// Inject caption + nav items into the sidebar menu
Expand Down
100 changes: 90 additions & 10 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Cryptnox Hardware Wallet
certified secure element. It provides hardware-secured private key storage and transaction signing
for cryptocurrency applications over NFC and contact (T=1) interfaces.

* **Hardware Wallet Technical Reference** [`HTML <https://cryptnox.github.io/cryptnox-hardware-wallet/>`__]
* **Hardware Wallet Technical Reference** [`HTML <https://docs.cryptnox.com/cryptnox-hardware-wallet/>`__]


-------------------------
Expand All @@ -37,11 +37,11 @@ Cryptnox CLI
</svg>
</div>

*Cryptnox CLI* is a command-line tool for interacting with Cryptnox smartcards from the terminal.
It handles card initialization, secure channel establishment, PIN management, seed generation,
key derivation, and transaction signing through a straightforward command interface.
*Cryptnox CLI* brings full smartcard control to the terminal, handling card initialization, secure
channel setup, PIN management, seed generation, key derivation, and transaction signing through a
single command interface.

* **Cryptnox CLI User Guide** [`HTML <https://cryptnox.github.io/cryptnox-cli/>`__]
* **Cryptnox CLI User Guide** [`HTML <https://docs.cryptnox.com/cryptnox-cli/>`__]


-------------------------
Expand All @@ -59,12 +59,92 @@ Cryptnox SDK for Python
</svg>
</div>

*Cryptnox SDK for Python* is a library that enables developers to integrate Cryptnox smartcard
functionality into their own applications. It provides programmatic access to secure channel
establishment, APDU communication, key derivation, and signing operations, allowing custom
wallet software and automation workflows to leverage the card's hardware security.
*Cryptnox SDK for Python* brings Cryptnox smartcard support to the Python ecosystem, surfacing
secure channel, APDU exchange, key derivation, and signing through a clean Python API. It integrates
directly into desktop wallets, backend services, and automation workflows, adding hardware-secured
keys to any Python application.

* **Cryptnox SDK for Python** [`HTML <https://cryptnox.github.io/cryptnox-sdk-py/>`__]
* **Cryptnox SDK for Python** [`HTML <https://docs.cryptnox.com/cryptnox-sdk-py/>`__]


-------------------------


Cryptnox SDK for ESP32
=========================

.. raw:: html

<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<rect x="4" y="4" width="16" height="16" rx="2" ry="2"/>
<rect x="9" y="9" width="6" height="6"/>
<line x1="9" y1="1" x2="9" y2="4"/>
<line x1="15" y1="1" x2="15" y2="4"/>
<line x1="9" y1="20" x2="9" y2="23"/>
<line x1="15" y1="20" x2="15" y2="23"/>
<line x1="20" y1="9" x2="23" y2="9"/>
<line x1="20" y1="14" x2="23" y2="14"/>
<line x1="1" y1="9" x2="4" y2="9"/>
<line x1="1" y1="14" x2="4" y2="14"/>
</svg>
</div>

*Cryptnox SDK for ESP32* brings Cryptnox smartcard support to the ESP-IDF ecosystem, wrapping secure
channel, APDU exchange, key derivation, and signing into a ready-to-use component for the ESP32's
Wi-Fi/Bluetooth SoCs. Connected firmware gains hardware-secured key storage without ever handling the
card protocol directly.

* **Cryptnox SDK for ESP32** [`HTML <https://docs.cryptnox.com/cryptnox-sdk-esp32/>`__]


-------------------------


Cryptnox SDK for Arduino
=========================

.. raw:: html

<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<rect x="3" y="3" width="18" height="18" rx="2" ry="2"/>
<circle cx="8.5" cy="8.5" r="1.5"/>
<circle cx="15.5" cy="15.5" r="1.5"/>
<path d="M8.5 10v3.5h3.5"/>
<path d="M12 8.5h3.5V12"/>
</svg>
</div>

*Cryptnox SDK for Arduino* packages Cryptnox smartcard support as an Arduino library, exposing secure
channel, APDU exchange, key derivation, and signing through a sketch-friendly API. Installable
directly through the Arduino IDE and Library Manager, it adds hardware-secured keys to any board in
just a few lines of code.

* **Cryptnox SDK for Arduino** [`HTML <https://docs.cryptnox.com/cryptnox-sdk-arduino/>`__]


-------------------------


Cryptnox SDK for C++
=========================

.. raw:: html

<div class="card-icon">
<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<path d="M7 4a2 2 0 0 0-2 2v3a2 2 0 0 1-2 2 2 2 0 0 1 2 2v3a2 2 0 0 0 2 2"/>
<path d="M17 4a2 2 0 0 1 2 2v3a2 2 0 0 0 2 2 2 2 0 0 0-2 2v3a2 2 0 0 1-2 2"/>
</svg>
</div>

*Cryptnox SDK for C++* is the portable core at the heart of Cryptnox's embedded SDKs, implementing
secure channel, APDU exchange, key derivation, and signing in platform-neutral C++. Porting Cryptnox
support to a new native platform requires only a platform-specific transport layer built on top of
it.

* **Cryptnox SDK for C++** [`HTML <https://docs.cryptnox.com/cryptnox-sdk-cpp/>`__]


-------------------------
Expand Down
Loading