xrdp/libxrdp/libxrdp.h

/**
 * xrdp: A Remote Desktop Protocol server.
 *
 * Copyright (C) Jay Sorg 2004-2014
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * libxrdp header
 */

#if !defined(LIBXRDP_H)
#define LIBXRDP_H

#include "arch.h"
#include "parse.h"
#include "trans.h"
#include "xrdp_constants.h"
#include "defines.h"
#include "os_calls.h"
#include "ssl_calls.h"
#include "list.h"
#include "log.h"
#include "file.h"
#include "libxrdpinc.h"
#include "xrdp_client_info.h"
#include "log.h"


/* iso */
struct xrdp_iso
{
    struct xrdp_mcs *mcs_layer; /* owner */
    int rdpNegData; /* bool */
    int requestedProtocol;
    int selectedProtocol;
    int failureCode;
    struct trans *trans;
};

/* used in mcs */
struct mcs_channel_item
{
    char name[16];
    int flags;
    int chanid;
    int disabled;
    int pad0;
};

/* mcs */
struct xrdp_mcs
{
    struct xrdp_sec *sec_layer; /* owner */
    struct xrdp_iso *iso_layer;
    int userid;
    int chanid;
    struct stream *client_mcs_data;
    struct stream *server_mcs_data;
    struct list *channel_list;
    /* This boolean is set to indicate we're expecting channel join
     * requests as part of the connect sequence */
    int expecting_channel_join_requests;
};

/* fastpath */
struct xrdp_fastpath
{
    struct xrdp_sec *sec_layer; /* owner */
    struct trans *trans;
    struct xrdp_session *session;
    int numEvents;
    int secFlags;
};

/* Encryption Methods */
#define CRYPT_METHOD_NONE              0x00000000
#define CRYPT_METHOD_40BIT             0x00000001
#define CRYPT_METHOD_128BIT            0x00000002
#define CRYPT_METHOD_56BIT             0x00000008
#define CRYPT_METHOD_FIPS              0x00000010

/* Encryption Levels */
#define CRYPT_LEVEL_NONE               0x00000000
#define CRYPT_LEVEL_LOW                0x00000001
#define CRYPT_LEVEL_CLIENT_COMPATIBLE  0x00000002
#define CRYPT_LEVEL_HIGH               0x00000003
#define CRYPT_LEVEL_FIPS               0x00000004


/* sec */
struct xrdp_sec
{
    struct xrdp_rdp *rdp_layer; /* owner */
    struct xrdp_mcs *mcs_layer;
    struct xrdp_fastpath *fastpath_layer;
    struct xrdp_channel *chan_layer;
    char server_random[32];
    char client_random[256];
    char client_crypt_random[256 + 8]; /* 64 + 8, 256 + 8 */
    struct stream client_mcs_data;
    struct stream server_mcs_data;
    int decrypt_use_count;
    int encrypt_use_count;
    char decrypt_key[16];
    char encrypt_key[16];
    char decrypt_update_key[16];
    char encrypt_update_key[16];
    int crypt_method;
    int rc4_key_len; /* 8 = 40 bit, 16 = 128 bit */
    int crypt_level;
    char sign_key[16];
    void *decrypt_rc4_info;
    void *encrypt_rc4_info;
    char pub_exp[4];
    char pub_mod[256];
    char pub_sig[64];
    char pri_exp[256];
    int rsa_key_bytes; /* 64 or 256 , 0 = no rdp security */
    char fips_encrypt_key[24];
    char fips_decrypt_key[24];
    char fips_sign_key[20];
    void *encrypt_fips_info;
    void *decrypt_fips_info;
    void *sign_fips_info;
    int is_security_header_present; /* boolean */
};

struct xrdp_drdynvc
{
    int chan_id;
    int status; /* see XRDP_DRDYNVC_STATUS_* */
    int flags;
    int pad0;
    int (*open_response)(intptr_t id, int chan_id, int creation_status);
    int (*close_response)(intptr_t id, int chan_id);
    int (*data_first)(intptr_t id, int chan_id, char *data, int bytes, int total_bytes);
    int (*data)(intptr_t id, int chan_id, char *data, int bytes);
};

