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
44 changes: 44 additions & 0 deletions docs/source/_extra/llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Cryptnox Product Documentation

> Official technical documentation for Cryptnox SA (Carouge, Geneva,
> Switzerland) — NFC smart cards for hardware wallets, FIDO2 authentication and
> PIV identity, plus SDKs, CLI tools and hardware reference material.
> Main website: https://www.cryptnox.com — Shop: https://shop.cryptnox.com
> Source code: https://github.com/cryptnox

Cryptnox security devices are smart cards: the hardware wallet, FIDO2 and PIV
products are ISO/IEC 7816 contact and ISO/IEC 14443 contactless (NFC) cards.
Cryptnox also sells USB smart card readers (USB-A, USB-C CCID and
NFC/contactless models) for using the cards with a computer — see
https://shop.cryptnox.com. The hardware wallet card also carries the FIDO
Alliance certified FIDO2 and U2F applets (FIDO2 CTAP2.1, Level 1), so it
doubles as a FIDO2 security key.

## Hardware Wallet Technical Reference

- [Hardware Wallet v2.0 (HTML)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/): technical specifications, lifecycle management, secure channel, authentication, seed management, key derivation, EC signatures, MuSig2 (BIP-327) commands, status codes, security model, supported algorithms and curves, JavaCard platform details
- [Hardware Wallet v2.0 (PDF)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/cryptnox-hardware-wallet-v2.0.pdf)
- [Hardware Wallet v1.6 (HTML)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/)
- [Hardware Wallet v1.6 (PDF)](https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/cryptnox-hardware-wallet-v1.6.pdf)

## Command-line tool

