Skip to content

Commit

Permalink
mgm: fix README, remove unused dependencies (RustCrypto#187)
Browse files Browse the repository at this point in the history
  • Loading branch information
newpavlov authored Aug 1, 2020
1 parent af954e2 commit 4842051
Show file tree
Hide file tree
Showing 6 changed files with 81 additions and 16 deletions.
56 changes: 56 additions & 0 deletions .github/workflows/eax.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: aes-siv

on:
pull_request:
paths:
- "aes-siv/**"
- "Cargo.*"
push:
branches: master

defaults:
run:
working-directory: aes-siv

env:
CARGO_INCREMENTAL: 0
RUSTFLAGS: "-Dwarnings"

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
rust:
- 1.41.0 # MSRV
- stable
target:
# - armv7-none-eabi TODO: test after MSRV is bumped to 1.42
- thumbv7em-none-eabi
- wasm32-unknown-unknown
steps:
- uses: actions/checkout@v1
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: ${{ matrix.rust }}
target: ${{ matrix.target }}
override: true
- run: cargo build --no-default-features --release --target ${{ matrix.target }}

test:
runs-on: ubuntu-latest
strategy:
matrix:
rust:
- 1.41.0 # MSRV
- stable
steps:
- uses: actions/checkout@v1
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: ${{ matrix.rust }}
override: true
- run: cargo test --lib --release
- run: cargo test --all-features --release
3 changes: 1 addition & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@ crate.

| Name | Algorithm | Crates.io | Documentation | Build |
|----------------------|------------------------------|-----------|---------------|-------|
| [`aes-gcm`] | [AES-GCM] | [![crates.io](https://img.shields.io/crates/v/aes-gcm.svg)](https://crates.io/crates/aes-gcm) | [![Documentation](https://docs.rs/aes-gcm/badge.svg)](https://docs.rs/aes-gcm) | ![aes-gcm](https://github.com/RustCrypto/AEADs/workflows/aes-gcm/badge.svg?branch=master&event=push) |
| [`aes-gcm-siv`] | [AES-GCM-SIV] | [![crates.io](https://img.shields.io/crates/v/aes-gcm-siv.svg)](https://crates.io/crates/aes-gcm-siv) | [![Documentation](https://docs.rs/aes-gcm-siv/badge.svg)](https://docs.rs/aes-gcm-siv) | ![aes-gcm-siv](https://github.com/RustCrypto/AEADs/workflows/aes-gcm-siv/badge.svg?branch=master&event=push) |
| [`aes-gcm`] | [AES-GCM] | [![crates.io](https://img.shields.io/crates/v/aes-gcm.svg)](https://crates.io/crates/aes-gcm) | [![Documentation](https://docs.rs/aes-gcm/badge.svg)](https://docs.rs/aes-gcm) | ![aes-gcm](https://github.com/RustCrypto/AEADs/workflows/aes-gcm/badge.svg?branch=master&event=push) |
| [`aes-siv`] | [AES-SIV] | [![crates.io](https://img.shields.io/crates/v/aes-siv.svg)](https://crates.io/crates/aes-siv) | [![Documentation](https://docs.rs/aes-siv/badge.svg)](https://docs.rs/aes-siv) | ![aes-siv](https://github.com/RustCrypto/AEADs/workflows/aes-siv/badge.svg?branch=master&event=push) |
| [`ccm`] | [CCM] | [![crates.io](https://img.shields.io/crates/v/ccm.svg)](https://crates.io/crates/ccm) | [![Documentation](https://docs.rs/ccm/badge.svg)](https://docs.rs/ccm) | ![ccm](https://github.com/RustCrypto/AEADs/workflows/ccm/badge.svg?branch=master&event=push) |
| [`chacha20poly1305`] | [(X)ChaCha20Poly1305] | [![crates.io](https://img.shields.io/crates/v/chacha20poly1305.svg)](https://crates.io/crates/chacha20poly1305) | [![Documentation](https://docs.rs/chacha20poly1305/badge.svg)](https://docs.rs/chacha20poly1305) | ![chacha20poly1305](https://github.com/RustCrypto/AEADs/workflows/chacha20poly1305/badge.svg?branch=master&event=push)
| [`crypto_box`] | [Curve25519XSalsa20Poly1305] | [![crates.io](https://img.shields.io/crates/v/crypto_box.svg)](https://crates.io/crates/crypto_box) | [![Documentation](https://docs.rs/crypto_box/badge.svg)](https://docs.rs/crypto_box) | ![crypto_box](https://github.com/RustCrypto/AEADs/workflows/crypto_box/badge.svg?branch=master&event=push) |
| [`eax`] | [EAX] | [![crates.io](https://img.shields.io/crates/v/eax.svg)](https://crates.io/crates/eax) | [![Documentation](https://docs.rs/eax/badge.svg)](https://docs.rs/eax) | ![eax](https://github.com/RustCrypto/AEADs/workflows/eax/badge.svg?branch=master&event=push) |
| [`mgm`] | [MGM] | [![crates.io](https://img.shields.io/crates/v/mgm.svg)](https://crates.io/crates/mgm) | [![Documentation](https://docs.rs/mgm/badge.svg)](https://docs.rs/mgm) | ![mgm](https://github.com/RustCrypto/AEADs/workflows/mgm/badge.svg?branch=master&event=push) |
| [`xsalsa20poly1305`] | [XSalsa20Poly1305] | [![crates.io](https://img.shields.io/crates/v/xsalsa20poly1305.svg)](https://crates.io/crates/xsalsa20poly1305) | [![Documentation](https://docs.rs/xsalsa20poly1305/badge.svg)](https://docs.rs/xsalsa20poly1305) | ![xsalsa20poly1305](https://github.com/RustCrypto/AEADs/workflows/xsalsa20poly1305/badge.svg?branch=master&event=push) |

NOTE: the [`aes-ccm`] crate also implements the [`aead`] traits
Expand Down Expand Up @@ -63,15 +66,21 @@ dual licensed as above, without any additional terms or conditions.
[`aes-gcm`]: https://github.com/RustCrypto/AEADs/tree/master/aes-gcm
[`aes-gcm-siv`]: https://github.com/RustCrypto/AEADs/tree/master/aes-gcm-siv
[`aes-siv`]: https://github.com/RustCrypto/AEADs/tree/master/aes-siv
[`ccm`]: https://github.com/RustCrypto/AEADs/tree/master/ccm
[`chacha20poly1305`]: https://github.com/RustCrypto/AEADs/tree/master/chacha20poly1305
[`crypto_box`]: https://github.com/RustCrypto/AEADs/tree/master/crypto_box
[`eax`]: https://github.com/RustCrypto/AEADs/tree/master/eax
[`mgm`]: https://github.com/RustCrypto/AEADs/tree/master/mgm
[`xsalsa20poly1305`]: https://github.com/RustCrypto/AEADs/tree/master/xsalsa20poly1305

[//]: # (algorithms)

[AES-GCM]: https://en.wikipedia.org/wiki/Galois/Counter_Mode
[AES-GCM-SIV]: https://en.wikipedia.org/wiki/AES-GCM-SIV
[AES-SIV]: https://github.com/miscreant/meta/wiki/AES-SIV
[CCM]: https://en.wikipedia.org/wiki/CCM_mode
[EAX]: https://en.wikipedia.org/wiki/EAX_mode
[MGM]: https://eprint.iacr.org/2019/123.pdf
[(X)ChaCha20Poly1305]: https://tools.ietf.org/html/rfc8439
[Curve25519XSalsa20Poly1305]: https://nacl.cr.yp.to/box.html
[XSalsa20Poly1305]: https://nacl.cr.yp.to/secretbox.html
5 changes: 5 additions & 0 deletions mgm/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.1.1 (2020-08-01)
- Fix README ([#187])

[187]: https://github.com/RustCrypto/AEADs/pull/187

## 0.1.0 (2020-08-01)
- Initial release
4 changes: 1 addition & 3 deletions mgm/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mgm"
version = "0.1.0"
version = "0.1.1"
description = "Generic implementation of the Multilinear Galois Mode (MGM) cipher"
authors = ["RustCrypto Developers"]
edition = "2018"
Expand All @@ -16,8 +16,6 @@ keywords = ["encryption", "aead"]
aead = { version = "0.3", default-features = false }
block-cipher = { version = "0.7", default-features = false }
subtle = { version = "2", default-features = false }
cfg-if = "0.1"
hex-literal = "0.2"

[dev-dependencies]
aead = { version = "0.3.2", features = ["dev"], default-features = false }
Expand Down
18 changes: 8 additions & 10 deletions mgm/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RustCrypto: CCM
# RustCrypto: Multilinear Galois Mode

[![crate][crate-image]][crate-link]
[![Docs][docs-image]][docs-link]
Expand All @@ -7,12 +7,10 @@
[![CodeCov Status][codecov-image]][codecov-link]
[![Build Status][build-image]][build-link]

Pure Rust implementation of the Counter with CBC-MAC ([CCM]) mode ([RFC 3610]): an
Pure Rust implementation of the Multilinear Galois Mode ([MGM]): an
Authenticated Encryption with Associated Data ([AEAD]) algorithm generic over
block ciphers with block size equal to 128 bits.

[Documentation][docs-link]

## Security Notes

No security audits of this crate have ever been performed, and it has not been
Expand All @@ -38,19 +36,19 @@ dual licensed as above, without any additional terms or conditions.

[//]: # (badges)

[crate-image]: https://img.shields.io/crates/v/ccm.svg
[crate-link]: https://crates.io/crates/ccm
[docs-image]: https://docs.rs/ccm/badge.svg
[docs-link]: https://docs.rs/ccm
[crate-image]: https://img.shields.io/crates/v/mgm.svg
[crate-link]: https://crates.io/crates/mgm
[docs-image]: https://docs.rs/mgm/badge.svg
[docs-link]: https://docs.rs/mgm
[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
[rustc-image]: https://img.shields.io/badge/rustc-1.41+-blue.svg
[codecov-image]: https://codecov.io/gh/RustCrypto/AEADs/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/RustCrypto/AEADs
[build-image]: https://github.com/RustCrypto/AEADs/workflows/ccm/badge.svg?branch=master&event=push
[build-image]: https://github.com/RustCrypto/AEADs/workflows/mgm/badge.svg?branch=master&event=push
[build-link]: https://github.com/RustCrypto/AEADs/actions

[//]: # (general links)

[RFC 3610]: https://tools.ietf.org/html/rfc3610
[CCM]: https://en.wikipedia.org/wiki/CCM_mode
[MGM]: https://eprint.iacr.org/2019/123.pdf
[AEAD]: https://en.wikipedia.org/wiki/Authenticated_encryption

0 comments on commit 4842051

Please sign in to comment.