prosody-modules
ec4c6e8f277d
mod_websocket/mod_websocket.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_websocket/mod_websocket.lua @ 909:ec4c6e8f277d

mod_websocket: Change the HTTP name to websocket, and override the default_path instead
author Florian Zeitz <florob@babelmonkeys.de>
date Wed, 13 Feb 2013 21:03:45 +0100
parent 905:eae665bc2122
child 910:c469a2b2d77d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
1 -- Prosody IM
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
2 -- Copyright (C) 2012 Florian Zeitz
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
3 --
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
4 -- This project is MIT/X11 licensed. Please see the
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
5 -- COPYING file in the source package for more information.
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
6 --
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
7
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
8 module:set_global();
129
5fc00a3e47b5 mod_websocket: Initial commit
Ali Sabil <ali.sabil@gmail.com>
parents:
diff changeset
9
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
10 local add_filter = require "util.filters".add_filter;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
11 local sha1 = require "util.hashes".sha1;
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
12 local base64 = require "util.encodings".base64.encode;
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
13 local softreq = require "util.dependencies".softreq;
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
14 local portmanager = require "core.portmanager";
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
15
905
eae665bc2122 mod_websocket: Fix require to work with lua-bitop (Thanks István and Zash)
Florian Zeitz <florob@babelmonkeys.de>
parents: 895
diff changeset
16 local bit;
eae665bc2122 mod_websocket: Fix require to work with lua-bitop (Thanks István and Zash)
Florian Zeitz <florob@babelmonkeys.de>
parents: 895
diff changeset
17 pcall(function() bit = require"bit"; end);
eae665bc2122 mod_websocket: Fix require to work with lua-bitop (Thanks István and Zash)
Florian Zeitz <florob@babelmonkeys.de>
parents: 895
diff changeset
18 bit = bit or softreq"bit32"
eae665bc2122 mod_websocket: Fix require to work with lua-bitop (Thanks István and Zash)
Florian Zeitz <florob@babelmonkeys.de>
parents: 895
diff changeset
19 if not bit then module:log("error", "No bit module found. Either LuaJIT 2, lua-bitop or Lua 5.2 is required"); end
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
20 local band = bit.band;
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
21 local bxor = bit.bxor;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
22
856
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
23 local cross_domain = module:get_option("cross_domain_websocket");
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
24 if cross_domain then
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
25 if cross_domain == true then
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
26 cross_domain = "*";
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
27 elseif type(cross_domain) == "table" then
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
28 cross_domain = table.concat(cross_domain, ", ");
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
29 end
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
30 if type(cross_domain) ~= "string" then
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
31 cross_domain = nil;
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
32 end
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
33 end
7eb54ed58856 mod_websocket: Add CORS support
Florian Zeitz <florob@babelmonkeys.de>
parents: 853
diff changeset
34
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
35 module:depends("c2s")
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
36 local sessions = module:shared("c2s/sessions");
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
37 local c2s_listener = portmanager.get_service("c2s").listener;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
38
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
39 -- Websocket helpers
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
40 local function parse_frame(frame)
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
41 local result = {};
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
42 local pos = 1;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
43 local length_bytes = 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
44 local counter = 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
45 local tmp_byte;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
46
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
47 if #frame < 2 then return; end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
48
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
49 tmp_byte = string.byte(frame, pos);
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
50 result.FIN = band(tmp_byte, 0x80) > 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
51 result.RSV1 = band(tmp_byte, 0x40) > 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
52 result.RSV2 = band(tmp_byte, 0x20) > 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
53 result.RSV3 = band(tmp_byte, 0x10) > 0;
690
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
54 result.opcode = band(tmp_byte, 0x0F);
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
55
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
56 pos = pos + 1;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
57 tmp_byte = string.byte(frame, pos);
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
58 result.MASK = band(tmp_byte, 0x80) > 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
59 result.length = band(tmp_byte, 0x7F);
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
60
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
61 if result.length == 126 then
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
62 length_bytes = 2;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
63 result.length = 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
64 elseif result.length == 127 then
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
65 length_bytes = 8;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
66 result.length = 0;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
67 end
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
68
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
69 if #frame < (2 + length_bytes) then return; end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
70
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
71 for i = 1, length_bytes do
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
72 pos = pos + 1;
840
f568661c9d39 mod_websocket: Fix frame length calculation
Florian Zeitz <florob@babelmonkeys.de>
parents: 839
diff changeset
73 result.length = result.length * 256 + string.byte(frame, pos);
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
74 end
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
75
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
76 if #frame < (2 + length_bytes + (result.MASK and 4 or 0) + result.length) then return; end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
77
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
78 if result.MASK then
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
79 result.key = {string.byte(frame, pos+1), string.byte(frame, pos+2),
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
80 string.byte(frame, pos+3), string.byte(frame, pos+4)}
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
81
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
82 pos = pos + 5;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
83 result.data = "";
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
84 for i = pos, pos + result.length - 1 do
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
85 result.data = result.data .. string.char(bxor(result.key[counter+1], string.byte(frame, i)));
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
86 counter = (counter + 1) % 4;
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
87 end
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
88 else
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
89 result.data = frame:sub(pos + 1, pos + result.length);
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
90 end
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
91
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
92 return result, 2 + length_bytes + (result.MASK and 4 or 0) + result.length;
677
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
93 end
eeb41cd5e9f3 mod_websocket: Move frame handling into a separate function
Florian Zeitz <florob@babelmonkeys.de>
parents: 676
diff changeset
94
687
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
95 local function build_frame(desc)
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
96 local length;
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
97 local result = "";
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
98 local data = desc.data or "";
687
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
99
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
100 result = result .. string.char(0x80 * (desc.FIN and 1 or 0) + desc.opcode);
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
101
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
102 length = #data;
687
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
103 if length <= 125 then -- 7-bit length
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
104 result = result .. string.char(length);
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
105 elseif length <= 0xFFFF then -- 2-byte length
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
106 result = result .. string.char(126);
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
107 result = result .. string.char(length/0x100) .. string.char(length%0x100);
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
108 else -- 8-byte length
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
109 result = result .. string.char(127);
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
110 for i = 7, 0, -1 do
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
111 result = result .. string.char(( length / (2^(8*i)) ) % 0x100);
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
112 end
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
113 end
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
114
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
115 result = result .. data;
687
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
116
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
117 return result;
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
118 end
d141375ece4b mod_websocket: Move frame building into a function
Florian Zeitz <florob@babelmonkeys.de>
parents: 677
diff changeset
119
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
120 --- Filter stuff
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
121 function handle_request(event, path)
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
122 local request, response = event.request, event.response;
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
123 local conn = response.conn;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
124
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
125 if not request.headers.sec_websocket_key then
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
126 response.headers.content_type = "text/html";
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
127 return [[<!DOCTYPE html><html><head><title>Websocket</title></head><body>
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
128 <p>It works! Now point your WebSocket client to this URL to connect to Prosody.</p>
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
129 </body></html>]];
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
130 end
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
131
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
132 local wants_xmpp = false;
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
133 (request.headers.sec_websocket_protocol or ""):gsub("([^,]*),?", function (proto)
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
134 if proto == "xmpp" then wants_xmpp = true; end
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
135 end);
129
5fc00a3e47b5 mod_websocket: Initial commit
Ali Sabil <ali.sabil@gmail.com>
parents:
diff changeset
136
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
137 if not wants_xmpp then
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
138 return 501;
129
5fc00a3e47b5 mod_websocket: Initial commit
Ali Sabil <ali.sabil@gmail.com>
parents:
diff changeset
139 end
5fc00a3e47b5 mod_websocket: Initial commit
Ali Sabil <ali.sabil@gmail.com>
parents:
diff changeset
140
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
141 local function websocket_close(code, message)
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
142 local data = string.char(code/0x100) .. string.char(code%0x100) .. message;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
143 conn:write(build_frame({opcode = 0x8, FIN = true, data = data}));
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
144 conn:close();
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
145 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
146
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
147 local dataBuffer;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
148 local function handle_frame(frame)
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
149 module:log("debug", "Websocket received: %s (%i bytes)", frame.data, #frame.data);
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
150
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
151 -- Error cases
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
152 if frame.RSV1 or frame.RSV2 or frame.RSV3 then -- Reserved bits non zero
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
153 websocket_close(1002, "Reserved bits not zero");
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
154 return false;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
155 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
156
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
157 if frame.opcode >= 0x8 and frame.length > 125 then -- Control frame with too much payload
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
158 websocket_close(1002, "Payload too large");
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
159 return false;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
160 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
161
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
162 if frame.opcode >= 0x8 and not frame.FIN then -- Fragmented control frame
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
163 websocket_close(1002, "Fragmented control frame");
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
164 return false;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
165 end
690
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
166
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
167 if (frame.opcode > 0x2 and frame.opcode < 0x8) or (frame.opcode > 0xA) then
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
168 websocket_close(1002, "Reserved opcode");
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
169 return false;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
170 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
171
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
172 if frame.opcode == 0x0 and not dataBuffer then
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
173 websocket_close(1002, "Unexpected continuation frame");
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
174 return false;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
175 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
176
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
177 if (frame.opcode == 0x1 or frame.opcode == 0x2) and dataBuffer then
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
178 websocket_close(1002, "Continuation frame expected");
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
179 return false;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
180 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
181
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
182 -- Valid cases
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
183 if frame.opcode == 0x0 then -- Continuation frame
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
184 dataBuffer = dataBuffer .. frame.data;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
185 elseif frame.opcode == 0x1 then -- Text frame
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
186 dataBuffer = frame.data;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
187 elseif frame.opcode == 0x2 then -- Binary frame
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
188 websocket_close(1003, "Only text frames are supported");
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
189 return;
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
190 elseif frame.opcode == 0x8 then -- Close request
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
191 websocket_close(1000, "Goodbye");
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
192 return;
691
04662cc35280 mod_websocket: Answer ping frames
Florian Zeitz <florob@babelmonkeys.de>
parents: 690
diff changeset
193 elseif frame.opcode == 0x9 then -- Ping frame
04662cc35280 mod_websocket: Answer ping frames
Florian Zeitz <florob@babelmonkeys.de>
parents: 690
diff changeset
194 frame.opcode = 0xA;
04662cc35280 mod_websocket: Answer ping frames
Florian Zeitz <florob@babelmonkeys.de>
parents: 690
diff changeset
195 conn:write(build_frame(frame));
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
196 return "";
690
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
197 else
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
198 log("warn", "Received frame with unsupported opcode %i", frame.opcode);
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
199 return "";
690
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
200 end
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
201
690
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
202 if frame.FIN then
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
203 data = dataBuffer;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
204 dataBuffer = nil;
690
5acc203972f3 mod_websocket: Add fragmentation support
Florian Zeitz <florob@babelmonkeys.de>
parents: 689
diff changeset
205
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
206 return data;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
207 end
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
208 return "";
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
209 end
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
210
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
211 conn:setlistener(c2s_listener);
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
212 c2s_listener.onconnect(conn);
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
213
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
214 local frameBuffer = "";
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
215 add_filter(sessions[conn], "bytes/in", function(data)
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
216 local cache = "";
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
217 frameBuffer = frameBuffer .. data;
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
218 local frame, length = parse_frame(frameBuffer);
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
219
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
220 while frame do
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
221 frameBuffer = frameBuffer:sub(length + 1);
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
222 local result = handle_frame(frame);
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
223 if not result then return; end
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
224 cache = cache .. result;
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
225 frame, length = parse_frame(frameBuffer);
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
226 end
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
227 return cache;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
228
844
a0987c0e4e1d mod_websocket: Check whether the xmpp sub-protocol was requested
Florian Zeitz <florob@babelmonkeys.de>
parents: 842
diff changeset
229 end);
a0987c0e4e1d mod_websocket: Check whether the xmpp sub-protocol was requested
Florian Zeitz <florob@babelmonkeys.de>
parents: 842
diff changeset
230
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
231 add_filter(sessions[conn], "bytes/out", function(data)
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
232 return build_frame({ FIN = true, opcode = 0x01, data = tostring(data)});
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
233 end);
842
32df4d13f178 mod_websocket: More robust frame handling
Florian Zeitz <florob@babelmonkeys.de>
parents: 840
diff changeset
234
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
235 response.status = "101 Switching Protocols";
895
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
236 response.headers.upgrade = "websocket";
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
237 response.headers.connection = "Upgrade";
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
238 response.headers.sec_webSocket_accept = base64(sha1(request.headers.sec_websocket_key .. "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"));
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
239 response.headers.sec_webSocket_protocol = "xmpp";
1f4d77104da5 mod_websocket: Simplify by getting the c2s_listener from mod_c2s
Florian Zeitz <florob@babelmonkeys.de>
parents: 857
diff changeset
240 response.headers.access_control_allow_origin = cross_domain;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
241
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
242 return "";
129
5fc00a3e47b5 mod_websocket: Initial commit
Ali Sabil <ali.sabil@gmail.com>
parents:
diff changeset
243 end
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
244
688
e87678a52720 mod_websocket: Make this a shared module
Florian Zeitz <florob@babelmonkeys.de>
parents: 687
diff changeset
245 function module.add_host(module)
e87678a52720 mod_websocket: Make this a shared module
Florian Zeitz <florob@babelmonkeys.de>
parents: 687
diff changeset
246 module:depends("http");
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
247 module:provides("http", {
909
ec4c6e8f277d mod_websocket: Change the HTTP name to websocket, and override the default_path instead
Florian Zeitz <florob@babelmonkeys.de>
parents: 905
diff changeset
248 name = "websocket";
ec4c6e8f277d mod_websocket: Change the HTTP name to websocket, and override the default_path instead
Florian Zeitz <florob@babelmonkeys.de>
parents: 905
diff changeset
249 default_path = "xmpp-websocket";
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
250 route = {
849
6e2ec1825182 mod_websocket: Accept GET request without trailing /
Florian Zeitz <florob@babelmonkeys.de>
parents: 844
diff changeset
251 ["GET"] = handle_request;
6e2ec1825182 mod_websocket: Accept GET request without trailing /
Florian Zeitz <florob@babelmonkeys.de>
parents: 844
diff changeset
252 ["GET /"] = handle_request;
676
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
253 };
54fa9d6d7809 mod_websocket: New mod_c2s based version, still WIP
Florian Zeitz <florob@babelmonkeys.de>
parents: 129
diff changeset
254 });
129
5fc00a3e47b5 mod_websocket: Initial commit
Ali Sabil <ali.sabil@gmail.com>
parents:
diff changeset
255 end