$ opm get toruneko/lua-resty-sm4

Name

lua-resty-sm4 - SM4 block cipher algorithm for LuaJIT

Status

This library is considered production ready.

Build status: [!Travis](https://travis-ci.org/toruneko/lua-resty-sm4)

Description

This library requires an nginx build with ngx_lua module, and LuaJIT 2.0.

Synopsis

        # nginx.conf:
    
        lua_package_path "/path/to/lua-resty-sm4/lib/?.lua;;";
    
        server {
            location = /t {
                content_by_lua_block {
                    local resty_sm4 = require "resty.sm4"
                    local sm4 = resty_sm4:new({0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0xFE, 0xDC, 0xBA, 0x98, 0x76, 0x54, 0x32, 0x10})
                    local enc_data = sm4:encrypt({0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, 0xFE, 0xDC, 0xBA, 0x98, 0x76, 0x54, 0x32, 0x10})
    
                    local dec_data = sm4:decrypt({0x68, 0x1e, 0xdf, 0x34, 0xd2, 0x06, 0x96, 0x5e, 0x86, 0xb3, 0xe9, 0x4f, 0x53, 0x6e, 0x42, 0x46})
                }
            }
        }
        

Methods

To load this library,

1. you need to specify this library's path in ngx_lua's lua_package_path directive. For example, lua_package_path "/path/to/lua-resty-sm4/lib/?.lua;;";.

2. you use require to load the library into a local Lua variable:

        local sm4 = require "resty.sm4"

cipher

syntax: ciph = sm4.cipher(_cipher)

creates a evp cipher object for lua-resty-string module.

    local resty_sm4 = require "resty.sm4"
    local resty_aes = require "resty.aes"
    local str = require "resty.string"
    local ciph = resty_sm4.cipher()
    local sm4, err = resty_aes:new("secret", nil, ciph)
    local enc_data = sm4:encrypt("abc")
    ngx.say(str.to_hex(enc_data))
    

new

syntax: obj = sm4.new()

Creates a new sm4 object instance

    -- creates a sm4 object
    local resty_sm4 = require "resty.sm4"
    local sm4 = resty_sm4:new()

encrypt

syntax: enc_data = sm4:encrypt(block)

decrypt

syntax: dec_data = sm4:decrypt(block)

Author

Jianhao Dai (toruneko) <toruneko@outlook.com>

Copyright and License

This module is licensed under the MIT license.

Copyright (C) 2018, by Jianhao Dai (toruneko) <toruneko@outlook.com>

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.

See Also

• the ngx_lua module: https://github.com/openresty/lua-nginx-module =back

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 147:

=over without closing =back