Debian Codegraph @

tools/attest/README.md

raw
1 # `attest` CLI tool
2
3 This binary is a thin wrapper around the `client` library to gather attestation
4 reports in either binary or textproto formats.
5
6 The tool's input is the intended `REPORT_DATA` contents, which is 64 bytes of
7 user-provided data to include in the attestation report. This is typically a
8 nonce.
9
10 The tool's output is the report in any specified format to either standard out
11 or directly to a file.
12
13
14 ## Usage
15
16 ```
17 ./attest [options...]
18 ```
19
20 ### `-in`
21
22 This flag provides a string of 64 bytes `REPORT_DATA` content directly on the command line to include in the output attestation report.
23 REPORT_DATA can be either in base64 or hex format. If -inform=auto, first check with base64, hex and last with auto.
24
25 ### `-inform`
26
27 The format that input takes. One of
28
29 * `base64`: for a byte string in base64 encoding. Fewer bytes than expected
30 will be zero-filled.
31 * `hex`: for a byte string encoded as a hexadecimal string. Fewer bytes than
32 expected will be zero-filled.
33 * `auto`: first check with base64 and last with hex
34
35 Default value is `auto`.
36
37 ### `-outform`
38
39 The format that output takes. This can be `bin` for Intel's specified structures
40 in binary or `textproto` for this module's protobuf message types in human readable text format.
41
42 Default value is `bin`.
43
44 ### `-out`
45
46 Path to output file to write attestation report to.
47
48 Default is empty, interpreted as stdout.
49
50
51 ### `verbose`
52
53 If set, then the logger can append INFO and WARNING logs to stdout as per the verbosity level. Default logger has verbosity set to `0`, so verbosity option should be set to appropriate value to append INFO and WARN logs at variable verbosity levels to stdout.
54
55 Default value is `false`.
56
57 ### `verbosity`
58
59 Used to set the verbosity of logger, where higher number means more verbose output.
60
61 Default value is `0`.