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.close = function( self, forced )
357 if not handler then return true; end
358 _readlistlen = removesocket( _readlist, socket, _readlistlen )
359 _readtimes[ handler ] = nil
360 if bufferqueuelen ~= 0 then
361 if not ( forced or fatalerror ) then
362 handler.sendbuffer( )
363 if bufferqueuelen ~= 0 then -- try again...
365 handler.write = nil -- ... but no further writing allowed
371 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
375 _ = shutdown and shutdown( socket )
377 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
378 _socketlist[ socket ] = nil
381 out_put "server.lua: socket already closed"
384 _writetimes[ handler ] = nil
385 _closelist[ handler ] = nil
391 out_put "server.lua: closed client handler and removed socket from list"
394 handler.ip = function( )
397 handler.serverport = function( )
400 handler.clientport = function( )
403 local write = function( self, data )
404 bufferlen = bufferlen + string_len( data )
405 if bufferlen > maxsendlen then
406 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
407 handler.write = idfalse -- dont write anymore
409 elseif socket and not _sendlist[ socket ] then
410 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
412 bufferqueuelen = bufferqueuelen + 1
413 bufferqueue[ bufferqueuelen ] = data
415 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
419 handler.write = write
420 handler.bufferqueue = function( self )
423 handler.socket = function( self )
426 handler.pattern = function( self, new )
427 pattern = new or pattern
430 handler.set_send = function ( self, newsend )
431 send = newsend or send
434 handler.bufferlen = function( self, readlen, sendlen )
435 maxsendlen = sendlen or maxsendlen
436 maxreadlen = readlen or maxreadlen
437 return bufferlen, maxreadlen, maxsendlen
439 handler.lock_read = function (self, switch)
440 if switch == true then
441 local tmp = _readlistlen
442 _readlistlen = removesocket( _readlist, socket, _readlistlen )
443 _readtimes[ handler ] = nil
444 if _readlistlen ~= tmp then
447 elseif switch == false then
450 _readlistlen = addsocket(_readlist, socket, _readlistlen)
451 _readtimes[ handler ] = _currenttime
456 handler.lock = function( self, switch )
457 handler.lock_read (switch)
458 if switch == true then
459 handler.write = idfalse
460 local tmp = _sendlistlen
461 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
462 _writetimes[ handler ] = nil
463 if _sendlistlen ~= tmp then
466 elseif switch == false then
467 handler.write = write
473 return noread, nosend
475 local _readbuffer = function( ) -- this function reads data
476 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
477 if not err or (err == "wantread" or err == "timeout") or string_len(part) > 0 then -- received something
478 local buffer = buffer or part or ""
479 local len = string_len( buffer )
480 if len > maxreadlen then
481 disconnect( handler, "receive buffer exceeded" )
482 handler.close( true )
485 local count = len * STAT_UNIT
486 readtraffic = readtraffic + count
487 _readtraffic = _readtraffic + count
488 _readtimes[ handler ] = _currenttime
489 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
490 return dispatch( handler, buffer, err )
491 else -- connections was closed or fatal error
492 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
494 disconnect( handler, err )
495 _ = handler and handler.close( )
499 local _sendbuffer = function( ) -- this function sends data
500 local succ, err, byte, buffer, count;
503 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
504 succ, err, byte = send( socket, buffer, 1, bufferlen )
505 count = ( succ or byte or 0 ) * STAT_UNIT
506 sendtraffic = sendtraffic + count
507 _sendtraffic = _sendtraffic + count
508 _ = _cleanqueue and clean( bufferqueue )
509 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
511 succ, err, count = false, "closed", 0;
513 if succ then -- sending succesful
516 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
517 _ = needtls and handler:starttls(true)
518 _writetimes[ handler ] = nil
519 _ = toclose and handler.close( )
521 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
522 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
523 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
525 bufferlen = bufferlen - byte
526 _writetimes[ handler ] = _currenttime
528 else -- connection was closed during sending or fatal error
529 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
531 disconnect( handler, err )
532 _ = handler and handler.close( )
539 function handler.set_sslctx(self, new_sslctx)
544 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
546 for i = 1, _maxsslhandshake do
547 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
548 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
549 read, wrote = nil, nil
550 _, err = client:dohandshake( )
552 out_put( "server.lua: ssl handshake done" )
553 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
554 handler.sendbuffer = _sendbuffer
555 _ = status and status( handler, "ssl-handshake-complete" )
556 _readlistlen = addsocket(_readlist, client, _readlistlen)
559 out_put( "server.lua: error during ssl handshake: ", tostring(err) )
560 if err == "wantwrite" and not wrote then
561 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
563 elseif err == "wantread" and not read then
564 _readlistlen = addsocket(_readlist, client, _readlistlen)
569 --coroutine_yield( handler, nil, err ) -- handshake not finished
573 disconnect( handler, "ssl handshake failed" )
574 _ = handler and handler:close( true ) -- forced disconnect
575 return false -- handshake failed
579 if sslctx then -- ssl?
580 handler:set_sslctx(sslctx);
581 if startssl then -- ssl now?
582 --out_put("server.lua: ", "starting ssl handshake")
584 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
586 out_put( "server.lua: ssl error: ", tostring(err) )
588 return nil, nil, err -- fatal error
590 socket:settimeout( 0 )
591 handler.readbuffer = handshake
592 handler.sendbuffer = handshake
593 handshake( socket ) -- do handshake
595 return nil, nil, "ssl handshake failed";
598 -- We're not automatically doing SSL, so we're not secure (yet)
600 handler.starttls = function( self, now )
602 --out_put "server.lua: we need to do tls, but delaying until later"
606 --out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
607 local oldsocket, err = socket
608 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
609 --out_put( "server.lua: sslwrapped socket is " .. tostring( socket ) )
611 out_put( "server.lua: error while starting tls on client: ", tostring(err) )
612 return nil, err -- fatal error
615 socket:settimeout( 0 )
617 -- add the new socket to our system
620 receive = socket.receive
623 _socketlist[ socket ] = handler
624 _readlistlen = addsocket(_readlist, socket, _readlistlen)
626 -- remove traces of the old socket
628 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
629 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
630 _socketlist[ oldsocket ] = nil
632 handler.starttls = nil
638 handler.readbuffer = handshake
639 handler.sendbuffer = handshake
640 handshake( socket ) -- do handshake
642 handler.readbuffer = _readbuffer
643 handler.sendbuffer = _sendbuffer
645 else -- normal connection
647 handler.readbuffer = _readbuffer
648 handler.sendbuffer = _sendbuffer
652 receive = socket.receive
653 shutdown = ( ssl and id ) or socket.shutdown
655 _socketlist[ socket ] = handler
656 _readlistlen = addsocket(_readlist, socket, _readlistlen)
658 return handler, socket
664 idfalse = function( )
668 addsocket = function( list, socket, len )
669 if not list[ socket ] then
677 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
678 local pos = list[ socket ]
681 local last = list[ len ]
683 if last ~= socket then
692 closesocket = function( socket )
693 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
694 _readlistlen = removesocket( _readlist, socket, _readlistlen )
695 _socketlist[ socket ] = nil
700 ----------------------------------// PUBLIC //--
702 addserver = function( addr, port, listeners, pattern, sslctx, startssl ) -- this function provides a way for other scripts to reg a server
704 --out_put("server.lua: autossl on ", port, " is ", startssl)
705 if type( listeners ) ~= "table" then
706 err = "invalid listener table"
708 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
710 elseif _server[ port ] then
711 err = "listeners on port '" .. port .. "' already exist"
712 elseif sslctx and not luasec then
713 err = "luasec not found"
716 out_error( "server.lua, port ", port, ": ", err )
720 local server, err = socket_bind( addr, port )
722 out_error( "server.lua, port ", port, ": ", err )
725 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver, startssl ) -- wrap new server socket
730 server:settimeout( 0 )
731 _readlistlen = addsocket(_readlist, server, _readlistlen)
732 _server[ port ] = handler
733 _socketlist[ server ] = handler
734 out_put( "server.lua: new server listener on '", addr, ":", port, "'" )
738 getserver = function ( port )
739 return _server[ port ];
742 removeserver = function( port )
743 local handler = _server[ port ]
745 return nil, "no server found on port '" .. tostring( port ) .. "'"
748 _server[ port ] = nil
752 closeall = function( )
753 for _, handler in pairs( _socketlist ) do
755 _socketlist[ _ ] = nil
768 getsettings = function( )
769 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
772 changesettings = function( new )
773 if type( new ) ~= "table" then
774 return nil, "invalid settings table"
776 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
777 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
778 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
779 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
780 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
781 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
782 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
783 _cleanqueue = new.cleanqueue
784 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
785 _maxsslhandshake = new._maxsslhandshake or _maxsslhandshake
789 addtimer = function( listener )
790 if type( listener ) ~= "function" then
791 return nil, "invalid listener function"
793 _timerlistlen = _timerlistlen + 1
794 _timerlist[ _timerlistlen ] = listener
799 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
802 local dontstop = true; -- thinking about tomorrow, ...
804 setquitting = function (quit)
809 loop = function( ) -- this is the main loop of the program
811 local read, write, err = socket_select( _readlist, _sendlist, _selecttimeout )
812 for i, socket in ipairs( write ) do -- send data waiting in writequeues
813 local handler = _socketlist[ socket ]
815 handler.sendbuffer( )
817 closesocket( socket )
818 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
821 for i, socket in ipairs( read ) do -- receive data
822 local handler = _socketlist[ socket ]
824 handler.readbuffer( )
826 closesocket( socket )
827 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
830 for handler, err in pairs( _closelist ) do
831 handler.disconnect( )( handler, err )
832 handler:close( true ) -- forced disconnect
835 _currenttime = os_time( )
836 if os_difftime( _currenttime - _timer ) >= 1 then
837 for i = 1, _timerlistlen do
838 _timerlist[ i ]( _currenttime ) -- fire timers
840 _timer = _currenttime
842 socket_sleep( _sleeptime ) -- wait some time
848 local function get_backend()
852 --// EXPERIMENTAL //--
854 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx, startssl )
855 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx, startssl )
856 _socketlist[ socket ] = handler
857 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
858 return handler, socket
861 local addclient = function( address, port, listeners, pattern, sslctx, startssl )
862 local client, err = luasocket.tcp( )
866 client:settimeout( 0 )
867 _, err = client:connect( address, port )
868 if err then -- try again
869 local handler = wrapclient( client, address, port, listeners )
871 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx, startssl )
875 --// EXPERIMENTAL //--
877 ----------------------------------// BEGIN //--
879 use "setmetatable" ( _socketlist, { __mode = "k" } )
880 use "setmetatable" ( _readtimes, { __mode = "k" } )
881 use "setmetatable" ( _writetimes, { __mode = "k" } )
884 _starttime = os_time( )
886 addtimer( function( )
887 local difftime = os_difftime( _currenttime - _starttime )
888 if difftime > _checkinterval then
889 _starttime = _currenttime
890 for handler, timestamp in pairs( _writetimes ) do
891 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
892 --_writetimes[ handler ] = nil
893 handler.disconnect( )( handler, "send timeout" )
894 handler:close( true ) -- forced disconnect
897 for handler, timestamp in pairs( _readtimes ) do
898 if os_difftime( _currenttime - timestamp ) > _readtimeout then
899 --_readtimes[ handler ] = nil
900 handler.disconnect( )( handler, "read timeout" )
901 handler:close( ) -- forced disconnect?
908 local function setlogger(new_logger)
909 local old_logger = log;
916 ----------------------------------// PUBLIC INTERFACE //--
920 addclient = addclient,
921 wrapclient = wrapclient,
927 addserver = addserver,
928 getserver = getserver,
929 setlogger = setlogger,
930 getsettings = getsettings,
931 setquitting = setquitting,
932 removeserver = removeserver,
933 get_backend = get_backend,
934 changesettings = changesettings,