mirror of
https://github.com/openharmony/third_party_openhitls.git
synced 2026-08-24 18:15:59 -04:00
dumb
6979f132dc
- Introduce HITLS_APP_UioOpenPrivate to create key files with 0600 permissions, replacing open-then-chmod pattern to avoid TOCTOU race - Migrate key/PKCS12/rand output paths to use private file creation - Refactor PKCS12 generation to use GenBuff + private UIO write - Add null check for confirmP.data in SPAKE2+ RespDerive - Add max length validation for private pass token challenge requests - Reject AEAD ciphers in enc command explicitly - Add 30s handshake timeout on accepted TCP connections Cherry-picked from: https://gitcode.com/openHiTLS/openhitls/merge_requests/1625 Signed-off-by: Dongjianwei001 <dongjianwei1@huawei.com>
310 lines
8.8 KiB
C
310 lines
8.8 KiB
C
/*
|
|
* This file is part of the openHiTLS project.
|
|
*
|
|
* openHiTLS is licensed under the Mulan PSL v2.
|
|
* You can use this software according to the terms and conditions of the Mulan PSL v2.
|
|
* You may obtain a copy of Mulan PSL v2 at:
|
|
*
|
|
* http://license.coscl.org.cn/MulanPSL2
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
|
|
* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
|
|
* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
|
|
* See the Mulan PSL v2 for more details.
|
|
*/
|
|
|
|
#ifndef HITLS_APP_OPT_H
|
|
#define HITLS_APP_OPT_H
|
|
|
|
#include <stdint.h>
|
|
#include "bsl_uio.h"
|
|
#include "bsl_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define HITLS_APP_FORMAT_UNDEF 0
|
|
#define HITLS_APP_FORMAT_PEM BSL_FORMAT_PEM // 1
|
|
#define HITLS_APP_FORMAT_ASN1 BSL_FORMAT_ASN1 // 2
|
|
#define HITLS_APP_FORMAT_TEXT 3
|
|
#define HITLS_APP_FORMAT_BASE64 4
|
|
#define HITLS_APP_FORMAT_HEX 5
|
|
#define HITLS_APP_FORMAT_BINARY 6
|
|
#define HITLS_APP_SHAKE128_SIZE 16
|
|
#define HITLS_APP_SHAKE256_SIZE 32
|
|
#define HITLS_APP_PROV_ENUM \
|
|
HITLS_APP_OPT_PROVIDER, \
|
|
HITLS_APP_OPT_PROVIDER_PATH, \
|
|
HITLS_APP_OPT_PROVIDER_ATTR \
|
|
|
|
#define HITLS_APP_PROV_OPTIONS \
|
|
{"provider", HITLS_APP_OPT_PROVIDER, HITLS_APP_OPT_VALUETYPE_STRING, \
|
|
"Specify the cryptographic service provider"}, \
|
|
{"provider-path", HITLS_APP_OPT_PROVIDER_PATH, HITLS_APP_OPT_VALUETYPE_STRING, \
|
|
"Set the path to the cryptographic service provider"}, \
|
|
{"provider-attr", HITLS_APP_OPT_PROVIDER_ATTR, HITLS_APP_OPT_VALUETYPE_STRING, \
|
|
"Set additional attributes for the cryptographic service provider"} \
|
|
|
|
#define HITLS_APP_PROV_CASES(optType, provider) \
|
|
switch (optType) { \
|
|
case HITLS_APP_OPT_PROVIDER: \
|
|
(provider)->providerName = HITLS_APP_OptGetValueStr(); \
|
|
break; \
|
|
case HITLS_APP_OPT_PROVIDER_PATH: \
|
|
(provider)->providerPath = HITLS_APP_OptGetValueStr(); \
|
|
break; \
|
|
case HITLS_APP_OPT_PROVIDER_ATTR: \
|
|
(provider)->providerAttr = HITLS_APP_OptGetValueStr(); \
|
|
break; \
|
|
default: \
|
|
break; \
|
|
}
|
|
|
|
typedef enum {
|
|
HITLS_APP_OPT_VALUETYPE_NONE = 0,
|
|
HITLS_APP_OPT_VALUETYPE_NO_VALUE = 1,
|
|
HITLS_APP_OPT_VALUETYPE_IN_FILE,
|
|
HITLS_APP_OPT_VALUETYPE_OUT_FILE,
|
|
HITLS_APP_OPT_VALUETYPE_STRING,
|
|
HITLS_APP_OPT_VALUETYPE_PARAMTERS,
|
|
HITLS_APP_OPT_VALUETYPE_DIR,
|
|
HITLS_APP_OPT_VALUETYPE_INT,
|
|
HITLS_APP_OPT_VALUETYPE_UINT,
|
|
HITLS_APP_OPT_VALUETYPE_POSITIVE_INT,
|
|
HITLS_APP_OPT_VALUETYPE_LONG,
|
|
HITLS_APP_OPT_VALUETYPE_ULONG,
|
|
HITLS_APP_OPT_VALUETYPE_FMT_PEMDER,
|
|
HITLS_APP_OPT_VALUETYPE_FMT_ANY,
|
|
HITLS_APP_OPT_VALUETYPE_MAX,
|
|
} HITLS_ValueType;
|
|
|
|
typedef enum {
|
|
HITLS_APP_OPT_VALUECLASS_NONE = 0,
|
|
HITLS_APP_OPT_VALUECLASS_NO_VALUE = 1,
|
|
HITLS_APP_OPT_VALUECLASS_STR,
|
|
HITLS_APP_OPT_VALUECLASS_DIR,
|
|
HITLS_APP_OPT_VALUECLASS_INT,
|
|
HITLS_APP_OPT_VALUECLASS_LONG,
|
|
HITLS_APP_OPT_VALUECLASS_FMT,
|
|
HITLS_APP_OPT_VALUECLASS_MAX,
|
|
} HITLS_ValueClass;
|
|
|
|
typedef enum {
|
|
HITLS_APP_OPT_ERR = -1,
|
|
HITLS_APP_OPT_EOF = 0,
|
|
HITLS_APP_OPT_PARAM = HITLS_APP_OPT_EOF,
|
|
HITLS_APP_OPT_HELP = 1,
|
|
} HITLS_OptChoice;
|
|
|
|
typedef struct {
|
|
const char *name; // option name
|
|
const int optType; // option type
|
|
int valueType; // options with parameters(type)
|
|
const char *help; // description of this option
|
|
} HITLS_CmdOption;
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Initialization of command-line argument parsing (internal function)
|
|
*
|
|
* @param argc [IN] number of options
|
|
* @param argv [IN] pointer to an array of options
|
|
* @param opts [IN] command option table
|
|
*
|
|
* @retval command name of command-line argument
|
|
*/
|
|
int32_t HITLS_APP_OptBegin(int32_t argc, char **argv, const HITLS_CmdOption *opts);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Parse next command-line argument (internal function)
|
|
*
|
|
* @param void
|
|
*
|
|
* @retval int32 option type
|
|
*/
|
|
int32_t HITLS_APP_OptNext(void);
|
|
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Finish parsing options
|
|
*
|
|
* @param void
|
|
*
|
|
* @retval void
|
|
*/
|
|
void HITLS_APP_OptEnd(void);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Print command line parsing
|
|
*
|
|
* @param opts command option table
|
|
*
|
|
* @retval void
|
|
*/
|
|
void HITLS_APP_OptHelpPrint(const HITLS_CmdOption *opts);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get the number of remaining options
|
|
*
|
|
* @param void
|
|
*
|
|
* @retval int32 number of remaining options
|
|
*/
|
|
int32_t HITLS_APP_GetRestOptNum(void);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get the remaining options
|
|
*
|
|
* @param void
|
|
*
|
|
* @retval char** the address of remaining options
|
|
*/
|
|
char **HITLS_APP_GetRestOpt(void);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get command option
|
|
* @param void
|
|
* @retval char* command option
|
|
*/
|
|
char *HITLS_APP_OptGetValueStr(void);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief option string to int
|
|
* @param valueS [IN] string value
|
|
* @param valueL [OUT] int value
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptGetInt(const char *valueS, int32_t *valueI);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief option string to uint32_t
|
|
* @param valueS [IN] string value
|
|
* @param valueL [OUT] uint32_t value
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptGetUint32(const char *valueS, uint32_t *valueU);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get the name of the current second-class command
|
|
*
|
|
* @param void
|
|
*
|
|
* @retval char* command name
|
|
*/
|
|
char *HITLS_APP_GetProgName(void);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief option string to long
|
|
*
|
|
* @param valueS [IN] string value
|
|
* @param valueL [OUT] long value
|
|
*
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptGetLong(const char *valueS, long *valueL);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get the format type from the option value
|
|
*
|
|
* @param valueS [IN] string of value
|
|
* @param type [IN] value type
|
|
* @param formatType [OUT] format type
|
|
*
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptGetFormatType(const char *valueS, HITLS_ValueType type, BSL_ParseFormat *formatType);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get UIO type from option value
|
|
*
|
|
* @param filename [IN] name of input file
|
|
* @param mode [IN] method of opening a file
|
|
* @param flag [IN] ownership flag: 0 means borrowed handle, 1 means closed by UIO.
|
|
* When filename is NULL, stdin/stdout is always borrowed and flag is ignored.
|
|
*
|
|
* @retval BSL_UIO * when succeeded, NULL when failed
|
|
*/
|
|
BSL_UIO* HITLS_APP_UioOpen(const char* filename, char mode, int32_t flag);
|
|
BSL_UIO* HITLS_APP_UioOpenPrivate(const char* filename, char mode);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Converts a character string to a character string in Base64 format and output the buf to UIO
|
|
*
|
|
* @param buf [IN] content to be encoded
|
|
* @param inBufLen [IN] the length of content to be encoded
|
|
* @param outBuf [IN] Encoded content
|
|
* @param outBufLen [IN] the length of encoded content
|
|
*
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptToBase64(uint8_t *buf, uint32_t inBufLen, char *outBuf, uint32_t outBufLen);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Convert byte array to hexadecimal string
|
|
*
|
|
* @param bytes [IN] Byte array to be converted
|
|
* @param bytesLen [IN] Length of byte array
|
|
* @param hexStr [OUT] Output hexadecimal string buffer
|
|
* @param hexStrSize [IN] Size of output buffer (must be >= bytesLen*2 + 1)
|
|
*
|
|
* @retval HITLS_APP_SUCCESS on success
|
|
* @retval HITLS_APP_INTERNAL_EXCEPTION if parameters are invalid
|
|
*
|
|
* @note Output format: lowercase hex without "0x" prefix (e.g., "1a2b3c")
|
|
* @note Output buffer must have space for null terminator
|
|
*/
|
|
int32_t HITLS_APP_BytesToHex(const uint8_t *bytes, uint32_t bytesLen, char *hexStr, uint32_t hexStrSize);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Output the buf to UIO
|
|
*
|
|
* @param uio [IN] output UIO
|
|
* @param buf [IN] output buf
|
|
* @param outLen [IN] the length of output buf
|
|
* @param format [IN] output format
|
|
*
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptWriteUio(BSL_UIO *uio, uint8_t *buf, uint32_t bufLen, int32_t format);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Read the content in the UIO to the readBuf
|
|
*
|
|
* @param uio [IN] input UIO
|
|
* @param readBuf [IN] buf which uio read
|
|
* @param readBufLen [IN] the length of readBuf
|
|
* @param maxBufLen [IN] the maximum length to be read.
|
|
*
|
|
* @retval int32_t success or not
|
|
*/
|
|
int32_t HITLS_APP_OptReadUio(BSL_UIO *uio, uint8_t **readBuf, uint64_t *readBufLen, uint64_t maxBufLen);
|
|
|
|
/**
|
|
* @ingroup HITLS_APP
|
|
* @brief Get unknown option name
|
|
*
|
|
* @retval char*
|
|
*/
|
|
const char *HITLS_APP_OptGetUnKownOptName();
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|