/* channel */
struct xrdp_channel
{
    struct xrdp_sec *sec_layer;
    struct xrdp_mcs *mcs_layer;
    int drdynvc_channel_id;
    int drdynvc_state;
    struct stream *s;
    struct xrdp_drdynvc drdynvcs[256];
};

/* rdp */
struct xrdp_rdp
{
    struct xrdp_session *session;
    struct xrdp_sec *sec_layer;
    int share_id;
    int mcs_channel;
    struct xrdp_client_info client_info;
    struct xrdp_mppc_enc *mppc_enc;
    void *rfx_enc;
};

/* state */
struct xrdp_orders_state
{
    int last_order; /* last order sent */

    int clip_left;  /* RDP_ORDER_BOUNDS, RDP_ORDER_LASTBOUNDS */
    int clip_top;
    int clip_right;
    int clip_bottom;

    int rect_x; /* RDP_ORDER_RECT */
    int rect_y;
    int rect_cx;
    int rect_cy;
    int rect_color;

    int scr_blt_x; /* RDP_ORDER_SCREENBLT */
    int scr_blt_y;
    int scr_blt_cx;
    int scr_blt_cy;
    int scr_blt_rop;
    int scr_blt_srcx;
    int scr_blt_srcy;

    int pat_blt_x; /* RDP_ORDER_PATBLT */
    int pat_blt_y;
    int pat_blt_cx;
    int pat_blt_cy;
    int pat_blt_rop;
    int pat_blt_bg_color;
    int pat_blt_fg_color;
    struct xrdp_brush pat_blt_brush;

    int dest_blt_x; /* RDP_ORDER_DESTBLT */
    int dest_blt_y;
    int dest_blt_cx;
    int dest_blt_cy;
    int dest_blt_rop;

    int line_mix_mode; /* RDP_ORDER_LINE */
    int line_startx;
    int line_starty;
    int line_endx;
    int line_endy;
    int line_bg_color;
    int line_rop;
    struct xrdp_pen line_pen;

    int mem_blt_color_table; /* RDP_ORDER_MEMBLT */
    int mem_blt_cache_id;
    int mem_blt_x;
    int mem_blt_y;
    int mem_blt_cx;
    int mem_blt_cy;
    int mem_blt_rop;
    int mem_blt_srcx;
    int mem_blt_srcy;
    int mem_blt_cache_idx;

    int text_font; /* RDP_ORDER_TEXT2 */
    int text_flags;
    int text_unknown;
    int text_mixmode;
    int text_fg_color;
    int text_bg_color;
    int text_clip_left;
    int text_clip_top;
    int text_clip_right;
    int text_clip_bottom;
    int text_box_left;
    int text_box_top;
    int text_box_right;
    int text_box_bottom;
    int text_x;
    int text_y;
    int text_len;
    char *text_data;

    int com_blt_srcidx;    /* RDP_ORDER_COMPOSITE */  /* 2 */
    int com_blt_srcformat;                            /* 2 */
    int com_blt_srcwidth;                             /* 2 */
    int com_blt_srcrepeat;                            /* 1 */
    int com_blt_srctransform[10];                     /* 40 */
    int com_blt_mskflags;                             /* 1 */
    int com_blt_mskidx;                               /* 2 */
    int com_blt_mskformat;                            /* 2 */
    int com_blt_mskwidth;                             /* 2 */
    int com_blt_mskrepeat;                            /* 1 */
    int com_blt_op;                                   /* 1 */
    int com_blt_srcx;                                 /* 2 */
    int com_blt_srcy;                                 /* 2 */
    int com_blt_mskx;                                 /* 2 */
    int com_blt_msky;                                 /* 2 */
    int com_blt_dstx;                                 /* 2 */
    int com_blt_dsty;                                 /* 2 */
    int com_blt_width;                                /* 2 */
    int com_blt_height;                               /* 2 */
    int com_blt_dstformat;                            /* 2 */

};

