mirror of
https://gitlab.uni-freiburg.de/opensourcevdi/spice
synced 2025-12-26 06:32:44 +00:00
176970f3f1
Make all RedChannelClient hierarchy a C++ class. This allows to use virtual methods. Added a normal contructor instead or properties and g_object_new. As we remove GObject conversion macros I added a macro XXX_CAST to create a function to replace the old macro. They will be removed when more type safety is introduced. There's a new SPICE_CXX_GLIB_ALLOCATOR macro in red-common.h. This macro, added to a class define the class allocator allowing to use, in this case, GLib for allocation. This to avoid C++ library dependency and to initialize all structure to 0 (not all fields are manually initialized, will be improved with more encapsulation). Currently the methods are mainly public, access will be modified when more encapsulation (all functions in method) are done. Some classes are now defined in the header, C++ uses access to limit accessibility but for efficiency and type safety/inline and other features require types to be defined in the headers. Some fields were moved from XxxPrivate structure to class, C++ has accessibility. Many destructors are defined as protected to forbid the use of stack, this as these objects uses internal reference counting to have normal pointers. Maybe in the future pointers like std::shared_ptr could be used instead. Reference counting is now implemented very easily using atomic operations. Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
341 lines
12 KiB
C++
341 lines
12 KiB
C++
/*
|
|
Copyright (C) 2009-2015 Red Hat, Inc.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#include <config.h>
|
|
|
|
#define RedCharDeviceClientOpaque RedChannelClient
|
|
|
|
#include "smartcard-channel-client.h"
|
|
|
|
XXX_CAST(RedChannelClient, SmartCardChannelClient, SMARTCARD_CHANNEL_CLIENT)
|
|
|
|
struct SmartCardChannelClientPrivate
|
|
{
|
|
SPICE_CXX_GLIB_ALLOCATOR
|
|
|
|
RedCharDeviceSmartcard *smartcard = nullptr;
|
|
|
|
/* read_from_client/write_to_device buffer.
|
|
* The beginning of the buffer should always be VSCMsgHeader*/
|
|
RedCharDeviceWriteBuffer *write_buf = nullptr;
|
|
/* was the client msg received into a RedCharDeviceWriteBuffer
|
|
* or was it explicitly malloced */
|
|
bool msg_in_write_buf = false;
|
|
};
|
|
|
|
typedef struct RedErrorItem {
|
|
RedPipeItem base;
|
|
VSCMsgHeader vheader;
|
|
VSCMsgError error;
|
|
} RedErrorItem;
|
|
|
|
SmartCardChannelClient::SmartCardChannelClient(RedChannel *channel,
|
|
RedClient *client,
|
|
RedStream *stream,
|
|
RedChannelCapabilities *caps):
|
|
RedChannelClient(channel, client, stream, caps),
|
|
priv(new SmartCardChannelClientPrivate())
|
|
{
|
|
}
|
|
|
|
SmartCardChannelClient::~SmartCardChannelClient()
|
|
{
|
|
if (priv->smartcard) {
|
|
g_object_remove_weak_pointer(G_OBJECT(priv->smartcard),
|
|
(gpointer*)&priv->smartcard);
|
|
}
|
|
delete priv;
|
|
}
|
|
|
|
SmartCardChannelClient* smartcard_channel_client_create(RedChannel *channel,
|
|
RedClient *client, RedStream *stream,
|
|
RedChannelCapabilities *caps)
|
|
{
|
|
auto rcc = new SmartCardChannelClient(channel, client, stream, caps);
|
|
if (!rcc->init()) {
|
|
rcc->unref();
|
|
rcc = nullptr;
|
|
}
|
|
return rcc;
|
|
}
|
|
|
|
uint8_t *
|
|
SmartCardChannelClient::alloc_recv_buf(uint16_t type, uint32_t size)
|
|
{
|
|
/* TODO: only one reader is actually supported. When we fix the code to support
|
|
* multiple readers, we will probably associate different devices to
|
|
* different channels */
|
|
if (!priv->smartcard) {
|
|
priv->msg_in_write_buf = FALSE;
|
|
return (uint8_t *) g_malloc(size);
|
|
} else {
|
|
RedCharDeviceSmartcard *smartcard;
|
|
|
|
spice_assert(smartcard_get_n_readers() == 1);
|
|
smartcard = priv->smartcard;
|
|
spice_assert(smartcard_char_device_get_client(smartcard) || priv->smartcard);
|
|
spice_assert(!priv->write_buf);
|
|
priv->write_buf =
|
|
red_char_device_write_buffer_get_client(RED_CHAR_DEVICE(smartcard), this, size);
|
|
|
|
if (!priv->write_buf) {
|
|
spice_error("failed to allocate write buffer");
|
|
return NULL;
|
|
}
|
|
priv->msg_in_write_buf = TRUE;
|
|
return priv->write_buf->buf;
|
|
}
|
|
}
|
|
|
|
void
|
|
SmartCardChannelClient::release_recv_buf(uint16_t type, uint32_t size, uint8_t *msg)
|
|
{
|
|
/* todo: only one reader is actually supported. When we fix the code to support
|
|
* multiple readers, we will porbably associate different devices to
|
|
* differenc channels */
|
|
|
|
if (!priv->msg_in_write_buf) {
|
|
spice_assert(!priv->write_buf);
|
|
g_free(msg);
|
|
} else {
|
|
if (priv->write_buf) { /* msg hasn't been pushed to the guest */
|
|
spice_assert(priv->write_buf->buf == msg);
|
|
red_char_device_write_buffer_release(RED_CHAR_DEVICE(priv->smartcard),
|
|
&priv->write_buf);
|
|
}
|
|
}
|
|
}
|
|
|
|
void SmartCardChannelClient::on_disconnect()
|
|
{
|
|
RedCharDeviceSmartcard *device = priv->smartcard;
|
|
|
|
if (device) {
|
|
smartcard_char_device_detach_client(device, this);
|
|
smartcard_char_device_notify_reader_remove(device);
|
|
}
|
|
}
|
|
|
|
void smartcard_channel_client_send_data(RedChannelClient *rcc,
|
|
SpiceMarshaller *m,
|
|
RedPipeItem *item,
|
|
VSCMsgHeader *vheader)
|
|
{
|
|
spice_assert(rcc);
|
|
spice_assert(vheader);
|
|
/* NOTE: 'vheader' is assumed to be owned by 'item' so we keep the pipe
|
|
* item valid until the message is actually sent. */
|
|
red_pipe_item_ref(item);
|
|
rcc->init_send_data(SPICE_MSG_SMARTCARD_DATA);
|
|
spice_marshaller_add_by_ref_full(m, (uint8_t*)vheader, sizeof(VSCMsgHeader) + vheader->length,
|
|
marshaller_unref_pipe_item, item);
|
|
}
|
|
|
|
void smartcard_channel_client_send_error(RedChannelClient *rcc, SpiceMarshaller *m, RedPipeItem *item)
|
|
{
|
|
RedErrorItem* error_item = SPICE_UPCAST(RedErrorItem, item);
|
|
|
|
smartcard_channel_client_send_data(rcc, m, item, &error_item->vheader);
|
|
}
|
|
|
|
static void smartcard_channel_client_push_error(RedChannelClient *rcc,
|
|
uint32_t reader_id,
|
|
VSCErrorCode error)
|
|
{
|
|
RedErrorItem *error_item = g_new0(RedErrorItem, 1);
|
|
|
|
red_pipe_item_init(&error_item->base, RED_PIPE_ITEM_TYPE_ERROR);
|
|
|
|
error_item->vheader.reader_id = reader_id;
|
|
error_item->vheader.type = VSC_Error;
|
|
error_item->vheader.length = sizeof(error_item->error);
|
|
error_item->error.code = error;
|
|
rcc->pipe_add_push(&error_item->base);
|
|
}
|
|
|
|
static void smartcard_channel_client_add_reader(SmartCardChannelClient *scc)
|
|
{
|
|
if (!scc->priv->smartcard) { /* we already tried to attach a reader to the client
|
|
when it connected */
|
|
SpiceCharDeviceInstance *char_device = smartcard_readers_get_unattached();
|
|
|
|
if (!char_device) {
|
|
smartcard_channel_client_push_error(scc,
|
|
VSCARD_UNDEFINED_READER_ID,
|
|
VSC_CANNOT_ADD_MORE_READERS);
|
|
return;
|
|
}
|
|
smartcard_char_device_attach_client(char_device, scc);
|
|
}
|
|
smartcard_char_device_notify_reader_add(scc->priv->smartcard);
|
|
// The device sends a VSC_Error message, we will let it through, no
|
|
// need to send our own. We already set the correct reader_id, from
|
|
// our RedCharDeviceSmartcard.
|
|
}
|
|
|
|
static void smartcard_channel_client_remove_reader(SmartCardChannelClient *scc,
|
|
uint32_t reader_id)
|
|
{
|
|
SpiceCharDeviceInstance *char_device = smartcard_readers_get(reader_id);
|
|
RedCharDeviceSmartcard *dev;
|
|
|
|
if (char_device == NULL) {
|
|
smartcard_channel_client_push_error(scc,
|
|
reader_id, VSC_GENERAL_ERROR);
|
|
return;
|
|
}
|
|
|
|
dev = RED_CHAR_DEVICE_SMARTCARD(char_device->st);
|
|
spice_assert(scc->priv->smartcard == dev);
|
|
if (!smartcard_char_device_notify_reader_remove(dev)) {
|
|
smartcard_channel_client_push_error(scc,
|
|
reader_id, VSC_GENERAL_ERROR);
|
|
return;
|
|
}
|
|
}
|
|
|
|
static void smartcard_channel_client_write_to_reader(SmartCardChannelClient *scc)
|
|
{
|
|
g_return_if_fail(scc);
|
|
|
|
smartcard_channel_write_to_reader(scc->priv->write_buf);
|
|
scc->priv->write_buf = NULL;
|
|
}
|
|
|
|
|
|
bool smartcard_channel_client_handle_message(RedChannelClient *rcc,
|
|
uint16_t type,
|
|
uint32_t size,
|
|
void *message)
|
|
{
|
|
VSCMsgHeader* vheader = (VSCMsgHeader*) message;
|
|
SmartCardChannelClient *scc = SMARTCARD_CHANNEL_CLIENT(rcc);
|
|
|
|
if (type != SPICE_MSGC_SMARTCARD_DATA) {
|
|
/* Handles seamless migration protocol. Also handles ack's */
|
|
return RedChannelClient::handle_message(rcc, type, size, message);
|
|
}
|
|
|
|
switch (vheader->type) {
|
|
case VSC_ReaderAdd:
|
|
smartcard_channel_client_add_reader(scc);
|
|
return TRUE;
|
|
break;
|
|
case VSC_ReaderRemove:
|
|
smartcard_channel_client_remove_reader(scc, vheader->reader_id);
|
|
return TRUE;
|
|
break;
|
|
case VSC_Init:
|
|
// ignore - we should never get this anyway
|
|
return TRUE;
|
|
break;
|
|
case VSC_Error:
|
|
case VSC_ATR:
|
|
case VSC_CardRemove:
|
|
case VSC_APDU:
|
|
break; // passed on to device
|
|
default:
|
|
red_channel_warning(rcc->get_channel(),
|
|
"ERROR: unexpected message on smartcard channel");
|
|
return TRUE;
|
|
}
|
|
|
|
/* todo: fix */
|
|
if (vheader->reader_id >= smartcard_get_n_readers()) {
|
|
red_channel_warning(rcc->get_channel(),
|
|
"ERROR: received message for non existing reader: %d, %d, %d",
|
|
vheader->reader_id, vheader->type, vheader->length);
|
|
return FALSE;
|
|
}
|
|
spice_assert(scc->priv->write_buf->buf_size >= size);
|
|
memcpy(scc->priv->write_buf->buf, message, size);
|
|
smartcard_channel_client_write_to_reader(scc);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
bool smartcard_channel_client_handle_migrate_data(RedChannelClient *rcc,
|
|
uint32_t size,
|
|
void *message)
|
|
{
|
|
SmartCardChannelClient *scc;
|
|
SpiceMigrateDataHeader *header;
|
|
SpiceMigrateDataSmartcard *mig_data;
|
|
|
|
scc = SMARTCARD_CHANNEL_CLIENT(rcc);
|
|
header = (SpiceMigrateDataHeader *)message;
|
|
mig_data = (SpiceMigrateDataSmartcard *)(header + 1);
|
|
if (size < sizeof(SpiceMigrateDataHeader) + sizeof(SpiceMigrateDataSmartcard)) {
|
|
spice_error("bad message size");
|
|
return FALSE;
|
|
}
|
|
if (!migration_protocol_validate_header(header,
|
|
SPICE_MIGRATE_DATA_SMARTCARD_MAGIC,
|
|
SPICE_MIGRATE_DATA_SMARTCARD_VERSION)) {
|
|
spice_error("bad header");
|
|
return FALSE;
|
|
}
|
|
|
|
if (!mig_data->base.connected) { /* client wasn't attached to a smartcard */
|
|
return TRUE;
|
|
}
|
|
|
|
if (!scc->priv->smartcard) {
|
|
SpiceCharDeviceInstance *char_device = smartcard_readers_get_unattached();
|
|
|
|
if (!char_device) {
|
|
spice_warning("no unattached device available");
|
|
return TRUE;
|
|
} else {
|
|
smartcard_char_device_attach_client(char_device, scc);
|
|
}
|
|
}
|
|
spice_debug("reader added %d partial read_size %u", mig_data->reader_added, mig_data->read_size);
|
|
|
|
return smartcard_char_device_handle_migrate_data(scc->priv->smartcard,
|
|
mig_data);
|
|
}
|
|
|
|
bool smartcard_channel_client_handle_migrate_flush_mark(RedChannelClient *rcc)
|
|
{
|
|
rcc->pipe_add_type(RED_PIPE_ITEM_TYPE_SMARTCARD_MIGRATE_DATA);
|
|
return TRUE;
|
|
}
|
|
|
|
void smartcard_channel_client_set_char_device(SmartCardChannelClient *scc,
|
|
RedCharDeviceSmartcard *device)
|
|
{
|
|
if (device == scc->priv->smartcard) {
|
|
return;
|
|
}
|
|
|
|
if (scc->priv->smartcard) {
|
|
g_object_remove_weak_pointer(G_OBJECT(scc->priv->smartcard),
|
|
(gpointer*)&scc->priv->smartcard);
|
|
}
|
|
|
|
scc->priv->smartcard = device;
|
|
if (scc->priv->smartcard) {
|
|
g_object_add_weak_pointer(G_OBJECT(scc->priv->smartcard),
|
|
(gpointer*)&scc->priv->smartcard);
|
|
}
|
|
}
|
|
|
|
RedCharDeviceSmartcard* smartcard_channel_client_get_char_device(SmartCardChannelClient *scc)
|
|
{
|
|
return scc->priv->smartcard;
|
|
}
|