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 232 233 234 235 236 237 238 239 240
|
/**
* Copyright (C) 2022 Matt Burt, all xrdp contributors
*
* 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.
*/
/**
* @file libipm/libipm.c
* @brief Inter-Process Messaging building and parsing definitions
*/
#if defined(HAVE_CONFIG_H)
#include <config_ac.h>
#endif
#include "libipm.h"
#include "libipm_private.h"
#include "libipm_facilities.h"
#include "trans.h"
#include "log.h"
#include "os_calls.h"
const char *libipm_valid_type_chars = "ybnqiuxtsdhogB";
/*****************************************************************************/
void
libipm_msg_in_close_file_descriptors(struct trans *self)
{
struct libipm_priv *priv = (struct libipm_priv *)self->extra_data;
if (priv != NULL)
{
unsigned int i;
for (i = priv->in_fd_index ; i < priv->in_fd_count; ++i)
{
g_file_close(priv->in_fds[i]);
}
priv->in_fd_count = 0;
priv->in_fd_index = 0;
}
}
/**************************************************************************//**
* Send function for a struct trans initialised with libipm_init_trans()
*
* @param self Transport to send on
* @param data pointer to data to send
* @param len Length of data to send
* @return As for write(2)
*/
static int
libipm_trans_send_proc(struct trans *self, const char *data, int len)
{
int rv;
struct libipm_priv *priv = (struct libipm_priv *)self->extra_data;
if (priv != NULL && data == self->out_s->data)
{
/* We're sending the message header. Send any file descriptors
* as ancillary data */
rv = g_sck_send_fd_set(self->sck, data, len,
priv->out_fds, priv->out_fd_count);
}
else
{
rv = g_sck_send(self->sck, data, len, 0);
}
return rv;
}
/**************************************************************************//**
* Receive function for a struct trans initialised with libipm_init_trans()
*
* @param self Transport to receive on
* @param data pointer to receive data buffer
* @param len Length of data to read
* @return As for read(2)
*/
static int
libipm_trans_recv_proc(struct trans *self, char *data, int len)
{
int rv;
struct libipm_priv *priv = (struct libipm_priv *)self->extra_data;
if (priv != NULL && data == self->in_s->data)
{
/* We're receiving the message header */
unsigned int fdcount;
/* Check there are no live file descriptors in the input
* buffer from a previous message. This shouldn't happen, but
* if by some chance it does, we could leak file descriptors */
if (priv->in_fd_count > 0)
{
LOG(LOG_LEVEL_WARNING, "Unconsumed file descriptors detected");
libipm_msg_in_close_file_descriptors(self);
}
rv = g_sck_recv_fd_set(self->sck, data, len,
priv->in_fds, MAX_FD_PER_MSG,
&fdcount);
if (fdcount > MAX_FD_PER_MSG)
{
LOG(LOG_LEVEL_WARNING,
"%d file descriptors were discarded on recvmsg()",
fdcount - MAX_FD_PER_MSG);
fdcount = MAX_FD_PER_MSG;
}
priv->in_fd_count = fdcount;
}
else
{
rv = g_sck_recv(self->sck, data, len, 0);
}
return rv;
}
/**************************************************************************//**
* Destructor for a struct trans initialised with libipm_init_trans()
*
* @param trans Transport to destroy
*/
static void
libipm_trans_destructor(struct trans *trans)
{
struct libipm_priv *priv = (struct libipm_priv *)trans->extra_data;
libipm_msg_in_close_file_descriptors(trans);
if (priv != NULL)
{
if ((priv->flags & LIBIPM_E_MSG_IN_ERASE_AFTER_USE) != 0 &&
trans->in_s->data != NULL)
{
g_memset(trans->in_s->data, '\0',
trans->in_s->end - trans->in_s->data);
}
g_free(priv);
trans->extra_data = NULL;
trans->extra_destructor = NULL;
}
}
/*****************************************************************************/
enum libipm_status
libipm_init_trans(struct trans *trans,
enum libipm_facility facility,
const char *(*msgno_to_str)(unsigned short msgno))
{
struct libipm_priv *priv;
enum libipm_status rv;
if (trans->extra_data != NULL || trans->extra_destructor != NULL)
{
LOG(LOG_LEVEL_ERROR, "%s() called with sub-classed transport",
__func__);
rv = E_LI_PROGRAM_ERROR;
}
else if ((priv = g_new0(struct libipm_priv, 1)) == 0)
{
LOG(LOG_LEVEL_ERROR, "%s() out of memory", __func__);
rv = E_LI_NO_MEMORY;
}
else
{
priv->facility = facility;
priv->msgno_to_str = msgno_to_str;
trans->trans_send = libipm_trans_send_proc;
trans->trans_recv = libipm_trans_recv_proc;
trans->extra_data = priv;
trans->extra_destructor = libipm_trans_destructor;
g_sck_set_non_blocking(trans->sck);
libipm_msg_in_reset(trans);
rv = E_LI_SUCCESS;
}
return rv;
}
/*****************************************************************************/
void
libipm_set_flags(struct trans *trans, unsigned int flags)
{
struct libipm_priv *priv = (struct libipm_priv *)trans->extra_data;
if (priv != NULL)
{
priv->flags |= flags;
}
}
/*****************************************************************************/
void
libipm_clear_flags(struct trans *trans, unsigned int flags)
{
struct libipm_priv *priv = (struct libipm_priv *)trans->extra_data;
if (priv != NULL)
{
priv->flags &= ~flags;
}
}
/*****************************************************************************/
void
libipm_change_facility(struct trans *trans,
enum libipm_facility old_facility,
enum libipm_facility new_facility)
{
struct libipm_priv *priv = (struct libipm_priv *)trans->extra_data;
if (priv != NULL)
{
if (priv->facility != old_facility)
{
LOG(LOG_LEVEL_WARNING, "Not changing libipm facility - bad value");
}
else
{
priv->facility = new_facility;
}
}
}
|