exonum-crypto 1.0.0

Cryptography related types, constants, traits and functions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Cryptography primitives for Exonum

[![Travis Build Status](https://img.shields.io/travis/exonum/exonum/master.svg?label=Linux%20Build)](https://travis-ci.com/exonum/exonum)
[![License: Apache-2.0](https://img.shields.io/github/license/exonum/exonum.svg)](https://github.com/exonum/exonum/blob/master/LICENSE)
![rust 1.42.0+ required](https://img.shields.io/badge/rust-1.42.0+-blue.svg?label=Required%20Rust)

`exonum-crypto` provides a high-level API for work with various cryptography tasks.

Capabilities of `exonum-crypto` include:

- Calculating the hash of data;
- Generating key pairs for work with digital signatures;
- Creating and verifying of digital signatures.

The main backend for `exonum-crypto` is `sodiumoxide`, and the used algorithms are:

- SHA-256 for hashing.
- Ed25519 for digital signatures.

Consult [the crate docs](https://docs.rs/exonum-crypto) for more details.

## Examples

Signing data and verifying the signature:

```rust
exonum_crypto::init();
let (public_key, secret_key) = exonum_crypto::gen_keypair();
let data = [1, 2, 3];
let signature = exonum_crypto::sign(&data, &secret_key);
assert!(exonum_crypto::verify(&signature, &data, &public_key));
```

Hashing fixed amount of data:

```rust
exonum_crypto::init();
let data = [1, 2, 3];
let hash = exonum_crypto::hash(&data);
```

Hashing data by chunks:

```rust
use exonum_crypto::HashStream;

exonum_crypto::init();
let data: Vec<[u8; 5]> = vec![[1, 2, 3, 4, 5], [6, 7, 8, 9, 10]];
let mut hash_stream = HashStream::new();
for chunk in data {
    hash_stream = hash_stream.update(&chunk);
}
let _ = hash_stream.hash();
```

## Usage

Include `exonum-crypto` as a dependency in your `Cargo.toml`:

```toml
[dependencies]
exonum-crypto = "1.0.0"
```

## License

`exonum-crypto` is licensed under the Apache License (Version 2.0).
See [LICENSE](LICENSE) for details.