mirror of
https://github.com/saymrwulf/risc0-curve25519-dalek-source.git
synced 2026-09-05 20:10:35 +00:00
1536 lines
54 KiB
Rust
1536 lines
54 KiB
Rust
// -*- mode: rust; -*-
|
||
//
|
||
// This file is part of curve25519-dalek.
|
||
// Copyright (c) 2016-2017 Isis Lovecruft, Henry de Valence
|
||
// See LICENSE for licensing information.
|
||
//
|
||
// Authors:
|
||
// - Isis Agora Lovecruft <isis@patternsinthevoid.net>
|
||
// - Henry de Valence <hdevalence@hdevalence.ca>
|
||
|
||
//! Group operations for Curve25519, in Edwards form.
|
||
//!
|
||
//! ## Encoding and Decoding
|
||
//!
|
||
//! Encoding is done by converting to and from a `CompressedEdwardsY`
|
||
//! struct, which is a typed wrapper around `[u8; 32]`.
|
||
//!
|
||
//! ## Equality Testing
|
||
//!
|
||
//! The `EdwardsPoint` struct implements the `subtle::Equal` trait for
|
||
//! constant-time equality checking, and the Rust `Eq` trait for
|
||
//! variable-time equality checking.
|
||
//!
|
||
//! ## Cofactor-related functions
|
||
//!
|
||
//! The order of the group of points on the curve \\(\mathcal E\\)
|
||
//! is \\(|\mathcal E| = 8\ell \\), so its structure is \\( \mathcal
|
||
//! E = \mathcal E[8] \times \mathcal E[\ell]\\). The torsion
|
||
//! subgroup \\( \mathcal E[8] \\) consists of eight points of small
|
||
//! order. Technically, all of \\(\mathcal E\\) is torsion, but we
|
||
//! use the word only to refer to the small \\(\mathcal E[8]\\) part, not
|
||
//! the large prime-order \\(\mathcal E[\ell]\\) part.
|
||
//!
|
||
//! To test if a point is in \\( \mathcal E[8] \\), use
|
||
//! `EdwardsPoint::is_small_order()`.
|
||
//!
|
||
//! To test if a point is in \\( \mathcal E[\ell] \\), use
|
||
//! `EdwardsPoint::is_torsion_free()`.
|
||
//!
|
||
//! To multiply by the cofactor, use `EdwardsPoint::mult_by_cofactor()`.
|
||
//!
|
||
//! To avoid dealing with cofactors entirely, consider using Ristretto.
|
||
//!
|
||
//! ## Scalars
|
||
//!
|
||
//! Scalars are represented by the `Scalar` struct. To construct a scalar with a specific bit
|
||
//! pattern, see `Scalar::from_bits()`.
|
||
//!
|
||
//! ## Scalar Multiplication
|
||
//!
|
||
//! Scalar multiplication on Edwards points is provided by:
|
||
//!
|
||
//! * the `*` operator between a `Scalar` and a `EdwardsPoint`, which
|
||
//! performs constant-time variable-base scalar multiplication;
|
||
//!
|
||
//! * the `*` operator between a `Scalar` and a
|
||
//! `EdwardsBasepointTable`, which performs constant-time fixed-base
|
||
//! scalar multiplication;
|
||
//!
|
||
//! * the `edwards::multiscalar_mult` function, which performs
|
||
//! constant-time variable-base multiscalar multiplication;
|
||
//!
|
||
//! * the `edwards::vartime::multiscalar_mult` function, which
|
||
//! performs variable-time variable-base multiscalar multiplication.
|
||
//!
|
||
//! ## Implementation
|
||
//!
|
||
//! The Edwards arithmetic is implemented using the “extended twisted
|
||
//! coordinates” of Hisil, Wong, Carter, and Dawson, and the
|
||
//! corresponding complete formulas. For more details,
|
||
//! see the `curve_models` submodule of the internal documentation.
|
||
//!
|
||
//! ## Validity Checking
|
||
//!
|
||
//! There is no function for checking whether a point is valid.
|
||
//! Instead, the `EdwardsPoint` struct is guaranteed to hold a valid
|
||
//! point on the curve.
|
||
//!
|
||
//! We use the Rust type system to make invalid points
|
||
//! unrepresentable: `EdwardsPoint` objects can only be created via
|
||
//! successful decompression of a compressed point, or else by
|
||
//! operations on other (valid) `EdwardsPoint`s.
|
||
|
||
// We allow non snake_case names because coordinates in projective space are
|
||
// traditionally denoted by the capitalisation of their respective
|
||
// counterparts in affine space. Yeah, you heard me, rustc, I'm gonna have my
|
||
// affine and projective cakes and eat both of them too.
|
||
#![allow(non_snake_case)]
|
||
|
||
#[cfg(feature = "alloc")]
|
||
use alloc::Vec;
|
||
|
||
use core::fmt::Debug;
|
||
use core::iter::Iterator;
|
||
use core::ops::{Add, Sub, Neg};
|
||
use core::ops::{AddAssign, SubAssign};
|
||
use core::ops::{Mul, MulAssign};
|
||
use core::ops::Index;
|
||
|
||
use subtle::slices_equal;
|
||
use subtle::ConditionallyAssignable;
|
||
use subtle::ConditionallyNegatable;
|
||
// XXX subtle::Equal
|
||
use subtle::Equal;
|
||
|
||
use constants;
|
||
|
||
use field::FieldElement;
|
||
use scalar::Scalar;
|
||
|
||
use montgomery::MontgomeryPoint;
|
||
use curve_models::ProjectivePoint;
|
||
use curve_models::CompletedPoint;
|
||
use curve_models::AffineNielsPoint;
|
||
use curve_models::ProjectiveNielsPoint;
|
||
|
||
use curve_models::window::LookupTable;
|
||
|
||
use traits::{Identity, IsIdentity};
|
||
use traits::ValidityCheck;
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Compressed points
|
||
// ------------------------------------------------------------------------
|
||
|
||
/// In "Edwards y" / "Ed25519" format, the curve point \\((x,y)\\) is
|
||
/// determined by the \\(y\\)-coordinate and the sign of \\(x\\).
|
||
///
|
||
/// The first 255 bits of a `CompressedEdwardsY` represent the
|
||
/// \\(y\\)-coordinate. The high bit of the 32nd byte gives the sign of \\(x\\).
|
||
#[derive(Copy, Clone, Eq, PartialEq)]
|
||
pub struct CompressedEdwardsY(pub [u8; 32]);
|
||
|
||
impl Debug for CompressedEdwardsY {
|
||
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
|
||
write!(f, "CompressedEdwardsY: {:?}", self.as_bytes())
|
||
}
|
||
}
|
||
|
||
impl CompressedEdwardsY {
|
||
/// View this `CompressedEdwardsY` as an array of bytes.
|
||
pub fn as_bytes(&self) -> &[u8; 32] {
|
||
&self.0
|
||
}
|
||
|
||
/// Copy this `CompressedEdwardsY` to an array of bytes.
|
||
pub fn to_bytes(&self) -> [u8; 32] {
|
||
self.0
|
||
}
|
||
|
||
/// Attempt to decompress to an `EdwardsPoint`.
|
||
///
|
||
/// Returns `None` if the input is not the \\(y\\)-coordinate of a
|
||
/// curve point.
|
||
pub fn decompress(&self) -> Option<EdwardsPoint> {
|
||
let Y = FieldElement::from_bytes(self.as_bytes());
|
||
let Z = FieldElement::one();
|
||
let YY = Y.square();
|
||
let u = &YY - &Z; // u = y²-1
|
||
let v = &(&YY * &constants::EDWARDS_D) + &Z; // v = dy²+1
|
||
let (is_nonzero_square, mut X) = FieldElement::sqrt_ratio(&u, &v);
|
||
|
||
if is_nonzero_square != 1u8 { return None; }
|
||
|
||
// Flip the sign of X if it's not correct
|
||
let compressed_sign_bit = self.as_bytes()[31] >> 7;
|
||
let current_sign_bit = X.is_negative();
|
||
X.conditional_negate(current_sign_bit ^ compressed_sign_bit);
|
||
|
||
Some(EdwardsPoint{ X: X, Y: Y, Z: Z, T: &X * &Y })
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Serde support
|
||
// ------------------------------------------------------------------------
|
||
// Serializes to and from `EdwardsPoint` directly, doing compression
|
||
// and decompression internally. This means that users can create
|
||
// structs containing `EdwardsPoint`s and use Serde's derived
|
||
// serializers to serialize those structures.
|
||
|
||
#[cfg(feature = "serde")]
|
||
use serde::{self, Serialize, Deserialize, Serializer, Deserializer};
|
||
#[cfg(feature = "serde")]
|
||
use serde::de::Visitor;
|
||
|
||
#[cfg(feature = "serde")]
|
||
impl Serialize for EdwardsPoint {
|
||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||
where S: Serializer
|
||
{
|
||
serializer.serialize_bytes(self.compress().as_bytes())
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde")]
|
||
impl<'de> Deserialize<'de> for EdwardsPoint {
|
||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||
where D: Deserializer<'de>
|
||
{
|
||
struct EdwardsPointVisitor;
|
||
|
||
impl<'de> Visitor<'de> for EdwardsPointVisitor {
|
||
type Value = EdwardsPoint;
|
||
|
||
fn expecting(&self, formatter: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
|
||
formatter.write_str("a valid point in Edwards y + sign format")
|
||
}
|
||
|
||
fn visit_bytes<E>(self, v: &[u8]) -> Result<EdwardsPoint, E>
|
||
where E: serde::de::Error
|
||
{
|
||
if v.len() == 32 {
|
||
let mut arr32 = [0u8; 32];
|
||
arr32[0..32].copy_from_slice(v);
|
||
CompressedEdwardsY(arr32)
|
||
.decompress()
|
||
.ok_or(serde::de::Error::custom("decompression failed"))
|
||
} else {
|
||
Err(serde::de::Error::invalid_length(v.len(), &self))
|
||
}
|
||
}
|
||
}
|
||
|
||
deserializer.deserialize_bytes(EdwardsPointVisitor)
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Internal point representations
|
||
// ------------------------------------------------------------------------
|
||
|
||
/// An `EdwardsPoint` represents a point on the Edwards form of Curve25519.
|
||
#[derive(Copy, Clone)]
|
||
#[allow(missing_docs)]
|
||
pub struct EdwardsPoint {
|
||
pub(crate) X: FieldElement,
|
||
pub(crate) Y: FieldElement,
|
||
pub(crate) Z: FieldElement,
|
||
pub(crate) T: FieldElement,
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Constructors
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl Identity for CompressedEdwardsY {
|
||
fn identity() -> CompressedEdwardsY {
|
||
CompressedEdwardsY([1, 0, 0, 0, 0, 0, 0, 0,
|
||
0, 0, 0, 0, 0, 0, 0, 0,
|
||
0, 0, 0, 0, 0, 0, 0, 0,
|
||
0, 0, 0, 0, 0, 0, 0, 0])
|
||
}
|
||
}
|
||
|
||
impl Identity for EdwardsPoint {
|
||
fn identity() -> EdwardsPoint {
|
||
EdwardsPoint{ X: FieldElement::zero(),
|
||
Y: FieldElement::one(),
|
||
Z: FieldElement::one(),
|
||
T: FieldElement::zero() }
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Validity checks (for debugging, not CT)
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl ValidityCheck for EdwardsPoint {
|
||
// XXX this should also check that T is correct
|
||
fn is_valid(&self) -> bool {
|
||
self.to_projective().is_valid()
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Constant-time assignment
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl ConditionallyAssignable for EdwardsPoint {
|
||
fn conditional_assign(&mut self, other: &EdwardsPoint, choice: u8) {
|
||
self.X.conditional_assign(&other.X, choice);
|
||
self.Y.conditional_assign(&other.Y, choice);
|
||
self.Z.conditional_assign(&other.Z, choice);
|
||
self.T.conditional_assign(&other.T, choice);
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Constant-time Equality
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl Equal for EdwardsPoint {
|
||
fn ct_eq(&self, other: &EdwardsPoint) -> u8 {
|
||
slices_equal(self.compress().as_bytes(),
|
||
other.compress().as_bytes())
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Point conversions
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl EdwardsPoint {
|
||
/// Convert to a ProjectiveNielsPoint
|
||
pub(crate) fn to_projective_niels(&self) -> ProjectiveNielsPoint {
|
||
ProjectiveNielsPoint{
|
||
Y_plus_X: &self.Y + &self.X,
|
||
Y_minus_X: &self.Y - &self.X,
|
||
Z: self.Z,
|
||
T2d: &self.T * &constants::EDWARDS_D2,
|
||
}
|
||
}
|
||
|
||
/// Convert the representation of this point from extended
|
||
/// coordinates to projective coordinates.
|
||
///
|
||
/// Free.
|
||
pub(crate) fn to_projective(&self) -> ProjectivePoint {
|
||
ProjectivePoint{
|
||
X: self.X,
|
||
Y: self.Y,
|
||
Z: self.Z,
|
||
}
|
||
}
|
||
|
||
/// Dehomogenize to a AffineNielsPoint.
|
||
/// Mainly for testing.
|
||
pub(crate) fn to_affine_niels(&self) -> AffineNielsPoint {
|
||
let recip = self.Z.invert();
|
||
let x = &self.X * &recip;
|
||
let y = &self.Y * &recip;
|
||
let xy2d = &(&x * &y) * &constants::EDWARDS_D2;
|
||
AffineNielsPoint{
|
||
y_plus_x: &y + &x,
|
||
y_minus_x: &y - &x,
|
||
xy2d: xy2d
|
||
}
|
||
}
|
||
|
||
/// Convert this `EdwardsPoint` on the Edwards model to the
|
||
/// corresponding `MontgomeryPoint` on the Montgomery model.
|
||
///
|
||
/// Note that this is a one-way conversion, since the Montgomery
|
||
/// model does not retain sign information.
|
||
///
|
||
// XXX need to figure out how to keep this in internal docs, and
|
||
// also to rewrite it to use tex
|
||
//
|
||
// # Implementation notes
|
||
//
|
||
// Taking the Montgomery curve equation in affine coordinates:
|
||
//
|
||
// E_(A,B) = Bv² = u³ + Au² + u <span style="float: right">(1)</span>
|
||
//
|
||
// and given its relations to the coordinates of the Edwards model:
|
||
//
|
||
// u = (1+y)/(1-y) <span style="float: right">(2)</span>
|
||
// v = (λu)/(x)
|
||
//
|
||
// Converting from affine to projective coordinates in the Montgomery
|
||
// model, we arrive at:
|
||
//
|
||
// u = (Z+Y)/(Z-Y) <span style="float: right">(3)</span>
|
||
// v = λ * ((Z+Y)/(Z-Y)) * (Z/X)
|
||
//
|
||
// The transition between affine and projective is given by
|
||
//
|
||
// u → U/W <span style="float: right">(4)</span>
|
||
// v → V/W
|
||
//
|
||
// thus the Montgomery curve equation (1) becomes
|
||
//
|
||
// E_(A,B) : BV²W = U³ + AU²W + UW² ⊆ 𝗣^2 <span style="float: right">(5)</span>
|
||
//
|
||
// Here, again, to differentiate from points in the twisted Edwards model, we
|
||
// call the point `(x,y)` in affine coordinates `(u,v)` and similarly in projective
|
||
// space we use `(U:V:W)`. However, since (as per Montgomery's original work) the
|
||
// v-coordinate is not required to perform scalar multiplication, we merely
|
||
// use `(U:W)`.
|
||
//
|
||
// Therefore, the direct translation between projective Montgomery points
|
||
// and projective twisted Edwards points is
|
||
//
|
||
// (U:W) = (Z+Y:Z-Y) <span style="float: right">(6)</span>
|
||
//
|
||
// Note, however, that there appears to be an exception where `Z=Y`,
|
||
// since—from equation 2—this would imply that `y=1` (thus causing the
|
||
// denominator to be zero). If this is the case, then it follows from the
|
||
// twisted Edwards curve equation
|
||
//
|
||
// -x² + y² = 1 + dx²y² <span style="float: right">(7)</span>
|
||
//
|
||
// that
|
||
//
|
||
// -x² + 1 = 1 + dx²
|
||
//
|
||
// and, assuming that `d ≠ -1`,
|
||
//
|
||
// -x² = x²
|
||
// x = 0
|
||
//
|
||
// Therefore, the only valid point with `y=1` is the twisted Edwards
|
||
// identity point, which correctly becomes `(1:0)`, that is, the identity,
|
||
// in the Montgomery model.
|
||
pub fn to_montgomery(&self) -> MontgomeryPoint {
|
||
MontgomeryPoint{
|
||
U: &self.Z + &self.Y,
|
||
W: &self.Z - &self.Y,
|
||
}
|
||
}
|
||
|
||
/// Compress this point to `CompressedEdwardsY` format.
|
||
pub fn compress(&self) -> CompressedEdwardsY {
|
||
let recip = self.Z.invert();
|
||
let x = &self.X * &recip;
|
||
let y = &self.Y * &recip;
|
||
let mut s: [u8; 32];
|
||
|
||
s = y.to_bytes();
|
||
s[31] ^= (x.is_negative() << 7) as u8;
|
||
CompressedEdwardsY(s)
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Doubling
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl EdwardsPoint {
|
||
/// Add this point to itself.
|
||
pub(crate) fn double(&self) -> EdwardsPoint {
|
||
self.to_projective().double().to_extended()
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Addition and Subtraction
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl<'a, 'b> Add<&'b EdwardsPoint> for &'a EdwardsPoint {
|
||
type Output = EdwardsPoint;
|
||
fn add(self, other: &'b EdwardsPoint) -> EdwardsPoint {
|
||
(self + &other.to_projective_niels()).to_extended()
|
||
}
|
||
}
|
||
|
||
define_add_variants!(LHS = EdwardsPoint, RHS = EdwardsPoint, Output = EdwardsPoint);
|
||
|
||
impl<'b> AddAssign<&'b EdwardsPoint> for EdwardsPoint {
|
||
fn add_assign(&mut self, _rhs: &'b EdwardsPoint) {
|
||
*self = (self as &EdwardsPoint) + _rhs;
|
||
}
|
||
}
|
||
|
||
define_add_assign_variants!(LHS = EdwardsPoint, RHS = EdwardsPoint);
|
||
|
||
impl<'a, 'b> Sub<&'b EdwardsPoint> for &'a EdwardsPoint {
|
||
type Output = EdwardsPoint;
|
||
fn sub(self, other: &'b EdwardsPoint) -> EdwardsPoint {
|
||
(self - &other.to_projective_niels()).to_extended()
|
||
}
|
||
}
|
||
|
||
define_sub_variants!(LHS = EdwardsPoint, RHS = EdwardsPoint, Output = EdwardsPoint);
|
||
|
||
impl<'b> SubAssign<&'b EdwardsPoint> for EdwardsPoint {
|
||
fn sub_assign(&mut self, _rhs: &'b EdwardsPoint) {
|
||
*self = (self as &EdwardsPoint) - _rhs;
|
||
}
|
||
}
|
||
|
||
define_sub_assign_variants!(LHS = EdwardsPoint, RHS = EdwardsPoint);
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Negation
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl<'a> Neg for &'a EdwardsPoint {
|
||
type Output = EdwardsPoint;
|
||
|
||
fn neg(self) -> EdwardsPoint {
|
||
EdwardsPoint{
|
||
X: -(&self.X),
|
||
Y: self.Y,
|
||
Z: self.Z,
|
||
T: -(&self.T),
|
||
}
|
||
}
|
||
}
|
||
|
||
impl Neg for EdwardsPoint {
|
||
type Output = EdwardsPoint;
|
||
|
||
fn neg(self) -> EdwardsPoint {
|
||
-&self
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Scalar multiplication
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl<'b> MulAssign<&'b Scalar> for EdwardsPoint {
|
||
fn mul_assign(&mut self, scalar: &'b Scalar) {
|
||
let result = (self as &EdwardsPoint) * scalar;
|
||
*self = result;
|
||
}
|
||
}
|
||
|
||
define_mul_assign_variants!(LHS = EdwardsPoint, RHS = Scalar);
|
||
|
||
define_mul_variants!(LHS = EdwardsPoint, RHS = Scalar, Output = EdwardsPoint);
|
||
define_mul_variants!(LHS = Scalar, RHS = EdwardsPoint, Output = EdwardsPoint);
|
||
|
||
impl<'a, 'b> Mul<&'b Scalar> for &'a EdwardsPoint {
|
||
type Output = EdwardsPoint;
|
||
/// Scalar multiplication: compute `scalar * self`.
|
||
///
|
||
/// For scalar multiplication of a basepoint,
|
||
/// `EdwardsBasepointTable` is approximately 4x faster.
|
||
fn mul(self, scalar: &'b Scalar) -> EdwardsPoint {
|
||
// If we built with AVX2, use the AVX2 backend.
|
||
#[cfg(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2")))] {
|
||
use backend::avx2::edwards::ExtendedPoint;
|
||
let P_avx2 = ExtendedPoint::from(*self);
|
||
return EdwardsPoint::from(&P_avx2 * scalar);
|
||
}
|
||
// Otherwise, proceed as normal:
|
||
#[cfg(not(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2"))))] {
|
||
// Construct a lookup table of [P,2P,3P,4P,5P,6P,7P,8P]
|
||
let lookup_table = LookupTable::<ProjectiveNielsPoint>::from(self);
|
||
|
||
// Setting s = scalar, compute
|
||
//
|
||
// s = s_0 + s_1*16^1 + ... + s_63*16^63,
|
||
//
|
||
// with `-8 ≤ s_i < 8` for `0 ≤ i < 63` and `-8 ≤ s_63 ≤ 8`.
|
||
let scalar_digits = scalar.to_radix_16();
|
||
|
||
// Compute s*P as
|
||
//
|
||
// s*P = P*(s_0 + s_1*16^1 + s_2*16^2 + ... + s_63*16^63)
|
||
// s*P = P*s_0 + P*s_1*16^1 + P*s_2*16^2 + ... + P*s_63*16^63
|
||
// s*P = P*s_0 + 16*(P*s_1 + 16*(P*s_2 + 16*( ... + P*s_63)...))
|
||
//
|
||
// We sum right-to-left.
|
||
let mut Q = EdwardsPoint::identity();
|
||
for i in (0..64).rev() {
|
||
// Q <-- 16*Q
|
||
Q = Q.mult_by_pow_2(4);
|
||
// Q <-- Q + P * s_i
|
||
Q = (&Q + &lookup_table.select(scalar_digits[i])).to_extended()
|
||
}
|
||
|
||
Q
|
||
}
|
||
}
|
||
}
|
||
|
||
impl<'a, 'b> Mul<&'b EdwardsPoint> for &'a Scalar {
|
||
type Output = EdwardsPoint;
|
||
|
||
/// Scalar multiplication: compute `scalar * self`.
|
||
///
|
||
/// For scalar multiplication of a basepoint,
|
||
/// `EdwardsBasepointTable` is approximately 4x faster.
|
||
fn mul(self, point: &'b EdwardsPoint) -> EdwardsPoint {
|
||
point * self
|
||
}
|
||
}
|
||
|
||
/// Given an iterator of (possibly secret) scalars and an iterator of
|
||
/// (possibly secret) points, compute
|
||
/// $$
|
||
/// Q = c\_1 P\_1 + \cdots + c\_n P\_n.
|
||
/// $$
|
||
///
|
||
/// This function has the same behaviour as
|
||
/// `vartime::multiscalar_mult` but is constant-time.
|
||
///
|
||
/// # Input
|
||
///
|
||
/// A iterable of `Scalar`s and a iterable of `EdwardsPoints`. It is an
|
||
/// error to call this function with two iterators of different lengths.
|
||
///
|
||
// XXX later when we do more fancy multiscalar mults, we can delegate
|
||
// based on the iter's size hint -- hdevalence
|
||
#[cfg(any(feature = "alloc", feature = "std"))]
|
||
pub fn multiscalar_mult<'a, 'b, I, J>(scalars: I, points: J) -> EdwardsPoint
|
||
where I: IntoIterator<Item = &'a Scalar>,
|
||
J: IntoIterator<Item = &'b EdwardsPoint>
|
||
{
|
||
// If we built with AVX2, use the AVX2 backend.
|
||
#[cfg(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2")))] {
|
||
use backend::avx2::edwards as edwards_avx2;
|
||
|
||
edwards_avx2::multiscalar_mult(scalars, points)
|
||
}
|
||
// Otherwise, proceed as normal:
|
||
#[cfg(not(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2"))))] {
|
||
//assert_eq!(scalars.len(), points.len());
|
||
|
||
use clear_on_drop::ClearOnDrop;
|
||
|
||
let lookup_tables_vec: Vec<_> = points.into_iter()
|
||
.map(|P| LookupTable::<ProjectiveNielsPoint>::from(P) )
|
||
.collect();
|
||
|
||
let lookup_tables = ClearOnDrop::new(lookup_tables_vec);
|
||
|
||
// Setting s_i = i-th scalar, compute
|
||
//
|
||
// s_i = s_{i,0} + s_{i,1}*16^1 + ... + s_{i,63}*16^63,
|
||
//
|
||
// with `-8 ≤ s_{i,j} < 8` for `0 ≤ j < 63` and `-8 ≤ s_{i,63} ≤ 8`.
|
||
let scalar_digits_vec: Vec<_> = scalars.into_iter()
|
||
.map(|c| c.to_radix_16())
|
||
.collect();
|
||
|
||
// This above puts the scalar digits into a heap-allocated Vec.
|
||
// To ensure that these are erased, pass ownership of the Vec into a
|
||
// ClearOnDrop wrapper.
|
||
let scalar_digits = ClearOnDrop::new(scalar_digits_vec);
|
||
|
||
// Compute s_1*P_1 + ... + s_n*P_n: since
|
||
//
|
||
// s_i*P_i = P_i*(s_{i,0} + s_{i,1}*16^1 + ... + s_{i,63}*16^63)
|
||
// s_i*P_i = P_i*s_{i,0} + P_i*s_{i,1}*16^1 + ... + P_i*s_{i,63}*16^63
|
||
// s_i*P_i = P_i*s_{i,0} + 16*(P_i*s_{i,1} + 16*( ... + 16*P_i*s_{i,63})...)
|
||
//
|
||
// we have the two-dimensional sum
|
||
//
|
||
// s_1*P_1 = P_1*s_{1,0} + 16*(P_1*s_{1,1} + 16*( ... + 16*P_1*s_{1,63})...)
|
||
// + s_2*P_2 = + P_2*s_{2,0} + 16*(P_2*s_{2,1} + 16*( ... + 16*P_2*s_{2,63})...)
|
||
// ...
|
||
// + s_n*P_n = + P_n*s_{n,0} + 16*(P_n*s_{n,1} + 16*( ... + 16*P_n*s_{n,63})...)
|
||
//
|
||
// We sum column-wise top-to-bottom, then right-to-left,
|
||
// multiplying by 16 only once per column.
|
||
//
|
||
// This provides the speedup over doing n independent scalar
|
||
// mults: we perform 63 multiplications by 16 instead of 63*n
|
||
// multiplications, saving 252*(n-1) doublings.
|
||
let mut Q = EdwardsPoint::identity();
|
||
// XXX this impl makes no effort to be cache-aware; maybe it could be improved?
|
||
for j in (0..64).rev() {
|
||
Q = Q.mult_by_pow_2(4);
|
||
let it = scalar_digits.iter().zip(lookup_tables.iter());
|
||
for (s_i, lookup_table_i) in it {
|
||
// R_i = s_{i,j} * P_i
|
||
let R_i = lookup_table_i.select(s_i[j]);
|
||
// Q = Q + R_i
|
||
Q = (&Q + &R_i).to_extended();
|
||
}
|
||
}
|
||
Q
|
||
}
|
||
}
|
||
|
||
/// A precomputed table of multiples of a basepoint, for accelerating
|
||
/// fixed-base scalar multiplication. One table, for the Ed25519
|
||
/// basepoint, is provided in the `constants` module.
|
||
///
|
||
/// The basepoint tables are reasonably large (30KB), so they should
|
||
/// probably be boxed.
|
||
#[derive(Clone)]
|
||
pub struct EdwardsBasepointTable(pub(crate) [LookupTable<AffineNielsPoint>; 32]);
|
||
|
||
impl EdwardsBasepointTable {
|
||
/// The computation uses Pippeneger's algorithm, as described on
|
||
/// page 13 of the Ed25519 paper. Write the scalar \\(a\\) in radix \\(16\\) with
|
||
/// coefficients in \\([-8,8)\\), i.e.,
|
||
/// $$
|
||
/// a = a\_0 + a\_1 16\^1 + \cdots + a\_{63} 16\^{63},
|
||
/// $$
|
||
/// with \\(-8 \leq a_i < 8\\), \\(-8 \leq a\_{63} \leq 8\\). Then
|
||
/// $$
|
||
/// a B = a\_0 B + a\_1 16\^1 B + \cdots + a\_{63} 16\^{63} B.
|
||
/// $$
|
||
/// Grouping even and odd coefficients gives
|
||
/// $$
|
||
/// \begin{aligned}
|
||
/// a B = \quad a\_0 16\^0 B +& a\_2 16\^2 B + \cdots + a\_{62} 16\^{62} B \\\\
|
||
/// + a\_1 16\^1 B +& a\_3 16\^3 B + \cdots + a\_{63} 16\^{63} B \\\\
|
||
/// = \quad(a\_0 16\^0 B +& a\_2 16\^2 B + \cdots + a\_{62} 16\^{62} B) \\\\
|
||
/// + 16(a\_1 16\^0 B +& a\_3 16\^2 B + \cdots + a\_{63} 16\^{62} B). \\\\
|
||
/// \end{aligned}
|
||
/// $$
|
||
/// For each \\(i = 0 \ldots 31\\), we create a lookup table of
|
||
/// $$
|
||
/// [16\^{2i} B, \ldots, 8\cdot16\^{2i} B],
|
||
/// $$
|
||
/// and use it to select \\( x \cdot 16\^{2i} \cdot B \\) in constant time.
|
||
///
|
||
/// The radix-\\(16\\) representation requires that the scalar is bounded
|
||
/// by \\(2\^{255}\\), which is always the case.
|
||
fn basepoint_mul(&self, scalar: &Scalar) -> EdwardsPoint {
|
||
let a = scalar.to_radix_16();
|
||
|
||
let tables = &self.0;
|
||
let mut P = EdwardsPoint::identity();
|
||
|
||
for i in (0..64).filter(|x| x % 2 == 1) {
|
||
P = (&P + &tables[i/2].select(a[i])).to_extended();
|
||
}
|
||
|
||
P = P.mult_by_pow_2(4);
|
||
|
||
for i in (0..64).filter(|x| x % 2 == 0) {
|
||
P = (&P + &tables[i/2].select(a[i])).to_extended();
|
||
}
|
||
|
||
P
|
||
}
|
||
}
|
||
|
||
impl<'a, 'b> Mul<&'b Scalar> for &'a EdwardsBasepointTable {
|
||
type Output = EdwardsPoint;
|
||
|
||
/// Construct an `EdwardsPoint` from a `Scalar` \\(a\\) by
|
||
/// computing the multiple \\(aB\\) of this basepoint \\(B\\).
|
||
fn mul(self, scalar: &'b Scalar) -> EdwardsPoint {
|
||
// delegate to a private function so that its documentation appears in internal docs
|
||
self.basepoint_mul(scalar)
|
||
}
|
||
}
|
||
|
||
impl<'a, 'b> Mul<&'a EdwardsBasepointTable> for &'b Scalar {
|
||
type Output = EdwardsPoint;
|
||
|
||
/// Construct an `EdwardsPoint` from a `Scalar` \\(a\\) by
|
||
/// computing the multiple \\(aB\\) of this basepoint \\(B\\).
|
||
fn mul(self, basepoint_table: &'a EdwardsBasepointTable) -> EdwardsPoint {
|
||
basepoint_table * &self
|
||
}
|
||
}
|
||
|
||
impl EdwardsBasepointTable {
|
||
/// Create a table of precomputed multiples of `basepoint`.
|
||
pub fn create(basepoint: &EdwardsPoint) -> EdwardsBasepointTable {
|
||
// XXX use init_with
|
||
let mut table = EdwardsBasepointTable([LookupTable::default(); 32]);
|
||
let mut P = *basepoint;
|
||
for i in 0..32 {
|
||
// P = (16^2)^i * B
|
||
table.0[i] = LookupTable::from(&P);
|
||
P = P.mult_by_pow_2(8);
|
||
}
|
||
table
|
||
}
|
||
|
||
/// Get the basepoint for this table as an `EdwardsPoint`.
|
||
///
|
||
/// XXX maybe this would be better as a `From` impl
|
||
pub fn basepoint(&self) -> EdwardsPoint {
|
||
// self.0[0].select(1) = 1*(16^2)^0*B
|
||
// but as an `AffineNielsPoint`, so add identity to convert to extended.
|
||
(&EdwardsPoint::identity() + &self.0[0].select(1)).to_extended()
|
||
}
|
||
}
|
||
|
||
impl EdwardsPoint {
|
||
/// Multiply by the cofactor: return \\([8]P\\).
|
||
pub fn mult_by_cofactor(&self) -> EdwardsPoint {
|
||
self.mult_by_pow_2(3)
|
||
}
|
||
|
||
/// Compute \\([2\^k] P \\) by successive doublings. Requires \\( k > 0 \\).
|
||
pub(crate) fn mult_by_pow_2(&self, k: u32) -> EdwardsPoint {
|
||
debug_assert!( k > 0 );
|
||
let mut r: CompletedPoint;
|
||
let mut s = self.to_projective();
|
||
for _ in 0..(k-1) {
|
||
r = s.double(); s = r.to_projective();
|
||
}
|
||
// Unroll last iteration so we can go directly to_extended()
|
||
s.double().to_extended()
|
||
}
|
||
|
||
/// Determine if this point is of small order.
|
||
///
|
||
/// # Return
|
||
///
|
||
/// * `true` if `self` is in the torsion subgroup \\( \mathcal E[8] \\);
|
||
/// * `false` if `self` is not in the torsion subgroup \\( \mathcal E[8] \\).
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```
|
||
/// use curve25519_dalek::constants;
|
||
///
|
||
/// // Generator of the prime-order subgroup
|
||
/// let P = constants::ED25519_BASEPOINT_POINT;
|
||
/// // Generator of the torsion subgroup
|
||
/// let Q = constants::EIGHT_TORSION[1];
|
||
///
|
||
/// // P has large order
|
||
/// assert_eq!(P.is_small_order(), false);
|
||
///
|
||
/// // Q has small order
|
||
/// assert_eq!(Q.is_small_order(), true);
|
||
/// ```
|
||
pub fn is_small_order(&self) -> bool {
|
||
self.mult_by_cofactor().is_identity()
|
||
}
|
||
|
||
/// Determine if this point is “torsion-free”, i.e., is contained in
|
||
/// the prime-order subgroup.
|
||
///
|
||
/// # Return
|
||
///
|
||
/// * `true` if `self` has zero torsion component and is in the
|
||
/// prime-order subgroup;
|
||
/// * `false` if `self` has a nonzero torsion component and is not
|
||
/// in the prime-order subgroup.
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```
|
||
/// use curve25519_dalek::constants;
|
||
///
|
||
/// // Generator of the prime-order subgroup
|
||
/// let P = constants::ED25519_BASEPOINT_POINT;
|
||
/// // Generator of the torsion subgroup
|
||
/// let Q = constants::EIGHT_TORSION[1];
|
||
///
|
||
/// // P is torsion-free
|
||
/// assert_eq!(P.is_torsion_free(), true);
|
||
///
|
||
/// // P + Q is not torsion-free
|
||
/// assert_eq!((P+Q).is_torsion_free(), false);
|
||
/// ```
|
||
pub fn is_torsion_free(&self) -> bool {
|
||
(self * &constants::BASEPOINT_ORDER).is_identity()
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Elligator2 (uniform encoding/decoding of curve points)
|
||
// ------------------------------------------------------------------------
|
||
|
||
// XXX should this be in another module, with types and `From` impls, like `CompressedEdwardsY`?
|
||
|
||
impl EdwardsPoint {
|
||
/// Use Elligator2 to try to convert `self` to a uniformly random
|
||
/// string.
|
||
///
|
||
/// Returns `Some<[u8;32]>` if `self` is in the image of the
|
||
/// Elligator2 map. For a random point on the curve, this happens
|
||
/// with probability 1/2. Otherwise, returns `None`.
|
||
fn to_uniform_representative(&self) -> Option<[u8; 32]> {
|
||
unimplemented!();
|
||
}
|
||
|
||
/// Use Elligator2 to convert a uniformly random string to a curve
|
||
/// point.
|
||
#[allow(unused_variables)] // REMOVE WHEN IMPLEMENTED
|
||
fn from_uniform_representative(bytes: &[u8; 32]) -> EdwardsPoint {
|
||
unimplemented!();
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Debug traits
|
||
// ------------------------------------------------------------------------
|
||
|
||
impl Debug for EdwardsPoint {
|
||
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
|
||
write!(f, "EdwardsPoint{{\n\tX: {:?},\n\tY: {:?},\n\tZ: {:?},\n\tT: {:?}\n}}",
|
||
&self.X, &self.Y, &self.Z, &self.T)
|
||
}
|
||
}
|
||
|
||
impl Debug for EdwardsBasepointTable {
|
||
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
|
||
write!(f, "EdwardsBasepointTable([\n")?;
|
||
for i in 0..32 {
|
||
write!(f, "\t{:?},\n", &self.0[i])?;
|
||
}
|
||
write!(f, "])")
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Variable-time functions
|
||
// ------------------------------------------------------------------------
|
||
|
||
pub mod vartime {
|
||
//! Variable-time operations on curve points, useful for non-secret data.
|
||
use super::*;
|
||
|
||
/// Holds odd multiples 1A, 3A, ..., 15A of a point A.
|
||
struct OddMultiples([ProjectiveNielsPoint; 8]);
|
||
|
||
impl OddMultiples {
|
||
fn create(A: &EdwardsPoint) -> OddMultiples {
|
||
let mut Ai = [ProjectiveNielsPoint::identity(); 8];
|
||
let A2 = A.double();
|
||
Ai[0] = A.to_projective_niels();
|
||
for i in 0..7 {
|
||
Ai[i+1] = (&A2 + &Ai[i]).to_extended().to_projective_niels();
|
||
}
|
||
// Now Ai = [A, 3A, 5A, 7A, 9A, 11A, 13A, 15A]
|
||
OddMultiples(Ai)
|
||
}
|
||
}
|
||
|
||
impl Index<usize> for OddMultiples {
|
||
type Output = ProjectiveNielsPoint;
|
||
|
||
fn index(&self, _index: usize) -> &ProjectiveNielsPoint {
|
||
&(self.0[_index])
|
||
}
|
||
}
|
||
|
||
/// Given an iterable of public scalars and an iterable of public
|
||
/// points, compute
|
||
/// $$
|
||
/// Q = c\_1 P\_1 + \cdots + c\_n P\_n.
|
||
/// $$
|
||
///
|
||
/// # Input
|
||
///
|
||
/// A iterable of `Scalar`s and a iterable of `EdwardsPoints`. It is an
|
||
/// error to call this function with two iterators of different lengths.
|
||
#[cfg(any(feature = "alloc", feature = "std"))]
|
||
pub fn multiscalar_mult<'a, 'b, I, J>(scalars: I, points: J) -> EdwardsPoint
|
||
where I: IntoIterator<Item = &'a Scalar>,
|
||
J: IntoIterator<Item = &'b EdwardsPoint>
|
||
{
|
||
// If we built with AVX2, use the AVX2 backend.
|
||
#[cfg(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2")))] {
|
||
use backend::avx2::edwards as edwards_avx2;
|
||
|
||
edwards_avx2::vartime::multiscalar_mult(scalars, points)
|
||
}
|
||
// Otherwise, proceed as normal:
|
||
#[cfg(not(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2"))))] {
|
||
//assert_eq!(scalars.len(), points.len());
|
||
|
||
let nafs: Vec<_> = scalars.into_iter()
|
||
.map(|c| c.non_adjacent_form()).collect();
|
||
let odd_multiples: Vec<_> = points.into_iter()
|
||
.map(|P| OddMultiples::create(P)).collect();
|
||
|
||
let mut r = ProjectivePoint::identity();
|
||
|
||
for i in (0..255).rev() {
|
||
let mut t = r.double();
|
||
|
||
for (naf, odd_multiple) in nafs.iter().zip(odd_multiples.iter()) {
|
||
if naf[i] > 0 {
|
||
t = &t.to_extended() + &odd_multiple[( naf[i]/2) as usize];
|
||
} else if naf[i] < 0 {
|
||
t = &t.to_extended() - &odd_multiple[(-naf[i]/2) as usize];
|
||
}
|
||
}
|
||
|
||
r = t.to_projective();
|
||
}
|
||
|
||
r.to_extended()
|
||
}
|
||
}
|
||
|
||
/// Given a point \\(A\\) and scalars \\(a\\) and \\(b\\), compute the point
|
||
/// \\(aA+bB\\), where \\(B\\) is the Ed25519 basepoint (i.e., \\(B = (x,4/5)\\)
|
||
/// with x positive).
|
||
#[cfg(feature="precomputed_tables")]
|
||
pub fn double_scalar_mult_basepoint(
|
||
a: &Scalar,
|
||
A: &EdwardsPoint,
|
||
b: &Scalar,
|
||
) -> EdwardsPoint {
|
||
// If we built with AVX2, use the AVX2 backend.
|
||
#[cfg(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2")))] {
|
||
use backend::avx2::edwards as edwards_avx2;
|
||
|
||
edwards_avx2::vartime::double_scalar_mult_basepoint(a, A, b)
|
||
}
|
||
// Otherwise, proceed as normal:
|
||
#[cfg(not(all(feature="nightly", all(feature="avx2_backend", target_feature="avx2"))))] {
|
||
let a_naf = a.non_adjacent_form();
|
||
let b_naf = b.non_adjacent_form();
|
||
|
||
// Find starting index
|
||
let mut i: usize = 255;
|
||
for j in (0..255).rev() {
|
||
i = j;
|
||
if a_naf[i] != 0 || b_naf[i] != 0 {
|
||
break;
|
||
}
|
||
}
|
||
|
||
let odd_multiples_of_A = OddMultiples::create(A);
|
||
let odd_multiples_of_B = &constants::AFFINE_ODD_MULTIPLES_OF_BASEPOINT;
|
||
|
||
let mut r = ProjectivePoint::identity();
|
||
loop {
|
||
let mut t = r.double();
|
||
|
||
if a_naf[i] > 0 {
|
||
t = &t.to_extended() + &odd_multiples_of_A[( a_naf[i]/2) as usize];
|
||
} else if a_naf[i] < 0 {
|
||
t = &t.to_extended() - &odd_multiples_of_A[(-a_naf[i]/2) as usize];
|
||
}
|
||
|
||
if b_naf[i] > 0 {
|
||
t = &t.to_extended() + &odd_multiples_of_B[( b_naf[i]/2) as usize];
|
||
} else if b_naf[i] < 0 {
|
||
t = &t.to_extended() - &odd_multiples_of_B[(-b_naf[i]/2) as usize];
|
||
}
|
||
|
||
r = t.to_projective();
|
||
|
||
if i == 0 {
|
||
break;
|
||
}
|
||
i -= 1;
|
||
}
|
||
|
||
r.to_extended()
|
||
}
|
||
}
|
||
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Tests
|
||
// ------------------------------------------------------------------------
|
||
|
||
#[cfg(test)]
|
||
mod test {
|
||
use field::FieldElement;
|
||
use scalar::Scalar;
|
||
use subtle::ConditionallyAssignable;
|
||
use constants;
|
||
use super::*;
|
||
|
||
/// X coordinate of the basepoint.
|
||
/// = 15112221349535400772501151409588531511454012693041857206046113283949847762202
|
||
static BASE_X_COORD_BYTES: [u8; 32] =
|
||
[0x1a, 0xd5, 0x25, 0x8f, 0x60, 0x2d, 0x56, 0xc9, 0xb2, 0xa7, 0x25, 0x95, 0x60, 0xc7, 0x2c, 0x69,
|
||
0x5c, 0xdc, 0xd6, 0xfd, 0x31, 0xe2, 0xa4, 0xc0, 0xfe, 0x53, 0x6e, 0xcd, 0xd3, 0x36, 0x69, 0x21];
|
||
|
||
/// Compressed Edwards Y form of 2*basepoint.
|
||
static BASE2_CMPRSSD: CompressedEdwardsY =
|
||
CompressedEdwardsY([0xc9, 0xa3, 0xf8, 0x6a, 0xae, 0x46, 0x5f, 0xe,
|
||
0x56, 0x51, 0x38, 0x64, 0x51, 0x0f, 0x39, 0x97,
|
||
0x56, 0x1f, 0xa2, 0xc9, 0xe8, 0x5e, 0xa2, 0x1d,
|
||
0xc2, 0x29, 0x23, 0x09, 0xf3, 0xcd, 0x60, 0x22]);
|
||
|
||
/// Compressed Edwards Y form of 16*basepoint.
|
||
static BASE16_CMPRSSD: CompressedEdwardsY =
|
||
CompressedEdwardsY([0xeb, 0x27, 0x67, 0xc1, 0x37, 0xab, 0x7a, 0xd8,
|
||
0x27, 0x9c, 0x07, 0x8e, 0xff, 0x11, 0x6a, 0xb0,
|
||
0x78, 0x6e, 0xad, 0x3a, 0x2e, 0x0f, 0x98, 0x9f,
|
||
0x72, 0xc3, 0x7f, 0x82, 0xf2, 0x96, 0x96, 0x70]);
|
||
|
||
/// 4493907448824000747700850167940867464579944529806937181821189941592931634714
|
||
pub static A_SCALAR: Scalar = Scalar{
|
||
bytes: [
|
||
0x1a, 0x0e, 0x97, 0x8a, 0x90, 0xf6, 0x62, 0x2d,
|
||
0x37, 0x47, 0x02, 0x3f, 0x8a, 0xd8, 0x26, 0x4d,
|
||
0xa7, 0x58, 0xaa, 0x1b, 0x88, 0xe0, 0x40, 0xd1,
|
||
0x58, 0x9e, 0x7b, 0x7f, 0x23, 0x76, 0xef, 0x09,
|
||
],
|
||
};
|
||
|
||
/// 2506056684125797857694181776241676200180934651973138769173342316833279714961
|
||
pub static B_SCALAR: Scalar = Scalar{
|
||
bytes: [
|
||
0x91, 0x26, 0x7a, 0xcf, 0x25, 0xc2, 0x09, 0x1b,
|
||
0xa2, 0x17, 0x74, 0x7b, 0x66, 0xf0, 0xb3, 0x2e,
|
||
0x9d, 0xf2, 0xa5, 0x67, 0x41, 0xcf, 0xda, 0xc4,
|
||
0x56, 0xa7, 0xd4, 0xaa, 0xb8, 0x60, 0x8a, 0x05,
|
||
],
|
||
};
|
||
|
||
/// A_SCALAR * basepoint, computed with ed25519.py
|
||
pub static A_TIMES_BASEPOINT: CompressedEdwardsY = CompressedEdwardsY([
|
||
0xea, 0x27, 0xe2, 0x60, 0x53, 0xdf, 0x1b, 0x59,
|
||
0x56, 0xf1, 0x4d, 0x5d, 0xec, 0x3c, 0x34, 0xc3,
|
||
0x84, 0xa2, 0x69, 0xb7, 0x4c, 0xc3, 0x80, 0x3e,
|
||
0xa8, 0xe2, 0xe7, 0xc9, 0x42, 0x5e, 0x40, 0xa5]);
|
||
|
||
/// A_SCALAR * (A_TIMES_BASEPOINT) + B_SCALAR * BASEPOINT
|
||
/// computed with ed25519.py
|
||
static DOUBLE_SCALAR_MULT_RESULT: CompressedEdwardsY = CompressedEdwardsY([
|
||
0x7d, 0xfd, 0x6c, 0x45, 0xaf, 0x6d, 0x6e, 0x0e,
|
||
0xba, 0x20, 0x37, 0x1a, 0x23, 0x64, 0x59, 0xc4,
|
||
0xc0, 0x46, 0x83, 0x43, 0xde, 0x70, 0x4b, 0x85,
|
||
0x09, 0x6f, 0xfe, 0x35, 0x4f, 0x13, 0x2b, 0x42]);
|
||
|
||
/// Test round-trip decompression for the basepoint.
|
||
#[test]
|
||
fn basepoint_decompression_compression() {
|
||
let base_X = FieldElement::from_bytes(&BASE_X_COORD_BYTES);
|
||
let bp = constants::ED25519_BASEPOINT_COMPRESSED.decompress().unwrap();
|
||
assert!(bp.is_valid());
|
||
// Check that decompression actually gives the correct X coordinate
|
||
assert_eq!(base_X, bp.X);
|
||
assert_eq!(bp.compress(), constants::ED25519_BASEPOINT_COMPRESSED);
|
||
}
|
||
|
||
/// Test sign handling in decompression
|
||
#[test]
|
||
fn decompression_sign_handling() {
|
||
// Manually set the high bit of the last byte to flip the sign
|
||
let mut minus_basepoint_bytes = constants::ED25519_BASEPOINT_COMPRESSED.as_bytes().clone();
|
||
minus_basepoint_bytes[31] |= 1 << 7;
|
||
let minus_basepoint = CompressedEdwardsY(minus_basepoint_bytes)
|
||
.decompress().unwrap();
|
||
// Test projective coordinates exactly since we know they should
|
||
// only differ by a flipped sign.
|
||
assert_eq!(minus_basepoint.X, -(&constants::ED25519_BASEPOINT_POINT.X));
|
||
assert_eq!(minus_basepoint.Y, constants::ED25519_BASEPOINT_POINT.Y);
|
||
assert_eq!(minus_basepoint.Z, constants::ED25519_BASEPOINT_POINT.Z);
|
||
assert_eq!(minus_basepoint.T, -(&constants::ED25519_BASEPOINT_POINT.T));
|
||
}
|
||
|
||
/// Test that computing 1*basepoint gives the correct basepoint.
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn basepoint_mult_one_vs_basepoint() {
|
||
let bp = &constants::ED25519_BASEPOINT_TABLE * &Scalar::one();
|
||
let compressed = bp.compress();
|
||
assert_eq!(compressed, constants::ED25519_BASEPOINT_COMPRESSED);
|
||
}
|
||
|
||
/// Test that `EdwardsBasepointTable::basepoint()` gives the correct basepoint.
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn basepoint_table_basepoint_function_correct() {
|
||
let bp = constants::ED25519_BASEPOINT_TABLE.basepoint();
|
||
assert_eq!(bp.compress(), constants::ED25519_BASEPOINT_COMPRESSED);
|
||
}
|
||
|
||
/// Test `impl Add<EdwardsPoint> for EdwardsPoint`
|
||
/// using basepoint + basepoint versus the 2*basepoint constant.
|
||
#[test]
|
||
fn basepoint_plus_basepoint_vs_basepoint2() {
|
||
let bp = constants::ED25519_BASEPOINT_POINT;
|
||
let bp_added = &bp + &bp;
|
||
assert_eq!(bp_added.compress(), BASE2_CMPRSSD);
|
||
}
|
||
|
||
/// Test `impl Add<ProjectiveNielsPoint> for EdwardsPoint`
|
||
/// using the basepoint, basepoint2 constants
|
||
#[test]
|
||
fn basepoint_plus_basepoint_projective_niels_vs_basepoint2() {
|
||
let bp = constants::ED25519_BASEPOINT_POINT;
|
||
let bp_added = (&bp + &bp.to_projective_niels()).to_extended();
|
||
assert_eq!(bp_added.compress(), BASE2_CMPRSSD);
|
||
}
|
||
|
||
/// Test `impl Add<AffineNielsPoint> for EdwardsPoint`
|
||
/// using the basepoint, basepoint2 constants
|
||
#[test]
|
||
fn basepoint_plus_basepoint_affine_niels_vs_basepoint2() {
|
||
let bp = constants::ED25519_BASEPOINT_POINT;
|
||
let bp_affine_niels = bp.to_affine_niels();
|
||
let bp_added = (&bp + &bp_affine_niels).to_extended();
|
||
assert_eq!(bp_added.compress(), BASE2_CMPRSSD);
|
||
}
|
||
|
||
/// Check that equality of `EdwardsPoints` handles projective
|
||
/// coordinates correctly.
|
||
#[test]
|
||
fn extended_point_equality_handles_scaling() {
|
||
let mut two_bytes = [0u8; 32]; two_bytes[0] = 2;
|
||
let id1 = EdwardsPoint::identity();
|
||
let id2 = EdwardsPoint{
|
||
X: FieldElement::zero(),
|
||
Y: FieldElement::from_bytes(&two_bytes),
|
||
Z: FieldElement::from_bytes(&two_bytes),
|
||
T: FieldElement::zero()
|
||
};
|
||
assert!(id1.ct_eq(&id2) == 1u8);
|
||
}
|
||
|
||
/// Sanity check for conversion to precomputed points
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn to_affine_niels_clears_denominators() {
|
||
// construct a point as aB so it has denominators (ie. Z != 1)
|
||
let aB = &constants::ED25519_BASEPOINT_TABLE * &A_SCALAR;
|
||
let aB_affine_niels = aB.to_affine_niels();
|
||
let also_aB = (&EdwardsPoint::identity() + &aB_affine_niels).to_extended();
|
||
assert_eq!( aB.compress(),
|
||
also_aB.compress());
|
||
}
|
||
|
||
/// Test basepoint_mult versus a known scalar multiple from ed25519.py
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn basepoint_mult_vs_ed25519py() {
|
||
let aB = &constants::ED25519_BASEPOINT_TABLE * &A_SCALAR;
|
||
assert_eq!(aB.compress(), A_TIMES_BASEPOINT);
|
||
}
|
||
|
||
/// Test that multiplication by the basepoint order kills the basepoint
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn basepoint_mult_by_basepoint_order() {
|
||
let B = &constants::ED25519_BASEPOINT_TABLE;
|
||
let should_be_id = B * &constants::BASEPOINT_ORDER;
|
||
assert!(should_be_id.is_identity());
|
||
}
|
||
|
||
/// Test precomputed basepoint mult
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn test_precomputed_basepoint_mult() {
|
||
let table = EdwardsBasepointTable::create(&constants::ED25519_BASEPOINT_POINT);
|
||
let aB_1 = &constants::ED25519_BASEPOINT_TABLE * &A_SCALAR;
|
||
let aB_2 = &table * &A_SCALAR;
|
||
assert_eq!(aB_1.compress(), aB_2.compress());
|
||
}
|
||
|
||
/// Test scalar_mult versus a known scalar multiple from ed25519.py
|
||
#[test]
|
||
fn scalar_mult_vs_ed25519py() {
|
||
let aB = &constants::ED25519_BASEPOINT_POINT * &A_SCALAR;
|
||
assert_eq!(aB.compress(), A_TIMES_BASEPOINT);
|
||
}
|
||
|
||
/// Test basepoint.double() versus the 2*basepoint constant.
|
||
#[test]
|
||
fn basepoint_double_vs_basepoint2() {
|
||
assert_eq!(constants::ED25519_BASEPOINT_POINT.double().compress(),
|
||
BASE2_CMPRSSD);
|
||
}
|
||
|
||
/// Test that computing 2*basepoint is the same as basepoint.double()
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn basepoint_mult_two_vs_basepoint2() {
|
||
let two = Scalar::from_u64(2);
|
||
let bp2 = &constants::ED25519_BASEPOINT_TABLE * &two;
|
||
assert_eq!(bp2.compress(), BASE2_CMPRSSD);
|
||
}
|
||
|
||
/// Check that converting to projective and then back to extended round-trips.
|
||
#[test]
|
||
fn basepoint_projective_extended_round_trip() {
|
||
assert_eq!(constants::ED25519_BASEPOINT_POINT
|
||
.to_projective().to_extended().compress(),
|
||
constants::ED25519_BASEPOINT_COMPRESSED);
|
||
}
|
||
|
||
/// Test computing 16*basepoint vs mult_by_pow_2(4)
|
||
#[test]
|
||
fn basepoint16_vs_mult_by_pow_2_4() {
|
||
let bp16 = constants::ED25519_BASEPOINT_POINT.mult_by_pow_2(4);
|
||
assert_eq!(bp16.compress(), BASE16_CMPRSSD);
|
||
}
|
||
|
||
/// Test that the conditional assignment trait works for AffineNielsPoints.
|
||
#[test]
|
||
fn conditional_assign_for_affine_niels_point() {
|
||
let id = AffineNielsPoint::identity();
|
||
let mut p1 = AffineNielsPoint::identity();
|
||
let bp = constants::ED25519_BASEPOINT_POINT.to_affine_niels();
|
||
|
||
p1.conditional_assign(&bp, 0);
|
||
assert_eq!(p1, id);
|
||
p1.conditional_assign(&bp, 1);
|
||
assert_eq!(p1, bp);
|
||
}
|
||
|
||
#[test]
|
||
fn is_small_order() {
|
||
// The basepoint has large prime order
|
||
assert!(constants::ED25519_BASEPOINT_POINT.is_small_order() == false);
|
||
// constants::EIGHT_TORSION has all points of small order.
|
||
for torsion_point in &constants::EIGHT_TORSION {
|
||
assert!(torsion_point.is_small_order() == true);
|
||
}
|
||
}
|
||
|
||
#[test]
|
||
fn compressed_identity() {
|
||
assert_eq!(EdwardsPoint::identity().compress(),
|
||
CompressedEdwardsY::identity());
|
||
}
|
||
|
||
#[test]
|
||
fn is_identity() {
|
||
assert!( EdwardsPoint::identity().is_identity() == true);
|
||
assert!(constants::ED25519_BASEPOINT_POINT.is_identity() == false);
|
||
}
|
||
|
||
/// Rust's debug builds have overflow and underflow trapping,
|
||
/// and enable `debug_assert!()`. This performs many scalar
|
||
/// multiplications to attempt to trigger possible overflows etc.
|
||
///
|
||
/// For instance, the `radix_51` `Mul` implementation for
|
||
/// `FieldElements` requires the input `Limb`s to be bounded by
|
||
/// 2^54, but we cannot enforce this dynamically at runtime, or
|
||
/// statically at compile time (until Rust gets type-level
|
||
/// integers, at which point we can encode "bits of headroom" into
|
||
/// the type system and prove correctness).
|
||
#[test]
|
||
fn monte_carlo_overflow_underflow_debug_assert_test() {
|
||
let mut P = constants::ED25519_BASEPOINT_POINT;
|
||
// N.B. each scalar_mult does 1407 field mults, 1024 field squarings,
|
||
// so this does ~ 1M of each operation.
|
||
for _ in 0..1_000 {
|
||
P *= &A_SCALAR;
|
||
}
|
||
}
|
||
|
||
#[test]
|
||
fn scalarmult_extended_point_works_both_ways() {
|
||
let G: EdwardsPoint = constants::ED25519_BASEPOINT_POINT;
|
||
let s: Scalar = A_SCALAR;
|
||
|
||
let P1 = &G * &s;
|
||
let P2 = &s * &G;
|
||
|
||
assert!(P1.compress().to_bytes() == P2.compress().to_bytes());
|
||
}
|
||
|
||
mod vartime {
|
||
use super::super::*;
|
||
use super::{A_SCALAR, B_SCALAR, A_TIMES_BASEPOINT, DOUBLE_SCALAR_MULT_RESULT};
|
||
|
||
/// Test double_scalar_mult_vartime vs ed25519.py
|
||
#[test]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn double_scalar_mult_basepoint_vs_ed25519py() {
|
||
let A = A_TIMES_BASEPOINT.decompress().unwrap();
|
||
let result = vartime::double_scalar_mult_basepoint(&A_SCALAR, &A, &B_SCALAR);
|
||
assert_eq!(result.compress(), DOUBLE_SCALAR_MULT_RESULT);
|
||
}
|
||
|
||
#[test]
|
||
fn multiscalar_mult_vs_ed25519py() {
|
||
let A = A_TIMES_BASEPOINT.decompress().unwrap();
|
||
let result = vartime::multiscalar_mult(
|
||
&[A_SCALAR, B_SCALAR],
|
||
&[A, constants::ED25519_BASEPOINT_POINT]
|
||
);
|
||
assert_eq!(result.compress(), DOUBLE_SCALAR_MULT_RESULT);
|
||
}
|
||
|
||
#[test]
|
||
fn multiscalar_mult_vartime_vs_consttime() {
|
||
let A = A_TIMES_BASEPOINT.decompress().unwrap();
|
||
let result_vartime = vartime::multiscalar_mult(
|
||
&[A_SCALAR, B_SCALAR],
|
||
&[A, constants::ED25519_BASEPOINT_POINT]
|
||
);
|
||
let result_consttime = multiscalar_mult(
|
||
&[A_SCALAR, B_SCALAR],
|
||
&[A, constants::ED25519_BASEPOINT_POINT]
|
||
);
|
||
|
||
assert_eq!(result_vartime.compress(), result_consttime.compress());
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde")]
|
||
use serde_cbor;
|
||
|
||
#[test]
|
||
#[cfg(feature = "serde")]
|
||
fn serde_cbor_basepoint_roundtrip() {
|
||
let output = serde_cbor::to_vec(&constants::ED25519_BASEPOINT_POINT).unwrap();
|
||
let parsed: EdwardsPoint = serde_cbor::from_slice(&output).unwrap();
|
||
assert_eq!(parsed.compress(), constants::ED25519_BASEPOINT_COMPRESSED);
|
||
}
|
||
|
||
#[test]
|
||
#[cfg(feature = "serde")]
|
||
fn serde_cbor_decode_invalid_fails() {
|
||
let mut output = serde_cbor::to_vec(&constants::ED25519_BASEPOINT_POINT).unwrap();
|
||
// CBOR apparently has two bytes of overhead for a 32-byte string.
|
||
// Set the low byte of the compressed point to 1 to make it invalid.
|
||
output[2] = 1;
|
||
let parsed: Result<EdwardsPoint, _> = serde_cbor::from_slice(&output);
|
||
assert!(parsed.is_err());
|
||
}
|
||
}
|
||
|
||
// ------------------------------------------------------------------------
|
||
// Benchmarks
|
||
// ------------------------------------------------------------------------
|
||
|
||
#[cfg(all(test, feature = "bench"))]
|
||
mod bench {
|
||
use rand::OsRng;
|
||
use test::Bencher;
|
||
use constants;
|
||
use super::*;
|
||
use super::test::A_SCALAR;
|
||
|
||
#[bench]
|
||
fn edwards_decompress(b: &mut Bencher) {
|
||
let B = &constants::ED25519_BASEPOINT_COMPRESSED;
|
||
b.iter(|| B.decompress().unwrap());
|
||
}
|
||
|
||
#[bench]
|
||
fn edwards_compress(b: &mut Bencher) {
|
||
let B = &constants::ED25519_BASEPOINT_POINT;
|
||
b.iter(|| B.compress());
|
||
}
|
||
|
||
#[bench]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn basepoint_mult(b: &mut Bencher) {
|
||
let B = &constants::ED25519_BASEPOINT_TABLE;
|
||
b.iter(|| B * &A_SCALAR);
|
||
}
|
||
|
||
#[bench]
|
||
fn scalar_mult(b: &mut Bencher) {
|
||
let B = &constants::ED25519_BASEPOINT_POINT;
|
||
b.iter(|| B * &A_SCALAR);
|
||
}
|
||
|
||
#[bench]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn bench_select_precomputed_point(b: &mut Bencher) {
|
||
use test::black_box;
|
||
let table = &constants::ED25519_BASEPOINT_TABLE.0[0];
|
||
b.iter(|| table.select(black_box(5)) );
|
||
}
|
||
|
||
#[bench]
|
||
fn add_extended_and_projective_niels_output_completed(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT;
|
||
let p2 = constants::ED25519_BASEPOINT_POINT.to_projective_niels();
|
||
|
||
b.iter(|| &p1 + &p2);
|
||
}
|
||
|
||
#[bench]
|
||
fn add_extended_and_projective_niels_output_extended(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT;
|
||
let p2 = constants::ED25519_BASEPOINT_POINT.to_projective_niels();
|
||
|
||
b.iter(|| (&p1 + &p2).to_extended());
|
||
}
|
||
|
||
#[bench]
|
||
fn add_extended_and_affine_niels_output_completed(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT;
|
||
let p2 = constants::ED25519_BASEPOINT_POINT.to_affine_niels();
|
||
|
||
b.iter(|| &p1 + &p2);
|
||
}
|
||
|
||
#[bench]
|
||
fn add_extended_and_affine_niels_output_extended(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT;
|
||
let p2 = constants::ED25519_BASEPOINT_POINT.to_affine_niels();
|
||
|
||
b.iter(|| (&p1 + &p2).to_extended());
|
||
}
|
||
|
||
#[bench]
|
||
fn projective_double_output_completed(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT.to_projective();
|
||
|
||
b.iter(|| p1.double());
|
||
}
|
||
|
||
#[bench]
|
||
fn extended_double_output_extended(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT;
|
||
|
||
b.iter(|| p1.double());
|
||
}
|
||
|
||
#[bench]
|
||
fn mult_by_cofactor(b: &mut Bencher) {
|
||
let p1 = constants::ED25519_BASEPOINT_POINT;
|
||
|
||
b.iter(|| p1.mult_by_cofactor());
|
||
}
|
||
|
||
#[bench]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn create_basepoint_table(b: &mut Bencher) {
|
||
let aB = &constants::ED25519_BASEPOINT_TABLE * &A_SCALAR;
|
||
b.iter(|| EdwardsBasepointTable::create(&aB));
|
||
}
|
||
|
||
#[bench]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn ten_fold_scalar_mult(b: &mut Bencher) {
|
||
let mut csprng: OsRng = OsRng::new().unwrap();
|
||
// Create 10 random scalars
|
||
let scalars: Vec<_> = (0..10).map(|_| Scalar::random(&mut csprng)).collect();
|
||
// Create 10 points (by doing scalar mults)
|
||
let B = &constants::ED25519_BASEPOINT_TABLE;
|
||
let points: Vec<_> = scalars.iter().map(|s| B * &s).collect();
|
||
|
||
b.iter(|| multiscalar_mult(&scalars, &points));
|
||
}
|
||
|
||
mod vartime {
|
||
use super::super::*;
|
||
use super::super::test::{A_SCALAR, B_SCALAR, A_TIMES_BASEPOINT};
|
||
use super::{Bencher, OsRng};
|
||
|
||
#[bench]
|
||
fn bench_double_scalar_mult_basepoint(b: &mut Bencher) {
|
||
let A = A_TIMES_BASEPOINT.decompress().unwrap();
|
||
b.iter(|| vartime::double_scalar_mult_basepoint(&A_SCALAR, &A, &B_SCALAR));
|
||
}
|
||
|
||
#[bench]
|
||
#[cfg(feature="precomputed_tables")]
|
||
fn ten_fold_scalar_mult(b: &mut Bencher) {
|
||
let mut csprng: OsRng = OsRng::new().unwrap();
|
||
// Create 10 random scalars
|
||
let scalars: Vec<_> = (0..10).map(|_| Scalar::random(&mut csprng)).collect();
|
||
// Create 10 points (by doing scalar mults)
|
||
let B = &constants::ED25519_BASEPOINT_TABLE;
|
||
let points: Vec<_> = scalars.iter().map(|s| B * &s).collect();
|
||
|
||
// XXX Currently Rust's benchmarking implementation doesn't
|
||
// allow you to specify a sequence of random inputs, but only
|
||
// many trials of the same input.
|
||
//
|
||
// Since this is a variable-time function, this means the
|
||
// benchmark is only useful as a ballpark measurement.
|
||
b.iter(|| vartime::multiscalar_mult(&scalars, &points));
|
||
}
|
||
}
|
||
}
|