mirror of
https://github.com/rapid7/metasploit-payloads
synced 2025-03-24 18:16:24 +01:00
719dbe2b51
* Updated `thread_create` so that it has 3 parameters, and removed `thread_create3`. * Updated all calls to `thread_create` and added the extra parameter of `NULL`. * Fixed comment typo. * Removed assignment where value is not used. * Checked for `NULL` prior to setting the result. * Undefined `DEBUGTRACE`.
106 lines
4.4 KiB
C
106 lines
4.4 KiB
C
/*!
|
|
* @file base.h
|
|
* @brief Declarations, macros and types that apply to almost any Meterpreter component.
|
|
*/
|
|
#ifndef _METERPRETER_BASE_H
|
|
#define _METERPRETER_BASE_H
|
|
|
|
#include "linkage.h"
|
|
#include "core.h"
|
|
|
|
/*! @brief Function pointer type that defines the interface for a dispatch handler. */
|
|
typedef DWORD (*DISPATCH_ROUTINE)( Remote *remote, Packet *packet );
|
|
typedef BOOL (*INLINE_DISPATCH_ROUTINE)( Remote *remote, Packet *packet, DWORD* result);
|
|
|
|
/*! @brief Specifies the maximum number of arguments that are checked/handled
|
|
* in a request/response packet dispatcher.
|
|
*/
|
|
#define MAX_CHECKED_ARGUMENTS 16
|
|
|
|
/*! @brief Flag indicating that the command arguments repeat. */
|
|
#define ARGUMENT_FLAG_REPEAT (1 << 28)
|
|
/*! @brief Mask indicating the range numbers allowed for command arguments. */
|
|
#define ARGUMENT_FLAG_MASK 0x0fffffff
|
|
|
|
/*! @brief Helper macro that contains the required NULL initialisations for a command handler TLV info. */
|
|
#define EMPTY_TLV { 0 }, 0
|
|
/*! @brief Helper macro which defines an empty dispatch handler. */
|
|
#define EMPTY_DISPATCH_HANDLER NULL, NULL, EMPTY_TLV
|
|
/*! @brief Helper macro that defines terminator for command lists. */
|
|
#define COMMAND_TERMINATOR { NULL, { EMPTY_DISPATCH_HANDLER }, { EMPTY_DISPATCH_HANDLER } }
|
|
|
|
/*!
|
|
* @brief Helper macro that defines a command instance with a request handler only.
|
|
* @remarks The request handler will be executed on a separate thread.
|
|
*/
|
|
#define COMMAND_REQ(name, reqHandler) { name, { reqHandler, NULL, EMPTY_TLV }, { EMPTY_DISPATCH_HANDLER } }
|
|
/*!
|
|
* @brief Helper macro that defines a command instance with a response handler only.
|
|
* @remarks The request handler will be executed on a separate thread.
|
|
*/
|
|
#define COMMAND_REP(name, repHandler) { name, { EMPTY_DISPATCH_HANDLER }, { repHandler, NULL, EMPTY_TLV } }
|
|
/*!
|
|
* @brief Helper macro that defines a command instance with both a request and response handler.
|
|
* @remarks The request handler will be executed on a separate thread.
|
|
*/
|
|
#define COMMAND_REQ_REP(name, reqHandler, repHandler) { name, { reqHandler, NULL, EMPTY_TLV }, { repHandler, NULL, EMPTY_TLV } }
|
|
/*!
|
|
* @brief Helper macro that defines a command instance with an inline request handler only.
|
|
* @remarks The request handler will be executed on the server thread.
|
|
*/
|
|
#define COMMAND_INLINE_REQ(name, reqHandler) { name, { NULL, reqHandler, EMPTY_TLV }, { EMPTY_DISPATCH_HANDLER } }
|
|
|
|
// Place holders
|
|
/*! @deprecated This entity is not used and may be removed in future. */
|
|
#define EXPORT_TABLE_BEGIN()
|
|
/*! @deprecated This entity is not used and may be removed in future. */
|
|
#define EXPORT_TABLE_END()
|
|
|
|
/*!
|
|
* @brief Defines a command handler for requests and responses.
|
|
*/
|
|
typedef struct
|
|
{
|
|
/*! @brief Pointer to the routine that will be called to handle the request/response. */
|
|
DISPATCH_ROUTINE handler;
|
|
|
|
/*!
|
|
* @brief Pointer to the routine that will be called on the _current thread_.
|
|
* @remark If this function is specified then it will be invoked on the current server
|
|
* thread rather than having a new thread allocated to it for processing.
|
|
* The result of this routine will indicate whether the server should continue.
|
|
* If this value is specified (ie. non-NULL) then the \c handler value is ignored.
|
|
*/
|
|
INLINE_DISPATCH_ROUTINE inline_handler;
|
|
|
|
/*! @brief Array of types that match the expected arguments for this response/request routine. */
|
|
TlvMetaType argumentTypes[MAX_CHECKED_ARGUMENTS];
|
|
/*! @brief The number of entries in the \c argumentTypes array. */
|
|
DWORD numArgumentTypes;
|
|
} PacketDispatcher;
|
|
|
|
/*!
|
|
* @brief Container for a command definition.
|
|
*/
|
|
typedef struct command
|
|
{
|
|
LPCSTR method; ///< Identifier for the command.
|
|
PacketDispatcher request; ///< Defines the request handler.
|
|
PacketDispatcher response; ///< Defines the response handler.
|
|
|
|
// Internal -- not stored
|
|
struct command *next; ///< Pointer to the next command in the command list.
|
|
struct command *prev; ///< Pointer to the previous command in the command list.
|
|
} Command;
|
|
|
|
LINKAGE void command_register_all(Command commands[]);
|
|
LINKAGE void command_deregister_all(Command commands[]);
|
|
LINKAGE DWORD command_register(Command *command);
|
|
LINKAGE DWORD command_deregister(Command *command);
|
|
|
|
LINKAGE VOID command_join_threads( VOID );
|
|
|
|
LINKAGE BOOL command_handle( Remote *remote, Packet *packet );
|
|
|
|
#endif
|