https://github.com/kikito/md5.lua

MD5 sum in pure Lua, with no C and no external dependencies
https://github.com/kikito/md5.lua

Last synced: about 8 hours ago
JSON representation

MD5 sum in pure Lua, with no C and no external dependencies

• Host: GitHub
• URL: https://github.com/kikito/md5.lua
• Owner: kikito
• License: mit
• Created: 2013-08-30T17:18:12.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-07-26T12:49:52.000Z (over 1 year ago)
• Last Synced: 2025-01-19T14:14:18.789Z (7 days ago)
• Language: Lua
• Homepage:
• Size: 45.9 KB
• Stars: 330
• Watchers: 14
• Forks: 149
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

• awesome-defold - md5

README

        
md5.lua [![Build Status](https://travis-ci.org/kikito/md5.lua.svg)](https://travis-ci.org/kikito/md5.lua)

=========================================================================================================

This pure-Lua module computes md5 in Lua 5.1, Lua 5.2 and LuaJIT, using native bit-manipulation libraries when available, and falling back to table-based manipulation of integers in 5.1.

It implements md5.sum and md5.sumhex like the [kepler project md5 package](http://keplerproject.github.com/md5/), but it's done completely in Lua, with no dependencies on other libs or C files.

Usage

=====

Simple example:

    local md5 = require 'md5'

    local md5_as_data  = md5.sum(message)       -- returns raw bytes

    local md5_as_hex   = md5.sumhexa(message)   -- returns a hex string

    local md5_as_hex2  = md5.tohex(md5_as_data) -- returns the same string as md5_as_hex

Incremental example (for computing md5 of streams, or big files which have to be loaded in chunks - new since 1.1.0):

    local m = md5.new()

    m:update('some bytes')

    m:update('some more bytes')

    m:update('etc')

    return md5.tohex(m:finish())

Credits

=======

This is a cleanup of an implementation by Adam Baldwin - https://gist.github.com/evilpacket/3647908

Which in turn was a mix of the bitwise lib, http://luaforge.net/projects/bit/ by hanzhao (`abrash_han - at - hotmail.com`),

and http://equi4.com/md5/md5calc.lua, by Equi 4 Software.

Lua 5.2 and LuaJIT compatibility by [Positive07](https://github.com/kikito/md5.lua/pull/2)

A very important fix and the incremental variant by [pgimeno](https://github.com/kikito/md5.lua/pull/10)

License

=======

This library, as well as all the previous ones in which is based, is released under the MIT license (See license file for details).

Specs

=====

The specs for this library are implemented with [busted](http://ovinelabs.com/busted/). In order to run them, install busted and then:

    cd path/to/where/the/spec/folder/is

    busted

    

Install

=======

Either copy the file or using luarocks:

    luarocks install --server=http://luarocks.org/manifests/kikito md5