hmac_key.h

Go to the documentation of this file.

/*
 * Copyright IBM Corp. 2025
 *
 * libzpc is free software; you can redistribute it and/or modify
 * it under the terms of the MIT license. See LICENSE for details.
 */
 
#ifndef ZPC_HMAC_KEY_H
# define ZPC_HMAC_KEY_H
# ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
# endif

 
# include <stddef.h>
 
/*
 * These constants match with kernel's pkey.h, enum pkey_key_type.
 */
# define ZPC_HMAC_KEY_TYPE_PVSECRET        9
 
typedef enum {
    ZPC_HMAC_SECRET_TYPE_NOT_SET = -2,
    ZPC_HMAC_SECRET_TYPE_INVALID = -1,
    ZPC_HMAC_SECRET_HMAC_SHA_256 = 0x09, /* architected key types, also below */
    ZPC_HMAC_SECRET_HMAC_SHA_512 = 0x0a,
} zpc_hmacsecret_type_t;
 
typedef enum {
    ZPC_HMAC_HASHFUNC_NOT_SET = -2,
    ZPC_HMAC_HASHFUNC_INVALID = -1,
    ZPC_HMAC_HASHFUNC_SHA_224 = 0,
    ZPC_HMAC_HASHFUNC_SHA_256,
    ZPC_HMAC_HASHFUNC_SHA_384,
    ZPC_HMAC_HASHFUNC_SHA_512,
} zpc_hmac_hashfunc_t;
 
struct zpc_hmac_key;

__attribute__((visibility("default")))
int zpc_hmac_key_alloc(struct zpc_hmac_key **key);
__attribute__((visibility("default")))
int zpc_hmac_key_set_type(struct zpc_hmac_key *key, int type);
__attribute__((visibility("default")))
int zpc_hmac_key_set_hash_function(struct zpc_hmac_key *key, zpc_hmac_hashfunc_t func);
__attribute__((visibility("default")))
int zpc_hmac_key_import(struct zpc_hmac_key *key, const unsigned char *origin,
    size_t originlen);
__attribute__((visibility("default")))
int zpc_hmac_key_import_clear(struct zpc_hmac_key *key,
    const unsigned char *clrkey, size_t keylen);
__attribute__((visibility("default")))
int zpc_hmac_key_export(struct zpc_hmac_key *key, unsigned char *origin,
    size_t *originlen);
__attribute__((visibility("default")))
int zpc_hmac_key_generate(struct zpc_hmac_key *key);
__attribute__((visibility("default")))
void zpc_hmac_key_free(struct zpc_hmac_key **key);
 
# ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
# endif
#endif