toritori0318 / lua-resty-querymask

lua resty querymask

query mask library.

Installation

luarocks install https://raw.githubusercontent.com/toritori0318/lua-resty-querymask/master/lua-resty-querymask-dev-1.rockspec

Synopsis

Basic

server {
    location /mask {
        content_by_lua_block {
            local querymask = require "resty.querymask"
            local q = querymask:new({
                mode = "writelist",
                mask_part_string = "*",
                mask_part_length = 3,
                mask_fill_string = "*MASK*",
                mask_hash_seed   = "hogefugapiyo",
                max_field_length = 512,
                fields = {
                  origin = {"attr1", "attr2"},
                  part   = {"attr3"},
                  fill   = {"attr4"},
                  hash   = {"attr5"},
                }
            })
            -- get table
            masked_query_table  = q:mask_query_table()
            -- get string
            masked_query_string = q:mask_query_string()

            ngx.header.content_type = "text/plain"

            ngx.say(masked_query_string)
            -- (example)
            --   curl 'http://localhost/mask?attr1=hogeeee&attr2=fugaaaa&attr3=piyoooo&attr4=fooooo&attr5=barrrrr'
            -- 
            --   attr1=hogeeee&attr2=fugaaaa&attr3=piy****&attr4=*MASK*&attr5=eoroiaweuroajejrfalwjreoaijrejwaerwaer'
        }
    }

    # curl 'http://localhost/get_hash?data=eoroiaweuroajejrfalwjreoaijrejwaerwaer
    location /get_hash {
        allow xxx.xxx.xxx.xxx;
        deny all;

        content_by_lua_block {
            local data = ngx.req.get_uri_args().data

            local querymask = require "resty.querymask"
            local q = querymask:new({
                mode = "writelist",
                mask_part_string = "*",
                mask_part_length = 3,
                mask_fill_string = "*MASK*",
                mask_hash_seed   = "hogefugapiyo",
                max_field_length = 512,
                fields = {
                  origin = {"attr1", "attr2"},
                  part   = {"attr3"},
                  fill   = {"attr4"},
                  hash   = {"attr5"},
                }
            })
            -- get hash
            local data_hash = q:get_hash(data)

            ngx.header.content_type = "text/plain"

            ngx.say(data_hash)
        }
    }
}

Include Nginx Log

log_format querymask_format
                  '$remote_addr - $remote_user [$time_local] '
                  '"$request" $status $body_bytes_sent '
                  '"$http_referer" "$http_user_agent" '
                  '"$x_mask_query"'
                  ;

server {


    access_log /var/log/nginx/nginx-access-querymask.log querymask_format;

    # set nginx valiables
    set $x_mask_query '-';

    location /mask {
        content_by_lua_block {
            local querymask = require "resty.querymask"
            local q = querymask:new({
                mode = "writelist",
                mask_part_string = "*",
                mask_part_length = 3,
                mask_fill_string = "*MASK*",
                mask_hash_seed   = "hogefugapiyo",
                max_field_length = 512,
                fields = {
                  origin = {"attr1", "attr2"},
                  part   = {"attr3"},
                  fill   = {"attr4"},
                  hash   = {"attr5"},
                }
            })
            -- get table
            masked_query_table  = q.mask_query_table()
            -- get string
            masked_query_string = q.mask_query_string()

            -- set nginx valiables
            ngx.var.x_mask_query = masked_query_string

            ngx.header.content_type = "text/plain"

            ngx.say(masked_query_string)
        }
    }
}

Parameters

mode

• whitelist
• blacklist

mask_part_string

mask_part_length

mask_fill_string

mask_hash_seed

max_field_length

fields

• operation
  • part
  • fill
  • hash

For Developer

docker run & run test

make docker-test

Authors

• TSUYOSHI TORII (toritori0318)

License

MIT