aboutsummaryrefslogtreecommitdiff
path: root/components/service/attestation/reporter/attestation_report.h
blob: aa70b59e2126e283dd4a3a4fc3b0454cb29d1cd3 (plain)
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
/*
 * Copyright (c) 2021, Arm Limited and Contributors. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef ATTESTATION_REPORT_H
#define ATTESTATION_REPORT_H

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * \brief Creates an attestation report
 *
 *  Using the view of the security state of the device provided by
 *  the claims_register, a signed attestation report is created.  On
 *  success, a buffer is allocated for the serialized report.  The buffer
 *  must be freed by calling attestation_reporter_destroy().
 *
 * \param[in] client_id             The requesting client id
 * \param[in] auth_challenge_data   The auth challenge from the requester
 * \param[in] auth_challenge_len    The auth challenge from the requester
 * \param[out] report               The created report
 * \param[out] report_len           The length of the report
 *
 * \return Operation status
 */
int attestation_report_create(int32_t client_id,
        const uint8_t *auth_challenge_data, size_t auth_challenge_len,
        const uint8_t **report, size_t *report_len);

/**
 * \brief Destroys an attestation report
 *
 *  Frees any resource associated with a created report
 *
 * \param[in] report               The created report
 */
void attestation_report_destroy(const uint8_t *report);


#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* ATTESTATION_REPORT_H */