/* orders */
struct xrdp_orders
{
    struct stream *out_s;
    struct xrdp_rdp *rdp_layer;
    struct xrdp_session *session;
    struct xrdp_wm *wm;

    char *order_count_ptr; /* pointer to count, set when sending */
    int order_count;
    int order_level; /* inc for every call to xrdp_orders_init */
    struct xrdp_orders_state orders_state;
    void *jpeg_han;
    int rfx_min_pixel;
    /* shared */
    struct stream *s;
    struct stream *temp_s;
};

#define PROTO_RDP_40 1
#define PROTO_RDP_50 2

struct xrdp_mppc_enc
{
    int    protocol_type;    /* PROTO_RDP_40, PROTO_RDP_50 etc */
    char  *historyBuffer;    /* contains uncompressed data */
    char  *outputBuffer;     /* contains compressed data */
    char  *outputBufferPlus;
    int    historyOffset;    /* next free slot in historyBuffer */
    int    buf_len;          /* length of historyBuffer, protocol dependent */
    int    bytes_in_opb;     /* compressed bytes available in outputBuffer */
    int    flags;            /* PACKET_COMPRESSED, PACKET_AT_FRONT, PACKET_FLUSHED etc */
    int    flagsHold;
    int    first_pkt;        /* this is the first pkt passing through enc */
    tui16 *hash_table;
};

int
compress_rdp(struct xrdp_mppc_enc *enc, tui8 *srcData, int len);
struct xrdp_mppc_enc *
mppc_enc_new(int protocol_type);
void
mppc_enc_free(struct xrdp_mppc_enc *enc);

/* xrdp_tcp.c */
struct xrdp_tcp *
xrdp_tcp_create(struct xrdp_iso *owner, struct trans *trans);
void
xrdp_tcp_delete(struct xrdp_tcp *self);
int
xrdp_tcp_init(struct xrdp_tcp *self, struct stream *s);
int
xrdp_tcp_recv(struct xrdp_tcp *self, struct stream *s, int len);
int
xrdp_tcp_send(struct xrdp_tcp *self, struct stream *s);

/* xrdp_iso.c */
struct xrdp_iso *
xrdp_iso_create(struct xrdp_mcs *owner, struct trans *trans);
void
xrdp_iso_delete(struct xrdp_iso *self);
int
xrdp_iso_init(struct xrdp_iso *self, struct stream *s);
int
xrdp_iso_recv(struct xrdp_iso *self, struct stream *s);
int
xrdp_iso_send(struct xrdp_iso *self, struct stream *s);
int
xrdp_iso_incoming(struct xrdp_iso *self);
int
xrdp_iso_detect_tpkt(struct xrdp_iso *self, struct stream *s);

/* xrdp_mcs.c */
struct xrdp_mcs *
xrdp_mcs_create(struct xrdp_sec *owner, struct trans *trans,
                struct stream *client_mcs_data,
                struct stream *server_mcs_data);
void
xrdp_mcs_delete(struct xrdp_mcs *self);
int
xrdp_mcs_init(struct xrdp_mcs *self, struct stream *s);
int
xrdp_mcs_recv(struct xrdp_mcs *self, struct stream *s, int *chan);
int
xrdp_mcs_send(struct xrdp_mcs *self, struct stream *s, int chan);
int
xrdp_mcs_incoming(struct xrdp_mcs *self);
int
xrdp_mcs_disconnect(struct xrdp_mcs *self);

/* xrdp_sec.c */

/*
    These are error return codes for:-
        1. xrdp_sec_process_mcs_data_monitors
        2. libxrdp_process_monitor_stream
        3. libxrdp_process_monitor_ex_stream
    To clarify any reason for a non-zero response code.
*/
#define SEC_PROCESS_MONITORS_ERR 1
#define SEC_PROCESS_MONITORS_ERR_TOO_MANY_MONITORS 2
#define SEC_PROCESS_MONITORS_ERR_INVALID_DESKTOP 3
#define SEC_PROCESS_MONITORS_ERR_INVALID_MONITOR 4

