capture.c File Reference

#include "csrlib.h"
#include <debug.h>

Include dependency graph for capture.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
VOID NTAPI	CsrProbeForRead (_In_ PVOID Address, _In_ ULONG Length, _In_ ULONG Alignment)
VOID NTAPI	CsrProbeForWrite (_In_ PVOID Address, _In_ ULONG Length, _In_ ULONG Alignment)
PCSR_CAPTURE_BUFFER NTAPI	CsrAllocateCaptureBuffer (_In_ ULONG ArgumentCount, _In_ ULONG BufferSize)
ULONG NTAPI	CsrAllocateMessagePointer (_Inout_ PCSR_CAPTURE_BUFFER CaptureBuffer, _In_ ULONG MessageLength, _Out_ PVOID *CapturedData)
VOID NTAPI	CsrCaptureMessageBuffer (_Inout_ PCSR_CAPTURE_BUFFER CaptureBuffer, _In_opt_ PVOID MessageBuffer, _In_ ULONG MessageLength, _Out_ PVOID *CapturedData)
VOID NTAPI	CsrFreeCaptureBuffer (_In_ _Frees_ptr_ PCSR_CAPTURE_BUFFER CaptureBuffer)
VOID NTAPI	CsrCaptureMessageString (_Inout_ PCSR_CAPTURE_BUFFER CaptureBuffer, _In_opt_ PCSTR String, _In_ ULONG StringLength, _In_ ULONG MaximumLength, _Out_ PSTRING CapturedString)
VOID NTAPI	CsrCaptureMessageUnicodeStringInPlace (_Inout_ PCSR_CAPTURE_BUFFER CaptureBuffer, _Inout_ PUNICODE_STRING String)
NTSTATUS NTAPI	CsrCaptureMessageMultiUnicodeStringsInPlace (_Inout_ PCSR_CAPTURE_BUFFER *CaptureBuffer, _In_ ULONG StringsCount, _In_ PUNICODE_STRING *MessageStrings)
PLARGE_INTEGER NTAPI	CsrCaptureTimeout (_In_ ULONG Milliseconds, _Out_ PLARGE_INTEGER Timeout)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 13 of file capture.c.

Function Documentation

CsrAllocateCaptureBuffer()

PCSR_CAPTURE_BUFFER NTAPI CsrAllocateCaptureBuffer	(	_In_ ULONG	ArgumentCount,
		_In_ ULONG	BufferSize
	)

Definition at line 87 of file capture.c.

{
    PCSR_CAPTURE_BUFFER CaptureBuffer;
    ULONG OffsetsArraySize;
    ULONG MaximumSize;
 
    /* Validate the argument count. Note that on server side, CSRSRV
     * limits the count to MAXUSHORT; here we are a bit more lenient. */
    if (ArgumentCount > (MAXLONG / sizeof(ULONG_PTR)))
        return NULL;
 
    OffsetsArraySize = ArgumentCount * sizeof(ULONG_PTR);
 
    /*
     * Validate the total buffer size.
     * The total size of the header plus the pointer-offset array and the
     * provided buffer, together with the alignment padding for each argument,
     * must be less than MAXLONG aligned to 4-byte boundary.
     */
    MaximumSize = (MAXLONG & ~3) - FIELD_OFFSET(CSR_CAPTURE_BUFFER, PointerOffsetsArray);
    if (OffsetsArraySize >= MaximumSize)
        return NULL;
    MaximumSize -= OffsetsArraySize;
    if (BufferSize >= MaximumSize)
        return NULL;
    MaximumSize -= BufferSize;
    if ((ArgumentCount * 3) + 3 >= MaximumSize)
        return NULL;
 
    /* Add the size of the header and of the pointer-offset array */
    BufferSize += FIELD_OFFSET(CSR_CAPTURE_BUFFER, PointerOffsetsArray) +
                    OffsetsArraySize;
 
    /* Add the size of the alignment padding for each argument */
    BufferSize += ArgumentCount * 3;
 
    /* Align it to a 4-byte boundary */
    BufferSize = (BufferSize + 3) & ~3;
 
    /* Allocate memory from the port heap */
    CaptureBuffer = RtlAllocateHeap(CsrPortHeap, HEAP_ZERO_MEMORY, BufferSize);
    if (CaptureBuffer == NULL) return NULL;
 
    /* Initialize the header */
    CaptureBuffer->Size = BufferSize;
    CaptureBuffer->PointerCount = 0;
 
    /* Initialize the pointer-offset array */
    RtlZeroMemory(CaptureBuffer->PointerOffsetsArray, OffsetsArraySize);
 
    /* Point to the start of the free buffer */
    CaptureBuffer->BufferEnd = (PVOID)((ULONG_PTR)CaptureBuffer->PointerOffsetsArray +
                                       OffsetsArraySize);
 
    /* Return the address of the buffer */
    return CaptureBuffer;
}

