Skip to content

Commit

Permalink
Adding some front-end documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@armfazh
armfazh committed Mar 3, 2020
1 parent 7ce4815 commit c2db7da
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 150 deletions.
144 changes: 1 addition & 143 deletions examples/call01.rs
View file
Original file line number Diff line number Diff line change
@@ -1,91 +1,16 @@
// use num_traits::identities::Zero;
use std::convert::From;

use num_bigint::BigUint;
// use num_integer::Integer;

// use redox_ecc::edwards;
// use redox_ecc::edwards::EDWARDS448;
// use redox_ecc::field::{FpElt, PrimeField};
// use redox_ecc::montgomery;
// use redox_ecc::montgomery::CURVE25519;
use redox_ecc::montgomery;
use redox_ecc::version;
use redox_ecc::weierstrass;
// // use redox_ecc::weierstrass::ProyCoordinates;
// // use redox_ecc::h2c;
// use redox_ecc::h2c::EncodeToCurve;
//
// use redox_ecc::h2c::{HashID, HashToField};
use redox_ecc::ellipticcurve::EllipticCurve;
use redox_ecc::field::{FromFactory, Sqrt};
// use redox_ecc::h2c::EncodeToCurve;
// use redox_ecc::montgomery::{
// CURVE25519_SHA256_ELL2_NU_, CURVE25519_SHA256_ELL2_RO_, CURVE25519_SHA512_ELL2_NU_,
// CURVE25519_SHA512_ELL2_RO_, CURVE448_SHA512_ELL2_NU_, CURVE448_SHA512_ELL2_RO_,
// };
use redox_ecc::h2c::HashToCurve;
use redox_ecc::instances::{P256, P384};
use redox_ecc::primefield::Fp;
use redox_ecc::suites::{
EDWARDS25519_SHA256_EDELL2_NU_, EDWARDS25519_SHA256_EDELL2_RO_, EDWARDS25519_SHA512_EDELL2_NU_,
EDWARDS25519_SHA512_EDELL2_RO_, EDWARDS448_SHA512_EDELL2_NU_, EDWARDS448_SHA512_EDELL2_RO_,
P256_SHA256_SSWU_NU_, P384_SHA512_SSWU_NU_, P521_SHA512_SSWU_NU_,
};
use redox_ecc::version;

