crypt_service.h File Reference

File containing the definition of crypt service configuration utilities. More...

#include <sqlite3.h>
#include <utarray.h>
#include "crypt_config.h"
#include "../utils/allocs.h"
#include "../utils/attributes.h"
#include "../utils/os.h"

Include dependency graph for crypt_service.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	crypt_pair
	crypt context structure definition More...

Macros
#define	MAIN_CRYPT_KEY_ID   "main"
#define	__must_free_crypt_service   __must_check

Functions
void	free_crypt_service (struct crypt_context *ctx)
	Frees the crypt context. More...
__must_free_crypt_service struct crypt_context *	load_crypt_service (const char *crypt_db_path, const char *key_id, uint8_t *user_secret, int user_secret_size)
	Load the crypt service. More...
struct crypt_pair *	get_crypt_pair (struct crypt_context *ctx, const char *key)
	Retrieves a key/value pair from the crypt. More...
int	put_crypt_pair (struct crypt_context *ctx, struct crypt_pair *pair)
	Inserts a key/value pair into the crypt. More...
void	free_crypt_pair (struct crypt_pair *pair)
	Frees the crypt pair. More...

Detailed Description

File containing the definition of crypt service configuration utilities.

Author

Alexandru Mereacre

Date

2021

Copyright

SPDX-FileCopyrightText: © 2021 NQMCyber Ltd and edgesec contributors SPDX-License-Identifier: LGPL-3.0-or-later

Macro Definition Documentation

__must_free_crypt_service

#define __must_free_crypt_service   __must_check

MAIN_CRYPT_KEY_ID

#define MAIN_CRYPT_KEY_ID   "main"

Function Documentation

free_crypt_pair()

void free_crypt_pair

(

struct crypt_pair *

pair

)

Frees the crypt pair.

Parameters

pair	The crypt pair

free_crypt_service()

void free_crypt_service

(

struct crypt_context *

ctx

)

Frees the crypt context.

Parameters

ctx	The crypt context

get_crypt_pair()

struct crypt_pair* get_crypt_pair	(	struct crypt_context *	ctx,
		const char *	key
	)

Retrieves a key/value pair from the crypt.

Parameters

ctx	The crypt context
key	The key string

Returns

struct crypt_pair* The returned pair, NULL on failure

load_crypt_service()

__must_free_crypt_service struct crypt_context* load_crypt_service	(	const char *	crypt_db_path,
		const char *	key_id,
		uint8_t *	user_secret,
		int	user_secret_size
	)

Load the crypt service.

Parameters

	crypt_db_path	The crypt db path
	key_id	The crypt secrets key id
[in,out]	user_secret	The user secret. If creating a new key, the user secret will be loaded from this variable. If loading an existing key, the existing key will be writen to the buffer.
	user_secret_size	The user secret size, if zero use the hardware secure element

Returns

The crypt contex, NULL on failure. Use free_crypt_service() to deallocate.

put_crypt_pair()

int put_crypt_pair	(	struct crypt_context *	ctx,
		struct crypt_pair *	pair
	)

Inserts a key/value pair into the crypt.

Parameters

ctx	The crypt context
pair	The key/value pair

Returns

0 on success, -1 on failure