struct xrdp_sec *
xrdp_sec_create(struct xrdp_rdp *owner, struct trans *trans);
void
xrdp_sec_delete(struct xrdp_sec *self);
int
xrdp_sec_init(struct xrdp_sec *self, struct stream *s);
int
xrdp_sec_get_fastpath_bytes(struct xrdp_sec *self);
int
xrdp_sec_init_fastpath(struct xrdp_sec *self, struct stream *s);
int
xrdp_sec_send_fastpath(struct xrdp_sec *self, struct stream *s);
int
xrdp_sec_recv_fastpath(struct xrdp_sec *self, struct stream *s);
int
xrdp_sec_recv(struct xrdp_sec *self, struct stream *s, int *chan);
int
xrdp_sec_send(struct xrdp_sec *self, struct stream *s, int chan);
int
xrdp_sec_process_mcs_data(struct xrdp_sec *self);
int
xrdp_sec_incoming(struct xrdp_sec *self);
int
xrdp_sec_disconnect(struct xrdp_sec *self);
int
xrdp_sec_process_mcs_data_monitors(struct xrdp_sec *self, struct stream *s);

/* xrdp_rdp.c */

/**
 * Reasons why output is being suppressed or restarted
 */
enum suppress_output_reason
{
    /// Client has requested suppress via TS_SUPPRESS_OUTPUT_PDU
    XSO_REASON_CLIENT_REQUEST = (1 << 0),
    /// Deactivation-Reactivation Sequence [MS-RDPBCGR] 1.3.1.3
    XSO_REASON_DEACTIVATE_REACTIVATE = (1 << 1),
    /// Dynamic resize in progress
    XSO_REASON_DYNAMIC_RESIZE = (1 << 2)
};

struct xrdp_rdp *
xrdp_rdp_create(struct xrdp_session *session, struct trans *trans);
void
xrdp_rdp_delete(struct xrdp_rdp *self);
int
xrdp_rdp_init(struct xrdp_rdp *self, struct stream *s);
int
xrdp_rdp_init_data(struct xrdp_rdp *self, struct stream *s);
int
xrdp_rdp_get_fastpath_bytes(struct xrdp_rdp *self);
int
xrdp_rdp_init_fastpath(struct xrdp_rdp *self, struct stream *s);
int
xrdp_rdp_recv(struct xrdp_rdp *self, struct stream *s, int *code);
int
xrdp_rdp_send(struct xrdp_rdp *self, struct stream *s, int pdu_type);
int
xrdp_rdp_send_data(struct xrdp_rdp *self, struct stream *s,
                   int data_pdu_type);
int
xrdp_rdp_send_data_from_channel(struct xrdp_rdp *self, struct stream *s,
                                int data_pdu_type, int channel_id,
                                int compress);
int
xrdp_rdp_send_fastpath(struct xrdp_rdp *self, struct stream *s,
                       int data_pdu_type);
int
xrdp_rdp_send_data_update_sync(struct xrdp_rdp *self);
int
xrdp_rdp_incoming(struct xrdp_rdp *self);
int
xrdp_rdp_process_data(struct xrdp_rdp *self, struct stream *s);
int
xrdp_rdp_disconnect(struct xrdp_rdp *self);
int
xrdp_rdp_send_deactivate(struct xrdp_rdp *self);
int
xrdp_rdp_send_session_info(struct xrdp_rdp *self, const char *data,
                           int data_bytes);
/**
 * Request output suppress or resume
 *
 * @param self RDP struct
 * @param suppress (!= 0 for suppress, 0 for resume)
 * @param reason Why the output is being suppressed or resumed
 * @param left Left pixel of repaint area (ignored for suppress)
 * @param top Top pixel of repaint area (ignored for suppress)
 * @param right Right pixel of inclusive repaint area (ignored for suppress)
 * @param bottom Bottom pixel of inclusive repaint area (ignored for suppress)
 */
