xrdp/common/trans.h

167 lines
5.1 KiB
C
Raw Normal View History

/**
* 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.
*
* generic transport
*/
2008-08-22 10:08:11 +04:00
#if !defined(TRANS_H)
#define TRANS_H
#include "arch.h"
#include "parse.h"
#define TRANS_MODE_TCP 1 /* tcp6 if defined, else tcp4 */
2010-05-04 11:37:22 +04:00
#define TRANS_MODE_UNIX 2
#define TRANS_MODE_VSOCK 3
#define TRANS_MODE_TCP4 4 /* tcp4 only */
#define TRANS_MODE_TCP6 6 /* tcp6 only */
2010-05-04 11:37:22 +04:00
#define TRANS_TYPE_LISTENER 1
#define TRANS_TYPE_SERVER 2
#define TRANS_TYPE_CLIENT 3
#define TRANS_STATUS_DOWN 0
#define TRANS_STATUS_UP 1
2008-08-22 10:08:11 +04:00
struct trans; /* forward declaration */
2014-07-23 16:31:45 +04:00
struct xrdp_tls;
2008-08-22 10:08:11 +04:00
typedef int (*ttrans_data_in)(struct trans *self);
typedef int (*ttrans_conn_in)(struct trans *self,
struct trans *new_self);
2017-03-12 19:35:00 +03:00
typedef int (*tis_term)(void);
typedef int (*trans_recv_proc) (struct trans *self, char *ptr, int len);
typedef int (*trans_send_proc) (struct trans *self, const char *data, int len);
typedef int (*trans_can_recv_proc) (struct trans *self, int sck, int millis);
2008-08-22 10:08:11 +04:00
2015-07-06 09:14:46 +03:00
/* optional source info */
enum xrdp_source
{
XRDP_SOURCE_NONE = 0,
XRDP_SOURCE_CLIENT,
XRDP_SOURCE_SESMAN,
XRDP_SOURCE_CHANSRV,
XRDP_SOURCE_MOD,
XRDP_SOURCE_MAX_COUNT
};
2015-07-06 09:14:46 +03:00
/*
* @brief Provide flow control mechanism for (primarily) xrdp
*
* There is one of these data structures per-program.
*
* While input is being read from a 'struct trans' and processed, the
* cur_source member is set to the my_source member from the transport.
* During this processing, trans_write_copy() may be called to send output
* on another struct trans. If this happens, and the ouput needs to be
* buffered, trans_write_copy() can add the number of bytes generated by
* the input trans to the source field for the cur_source. This allows us to
* see how much output has been buffered for each input source.
*
* When the program assembles 'struct trans' objects to scan for input
* (normally in trans_get_wait_objs()), it is able to see how much buffered
* output is registered for each input. Inputs which have too much buffered
* output owing are skipped, and not considered for input.
*
* This provides a simple means of providing back-pressure on an input
* where the data it is providing is being processed and then sent out on
* a much slower link.
*/
2015-07-06 09:14:46 +03:00
struct source_info
{
enum xrdp_source cur_source;
int source[XRDP_SOURCE_MAX_COUNT];
2015-07-06 09:14:46 +03:00
};
2008-08-22 10:08:11 +04:00
struct trans
{
tbus sck; /* socket handle */
int mode; /* 1 tcp, 2 unix socket, 3 vsock */
int status;
int type1; /* 1 listener 2 server 3 client */
ttrans_data_in trans_data_in;
ttrans_conn_in trans_conn_in;
void *callback_data;
int header_size;
struct stream *in_s;
struct stream *out_s;
char *listen_filename;
tis_term is_term; /* used to test for exit */
struct stream *wait_s;
char addr[256];
char port[256];
int no_stream_init_on_data_in;
int extra_flags; /* user defined */
2014-11-26 05:55:37 +03:00
struct ssl_tls *tls;
2016-09-09 09:42:04 +03:00
const char *ssl_protocol; /* e.g. TLSv1, TLSv1.1, TLSv1.2, unknown */
const char *cipher_name; /* e.g. AES256-GCM-SHA384 */
2014-11-22 07:49:01 +03:00
trans_recv_proc trans_recv;
trans_send_proc trans_send;
trans_can_recv_proc trans_can_recv;
2015-07-06 09:14:46 +03:00
struct source_info *si;
enum xrdp_source my_source;
2008-08-22 10:08:11 +04:00
};
struct trans *
2008-08-22 10:08:11 +04:00
trans_create(int mode, int in_size, int out_size);
2017-03-12 19:35:00 +03:00
void
trans_delete(struct trans *self);
void
trans_delete_from_child(struct trans *self);
2017-03-12 19:35:00 +03:00
int
trans_get_wait_objs(struct trans *self, tbus *objs, int *count);
2017-03-12 19:35:00 +03:00
int
trans_get_wait_objs_rw(struct trans *self,
tbus *robjs, int *rcount,
2015-07-13 11:10:48 +03:00
tbus *wobjs, int *wcount, int *timeout);
2017-03-12 19:35:00 +03:00
int
trans_check_wait_objs(struct trans *self);
2017-03-12 19:35:00 +03:00
int
trans_force_read_s(struct trans *self, struct stream *in_s, int size);
2017-03-12 19:35:00 +03:00
int
trans_force_write_s(struct trans *self, struct stream *out_s);
2017-03-12 19:35:00 +03:00
int
trans_force_read(struct trans *self, int size);
2017-03-12 19:35:00 +03:00
int
trans_force_write(struct trans *self);
2017-03-12 19:35:00 +03:00
int
trans_write_copy(struct trans *self);
2017-03-12 19:35:00 +03:00
int
trans_write_copy_s(struct trans *self, struct stream *out_s);
2017-03-12 19:35:00 +03:00
int
trans_connect(struct trans *self, const char *server, const char *port,
2008-08-22 10:08:11 +04:00
int timeout);
2017-03-12 19:35:00 +03:00
int
trans_listen_address(struct trans *self, char *port, const char *address);
2017-03-12 19:35:00 +03:00
int
trans_listen(struct trans *self, char *port);
struct stream *
trans_get_in_s(struct trans *self);
struct stream *
trans_get_out_s(struct trans *self, int size);
2017-03-12 19:35:00 +03:00
int
trans_set_tls_mode(struct trans *self, const char *key, const char *cert,
long ssl_protocols, const char *tls_ciphers);
2017-03-12 19:35:00 +03:00
int
2014-07-23 16:31:45 +04:00
trans_shutdown_tls_mode(struct trans *self);
2017-03-12 19:35:00 +03:00
int
2014-07-23 16:31:45 +04:00
trans_tcp_force_read_s(struct trans *self, struct stream *in_s, int size);
2008-08-22 10:08:11 +04:00
#endif