Skip to content

Latest commit

 

History

History
621 lines (508 loc) · 24.3 KB

README.md

File metadata and controls

621 lines (508 loc) · 24.3 KB
Raw

wiola

WAMP (WebSocket Application Messaging Protocol) implementation on Lua, using the power of Lua Nginx module, Lua WebSocket addon, and Redis as cache store.

Table of Contents

Description

Wiola implements WAMP specification v2 router specification on top of OpenResty web server, which is actually nginx plus a bunch of 3rd party modules, such as lua-nginx-module, lua-resty-websocket, lua-resty-redis and so on.

Wiola supports next WAMP roles and features:

  • broker: advanced profile with features:
    • pattern based subscription
    • publisher exclusion
    • publisher identification
    • publication trust levels
    • session meta api
    • subscriber blackwhite listing
    • subscription meta api (partly)
  • dealer: advanced profile with features:
    • call canceling
    • call timeout
    • caller identification
    • call trust levels
    • pattern based registration
    • progressive call results
    • registration meta api (partly)
    • session meta api
  • Challenge Response Authentication ("WAMP-CRA")
  • Cookie Authentication
  • Rawsocket transport
  • Session Meta API

Wiola supports JSON and msgpack serializers.

From v0.3.1 Wiola also supports lightweight POST event publishing. See processPostData method and post-handler.lua for details.

Back to TOC

Usage example

For example usage, please see ws-handler.lua file.

Back to TOC

Installation

To use wiola you need:

Instead of compiling lua-* modules into nginx, you can simply use OpenResty server.

In any case, for your convenience, you can install Wiola through luarocks by luarocks install wiola or through OpenResty Package Manager by opm install KSDaemon/wiola. Unfortunately, not all dependencies are available in opm, so you need to manually install missing ones.

Next thing is configuring nginx host. See example below.

http {

    # set search paths for pure Lua external libraries (';;' is the default path):
    # add paths for wiola and msgpack libs
    lua_package_path '/usr/local/lualib/wiola/?.lua;/usr/local/lualib/lua-MessagePack/?.lua;;';

    init_worker_by_lua_block {
        -- Initializing math.randomseed for every worker/luaVM
        local f = io.open('/dev/random', 'rb')
        local seed
        if f then
            local b1, b2, b3, b4 = string.byte(f:read(4), 1, 4)
            seed = b1 * 0x1000000 + b2 * 0x10000 + b3 * 0x100 + b4
            f:close()
        else
            seed = ngx.time() + ngx.worker.pid()
        end
        math.randomseed(seed)
        math.randomseed = function()end
    }


    init_by_lua_block {
        -- Wiola configuration. You can read more in description of .configure() method below.
        local cfg = require "wiola.config"
        cfg.config({
            socketTimeout = 1000,           -- one second
            maxPayloadLen = 65536,
            pingInterval = 1000,  -- interval in ms for sending ping frames. set to 0 for disabling
            realms = { "app", "admin" },
            store = "redis",
            storeConfig = {
                host = "unix:///tmp/redis.sock",  -- Optional parameter. Can be hostname/ip or socket path
                --port = 6379                     -- Optional parameter. Should be set when using hostname/ip
                                                  -- Omit for socket connection
                --db = 5                          -- Optional parameter. Redis db to use
            },
            callerIdentification = "auto",        -- Optional parameter. auto | never | always
            cookieAuth = {                        -- Optional parameter.
                authType = "none",                -- none | static | dynamic
                cookieName = "wampauth",
                staticCredentials = nil, --{
                    -- "user1", "user2:password2", "secretkey3"
                --},
                authCallback = nil
            },
            wampCRA = {                           -- Optional parameter.
                authType = "none",                -- none | static | dynamic
                staticCredentials = nil, --{
                    -- user1 = { authrole = "userRole1", secret="secret1" },
                    -- user2 = { authrole = "userRole2", secret="secret2" }
                --},
                challengeCallback = nil,
                authCallback = nil
            },
            trustLevels = {                       -- Optional parameter.
                authType = "none",                -- none | static | dynamic
                defaultTrustLevel = nil,
                staticCredentials = {
                    byAuthid = {
                        --{ authid = "user1", trustlevel = 1 },
                        --{ authid = "admin1", trustlevel = 5 }
                    },
                    byAuthRole = {
                        --{ authrole = "user-role", trustlevel = 2 },
                        --{ authrole = "admin-role", trustlevel = 4 }
                    },
                    byClientIp = {
                        --{ clientip = "127.0.0.1", trustlevel = 10 }
                    }
                },
                authCallback = nil -- function that accepts (client ip address, realm,
                                   -- authid, authrole) and returns trust level
            },
            metaAPI = {                           -- Expose META API ? Optional parameter.
                session = true,
                subscription = true,
                registration = true
            }
        })

        -- If you want automatically clean up redis db during nginx restart uncomment next two lines
        -- for this to work, you need redis-lua library
        -- Use it only with lua_code_cache on; !!!
        --local wflush = require "wiola.flushdb"
        --wflush.flushAll()
    }

    # Configure a vhost
    server {
       # example location for websocket WAMP connection
       location /ws/ {
          set $wiola_max_payload_len 65535; # Optional parameter. Set the value to suit your needs

          lua_socket_log_errors off;
          lua_check_client_abort on;

          # This is needed to set additional websocket protocol headers
          header_filter_by_lua_file $document_root/lua/wiola/headers.lua;
          # Set a handler for connection
          content_by_lua_file $document_root/lua/wiola/ws-handler.lua;
       }

       # example location for a lightweight POST event publishing
       location /wslight/ {
          lua_socket_log_errors off;
          lua_check_client_abort on;

          content_by_lua_file $document_root/lua/wiola/post-handler.lua;
       }

    }
}

