diff options
| author | Hubert Kario <hubert@kario.pl> | 2021-08-13 14:50:01 +0200 |
|---|---|---|
| committer | Hubert Kario <hkario@redhat.com> | 2022-07-08 14:21:12 +0200 |
| commit | af73018c75f2e250b38327bc7c5793e59b5d8d18 (patch) | |
| tree | 67daeb71161ff22747cd279a0fb1eda87c53f46b | |
| parent | 29a3cd05f60644ac1962f2cc5227f8bb4344a73a (diff) | |
| download | ecdsa-af73018c75f2e250b38327bc7c5793e59b5d8d18.tar.gz | |
docs: general project description
| -rw-r--r-- | docs/source/index.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 9aa5b3f..1fb7c17 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,6 +6,20 @@ Welcome to python-ecdsa's documentation! ======================================== +``ecdsa`` implements +`elliptic-curve cryptography (ECC) <https://en.wikipedia.org/wiki/Elliptic-curve_cryptography>`_, +more specifically the +`Elliptic Curve Digital Signature Algorithm (ECDSA) <https://en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm>`_ +and the +`Elliptic Curve Diffie-Hellman (ECDH) <https://en.wikipedia.org/wiki/Elliptic-curve_Diffie%E2%80%93Hellman>`_ +algorithms. +Both of those algorithms are used in many protocols in practice, like +in +`TLS <https://en.wikipedia.org/wiki/Transport_Layer_Security>`_ +or +`SSH <https://en.wikipedia.org/wiki/Secure_Shell_Protocol>`_. + + .. toctree:: :maxdepth: 2 :caption: Contents: |