impl/src/string_util.c

/*
 * Copyright (C) 2021-2025 Huawei Device Co., Ltd.
 * 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.
 */

#include "string_util.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include "securec.h"
#include "clib_error.h"
#include "hc_types.h"
#include "hc_log.h"

#define OUT_OF_HEX 16
#define NUMBER_9_IN_DECIMAL 9
#define ASCII_CASE_DIFFERENCE_VALUE 32
#define MIN_ANONYMOUS_LEN 12
#define ANONYMOUS_ASTERISK_LEN 2
#define ANONYMOUS_DIVIDER 2

static char HexToChar(uint8_t hex)
{
    return (hex > NUMBER_9_IN_DECIMAL) ? (hex + 0x37) : (hex + 0x30); /* Convert to the corresponding character */
}

int32_t ByteToHexString(const uint8_t *byte, uint32_t byteLen, char *hexStr, uint32_t hexLen)
{
    if (byte == NULL || hexStr == NULL) {
        return CLIB_ERR_NULL_PTR;
    }
    /* The terminator('\0') needs 1 bit */
    if (hexLen < byteLen * BYTE_TO_HEX_OPER_LENGTH + 1) {
        return CLIB_ERR_INVALID_LEN;
    }

    for (uint32_t i = 0; i < byteLen; i++) {
        hexStr[i * BYTE_TO_HEX_OPER_LENGTH] = HexToChar((byte[i] & 0xF0) >> 4); /* 4: shift right for filling */
        hexStr[i * BYTE_TO_HEX_OPER_LENGTH + 1] = HexToChar(byte[i] & 0x0F); /* get low four bits */
    }
    hexStr[byteLen * BYTE_TO_HEX_OPER_LENGTH] = '\0';

    return CLIB_SUCCESS;
}

static uint8_t CharToHex(char c)
{
    if ((c >= 'A') && (c <= 'F')) {
        return (c - 'A' + DEC);
    } else if ((c >= 'a') && (c <= 'f')) {
        return (c - 'a' + DEC);
    } else if ((c >= '0') && (c <= '9')) {
        return (c - '0');
    } else {
        return OUT_OF_HEX;
    }
}

int32_t HexStringToByte(const char *hexStr, uint8_t *byte, uint32_t byteLen)
{
    if (byte == NULL || hexStr == NULL) {
        return CLIB_ERR_NULL_PTR;
    }
    uint32_t realHexLen = HcStrlen(hexStr);
    /* even number or not */
    if (realHexLen % BYTE_TO_HEX_OPER_LENGTH != 0 || byteLen < realHexLen / BYTE_TO_HEX_OPER_LENGTH) {
        return CLIB_ERR_INVALID_LEN;
    }

    for (uint32_t i = 0; i < realHexLen / BYTE_TO_HEX_OPER_LENGTH; i++) {
        uint8_t high = CharToHex(hexStr[i * BYTE_TO_HEX_OPER_LENGTH]);
        uint8_t low = CharToHex(hexStr[i * BYTE_TO_HEX_OPER_LENGTH + 1]);
        if (high == OUT_OF_HEX || low == OUT_OF_HEX) {
            return CLIB_ERR_INVALID_PARAM;
        }
        byte[i] = high << 4; /* 4: Set the high nibble */
        byte[i] |= low; /* Set the low nibble */
    }
    return CLIB_SUCCESS;
}

int64_t StringToInt64(const char *cp)
{
    if (cp == NULL) {
        return 0;
    }
    return strtoll(cp, NULL, DEC);
}

int32_t ToUpperCase(const char *oriStr, char **desStr)
{
    if (oriStr == NULL || desStr == NULL) {
        return CLIB_ERR_NULL_PTR;
    }
    uint32_t len = HcStrlen(oriStr);
    *desStr = HcMalloc(len + 1, 0);
    if (*desStr == NULL) {
        return CLIB_ERR_BAD_ALLOC;
    }
    for (uint32_t i = 0; i < len; i++) {
        if ((oriStr[i] >= 'a') && (oriStr[i] <= 'f')) {
            (*desStr)[i] = oriStr[i] - ASCII_CASE_DIFFERENCE_VALUE;
        } else {
            (*desStr)[i] = oriStr[i];
        }
    }
    return CLIB_SUCCESS;
}

int32_t DeepCopyString(const char *str, char **newStr)
{
    if (str == NULL || newStr == NULL) {
        return CLIB_ERR_NULL_PTR;
    }
    uint32_t len = HcStrlen(str);
    if (len == 0) {
        return CLIB_ERR_INVALID_LEN;
    }
    char *val = (char *)HcMalloc(len + 1, 0);
    if (val == NULL) {
        return CLIB_ERR_BAD_ALLOC;
    }
    (void)memcpy_s(val, len, str, len);
    *newStr = val;
    return CLIB_SUCCESS;
}

void PrintBuffer(const uint8_t *msgBuff, uint32_t msgLen, const char *msgTag)
{
    uint32_t hexLen = msgLen * BYTE_TO_HEX_OPER_LENGTH + 1;
    char *hexStr = (char *)HcMalloc(hexLen, 0);
    if (hexStr == NULL) {
        return;
    }
    (void)ByteToHexString(msgBuff, msgLen, hexStr, hexLen);
    LOGD("%" LOG_PUB "s value is: %" LOG_PUB "s", msgTag, hexStr);
    HcFree(hexStr);
}

int32_t GetAnonymousString(const char *originStr, char *anonymousStr, uint32_t anonymousLen)
{
    if (originStr == NULL || anonymousStr == NULL) {
        return CLIB_ERR_NULL_PTR;
    }
    if (anonymousLen < MIN_ANONYMOUS_LEN || (anonymousLen - ANONYMOUS_ASTERISK_LEN) % ANONYMOUS_DIVIDER != 0) {
        return CLIB_ERR_INVALID_LEN;
    }
    uint32_t originStrLen = HcStrlen(originStr);
    if (originStrLen < anonymousLen - ANONYMOUS_ASTERISK_LEN) {
        return CLIB_ERR_INVALID_LEN;
    }
    uint32_t printLen = (anonymousLen - ANONYMOUS_ASTERISK_LEN) / ANONYMOUS_DIVIDER;
    if (memcpy_s(anonymousStr, printLen, originStr, printLen) != EOK) {
        return CLIB_ERR_BAD_ALLOC;
    }
    if (memcpy_s(anonymousStr + printLen, ANONYMOUS_ASTERISK_LEN, "**", ANONYMOUS_ASTERISK_LEN) != EOK) {
        return CLIB_ERR_BAD_ALLOC;
    }
    if (memcpy_s(anonymousStr + printLen + ANONYMOUS_ASTERISK_LEN, printLen,
        originStr + originStrLen - printLen, printLen) != EOK) {
        return CLIB_ERR_BAD_ALLOC;
    }
    return CLIB_SUCCESS;
}

bool IsStrEqual(const char *str1, const char *str2)
{
    if (str1 == NULL || str2 == NULL) {
        return false;
    }

    return strcmp(str1, str2) == 0;
}