void
xrdp_rdp_suppress_output(struct xrdp_rdp *self, int suppress,
                         enum suppress_output_reason reason,
                         int left, int top, int right, int bottom);

/* xrdp_orders.c */
struct xrdp_orders *
xrdp_orders_create(struct xrdp_session *session,
                   struct xrdp_rdp *rdp_layer);
void
xrdp_orders_delete(struct xrdp_orders *self);
int
xrdp_orders_reset(struct xrdp_orders *self);
int
xrdp_orders_init(struct xrdp_orders *self);
int
xrdp_orders_send(struct xrdp_orders *self);
int
xrdp_orders_force_send(struct xrdp_orders *self);
int
xrdp_orders_check(struct xrdp_orders *self, int max_size);
int
xrdp_orders_rect(struct xrdp_orders *self, int x, int y, int cx, int cy,
                 int color, struct xrdp_rect *rect);
int
xrdp_orders_screen_blt(struct xrdp_orders *self, int x, int y,
                       int cx, int cy, int srcx, int srcy,
                       int rop, struct xrdp_rect *rect);
int
xrdp_orders_pat_blt(struct xrdp_orders *self, int x, int y,
                    int cx, int cy, int rop, int bg_color,
                    int fg_color, struct xrdp_brush *brush,
                    struct xrdp_rect *rect);
int
xrdp_orders_dest_blt(struct xrdp_orders *self, int x, int y,
                     int cx, int cy, int rop,
                     struct xrdp_rect *rect);
int
xrdp_orders_line(struct xrdp_orders *self, int mix_mode,
                 int startx, int starty,
                 int endx, int endy, int rop, int bg_color,
                 struct xrdp_pen *pen,
                 struct xrdp_rect *rect);
int
xrdp_orders_mem_blt(struct xrdp_orders *self, int cache_id,
                    int color_table, int x, int y, int cx, int cy,
                    int rop, int srcx, int srcy,
                    int cache_idx, struct xrdp_rect *rect);
int
xrdp_orders_composite_blt(struct xrdp_orders *self, int srcidx,
                          int srcformat, int srcwidth,
                          int srcrepeat, int *srctransform, int mskflags,
                          int mskidx, int mskformat, int mskwidth,
                          int mskrepeat, int op, int srcx, int srcy,
                          int mskx, int msky, int dstx, int dsty,
                          int width, int height, int dstformat,
                          struct xrdp_rect *rect);
int
xrdp_orders_text(struct xrdp_orders *self,
                 int font, int flags, int mixmode,
                 int fg_color, int bg_color,
                 int clip_left, int clip_top,
                 int clip_right, int clip_bottom,
                 int box_left, int box_top,
                 int box_right, int box_bottom,
                 int x, int y, char *data, int data_len,
                 struct xrdp_rect *rect);
int
xrdp_orders_send_palette(struct xrdp_orders *self, int *palette,
                         int cache_id);
int
xrdp_orders_send_raw_bitmap(struct xrdp_orders *self,
                            int width, int height, int bpp, char *data,
                            int cache_id, int cache_idx);
int
xrdp_orders_send_bitmap(struct xrdp_orders *self,
                        int width, int height, int bpp, char *data,
                        int cache_id, int cache_idx);
int
xrdp_orders_send_font(struct xrdp_orders *self,
                      struct xrdp_font_char *font_char,
                      int font_index, int char_index);
int
xrdp_orders_send_raw_bitmap2(struct xrdp_orders *self,
                             int width, int height, int bpp, char *data,
                             int cache_id, int cache_idx);
int
xrdp_orders_send_bitmap2(struct xrdp_orders *self,
                         int width, int height, int bpp, char *data,
                         int cache_id, int cache_idx, int hints);
