1 unstable release

0.0.1 Feb 7, 2023

#6 in #hsh

MIT/Apache

68KB
637 lines

MDG

A Rust library that implements the MD5 cryptographic hash function

Made With Love Crates.io Lib.rs Docs.rs License

divider

Welcome to MDG 👋

MDG Banner

Website â€ĸ Documentation â€ĸ Report Bug â€ĸ Request Feature â€ĸ Contributing Guidelines

Overview 📖

The Message Digest (MDG) is an implementation of the MD5 cryptographic hash function. It provides a struct, MD5, that can generate a message digest of data in a secure, one-way hash. The message digest can verify the integrity of the data without having to store the entire message.

Features ✨

The MD5 struct has a variety of functions to make it easy to use. The new function creates a new instance of the struct, ready to hash data. The transform function updates the struct 's internal state with new data, and the finalize function finishes the message digest and returns it.

  • An MD5 struct that represents the current state of the hash computation.
  • A new() method to create a new instance of the struct.
  • A transform() method to update the internal state with new data.
  • A finalize() method to finalize the hash computation and return the result as a 16-byte array.

Installation đŸ“Ļ

It takes just a few minutes to get up and running with mdg.

Requirements

mdg requires Rust 1.67.0 or later.

Documentation

ℹī¸ Info: Please check out our website for more information and find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use mdg in your project, add the following to your Cargo.toml file:

[dependencies]
mdg = "0.0.1"

Add the following to your main.rs file:

extern crate mdg;
use mdg::*;

then you can use the functions in your application code.

Examples

MDG comes with a set of examples that you can use to get started. The examples are located in the examples directory of the project. To run the examples, clone the repository and run the following command in your terminal from the project root directory.

cargo run --example mdg

Semantic Versioning Policy đŸšĨ

For transparency into our release cycle and in striving to maintain backward compatibility, QRC follows semantic versioning.

License 📝

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

Contribution 🤝

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.

divider

Acknowledgements 💙

A big thank you to all the awesome contributors of Mini Functions for their help and support. A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.

Dependencies

~9–13MB
~326K SLoC