If you want to use raw socket transport instead of (or additional to) websocket, you need also to configure nginx stream

stream {
    # set search paths for pure Lua external libraries (';;' is the default path):
    # add paths for wiola and msgpack libs
    lua_package_path '/usr/local/lualib/wiola/?.lua;/usr/local/lualib/lua-MessagePack/?.lua;;';

    init_worker_by_lua_block {
        # Actually same one as in http example above...
    }

    init_by_lua_block {
        # Actually same one as in http example above...
    }

    server {
        listen 1234;
        lua_check_client_abort on;
        content_by_lua_file $document_root/lua/wiola/raw-handler.lua;
    }

}

Also, starting from v0.12.0 Wiola uses Redis pubsub system instead of polling for retreiving client data. So you need to configure Redis server and enable keyspace-events. Btw, you do not need to enable all events. Wiola needs only keyspace events for list.

Edit redis.conf and set notify-keyspace-events option.

notify-keyspace-events "Kl"

Actually, you do not need to do anything else. Just take any WAMP client and make a connection.

Back to TOC

Authentication

Beginning with v0.6.0 Wiola supports several types of authentication:

  • Cookie authentication:
    • Static configuration
    • Dynamic callback
  • Challenge Response Authentication:
    • Static configuration
    • Dynamic callback

Also it is possible to use both types of authentication :) To setup authentication you need to config Wiola somewhere in nginx/openresty before request processing. In simple case, you can do it just in nginx http config section.

local cfg = require "wiola.config"
cfg.config({
    cookieAuth = {
        authType = "dynamic",              -- none | static | dynamic
        cookieName = "wampauth",
        staticCredentials = { "user1:pass1", "user2:pass2"},
        authCallback = function (creds)
            -- Validate credentials somehow
            -- return true, if valid
            if isValid(creds) then
                return true
            end

            return false
        end
    },
    wampCRA = {
        authType = "dynamic",              -- none | static | dynamic
        staticCredentials = {
            user1 = { authrole = "userRole1", secret="secret1" },
            user2 = { authrole = "userRole2", secret="secret2" }
        },
        challengeCallback = function (sessionid, authid)
            -- Generate a challenge string somehow and return it
            -- Do not forget to save it somewhere for response validation!

            return "{ \"nonce\": \"LHRTC9zeOIrt_9U3\"," ..
                     "\"authprovider\": \"usersProvider\", \"authid\": \"" .. authid .. "\"," ..
                     "\"timestamp\": \"" .. os.date("!%FT%TZ") .. "\"," ..
                     "\"authrole\": \"userRole1\", \"authmethod\": \"wampcra\"," ..
                     "\"session\": " .. sessionid .. "}"
        end,
        authCallback = function (sessionid, signature)
            -- Validate responsed signature against challenge
            -- return auth info object (like bellow) or nil if failed
            return { authid="user1", authrole="userRole1", authmethod="wampcra", authprovider="usersProvider" }
        end
    }
})