int
xrdp_orders_send_bitmap3(struct xrdp_orders *self,
                         int width, int height, int bpp, char *data,
                         int cache_id, int cache_idx, int hints);
int
xrdp_orders_send_brush(struct xrdp_orders *self, int width, int height,
                       int bpp, int type, int size, char *data, int cache_id);
int
xrdp_orders_send_create_os_surface(struct xrdp_orders *self, int id,
                                   int width, int height,
                                   struct list *del_list);
int
xrdp_orders_send_switch_os_surface(struct xrdp_orders *self, int id);

/* xrdp_bitmap_compress.c */
int
xrdp_bitmap_compress(char *in_data, int width, int height,
                     struct stream *s, int bpp, int byte_limit,
                     int start_line, struct stream *temp_s,
                     int e);
int
xrdp_bitmap32_compress(char *in_data, int width, int height,
                       struct stream *s, int bpp, int byte_limit,
                       int start_line, struct stream *temp_s,
                       int e, int flags);
int
xrdp_jpeg_compress(void *handle, char *in_data, int width, int height,
                   struct stream *s, int bpp, int byte_limit,
                   int start_line, struct stream *temp_s,
                   int e, int quality);

int
xrdp_codec_jpeg_compress(void *handle,
                         int   format,   /* input data format */
                         char *inp_data, /* input data */
                         int   width,    /* width of inp_data */
                         int   height,   /* height of inp_data */
                         int   stride,   /* inp_data stride, in bytes*/
                         int   x,        /* x loc in inp_data */
                         int   y,        /* y loc in inp_data */
                         int   cx,       /* width of area to compress */
                         int   cy,       /* height of area to compress */
                         int   quality,  /* higher numbers compress less */
                         char *out_data, /* dest for jpg image */
                         int  *io_len    /* length of out_data and on return
                                            len of compressed data */
                        );

void *
xrdp_jpeg_init(void);
int
xrdp_jpeg_deinit(void *handle);

/* xrdp_channel.c */
struct xrdp_channel *
xrdp_channel_create(struct xrdp_sec *owner, struct xrdp_mcs *mcs_layer);
void
xrdp_channel_delete(struct xrdp_channel *self);
int
xrdp_channel_init(struct xrdp_channel *self, struct stream *s);
int
xrdp_channel_send(struct xrdp_channel *self, struct stream *s, int channel_id,
                  int total_data_len, int flags);
int
xrdp_channel_process(struct xrdp_channel *self, struct stream *s,
                     int chanid);
int
xrdp_channel_drdynvc_start(struct xrdp_channel *self);
int
xrdp_channel_drdynvc_open(struct xrdp_channel *self, const char *name,
                          int flags, struct xrdp_drdynvc_procs *procs,
                          int *chan_id);
int
xrdp_channel_drdynvc_close(struct xrdp_channel *self, int chan_id);
int
xrdp_channel_drdynvc_data_first(struct xrdp_channel *self, int chan_id,
                                const char *data, int data_bytes,
                                int total_data_bytes);
int
xrdp_channel_drdynvc_data(struct xrdp_channel *self, int chan_id,
                          const char *data, int data_bytes);

/* xrdp_fastpath.c */
struct xrdp_fastpath *
xrdp_fastpath_create(struct xrdp_sec *owner, struct trans *trans);
void
xrdp_fastpath_delete(struct xrdp_fastpath *self);
int
xrdp_fastpath_recv(struct xrdp_fastpath *self, struct stream *s);
int
xrdp_fastpath_process_input_event(struct xrdp_fastpath *self, struct stream *s);
int
xrdp_fastpath_init(struct xrdp_fastpath *self, struct stream *s);
int
xrdp_fastpath_send(struct xrdp_fastpath *self, struct stream *s);

/* xrdp_caps.c */
int
xrdp_caps_send_demand_active(struct xrdp_rdp *self);
int
xrdp_caps_process_confirm_active(struct xrdp_rdp *self, struct stream *s);
#endif