1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
--
-- gcsd
--
-- gcsd the generic command sequencer daemon can be used to serialize
-- commands sent over various paralell communication channels to a
-- single command output. It can be seen as a multiplexer for any
-- kind of communication between a single resource and various clients
-- which want to submit commands to it or query information from it.
-- gcsd is written in C and Lua. The goal is to provide an easy to
-- understand high level API based on Lua which can be used to
-- implement the business logic of the so formed multiplexer daemon.
--
--
-- Copyright (C) 2009-2010 Markus Grueneis <gimpf@spreadspace.org>
-- Christian Pointner <equinox@spreadspace.org>
--
-- This file is part of gcsd.
--
-- gcsd is free software: you can redistribute it and/or modify
-- it under the terms of the GNU General Public License as published by
-- the Free Software Foundation, either version 3 of the License, or
-- any later version.
--
-- gcsd is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU General Public License for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with gcsd. If not, see <http://www.gnu.org/licenses/>.
--
local socket = require("socket")
local defines = require("defines")
local debug_shell = {}
debug_shell.properties = { input=true, output=true, max_instances=1, module_type_name="debug_shell" }
debug_shell.next_id = 0
function debug_shell:new(config)
local inst = {}
if(config.name == nil or config.name == "") then
inst.name = self.properties.module_type_name .. self.next_id
self.next_id = self.next_id + 1
else
inst.name = config.name
end
local ip, err = socket.dns.toip(config.host)
if(ip == nil) then
log.printf(log.ERROR, inst.name .. ": can't resolve %s: %s", config.host, err)
return nil
end
local server_sock_raw, err = socket.tcp()
if(server_sock_raw == nil) then
log.printf(log.ERROR, inst.name .. ": can't create tcp socket")
return nil
end
server_sock_raw:setoption('reuseaddr', true);
local ret, err = server_sock_raw:bind(ip, config.port)
if(ret == nil) then
log.printf(log.ERROR, inst.name .. ": bind(%s,%s) failed: %s", ip, config.port, err)
return nil
end
local ret, err = server_sock_raw:listen()
if(ret == nil) then
log.printf(log.ERROR, inst.name .. ": listen() failed: %s", err)
return nil
end
server_sock_raw:settimeout(0)
local server_sock = {}
server_sock.sock = server_sock_raw
function server_sock:getfd() return self.sock:getfd() end
function server_sock:dirty() return self.sock:dirty() end
function server_sock:read()
local client_sock_raw, err = self.sock:accept()
if(client_sock_raw == nil) then
log.printf(log.ERROR, inst.name .. ": accept() failed: %s", err)
end
local ip, port = client_sock_raw:getpeername();
log.printf(log.INFO, inst.name .. ": connection from %s:%s accepted", ip, port)
client_sock_raw:settimeout(0);
client_sock_raw:setoption('tcp-nodelay', true);
local client_sock = {}
client_sock.sock = client_sock_raw
function client_sock:getfd() return self.sock:getfd() end
function client_sock:dirty() return self.sock:dirty() end
client_sock.client_instance = nil
client_sock.in_buffer = ""
client_sock.out_buffer = ""
function client_sock:read()
local ret = 0
local data, err, partial = self.sock:receive('*l')
if(data == nil) then
if(err == 'closed') then
log.printf(log.INFO, inst.name .. ": connection closed by peer")
ret = defines.KILL_CLIENT
elseif(err == 'timeout') then
self.in_buffer = self.in_buffer .. partial
else
log.printf(log.INFO, inst.name .. ": connection error: %s", err)
ret = defines.KILL_CLIENT
end
else
self.in_buffer = self.in_buffer .. data
ret = debug_shell:exec_cmd(self)
if(ret == 1) then
ret = defines.KILL_CLIENT
end
self.in_buffer = ""
end
return ret
end
function client_sock:write()
self.sock:send(self.out_buffer)
self.out_buffer = ""
return defines.OK
end
local client = {}
client.module_instance = inst
client.name = inst.name .. "#" .. ip .. ":" .. port
client.sock = client_sock
function client:process_response(response)
self.sock.out_buffer = self.sock.out_buffer .. response
end
function client:process_timeout() end
function client:get_read_handles()
return { self.sock }
end
function client:get_write_handles()
if(self.sock.out_buffer ~= "") then
return { self.sock }
else
return {}
end
end
function client:cleanup()
self.sock.sock:close()
end
client_sock.client_instance = client
client_list:register(client)
return defines.OK
end
function server_sock:write() return defines.OK end
log.printf(log.WARNING, inst.name .. ": listening on %s:%s (this is a huge security risk)", ip, config.port);
function inst:cleanup()
log.printf(log.INFO, inst.name .. ": cleanup called");
client_list:unregister_by_module(self)
server_sock.sock:close()
end
function inst:get_read_handles()
return { server_sock }
end
function inst:get_write_handles()
return {}
end
setmetatable(inst, {})
getmetatable(inst).__gc = function() inst:cleanup() end
return inst
end
function debug_shell:exec_cmd(socket)
log.printf(log.DEBUG, "debug shell: received string: '%s'", socket.in_buffer)
local ret = defines.OK
local luacode = string.match(socket.in_buffer, "^!(.*)$");
if(luacode and luacode ~= "") then
local chunk = loadstring(luacode)
if(chunk) then
log.printf(log.DEBUG, "debug shell: calling lua command: '%s'", luacode)
local results = { pcall(chunk) }
if(results[1]) then
for i,result in ipairs(results) do
if(i > 1) then
socket.out_buffer = socket.out_buffer .. string.format("#%d: %s\n", i-1, tostring(result))
end
end
else
socket.out_buffer = socket.out_buffer .. string.format("lua call failed: %s\n", tostring(results[2]))
end
else
socket.out_buffer = socket.out_buffer .. "syntax error\n"
end
else
local cmd, sep, param = string.match(socket.in_buffer, "^(%w+)(.?)(.*)$");
if(cmd == 'quit') then
if(sep and sep ~= "") then socket.out_buffer = socket.out_buffer .. "unknown command\n" end
log.printf(log.INFO, "debug shell: quitting debug session")
ret = defines.KILL_CLIENT
elseif(cmd == 'disable') then
if(sep and sep ~= "") then socket.out_buffer = socket.out_buffer .. "unknown command\n" end
log.printf(log.NOTICE, "debug shell: disabling debug shell and close all connections")
ret = defines.KILL_MODULE
elseif(cmd == 'terminate') then
if(sep and sep ~= "") then socket.out_buffer = socket.out_buffer .. "unknown command\n" end
log.printf(log.NOTICE, "debug shell: terminate command received")
ret = defines.KILL_DAEMON
elseif(cmd == 'help') then
if(sep and sep ~= "") then socket.out_buffer = socket.out_buffer .. "unknown command\n" end
socket.out_buffer = socket.out_buffer .. "!<lua code> execute lua code\n" ..
"quit quit this debug session\n" ..
"ping[ <data>] echo request (response will be 'pong[ <data>]')\n" ..
"terminate terminate the daemon\n"
elseif(cmd == 'ping') then
if(sep == ' ') then socket.out_buffer = socket.out_buffer .. "pong " .. (param or "") .. "\n"
else socket.out_buffer = socket.out_buffer .. "pong\n" end
else
socket.out_buffer = socket.out_buffer .. "unknown command\n"
end
end
return ret
end
return debug_shell
|