Skip to content

Commit ff96a6d

Browse files
jcapenewpavlov
authored andcommitted
AEAD Trait (#40)
1 parent 4765384 commit ff96a6d

10 files changed

+366
-3
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ target/
22
*/target/
33
*/*/target/
44
Cargo.lock
5+

.travis.yml

+4-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ sudo: required
55
matrix:
66
include:
77
- rust: 1.21.0
8-
script: cargo test --verbose --all --release
8+
script: cargo test --verbose --all --exclude aead --release
9+
- rust: 1.36.0
10+
script: cargo test --verbose --package aead --release
911
- rust: stable
1012
script: cargo test --verbose --all --release
1113
- rust: nightly
@@ -23,7 +25,7 @@ matrix:
2325
# tests if crates truly can be built without std
2426
- env: TARGET=thumbv7em-none-eabi
2527
rust: nightly
26-
script: xargo build --no-default-features --verbose --target $TARGET
28+
script: xargo build --exclude aead --no-default-features --verbose --target $TARGET
2729
install:
2830
- cargo install xargo || true
2931
- rustup target install armv7-unknown-linux-gnueabihf

Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[workspace]
22
members = [
3+
"aead",
34
"block-cipher-trait",
45
"crypto-mac",
56
"digest",

aead/Cargo.toml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[package]
2+
name = "aead"
3+
version = "0.1.0"
4+
authors = ["James Cape <[email protected]>"]
5+
edition = "2018"
6+
description = """
7+
Traits for Authenticated Encryption with Associated Data (AEAD) algorithms
8+
"""
9+
10+
[dependencies]
11+
generic-array = { version = "0.12", default-features = false }

aead/LICENSE-APACHE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

aead/LICENSE-MIT

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Copyright (c) 2019 The RustCrypto Project Developers
2+
Copyright (c) 2019 MobileCoin, LLC
3+
4+
Permission is hereby granted, free of charge, to any
5+
person obtaining a copy of this software and associated
6+
documentation files (the "Software"), to deal in the
7+
Software without restriction, including without
8+
limitation the rights to use, copy, modify, merge,
9+
publish, distribute, sublicense, and/or sell copies of
10+
the Software, and to permit persons to whom the Software
11+
is furnished to do so, subject to the following
12+
conditions:
13+
14+
The above copyright notice and this permission notice
15+
shall be included in all copies or substantial portions
16+
of the Software.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
19+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
20+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
21+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
22+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
23+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
24+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
25+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26+
DEALINGS IN THE SOFTWARE.

aead/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Authenticated Encryption with Additional Data
2+
3+
This crate provides the rust trait equivilent of the AEAD API defined in
4+
RFC5116. As a result, it should provide nearly drop-in support for any
5+
compliant AEAD scheme, including AES-GCM, AES-CCM, ChaCha20-Poly1305,
6+
AES-CBC-HMAC, etc.

aead/rustfmt.toml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
merge_imports = true

aead/src/lib.rs

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
//! A set of traits designed to support authenticated encryption.
2+
3+
#![no_std]
4+
5+
extern crate alloc;
6+
7+
pub use generic_array;
8+
9+
use alloc::vec::Vec;
10+
use generic_array::{GenericArray, ArrayLength, typenum::Unsigned};
11+
12+
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
13+
pub struct Error;
14+
15+
/// A trait which can be used to create a new RFC5116 authenticated encryption
16+
/// scheme.
17+
pub trait NewAead {
18+
/// The size of the key array required by this algorithm.
19+
type KeySize: ArrayLength<u8>;
20+
21+
/// Construct a new stateful instance for the given key.
22+
fn new(key: GenericArray<u8, Self::KeySize>) -> Self;
23+
}
24+
25+
/// A trait which can support a stateful, RFC5116 authenticated encryption
26+
/// scheme with a fixed-size nonce.
27+
pub trait Aead {
28+
/// The length of a nonce.
29+
type NonceSize: ArrayLength<u8>;
30+
/// The maximum length of the nonce.
31+
type TagSize: ArrayLength<u8>;
32+
/// The upper bound amount of additional space required to support a
33+
/// ciphertext vs. a plaintext.
34+
type CiphertextOverhead: ArrayLength<u8> + Unsigned;
35+
36+
/// Encrypt the given plaintext slice, and return the resulting ciphertext
37+
/// as a vector of bytes.
38+
fn encrypt(
39+
&mut self,
40+
additional_data: &[u8],
41+
nonce: &GenericArray<u8, Self::NonceSize>,
42+
plaintext: &[u8]
43+
) -> Result<Vec<u8>, Error>;
44+
45+
/// Decrypt the given ciphertext slice, and return the resulting plaintext
46+
/// as a vector of bytes.
47+
fn decrypt(
48+
&mut self,
49+
additional_data: &[u8],
50+
nonce: &GenericArray<u8, Self::NonceSize>,
51+
ciphertext: &[u8]
52+
) -> Result<Vec<u8>, Error>;
53+
}
54+
55+
/// A trait which can support a stateless RFC5116 authenticated encryption
56+
/// scheme. This is the standard RFC algorithm.
57+
pub trait StatelessAead {
58+
/// The length of a nonce.
59+
type NonceSize: ArrayLength<u8>;
60+
/// The maximum length of the nonce.
61+
type TagSize: ArrayLength<u8>;
62+
/// The upper bound amount of additional space required to support a
63+
/// ciphertext vs. a plaintext.
64+
type CiphertextOverhead: ArrayLength<u8> + Unsigned;
65+
66+
/// Encrypt the given plaintext slice, and return the resulting ciphertext
67+
/// as a vector of bytes.
68+
fn encrypt(
69+
&self,
70+
additional_data: &[u8],
71+
nonce: &GenericArray<u8, Self::NonceSize>,
72+
plaintext: &[u8]
73+
) -> Result<Vec<u8>, Error>;
74+
75+
/// Decrypt the given ciphertext slice, and return the resulting plaintext
76+
/// as a vector of bytes.
77+
fn decrypt(
78+
&self,
79+
additional_data: &[u8],
80+
nonce: &GenericArray<u8, Self::NonceSize>,
81+
ciphertext: &[u8]
82+
) -> Result<Vec<u8>, Error>;
83+
}
84+
85+
/// A blanket implementation of the Stateful AEAD interface for Stateless
86+
/// AEAD implementations.
87+
impl<Algo: StatelessAead> Aead for Algo {
88+
type NonceSize = Algo::NonceSize;
89+
type TagSize = Algo::TagSize;
90+
type CiphertextOverhead = Algo::CiphertextOverhead;
91+
92+
/// Encrypt the given plaintext slice, and return the resulting ciphertext
93+
/// as a vector of bytes.
94+
fn encrypt(
95+
&mut self,
96+
additional_data: &[u8],
97+
nonce: &GenericArray<u8, Self::NonceSize>,
98+
plaintext: &[u8]
99+
) -> Result<Vec<u8>, Error> {
100+
<Self as StatelessAead>::encrypt(self, additional_data, nonce, plaintext)
101+
}
102+
103+
/// Decrypt the given ciphertext slice, and return the resulting plaintext
104+
/// as a vector of bytes.
105+
fn decrypt(
106+
&mut self,
107+
additional_data: &[u8],
108+
nonce: &GenericArray<u8, Self::NonceSize>,
109+
ciphertext: &[u8]
110+
) -> Result<Vec<u8>, Error> {
111+
<Self as StatelessAead>::decrypt(self, additional_data, nonce, ciphertext)
112+
}
113+
}

0 commit comments

Comments
 (0)