$ opm get openresty/lua-resty-string

名称

lua-resty-string - ngx_lua 和 LuaJIT 的字符串工具和常用哈希函数

状态

该库被认为是实验性的，并且仍在积极开发中。

API 仍在变化中，可能随时更改，恕不另行通知。

描述

此库需要使用 OpenSSL 构建的 nginx，ngx_lua 模块 和 LuaJIT 2.0。

摘要

        # nginx.conf:
    
        lua_package_path "/path/to/lua-resty-string/lib/?.lua;;";
    
        server {
            location = /test {
                content_by_lua_file conf/test.lua;
            }
        }
    
        -- conf/test.lua:
    
        local resty_sha1 = require "resty.sha1"
    
        local sha1 = resty_sha1:new()
        if not sha1 then
            ngx.say("failed to create the sha1 object")
            return
        end
    
        local ok = sha1:update("hello, ")
        if not ok then
            ngx.say("failed to add data")
            return
        end
    
        ok = sha1:update("world")
        if not ok then
            ngx.say("failed to add data")
            return
        end
    
        local digest = sha1:final()  -- binary digest
    
        local str = require "resty.string"
        ngx.say("sha1: ", str.to_hex(digest))
            -- output: "sha1: b7e23ec29af22b0b4e41da31e868d57226121c84"
    
        local resty_md5 = require "resty.md5"
        local md5 = resty_md5:new()
        if not md5 then
            ngx.say("failed to create md5 object")
            return
        end
    
        local ok = md5:update("hel")
        if not ok then
            ngx.say("failed to add data")
            return
        end
    
        ok = md5:update("lo")
        if not ok then
            ngx.say("failed to add data")
            return
        end
    
        local digest = md5:final()
    
        local str = require "resty.string"
        ngx.say("md5: ", str.to_hex(digest))
            -- yield "md5: 5d41402abc4b2a76b9719d911017c592"
    
        local resty_sha224 = require "resty.sha224"
        local str = require "resty.string"
        local sha224 = resty_sha224:new()
        ngx.say(sha224:update("hello"))
        local digest = sha224:final()
        ngx.say("sha224: ", str.to_hex(digest))
    
        local resty_sha256 = require "resty.sha256"
        local str = require "resty.string"
        local sha256 = resty_sha256:new()
        ngx.say(sha256:update("hello"))
        local digest = sha256:final()
        ngx.say("sha256: ", str.to_hex(digest))
    
        local resty_sha512 = require "resty.sha512"
        local str = require "resty.string"
        local sha512 = resty_sha512:new()
        ngx.say(sha512:update("hello"))
        local digest = sha512:final()
        ngx.say("sha512: ", str.to_hex(digest))
    
        local resty_sha384 = require "resty.sha384"
        local str = require "resty.string"
        local sha384 = resty_sha384:new()
        ngx.say(sha384:update("hel"))
        ngx.say(sha384:update("lo"))
        local digest = sha384:final()
        ngx.say("sha384: ", str.to_hex(digest))
    
        local resty_random = require "resty.random"
        local str = require "resty.string"
        local random = resty_random.bytes(16)
            -- generate 16 bytes of pseudo-random data
        ngx.say("pseudo-random: ", str.to_hex(random))
    
        local resty_random = require "resty.random"
        local str = require "resty.string"
        local strong_random = resty_random.bytes(16,true)
            -- attempt to generate 16 bytes of
            -- cryptographically strong random data
        while strong_random == nil do
            strong_random = resty_random.bytes(16,true)
        end
        ngx.say("random: ", str.to_hex(strong_random))
    
        local aes = require "resty.aes"
        local str = require "resty.string"
        local aes_128_cbc_md5 = aes:new("AKeyForAES")
            -- the default cipher is AES 128 CBC with 1 round of MD5
            -- for the key and a nil salt
        local encrypted = 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))
    
        local aes = require "resty.aes"
        local str = require "resty.string"
        local aes_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 long
        local encrypted = 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))
    
        local aes = require "resty.aes"
        local str = require "resty.string"
        local aes_128_cbc_with_iv = assert(aes:new("1234567890123456",
            nil, aes.cipher(128,"cbc"), {iv="1234567890123456"}))
            -- AES 128 CBC with IV and no SALT
        local encrypted = 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))

作者

章亦春 (Yichun "agentzh" Zhang) <[email protected]>

版权和许可

此模块根据 BSD 许可证发布。

版权所有 (C) 2012-2018，由章亦春 (Yichun "agentzh" Zhang) <[email protected]>，OpenResty Inc. 所有。

保留所有权利。

在满足以下条件的情况下，允许以源代码和二进制形式重新分发和使用，无论是否修改：

• 源代码的再分发必须保留上述版权声明、此条件列表以及以下免责声明。

• 二进制形式的再分发必须在随分发提供的文档和/或其他材料中复制上述版权声明、此条件列表以及以下免责声明。

本软件由版权持有人和贡献者“按原样”提供，并且任何明示或暗示的担保，包括但不限于适销性和特定用途适用性的暗示担保，均被免除。在任何情况下，版权持有人或贡献者均不对任何直接、间接、偶然、特殊、惩戒性或后果性损害（包括但不限于替代商品或服务的采购；使用、数据或利润损失；或业务中断）负责，无论这些损害是如何造成的以及基于任何责任理论，无论是合同、严格责任还是侵权行为（包括疏忽或其他原因），即使已被告知此类损害的可能性。

另请参阅

• ngx_lua 模块：http://wiki.nginx.org/HttpLuaModule