aboutsummaryrefslogtreecommitdiff
path: root/openssl/src
diff options
context:
space:
mode:
authorAndy Gauge <[email protected]>2017-10-11 13:04:53 -0700
committerAndy Gauge <[email protected]>2017-10-11 13:04:53 -0700
commita62069cef90737558d14d440b0e14748f8b141fe (patch)
tree766eeaa2cf39bc1419ef5a08e2cd599c026a6c5e /openssl/src
parentMerge branch 'master' of https://github.com/sfackler/rust-openssl (diff)
downloadrust-openssl-a62069cef90737558d14d440b0e14748f8b141fe.tar.xz
rust-openssl-a62069cef90737558d14d440b0e14748f8b141fe.zip
Began EC documenation
Diffstat (limited to 'openssl/src')
-rw-r--r--openssl/src/ec.rs10
1 files changed, 10 insertions, 0 deletions
diff --git a/openssl/src/ec.rs b/openssl/src/ec.rs
index 02be6d22..c6012050 100644
--- a/openssl/src/ec.rs
+++ b/openssl/src/ec.rs
@@ -1,3 +1,13 @@
+//! Elliptic Curve
+//!
+//! Cryptology relies on the difficulty of solving mathematical problems, such as the factor
+//! of large integers composed of two large prime numbers and the discrete logarithm of a
+//! random eliptic curve. This module provides low-level features of the latter.
+//! Elliptic Curve protocols can provide the same security with smaller keys.
+//!
+//! There are 2 forms of elliptic curves, `Fp` and `F2^m`. These curves use irreducible
+//! trinomial or pentanomial. Being a generic interface to a wide range of algorithms,
+//! the cuves are generally referenced by [`EcGroup`]
use ffi;
use foreign_types::{ForeignType, ForeignTypeRef};
use std::ptr;