Blame view
sources/3rdparty/js/md5/README.md
2.96 KB
31b7f2792
Upgrade to ownclo...
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# JavaScript MD5
## Demo
[JavaScript MD5 Demo](http://blueimp.github.io/JavaScript-MD5/)
## Description
JavaScript MD5 implementation. Compatible with server-side environments like node.js, module loaders like RequireJS and all web browsers.
## Usage
### Client-side
Include the (minified) JavaScript [MD5](http://en.wikipedia.org/wiki/MD5) script in your HTML markup:
```html
<script src="js/md5.min.js"></script>
```
In your application code, calculate the ([hex](http://en.wikipedia.org/wiki/Hexadecimal)-encoded) [MD5](http://en.wikipedia.org/wiki/MD5) hash of a string by calling the **md5** method with the string as argument:
```js
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](http://nodejs.org/).
Create a new directory and add the **md5.js** file. Or alternatively, install the **blueimp-md5** package with [npm](http://npmjs.org/):
```sh
npm install blueimp-md5
```
Add a file **server.js** with the following content:
```js
require("http").createServer(function (req, res) {
// The md5 module exports the md5() function:
var md5 = require("./md5").md5,
// Use the following version if you installed the package with npm:
// var md5 = require("blueimp-md5").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:
```sh
node server.js
```
## Requirements
The JavaScript MD5 script has zero dependencies.
## API
Calculate the ([hex](http://en.wikipedia.org/wiki/Hexadecimal)-encoded) [MD5](http://en.wikipedia.org/wiki/MD5) hash of a given string value:
```js
var hash = md5("value"); // "2063c1608d6e0baf80249c42e2be5804"
```
Calculate the ([hex](http://en.wikipedia.org/wiki/Hexadecimal)-encoded) [HMAC](http://en.wikipedia.org/wiki/HMAC)-MD5 hash of a given string value and key:
```js
var hash = md5("value", "key"); // "01433efd5f16327ea4b31144572c67f6"
```
Calculate the raw [MD5](http://en.wikipedia.org/wiki/MD5) hash of a given string value:
```js
var hash = md5("value", null, true);
```
Calculate the raw [HMAC](http://en.wikipedia.org/wiki/HMAC)-MD5 hash of a given string value and key:
```js
var hash = md5("value", "key", true);
```
## Tests
The JavaScript MD5 project comes with [Unit Tests](http://en.wikipedia.org/wiki/Unit_testing).
There are two different ways to run the tests:
* 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](http://nodejs.org/) integration.
## License
The JavaScript MD5 script is released under the [MIT license](http://www.opensource.org/licenses/MIT).
|