fn main() {
println!("{}", version());
println!("Example!");

let f = Fp::new(BigUint::from(11u32));
let x = f.from(5);
let y = f.from(7);
let z = (x * y).is_square();
println!("z: {} ", z);
/*
let f = Fp::create(BigUint::from(53u64));
let a = f.from(-3);
let b = f.from(6);
let r = BigUint::from(41u64);
println!("F: {}", f);
println!("a: {} ", a);
println!("b: {} ", b);
println!("r: {} ", r);
let curve = weierstrass::Curve { f, a, b, r };
println!("E: {} ", curve);
let g0 = curve.new_point(weierstrass::Coordinates {
x: curve.f.from(41u64),
y: curve.f.from(13u64),
z: curve.f.one(),
});
let g1 = curve.new_point(weierstrass::Coordinates {
x: curve.f.from(41u64),
y: curve.f.from(13u64),
z: curve.f.one(),
});
println!("g0: {} ", g0);
println!("g1: {} ", g1);
let g2 = g0 + g1;
println!("g2: {} ", g2);
let uno = curve.new_scalar(BigInt::from(1153i64));
let mut g3 = &uno * &g2;
g3.normalize();
println!("g3: {} ", g3);
let mut g4 = g2 * &uno;
g4.normalize();
println!("g4: {} ", g4);
for (i, ki) in uno.iter_lr().enumerate() {
println!("i: {}, ki: {:?}", i, ki);
}
for (i, ki) in uno.iter_rl().enumerate() {
println!("i: {}, ki: {:?}", i, ki);
}
*/

// println!("N: {} ", &a);
// println!("N: {} ", &b);
// println!("N: {} ", b.sqrt());
let ec = P256.get();
let g0 = ec.get_generator();
let g1 = ec.get_generator();
Expand All @@ -111,71 +36,4 @@ fn main() {
p.normalize();
println!("enc: {} {} ", suite, p);
}
// println!("G: {} ", g2 + g3);
// let g2 = ec.get_generator();
// let g3 = ec.get_generator();
//
// let a = &g0 + &g1;
// println!("G: {} ", a);
// let b = g0 + &g1;
// println!("G: {} ", b);
// let c = &g1 + g2;
// println!("G: {} ", c);
// let d = g3 + g1;
// println!("G: {} ", d);

// let f = ec.get_field();
//
// let a = f.hash(HashID::SHA256, msg, dst, 0u8, 48usize);
// println!("a: {} ", f);
// println!("a: {} ", a);

// let suites = vec![
// CURVE25519_SHA256_ELL2_NU_,
// CURVE25519_SHA256_ELL2_RO_,
// CURVE25519_SHA512_ELL2_NU_,
// CURVE25519_SHA512_ELL2_RO_,
// CURVE448_SHA512_ELL2_NU_,
// CURVE448_SHA512_ELL2_RO_,
// P256_SHA256_SSWU_NU_,
// P256_SHA256_SSWU_RO_,
// P256_SHA256_SVDW_NU_,
// P256_SHA256_SVDW_RO_,
// P384_SHA512_SSWU_NU_,
// P384_SHA512_SSWU_RO_,
// P384_SHA512_SVDW_NU_,
// P384_SHA512_SVDW_RO_,
// P521_SHA512_SSWU_NU_,
// P521_SHA512_SSWU_RO_,
// P521_SHA512_SVDW_NU_,
// P521_SHA512_SVDW_RO_,
// ];
// for suite in suites {
// let enc = suite.get(dst);
// let mut p = enc.hash(msg);
// p.normalize();
// println!("enc: {} {} ", suite, p);
// }

// println!("N: {} ", P256);
// let gg = ec.get_generator();
// let f = ec.get_field();
// let g2 = ec.new_point(ProyCoordinates {
// x: f.from("51317554015454129980312020699350903676485190487572340293004311540924363220810"),
// y: f.from("40717246725065776267553779947826866259129181902823445522925495338883756281207"),
// z: f.from(1),
// });
// let mut g3 = &gg + &g2;
// g3.normalize();
// println!("G: {} ", g3);
// let ec = edwards::Curve::from(EDWARDS448);
// let gg = ec.get_generator();
// println!("E: {} ", EDWARDS448);
// println!("E: {} ", ec);
// println!("G: {} ", gg);
// let ec = montgomery::Curve::from(CURVE25519);
// let gg = ec.get_generator();
// println!("E: {} ", CURVE25519);
// println!("E: {} ", ec);
// println!("G: {} ", gg);
}
44 changes: 42 additions & 2 deletions src/lib.rs
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
//! This is documentation for the `redox-ecc` crate.
//! `redox_ecc` is a reference implementation of elliptic curve operations.
//!
//! The purpose of this library is to provide mathematical operations used in some elliptic curves.
//!
//! # Warning
//!
//! This is implementation is **not** protected against any kind of attack, including
//! side-channel attacks. Do not use this code for securing any application.
//!
//! # Hash to Curve Example
//!
//! ```
//! use redox_ecc::ellipticcurve::EllipticCurve;
//! use redox_ecc::h2c::HashToCurve;
//! use redox_ecc::instances::{CURVE25519, P256};
//! use redox_ecc::suites::{
//! EDWARDS25519_SHA256_EDELL2_RO_, EDWARDS25519_SHA512_EDELL2_NU_, EDWARDS25519_SHA512_EDELL2_RO_,
//! EDWARDS448_SHA512_EDELL2_NU_, EDWARDS448_SHA512_EDELL2_RO_, P256_SHA256_SSWU_RO_,
//! };
//! let msg = "This is a message string".as_bytes();
//! let dst = "QUUX-V01-CS02".as_bytes();
//!
//! let ec = P256.get();
//! let g0 = ec.get_generator();
//! let g1 = ec.get_generator();
//! println!("{}\n2G: {} ", ec, g0 + g1);
//! let suite = P256_SHA256_SSWU_RO_;
//! let h = suite.get(dst);
//! let mut p = h.hash(msg);
//! p.normalize();
//! println!("enc: {} {} ", suite, p);
//!
//! let ec = CURVE25519.get();
//! let g0 = ec.get_generator();
//! let g1 = ec.get_generator();
//! println!("{}\n2G: {} ", ec, g0 + g1);
//! let suite = EDWARDS25519_SHA512_EDELL2_RO_;
//! let h = suite.get(dst);
//! let mut p = h.hash(msg);
//! p.normalize();
//! println!("enc: {} {} ", suite, p);
//! ```
//!
//! The foo crate is meant to be used for bar.

// #![warn(missing_docs)]

Expand Down
6 changes: 2 additions & 4 deletions src/ops.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,8 @@ macro_rules! make_trait {
),
pub trait $name
where
for<'a, 'b> Self: Sized
+ 'a
+ 'static
+ std::ops::$trait<&'b Self, Output = Self>
Self: Sized
+ for<'a> std::ops::$trait<&'a Self, Output = Self>
+ std::ops::$trait<Self, Output = Self>,
{
// for<'a, 'b> &'a Self: Sized
Expand Down
4 changes: 3 additions & 1 deletion src/primefield/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ pub struct Fp(Rc<Params>);
impl Fp {
/// Use `new` to generate a prime field instance.
/// ```
/// let f = Fp::new(BigUint::from(101));
/// use num_bigint::BigUint;
/// use redox_ecc::primefield::Fp;
/// let f = Fp::new(BigUint::from(101u32));
/// ```
/// The `modulus` should be a prime number.
pub fn new(modulus: BigUint) -> Self {
Expand Down

0 comments on commit c2db7da

Please sign in to comment.