Referenced by BaseCheckVDM(), CreateConsoleScreenBuffer(), CsrCaptureMessageMultiUnicodeStringsInPlace(), CsrClientConnectToServer(), DefineDosDeviceW(), DeviceEventWorker(), GetConsoleFontInfo(), GetConsoleProcessList(), GetNextVDMCommand(), GetVDMCurrentDirectories(), IntAddConsoleAlias(), IntAllocConsole(), IntAttachConsole(), IntExpungeConsoleCommandHistory(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasesLength(), IntGetConsoleAliasExes(), IntGetConsoleCommandHistory(), IntGetConsoleCommandHistoryLength(), IntGetConsoleInput(), IntGetConsoleTitle(), IntReadConsole(), IntReadConsoleOutput(), IntReadConsoleOutputCode(), IntRegisterConsoleIME(), IntSetConsoleNumberOfCommands(), IntSetConsoleTitle(), IntWriteConsole(), IntWriteConsoleInput(), IntWriteConsoleOutput(), IntWriteConsoleOutputCode(), RegisterConsoleVDM(), and SetVDMCurrentDirectories().

CsrAllocateMessagePointer()

ULONG NTAPI CsrAllocateMessagePointer	(	_Inout_ PCSR_CAPTURE_BUFFER	CaptureBuffer,
		_In_ ULONG	MessageLength,
		_Out_ PVOID *	CapturedData
	)

Definition at line 152 of file capture.c.

{
    if (MessageLength == 0)
    {
        *CapturedData = NULL;
        CapturedData = NULL;
    }
    else
    {
        /* Set the capture data at our current available buffer */
        *CapturedData = CaptureBuffer->BufferEnd;
 
        /* Validate the size */
        if (MessageLength >= MAXLONG) return 0;
 
        /* Align it to a 4-byte boundary */
        MessageLength = (MessageLength + 3) & ~3;
 
        /* Move our available buffer beyond this space */
        CaptureBuffer->BufferEnd = (PVOID)((ULONG_PTR)CaptureBuffer->BufferEnd + MessageLength);
    }
 
    /* Write down this pointer in the array and increase the count */
    CaptureBuffer->PointerOffsetsArray[CaptureBuffer->PointerCount++] = (ULONG_PTR)CapturedData;
 
    /* Return the aligned length */
    return MessageLength;
}

Referenced by CsrCaptureMessageBuffer(), CsrCaptureMessageString(), DefineDosDeviceW(), GetConsoleFontInfo(), GetConsoleProcessList(), GetNextVDMCommand(), GetVDMCurrentDirectories(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasExes(), IntGetConsoleCommandHistory(), IntGetConsoleInput(), IntGetConsoleTitle(), IntReadConsole(), IntReadConsoleOutput(), IntReadConsoleOutputCode(), and IntWriteConsoleOutput().

CsrCaptureMessageBuffer()

VOID NTAPI CsrCaptureMessageBuffer	(	_Inout_ PCSR_CAPTURE_BUFFER	CaptureBuffer,
		_In_opt_ PVOID	MessageBuffer,
		_In_ ULONG	MessageLength,
		_Out_ PVOID *	CapturedData
	)

Definition at line 189 of file capture.c.

{
    /* Simply allocate a message pointer in the buffer */
    CsrAllocateMessagePointer(CaptureBuffer, MessageLength, CapturedData);
 
    /* Check if there was any data */
    if (!MessageBuffer || !MessageLength) return;
 
    /* Copy the data into the buffer */
    RtlMoveMemory(*CapturedData, MessageBuffer, MessageLength);
}

Referenced by BaseCheckVDM(), CreateConsoleScreenBuffer(), CsrClientConnectToServer(), DeviceEventWorker(), IntAddConsoleAlias(), IntAllocConsole(), IntAttachConsole(), IntExpungeConsoleCommandHistory(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasesLength(), IntGetConsoleCommandHistory(), IntGetConsoleCommandHistoryLength(), IntRegisterConsoleIME(), IntSetConsoleNumberOfCommands(), IntSetConsoleTitle(), IntWriteConsole(), IntWriteConsoleInput(), IntWriteConsoleOutputCode(), RegisterConsoleVDM(), and SetVDMCurrentDirectories().

CsrCaptureMessageMultiUnicodeStringsInPlace()

NTSTATUS NTAPI CsrCaptureMessageMultiUnicodeStringsInPlace	(	_Inout_ PCSR_CAPTURE_BUFFER *	CaptureBuffer,
		_In_ ULONG	StringsCount,
		_In_ PUNICODE_STRING *	MessageStrings
	)

Definition at line 294 of file capture.c.

{
    ULONG Count;
 
    if (!CaptureBuffer) return STATUS_INVALID_PARAMETER;
 
    /* Allocate a new capture buffer if we don't have one already */
    if (!*CaptureBuffer)
    {
        /* Compute the required size for the capture buffer */
        ULONG Size = 0;
 
        Count = 0;
        while (Count < StringsCount)
        {
            if (MessageStrings[Count])
                Size += MessageStrings[Count]->MaximumLength;
 
            ++Count;
        }
 
        /* Allocate the capture buffer */
        *CaptureBuffer = CsrAllocateCaptureBuffer(StringsCount, Size);
        if (!*CaptureBuffer) return STATUS_NO_MEMORY;
    }
 
    /* Now capture each UNICODE string */
    Count = 0;
    while (Count < StringsCount)
    {
        if (MessageStrings[Count])
            CsrCaptureMessageUnicodeStringInPlace(*CaptureBuffer, MessageStrings[Count]);
 
        ++Count;
    }
 
    return STATUS_SUCCESS;
}

CsrCaptureMessageString()

VOID NTAPI CsrCaptureMessageString	(	_Inout_ PCSR_CAPTURE_BUFFER	CaptureBuffer,
		_In_opt_ PCSTR	String,
		_In_ ULONG	StringLength,
		_In_ ULONG	MaximumLength,
		_Out_ PSTRING	CapturedString
	)

Definition at line 222 of file capture.c.

{
    ASSERT(CapturedString != NULL);
 
    /*
     * If we don't have a string, initialize an empty one,
     * otherwise capture the given string.
     */
    if (!String)
    {
        CapturedString->Length = 0;
        CapturedString->MaximumLength = (USHORT)MaximumLength;
 
        /* Allocate a pointer for it */
        CsrAllocateMessagePointer(CaptureBuffer,
                                  MaximumLength,
                                  (PVOID*)&CapturedString->Buffer);
    }
    else
    {
        /* Cut-off the string length if needed */
        if (StringLength > MaximumLength)
            StringLength = MaximumLength;
 
        CapturedString->Length = (USHORT)StringLength;
 
        /* Allocate a buffer and get its size */
        CapturedString->MaximumLength =
            (USHORT)CsrAllocateMessagePointer(CaptureBuffer,
                                              MaximumLength,
                                              (PVOID*)&CapturedString->Buffer);
 
        /* If the string has data, copy it into the buffer */
        if (StringLength)
            RtlMoveMemory(CapturedString->Buffer, String, StringLength);
    }
 
    /* Null-terminate the string if we don't take up the whole space */
    if (CapturedString->Length < CapturedString->MaximumLength)
        CapturedString->Buffer[CapturedString->Length] = ANSI_NULL;
}

Referenced by CsrCaptureMessageUnicodeStringInPlace().

CsrCaptureMessageUnicodeStringInPlace()

VOID NTAPI CsrCaptureMessageUnicodeStringInPlace	(	_Inout_ PCSR_CAPTURE_BUFFER	CaptureBuffer,
		_Inout_ PUNICODE_STRING	String
	)

Definition at line 271 of file capture.c.

{
    ASSERT(String != NULL);
 
    /* This is a way to capture the UNICODE string, since (Maximum)Length are also in bytes */
    CsrCaptureMessageString(CaptureBuffer,
                            (PCSTR)String->Buffer,
                            String->Length,
                            String->MaximumLength,
                            (PSTRING)String);
 
    /* Null-terminate the string if we don't take up the whole space */
    if (String->Length + sizeof(WCHAR) <= String->MaximumLength)
        String->Buffer[String->Length / sizeof(WCHAR)] = UNICODE_NULL;
}

Referenced by CsrCaptureMessageMultiUnicodeStringsInPlace().

CsrCaptureTimeout()

PLARGE_INTEGER NTAPI CsrCaptureTimeout	(	_In_ ULONG	Milliseconds,
		_Out_ PLARGE_INTEGER	Timeout
	)

Definition at line 341 of file capture.c.

{
    /* Validate the time */
    if (Milliseconds == -1) return NULL;
 
    /* Convert to relative ticks */
    Timeout->QuadPart = Milliseconds * -10000LL;
    return Timeout;
}

CsrFreeCaptureBuffer()

VOID NTAPI CsrFreeCaptureBuffer

(

_In_ _Frees_ptr_ PCSR_CAPTURE_BUFFER

CaptureBuffer

)

Definition at line 210 of file capture.c.

{
    /* Free it from the heap */
    RtlFreeHeap(CsrPortHeap, 0, CaptureBuffer);
}

Referenced by BaseCheckVDM(), CreateConsoleScreenBuffer(), CreateProcessInternalW(), CsrClientConnectToServer(), DefineDosDeviceW(), DeviceEventWorker(), GetConsoleFontInfo(), GetConsoleProcessList(), GetNextVDMCommand(), GetVDMCurrentDirectories(), IntAddConsoleAlias(), IntAllocConsole(), IntAttachConsole(), IntExpungeConsoleCommandHistory(), IntGetConsoleAlias(), IntGetConsoleAliases(), IntGetConsoleAliasesLength(), IntGetConsoleAliasExes(), IntGetConsoleCommandHistory(), IntGetConsoleCommandHistoryLength(), IntGetConsoleInput(), IntGetConsoleTitle(), IntReadConsole(), IntReadConsoleOutput(), IntReadConsoleOutputCode(), IntRegisterConsoleIME(), IntSetConsoleNumberOfCommands(), IntSetConsoleTitle(), IntWriteConsole(), IntWriteConsoleInput(), IntWriteConsoleOutput(), IntWriteConsoleOutputCode(), RegisterConsoleVDM(), and SetVDMCurrentDirectories().

CsrProbeForRead()

VOID NTAPI CsrProbeForRead	(	_In_ PVOID	Address,
		_In_ ULONG	Length,
		_In_ ULONG	Alignment
	)

Definition at line 23 of file capture.c.

{
    volatile UCHAR *Pointer;
    UCHAR Data;
 
    /* Validate length */
    if (Length == 0) return;
 
    /* Validate alignment */
    if ((ULONG_PTR)Address & (Alignment - 1))
    {
        /* Raise exception if it doesn't match */
        RtlRaiseStatus(STATUS_DATATYPE_MISALIGNMENT);
    }
 
    /* Probe first byte */
    Pointer = Address;
    Data = *Pointer;
 
    /* Probe last byte */
    Pointer = (PUCHAR)Address + Length - 1;
    Data = *Pointer;
    (void)Data;
}

CsrProbeForWrite()

VOID NTAPI CsrProbeForWrite	(	_In_ PVOID	Address,
		_In_ ULONG	Length,
		_In_ ULONG	Alignment
	)

Definition at line 56 of file capture.c.

{
    volatile UCHAR *Pointer;
 
    /* Validate length */
    if (Length == 0) return;
 
    /* Validate alignment */
    if ((ULONG_PTR)Address & (Alignment - 1))
    {
        /* Raise exception if it doesn't match */
        RtlRaiseStatus(STATUS_DATATYPE_MISALIGNMENT);
    }
 
    /* Probe first byte */
    Pointer = Address;
    *Pointer = *Pointer;
 
    /* Probe last byte */
    Pointer = (PUCHAR)Address + Length - 1;
    *Pointer = *Pointer;
}