1
- # RustCrypto: Message Authentication Codes ![ Rust Version] [ rustc-image ] [ ![ Project Chat] [ chat-image ]] [ chat-link ] [ ![ dependency status] [ deps-image ]] [ deps-link ]
1
+ # RustCrypto: Message Authentication Codes
2
+
3
+ [ ![ Project Chat] [ chat-image ]] [ chat-link ] [ ![ dependency status] [ deps-image ]] [ deps-link ] ![ Apache2/MIT licensed] [ license-image ]
2
4
3
5
Collection of [ Message Authentication Code] [ 1 ] (MAC) algorithms written in pure Rust.
4
6
5
- ## Crates
7
+ ## Supported Algorithms
8
+
9
+ | Algorithm | Crate | Crates.io | Documentation | MSRV |
10
+ | -----------| ----------| :-------------:| :-------------:| :----:|
11
+ | [ CMAC] | [ ` cmac ` ] | [ ![ crates.io] ( https://img.shields.io/crates/v/cmac.svg )] ( https://crates.io/crates/cmac ) | [ ![ Documentation] ( https://docs.rs/cmac/badge.svg )] ( https://docs.rs/cmac ) | ![ MSRV 1.41] [ msrv-1.41 ] |
12
+ | [ DAA] | [ ` daa ` ] | [ ![ crates.io] ( https://img.shields.io/crates/v/daa.svg )] ( https://crates.io/crates/daa ) | [ ![ Documentation] ( https://docs.rs/daa/badge.svg )] ( https://docs.rs/daa ) | ![ MSRV 1.41] [ msrv-1.41 ] |
13
+ | [ HMAC] | [ ` hmac ` ] | [ ![ crates.io] ( https://img.shields.io/crates/v/hmac.svg )] ( https://crates.io/crates/hmac ) | [ ![ Documentation] ( https://docs.rs/hmac/badge.svg )] ( https://docs.rs/hmac ) | ![ MSRV 1.41] [ msrv-1.41 ] |
14
+ | [ PMAC] | [ ` pmac ` ] | [ ![ crates.io] ( https://img.shields.io/crates/v/pmac.svg )] ( https://crates.io/crates/pmac ) | [ ![ Documentation] ( https://docs.rs/pmac/badge.svg )] ( https://docs.rs/pmac ) | ![ MSRV 1.41] [ msrv-1.41 ] |
15
+
16
+ ### Minimum Supported Rust Version (MSRV) Policy
6
17
7
- | Name | Algorithm | Crates.io | Documentation | Build Status |
8
- | --------| -----------| ---------------| ---------------| --------------|
9
- | ` cmac ` | [ CMAC] | [ ![ crates.io] ( https://img.shields.io/crates/v/cmac.svg )] ( https://crates.io/crates/cmac ) | [ ![ Documentation] ( https://docs.rs/cmac/badge.svg )] ( https://docs.rs/cmac ) | [ ![ Build] ( https://github.com/RustCrypto/MACs/workflows/cmac/badge.svg?branch=master&event=push )] ( https://github.com/RustCrypto/MACs/actions?query=workflow:cmac+branch:master )
10
- | ` daa ` | [ DAA] | [ ![ crates.io] ( https://img.shields.io/crates/v/daa.svg )] ( https://crates.io/crates/daa ) | [ ![ Documentation] ( https://docs.rs/daa/badge.svg )] ( https://docs.rs/daa ) | [ ![ Build] ( https://github.com/RustCrypto/MACs/workflows/daa/badge.svg?branch=master&event=push )] ( https://github.com/RustCrypto/MACs/actions?query=workflow:daa+branch:master )
11
- | ` hmac ` | [ HMAC] | [ ![ crates.io] ( https://img.shields.io/crates/v/hmac.svg )] ( https://crates.io/crates/hmac ) | [ ![ Documentation] ( https://docs.rs/hmac/badge.svg )] ( https://docs.rs/hmac ) | [ ![ Build] ( https://github.com/RustCrypto/MACs/workflows/hmac/badge.svg?branch=master&event=push )] ( https://github.com/RustCrypto/MACs/actions?query=workflow:hmac+branch:master )
12
- | ` pmac ` | [ PMAC] | [ ![ crates.io] ( https://img.shields.io/crates/v/pmac.svg )] ( https://crates.io/crates/pmac ) | [ ![ Documentation] ( https://docs.rs/pmac/badge.svg )] ( https://docs.rs/pmac ) | [ ![ Build] ( https://github.com/RustCrypto/MACs/workflows/pmac/badge.svg?branch=master&event=push )] ( https://github.com/RustCrypto/MACs/actions?query=workflow:pmac+branch:master )
18
+ MSRV bumps are considered breaking changes and will be performed only with minor version bump.
13
19
14
20
## License
15
21
@@ -22,16 +28,23 @@ at your option.
22
28
23
29
### Contribution
24
30
25
- Unless you explicitly state otherwise, any contribution intentionally submitted
26
- for inclusion in the work by you, as defined in the Apache-2.0 license
31
+ 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.
27
32
28
33
[ // ] : # ( badges )
29
34
30
- [ rustc-image ] : https://img.shields.io/badge/rustc-1.41+-blue.svg
31
35
[ chat-image ] : https://img.shields.io/badge/zulip-join_chat-blue.svg
32
36
[ chat-link ] : https://rustcrypto.zulipchat.com/#narrow/stream/260044-MACs
37
+ [ license-image ] : https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
33
38
[ deps-image ] : https://deps.rs/repo/github/RustCrypto/MACs/status.svg
34
39
[ deps-link ] : https://deps.rs/repo/github/RustCrypto/MACs
40
+ [ msrv-1.41 ] : https://img.shields.io/badge/rustc-1.41.0+-blue.svg
41
+
42
+ [ // ] : # ( crates )
43
+
44
+ [ `cmac` ] : ./cmac
45
+ [ `daa` ] : ./daa
46
+ [ `hmac` ] : ./hmac
47
+ [ `pmac` ] : ./pmac
35
48
36
49
[ // ] : # ( footnotes )
37
50
0 commit comments