a992743d99
The format is described in MS-RDPECLIP 2.2.5.2.3 Packed File List (CLIPRDR_FILELIST). These functions handle conversion between the on-the-wire data from cliprdr and arrays of FILEDESCRIPTOR structs. FILETIME handling is a bit wacky, but that's what we currently have.
496 lines
13 KiB
C
496 lines
13 KiB
C
/**
|
|
* FreeRDP: A Remote Desktop Protocol Implementation
|
|
* Clipboard Virtual Channel
|
|
*
|
|
* Copyright 2009-2011 Jay Sorg
|
|
* Copyright 2010-2011 Vic Lee
|
|
* Copyright 2015 Thincast Technologies GmbH
|
|
* Copyright 2015 DI (FH) Martin Haimberger <martin.haimberger@thincast.com>
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
|
|
#include <winpr/crt.h>
|
|
#include <winpr/print.h>
|
|
|
|
#include <freerdp/types.h>
|
|
#include <freerdp/constants.h>
|
|
#include <freerdp/client/cliprdr.h>
|
|
|
|
#include "cliprdr_main.h"
|
|
#include "cliprdr_format.h"
|
|
|
|
/**
|
|
* Function description
|
|
*
|
|
* @return 0 on success, otherwise a Win32 error code
|
|
*/
|
|
UINT cliprdr_process_format_list(cliprdrPlugin* cliprdr, wStream* s, UINT32 dataLen, UINT16 msgFlags)
|
|
{
|
|
UINT32 index;
|
|
UINT32 position;
|
|
BOOL asciiNames;
|
|
int formatNameLength;
|
|
char* szFormatName;
|
|
WCHAR* wszFormatName;
|
|
CLIPRDR_FORMAT* formats = NULL;
|
|
CLIPRDR_FORMAT_LIST formatList;
|
|
CliprdrClientContext* context = cliprdr_get_client_interface(cliprdr);
|
|
UINT error = CHANNEL_RC_OK;
|
|
|
|
if (!context->custom)
|
|
{
|
|
WLog_ERR(TAG, "context->custom not set!");
|
|
return ERROR_INTERNAL_ERROR;
|
|
}
|
|
|
|
asciiNames = (msgFlags & CB_ASCII_NAMES) ? TRUE : FALSE;
|
|
|
|
formatList.msgType = CB_FORMAT_LIST;
|
|
formatList.msgFlags = msgFlags;
|
|
formatList.dataLen = dataLen;
|
|
|
|
index = 0;
|
|
formatList.numFormats = 0;
|
|
position = Stream_GetPosition(s);
|
|
|
|
if (!formatList.dataLen)
|
|
{
|
|
/* empty format list */
|
|
formatList.formats = NULL;
|
|
formatList.numFormats = 0;
|
|
}
|
|
else if (!cliprdr->useLongFormatNames)
|
|
{
|
|
formatList.numFormats = (dataLen / 36);
|
|
|
|
if ((formatList.numFormats * 36) != dataLen)
|
|
{
|
|
WLog_ERR(TAG, "Invalid short format list length: %"PRIu32"", dataLen);
|
|
return ERROR_INTERNAL_ERROR;
|
|
}
|
|
|
|
if (formatList.numFormats)
|
|
formats = (CLIPRDR_FORMAT*) calloc(formatList.numFormats, sizeof(CLIPRDR_FORMAT));
|
|
|
|
if (!formats)
|
|
{
|
|
WLog_ERR(TAG, "calloc failed!");
|
|
return CHANNEL_RC_NO_MEMORY;
|
|
}
|
|
|
|
formatList.formats = formats;
|
|
|
|
while (dataLen)
|
|
{
|
|
Stream_Read_UINT32(s, formats[index].formatId); /* formatId (4 bytes) */
|
|
dataLen -= 4;
|
|
|
|
formats[index].formatName = NULL;
|
|
|
|
/* According to MS-RDPECLIP 2.2.3.1.1.1 formatName is "a 32-byte block containing
|
|
* the *null-terminated* name assigned to the Clipboard Format: (32 ASCII 8 characters
|
|
* or 16 Unicode characters)"
|
|
* However, both Windows RDSH and mstsc violate this specs as seen in the following
|
|
* example of a transferred short format name string: [R.i.c.h. .T.e.x.t. .F.o.r.m.a.t.]
|
|
* These are 16 unicode charaters - *without* terminating null !
|
|
*/
|
|
|
|
if (asciiNames)
|
|
{
|
|
szFormatName = (char*) Stream_Pointer(s);
|
|
|
|
if (szFormatName[0])
|
|
{
|
|
/* ensure null termination */
|
|
formats[index].formatName = (char*) malloc(32 + 1);
|
|
if (!formats[index].formatName)
|
|
{
|
|
WLog_ERR(TAG, "malloc failed!");
|
|
error = CHANNEL_RC_NO_MEMORY;
|
|
goto error_out;
|
|
}
|
|
CopyMemory(formats[index].formatName, szFormatName, 32);
|
|
formats[index].formatName[32] = '\0';
|
|
}
|
|
}
|
|
else
|
|
{
|
|
wszFormatName = (WCHAR*) Stream_Pointer(s);
|
|
|
|
if (wszFormatName[0])
|
|
{
|
|
/* ConvertFromUnicode always returns a null-terminated
|
|
* string on success, even if the source string isn't.
|
|
*/
|
|
if (ConvertFromUnicode(CP_UTF8, 0, wszFormatName, 16,
|
|
&(formats[index].formatName), 0, NULL, NULL) < 1)
|
|
{
|
|
WLog_ERR(TAG, "failed to convert short clipboard format name");
|
|
error = ERROR_INTERNAL_ERROR;
|
|
goto error_out;
|
|
}
|
|
}
|
|
}
|
|
|
|
Stream_Seek(s, 32);
|
|
dataLen -= 32;
|
|
index++;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
while (dataLen)
|
|
{
|
|
Stream_Seek(s, 4); /* formatId (4 bytes) */
|
|
dataLen -= 4;
|
|
|
|
wszFormatName = (WCHAR*) Stream_Pointer(s);
|
|
|
|
if (!wszFormatName[0])
|
|
formatNameLength = 0;
|
|
else
|
|
formatNameLength = _wcslen(wszFormatName);
|
|
|
|
Stream_Seek(s, (formatNameLength + 1) * 2);
|
|
dataLen -= ((formatNameLength + 1) * 2);
|
|
|
|
formatList.numFormats++;
|
|
}
|
|
|
|
dataLen = formatList.dataLen;
|
|
Stream_SetPosition(s, position);
|
|
|
|
if (formatList.numFormats)
|
|
formats = (CLIPRDR_FORMAT*) calloc(formatList.numFormats, sizeof(CLIPRDR_FORMAT));
|
|
|
|
if (!formats)
|
|
{
|
|
WLog_ERR(TAG, "calloc failed!");
|
|
return CHANNEL_RC_NO_MEMORY;
|
|
}
|
|
|
|
formatList.formats = formats;
|
|
|
|
while (dataLen)
|
|
{
|
|
Stream_Read_UINT32(s, formats[index].formatId); /* formatId (4 bytes) */
|
|
dataLen -= 4;
|
|
|
|
formats[index].formatName = NULL;
|
|
|
|
wszFormatName = (WCHAR*) Stream_Pointer(s);
|
|
|
|
if (!wszFormatName[0])
|
|
formatNameLength = 0;
|
|
else
|
|
formatNameLength = _wcslen(wszFormatName);
|
|
|
|
if (formatNameLength)
|
|
{
|
|
if (ConvertFromUnicode(CP_UTF8, 0, wszFormatName, -1,
|
|
&(formats[index].formatName), 0, NULL, NULL) < 1)
|
|
{
|
|
WLog_ERR(TAG, "failed to convert long clipboard format name");
|
|
error = ERROR_INTERNAL_ERROR;
|
|
goto error_out;
|
|
}
|
|
}
|
|
|
|
Stream_Seek(s, (formatNameLength + 1) * 2);
|
|
dataLen -= ((formatNameLength + 1) * 2);
|
|
|
|
index++;
|
|
}
|
|
}
|
|
|
|
WLog_Print(cliprdr->log, WLOG_DEBUG, "ServerFormatList: numFormats: %"PRIu32"",
|
|
formatList.numFormats);
|
|
|
|
if (context->ServerFormatList)
|
|
{
|
|
if ((error = context->ServerFormatList(context, &formatList)))
|
|
WLog_ERR(TAG, "ServerFormatList failed with error %"PRIu32"", error);
|
|
}
|
|
|
|
error_out:
|
|
if (formats)
|
|
{
|
|
for (index = 0; index < formatList.numFormats; index++)
|
|
{
|
|
free(formats[index].formatName);
|
|
}
|
|
|
|
free(formats);
|
|
}
|
|
return error;
|
|
}
|
|
|
|
/**
|
|
* Function description
|
|
*
|
|
* @return 0 on success, otherwise a Win32 error code
|
|
*/
|
|
UINT cliprdr_process_format_list_response(cliprdrPlugin* cliprdr, wStream* s, UINT32 dataLen, UINT16 msgFlags)
|
|
{
|
|
CLIPRDR_FORMAT_LIST_RESPONSE formatListResponse;
|
|
CliprdrClientContext* context = cliprdr_get_client_interface(cliprdr);
|
|
UINT error = CHANNEL_RC_OK;
|
|
|
|
WLog_Print(cliprdr->log, WLOG_DEBUG, "ServerFormatListResponse");
|
|
|
|
if (!context->custom)
|
|
{
|
|
WLog_ERR(TAG, "context->custom not set!");
|
|
return ERROR_INTERNAL_ERROR;
|
|
}
|
|
|
|
formatListResponse.msgType = CB_FORMAT_LIST_RESPONSE;
|
|
formatListResponse.msgFlags = msgFlags;
|
|
formatListResponse.dataLen = dataLen;
|
|
|
|
IFCALLRET(context->ServerFormatListResponse, error, context, &formatListResponse);
|
|
if (error)
|
|
WLog_ERR(TAG, "ServerFormatListResponse failed with error %"PRIu32"!", error);
|
|
|
|
return error;
|
|
}
|
|
|
|
/**
|
|
* Function description
|
|
*
|
|
* @return 0 on success, otherwise a Win32 error code
|
|
*/
|
|
UINT cliprdr_process_format_data_request(cliprdrPlugin* cliprdr, wStream* s, UINT32 dataLen, UINT16 msgFlags)
|
|
{
|
|
CLIPRDR_FORMAT_DATA_REQUEST formatDataRequest;
|
|
CliprdrClientContext* context = cliprdr_get_client_interface(cliprdr);
|
|
UINT error = CHANNEL_RC_OK;
|
|
|
|
WLog_Print(cliprdr->log, WLOG_DEBUG, "ServerFormatDataRequest");
|
|
|
|
if (!context->custom)
|
|
{
|
|
WLog_ERR(TAG, "context->custom not set!");
|
|
return ERROR_INTERNAL_ERROR;
|
|
}
|
|
|
|
formatDataRequest.msgType = CB_FORMAT_DATA_REQUEST;
|
|
formatDataRequest.msgFlags = msgFlags;
|
|
formatDataRequest.dataLen = dataLen;
|
|
|
|
Stream_Read_UINT32(s, formatDataRequest.requestedFormatId); /* requestedFormatId (4 bytes) */
|
|
|
|
|
|
IFCALLRET(context->ServerFormatDataRequest, error, context, &formatDataRequest);
|
|
if (error)
|
|
WLog_ERR(TAG, "ServerFormatDataRequest failed with error %"PRIu32"!", error);
|
|
|
|
return error;
|
|
}
|
|
|
|
/**
|
|
* Function description
|
|
*
|
|
* @return 0 on success, otherwise a Win32 error code
|
|
*/
|
|
UINT cliprdr_process_format_data_response(cliprdrPlugin* cliprdr, wStream* s, UINT32 dataLen, UINT16 msgFlags)
|
|
{
|
|
CLIPRDR_FORMAT_DATA_RESPONSE formatDataResponse;
|
|
CliprdrClientContext* context = cliprdr_get_client_interface(cliprdr);
|
|
UINT error = CHANNEL_RC_OK;
|
|
|
|
WLog_Print(cliprdr->log, WLOG_DEBUG, "ServerFormatDataResponse");
|
|
|
|
if (!context->custom)
|
|
{
|
|
WLog_ERR(TAG, "context->custom not set!");
|
|
return ERROR_INTERNAL_ERROR;
|
|
}
|
|
|
|
formatDataResponse.msgType = CB_FORMAT_DATA_RESPONSE;
|
|
formatDataResponse.msgFlags = msgFlags;
|
|
formatDataResponse.dataLen = dataLen;
|
|
formatDataResponse.requestedFormatData = NULL;
|
|
|
|
if (dataLen)
|
|
formatDataResponse.requestedFormatData = (BYTE*) Stream_Pointer(s);
|
|
|
|
IFCALLRET(context->ServerFormatDataResponse, error, context, &formatDataResponse);
|
|
if (error)
|
|
WLog_ERR(TAG, "ServerFormatDataResponse failed with error %"PRIu32"!", error);
|
|
|
|
return error;
|
|
}
|
|
|
|
static UINT64 filetime_to_uint64(FILETIME value)
|
|
{
|
|
UINT64 converted = 0;
|
|
converted |= (UINT32) value.dwHighDateTime;
|
|
converted <<= 32;
|
|
converted |= (UINT32) value.dwLowDateTime;
|
|
return converted;
|
|
}
|
|
|
|
static FILETIME uint64_to_filetime(UINT64 value)
|
|
{
|
|
FILETIME converted;
|
|
converted.dwLowDateTime = (UINT32) (value >> 0);
|
|
converted.dwHighDateTime = (UINT32) (value >> 32);
|
|
return converted;
|
|
}
|
|
|
|
#define CLIPRDR_FILEDESCRIPTOR_SIZE (4 + 32 + 4 + 16 + 8 + 8 + 520)
|
|
|
|
/**
|
|
* Parse a packed file list.
|
|
*
|
|
* The resulting array must be freed with the `free()` function.
|
|
*
|
|
* @param [in] format_data packed `CLIPRDR_FILELIST` to parse.
|
|
* @param [in] format_data_length length of `format_data` in bytes.
|
|
* @param [out] file_descriptor_array parsed array of `FILEDESCRIPTOR` structs.
|
|
* @param [out] file_descriptor_count number of elements in `file_descriptor_array`.
|
|
*
|
|
* @returns 0 on success, otherwise a Win32 error code.
|
|
*/
|
|
UINT cliprdr_parse_file_list(const BYTE* format_data, UINT32 format_data_length,
|
|
FILEDESCRIPTOR** file_descriptor_array, UINT32* file_descriptor_count)
|
|
{
|
|
UINT result = NO_ERROR;
|
|
UINT32 i;
|
|
UINT32 count = 0;
|
|
wStream* s = NULL;
|
|
|
|
if (!format_data || !file_descriptor_array || !file_descriptor_count)
|
|
return ERROR_BAD_ARGUMENTS;
|
|
|
|
s = Stream_New((BYTE*) format_data, format_data_length);
|
|
if (!s)
|
|
return ERROR_NOT_ENOUGH_MEMORY;
|
|
|
|
if (Stream_GetRemainingLength(s) < 4)
|
|
{
|
|
WLog_ERR(TAG, "invalid packed file list");
|
|
|
|
result = ERROR_INCORRECT_SIZE;
|
|
goto out;
|
|
}
|
|
|
|
Stream_Read_UINT32(s, count); /* cItems (4 bytes) */
|
|
|
|
if (Stream_GetRemainingLength(s) < count * CLIPRDR_FILEDESCRIPTOR_SIZE)
|
|
{
|
|
WLog_ERR(TAG, "packed file list is too short: expected %"PRIu32", have %"PRIuz,
|
|
count * CLIPRDR_FILEDESCRIPTOR_SIZE,
|
|
Stream_GetRemainingLength(s));
|
|
|
|
result = ERROR_INCORRECT_SIZE;
|
|
goto out;
|
|
}
|
|
|
|
*file_descriptor_count = count;
|
|
*file_descriptor_array = calloc(count, sizeof(FILEDESCRIPTOR));
|
|
if (!*file_descriptor_array)
|
|
{
|
|
result = ERROR_NOT_ENOUGH_MEMORY;
|
|
goto out;
|
|
}
|
|
|
|
for (i = 0; i < count; i++)
|
|
{
|
|
int c;
|
|
UINT64 lastWriteTime;
|
|
FILEDESCRIPTOR* file = &((*file_descriptor_array)[i]);
|
|
|
|
Stream_Read_UINT32(s, file->dwFlags); /* flags (4 bytes) */
|
|
Stream_Seek(s, 32); /* reserved1 (32 bytes) */
|
|
Stream_Read_UINT32(s, file->dwFileAttributes); /* fileAttributes (4 bytes) */
|
|
Stream_Seek(s, 16); /* reserved2 (16 bytes) */
|
|
Stream_Read_UINT64(s, lastWriteTime); /* lastWriteTime (8 bytes) */
|
|
file->ftLastWriteTime = uint64_to_filetime(lastWriteTime);
|
|
Stream_Read_UINT32(s, file->nFileSizeHigh); /* fileSizeHigh (4 bytes) */
|
|
Stream_Read_UINT32(s, file->nFileSizeLow); /* fileSizeLow (4 bytes) */
|
|
for (c = 0; c < 260; c++) /* fileName (520 bytes) */
|
|
Stream_Read_UINT16(s, file->fileName[c]);
|
|
}
|
|
|
|
if (Stream_GetRemainingLength(s) > 0)
|
|
WLog_WARN(TAG, "packed file list has %"PRIuz" excess bytes",
|
|
Stream_GetRemainingLength(s));
|
|
out:
|
|
Stream_Free(s, FALSE);
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Serialize a packed file list.
|
|
*
|
|
* The resulting format data must be freed with the `free()` function.
|
|
*
|
|
* @param [in] file_descriptor_array array of `FILEDESCRIPTOR` structs to serialize.
|
|
* @param [in] file_descriptor_count number of elements in `file_descriptor_array`.
|
|
* @param [out] format_data serialized CLIPRDR_FILELIST.
|
|
* @param [out] format_data_length length of `format_data` in bytes.
|
|
*
|
|
* @returns 0 on success, otherwise a Win32 error code.
|
|
*/
|
|
UINT cliprdr_serialize_file_list(const FILEDESCRIPTOR* file_descriptor_array,
|
|
UINT32 file_descriptor_count, BYTE** format_data, UINT32* format_data_length)
|
|
{
|
|
UINT result = NO_ERROR;
|
|
UINT32 i;
|
|
wStream* s = NULL;
|
|
|
|
if (!file_descriptor_array || !format_data || !format_data_length)
|
|
return ERROR_BAD_ARGUMENTS;
|
|
|
|
s = Stream_New(NULL, 4 + file_descriptor_count * CLIPRDR_FILEDESCRIPTOR_SIZE);
|
|
if (!s)
|
|
return ERROR_NOT_ENOUGH_MEMORY;
|
|
|
|
Stream_Write_UINT32(s, file_descriptor_count); /* cItems (4 bytes) */
|
|
|
|
for (i = 0; i < file_descriptor_count; i++)
|
|
{
|
|
int c;
|
|
UINT64 lastWriteTime;
|
|
const FILEDESCRIPTOR* file = &file_descriptor_array[i];
|
|
|
|
Stream_Write_UINT32(s, file->dwFlags); /* flags (4 bytes) */
|
|
Stream_Zero(s, 32); /* reserved1 (32 bytes) */
|
|
Stream_Write_UINT32(s, file->dwFileAttributes); /* fileAttributes (4 bytes) */
|
|
Stream_Zero(s, 16); /* reserved2 (16 bytes) */
|
|
lastWriteTime = filetime_to_uint64(file->ftLastWriteTime);
|
|
Stream_Write_UINT64(s, lastWriteTime); /* lastWriteTime (8 bytes) */
|
|
Stream_Write_UINT32(s, file->nFileSizeHigh); /* fileSizeHigh (4 bytes) */
|
|
Stream_Write_UINT32(s, file->nFileSizeLow); /* fileSizeLow (4 bytes) */
|
|
for (c = 0; c < 260; c++) /* fileName (520 bytes) */
|
|
Stream_Write_UINT16(s, file->fileName[c]);
|
|
}
|
|
|
|
Stream_SealLength(s);
|
|
|
|
Stream_GetBuffer(s, *format_data);
|
|
Stream_GetLength(s, *format_data_length);
|
|
|
|
Stream_Free(s, FALSE);
|
|
|
|
return result;
|
|
}
|