Back to TOC

Call and Publication trust levels

Beginning with v0.9.0 Wiola supports Call and Publication trust levels labeling To setup trust levels you need to config Wiola somewhere in nginx/openresty before request processing. In simple case, you can do it just in nginx http config section. For static configuration, authid option takes precendence over authrole, which takes precendence over client ip. For example, if client match all three options (authid, authrole, client ip), than trust level from auth id will be set.

local cfg = require "wiola.config"

-- Static trustlevel configuration
cfg.config({
    trustLevels = {
        authType = "static",
        defaultTrustLevel = 5,
        staticCredentials = {
            byAuthid = {
                { authid = "user1", trustlevel = 1 },
                { authid = "admin1", trustlevel = 5 }
            },
            byAuthRole = {
                { authrole = "user-role", trustlevel = 2 },
                { authrole = "admin-role", trustlevel = 4 }
            },
            byClientIp = {
                { clientip = "127.0.0.1", trustlevel = 10 }
            }
        }
    }
})

-- Dynamic trustlevel configuration
cfg.config({
    trustLevels = {
        authType = "dynamic",
        authCallback = function (clientIp, realm, authid, authrole)

            -- write your own logic for setting trust level
            -- just a simple example

            if clientIp == "127.0.0.1" then
                return 15
            end

            if realm == "test" then
                return nil
            end

            return 5
        end
    }
})

Back to TOC

Methods

config(config)

Configure Wiola Instance or retrieve current configuration. All options are optional. Some options have default value, or are nils if not specified.

Parameters:

  • config - Configuration table with possible options:
    • socketTimeout - Timeout for underlying socket connection operations. Default: 100 ms
    • maxPayloadLen - Maximal length of payload allowed when sending and receiving using underlying socket. Default: 65536 bytes (2^16). For raw socket transport please use values, aligned with power of two between 9 and 24. 2^9, 2^10 .. 2^24.
    • pingInterval - Interval in ms for sending ping frames. Set to 0 for disabling server initiated ping. Default: 1000 ms
    • realms - Array of allowed WAMP realms. Default value: {} - so no clients will connect to router. Also it's possible to set special realm { "*" } - which allows to create any realm on client request if it not exists, great for development use.
    • redis - Redis connection configuration table:
      • host - Redis server host or Redis unix socket path. Default: "unix:/tmp/redis.sock"
      • port - Redis server port (in case of use network connection). Omit for socket connection
      • db - Redis database index to select
    • callerIdentification - Disclose caller identification? Possible values: auto | never | always. Default: "auto"
    • cookieAuth - Cookie-based Authentication configuration table:
      • authType - Type of auth. Possible values: none | static | dynamic. Default: "none", which means - don't use
      • cookieName - Name of cookie with auth info. Default: "wampauth"
      • staticCredentials - Array-like table with string items, allowed to connect. Is used with authType="static"
      • authCallback - Callback function for authentication. Is used with authType="dynamic". Value of cookieName is passed as first parameter. Should return boolean flag, true - allows connection, false - prevent connection
    • wampCRA - WAMP Challenge-Response ("WAMP-CRA") authentication configuration table:
      • authType - Type of auth. Possible values: none | static | dynamic. Default: "none", which means - don't use
      • staticCredentials - table with keys, named as authids and values like { authrole = "userRole1", secret="secret1" }, allowed to connect. Is used with authType="static"
      • challengeCallback - Callback function for generating challenge info. Is used with authType="dynamic". Is called on HELLO message, passing session ID as first parameter and authid as second one. Should return challenge string the client needs to create a signature for. Check Challenge Response Authentication section in WAMP Specification for more info.
      • authCallback - Callback function for checking auth signature. Is used with authType="dynamic". Is called on AUTHENTICATE message, passing session ID as first parameter and signature as second one. Should return auth info object { authid="user1", authrole="userRole", authmethod="wampcra", authprovider="usersProvider" } or nil | false in case of failure.
    • trustLevels - Trust levels configuration table:
      • authType - Type of auth. Possible values: none | static | dynamic. Default: "none", which means - don't use
      • defaultTrustLevel - Default trust level for clients that doesn't match to any static credentials. Should be any positive integer or nil for omitting
      • staticCredentials - Is used with authType="static". Has 3 subtables:
        • byAuthid. This array-like table holds items like { authid = "user1", trustlevel = 1 }
        • byAuthRole. This array-like table holds items like { authrole = "user-role", trustlevel = 2 }
        • byClientIp. This array-like table holds items like { clientip = "127.0.0.1", trustlevel = 10 }
      • authCallback - Callback function for getting trust level for client. It accepts (client ip address, realm, authid, authrole) and returns trust level (positive integer or nil)
    • metaAPI - Meta API configuration table:
      • session - Expose session meta api? Possible values: true | false. Default: false.
      • subscription - Expose subscription meta api? Possible values: true | false. Default: false.
      • registration - Expose registration meta api? Possible values: true | false. Default: false.

