secapi-sys 0.4.0

FFI bindings to SecAPI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

/*
 * Copyright 2020-2025 Comcast Cable Communications Management, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/** @section Description
 * @file client_store.h
 *
 * This file contains the functions and structures implementing storage for client objects.
 * The client object is stored and retrieved using the ta_client value indicating the slot at which
 * it is stored.
 */

#ifndef CLIENT_STORE_H
#define CLIENT_STORE_H

#include "cipher_store.h"
#include "key_store.h"
#include "mac_store.h"
#include "object_store.h"
#include "sa_types.h"
#ifdef ENABLE_SVP
#include "svp_store.h"
#endif // ENABLE_SVP 
#include "ta_sa_types.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct client_s client_t;

/**
 * Get the key store.
 *
 * @param[in] client client.
 * @return key store.
 */
key_store_t* client_get_key_store(const client_t* client);

/**
 * Get the cipher store.
 *
 * @param[in] client client.
 * @return cipher store.
 */
cipher_store_t* client_get_cipher_store(const client_t* client);

/**
 * Get the mac store.
 *
 * @param[in] client client.
 * @return mac store.
 */
mac_store_t* client_get_mac_store(const client_t* client);

#ifdef ENABLE_SVP
/**
 * Get the svp store.
 *
 * @param[in] client client.
 * @return svp store.
 */
svp_store_t* client_get_svp_store(const client_t* client);
#endif //ENABLE_SVP

typedef object_store_t client_store_t;

/**
 * Obtain global client store instance. There will be only one instance of this store in the SecApi
 * TA.
 *
 * @return client store
 */
client_store_t* client_store_global();

/**
 * Add a new client to the client store.
 *
 * @param[out] client_slot slot at which the client was stored.
 * @param[in] store store.
 * @param[in] caller_uuid caller UUID.
 * @return status of the operation
 */
sa_status client_store_add(
        ta_client* client_slot,
        client_store_t* store,
        const sa_uuid* caller_uuid);

/**
 * Remove the client from the store. This call will block until the client at the specified slot
 * has reference count of 0.
 *
 * @param[in] store store.
 * @param[in] client_slot client to remove.
 * @param[in] caller_uuid caller UUID.
 * @return status of the operation.
 */
sa_status client_store_remove(
        client_store_t* store,
        ta_client client_slot,
        const sa_uuid* caller_uuid);

/**
 * Obtain the client at the specified index and increment reference count. Client with reference
 * count greater then 0 is guaranteed not to be deleted.
 *
 * @param[out] client client.
 * @param[in] store store.
 * @param[in] client_slot client slot.
 * @param[in] caller_uuid caller UUID.
 * @return status of the operation.
 */
sa_status client_store_acquire(
        client_t** client,
        client_store_t* store,
        ta_client client_slot,
        const sa_uuid* caller_uuid);

/**
 * Decrement the reference count for the client at the specified slot.
 *
 * @param[in] store store.
 * @param[in] client_slot client slot.
 * @param[in] client client.
 * @param[in] caller_uuid caller UUID.
 * @return status of the operation.
 */
sa_status client_store_release(
        client_store_t* store,
        ta_client client_slot,
        client_t* client,
        const sa_uuid* caller_uuid);

#ifdef __cplusplus
}
#endif

#endif // CLIENT_STORE_H