str4d
6 years ago
committed by
GitHub
89 changed files with 2601 additions and 2675 deletions
@ -0,0 +1,18 @@
|
||||
[package] |
||||
name = "ff" |
||||
version = "0.4.0" |
||||
authors = ["Sean Bowe <[email protected]>"] |
||||
description = "Library for building and interfacing with finite fields" |
||||
documentation = "https://docs.rs/ff/" |
||||
homepage = "https://github.com/ebfull/ff" |
||||
license = "MIT/Apache-2.0" |
||||
repository = "https://github.com/ebfull/ff" |
||||
|
||||
[dependencies] |
||||
byteorder = "1" |
||||
rand = "0.4" |
||||
ff_derive = { version = "0.3.0", path = "ff_derive", optional = true } |
||||
|
||||
[features] |
||||
default = [] |
||||
derive = ["ff_derive"] |
||||
@ -0,0 +1,202 @@
|
||||
Apache License |
||||
Version 2.0, January 2004 |
||||
http://www.apache.org/licenses/ |
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||
|
||||
1. Definitions. |
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, |
||||
and distribution as defined by Sections 1 through 9 of this document. |
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by |
||||
the copyright owner that is granting the License. |
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all |
||||
other entities that control, are controlled by, or are under common |
||||
control with that entity. For the purposes of this definition, |
||||
"control" means (i) the power, direct or indirect, to cause the |
||||
direction or management of such entity, whether by contract or |
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||
outstanding shares, or (iii) beneficial ownership of such entity. |
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity |
||||
exercising permissions granted by this License. |
||||
|
||||
"Source" form shall mean the preferred form for making modifications, |
||||
including but not limited to software source code, documentation |
||||
source, and configuration files. |
||||
|
||||
"Object" form shall mean any form resulting from mechanical |
||||
transformation or translation of a Source form, including but |
||||
not limited to compiled object code, generated documentation, |
||||
and conversions to other media types. |
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or |
||||
Object form, made available under the License, as indicated by a |
||||
copyright notice that is included in or attached to the work |
||||
(an example is provided in the Appendix below). |
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object |
||||
form, that is based on (or derived from) the Work and for which the |
||||
editorial revisions, annotations, elaborations, or other modifications |
||||
represent, as a whole, an original work of authorship. For the purposes |
||||
of this License, Derivative Works shall not include works that remain |
||||
separable from, or merely link (or bind by name) to the interfaces of, |
||||
the Work and Derivative Works thereof. |
||||
|
||||
"Contribution" shall mean any work of authorship, including |
||||
the original version of the Work and any modifications or additions |
||||
to that Work or Derivative Works thereof, that is intentionally |
||||
submitted to Licensor for inclusion in the Work by the copyright owner |
||||
or by an individual or Legal Entity authorized to submit on behalf of |
||||
the copyright owner. For the purposes of this definition, "submitted" |
||||
means any form of electronic, verbal, or written communication sent |
||||
to the Licensor or its representatives, including but not limited to |
||||
communication on electronic mailing lists, source code control systems, |
||||
and issue tracking systems that are managed by, or on behalf of, the |
||||
Licensor for the purpose of discussing and improving the Work, but |
||||
excluding communication that is conspicuously marked or otherwise |
||||
designated in writing by the copyright owner as "Not a Contribution." |
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||
on behalf of whom a Contribution has been received by Licensor and |
||||
subsequently incorporated within the Work. |
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
copyright license to reproduce, prepare Derivative Works of, |
||||
publicly display, publicly perform, sublicense, and distribute the |
||||
Work and such Derivative Works in Source or Object form. |
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
(except as stated in this section) patent license to make, have made, |
||||
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||
where such license applies only to those patent claims licensable |
||||
by such Contributor that are necessarily infringed by their |
||||
Contribution(s) alone or by combination of their Contribution(s) |
||||
with the Work to which such Contribution(s) was submitted. If You |
||||
institute patent litigation against any entity (including a |
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||
or a Contribution incorporated within the Work constitutes direct |
||||
or contributory patent infringement, then any patent licenses |
||||
granted to You under this License for that Work shall terminate |
||||
as of the date such litigation is filed. |
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the |
||||
Work or Derivative Works thereof in any medium, with or without |
||||
modifications, and in Source or Object form, provided that You |
||||
meet the following conditions: |
||||
|
||||
(a) You must give any other recipients of the Work or |
||||
Derivative Works a copy of this License; and |
||||
|
||||
(b) You must cause any modified files to carry prominent notices |
||||
stating that You changed the files; and |
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works |
||||
that You distribute, all copyright, patent, trademark, and |
||||
attribution notices from the Source form of the Work, |
||||
excluding those notices that do not pertain to any part of |
||||
the Derivative Works; and |
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its |
||||
distribution, then any Derivative Works that You distribute must |
||||
include a readable copy of the attribution notices contained |
||||
within such NOTICE file, excluding those notices that do not |
||||
pertain to any part of the Derivative Works, in at least one |
||||
of the following places: within a NOTICE text file distributed |
||||
as part of the Derivative Works; within the Source form or |
||||
documentation, if provided along with the Derivative Works; or, |
||||
within a display generated by the Derivative Works, if and |
||||
wherever such third-party notices normally appear. The contents |
||||
of the NOTICE file are for informational purposes only and |
||||
do not modify the License. You may add Your own attribution |
||||
notices within Derivative Works that You distribute, alongside |
||||
or as an addendum to the NOTICE text from the Work, provided |
||||
that such additional attribution notices cannot be construed |
||||
as modifying the License. |
||||
|
||||
You may add Your own copyright statement to Your modifications and |
||||
may provide additional or different license terms and conditions |
||||
for use, reproduction, or distribution of Your modifications, or |
||||
for any such Derivative Works as a whole, provided Your use, |
||||
reproduction, and distribution of the Work otherwise complies with |
||||
the conditions stated in this License. |
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||
any Contribution intentionally submitted for inclusion in the Work |
||||
by You to the Licensor shall be under the terms and conditions of |
||||
this License, without any additional terms or conditions. |
||||
Notwithstanding the above, nothing herein shall supersede or modify |
||||
the terms of any separate license agreement you may have executed |
||||
with Licensor regarding such Contributions. |
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade |
||||
names, trademarks, service marks, or product names of the Licensor, |
||||
except as required for reasonable and customary use in describing the |
||||
origin of the Work and reproducing the content of the NOTICE file. |
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or |
||||
agreed to in writing, Licensor provides the Work (and each |
||||
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
implied, including, without limitation, any warranties or conditions |
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||
appropriateness of using or redistributing the Work and assume any |
||||
risks associated with Your exercise of permissions under this License. |
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, |
||||
whether in tort (including negligence), contract, or otherwise, |
||||
unless required by applicable law (such as deliberate and grossly |
||||
negligent acts) or agreed to in writing, shall any Contributor be |
||||
liable to You for damages, including any direct, indirect, special, |
||||
incidental, or consequential damages of any character arising as a |
||||
result of this License or out of the use or inability to use the |
||||
Work (including but not limited to damages for loss of goodwill, |
||||
work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses), even if such Contributor |
||||
has been advised of the possibility of such damages. |
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing |
||||
the Work or Derivative Works thereof, You may choose to offer, |
||||
and charge a fee for, acceptance of support, warranty, indemnity, |
||||
or other liability obligations and/or rights consistent with this |
||||
License. However, in accepting such obligations, You may act only |
||||
on Your own behalf and on Your sole responsibility, not on behalf |
||||
of any other Contributor, and only if You agree to indemnify, |
||||
defend, and hold each Contributor harmless for any liability |
||||
incurred by, or claims asserted against, such Contributor by reason |
||||
of your accepting any such warranty or additional liability. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
APPENDIX: How to apply the Apache License to your work. |
||||
|
||||
To apply the Apache License to your work, attach the following |
||||
boilerplate notice, with the fields enclosed by brackets "[]" |
||||
replaced with your own identifying information. (Don't include |
||||
the brackets!) The text should be enclosed in the appropriate |
||||
comment syntax for the file format. We also recommend that a |
||||
file or class name and description of purpose be included on the |
||||
same "printed page" as the copyright notice for easier |
||||
identification within third-party archives. |
||||
|
||||
Copyright [yyyy] [name of copyright owner] |
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0 |
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
||||
|
||||
@ -0,0 +1,21 @@
|
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2017 Sean Bowe |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
THE SOFTWARE. |
||||
@ -0,0 +1,60 @@
|
||||
# ff |
||||
|
||||
`ff` is a finite field library written in pure Rust, with no `unsafe{}` code. |
||||
|
||||
## Disclaimers |
||||
|
||||
* This library does not provide constant-time guarantees. |
||||
|
||||
## Usage |
||||
|
||||
Add the `ff` crate to your `Cargo.toml`: |
||||
|
||||
```toml |
||||
[dependencies] |
||||
ff = "0.4" |
||||
``` |
||||
|
||||
The `ff` crate contains `Field`, `PrimeField`, `PrimeFieldRepr` and `SqrtField` traits. See the **[documentation](https://docs.rs/ff/0.4.0/ff/)** for more. |
||||
|
||||
### #![derive(PrimeField)] |
||||
|
||||
If you need an implementation of a prime field, this library also provides a procedural macro that will expand into an efficient implementation of a prime field when supplied with the modulus. `PrimeFieldGenerator` must be an element of Fp of p-1 order, that is also quadratic nonresidue. |
||||
|
||||
First, enable the `derive` crate feature: |
||||
|
||||
```toml |
||||
[dependencies] |
||||
ff = { version = "0.4", features = ["derive"] } |
||||
``` |
||||
|
||||
And then use the macro like so: |
||||
|
||||
```rust |
||||
extern crate rand; |
||||
#[macro_use] |
||||
extern crate ff; |
||||
|
||||
#[derive(PrimeField)] |
||||
#[PrimeFieldModulus = "52435875175126190479447740508185965837690552500527637822603658699938581184513"] |
||||
#[PrimeFieldGenerator = "7"] |
||||
struct Fp(FpRepr); |
||||
``` |
||||
|
||||
And that's it! `Fp` now implements `Field` and `PrimeField`. `Fp` will also implement `SqrtField` if supported. The library implements `FpRepr` itself and derives `PrimeFieldRepr` for it. |
||||
|
||||
## License |
||||
|
||||
Licensed under either of |
||||
|
||||
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
||||
|
||||
at your option. |
||||
|
||||
### Contribution |
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally |
||||
submitted for inclusion in the work by you, as defined in the Apache-2.0 |
||||
license, shall be dual licensed as above, without any additional terms or |
||||
conditions. |
||||
@ -0,0 +1,20 @@
|
||||
[package] |
||||
name = "ff_derive" |
||||
version = "0.3.0" |
||||
authors = ["Sean Bowe <[email protected]>"] |
||||
description = "Procedural macro library used to build custom prime field implementations" |
||||
documentation = "https://docs.rs/ff/" |
||||
homepage = "https://github.com/ebfull/ff" |
||||
license = "MIT/Apache-2.0" |
||||
repository = "https://github.com/ebfull/ff" |
||||
|
||||
[lib] |
||||
proc-macro = true |
||||
|
||||
[dependencies] |
||||
num-bigint = "0.2" |
||||
num-traits = "0.2" |
||||
num-integer = "0.1" |
||||
proc-macro2 = "0.4" |
||||
quote = "0.6" |
||||
syn = "0.14" |
||||
@ -0,0 +1,393 @@
|
||||
#![allow(unused_imports)] |
||||
|
||||
extern crate byteorder; |
||||
extern crate rand; |
||||
|
||||
#[cfg(feature = "derive")] |
||||
#[macro_use] |
||||
extern crate ff_derive; |
||||
|
||||
#[cfg(feature = "derive")] |
||||
pub use ff_derive::*; |
||||
|
||||
use std::error::Error; |
||||
use std::fmt; |
||||
use std::io::{self, Read, Write}; |
||||
|
||||
/// This trait represents an element of a field.
|
||||
pub trait Field: |
||||
Sized + Eq + Copy + Clone + Send + Sync + fmt::Debug + fmt::Display + 'static + rand::Rand |
||||
{ |
||||
/// Returns the zero element of the field, the additive identity.
|
||||
fn zero() -> Self; |
||||
|
||||
/// Returns the one element of the field, the multiplicative identity.
|
||||
fn one() -> Self; |
||||
|
||||
/// Returns true iff this element is zero.
|
||||
fn is_zero(&self) -> bool; |
||||
|
||||
/// Squares this element.
|
||||
fn square(&mut self); |
||||
|
||||
/// Doubles this element.
|
||||
fn double(&mut self); |
||||
|
||||
/// Negates this element.
|
||||
fn negate(&mut self); |
||||
|
||||
/// Adds another element to this element.
|
||||
fn add_assign(&mut self, other: &Self); |
||||
|
||||
/// Subtracts another element from this element.
|
||||
fn sub_assign(&mut self, other: &Self); |
||||
|
||||
/// Multiplies another element by this element.
|
||||
fn mul_assign(&mut self, other: &Self); |
||||
|
||||
/// Computes the multiplicative inverse of this element, if nonzero.
|
||||
fn inverse(&self) -> Option<Self>; |
||||
|
||||
/// Exponentiates this element by a power of the base prime modulus via
|
||||
/// the Frobenius automorphism.
|
||||
fn frobenius_map(&mut self, power: usize); |
||||
|
||||
/// Exponentiates this element by a number represented with `u64` limbs,
|
||||
/// least significant digit first.
|
||||
fn pow<S: AsRef<[u64]>>(&self, exp: S) -> Self { |
||||
let mut res = Self::one(); |
||||
|
||||
let mut found_one = false; |
||||
|
||||
for i in BitIterator::new(exp) { |
||||
if found_one { |
||||
res.square(); |
||||
} else { |
||||
found_one = i; |
||||
} |
||||
|
||||
if i { |
||||
res.mul_assign(self); |
||||
} |
||||
} |
||||
|
||||
res |
||||
} |
||||
} |
||||
|
||||
/// This trait represents an element of a field that has a square root operation described for it.
|
||||
pub trait SqrtField: Field { |
||||
/// Returns the Legendre symbol of the field element.
|
||||
fn legendre(&self) -> LegendreSymbol; |
||||
|
||||
/// Returns the square root of the field element, if it is
|
||||
/// quadratic residue.
|
||||
fn sqrt(&self) -> Option<Self>; |
||||
} |
||||
|
||||
/// This trait represents a wrapper around a biginteger which can encode any element of a particular
|
||||
/// prime field. It is a smart wrapper around a sequence of `u64` limbs, least-significant digit
|
||||
/// first.
|
||||
pub trait PrimeFieldRepr: |
||||
Sized |
||||
+ Copy |
||||
+ Clone |
||||
+ Eq |
||||
+ Ord |
||||
+ Send |
||||
+ Sync |
||||
+ Default |
||||
+ fmt::Debug |
||||
+ fmt::Display |
||||
+ 'static |
||||
+ rand::Rand |
||||
+ AsRef<[u64]> |
||||
+ AsMut<[u64]> |
||||
+ From<u64> |
||||
{ |
||||
/// Subtract another represetation from this one.
|
||||
fn sub_noborrow(&mut self, other: &Self); |
||||
|
||||
/// Add another representation to this one.
|
||||
fn add_nocarry(&mut self, other: &Self); |
||||
|
||||
/// Compute the number of bits needed to encode this number. Always a
|
||||
/// multiple of 64.
|
||||
fn num_bits(&self) -> u32; |
||||
|
||||
/// Returns true iff this number is zero.
|
||||
fn is_zero(&self) -> bool; |
||||
|
||||
/// Returns true iff this number is odd.
|
||||
fn is_odd(&self) -> bool; |
||||
|
||||
/// Returns true iff this number is even.
|
||||
fn is_even(&self) -> bool; |
||||
|
||||
/// Performs a rightwise bitshift of this number, effectively dividing
|
||||
/// it by 2.
|
||||
fn div2(&mut self); |
||||
|
||||
/// Performs a rightwise bitshift of this number by some amount.
|
||||
fn shr(&mut self, amt: u32); |
||||
|
||||
/// Performs a leftwise bitshift of this number, effectively multiplying
|
||||
/// it by 2. Overflow is ignored.
|
||||
fn mul2(&mut self); |
||||
|
||||
/// Performs a leftwise bitshift of this number by some amount.
|
||||
fn shl(&mut self, amt: u32); |
||||
|
||||
/// Writes this `PrimeFieldRepr` as a big endian integer.
|
||||
fn write_be<W: Write>(&self, mut writer: W) -> io::Result<()> { |
||||
use byteorder::{BigEndian, WriteBytesExt}; |
||||
|
||||
for digit in self.as_ref().iter().rev() { |
||||
writer.write_u64::<BigEndian>(*digit)?; |
||||
} |
||||
|
||||
Ok(()) |
||||
} |
||||
|
||||
/// Reads a big endian integer into this representation.
|
||||
fn read_be<R: Read>(&mut self, mut reader: R) -> io::Result<()> { |
||||
use byteorder::{BigEndian, ReadBytesExt}; |
||||
|
||||
for digit in self.as_mut().iter_mut().rev() { |
||||
*digit = reader.read_u64::<BigEndian>()?; |
||||
} |
||||
|
||||
Ok(()) |
||||
} |
||||
|
||||
/// Writes this `PrimeFieldRepr` as a little endian integer.
|
||||
fn write_le<W: Write>(&self, mut writer: W) -> io::Result<()> { |
||||
use byteorder::{LittleEndian, WriteBytesExt}; |
||||
|
||||
for digit in self.as_ref().iter() { |
||||
writer.write_u64::<LittleEndian>(*digit)?; |
||||
} |
||||
|
||||
Ok(()) |
||||
} |
||||
|
||||
/// Reads a little endian integer into this representation.
|
||||
fn read_le<R: Read>(&mut self, mut reader: R) -> io::Result<()> { |
||||
use byteorder::{LittleEndian, ReadBytesExt}; |
||||
|
||||
for digit in self.as_mut().iter_mut() { |
||||
*digit = reader.read_u64::<LittleEndian>()?; |
||||
} |
||||
|
||||
Ok(()) |
||||
} |
||||
} |
||||
|
||||
#[derive(Debug, PartialEq)] |
||||
pub enum LegendreSymbol { |
||||
Zero = 0, |
||||
QuadraticResidue = 1, |
||||
QuadraticNonResidue = -1, |
||||
} |
||||
|
||||
/// An error that may occur when trying to interpret a `PrimeFieldRepr` as a
|
||||
/// `PrimeField` element.
|
||||
#[derive(Debug)] |
||||
pub enum PrimeFieldDecodingError { |
||||
/// The encoded value is not in the field
|
||||
NotInField(String), |
||||
} |
||||
|
||||
impl Error for PrimeFieldDecodingError { |
||||
fn description(&self) -> &str { |
||||
match *self { |
||||
PrimeFieldDecodingError::NotInField(..) => "not an element of the field", |
||||
} |
||||
} |
||||
} |
||||
|
||||
impl fmt::Display for PrimeFieldDecodingError { |
||||
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { |
||||
match *self { |
||||
PrimeFieldDecodingError::NotInField(ref repr) => { |
||||
write!(f, "{} is not an element of the field", repr) |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
/// This represents an element of a prime field.
|
||||
pub trait PrimeField: Field { |
||||
/// The prime field can be converted back and forth into this biginteger
|
||||
/// representation.
|
||||
type Repr: PrimeFieldRepr + From<Self>; |
||||
|
||||
/// Interpret a string of numbers as a (congruent) prime field element.
|
||||
/// Does not accept unnecessary leading zeroes or a blank string.
|
||||
fn from_str(s: &str) -> Option<Self> { |
||||
if s.is_empty() { |
||||
return None; |
||||
} |
||||
|
||||
if s == "0" { |
||||
return Some(Self::zero()); |
||||
} |
||||
|
||||
let mut res = Self::zero(); |
||||
|
||||
let ten = Self::from_repr(Self::Repr::from(10)).unwrap(); |
||||
|
||||
let mut first_digit = true; |
||||
|
||||
for c in s.chars() { |
||||
match c.to_digit(10) { |
||||
Some(c) => { |
||||
if first_digit { |
||||
if c == 0 { |
||||
return None; |
||||
} |
||||
|
||||
first_digit = false; |
||||
} |
||||
|
||||
res.mul_assign(&ten); |
||||
res.add_assign(&Self::from_repr(Self::Repr::from(u64::from(c))).unwrap()); |
||||
} |
||||
None => { |
||||
return None; |
||||
} |
||||
} |
||||
} |
||||
|
||||
Some(res) |
||||
} |
||||
|
||||
/// Convert this prime field element into a biginteger representation.
|
||||
fn from_repr(Self::Repr) -> Result<Self, PrimeFieldDecodingError>; |
||||
|
||||
/// Convert a biginteger representation into a prime field element, if
|
||||
/// the number is an element of the field.
|
||||
fn into_repr(&self) -> Self::Repr; |
||||
|
||||
/// Returns the field characteristic; the modulus.
|
||||
fn char() -> Self::Repr; |
||||
|
||||
/// How many bits are needed to represent an element of this field.
|
||||
const NUM_BITS: u32; |
||||
|
||||
/// How many bits of information can be reliably stored in the field element.
|
||||
const CAPACITY: u32; |
||||
|
||||
/// Returns the multiplicative generator of `char()` - 1 order. This element
|
||||
/// must also be quadratic nonresidue.
|
||||
fn multiplicative_generator() -> Self; |
||||
|
||||
/// 2^s * t = `char()` - 1 with t odd.
|
||||
const S: u32; |
||||
|
||||
/// Returns the 2^s root of unity computed by exponentiating the `multiplicative_generator()`
|
||||
/// by t.
|
||||
fn root_of_unity() -> Self; |
||||
} |
||||
|
||||
/// An "engine" is a collection of types (fields, elliptic curve groups, etc.)
|
||||
/// with well-defined relationships. Specific relationships (for example, a
|
||||
/// pairing-friendly curve) can be defined in a subtrait.
|
||||
pub trait ScalarEngine: Sized + 'static + Clone { |
||||
/// This is the scalar field of the engine's groups.
|
||||
type Fr: PrimeField + SqrtField; |
||||
} |
||||
|
||||
#[derive(Debug)] |
||||
pub struct BitIterator<E> { |
||||
t: E, |
||||
n: usize, |
||||
} |
||||
|
||||
impl<E: AsRef<[u64]>> BitIterator<E> { |
||||
pub fn new(t: E) -> Self { |
||||
let n = t.as_ref().len() * 64; |
||||
|
||||
BitIterator { t, n } |
||||
} |
||||
} |
||||
|
||||
impl<E: AsRef<[u64]>> Iterator for BitIterator<E> { |
||||
type Item = bool; |
||||
|
||||
fn next(&mut self) -> Option<bool> { |
||||
if self.n == 0 { |
||||
None |
||||
} else { |
||||
self.n -= 1; |
||||
let part = self.n / 64; |
||||
let bit = self.n - (64 * part); |
||||
|
||||
Some(self.t.as_ref()[part] & (1 << bit) > 0) |
||||
} |
||||
} |
||||
} |
||||
|
||||
#[test] |
||||
fn test_bit_iterator() { |
||||
let mut a = BitIterator::new([0xa953d79b83f6ab59, 0x6dea2059e200bd39]); |
||||
let expected = "01101101111010100010000001011001111000100000000010111101001110011010100101010011110101111001101110000011111101101010101101011001"; |
||||
|
||||
for e in expected.chars() { |
||||
assert!(a.next().unwrap() == (e == '1')); |
||||
} |
||||
|
||||
assert!(a.next().is_none()); |
||||
|
||||
let expected = "1010010101111110101010000101101011101000011101110101001000011001100100100011011010001011011011010001011011101100110100111011010010110001000011110100110001100110011101101000101100011100100100100100001010011101010111110011101011000011101000111011011101011001"; |
||||
|
||||
let mut a = BitIterator::new([ |
||||
0x429d5f3ac3a3b759, |
||||
0xb10f4c66768b1c92, |
||||
0x92368b6d16ecd3b4, |
||||
0xa57ea85ae8775219, |
||||
]); |
||||
|
||||
for e in expected.chars() { |
||||
assert!(a.next().unwrap() == (e == '1')); |
||||
} |
||||
|
||||
assert!(a.next().is_none()); |
||||
} |
||||
|
||||
pub use self::arith_impl::*; |
||||
|
||||
mod arith_impl { |
||||
/// Calculate a - b - borrow, returning the result and modifying
|
||||
/// the borrow value.
|
||||
#[inline(always)] |
||||
pub fn sbb(a: u64, b: u64, borrow: &mut u64) -> u64 { |
||||
let tmp = (1u128 << 64) + u128::from(a) - u128::from(b) - u128::from(*borrow); |
||||
|
||||
*borrow = if tmp >> 64 == 0 { 1 } else { 0 }; |
||||
|
||||
tmp as u64 |
||||
} |
||||
|
||||
/// Calculate a + b + carry, returning the sum and modifying the
|
||||
/// carry value.
|
||||
#[inline(always)] |
||||
pub fn adc(a: u64, b: u64, carry: &mut u64) -> u64 { |
||||
let tmp = u128::from(a) + u128::from(b) + u128::from(*carry); |
||||
|
||||
*carry = (tmp >> 64) as u64; |
||||
|
||||
tmp as u64 |
||||
} |
||||
|
||||
/// Calculate a + (b * c) + carry, returning the least significant digit
|
||||
/// and setting carry to the most significant digit.
|
||||
#[inline(always)] |
||||
pub fn mac_with_carry(a: u64, b: u64, c: u64, carry: &mut u64) -> u64 { |
||||
let tmp = (u128::from(a)) + u128::from(b) * u128::from(c) + u128::from(*carry); |
||||
|
||||
*carry = (tmp >> 64) as u64; |
||||
|
||||
tmp as u64 |
||||
} |
||||
} |
||||
@ -0,0 +1,14 @@
|
||||
Copyrights in the "group" library are retained by their contributors. No |
||||
copyright assignment is required to contribute to the "group" library. |
||||
|
||||
The "group" library is licensed under either of |
||||
|
||||
* Apache License, Version 2.0, (see ./LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) |
||||
* MIT license (see ./LICENSE-MIT or http://opensource.org/licenses/MIT) |
||||
|
||||
at your option. |
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally |
||||
submitted for inclusion in the work by you, as defined in the Apache-2.0 |
||||
license, shall be dual licensed as above, without any additional terms or |
||||
conditions. |
||||
@ -0,0 +1,17 @@
|
||||
[package] |
||||
name = "group" |
||||
version = "0.1.0" |
||||
authors = [ |
||||
"Sean Bowe <[email protected]>", |
||||
"Jack Grigg <[email protected]>", |
||||
] |
||||
license = "MIT/Apache-2.0" |
||||
|
||||
description = "Elliptic curve group traits and utilities" |
||||
documentation = "https://docs.rs/group/" |
||||
homepage = "https://github.com/ebfull/group" |
||||
repository = "https://github.com/ebfull/group" |
||||
|
||||
[dependencies] |
||||
ff = { path = "../ff" } |
||||
rand = "0.4" |
||||
@ -0,0 +1,201 @@
|
||||
Apache License |
||||
Version 2.0, January 2004 |
||||
http://www.apache.org/licenses/ |
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||
|
||||
1. Definitions. |
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, |
||||
and distribution as defined by Sections 1 through 9 of this document. |
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by |
||||
the copyright owner that is granting the License. |
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all |
||||
other entities that control, are controlled by, or are under common |
||||
control with that entity. For the purposes of this definition, |
||||
"control" means (i) the power, direct or indirect, to cause the |
||||
direction or management of such entity, whether by contract or |
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||
outstanding shares, or (iii) beneficial ownership of such entity. |
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity |
||||
exercising permissions granted by this License. |
||||
|
||||
"Source" form shall mean the preferred form for making modifications, |
||||
including but not limited to software source code, documentation |
||||
source, and configuration files. |
||||
|
||||
"Object" form shall mean any form resulting from mechanical |
||||
transformation or translation of a Source form, including but |
||||
not limited to compiled object code, generated documentation, |
||||
and conversions to other media types. |
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or |
||||
Object form, made available under the License, as indicated by a |
||||
copyright notice that is included in or attached to the work |
||||
(an example is provided in the Appendix below). |
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object |
||||
form, that is based on (or derived from) the Work and for which the |
||||
editorial revisions, annotations, elaborations, or other modifications |
||||
represent, as a whole, an original work of authorship. For the purposes |
||||
of this License, Derivative Works shall not include works that remain |
||||
separable from, or merely link (or bind by name) to the interfaces of, |
||||
the Work and Derivative Works thereof. |
||||
|
||||
"Contribution" shall mean any work of authorship, including |
||||
the original version of the Work and any modifications or additions |
||||
to that Work or Derivative Works thereof, that is intentionally |
||||
submitted to Licensor for inclusion in the Work by the copyright owner |
||||
or by an individual or Legal Entity authorized to submit on behalf of |
||||
the copyright owner. For the purposes of this definition, "submitted" |
||||
means any form of electronic, verbal, or written communication sent |
||||
to the Licensor or its representatives, including but not limited to |
||||
communication on electronic mailing lists, source code control systems, |
||||
and issue tracking systems that are managed by, or on behalf of, the |
||||
Licensor for the purpose of discussing and improving the Work, but |
||||
excluding communication that is conspicuously marked or otherwise |
||||
designated in writing by the copyright owner as "Not a Contribution." |
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||
on behalf of whom a Contribution has been received by Licensor and |
||||
subsequently incorporated within the Work. |
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
copyright license to reproduce, prepare Derivative Works of, |
||||
publicly display, publicly perform, sublicense, and distribute the |
||||
Work and such Derivative Works in Source or Object form. |
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of |
||||
this License, each Contributor hereby grants to You a perpetual, |
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||
(except as stated in this section) patent license to make, have made, |
||||
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||
where such license applies only to those patent claims licensable |
||||
by such Contributor that are necessarily infringed by their |
||||
Contribution(s) alone or by combination of their Contribution(s) |
||||
with the Work to which such Contribution(s) was submitted. If You |
||||
institute patent litigation against any entity (including a |
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||
or a Contribution incorporated within the Work constitutes direct |
||||
or contributory patent infringement, then any patent licenses |
||||
granted to You under this License for that Work shall terminate |
||||
as of the date such litigation is filed. |
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the |
||||
Work or Derivative Works thereof in any medium, with or without |
||||
modifications, and in Source or Object form, provided that You |
||||
meet the following conditions: |
||||
|
||||
(a) You must give any other recipients of the Work or |
||||
Derivative Works a copy of this License; and |
||||
|
||||
(b) You must cause any modified files to carry prominent notices |
||||
stating that You changed the files; and |
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works |
||||
that You distribute, all copyright, patent, trademark, and |
||||
attribution notices from the Source form of the Work, |
||||
excluding those notices that do not pertain to any part of |
||||
the Derivative Works; and |
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its |
||||
distribution, then any Derivative Works that You distribute must |
||||
include a readable copy of the attribution notices contained |
||||
within such NOTICE file, excluding those notices that do not |
||||
pertain to any part of the Derivative Works, in at least one |
||||
of the following places: within a NOTICE text file distributed |
||||
as part of the Derivative Works; within the Source form or |
||||
documentation, if provided along with the Derivative Works; or, |
||||
within a display generated by the Derivative Works, if and |
||||
wherever such third-party notices normally appear. The contents |
||||
of the NOTICE file are for informational purposes only and |
||||
do not modify the License. You may add Your own attribution |
||||
notices within Derivative Works that You distribute, alongside |
||||
or as an addendum to the NOTICE text from the Work, provided |
||||
that such additional attribution notices cannot be construed |
||||
as modifying the License. |
||||
|
||||
You may add Your own copyright statement to Your modifications and |
||||
may provide additional or different license terms and conditions |
||||
for use, reproduction, or distribution of Your modifications, or |
||||
for any such Derivative Works as a whole, provided Your use, |
||||
reproduction, and distribution of the Work otherwise complies with |
||||
the conditions stated in this License. |
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||
any Contribution intentionally submitted for inclusion in the Work |
||||
by You to the Licensor shall be under the terms and conditions of |
||||
this License, without any additional terms or conditions. |
||||
Notwithstanding the above, nothing herein shall supersede or modify |
||||
the terms of any separate license agreement you may have executed |
||||
with Licensor regarding such Contributions. |
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade |
||||
names, trademarks, service marks, or product names of the Licensor, |
||||
except as required for reasonable and customary use in describing the |
||||
origin of the Work and reproducing the content of the NOTICE file. |
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or |
||||
agreed to in writing, Licensor provides the Work (and each |
||||
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||
implied, including, without limitation, any warranties or conditions |
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||
appropriateness of using or redistributing the Work and assume any |
||||
risks associated with Your exercise of permissions under this License. |
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, |
||||
whether in tort (including negligence), contract, or otherwise, |
||||
unless required by applicable law (such as deliberate and grossly |
||||
negligent acts) or agreed to in writing, shall any Contributor be |
||||
liable to You for damages, including any direct, indirect, special, |
||||
incidental, or consequential damages of any character arising as a |
||||
result of this License or out of the use or inability to use the |
||||
Work (including but not limited to damages for loss of goodwill, |
||||
work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses), even if such Contributor |
||||
has been advised of the possibility of such damages. |
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing |
||||
the Work or Derivative Works thereof, You may choose to offer, |
||||
and charge a fee for, acceptance of support, warranty, indemnity, |
||||
or other liability obligations and/or rights consistent with this |
||||
License. However, in accepting such obligations, You may act only |
||||
on Your own behalf and on Your sole responsibility, not on behalf |
||||
of any other Contributor, and only if You agree to indemnify, |
||||
defend, and hold each Contributor harmless for any liability |
||||
incurred by, or claims asserted against, such Contributor by reason |
||||
of your accepting any such warranty or additional liability. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
APPENDIX: How to apply the Apache License to your work. |
||||
|
||||
To apply the Apache License to your work, attach the following |
||||
boilerplate notice, with the fields enclosed by brackets "[]" |
||||
replaced with your own identifying information. (Don't include |
||||
the brackets!) The text should be enclosed in the appropriate |
||||
comment syntax for the file format. We also recommend that a |
||||
file or class name and description of purpose be included on the |
||||
same "printed page" as the copyright notice for easier |
||||
identification within third-party archives. |
||||
|
||||
Copyright [yyyy] [name of copyright owner] |
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); |
||||
you may not use this file except in compliance with the License. |
||||
You may obtain a copy of the License at |
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0 |
||||
|
||||
Unless required by applicable law or agreed to in writing, software |
||||
distributed under the License is distributed on an "AS IS" BASIS, |
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
See the License for the specific language governing permissions and |
||||
limitations under the License. |
||||
@ -0,0 +1,23 @@
|
||||
Permission is hereby granted, free of charge, to any |
||||
person obtaining a copy of this software and associated |
||||
documentation files (the "Software"), to deal in the |
||||
Software without restriction, including without |
||||
limitation the rights to use, copy, modify, merge, |
||||
publish, distribute, sublicense, and/or sell copies of |
||||
the Software, and to permit persons to whom the Software |
||||
is furnished to do so, subject to the following |
||||
conditions: |
||||
|
||||
The above copyright notice and this permission notice |
||||
shall be included in all copies or substantial portions |
||||
of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF |
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED |
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A |
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT |
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR |
||||
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
||||
DEALINGS IN THE SOFTWARE. |
||||
@ -0,0 +1,17 @@
|
||||
# group [](https://crates.io/crates/group) # |
||||
|
||||
## License |
||||
|
||||
Licensed under either of |
||||
|
||||
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) |
||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) |
||||
|
||||
at your option. |
||||
|
||||
### Contribution |
||||
|
||||
Unless you explicitly state otherwise, any contribution intentionally |
||||
submitted for inclusion in the work by you, as defined in the Apache-2.0 |
||||
license, shall be dual licensed as above, without any additional terms or |
||||
conditions. |
||||
@ -0,0 +1,196 @@
|
||||
extern crate ff; |
||||
extern crate rand; |
||||
|
||||
use ff::{PrimeField, PrimeFieldDecodingError, ScalarEngine, SqrtField}; |
||||
use std::error::Error; |
||||
use std::fmt; |
||||
|
||||
pub mod tests; |
||||
|
||||
mod wnaf; |
||||
pub use self::wnaf::Wnaf; |
||||
|
||||
/// Projective representation of an elliptic curve point guaranteed to be
|
||||
/// in the correct prime order subgroup.
|
||||
pub trait CurveProjective: |
||||
PartialEq |
||||
+ Eq |
||||
+ Sized |
||||
+ Copy |
||||
+ Clone |
||||
+ Send |
||||
+ Sync |
||||
+ fmt::Debug |
||||
+ fmt::Display |
||||
+ rand::Rand |
||||
+ 'static |
||||
{ |
||||
type Engine: ScalarEngine<Fr = Self::Scalar>; |
||||
type Scalar: PrimeField + SqrtField; |
||||
type Base: SqrtField; |
||||
type Affine: CurveAffine<Projective = Self, Scalar = Self::Scalar>; |
||||
|
||||
/// Returns the additive identity.
|
||||
fn zero() -> Self; |
||||
|
||||
/// Returns a fixed generator of unknown exponent.
|
||||
fn one() -> Self; |
||||
|
||||
/// Determines if this point is the point at infinity.
|
||||
fn is_zero(&self) -> bool; |
||||
|
||||
/// Normalizes a slice of projective elements so that
|
||||
/// conversion to affine is cheap.
|
||||
fn batch_normalization(v: &mut [Self]); |
||||
|
||||
/// Checks if the point is already "normalized" so that
|
||||
/// cheap affine conversion is possible.
|
||||
fn is_normalized(&self) -> bool; |
||||
|
||||
/// Doubles this element.
|
||||
fn double(&mut self); |
||||
|
||||
/// Adds another element to this element.
|
||||
fn add_assign(&mut self, other: &Self); |
||||
|
||||
/// Subtracts another element from this element.
|
||||
fn sub_assign(&mut self, other: &Self) { |
||||
let mut tmp = *other; |
||||
tmp.negate(); |
||||
self.add_assign(&tmp); |
||||
} |
||||
|
||||
/// Adds an affine element to this element.
|
||||
fn add_assign_mixed(&mut self, other: &Self::Affine); |
||||
|
||||
/// Negates this element.
|
||||
fn negate(&mut self); |
||||
|
||||
/// Performs scalar multiplication of this element.
|
||||
fn mul_assign<S: Into<<Self::Scalar as PrimeField>::Repr>>(&mut self, other: S); |
||||
|
||||
/// Converts this element into its affine representation.
|
||||
fn into_affine(&self) -> Self::Affine; |
||||
|
||||
/// Recommends a wNAF window table size given a scalar. Always returns a number
|
||||
/// between 2 and 22, inclusive.
|
||||
fn recommended_wnaf_for_scalar(scalar: <Self::Scalar as PrimeField>::Repr) -> usize; |
||||
|
||||
/// Recommends a wNAF window size given the number of scalars you intend to multiply
|
||||
/// a base by. Always returns a number between 2 and 22, inclusive.
|
||||
fn recommended_wnaf_for_num_scalars(num_scalars: usize) -> usize; |
||||
} |
||||
|
||||
/// Affine representation of an elliptic curve point guaranteed to be
|
||||
/// in the correct prime order subgroup.
|
||||
pub trait CurveAffine: |
||||
Copy + Clone + Sized + Send + Sync + fmt::Debug + fmt::Display + PartialEq + Eq + 'static |
||||
{ |
||||
type Engine: ScalarEngine<Fr = Self::Scalar>; |
||||
type Scalar: PrimeField + SqrtField; |
||||
type Base: SqrtField; |
||||
type Projective: CurveProjective<Affine = Self, Scalar = Self::Scalar>; |
||||
type Uncompressed: EncodedPoint<Affine = Self>; |
||||
type Compressed: EncodedPoint<Affine = Self>; |
||||
|
||||
/// Returns the additive identity.
|
||||
fn zero() -> Self; |
||||
|
||||
/// Returns a fixed generator of unknown exponent.
|
||||
fn one() -> Self; |
||||
|
||||
/// Determines if this point represents the point at infinity; the
|
||||
/// additive identity.
|
||||
fn is_zero(&self) -> bool; |
||||
|
||||
/// Negates this element.
|
||||
fn negate(&mut self); |
||||
|
||||
/// Performs scalar multiplication of this element with mixed addition.
|
||||
fn mul<S: Into<<Self::Scalar as PrimeField>::Repr>>(&self, other: S) -> Self::Projective; |
||||
|
||||
/// Converts this element into its affine representation.
|
||||
fn into_projective(&self) -> Self::Projective; |
||||
|
||||
/// Converts this element into its compressed encoding, so long as it's not
|
||||
/// the point at infinity.
|
||||
fn into_compressed(&self) -> Self::Compressed { |
||||
<Self::Compressed as EncodedPoint>::from_affine(*self) |
||||
} |
||||
|
||||
/// Converts this element into its uncompressed encoding, so long as it's not
|
||||
/// the point at infinity.
|
||||
fn into_uncompressed(&self) -> Self::Uncompressed { |
||||
<Self::Uncompressed as EncodedPoint>::from_affine(*self) |
||||
} |
||||
} |
||||
|
||||
/// An encoded elliptic curve point, which should essentially wrap a `[u8; N]`.
|
||||
pub trait EncodedPoint: |
||||
Sized + Send + Sync + AsRef<[u8]> + AsMut<[u8]> + Clone + Copy + 'static |
||||
{ |
||||
type Affine: CurveAffine; |
||||
|
||||
/// Creates an empty representation.
|
||||
fn empty() -> Self; |
||||
|
||||
/// Returns the number of bytes consumed by this representation.
|
||||
fn size() -> usize; |
||||
|
||||
/// Converts an `EncodedPoint` into a `CurveAffine` element,
|
||||
/// if the encoding represents a valid element.
|
||||
fn into_affine(&self) -> Result<Self::Affine, GroupDecodingError>; |
||||
|
||||
/// Converts an `EncodedPoint` into a `CurveAffine` element,
|
||||
/// without guaranteeing that the encoding represents a valid
|
||||
/// element. This is useful when the caller knows the encoding is
|
||||
/// valid already.
|
||||
///
|
||||
/// If the encoding is invalid, this can break API invariants,
|
||||
/// so caution is strongly encouraged.
|
||||
fn into_affine_unchecked(&self) -> Result<Self::Affine, GroupDecodingError>; |
||||
|
||||
/// Creates an `EncodedPoint` from an affine point, as long as the
|
||||
/// point is not the point at infinity.
|
||||
fn from_affine(affine: Self::Affine) -> Self; |
||||
} |
||||
|
||||
/// An error that may occur when trying to decode an `EncodedPoint`.
|
||||
#[derive(Debug)] |
||||
pub enum GroupDecodingError { |
||||
/// The coordinate(s) do not lie on the curve.
|
||||
NotOnCurve, |
||||
/// The element is not part of the r-order subgroup.
|
||||
NotInSubgroup, |
||||
/// One of the coordinates could not be decoded
|
||||
CoordinateDecodingError(&'static str, PrimeFieldDecodingError), |
||||
/// The compression mode of the encoded element was not as expected
|
||||
UnexpectedCompressionMode, |
||||
/// The encoding contained bits that should not have been set
|
||||
UnexpectedInformation, |
||||
} |
||||
|
||||
impl Error for GroupDecodingError { |
||||
fn description(&self) -> &str { |
||||
match *self { |
||||
GroupDecodingError::NotOnCurve => "coordinate(s) do not lie on the curve", |
||||
GroupDecodingError::NotInSubgroup => "the element is not part of an r-order subgroup", |
||||
GroupDecodingError::CoordinateDecodingError(..) => "coordinate(s) could not be decoded", |
||||
GroupDecodingError::UnexpectedCompressionMode => { |
||||
"encoding has unexpected compression mode" |
||||
} |
||||
GroupDecodingError::UnexpectedInformation => "encoding has unexpected information", |
||||
} |
||||
} |
||||
} |
||||
|
||||
impl fmt::Display for GroupDecodingError { |
||||
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> { |
||||
match *self { |
||||
GroupDecodingError::CoordinateDecodingError(description, ref err) => { |
||||
write!(f, "{} decoding error: {}", description, err) |
||||
} |
||||
_ => write!(f, "{}", self.description()), |
||||
} |
||||
} |
||||
} |
||||
@ -1,4 +1,6 @@
|
||||
use super::{CurveProjective, PrimeField, PrimeFieldRepr}; |
||||
use ff::{PrimeField, PrimeFieldRepr}; |
||||
|
||||
use super::CurveProjective; |
||||
|
||||
/// Replaces the contents of `table` with a w-NAF window table for the given window size.
|
||||
pub(crate) fn wnaf_table<G: CurveProjective>(table: &mut Vec<G>, mut base: G, window: usize) { |
||||
@ -3,7 +3,10 @@ name = "pairing"
|
||||
|
||||
# Remember to change version string in README.md. |
||||
version = "0.14.2" |
||||
authors = ["Sean Bowe <[email protected]>"] |
||||
authors = [ |
||||
"Sean Bowe <[email protected]>", |
||||
"Jack Grigg <[email protected]>", |
||||
] |
||||
license = "MIT/Apache-2.0" |
||||
|
||||
description = "Pairing-friendly elliptic curve library" |
||||
@ -14,10 +17,10 @@ repository = "https://github.com/ebfull/pairing"
|
||||
[dependencies] |
||||
rand = "0.4" |
||||
byteorder = "1" |
||||
clippy = { version = "0.0.200", optional = true } |
||||
ff = { path = "../ff", features = ["derive"] } |
||||
group = { path = "../group" } |
||||
|
||||
[features] |
||||
unstable-features = ["expose-arith"] |
||||
expose-arith = [] |
||||
u128-support = [] |
||||
default = [] |
||||
|
||||
@ -1,4 +1,3 @@
|
||||
pub mod curve; |
||||
pub mod engine; |
||||
pub mod field; |
||||
pub mod repr; |
||||
|
||||
Loading…
Reference in new issue