mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
228 lines
7.0 KiB
C
228 lines
7.0 KiB
C
/** Copyright (c) 2009 Open Information Security Foundation
|
|
*
|
|
* \author Brian Rectanus <brectanu@gmail.com>
|
|
*/
|
|
|
|
#ifndef __UTIL_BYTE_H__
|
|
#define __UTIL_BYTE_H__
|
|
|
|
#include <stdint.h>
|
|
|
|
#define BYTE_BIG_ENDIAN 0
|
|
#define BYTE_LITTLE_ENDIAN 1
|
|
|
|
/** Wrappers for OS dependent byte swapping functions */
|
|
#ifdef OS_FREEBSD
|
|
#include <sys/endian.h>
|
|
#define SCByteSwap16(x) bswap16(x)
|
|
#define SCByteSwap32(x) bswap32(x)
|
|
#define SCByteSwap64(x) bswap64(x)
|
|
#elif OS_DARWIN
|
|
#include <libkern/OSByteOrder.h>
|
|
#define SCByteSwap16(x) OSSwapInt16(x)
|
|
#define SCByteSwap32(x) OSSwapInt32(x)
|
|
#define SCByteSwap64(x) OSSwapInt64(x)
|
|
#elif OS_WIN32
|
|
/* Quick & dirty solution, nothing seems to exist for this in Win32 API */
|
|
#define SCByteSwap16(x) \
|
|
((((x) & 0xff00) >> 8) \
|
|
| (((x) & 0x00ff) << 8))
|
|
#define SCByteSwap32(x) \
|
|
((((x) & 0xff000000) >> 24) \
|
|
| (((x) & 0x00ff0000) >> 8) \
|
|
| (((x) & 0x0000ff00) << 8) \
|
|
| (((x) & 0x000000ff) << 24))
|
|
#define SCByteSwap64(x) \
|
|
((((x) & 0xff00000000000000ull) >> 56) \
|
|
| (((x) & 0x00ff000000000000ull) >> 40) \
|
|
| (((x) & 0x0000ff0000000000ull) >> 24) \
|
|
| (((x) & 0x000000ff00000000ull) >> 8) \
|
|
| (((x) & 0x00000000ff000000ull) << 8) \
|
|
| (((x) & 0x0000000000ff0000ull) << 24) \
|
|
| (((x) & 0x000000000000ff00ull) << 40) \
|
|
| (((x) & 0x00000000000000ffull) << 56))
|
|
#else
|
|
#include <byteswap.h>
|
|
#define SCByteSwap16(x) bswap_16(x)
|
|
#define SCByteSwap32(x) bswap_32(x)
|
|
#define SCByteSwap64(x) bswap_64(x)
|
|
#endif /* OS_FREEBSD */
|
|
|
|
/**
|
|
* Extract bytes from a byte string and convert to a unint64_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param e Endianness (BYTE_BIG_ENDIAN or BYTE_LITTLE_ENDIAN)
|
|
* \param len Number of bytes to extract (8 max)
|
|
* \param bytes Data to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
int ByteExtractUint64(uint64_t *res, int e, uint16_t len, const uint8_t *bytes);
|
|
|
|
/**
|
|
* Extract bytes from a byte string and convert to a unint32_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param e Endianness (BYTE_BIG_ENDIAN or BYTE_LITTLE_ENDIAN)
|
|
* \param len Number of bytes to extract (8 max)
|
|
* \param bytes Data to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractUint32(uint32_t *res, int e, uint16_t len, const uint8_t *bytes);
|
|
|
|
/**
|
|
* Extract bytes from a byte string and convert to a unint16_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param e Endianness (BYTE_BIG_ENDIAN or BYTE_LITTLE_ENDIAN)
|
|
* \param len Number of bytes to extract (8 max)
|
|
* \param bytes Data to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractUint16(uint16_t *res, int e, uint16_t len, const uint8_t *bytes);
|
|
|
|
/**
|
|
* Extract unsigned integer value from a string.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractString(uint64_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract unsigned integer value from a string as uint64_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param len Number of bytes to extract (23 max)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringUint64(uint64_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract unsigned integer value from a string as uint32_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringUint32(uint32_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract unsigned integer value from a string as uint16_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringUint16(uint16_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract unsigned integer value from a string as uint8_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringUint8(uint8_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract signed integer value from a string.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringSigned(int64_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract signed integer value from a string as uint64_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringInt64(int64_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract signed integer value from a string as uint32_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringInt32(int32_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract signed integer value from a string as uint16_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringInt16(int16_t *res, int base, uint16_t len, const char *str);
|
|
|
|
/**
|
|
* Extract signed integer value from a string as uint8_t.
|
|
*
|
|
* \param res Stores result
|
|
* \param base Base of the number to extract
|
|
* \param len Number of bytes to extract (23 max or 0 for unbounded)
|
|
* \param str String to extract from
|
|
*
|
|
* \return n Number of bytes extracted on success
|
|
* \return -1 On error
|
|
*/
|
|
inline int ByteExtractStringInt8(int8_t *res, int base, uint16_t len, const char *str);
|
|
|
|
#ifdef UNITTESTS
|
|
void ByteRegisterTests(void);
|
|
#endif /* UNITTESTS */
|
|
|
|
|
|
#endif /* __UTIL_BYTE_H__ */
|
|
|