-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3702a7c
Showing
9 changed files
with
531 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
target/ | ||
**/*.rs.bk | ||
Cargo.lock | ||
|
||
.cargo | ||
|
||
*~ | ||
\#* | ||
.\#* | ||
*.swp | ||
*.orig | ||
*.bak | ||
|
||
*.s |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
language: rust | ||
|
||
rust: | ||
- nightly | ||
|
||
env: | ||
- TEST_COMMAND=test EXTRA_FLAGS='' FEATURES='' | ||
- TEST_COMMAND=bench EXTRA_FLAGS='' FEATURES='bench' | ||
- TEST_COMMAND=build EXTRA_FLAGS='--no-default-features' FEATURES='nightly' | ||
|
||
matrix: | ||
include: | ||
- rust: stable | ||
env: TEST_COMMAND=test EXTRA_FLAGS='--no-default-features' FEATURES='std' | ||
- rust: beta | ||
env: TEST_COMMAND=test EXTRA_FLAGS='--no-default-features' FEATURES='std' | ||
|
||
script: | ||
- cargo $TEST_COMMAND --features="$FEATURES" $EXTRA_FLAGS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contributing to curve25519-dalek | ||
|
||
If you have questions or comments, please feel free to email the | ||
authors. | ||
|
||
For feature requests, suggestions, and bug reports, please open an issue on | ||
[our Github](https://github.com/isislovecruft/x25519-dalek). (Or, send us | ||
an email if you're opposed to using Github for whatever reason.) | ||
|
||
Patches are welcomed as pull requests on | ||
[our Github](https://github.com/isislovecruft/x25519-dalek), as well as by | ||
email (preferably sent to all of the authors listed in `Cargo.toml`). | ||
|
||
All issues on curve25519-dalek are mentored, if you want help with a bug just | ||
ask @isislovecruft. | ||
|
||
Some issues are easier than others. The `easy` label can be used to find the | ||
easy issues. If you want to work on an issue, please leave a comment so that we | ||
can assign it to you! | ||
|
||
# Code of Conduct | ||
|
||
We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html), | ||
with the following additional clauses: | ||
|
||
* We respect the rights to privacy and anonymity for contributors and people in | ||
the community. If someone wishes to contribute under a pseudonym different to | ||
their primary identity, that wish is to be respected by all contributors. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
[package] | ||
name = "x25519-dalek" | ||
version = "0.0.0" | ||
authors = ["Isis Lovecruft <isis@patternsinthevoid.net>"] | ||
readme = "README.md" | ||
license = "BSD-3-Clause" | ||
repository = "https://github.com/isislovecruft/x25519-dalek" | ||
documentation = "https://docs.rs/x25519-dalek" | ||
categories = ["cryptography", "no-std"] | ||
keywords = ["cryptography", "curve25519", "key-exchange", "x25519", "diffie-hellman"] | ||
description = "X25519 elliptic curve Diffie-Hellman key exchange in pure-Rust, using curve25519-dalek." | ||
exclude = [ | ||
".gitignore", | ||
".travis.yml", | ||
"CONTRIBUTING.md", | ||
] | ||
|
||
[badges] | ||
travis-ci = { repository = "isislovecruft/x25519-dalek", branch = "master"} | ||
|
||
[dependencies.curve25519-dalek] | ||
version = "^0.12" | ||
|
||
[dependencies.rand] | ||
optional = true | ||
version = "^0.3" | ||
|
||
[features] | ||
bench = [] | ||
default = ["std", "nightly"] | ||
std = ["rand", "curve25519-dalek/std"] | ||
nightly = ["curve25519-dalek/nightly"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
Copyright (c) 2017 Isis Agora Lovecruft. All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are | ||
met: | ||
|
||
1. Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright | ||
notice, this list of conditions and the following disclaimer in the | ||
documentation and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of the copyright holder nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS | ||
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED | ||
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A | ||
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED | ||
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | ||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | ||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
|
||
# x25519-dalek [](https://crates.io/crates/x25519-dalek) [](https://docs.rs/x25519-dalek) [](https://travis-ci.org/isislovecruft/x25519-dalek) | ||
|
||
A pure-Rust implementation of x25519 elliptic curve Diffie-Hellman key exchange, | ||
as specified by Mike Hamburg and Adam Langley in | ||
[RFC7748](https://tools.ietf.org/html/rfc7748), using | ||
[curve25519-dalek](https://github.com/isislovecruft/curve25519-dalek). | ||
|
||
## Examples | ||
|
||
[](https://shop.bubblesort.io) | ||
|
||
"Secret Messages" cover image and [zine](https://shop.bubblesort.io/products/secret-messages-zine) | ||
copyright © Amy Wibowo ([@sailorhg](https://twitter.com/sailorhg)) | ||
|
||
Alice and Bob are two adorable kittens who have lost their mittens, and they | ||
wish to be able to send secret messages to each other to coordinate finding | ||
them, otherwise—if their caretaker cat finds out—they will surely be called | ||
naughty kittens and be given no pie! | ||
|
||
But the two kittens are quite clever. Even though their paws are still too big | ||
and the rest of them is 90% fuzziness, these clever kittens have been studying | ||
up on modern public key cryptography and have learned a nifty trick called | ||
*elliptic curve Diffie-Hellman key exchange*. With the right incantations, the | ||
kittens will be able to secretly organise to find their mittens, and then spend | ||
the rest of the afternoon nomming some yummy pie! | ||
|
||
First, Alice uses `x25519_dalek::generate_secret()` and then | ||
`x25519_dalek::generate_public()` to produce her secret and public keys: | ||
|
||
```rust | ||
extern crate x25519_dalek; | ||
extern crate rand; | ||
|
||
use x25519_dalek::generate_secret; | ||
use x25519_dalek::generate_public; | ||
use rand::OsRng; | ||
|
||
let mut alice_csprng = OsRng::new().unwrap(); | ||
let alice_secret = generate_secret(&mut alice_csprng); | ||
let alice_public = generate_public(&alice_secret); | ||
``` | ||
|
||
Bob does the same: | ||
|
||
```rust | ||
let mut bob_csprng = OsRng::new().unwrap(); | ||
let bob_secret = generate_secret(&mut bob_csprng); | ||
let bob_public = generate_public(&bob_secret); | ||
``` | ||
|
||
Alice meows across the room, telling `alice_public` to Bob, and Bob | ||
loudly meows `bob_public` back to Alice. Alice now computes her | ||
shared secret with Bob by doing: | ||
|
||
```rust | ||
use x25519_dalek::diffie_hellman; | ||
|
||
let shared_secret = diffie_hellman(&alice_secret, &bob_public.as_bytes()); | ||
``` | ||
|
||
Similarly, Bob computes the same shared secret by doing: | ||
|
||
```rust | ||
let shared_secret = diffie_hellman(&bob_secret, &alice_public.as_bytes()); | ||
``` | ||
|
||
Voilá! Alice and Bob can now use their shared secret to encrypt their | ||
meows, for example, by using it to generate a key and nonce for an | ||
authenticated-encryption cipher. | ||
|
||
# Warnings | ||
|
||
[Our elliptic curve library](https://github.com/isislovecruft/curve25519-dalek) | ||
(which this code uses) has received *one* formal cryptographic and security | ||
review. It has not yet received what we would consider *sufficient* peer | ||
review by other qualified cryptographers to be considered in any way, shape, | ||
or form, safe. | ||
|
||
This code matches the test vectors, as specified in | ||
[RFC7748](https://tools.ietf.org/html/rfc7748), however: | ||
|
||
**USE AT YOUR OWN RISK.** | ||
|
||
# Documentation | ||
|
||
Documentation is available [here](https://docs.rs/x25519-dalek). | ||
|
||
# Installation | ||
|
||
To install, add the following to your project's `Cargo.toml`: | ||
|
||
[dependencies.x25519-dalek] | ||
version = "^0.0" | ||
|
||
Then, in your library or executable source, add: | ||
|
||
extern crate x25519_dalek |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
// -*- mode: rust; -*- | ||
// | ||
// This file is part of x25519-dalek. | ||
// Copyright (c) 2017 Isis Lovecruft | ||
// See LICENSE for licensing information. | ||
// | ||
// Authors: | ||
// - Isis Agora Lovecruft <isis@patternsinthevoid.net> | ||
|
||
//! x25519 Diffie-Hellman key exchange | ||
//! | ||
//! A pure-Rust implementation of x25519 elliptic curve Diffie-Hellman key | ||
//! exchange as specified by Mike Hamburg and Adam Langley in | ||
//! [RFC7748](https://tools.ietf.org/html/rfc7748). | ||
//! | ||
//! # Examples | ||
//! | ||
//! [](https://shop.bubblesort.io) | ||
//! | ||
//! "Secret Messages" cover image and [zine](https://shop.bubblesort.io/products/secret-messages-zine) | ||
//! copyright © Amy Wibowo ([@sailorhg](https://twitter.com/sailorhg)) | ||
//! | ||
//! Alice and Bob are two adorable kittens who have lost their mittens, and they | ||
//! wish to be able to send secret messages to each other to coordinate finding | ||
//! them, otherwise—if their caretaker cat finds out—they will surely be called | ||
//! naughty kittens and be given no pie! | ||
//! | ||
//! But the two kittens are quite clever. Even though their paws are still too | ||
//! big and the rest of them is 90% fuzziness, these clever kittens have been | ||
//! studying up on modern public key cryptography and have learned a nifty trick | ||
//! called *elliptic curve Diffie-Hellman key exchange*. With the right | ||
//! incantations, the kittens will be able to secretly organise to find their | ||
//! mittens, and then spend the rest of the afternoon nomming some yummy pie! | ||
//! | ||
//! First, Alice uses `x25519_dalek::generate_secret()` and | ||
//! `x25519_dalek::generate_public()` to produce her secret and public keys: | ||
//! | ||
//! ``` | ||
//! extern crate x25519_dalek; | ||
//! extern crate rand; | ||
//! | ||
//! # fn main() { | ||
//! use x25519_dalek::generate_secret; | ||
//! use x25519_dalek::generate_public; | ||
//! use rand::OsRng; | ||
//! | ||
//! let mut alice_csprng = OsRng::new().unwrap(); | ||
//! let alice_secret = generate_secret(&mut alice_csprng); | ||
//! let alice_public = generate_public(&alice_secret); | ||
//! # } | ||
//! ``` | ||
//! | ||
//! Bob does the same: | ||
//! | ||
//! ``` | ||
//! # extern crate x25519_dalek; | ||
//! # extern crate rand; | ||
//! # | ||
//! # fn main() { | ||
//! # use x25519_dalek::generate_secret; | ||
//! # use x25519_dalek::generate_public; | ||
//! # use rand::OsRng; | ||
//! # | ||
//! let mut bob_csprng = OsRng::new().unwrap(); | ||
//! let bob_secret = generate_secret(&mut bob_csprng); | ||
//! let bob_public = generate_public(&bob_secret); | ||
//! # } | ||
//! ``` | ||
//! | ||
//! Alice meows across the room, telling `alice_public` to Bob, and Bob | ||
//! loudly meows `bob_public` back to Alice. Alice now computes her | ||
//! shared secret with Bob by doing: | ||
//! | ||
//! ``` | ||
//! # extern crate x25519_dalek; | ||
//! # extern crate rand; | ||
//! # | ||
//! # fn main() { | ||
//! # use x25519_dalek::generate_secret; | ||
//! # use x25519_dalek::generate_public; | ||
//! # use rand::OsRng; | ||
//! # | ||
//! # let mut alice_csprng = OsRng::new().unwrap(); | ||
//! # let alice_secret = generate_secret(&mut alice_csprng); | ||
//! # let alice_public = generate_public(&alice_secret); | ||
//! # | ||
//! # let mut bob_csprng = OsRng::new().unwrap(); | ||
//! # let bob_secret = generate_secret(&mut bob_csprng); | ||
//! # let bob_public = generate_public(&bob_secret); | ||
//! # | ||
//! use x25519_dalek::diffie_hellman; | ||
//! | ||
//! let shared_secret = diffie_hellman(&alice_secret, &bob_public.as_bytes()); | ||
//! # } | ||
//! ``` | ||
//! | ||
//! Similarly, Bob computes the same shared secret by doing: | ||
//! | ||
//! ``` | ||
//! # extern crate x25519_dalek; | ||
//! # extern crate rand; | ||
//! # | ||
//! # fn main() { | ||
//! # use x25519_dalek::diffie_hellman; | ||
//! # use x25519_dalek::generate_secret; | ||
//! # use x25519_dalek::generate_public; | ||
//! # use rand::OsRng; | ||
//! # | ||
//! # let mut alice_csprng = OsRng::new().unwrap(); | ||
//! # let alice_secret = generate_secret(&mut alice_csprng); | ||
//! # let alice_public = generate_public(&alice_secret); | ||
//! # | ||
//! # let mut bob_csprng = OsRng::new().unwrap(); | ||
//! # let bob_secret = generate_secret(&mut bob_csprng); | ||
//! # let bob_public = generate_public(&bob_secret); | ||
//! # | ||
//! let shared_secret = diffie_hellman(&bob_secret, &alice_public.as_bytes()); | ||
//! # } | ||
//! ``` | ||
//! | ||
//! Voilá! Alice and Bob can now use their shared secret to encrypt their | ||
//! meows, for example, by using it to generate a key and nonce for an | ||
//! authenticated-encryption cipher. | ||
#![no_std] | ||
#![cfg_attr(feature = "bench", feature(test))] | ||
#![deny(missing_docs)] | ||
|
||
extern crate curve25519_dalek; | ||
|
||
#[cfg(feature = "std")] | ||
extern crate rand; | ||
|
||
#[cfg(all(test, feature = "bench"))] | ||
extern crate test; | ||
|
||
mod x25519; | ||
|
||
#[allow(missing_docs)] | ||
pub use x25519::*; |
Oops, something went wrong.