app_opt.h

/*
 * 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 HILTS_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;

int32_t HITLS_APP_OptBegin(int32_t argc, char **argv, const HITLS_CmdOption *opts);

int32_t HITLS_APP_OptNext(void);
 

void HITLS_APP_OptEnd(void);

void HITLS_APP_OptHelpPrint(const HITLS_CmdOption *opts);

int32_t HITLS_APP_GetRestOptNum(void);

char **HITLS_APP_GetRestOpt(void);

char *HITLS_APP_OptGetValueStr(void);

int32_t HITLS_APP_OptGetInt(const char *valueS, int32_t *valueI);

int32_t HITLS_APP_OptGetUint32(const char *valueS, uint32_t *valueU);

char *HITLS_APP_GetProgName(void);

int32_t HITLS_APP_OptGetLong(const char *valueS, long *valueL);

int32_t HITLS_APP_OptGetFormatType(const char *valueS, HITLS_ValueType type, BSL_ParseFormat *formatType);

BSL_UIO* HITLS_APP_UioOpen(const char* filename, char mode, int32_t flag);

int32_t HITLS_APP_OptToBase64(uint8_t *buf, uint32_t inBufLen, char *outBuf, uint32_t outBufLen);

int32_t HITLS_APP_BytesToHex(const uint8_t *bytes, uint32_t bytesLen, char *hexStr, uint32_t hexStrSize);

int32_t HITLS_APP_OptWriteUio(BSL_UIO *uio, uint8_t *buf, uint32_t bufLen, int32_t format);

int32_t HITLS_APP_OptReadUio(BSL_UIO *uio, uint8_t **readBuf, uint64_t *readBufLen, uint64_t maxBufLen);

const char *HITLS_APP_OptGetUnKownOptName();
#ifdef __cplusplus
}
#endif
#endif