lua-resty-string - String utilities and common hash functions for ngx_lua and LuaJIT
This library is considered experimental and still under active development.
The API is still in flux and may change without notice.
This library requires an nginx build with OpenSSL, the ngx_lua module, and LuaJIT 2.0.
#nginx.conf:
lua_package_path"/path/to/lua-resty-string/lib/?.lua;;";
server {
location=/test {
content_by_lua_fileconf/test.lua;
}
}
-- conf/test.lua:localresty_sha1=require"resty.sha1"localsha1=resty_sha1:new()
ifnotsha1thenngx.say("failed to create the sha1 object")
returnendlocalok=sha1:update("hello, ")
ifnotokthenngx.say("failed to add data")
returnendok=sha1:update("world")
ifnotokthenngx.say("failed to add data")
returnendlocaldigest=sha1:final() -- binary digestlocalstr=require"resty.string"ngx.say("sha1: ", str.to_hex(digest))
-- output: "sha1: b7e23ec29af22b0b4e41da31e868d57226121c84"localresty_md5=require"resty.md5"localmd5=resty_md5:new()
ifnotmd5thenngx.say("failed to create md5 object")
returnendlocalok=md5:update("hel")
ifnotokthenngx.say("failed to add data")
returnend-- md5:update() with an optional "len" parameterok=md5:update("loxxx", 2)
ifnotokthenngx.say("failed to add data")
returnendlocaldigest=md5:final()
localstr=require"resty.string"ngx.say("md5: ", str.to_hex(digest))
-- yield "md5: 5d41402abc4b2a76b9719d911017c592"localresty_sha224=require"resty.sha224"localstr=require"resty.string"localsha224=resty_sha224:new()
ngx.say(sha224:update("hello"))
localdigest=sha224:final()
ngx.say("sha224: ", str.to_hex(digest))
localresty_sha256=require"resty.sha256"localstr=require"resty.string"localsha256=resty_sha256:new()
ngx.say(sha256:update("hello"))
localdigest=sha256:final()
ngx.say("sha256: ", str.to_hex(digest))
localresty_sha512=require"resty.sha512"localstr=require"resty.string"localsha512=resty_sha512:new()
ngx.say(sha512:update("hello"))
localdigest=sha512:final()
ngx.say("sha512: ", str.to_hex(digest))
localresty_sha384=require"resty.sha384"localstr=require"resty.string"localsha384=resty_sha384:new()
ngx.say(sha384:update("hel"))
ngx.say(sha384:update("lo"))
localdigest=sha384:final()
ngx.say("sha384: ", str.to_hex(digest))
localresty_random=require"resty.random"localstr=require"resty.string"localrandom=resty_random.bytes(16)
-- generate 16 bytes of pseudo-random datangx.say("pseudo-random: ", str.to_hex(random))
localresty_random=require"resty.random"localstr=require"resty.string"localstrong_random=resty_random.bytes(16,true)
-- attempt to generate 16 bytes of-- cryptographically strong random datawhilestrong_random==nildostrong_random=resty_random.bytes(16,true)
endngx.say("random: ", str.to_hex(strong_random))
localaes=require"resty.aes"localstr=require"resty.string"localaes_128_cbc_md5=aes:new("AKeyForAES")
-- the default cipher is AES 128 CBC with 1 round of MD5-- for the key and a nil saltlocalencrypted=aes_128_cbc_md5:encrypt("Secret message!")
ngx.say("AES 128 CBC (MD5) Encrypted HEX: ", str.to_hex(encrypted))
ngx.say("AES 128 CBC (MD5) Decrypted: ", aes_128_cbc_md5:decrypt(encrypted))
localaes=require"resty.aes"localstr=require"resty.string"localaes_256_cbc_sha512x5=aes:new("AKeyForAES-256-CBC",
"MySalt!!", aes.cipher(256,"cbc"), aes.hash.sha512, 5)
-- AES 256 CBC with 5 rounds of SHA-512 for the key-- and a salt of "MySalt!!"-- Note: salt can be either nil or exactly 8 characters longlocalencrypted=aes_256_cbc_sha512x5:encrypt("Really secret message!")
ngx.say("AES 256 CBC (SHA-512, salted) Encrypted HEX: ", str.to_hex(encrypted))
ngx.say("AES 256 CBC (SHA-512, salted) Decrypted: ",
aes_256_cbc_sha512x5:decrypt(encrypted))
localaes=require"resty.aes"localstr=require"resty.string"localaes_128_cbc_with_iv=assert(aes:new("1234567890123456",
nil, aes.cipher(128,"cbc"), {iv="1234567890123456"}))
-- AES 128 CBC with IV and no SALTlocalencrypted=aes_128_cbc_with_iv:encrypt("Really secret message!")
ngx.say("AES 128 CBC (WITH IV) Encrypted HEX: ", str.to_hex(encrypted))
ngx.say("AES 128 CBC (WITH IV) Decrypted: ",
aes_128_cbc_with_iv:decrypt(encrypted))
localaes=require"resty.aes"localstr=require"resty.string"localenable_padding=falselocalaes_256_cbc_with_padding=aes:new(
key, nil, aes.cipher(256,"cbc"), {iv=string.sub(key, 1, 16)}, nil,
nil, enable_padding)
-- AES-256 CBC (custom keygen, user padding with block_size=32)localtext="hello"localblock_size=32localpad=block_size-#text%32localtext_paded=text..string.rep(string.char(pad), pad)
localencrypted=aes_256_cbc_with_padding:encrypt(text_paded)
ngx.say("AES-256 CBC (custom keygen, user padding with block_size=32) HEX: ",
str.to_hex(encrypted))Yichun "agentzh" Zhang (章亦春) agentzh@gmail.com
This module is licensed under the BSD license.
Copyright (C) 2012-2018, by Yichun "agentzh" Zhang (章亦春) agentzh@gmail.com, OpenResty Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- the ngx_lua module: http://wiki.nginx.org/HttpLuaModule