2 -- server.lua by blastbeat of the luadch project
3 -- Re-used here under the MIT/X Consortium License
5 -- Modifications (C) 2008-2009 Matthew Wild, Waqas Hussain
8 -- // wrapping luadch stuff // --
10 local use = function( what )
13 local clean = function( tbl )
14 for i, k in pairs( tbl ) do
19 local log, table_concat = require ("util.logger").init("socket"), table.concat;
20 local out_put = function (...) return log("debug", table_concat{...}); end
21 local out_error = function (...) return log("warn", table_concat{...}); end
22 local mem_free = collectgarbage
24 ----------------------------------// DECLARATION //--
28 local STAT_UNIT = 1 -- byte
30 --// lua functions //--
32 local type = use "type"
33 local pairs = use "pairs"
34 local ipairs = use "ipairs"
35 local tostring = use "tostring"
36 local collectgarbage = use "collectgarbage"
41 local table = use "table"
42 local string = use "string"
43 local coroutine = use "coroutine"
45 --// lua lib methods //--
47 local os_time = os.time
48 local os_difftime = os.difftime
49 local table_concat = table.concat
50 local table_remove = table.remove
51 local string_len = string.len
52 local string_sub = string.sub
53 local coroutine_wrap = coroutine.wrap
54 local coroutine_yield = coroutine.yield
58 local luasec = select( 2, pcall( require, "ssl" ) )
59 local luasocket = require "socket"
61 --// extern lib methods //--
63 local ssl_wrap = ( luasec and luasec.wrap )
64 local socket_bind = luasocket.bind
65 local socket_sleep = luasocket.sleep
66 local socket_select = luasocket.select
67 local ssl_newcontext = ( luasec and luasec.newcontext )
99 --// simple data types //--
126 local _maxclientsperserver
128 ----------------------------------// DEFINITION //--
130 _server = { } -- key = port, value = table; list of listening servers
131 _readlist = { } -- array with sockets to read from
132 _sendlist = { } -- arrary with sockets to write to
133 _timerlist = { } -- array of timer functions
134 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
135 _readtimes = { } -- key = handler, value = timestamp of last data reading
136 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
137 _closelist = { } -- handlers to close
139 _readlistlen = 0 -- length of readlist
140 _sendlistlen = 0 -- length of sendlist
141 _timerlistlen = 0 -- lenght of timerlist
143 _sendtraffic = 0 -- some stats
146 _selecttimeout = 1 -- timeout of socket.select
147 _sleeptime = 0 -- time to wait at the end of every loop
149 _maxsendlen = 51000 * 1024 -- max len of send buffer
150 _maxreadlen = 25000 * 1024 -- max len of read buffer
152 _checkinterval = 1200000 -- interval in secs to check idle clients
153 _sendtimeout = 60000 -- allowed send idle time in secs
154 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
156 _cleanqueue = false -- clean bufferqueue after using
158 _maxclientsperserver = 1000
160 _maxsslhandshake = 30 -- max handshake round-trips
161 ----------------------------------// PRIVATE //--
163 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx, maxconnections, startssl ) -- this function wraps a server
165 maxconnections = maxconnections or _maxclientsperserver
167 local connections = 0
169 local dispatch, disconnect = listeners.onincoming, listeners.ondisconnect
177 if not ssl_newcontext then
178 out_error "luasec not found"
181 if type( sslctx ) ~= "table" then
182 out_error "server.lua: wrong server sslctx"
186 ctx, err = ssl_newcontext( sslctx )
188 err = err or "wrong sslctx parameters"
190 file = err:match("^error loading (.-) %(");
192 if file == "private key" then
193 file = sslctx.key or "your private key";
194 elseif file == "certificate" then
195 file = sslctx.certificate or "your certificate file";
197 local reason = err:match("%((.+)%)$") or "some reason";
198 if reason == "Permission denied" then
199 reason = "Check that the permissions allow Prosody to read this file.";
200 elseif reason == "No such file or directory" then
201 reason = "Check that the path is correct, and the file exists.";
202 elseif reason == "system lib" then
203 reason = "Previous error (see logs), or other system error.";
205 reason = "Reason: "..tostring(reason or "unknown"):lower();
207 log("error", "SSL/TLS: Failed to load %s: %s", file, reason);
209 log("error", "SSL/TLS: Error initialising for port %d: %s", serverport, err );
218 log("error", "Failed to listen on port %d due to SSL/TLS to SSL/TLS initialisation errors (see logs)", serverport )
219 return nil, "Cannot start ssl, see log for details"
223 local accept = socket.accept
225 --// public methods of the object //--
229 handler.shutdown = function( ) end
231 handler.ssl = function( )
234 handler.sslctx = function( )
237 handler.remove = function( )
238 connections = connections - 1
240 handler.close = function( )
241 for _, handler in pairs( _socketlist ) do
242 if handler.serverport == serverport then
243 handler.disconnect( handler, "server closed" )
244 handler:close( true )
248 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
249 _readlistlen = removesocket( _readlist, socket, _readlistlen )
250 _socketlist[ socket ] = nil
254 out_put "server.lua: closed server handler and removed sockets from list"
256 handler.ip = function( )
259 handler.serverport = function( )
262 handler.socket = function( )
265 handler.readbuffer = function( )
266 if connections > maxconnections then
267 out_put( "server.lua: refused new client connection: server full" )
270 local client, err = accept( socket ) -- try to accept
272 local ip, clientport = client:getpeername( )
273 client:settimeout( 0 )
274 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx, startssl ) -- wrap new client socket
275 if err then -- error while wrapping ssl socket
278 connections = connections + 1
279 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
280 return dispatch( handler )
281 elseif err then -- maybe timeout or something else
282 out_put( "server.lua: error with new client connection: ", tostring(err) )
289 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx, startssl ) -- this function wraps a client to a handler object
291 socket:settimeout( 0 )
293 --// local import of socket methods //--
299 --// private closures of the object //--
303 local dispatch = listeners.onincoming
304 local status = listeners.status
305 local disconnect = listeners.ondisconnect
307 local bufferqueue = { } -- buffer array
308 local bufferqueuelen = 0 -- end of buffer array
319 local sendtraffic, readtraffic = 0, 0
321 local maxsendlen = _maxsendlen
322 local maxreadlen = _maxreadlen
324 --// public methods of the object //--
326 local handler = bufferqueue -- saves a table ^_^
328 handler.dispatch = function( )
331 handler.disconnect = function( )
334 handler.setlistener = function( self, listeners )
335 dispatch = listeners.onincoming
336 disconnect = listeners.ondisconnect
338 handler.getstats = function( )
339 return readtraffic, sendtraffic
341 handler.ssl = function( )
344 handler.sslctx = function ( )
347 handler.send = function( _, data, i, j )
348 return send( socket, data, i, j )
350 handler.receive = function( pattern, prefix )
351 return receive( socket, pattern, prefix )
353 handler.shutdown = function( pattern )
354 return shutdown( socket, pattern )
356 handler.setoption = function (self, option, value)
357 if socket.setoption then
358 return socket:setoption(option, value);
360 return false, "setoption not implemented";
362 handler.close = function( self, forced )
363 if not handler then return true; end
364 _readlistlen = removesocket( _readlist, socket, _readlistlen )
365 _readtimes[ handler ] = nil
366 if bufferqueuelen ~= 0 then
367 if not ( forced or fatalerror ) then
368 handler.sendbuffer( )
369 if bufferqueuelen ~= 0 then -- try again...
371 handler.write = nil -- ... but no further writing allowed
377 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
381 _ = shutdown and shutdown( socket )
383 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
384 _socketlist[ socket ] = nil
387 out_put "server.lua: socket already closed"
390 _writetimes[ handler ] = nil
391 _closelist[ handler ] = nil
397 out_put "server.lua: closed client handler and removed socket from list"
400 handler.ip = function( )
403 handler.serverport = function( )
406 handler.clientport = function( )
409 local write = function( self, data )
410 bufferlen = bufferlen + string_len( data )
411 if bufferlen > maxsendlen then
412 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
413 handler.write = idfalse -- dont write anymore
415 elseif socket and not _sendlist[ socket ] then
416 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
418 bufferqueuelen = bufferqueuelen + 1
419 bufferqueue[ bufferqueuelen ] = data
421 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
425 handler.write = write
426 handler.bufferqueue = function( self )
429 handler.socket = function( self )
432 handler.pattern = function( self, new )
433 pattern = new or pattern
436 handler.set_send = function ( self, newsend )
437 send = newsend or send
440 handler.bufferlen = function( self, readlen, sendlen )
441 maxsendlen = sendlen or maxsendlen
442 maxreadlen = readlen or maxreadlen
443 return bufferlen, maxreadlen, maxsendlen
445 handler.lock_read = function (self, switch)
446 if switch == true then
447 local tmp = _readlistlen
448 _readlistlen = removesocket( _readlist, socket, _readlistlen )
449 _readtimes[ handler ] = nil
450 if _readlistlen ~= tmp then
453 elseif switch == false then
456 _readlistlen = addsocket(_readlist, socket, _readlistlen)
457 _readtimes[ handler ] = _currenttime
462 handler.lock = function( self, switch )
463 handler.lock_read (switch)
464 if switch == true then
465 handler.write = idfalse
466 local tmp = _sendlistlen
467 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
468 _writetimes[ handler ] = nil
469 if _sendlistlen ~= tmp then
472 elseif switch == false then
473 handler.write = write
479 return noread, nosend
481 local _readbuffer = function( ) -- this function reads data
482 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
483 if not err or (err == "wantread" or err == "timeout") or string_len(part) > 0 then -- received something
484 local buffer = buffer or part or ""
485 local len = string_len( buffer )
486 if len > maxreadlen then
487 disconnect( handler, "receive buffer exceeded" )
488 handler.close( true )
491 local count = len * STAT_UNIT
492 readtraffic = readtraffic + count
493 _readtraffic = _readtraffic + count
494 _readtimes[ handler ] = _currenttime
495 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
496 return dispatch( handler, buffer, err )
497 else -- connections was closed or fatal error
498 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
500 disconnect( handler, err )
501 _ = handler and handler.close( )
505 local _sendbuffer = function( ) -- this function sends data
506 local succ, err, byte, buffer, count;
509 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
510 succ, err, byte = send( socket, buffer, 1, bufferlen )
511 count = ( succ or byte or 0 ) * STAT_UNIT
512 sendtraffic = sendtraffic + count
513 _sendtraffic = _sendtraffic + count
514 _ = _cleanqueue and clean( bufferqueue )
515 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
517 succ, err, count = false, "closed", 0;
519 if succ then -- sending succesful
522 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
523 _ = needtls and handler:starttls(true)
524 _writetimes[ handler ] = nil
525 _ = toclose and handler.close( )
527 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
528 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
529 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
531 bufferlen = bufferlen - byte
532 _writetimes[ handler ] = _currenttime
534 else -- connection was closed during sending or fatal error
535 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
537 disconnect( handler, err )
538 _ = handler and handler.close( )
545 function handler.set_sslctx(self, new_sslctx)
550 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
552 for i = 1, _maxsslhandshake do
553 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
554 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
555 read, wrote = nil, nil
556 _, err = client:dohandshake( )
558 out_put( "server.lua: ssl handshake done" )
559 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
560 handler.sendbuffer = _sendbuffer
561 _ = status and status( handler, "ssl-handshake-complete" )
562 _readlistlen = addsocket(_readlist, client, _readlistlen)
565 out_put( "server.lua: error during ssl handshake: ", tostring(err) )
566 if err == "wantwrite" and not wrote then
567 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
569 elseif err == "wantread" and not read then
570 _readlistlen = addsocket(_readlist, client, _readlistlen)
575 --coroutine_yield( handler, nil, err ) -- handshake not finished
579 disconnect( handler, "ssl handshake failed" )
580 _ = handler and handler:close( true ) -- forced disconnect
581 return false -- handshake failed
585 if sslctx then -- ssl?
586 handler:set_sslctx(sslctx);
587 if startssl then -- ssl now?
588 --out_put("server.lua: ", "starting ssl handshake")
590 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
592 out_put( "server.lua: ssl error: ", tostring(err) )
594 return nil, nil, err -- fatal error
596 socket:settimeout( 0 )
597 handler.readbuffer = handshake
598 handler.sendbuffer = handshake
599 handshake( socket ) -- do handshake
601 return nil, nil, "ssl handshake failed";
604 -- We're not automatically doing SSL, so we're not secure (yet)
606 handler.starttls = function( self, now )
608 --out_put "server.lua: we need to do tls, but delaying until later"
612 --out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
613 local oldsocket, err = socket
614 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
615 --out_put( "server.lua: sslwrapped socket is " .. tostring( socket ) )
617 out_put( "server.lua: error while starting tls on client: ", tostring(err) )
618 return nil, err -- fatal error
621 socket:settimeout( 0 )
623 -- add the new socket to our system
626 receive = socket.receive
629 _socketlist[ socket ] = handler
630 _readlistlen = addsocket(_readlist, socket, _readlistlen)
632 -- remove traces of the old socket
634 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
635 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
636 _socketlist[ oldsocket ] = nil
638 handler.starttls = nil
644 handler.readbuffer = handshake
645 handler.sendbuffer = handshake
646 handshake( socket ) -- do handshake
648 handler.readbuffer = _readbuffer
649 handler.sendbuffer = _sendbuffer
651 else -- normal connection
653 handler.readbuffer = _readbuffer
654 handler.sendbuffer = _sendbuffer
658 receive = socket.receive
659 shutdown = ( ssl and id ) or socket.shutdown
661 _socketlist[ socket ] = handler
662 _readlistlen = addsocket(_readlist, socket, _readlistlen)
664 return handler, socket
670 idfalse = function( )
674 addsocket = function( list, socket, len )
675 if not list[ socket ] then
683 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
684 local pos = list[ socket ]
687 local last = list[ len ]
689 if last ~= socket then
698 closesocket = function( socket )
699 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
700 _readlistlen = removesocket( _readlist, socket, _readlistlen )
701 _socketlist[ socket ] = nil
706 ----------------------------------// PUBLIC //--
708 addserver = function( addr, port, listeners, pattern, sslctx, startssl ) -- this function provides a way for other scripts to reg a server
710 --out_put("server.lua: autossl on ", port, " is ", startssl)
711 if type( listeners ) ~= "table" then
712 err = "invalid listener table"
714 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
716 elseif _server[ port ] then
717 err = "listeners on port '" .. port .. "' already exist"
718 elseif sslctx and not luasec then
719 err = "luasec not found"
722 out_error( "server.lua, port ", port, ": ", err )
726 local server, err = socket_bind( addr, port )
728 out_error( "server.lua, port ", port, ": ", err )
731 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver, startssl ) -- wrap new server socket
736 server:settimeout( 0 )
737 _readlistlen = addsocket(_readlist, server, _readlistlen)
738 _server[ port ] = handler
739 _socketlist[ server ] = handler
740 out_put( "server.lua: new server listener on '", addr, ":", port, "'" )
744 getserver = function ( port )
745 return _server[ port ];
748 removeserver = function( port )
749 local handler = _server[ port ]
751 return nil, "no server found on port '" .. tostring( port ) .. "'"
754 _server[ port ] = nil
758 closeall = function( )
759 for _, handler in pairs( _socketlist ) do
761 _socketlist[ _ ] = nil
774 getsettings = function( )
775 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
778 changesettings = function( new )
779 if type( new ) ~= "table" then
780 return nil, "invalid settings table"
782 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
783 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
784 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
785 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
786 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
787 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
788 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
789 _cleanqueue = new.cleanqueue
790 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
791 _maxsslhandshake = new._maxsslhandshake or _maxsslhandshake
795 addtimer = function( listener )
796 if type( listener ) ~= "function" then
797 return nil, "invalid listener function"
799 _timerlistlen = _timerlistlen + 1
800 _timerlist[ _timerlistlen ] = listener
805 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
808 local dontstop = true; -- thinking about tomorrow, ...
810 setquitting = function (quit)
815 loop = function( ) -- this is the main loop of the program
817 local read, write, err = socket_select( _readlist, _sendlist, _selecttimeout )
818 for i, socket in ipairs( write ) do -- send data waiting in writequeues
819 local handler = _socketlist[ socket ]
821 handler.sendbuffer( )
823 closesocket( socket )
824 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
827 for i, socket in ipairs( read ) do -- receive data
828 local handler = _socketlist[ socket ]
830 handler.readbuffer( )
832 closesocket( socket )
833 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
836 for handler, err in pairs( _closelist ) do
837 handler.disconnect( )( handler, err )
838 handler:close( true ) -- forced disconnect
841 _currenttime = os_time( )
842 if os_difftime( _currenttime - _timer ) >= 1 then
843 for i = 1, _timerlistlen do
844 _timerlist[ i ]( _currenttime ) -- fire timers
846 _timer = _currenttime
848 socket_sleep( _sleeptime ) -- wait some time
854 local function get_backend()
858 --// EXPERIMENTAL //--
860 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx, startssl )
861 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx, startssl )
862 _socketlist[ socket ] = handler
863 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
864 return handler, socket
867 local addclient = function( address, port, listeners, pattern, sslctx, startssl )
868 local client, err = luasocket.tcp( )
872 client:settimeout( 0 )
873 _, err = client:connect( address, port )
874 if err then -- try again
875 local handler = wrapclient( client, address, port, listeners )
877 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx, startssl )
881 --// EXPERIMENTAL //--
883 ----------------------------------// BEGIN //--
885 use "setmetatable" ( _socketlist, { __mode = "k" } )
886 use "setmetatable" ( _readtimes, { __mode = "k" } )
887 use "setmetatable" ( _writetimes, { __mode = "k" } )
890 _starttime = os_time( )
892 addtimer( function( )
893 local difftime = os_difftime( _currenttime - _starttime )
894 if difftime > _checkinterval then
895 _starttime = _currenttime
896 for handler, timestamp in pairs( _writetimes ) do
897 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
898 --_writetimes[ handler ] = nil
899 handler.disconnect( )( handler, "send timeout" )
900 handler:close( true ) -- forced disconnect
903 for handler, timestamp in pairs( _readtimes ) do
904 if os_difftime( _currenttime - timestamp ) > _readtimeout then
905 --_readtimes[ handler ] = nil
906 handler.disconnect( )( handler, "read timeout" )
907 handler:close( ) -- forced disconnect?
914 local function setlogger(new_logger)
915 local old_logger = log;
922 ----------------------------------// PUBLIC INTERFACE //--
926 addclient = addclient,
927 wrapclient = wrapclient,
933 addserver = addserver,
934 getserver = getserver,
935 setlogger = setlogger,
936 getsettings = getsettings,
937 setquitting = setquitting,
938 removeserver = removeserver,
939 get_backend = get_backend,
940 changesettings = changesettings,