Merge "add data encryption feature" into tizen
[sdk/target/sdbd.git] / src / sdb.h
1 /*
2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __SDB_H
18 #define __SDB_H
19
20 #include <limits.h>
21 #include <stdlib.h>
22 #include <stddef.h>
23
24 #include "transport.h"  /* readx(), writex() */
25 #include "fdevent.h"
26 #include "sdbd_plugin.h"
27 #if !SDB_HOST
28 #include "commandline_sdbd.h"
29 #endif
30 #include <tzplatform_config.h>
31
32 #define MAX_PAYLOAD 4096
33
34 #define A_SYNC 0x434e5953
35 #define A_CNXN 0x4e584e43
36 #define A_OPEN 0x4e45504f
37 #define A_OKAY 0x59414b4f
38 #define A_CLSE 0x45534c43
39 #define A_WRTE 0x45545257
40 #define A_STAT 0x54415453
41 #define A_ENCR 0x40682018 // encryption 메시지
42
43 #ifdef SUPPORT_ENCRYPT
44  #define ENCR_SET_ON_REQ 0 // encryption hello 메시지
45  #define ENCR_SET_ON_OK 1 // encryption ack 메시지
46  #define ENCR_SET_OFF 2 // encryption mode off 메시지
47  #define ENCR_GET 3 // encryption status get 메시지
48  #define ENCR_ON_FAIL 4 // encryption on 실패 메시지
49  #define ENCR_OFF_FAIL 5 // encryption off 실패 메시지
50  #define ENCR_ON 1 // encryption on 상태
51  #define ENCR_OFF 0 // encryption off 상태
52 #endif
53
54 #define A_VERSION 0x02000000        // SDB protocol version
55
56 #define SDB_VERSION_MAJOR 2         // Used for help/version information
57 #define SDB_VERSION_MINOR 2         // Used for help/version information
58 #define SDB_VERSION_PATCH 31        // Used for help/version information
59
60 #define SDB_SERVER_VERSION 0        // Increment this when we want to force users to start a new sdb server
61
62 typedef struct amessage amessage;
63 typedef struct apacket apacket;
64 typedef struct asocket asocket;
65 typedef struct alistener alistener;
66 typedef struct aservice aservice;
67 typedef struct atransport atransport;
68 typedef struct adisconnect  adisconnect;
69 typedef struct usb_handle usb_handle;
70
71 struct amessage {
72     unsigned command;       /* command identifier constant      */
73     unsigned arg0;          /* first argument                   */
74     unsigned arg1;          /* second argument                  */
75     unsigned data_length;   /* length of payload (0 is allowed) */
76     unsigned data_check;    /* checksum of data payload         */
77     unsigned magic;         /* command ^ 0xffffffff             */
78 };
79
80 struct apacket
81 {
82     apacket *next;
83
84     unsigned len;
85     unsigned char *ptr;
86
87     amessage msg;
88     unsigned char data[MAX_PAYLOAD];
89 };
90
91 /* An asocket represents one half of a connection between a local and
92 ** remote entity.  A local asocket is bound to a file descriptor.  A
93 ** remote asocket is bound to the protocol engine.
94 */
95 struct asocket {
96         /* chain pointers for the local/remote list of
97         ** asockets that this asocket lives in
98         */
99     asocket *next;
100     asocket *prev;
101
102         /* the unique identifier for this asocket
103         */
104     unsigned id;
105
106         /* flag: set when the socket's peer has closed
107         ** but packets are still queued for delivery
108         */
109     int    closing;
110
111         /* the asocket we are connected to
112         */
113
114     asocket *peer;
115
116         /* For local asockets, the fde is used to bind
117         ** us to our fd event system.  For remote asockets
118         ** these fields are not used.
119         */
120     fdevent fde;
121     int fd;
122
123         /* queue of apackets waiting to be written
124         */
125     apacket *pkt_first;
126     apacket *pkt_last;
127
128         /* enqueue is called by our peer when it has data
129         ** for us.  It should return 0 if we can accept more
130         ** data or 1 if not.  If we return 1, we must call
131         ** peer->ready() when we once again are ready to
132         ** receive data.
133         */
134     int (*enqueue)(asocket *s, apacket *pkt);
135
136         /* ready is called by the peer when it is ready for
137         ** us to send data via enqueue again
138         */
139     void (*ready)(asocket *s);
140
141         /* close is called by the peer when it has gone away.
142         ** we are not allowed to make any further calls on the
143         ** peer once our close method is called.
144         */
145     void (*close)(asocket *s);
146
147         /* socket-type-specific extradata */
148     void *extra;
149
150         /* A socket is bound to atransport */
151     atransport *transport;
152 };
153
154
155 /* the adisconnect structure is used to record a callback that
156 ** will be called whenever a transport is disconnected (e.g. by the user)
157 ** this should be used to cleanup objects that depend on the
158 ** transport (e.g. remote sockets, listeners, etc...)
159 */
160 struct  adisconnect
161 {
162     void        (*func)(void*  opaque, atransport*  t);
163     void*         opaque;
164     adisconnect*  next;
165     adisconnect*  prev;
166 };
167
168
169 /* a transport object models the connection to a remote device or emulator
170 ** there is one transport per connected device/emulator. a "local transport"
171 ** connects through TCP (for the emulator), while a "usb transport" through
172 ** USB (for real devices)
173 **
174 ** note that kTransportHost doesn't really correspond to a real transport
175 ** object, it's a special value used to indicate that a client wants to
176 ** connect to a service implemented within the SDB server itself.
177 */
178 typedef enum transport_type {
179         kTransportUsb,
180         kTransportLocal,
181         kTransportAny,
182         kTransportHost,
183 } transport_type;
184
185 struct atransport
186 {
187     atransport *next;
188     atransport *prev;
189
190     int (*read_from_remote)(apacket *p, atransport *t);
191     int (*write_to_remote)(apacket *p, atransport *t);
192     void (*close)(atransport *t);
193     void (*kick)(atransport *t);
194
195     int fd;
196     int transport_socket;
197     fdevent transport_fde;
198     int ref_count;
199     unsigned sync_token;
200     int connection_state;
201     transport_type type;
202
203         /* usb handle or socket fd as needed */
204     usb_handle *usb;
205     int sfd;
206
207         /* used to identify transports for clients */
208     char *serial;
209     char *product;
210     int sdb_port; // Use for emulators (local transport)
211     char *device_name; // for connection explorer
212
213         /* a list of adisconnect callbacks called when the transport is kicked */
214     int          kicked;
215     adisconnect  disconnects;
216
217 #ifdef SUPPORT_ENCRYPT
218         unsigned encryption; // 해당 연결이 암호화 모드인지 확인하는 flag , 0 = no-encryption / 1 = encryption
219         int sessionID; // 암호화 세션 ID, 암호화 map에 대한 key
220 #endif
221 };
222
223
224 /* A listener is an entity which binds to a local port
225 ** and, upon receiving a connection on that port, creates
226 ** an asocket to connect the new local connection to a
227 ** specific remote service.
228 **
229 ** TODO: some listeners read from the new connection to
230 ** determine what exact service to connect to on the far
231 ** side.
232 */
233 struct alistener
234 {
235     alistener *next;
236     alistener *prev;
237
238     fdevent fde;
239     int fd;
240
241     const char *local_name;
242     const char *connect_to;
243     atransport *transport;
244     adisconnect  disconnect;
245 };
246
247 #define UNKNOWN "unknown"
248 #define INFOBUF_MAXLEN 64
249 #define INFO_VERSION "2.2.0"
250 typedef struct platform_info {
251     char platform_info_version[INFOBUF_MAXLEN];
252     char model_name[INFOBUF_MAXLEN]; // Emulator
253     char platform_name[INFOBUF_MAXLEN]; // Tizen
254     char platform_version[INFOBUF_MAXLEN]; // 2.2.1
255     char profile_name[INFOBUF_MAXLEN]; // 2.2.1
256 } pinfo;
257
258 #define ENABLED "enabled"
259 #define DISABLED "disabled"
260 #define CAPBUF_SIZE 4096
261 #define CAPBUF_ITEMSIZE 32
262 #define CAPBUF_L_ITEMSIZE 256
263 #define CAPBUF_LL_ITEMSIZE PATH_MAX
264 #define SDBD_CAP_VERSION_MAJOR 1
265 #define SDBD_CAP_VERSION_MINOR 0
266 typedef struct platform_capabilities
267 {
268     char secure_protocol[CAPBUF_ITEMSIZE];      // enabled or disabled
269     char intershell_support[CAPBUF_ITEMSIZE];   // enabled or disabled
270     char filesync_support[CAPBUF_ITEMSIZE];     // push or pull or pushpull or disabled
271     char rootonoff_support[CAPBUF_ITEMSIZE];    // enabled or disabled
272     char zone_support[CAPBUF_ITEMSIZE];         // enabled or disabled
273     char multiuser_support[CAPBUF_ITEMSIZE];    // enabled or disabled
274     char syncwinsz_support[CAPBUF_ITEMSIZE];    // enabled or disabled
275     char usbproto_support[CAPBUF_ITEMSIZE];     // enabled or disabled
276     char sockproto_support[CAPBUF_ITEMSIZE];    // enabled or disabled
277     char encryption_support[CAPBUF_ITEMSIZE];   // enabled or disabled
278
279     char log_enable[CAPBUF_ITEMSIZE];    // enabled or disabled
280     char log_path[CAPBUF_LL_ITEMSIZE];    // path of sdbd log
281
282     char cpu_arch[CAPBUF_ITEMSIZE];             // cpu architecture (ex. x86)
283     char profile_name[CAPBUF_ITEMSIZE];         // profile name (ex. mobile)
284     char vendor_name[CAPBUF_ITEMSIZE];          // vendor name (ex. Tizen)
285     char sdk_toolpath[CAPBUF_L_ITEMSIZE];       // sdk tool path
286     char can_launch[CAPBUF_L_ITEMSIZE];         // target name
287
288     char platform_version[CAPBUF_ITEMSIZE];     // platform version (ex. 2.3.0)
289     char product_version[CAPBUF_ITEMSIZE];      // product version (ex. 1.0)
290     char sdbd_version[CAPBUF_ITEMSIZE];         // sdbd version
291     char sdbd_plugin_version[CAPBUF_ITEMSIZE];  // sdbd plugin version
292     char sdbd_cap_version[CAPBUF_ITEMSIZE];     // capability version
293 } pcap;
294 extern pcap g_capabilities;
295
296 #define SDBD_PLUGIN_PATH    "/usr/lib/libsdbd_plugin.so"
297 #define SDBD_PLUGIN_INTF    "sdbd_plugin_cmd_proc"
298 typedef int (*SDBD_PLUGIN_CMD_PROC_PTR)(const char*, const char*, sdbd_plugin_param);
299 extern SDBD_PLUGIN_CMD_PROC_PTR sdbd_plugin_cmd_proc;
300 int request_plugin_cmd(const char* cmd, const char* in_buf, char *out_buf, unsigned int out_len);
301 int request_plugin_verification(const char* cmd, const char* in_buf);
302
303 void print_packet(const char *label, apacket *p);
304
305 asocket *find_local_socket(unsigned id);
306 void install_local_socket(asocket *s);
307 void remove_socket(asocket *s);
308 void close_all_sockets(atransport *t);
309
310 #define  LOCAL_CLIENT_PREFIX  "emulator-"
311
312 asocket *create_local_socket(int fd);
313 asocket *create_local_service_socket(const char *destination);
314
315 asocket *create_remote_socket(unsigned id, atransport *t);
316 void connect_to_remote(asocket *s, const char *destination);
317 void connect_to_smartsocket(asocket *s);
318
319 void fatal(const char *fmt, ...);
320 void fatal_errno(const char *fmt, ...);
321
322 void handle_packet(apacket *p, atransport *t);
323 void send_packet(apacket *p, atransport *t);
324
325 void get_my_path(char *s, size_t maxLen);
326 int launch_server(int server_port);
327 int sdb_main(int is_daemon, int server_port);
328
329
330 /* transports are ref-counted
331 ** get_device_transport does an acquire on your behalf before returning
332 */
333 void init_transport_registration(void);
334 int  list_transports(char *buf, size_t  bufsize);
335 void update_transports(void);
336 void broadcast_transport(apacket *p);
337 int get_connected_count(transport_type type);
338
339 asocket*  create_device_tracker(void);
340
341 /* Obtain a transport from the available transports.
342 ** If state is != CS_ANY, only transports in that state are considered.
343 ** If serial is non-NULL then only the device with that serial will be chosen.
344 ** If no suitable transport is found, error is set.
345 */
346 atransport *acquire_one_transport(int state, transport_type ttype, const char* serial, char **error_out);
347 void   add_transport_disconnect( atransport*  t, adisconnect*  dis );
348 void   remove_transport_disconnect( atransport*  t, adisconnect*  dis );
349 void   run_transport_disconnects( atransport*  t );
350 void   kick_transport( atransport*  t );
351
352 /* initialize a transport object's func pointers and state */
353 #if SDB_HOST
354 int get_available_local_transport_index();
355 #endif
356 int  init_socket_transport(atransport *t, int s, int port, int local);
357 void init_usb_transport(atransport *t, usb_handle *usb, int state);
358
359 /* for MacOS X cleanup */
360 void close_usb_devices();
361
362 /* cause new transports to be init'd and added to the list */
363 void register_socket_transport(int s, const char *serial, int port, int local, const char *device_name);
364
365 /* these should only be used for the "sdb disconnect" command */
366 void unregister_transport(atransport *t);
367 void unregister_all_tcp_transports();
368
369 void register_usb_transport(usb_handle *h, const char *serial, unsigned writeable);
370
371 /* this should only be used for transports with connection_state == CS_NOPERM */
372 void unregister_usb_transport(usb_handle *usb);
373
374 atransport *find_transport(const char *serial);
375 #if SDB_HOST
376 atransport* find_emulator_transport_by_sdb_port(int sdb_port);
377 #endif
378
379 int service_to_fd(const char *name);
380 #if SDB_HOST
381 asocket *host_service_to_socket(const char*  name, const char *serial);
382 #endif
383
384 #if !SDB_HOST
385 int       init_jdwp(void);
386 asocket*  create_jdwp_service_socket();
387 asocket*  create_jdwp_tracker_service_socket();
388 int       create_jdwp_connection_fd(int  jdwp_pid);
389 #endif
390
391 #if !SDB_HOST
392 typedef enum {
393     BACKUP,
394     RESTORE
395 } BackupOperation;
396 int backup_service(BackupOperation operation, char* args);
397 void framebuffer_service(int fd, void *cookie);
398 void log_service(int fd, void *cookie);
399 void remount_service(int fd, void *cookie);
400 char * get_log_file_path(const char * log_name);
401
402 extern int rootshell_mode; // 0: sdk user, 1: root
403 extern int booting_done; // 0: platform booting is in progess 1: platform booting is done
404
405 // This is the users and groups config for the platform
406
407 #define SID_ROOT        0    /* traditional unix root user */
408
409 #define SDK_USER_NAME   tzplatform_getenv(TZ_SDK_USER_NAME)
410 #define SDK_TOOL_PATH   tzplatform_getenv(TZ_SDK_TOOLS)
411 #define STATIC_SDK_USER_ID      5001
412 #define STATIC_SDK_GROUP_ID     100
413 #define STATIC_SDK_HOME_DIR     "/home/owner"
414 extern uid_t g_sdk_user_id;
415 extern gid_t g_sdk_group_id;
416 extern char* g_sdk_home_dir;
417 extern char* g_sdk_home_dir_env;
418 #endif
419
420 int is_pwlocked(void);
421 int should_drop_privileges(void);
422 int set_sdk_user_privileges();
423 void set_root_privileges();
424
425 int get_emulator_forward_port(void);
426 int get_emulator_name(char str[], int str_size);
427 int get_device_name(char str[], int str_size);
428 int get_emulator_hostip(char str[], int str_size);
429 int get_emulator_guestip(char str[], int str_size);
430
431 /* packet allocator */
432 apacket *get_apacket(void);
433 void put_apacket(apacket *p);
434
435 int check_header(apacket *p);
436 int check_data(apacket *p);
437
438 /* define SDB_TRACE to 1 to enable tracing support, or 0 to disable it */
439
440 #define  SDB_TRACE    1
441
442 /* IMPORTANT: if you change the following list, don't
443  * forget to update the corresponding 'tags' table in
444  * the sdb_trace_init() function implemented in sdb.c
445  */
446 typedef enum {
447     TRACE_SDB = 0,
448     TRACE_SOCKETS,
449     TRACE_PACKETS,
450     TRACE_TRANSPORT,
451     TRACE_RWX,
452     TRACE_USB,
453     TRACE_SYNC,
454     TRACE_SYSDEPS,
455     TRACE_JDWP,
456     TRACE_SERVICES,
457     TRACE_PROPERTIES,
458     TRACE_SDKTOOLS
459 } SdbTrace;
460
461 #if SDB_TRACE
462
463 #if !SDB_HOST
464 /*
465  * When running inside the emulator, guest's sdbd can connect to 'sdb-debug'
466  * qemud service that can display sdb trace messages (on condition that emulator
467  * has been started with '-debug sdb' option).
468  */
469
470 /* Delivers a trace message to the emulator via QEMU pipe. */
471 void sdb_qemu_trace(const char* fmt, ...);
472 /* Macro to use to send SDB trace messages to the emulator. */
473 #define DQ(...)    sdb_qemu_trace(__VA_ARGS__)
474 #else
475 #define DQ(...) ((void)0)
476 #endif  /* !SDB_HOST */
477
478   extern int     sdb_trace_mask;
479   extern unsigned char    sdb_trace_output_count;
480   void    sdb_trace_init(void);
481
482 #  define SDB_TRACING  ((sdb_trace_mask & (1 << TRACE_TAG)) != 0)
483
484   /* you must define TRACE_TAG before using this macro */
485 #  define  D(...)                                      \
486         do {                                           \
487             if (SDB_TRACING) {                         \
488                 int save_errno = errno;                \
489                 sdb_mutex_lock(&D_lock);               \
490                 fprintf(stderr, "%s::%s():",           \
491                         __FILE__, __FUNCTION__);       \
492                 errno = save_errno;                    \
493                 fprintf(stderr, __VA_ARGS__ );         \
494                 fflush(stderr);                        \
495                 sdb_mutex_unlock(&D_lock);             \
496                 errno = save_errno;                    \
497            }                                           \
498         } while (0)
499 #  define  DR(...)                                     \
500         do {                                           \
501             if (SDB_TRACING) {                         \
502                 int save_errno = errno;                \
503                 sdb_mutex_lock(&D_lock);               \
504                 errno = save_errno;                    \
505                 fprintf(stderr, __VA_ARGS__ );         \
506                 fflush(stderr);                        \
507                 sdb_mutex_unlock(&D_lock);             \
508                 errno = save_errno;                    \
509            }                                           \
510         } while (0)
511 #else
512 #  define  D(...)          ((void)0)
513 #  define  DR(...)         ((void)0)
514 #  define  SDB_TRACING     0
515 #endif
516
517
518 #if !TRACE_PACKETS
519 #define print_packet(tag,p) do {} while (0)
520 #endif
521
522 #if SDB_HOST_ON_TARGET
523 /* sdb and sdbd are coexisting on the target, so use 26099 for sdb
524  * to avoid conflicting with sdbd's usage of 26098
525  */
526 #  define DEFAULT_SDB_PORT 26099 /* tizen specific */
527 #else
528 #  define DEFAULT_SDB_PORT 26099 /* tizen specific */
529 #endif
530
531 #  define QEMU_FORWARD_IP "10.0.2.2"
532
533 #define DEFAULT_SDB_LOCAL_TRANSPORT_PORT 26101 /* tizen specific */
534 #define DEFAULT_SENSORS_LOCAL_TRANSPORT_PORT 26103 /* tizen specific */
535
536 #define SDB_CLASS              0xff
537 #define SDB_SUBCLASS           0x20 //0x42 /* tizen specific */
538 #define SDB_PROTOCOL           0x02 //0x01 /* tizen specific */
539
540
541 void local_init(int port);
542 int  local_connect(int  port, const char *device_name);
543 int  local_connect_arbitrary_ports(int console_port, int sdb_port, const char *device_name);
544
545 /* usb host/client interface */
546 #if SDB_HOST
547 void usb_init();
548 void usb_cleanup();
549 int usb_write(usb_handle *h, const void *data, int len);
550 int usb_read(usb_handle *h, void *data, size_t len);
551 int usb_close(usb_handle *h);
552 void usb_kick(usb_handle *h);
553 #else
554
555 extern void (*usb_init)();
556 extern void (*usb_cleanup)();
557 extern int (*usb_write)(usb_handle *h, const void *data, int len);
558 extern int (*usb_read)(usb_handle *h, void *data, size_t len);
559 extern int (*usb_close)(usb_handle *h);
560 extern void (*usb_kick)(usb_handle *h);
561
562 /* functionfs backend */
563 void ffs_usb_init();
564 void ffs_usb_cleanup();
565 int ffs_usb_write(usb_handle *h, const void *data, int len);
566 int ffs_usb_read(usb_handle *h, void *data, size_t len);
567 int ffs_usb_close(usb_handle *h);
568 void ffs_usb_kick(usb_handle *h);
569
570 /* kernel sdb gadget backend */
571 void linux_usb_init();
572 void linux_usb_cleanup();
573 int linux_usb_write(usb_handle *h, const void *data, int len);
574 int linux_usb_read(usb_handle *h, void *data, size_t len);
575 int linux_usb_close(usb_handle *h);
576 void linux_usb_kick(usb_handle *h);
577
578 #endif
579
580 /* used for USB device detection */
581 #if SDB_HOST
582 int is_sdb_interface(int vid, int pid, int usb_class, int usb_subclass, int usb_protocol);
583 #endif
584
585 unsigned host_to_le32(unsigned n);
586 int sdb_commandline(int argc, char **argv);
587
588 int connection_state(atransport *t);
589
590 #define CS_ANY       -1
591 #define CS_OFFLINE    0
592 #define CS_BOOTLOADER 1
593 #define CS_DEVICE     2
594 #define CS_HOST       3
595 #define CS_RECOVERY   4
596 #define CS_NOPERM     5 /* Insufficient permissions to communicate with the device */
597 #define CS_SIDELOAD   6
598 #define CS_PWLOCK     10
599
600 extern int HOST;
601 extern int SHELL_EXIT_NOTIFY_FD;
602 #if !SDB_HOST
603 extern SdbdCommandlineArgs sdbd_commandline_args;
604 #endif
605
606 #define CHUNK_SIZE (64*1024)
607
608 int sendfailmsg(int fd, const char *reason);
609 int handle_host_request(char *service, transport_type ttype, char* serial, int reply_fd, asocket *s);
610 int copy_packet(apacket* dest, apacket* src);
611
612 int is_emulator(void);
613 #define DEFAULT_DEVICENAME "unknown"
614
615 #if SDB_HOST /* tizen-specific */
616 #define DEVICEMAP_SEPARATOR ":"
617 #define DEVICENAME_MAX 256
618 #define VMS_PATH OS_PATH_SEPARATOR_STR "vms" OS_PATH_SEPARATOR_STR // should include sysdeps.h above
619
620 void register_device_name(const char *device_type, const char *device_name, int port);
621 int get_devicename_from_shdmem(int port, char *device_name);
622 int read_line(const int fd, char* ptr, const size_t maxlen);
623 #endif
624 #endif
625
626 #define USB_FUNCFS_SDB_PATH "/dev/usbgadget/sdb"
627 #define USB_NODE_FILE "/dev/samsung_sdb"