blob: cecd09f75084b755581f2c00cec58020e128fd45 [file] [log] [blame]
Ed Tanousc81ca422017-03-21 16:18:49 -07001namespace crow {
2namespace kvm {
3static const std::string rfb_3_3_version_string = "RFB 003.003\n";
4static const std::string rfb_3_7_version_string = "RFB 003.007\n";
5static const std::string rfb_3_8_version_string = "RFB 003.008\n";
6
7enum class RfbAuthScheme : uint8_t {
8 connection_failed = 0,
9 no_authentication = 1,
10 vnc_authentication = 2
11};
12
13struct pixel_format_struct {
14 boost::endian::big_uint8_t bits_per_pixel;
15 boost::endian::big_uint8_t depth;
16 boost::endian::big_uint8_t is_big_endian;
17 boost::endian::big_uint8_t is_true_color;
18 boost::endian::big_uint16_t red_max;
19 boost::endian::big_uint16_t green_max;
20 boost::endian::big_uint16_t blue_max;
21 boost::endian::big_uint8_t red_shift;
22 boost::endian::big_uint8_t green_shift;
23 boost::endian::big_uint8_t blue_shift;
24 boost::endian::big_uint8_t pad1;
25 boost::endian::big_uint8_t pad2;
26 boost::endian::big_uint8_t pad3;
27};
28
29struct server_initialization_message {
30 boost::endian::big_uint16_t framebuffer_width;
31 boost::endian::big_uint16_t framebuffer_height;
32 pixel_format_struct pixel_format;
33 boost::endian::big_uint32_t name_length;
34};
35
36enum class client_to_server_message_type : uint8_t {
37 set_pixel_format = 0,
38 fix_color_map_entries = 1,
39 set_encodings = 2,
40 framebuffer_update_request = 3,
41 key_event = 4,
42 pointer_event = 5,
43 client_cut_text = 6
44};
45
46struct set_pixel_format_message {
47 boost::endian::big_uint8_t pad1;
48 boost::endian::big_uint8_t pad2;
49 boost::endian::big_uint8_t pad3;
50 pixel_format_struct pixel_format;
51};
52
53struct frame_buffer_update_request_message {
54 boost::endian::big_uint8_t incremental;
55 boost::endian::big_uint16_t x_position;
56 boost::endian::big_uint16_t y_position;
57 boost::endian::big_uint16_t width;
58 boost::endian::big_uint16_t height;
59};
60
61struct key_event_message {
62 boost::endian::big_uint8_t down_flag;
63 boost::endian::big_uint8_t pad1;
64 boost::endian::big_uint8_t pad2;
65 boost::endian::big_uint32_t key;
66};
67
68struct pointer_event_message {
69 boost::endian::big_uint8_t button_mask;
70 boost::endian::big_uint16_t x_position;
71 boost::endian::big_uint16_t y_position;
72};
73
74struct client_cut_text_message {
75 std::vector<uint8_t> data;
76};
77
78enum class encoding_type : uint32_t {
79 raw = 0x00,
80 copy_rectangle = 0x01,
81 rising_rectangle = 0x02,
82 corre = 0x04,
83 hextile = 0x05,
84 zlib = 0x06,
85 tight = 0x07,
86 zlibhex = 0x08,
87 ultra = 0x09,
88 zrle = 0x10,
89 zywrle = 0x011,
90 cache_enable = 0xFFFF0001,
91 xor_enable = 0xFFFF0006,
92 server_state_ultranvc = 0xFFFF8000,
93 enable_keep_alive = 0xFFFF8001,
94 enableftp_protocol_version = 0xFFFF8002,
95 tight_compress_level_0 = 0xFFFFFF00,
96 tight_compress_level_9 = 0xFFFFFF09,
97 x_cursor = 0xFFFFFF10,
98 rich_cursor = 0xFFFFFF11,
99 pointer_pos = 0xFFFFFF18,
100 last_rect = 0xFFFFFF20,
101 new_framebuffer_size = 0xFFFFFF21,
102 tight_quality_level_0 = 0xFFFFFFE0,
103 tight_quality_level_9 = 0xFFFFFFE9
104};
105
106struct framebuffer_rectangle {
107 boost::endian::big_uint16_t x;
108 boost::endian::big_uint16_t y;
109 boost::endian::big_uint16_t width;
110 boost::endian::big_uint16_t height;
111 boost::endian::big_uint32_t encoding;
112 std::vector<uint8_t> data;
113};
114
115struct framebuffer_update_message {
116 boost::endian::big_uint8_t message_type;
117 std::vector<framebuffer_rectangle> rectangles;
118};
119
120std::string serialize(const framebuffer_update_message& msg) {
121 // calculate the size of the needed vector for serialization
122 size_t vector_size = 4;
123 for (const auto& rect : msg.rectangles) {
124 vector_size += 12 + rect.data.size();
125 }
126
127 std::string serialized(vector_size, 0);
128
129 size_t i = 0;
130 serialized[i++] = 0; // Type
131 serialized[i++] = 0; // Pad byte
132 boost::endian::big_uint16_t number_of_rectangles = msg.rectangles.size();
133 std::memcpy(&serialized[i], &number_of_rectangles,
134 sizeof(number_of_rectangles));
135 i += sizeof(number_of_rectangles);
136
137 for (const auto& rect : msg.rectangles) {
138 // copy the first part of the struct
139 size_t buffer_size =
140 sizeof(framebuffer_rectangle) - sizeof(std::vector<uint8_t>);
141 std::memcpy(&serialized[i], &rect, buffer_size);
142 i += buffer_size;
143
144 std::memcpy(&serialized[i], rect.data.data(), rect.data.size());
145 i += rect.data.size();
146 }
147
148 return serialized;
149}
150
151enum class VncState {
152 UNSTARTED,
153 AWAITING_CLIENT_VERSION,
154 AWAITING_CLIENT_AUTH_METHOD,
155 AWAITING_CLIENT_INIT_MESSAGE,
156 MAIN_LOOP
157};
158
159class connection_metadata {
160 public:
161 connection_metadata(void) : vnc_state(VncState::AWAITING_CLIENT_VERSION){};
162
163 VncState vnc_state;
164};
165
166typedef std::vector<connection_metadata> meta_list;
167meta_list connection_states(10);
168
169connection_metadata meta;
170
171void request_routes(BmcAppType& app) {
172 CROW_ROUTE(app, "/kvmws")
173 .websocket()
174 .onopen([&](crow::websocket::connection& conn) {
175 meta.vnc_state = VncState::AWAITING_CLIENT_VERSION;
176 conn.send_binary(rfb_3_8_version_string);
177 })
178 .onclose(
179 [&](crow::websocket::connection& conn, const std::string& reason) {
180 meta.vnc_state = VncState::UNSTARTED;
181 })
182 .onmessage([&](crow::websocket::connection& conn, const std::string& data,
183 bool is_binary) {
184 switch (meta.vnc_state) {
185 case VncState::AWAITING_CLIENT_VERSION: {
186 LOG(DEBUG) << "Client sent: " << data;
187 if (data == rfb_3_8_version_string ||
188 data == rfb_3_7_version_string) {
189 std::string auth_types{1,
190 (uint8_t)RfbAuthScheme::no_authentication};
191 conn.send_binary(auth_types);
192 meta.vnc_state = VncState::AWAITING_CLIENT_AUTH_METHOD;
193 } else if (data == rfb_3_3_version_string) {
194 // TODO(ed) Support older protocols
195 meta.vnc_state = VncState::UNSTARTED;
196 conn.close();
197 } else {
198 // TODO(ed) Support older protocols
199 meta.vnc_state = VncState::UNSTARTED;
200 conn.close();
201 }
202 } break;
203 case VncState::AWAITING_CLIENT_AUTH_METHOD: {
204 std::string security_result{{0, 0, 0, 0}};
205 if (data[0] == (uint8_t)RfbAuthScheme::no_authentication) {
206 meta.vnc_state = VncState::AWAITING_CLIENT_INIT_MESSAGE;
207 } else {
208 // Mark auth as failed
209 security_result[3] = 1;
210 meta.vnc_state = VncState::UNSTARTED;
211 }
212 conn.send_binary(security_result);
213 } break;
214 case VncState::AWAITING_CLIENT_INIT_MESSAGE: {
215 // Now send the server initialization
216 server_initialization_message server_init_msg;
217 server_init_msg.framebuffer_width = 640;
218 server_init_msg.framebuffer_height = 480;
219 server_init_msg.pixel_format.bits_per_pixel = 32;
220 server_init_msg.pixel_format.is_big_endian = 0;
221 server_init_msg.pixel_format.is_true_color = 1;
222 server_init_msg.pixel_format.red_max = 255;
223 server_init_msg.pixel_format.green_max = 255;
224 server_init_msg.pixel_format.blue_max = 255;
225 server_init_msg.pixel_format.red_shift = 16;
226 server_init_msg.pixel_format.green_shift = 8;
227 server_init_msg.pixel_format.blue_shift = 0;
228 server_init_msg.name_length = 0;
229 LOG(DEBUG) << "size: " << sizeof(server_init_msg);
230 // TODO(ed) this is ugly. Crow should really have a span type
231 // interface
232 // to avoid the copy, but alas, today it does not.
233 std::string s(reinterpret_cast<char*>(&server_init_msg),
234 sizeof(server_init_msg));
235 LOG(DEBUG) << "s.size() " << s.size();
236 conn.send_binary(s);
237 meta.vnc_state = VncState::MAIN_LOOP;
238 } break;
239 case VncState::MAIN_LOOP: {
240 if (data.size() >= sizeof(client_to_server_message_type)) {
241 auto type = static_cast<client_to_server_message_type>(data[0]);
242 LOG(DEBUG) << "Got type " << (uint32_t)type << "\n";
243 switch (type) {
244 case client_to_server_message_type::set_pixel_format: {
245 } break;
246
247 case client_to_server_message_type::fix_color_map_entries: {
248 } break;
249 case client_to_server_message_type::set_encodings: {
250 } break;
251 case client_to_server_message_type::
252 framebuffer_update_request: {
253 // Make sure the buffer is long enough to handle what we're
254 // about to do
255 if (data.size() >=
256 sizeof(frame_buffer_update_request_message) +
257 sizeof(client_to_server_message_type)) {
258 auto msg = reinterpret_cast<
259 const frame_buffer_update_request_message*>(
260 data.data() + sizeof(client_to_server_message_type));
261
262 if (!msg->incremental) {
263 framebuffer_update_message buffer_update_message;
264
265 // If the viewer is requesting a full update, force write
266 // of all pixels
267
268 framebuffer_rectangle this_rect;
269 this_rect.x = msg->x_position;
270 this_rect.y = msg->y_position;
271 this_rect.width = msg->width;
272 this_rect.height = msg->height;
273 this_rect.encoding =
274 static_cast<uint8_t>(encoding_type::raw);
275 LOG(DEBUG) << "Encoding is" << this_rect.encoding;
276 this_rect.data.reserve(this_rect.width *
277 this_rect.height * 4);
278
279 for (unsigned int x_index = 0; x_index < this_rect.width;
280 x_index++) {
281 for (unsigned int y_index = 0;
282 y_index < this_rect.height; y_index++) {
283 this_rect.data.push_back(
284 static_cast<uint8_t>(0)); // Blue
285 this_rect.data.push_back(
286 static_cast<uint8_t>(0)); // Green
287 this_rect.data.push_back(static_cast<uint8_t>(
288 x_index * 0xFF / msg->width)); // RED
289 this_rect.data.push_back(
290 static_cast<uint8_t>(0)); // UNUSED
291 }
292 }
293
294 buffer_update_message.rectangles.push_back(
295 std::move(this_rect));
296 auto serialized = serialize(buffer_update_message);
297
298 conn.send_binary(serialized);
299 }
300 }
301
302 }
303
304 break;
305
306 case client_to_server_message_type::key_event: {
307 } break;
308
309 case client_to_server_message_type::pointer_event: {
310 } break;
311
312 case client_to_server_message_type::client_cut_text: {
313 } break;
314
315 default:
316 break;
317 }
318 }
319
320 } break;
321 case VncState::UNSTARTED:
322 // Error? TODO
323 break;
324 }
325
326 });
327}
328}
329}