When called without parameters, returns current configuration. When setting configuration, returns nothing.

Config example (multiple options, just for showcase):

    init_by_lua_block {
        local cfg = require "wiola.config"
        cfg.config({
            socketTimeout = 1000,           -- one second
            maxPayloadLen = 65536,
            realms = { "test", "app" },
            callerIdentification = "always",
            redis = {
                host = "unix:/tmp/redis.sock"   -- Optional parameter. Can be hostname/ip or socket path
                --port = 6379                     -- Optional parameter. Should be set when using hostname/ip
                                                -- Omit for socket connection
                --db = 5                         -- Optional parameter. Redis db to use
            },
            cookieAuth = {
                authType = "none",              -- none | static | dynamic
                cookieName = "wampauth",
                staticCredentials = { "user1:pass1", "user2:pass2"},
                authCallback = function (creds)
                    if creds ~= "" then
                        return true
                    end

                    return false
                end
            },
            wampCRA = {
                authType = "dynamic",              -- none | static | dynamic
                staticCredentials = {
                    user1 = { authrole = "userRole1", secret="secret1" },
                    user2 = { authrole = "userRole2", secret="secret2" }
                },
                challengeCallback = function (sessionid, authid)
                    return "{ \"nonce\": \"LHRTC9zeOIrt_9U3\"," ..
                             "\"authprovider\": \"usersProvider\", \"authid\": \"" .. authid .. "\"," ..
                             "\"timestamp\": \"" .. os.date("!%FT%TZ") .. "\"," ..
                             "\"authrole\": \"userRole1\", \"authmethod\": \"wampcra\"," ..
                             "\"session\": " .. sessionid .. "}"
                end,
                authCallback = function (sessionid, signature)
                    return { authid="user1", authrole="userRole1", authmethod="wampcra", authprovider="usersProvider" }
                end
            },
            metaAPI = {
                session = true,
                subscription = false,
                registration = false
            }
        })
    }

Back to TOC

addConnection(sid, wampProto)

Adds new connection instance to wiola control.

Parameters:

  • sid - nginx session id
  • wampProto - chosen WAMP subprotocol. It is set in header filter. So just pass here ngx.header["Sec-WebSocket-Protocol"]. It's done just in order not to use shared variables.

Returns:

  • WAMP session ID (integer)
  • Connection data type (string: 'text' or 'binary')

Back to TOC

receiveData(regId, data)

This method should be called, when new data is received from web socket. This method analyze all incoming messages, set states and prepare response data for clients.

Parameters:

  • regId - WAMP session ID
  • data - received data

Returns: nothing

Back to TOC

getPendingData(regId)

Checks the store for new data for client.

Parameters:

  • regId - WAMP session ID

Returns:

  • client data (type depends on session data type) or null
  • error description in case of error

This method is actualy a proxy for redis:lpop() method.

Back to TOC

processPostData(sid, realm, data)

Process lightweight POST data from client containing a publish message. This method is intended for fast publishing an event, for example, in case when WAMP client is a browser application, which makes some changes on backend server, so backend is a right place to notify other WAMP subscribers, but making a full WAMP connection is not optimal.

Parameters:

  • sid - nginx session connection ID
  • realm - WAMP Realm to operate in
  • data - data, received through POST (JSON-encoded WAMP publish event)

Returns:

  • response data (JSON encoded WAMP response message in case of error, or { result = true })
  • httpCode HTTP status code (HTTP_OK/200 in case of success, HTTP_FORBIDDEN/403 in case of error)

Back to TOC

Copyright and License

Wiola library is licensed under the BSD 2-Clause license.

Copyright (c) 2014-2017, Konstantin Burkalev 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.

Back to TOC

See Also

Back to TOC

Thanks JetBrains for the best IDEs and support for open source!

jetbrains logo