ExternalVendorCode/go-attestation
1
0
Fork 0
mirror of https://github.com/google/go-attestation.git synced 2025-04-15 15:06:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add initial docs for attest-tool (#213)

Browse Source
This commit is contained in:
Tom D 2021-04-15 12:14:18 -07:00 committed by GitHub
parent b6c6a0c365
commit e24a847d44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
attest/attest-tool/README.md Normal file
View File

@ -0,0 +1,29 @@
# attest-tool
`attest-tool` is a simple utility to exercise attestation-related operations on your system.
## Building attest-tool
If your system has git and a [Go 1.15+ compiler](https://golang.org/dl/) installed, you can
install `attest-tool` from source by running the following commands:
```shell
git clone 'https://github.com/google/go-attestation' && cd go-attestation/attest/attest-tool
go build -o attest-tool ./ # compiled to ./attest-tool
```
## Testing attestation readiness
The main use-case of `attest-tool` is testing whether attestation works on the local system.
Once `attest-tool` has been built, you can run it in self-test mode like this:
```shell
./attest-tool self-test
```
After a few seconds, it should print out a 'PASS' message, or a 'FAIL' message with a
description of what went wrong.
On Linux, `attest-tool` either needs to be run as root, or granted access to the TPM (`/dev/tpmrm0`) device
& event log (`/sys/kernel/security/tpm0/binary_bios_measurements`)