- [Cryptnox CLI User Guide (HTML)](https://docs.cryptnox.com/cryptnox-cli/): installation, supported hardware, command reference, interactive mode, BIP39 passphrase support, exit codes, examples
- [Cryptnox CLI User Guide (PDF)](https://docs.cryptnox.com/cryptnox-cli/cryptnox-cli.pdf)

## SDKs

- [Python SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-py/): API reference for the cryptnox_sdk_py package, class diagrams, connection components, reader hierarchy
- [Python SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-py/cryptnox-sdk-py.pdf)
- [ESP32 SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-esp32/)
- [ESP32 SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-esp32/cryptnox-sdk-esp32.pdf)
- [Arduino SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-arduino/)
- [Arduino SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-arduino/cryptnox-sdk-arduino.pdf)
- [C++ SDK (HTML)](https://docs.cryptnox.com/cryptnox-sdk-cpp/)
- [C++ SDK (PDF)](https://docs.cryptnox.com/cryptnox-sdk-cpp/cryptnox-sdk-cpp.pdf)

## Optional

- [Documentation index](https://docs.cryptnox.com/)
- [Cryptnox website](https://www.cryptnox.com)
- [Cryptnox on GitHub](https://github.com/cryptnox)
5 changes: 5 additions & 0 deletions docs/source/_extra/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
User-agent: *
Allow: /

Sitemap: https://docs.cryptnox.com/sitemap.xml
Sitemap: https://docs.cryptnox.com/sitemap-docs.xml
19 changes: 19 additions & 0 deletions docs/source/_extra/sitemap-docs.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url><loc>https://docs.cryptnox.com/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/cryptnox-hardware-wallet-v2.0.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/cryptnox-hardware-wallet-v1.6.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-cli/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-cli/cryptnox-cli.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-py/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-py/cryptnox-sdk-py.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-esp32/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-esp32/cryptnox-sdk-esp32.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-arduino/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-arduino/cryptnox-sdk-arduino.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-cpp/</loc></url>
<url><loc>https://docs.cryptnox.com/cryptnox-sdk-cpp/cryptnox-sdk-cpp.pdf</loc></url>
<url><loc>https://docs.cryptnox.com/genindex.html</loc></url>
</urlset>
34 changes: 18 additions & 16 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@
<meta property="og:url" content="{{ canonical_url }}" />
<meta property="og:title" content="{{ title|striptags }} | Cryptnox Docs" />
<meta property="og:description" content="Access the official Cryptnox technical documentation. Explore setup guides, features, and integration details for secure and efficient solutions." />
<meta property="og:image" content="https://docs.cryptnox.com/wp-content/uploads/2025/08/Technical-Documentation-1024x538.png" />
<meta property="og:image:width" content="1024" />
<meta property="og:image:height" content="538" />
<meta property="og:image" content="https://cryptnox.com/wp-content/uploads/2024/07/cropped-Group_17_430x.webp" />
<meta property="og:image:width" content="512" />
<meta property="og:image:height" content="512" />
<meta property="og:site_name" content="Cryptnox Docs" />

<!-- Twitter Card -->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="@CryptnoxTech" />
<meta name="twitter:title" content="{{ title|striptags }} | Cryptnox Docs" />
<meta name="twitter:description" content="Access the official Cryptnox technical documentation. Explore setup guides, features, and integration details for secure and efficient solutions." />
<meta name="twitter:image" content="https://docs.cryptnox.com/wp-content/uploads/2025/08/Technical-Documentation-1024x538.png" />
<meta name="twitter:image" content="https://cryptnox.com/wp-content/uploads/2024/07/cropped-Group_17_430x.webp" />

<!-- JSON-LD Structured Data -->
<script type="application/ld+json">
Expand All @@ -32,26 +32,28 @@
"@graph": [
{
"@type": "Organization",
"@id": "https://docs.cryptnox.com/#organization",
"name": "Cryptnox Docs",
"@id": "https://cryptnox.com/#organization",
"name": "Cryptnox SA",
"url": "https://cryptnox.com/",
"logo": {
"@type": "ImageObject",
"@id": "https://docs.cryptnox.com/#logo",
"url": "https://docs.cryptnox.com/wp-content/uploads/2025/07/cryptnox-logo.png",
"contentUrl": "https://docs.cryptnox.com/wp-content/uploads/2025/07/cryptnox-logo.png",
"caption": "Cryptnox Docs",
"inLanguage": "en-US",
"width": "380",
"height": "71"
}
"url": "https://docs.cryptnox.com/_static/cryptnox-logo.svg",
"contentUrl": "https://docs.cryptnox.com/_static/cryptnox-logo.svg",
"caption": "Cryptnox"
},
"sameAs": [
"https://shop.cryptnox.com/",
"https://github.com/cryptnox"
]
},
{
"@type": "WebSite",
"@id": "https://docs.cryptnox.com/#website",
"url": "https://docs.cryptnox.com",
"name": "Cryptnox Docs",
"alternateName": "Cryptnox",
"publisher": { "@id": "https://docs.cryptnox.com/#organization" },
"publisher": { "@id": "https://cryptnox.com/#organization" },
"inLanguage": "en-US"
},
{
Expand All @@ -61,9 +63,9 @@
"name": "Cryptnox Product Documentation",
"description": "Access the official Cryptnox technical documentation. Explore setup guides, features, and integration details for secure and efficient solutions.",
"isPartOf": { "@id": "https://docs.cryptnox.com/#website" },
"publisher": { "@id": "https://docs.cryptnox.com/#organization" },
"publisher": { "@id": "https://cryptnox.com/#organization" },
"inLanguage": "en-US",
"keywords": "Cryptnox, hardware wallet, CLI, SDK, documentation"
"keywords": "Cryptnox, hardware wallet, FIDO2, smart card, secure element, MuSig2, CLI, SDK, documentation"
}
]
}
Expand Down
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

html_meta = {
'description': 'Access the official Cryptnox technical documentation. Explore setup guides, features, and integration details for secure and efficient solutions.',
'keywords': 'Cryptnox, hardware wallet, smartcard, JavaCard, CLI, SDK, documentation, BIP32, ECDSA, NFC, secure element',
'keywords': 'Cryptnox, hardware wallet, smartcard, JavaCard, CLI, SDK, documentation, BIP32, ECDSA, NFC, secure element, FIDO2, MuSig2, BIP-327, secp256k1',
'author': 'Cryptnox',
'robots': 'index, follow, max-snippet:-1, max-video-preview:-1, max-image-preview:large',
}
Expand All @@ -33,6 +33,7 @@

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
html_extra_path = ['_extra'] # robots.txt, llms.txt, sitemap-docs.xml copied to site root
html_logo = '_static/cryptnox-logo.svg'
html_favicon = '_static/favicon.png'

Expand Down
12 changes: 11 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@ Cryptnox Hardware Wallet

*Cryptnox Hardware Wallet* is a JavaCard Open Platform 3 smartcard with an EAL6+ Common Criteria
certified secure element. It provides hardware-secured private key storage and transaction signing
for cryptocurrency applications over NFC and contact (T=1) interfaces.
for cryptocurrency applications over NFC and contact (T=1) interfaces. The technical reference
covers lifecycle management, the secure channel, seed management, BIP32 key derivation, EC
signatures on secp256k1 and NIST P-256, and MuSig2 (BIP-327) multi-signature commands.

The same card also carries the FIDO Alliance certified FIDO2 and U2F applets (FIDO2 CTAP2.1,
Level 1), so the wallet card doubles as a FIDO2 security key for passkeys and strong
authentication alongside its wallet function.

* **Hardware Wallet Technical Reference v2.0** [`HTML <https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/>`__] [`PDF <https://docs.cryptnox.com/cryptnox-hardware-wallet/v2.0/cryptnox-hardware-wallet-v2.0.pdf>`__]
* **Hardware Wallet Technical Reference v1.6** [`HTML <https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/>`__] [`PDF <https://docs.cryptnox.com/cryptnox-hardware-wallet/v1.6/cryptnox-hardware-wallet-v1.6.pdf>`__]
Expand Down Expand Up @@ -145,6 +151,10 @@ Other resources

* `Cryptnox Website <https://www.cryptnox.com>`_
* `Cryptnox on GitHub <https://github.com/cryptnox>`_
* `Hardware Wallet Card — product page <https://shop.cryptnox.com/product/hardware-wallet-smartcard-dual/>`_
* `FIDO2 & MIFARE DESFire Card — product page <https://shop.cryptnox.com/product/cryptnox-smartcard-fido2/>`_
* `FIDO2 Card Technical Specifications <https://cryptnox.com/cryptnox-fido2-card-technical-specifications/>`_
* `Contact Cryptnox <https://cryptnox.com/contact/>`_

|

Expand Down
Loading