Loading...
Searching...
No Matches
spdk_keyring_module Struct Reference

Public Member Functions

 TAILQ_ENTRY (spdk_keyring_module) tailq
 

Data Fields

const char * name
 Name of the module.
 
int(* init )(void)
 Initializes a module, called during keyring's initialization.
 
void(* cleanup )(void)
 Clean up resources allocated by a module.
 
void(* write_config )(struct spdk_json_write_ctx *w)
 Write module configuration to JSON.
 
int(* probe_key )(const char *name)
 Probe if a key with a specified name is available.
 
int(* add_key )(struct spdk_key *key, void *ctx)
 Add a key to the keyring.
 
void(* remove_key )(struct spdk_key *key)
 Remove a key from the keyring.
 
int(* get_key )(struct spdk_key *key, void *buf, int len)
 Get keying material from a key.
 
size_t(* get_ctx_size )(void)
 Get the size of the context associated with a key.
 
void(* dump_info )(struct spdk_key *key, struct spdk_json_write_ctx *w)
 Dump information about a key to JSON.
 

Field Documentation

◆ cleanup

void(* spdk_keyring_module::cleanup) (void)

Clean up resources allocated by a module.

Called during keyring's cleanup

◆ dump_info

void(* spdk_keyring_module::dump_info) (struct spdk_key *key, struct spdk_json_write_ctx *w)

Dump information about a key to JSON.

This callback should never dump keying material itself, only non-sensitive properties of a key must be dumped.

◆ probe_key

int(* spdk_keyring_module::probe_key) (const char *name)

Probe if a key with a specified name is available.

If it is, the module should add it to the keyring and return zero. Otherwise, -ENOKEY should be returned.


The documentation for this struct was generated from the following file:
  • keyring_module.h