maksymsemenykhin/javascript-md5

JavaScript MD5

Demo

JavaScript MD5 Demo, _(*1)

Description

JavaScript MD5 implementation. Compatible with server-side environments like Node.js, module loaders like RequireJS, Browserify or webpack and all web browsers., _(*2)

Usage

Client-side

Include the (minified) JavaScript MD5 script in your HTML markup:, _(*3)

<script src="js/md5.min.js"></script>

In your application code, calculate the (hex-encoded) MD5 hash of a string by calling the md5 method with the string as argument:, _(*4)

var hash = md5("value"); // "2063c1608d6e0baf80249c42e2be5804"

Server-side

The following is an example how to use the JavaScript MD5 module on the server-side with Node.js., _(*5)

Create a new directory and add the md5.js file. Or alternatively, install the blueimp-md5 package with npm:, _(*6)

npm install blueimp-md5

Add a file server.js with the following content:, _(*7)

require("http").createServer(function (req, res) {
    // The md5 module exports the md5() function:
    var md5 = require("./md5"),
    // Use the following version if you installed the package with npm:
    // var md5 = require("blueimp-md5"),
        url  = require("url"),
        query = url.parse(req.url).query;
    res.writeHead(200, {"Content-Type": "text/plain"});
    // Calculate and print the MD5 hash of the url query:
    res.end(md5(query));
}).listen(8080, "localhost");
console.log("Server running at http://localhost:8080/");

Run the application with the following command:, _(*8)

node server.js

Requirements

The JavaScript MD5 script has zero dependencies., _(*9)

API

Calculate the (hex-encoded) MD5 hash of a given string value:, _(*10)

var hash = md5("value"); // "2063c1608d6e0baf80249c42e2be5804"

Calculate the (hex-encoded) HMAC-MD5 hash of a given string value and key:, _(*11)

var hash = md5("value", "key"); // "01433efd5f16327ea4b31144572c67f6"

Calculate the raw MD5 hash of a given string value:, _(*12)

var hash = md5("value", null, true);

Calculate the raw HMAC-MD5 hash of a given string value and key:, _(*13)

var hash = md5("value", "key", true);

Tests

The JavaScript MD5 project comes with Unit Tests.
There are two different ways to run the tests:, _(*14)

• Open test/index.html in your browser or
• run npm test in the Terminal in the root path of the repository package.

The first one tests the browser integration, the second one the node.js integration., _(*15)

License

The JavaScript MD5 script is released under the MIT license., _(*16)