xref: /optee_os/ta/pkcs11/src/sanitize_object.h (revision 63f89caa9022ecf51d1b82dc78af35ba9e38466d)
1*63f89caaSJens Wiklander /* SPDX-License-Identifier: BSD-2-Clause */
2*63f89caaSJens Wiklander /*
3*63f89caaSJens Wiklander  * Copyright (c) 2017-2020, Linaro Limited
4*63f89caaSJens Wiklander  */
5*63f89caaSJens Wiklander 
6*63f89caaSJens Wiklander #ifndef PKCS11_TA_SANITIZE_OBJECT_H
7*63f89caaSJens Wiklander #define PKCS11_TA_SANITIZE_OBJECT_H
8*63f89caaSJens Wiklander 
9*63f89caaSJens Wiklander #include "serializer.h"
10*63f89caaSJens Wiklander 
11*63f89caaSJens Wiklander /*
12*63f89caaSJens Wiklander  * sanitize_consistent_class_and_type - Check object type matches object class
13*63f89caaSJens Wiklander  *
14*63f89caaSJens Wiklander  * @attrs - object attributes
15*63f89caaSJens Wiklander  * Return true if class/type matches, else return false
16*63f89caaSJens Wiklander  */
17*63f89caaSJens Wiklander bool sanitize_consistent_class_and_type(struct obj_attrs *attrs);
18*63f89caaSJens Wiklander 
19*63f89caaSJens Wiklander /**
20*63f89caaSJens Wiklander  * sanitize_client_object - Setup a serializer from a serialized object
21*63f89caaSJens Wiklander  *
22*63f89caaSJens Wiklander  * @dst - output structure tracking the generated serial object
23*63f89caaSJens Wiklander  * @head - pointer to the formatted serialized object (its head)
24*63f89caaSJens Wiklander  * @size - byte size of the serialized binary blob
25*63f89caaSJens Wiklander  *
26*63f89caaSJens Wiklander  * This function copies an attribute list from a client API attribute head
27*63f89caaSJens Wiklander  * into a PKCS11 TA internal attribute structure. It generates a serialized
28*63f89caaSJens Wiklander  * attribute list with a consistent format and identified attribute IDs.
29*63f89caaSJens Wiklander  *
30*63f89caaSJens Wiklander  * @head points to a blob starting with a pkcs11 attribute header.
31*63f89caaSJens Wiklander  * @head may point to an unaligned address.
32*63f89caaSJens Wiklander  * This function allocates, fills and returns a serialized attribute list
33*63f89caaSJens Wiklander  * into a serializer container.
34*63f89caaSJens Wiklander  */
35*63f89caaSJens Wiklander enum pkcs11_rc sanitize_client_object(struct obj_attrs **dst, void *head,
36*63f89caaSJens Wiklander 				      size_t size);
37*63f89caaSJens Wiklander 
38*63f89caaSJens Wiklander /* Debug: dump attribute content as debug traces */
39*63f89caaSJens Wiklander void trace_attributes_from_api_head(const char *prefix, void *ref, size_t size);
40*63f89caaSJens Wiklander 
41*63f89caaSJens Wiklander #endif /*PKCS11_TA_SANITIZE_OBJECT_H*/
42