Library to encrypt and decrypt data using a wrapping key thats encoded inside a Trusted Platform Module (TPM)
.
In other words, you must have access to a specific TPM decrypt the wrapping key.
In addition you can stipulate that the key can only get decrypted by the TPM if the user provides a passphrase (userAuth
) or if the target system has certain PCR
values.
There are two modes to using this library:
-
Seal/Unseal
To use this, you must have access to the same TPM for both encrypting and decrypting.
When you encrypt data, it can ONLY get decrypted by that SAME TPM.
see Seal/Unseal using a TPM's Storage Root Key (SRK)
-
Remote encryption
This mode utilizes a TPM Endorsement Public Key (EKPub)
to wrap the encryption key which can ONLY get decrypted by the TPM that owns the EKPub
This mode requires local access to a real or simulated TPM to encrypt the data.
This library is a a variation of https://github.com/hashicorp/go-kms-wrapping
This library is NOT supported by google
Examples below uses two software TPMs (--tpm-path="127.0.0.1:2321"
). IRL you'd use actual TPMs (--tpm-path="/dev/tpm0"
).
To configure the software TPM on your laptop for testing, see the Using swtpm
section below.
Usage Seal
To use, simply initialize the wrapper as shown below, specify a path to the TPM and optionally the PCR values to bind against
Encrypt:
import (
wrapping "github.com/hashicorp/go-kms-wrapping/v2"
tpmwrap "github.com/salrashid123/go-tpm-wrapping"
)
wrapper := tpmwrap.NewWrapper()
_, err := wrapper.SetConfig(ctx, wrapping.WithConfigMap(map[string]string{
tpmwrap.TPM_PATH: *tpmPath,
// tpmwrap.PCR_VALUES: *pcrValues,
// tpmwrap.USER_AUTH: *userAuth,
}))
blobInfo, err := wrapper.Encrypt(ctx, []byte(*dataToEncrypt))
fmt.Printf("Encrypted: %s\n", hex.EncodeToString(blobInfo.Ciphertext))
Decrypt:
wrapper := tpmwrap.NewWrapper()
_, err := wrapper.SetConfig(ctx, wrapping.WithConfigMap(map[string]string{
tpmwrap.TPM_PATH: *tpmPath,
// tpmwrap.PCR_VALUES: *pcrValues,
// tpmwrap.USER_AUTH: *userAuth,
}))
b, err := os.ReadFile(*encryptedBlob)
newBlobInfo := &wrapping.BlobInfo{}
err = protojson.Unmarshal(b, newBlobInfo)
plaintext, err := wrapper.Decrypt(ctx, newBlobInfo)
fmt.Printf("Decrypted %s\n", string(plaintext))
To use as a CLI, you can run cmd/main.go
or download from the Releases
page. If you want to use as an API, see the example
folder
## encrypt/decrypt
$ go run cmd/main.go --mode=seal --debug \
--dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
$ go run cmd/main.go --mode=seal --debug --decrypt=true \
--encryptedBlob=/tmp/encrypted.json --tpm-path="127.0.0.1:2321"
## encrypt/decrypt with passphrase
$ go run cmd/main.go --mode=seal --debug \
--dataToEncrypt=foo --keyPass=testpass --encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
$ go run cmd/main.go --mode=seal --debug --keyPass=testpass --decrypt=true \
--encryptedBlob=/tmp/encrypted.json --tpm-path="127.0.0.1:2321"
## encrypt/decrypt and bind the data to the **TPM's** values in
### PCR banks 0,23
$ tpm2_pcrread sha256:0,23
sha256:
0 : 0x0000000000000000000000000000000000000000000000000000000000000000
23: 0x0000000000000000000000000000000000000000000000000000000000000000
## encrypt/decrypt
$ go run cmd/main.go --mode=seal --debug \
--dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--keyPass=testpass \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2321"
$ go run cmd/main.go --mode=seal --debug --decrypt=true \
--encryptedBlob=/tmp/encrypted.json --keyPass=testpass \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2321"
to verify that pcr values are actually used, increment the PCR after which decryption will fail
# export TPM2TOOLS_TCTI="swtpm:port=2321"
$ tpm2_pcrread sha256:23
sha256:
23: 0x0000000000000000000000000000000000000000000000000000000000000000
$ tpm2_pcrextend 23:sha256=0000000000000000000000000000000000000000000000000000000000000000
$ tpm2_pcrread sha256:23
sha256:
23: 0xF5A5FD42D16A20302798EF6ED309979B43003D2320D9F0E8EA9831A92759FB4B
$ go run cmd/main.go --mode=seal --debug --decrypt=true \
--encryptedBlob=/tmp/encrypted.json --keyPass=testpass \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2321"
# Error decrypting executing PolicyPCR: TPM_RC_VALUE (parameter 1): value is out of range or is not correct for the context
$ go run cmd/main.go --mode=seal --debug --decrypt=true \
--encryptedBlob=/tmp/encrypted.json --keyPass=testpass \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:F5A5FD42D16A20302798EF6ED309979B43003D2320D9F0E8EA9831A92759FB4B \
--tpm-path="127.0.0.1:2321"
# Error decrypting executing unseal: TPM_RC_POLICY_FAIL (session 1): a policy check failed
If you want to exercise the api itself, see the examples/
folder
# no auth
## encrypt/decrypt
$ go run seal_encrypt/main.go --dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
$ go run seal_decrypt/main.go --encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
# password and pcr
$ go run seal_encrypt/main.go --dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--userAuth=abc --pcrValues=23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2321"
$ go run seal_decrypt/main.go --encryptedBlob=/tmp/encrypted.json \
--userAuth=abc --pcrValues=23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2321"
Usage Import
To use this mode, you must first acquire the Endorsement Public Key (ekPub)
.
The ekPub can be extracted from the Endorsement Certificate
on a TPM or on GCE, via an API.
To use tpm2_tools
on the target machine (the one where you want to transfer a key to)
$ tpm2_createek -c /tmp/primaryB.ctx -G rsa -u /tmp/ekB.pub -Q
$ tpm2_readpublic -c /tmp/primaryB.ctx -o /tmp/ekpubB.pem -f PEM -Q
## or from the ekcert
# $ tpm2_getekcertificate -X -o /tmp/ECcert.bin
# $ openssl x509 -in /tmp/ECcert.bin -inform DER -noout -text
# $ openssl x509 -pubkey -noout -in /tmp/ECcert.bin -inform DER
Copy the public key to the host you want to transfer they key from. This is the encrypting_public_key
On a remote machine:
import (
wrapping "github.com/hashicorp/go-kms-wrapping/v2"
tpmwrap "github.com/salrashid123/go-tpm-wrapping"
)
wrapper := tpmwrap.NewRemoteWrapper()
_, err = wrapper.SetConfig(ctx, wrapping.WithConfigMap(map[string]string{
tpmwrap.TPM_PATH: *tpmPath,
tpmwrap.ENCRYPTING_PUBLIC_KEY: hex.EncodeToString(b),
// tpmwrap.PCR_VALUES: *pcrValues,
// tpmwrap.USER_AUTH: *userAuth,
}))
blobInfo, err := wrapper.Encrypt(ctx, []byte(*dataToEncrypt))
eb, err := protojson.Marshal(blobInfo)
fmt.Printf("Encrypted: %s\n", hex.EncodeToString(blobInfo.Ciphertext))
At this point, copy encrypted_blob
to the machine where you want to transfer a key to
wrapper := tpmwrap.NewRemoteWrapper()
_, err = wrapper.SetConfig(ctx, wrapping.WithConfigMap(map[string]string{
tpmwrap.TPM_PATH: *tpmPath,
tpmwrap.ENCRYPTING_PUBLIC_KEY: hex.EncodeToString(b),
// tpmwrap.PCR_VALUES: *pcrValues,
// tpmwrap.USER_AUTH: *userAuth,
}))
eb, err := os.ReadFile(*encryptedBlob)
newBlobInfo := &wrapping.BlobInfo{}
err = protojson.Unmarshal(eb, newBlobInfo)
plaintext, err := wrapper.Decrypt(ctx, newBlobInfo)
fmt.Printf("Decrypted %s\n", string(plaintext))
Just to note, you don't really need access to a real, permanent TPM on the system you're transferring from. You can even use a simulator (--tpm-path="simulator"
)
The following encrypts some data using just the remote ekpub
## encrypt
$ go run cmd/main.go --mode=import --debug \
--encrypting_public_key=/tmp/ekpubB.pem \
--dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
### note, you can even encrypt the data with a --tpm-path="simulator"
### copy scp /tmp/encrypted.json to VM
## decrypt
$ go run cmd/main.go --mode=import --debug --decrypt --encrypting_public_key=/tmp/ekpubB.pem \
--encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2341"
$ go run cmd/main.go --mode=import --debug \
--encrypting_public_key=/tmp/ekpubB.pem \
--dataToEncrypt=foo --keyPass=bar --encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
Then on a machine with the TPM, run
$ go run cmd/main.go --mode=import --debug --decrypt \
--encryptedBlob=/tmp/encrypted.json --keyPass=bar \
--tpm-path="127.0.0.1:2341"
## encrypt/decrypt and bind the data to the **TPM's** values in
### PCR banks 0,23
$ tpm2_pcrread sha256:0,23
sha256:
0 : 0x0000000000000000000000000000000000000000000000000000000000000000
23: 0x0000000000000000000000000000000000000000000000000000000000000000
$ go run cmd/main.go --mode=import --debug \
--encrypting_public_key=/tmp/ekpubB.pem \
--dataToEncrypt=foo \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:0000000000000000000000000000000000000000000000000000000000000000 \
--encryptedBlob=/tmp/encrypted.json \
--tpm-path="127.0.0.1:2321"
$ go run cmd/main.go --mode=import --debug --decrypt \
--dataToEncrypt=foo --encrypting_public_key=/tmp/ekpubB.pem --encryptedBlob=/tmp/encrypted.json \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2341"
For validation, increment the PCR value on TPM-B
export TPM2OPENSSL_TCTI="swtpm:port=2341"
$ tpm2_pcrread sha256:0,23
sha256:
0 : 0x0000000000000000000000000000000000000000000000000000000000000000
23: 0x0000000000000000000000000000000000000000000000000000000000000000
$ tpm2_pcrextend 23:sha256=0x0000000000000000000000000000000000000000000000000000000000000000
$ tpm2_pcrread sha256:0,23
sha256:
0 : 0x0000000000000000000000000000000000000000000000000000000000000000
23: 0xF5A5FD42D16A20302798EF6ED309979B43003D2320D9F0E8EA9831A92759FB4B
# loading the value fails
go run cmd/main.go --mode=import --decrypt \
--dataToEncrypt=foo --encrypting_public_key=/tmp/ekpubB.pem --encryptedBlob=/tmp/encrypted.json \
--pcrValues=0:0000000000000000000000000000000000000000000000000000000000000000,23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2341"
Error decrypting error executing PolicyPCR: TPM_RC_VALUE (parameter 1): value is out of range or is not correct for the context
If you want to exercise the api itself, see the examples/
folder
# no auth
$ go run import_encrypt/main.go --dataToEncrypt=foo \
--encryptedBlob=/tmp/encrypted.json --encrypting_public_key=/tmp/ekpubB.pem \
--tpm-path="127.0.0.1:2321"
$ go run import_decrypt/main.go --encryptedBlob=/tmp/encrypted.json \
--encrypting_public_key=/tmp/ekpubB.pem --tpm-path="127.0.0.1:2341"
# password
$ go run import_encrypt/main.go --dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--encrypting_public_key=/tmp/ekpubB.pem \
--userAuth=abc \
--tpm-path="127.0.0.1:2321"
$ go run import_decrypt/main.go --encryptedBlob=/tmp/encrypted.json \
--encrypting_public_key=/tmp/ekpubB.pem \
--userAuth=abc \
--tpm-path="127.0.0.1:2341"
# pcr
$ go run import_encrypt/main.go --dataToEncrypt=foo --encryptedBlob=/tmp/encrypted.json \
--encrypting_public_key=/tmp/ekpubB.pem \
--pcrValues=23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2321"
$ go run import_decrypt/main.go --encryptedBlob=/tmp/encrypted.json \
--encrypting_public_key=/tmp/ekpubB.pem \
--pcrValues=23:0000000000000000000000000000000000000000000000000000000000000000 \
--tpm-path="127.0.0.1:2341"
Session Encryption
Each operation uses encrypted sessions but by default, the library interrogates the TPM for the current EK directly.
A todo is to allow the user to specify the 'name' of a trusted EK which we'd compare in code (if not match, bail, eg implement the --tpm-session-encrypt-with-name=
parameter shown below)
Background
The following details some background how each of these modes works:
-
Seal
Sealing data to a TPM is pretty well known (see tpm2_unseal). Basically you create a key where the sensitive data within that key is the actual secret. The Key itself can have a password or pcr policy set which must get fulfilled to unseal. In this library, the wrapping DEK is what is sealed.
-
Import
For this, you encrypt some data remotely using just a public encryption key for the target TPM.
In this specific implementation, there ar e several layers of encryption involved:
To transfer a secret from TPM-A
to TPM-B
with userAuth
TPM-B
: create ekpubB.pem
- copy
ekpubB.pem
to TPM-A
- on
TPM-A
:
-
- create a trial session with
PolicyDuplicateSelect
using TPM-B
's ekpub
-
- create an AES key on
TPM-A
with authPolicy (userAuth) and the trial session.
-
- use the AES key to encrypt the DEK
-
- duplicate the TPM based key using the
Policyduplicateselect
and a real session
copy the duplicated key and wrapped DEK to TPM-B
- on
TPM-B
:
-
- create a real session with
PolicySecret
(since we used the EndorsementKey)
-
- Import and Load the duplicated key with the policy
-
- Use the TPM-based key, specify the userAuth and decrypt the DEK
To transfer a secret from TPM-A
to TPM-B
with PCRPolicy
- TPM-B: create
ekpubB.pem
- copy
ekpubB.pem
to TPM-A
- on
TPM-A
:
-
- create random local (non-tpm) AES key
-
- create an AES key on
TPM-A
without any policy or auth where the sensitive part is the AES key above
-
- use the AES key to encrypt the DEK
-
- create a trial TPM
PolicyOR
session with a PolicyPCR
and PolicyDuplicateSelect
(the latter which bound to TPM-B
's ekpub)
-
- create a NEW AES key on
TPM-A
with the original random AES key as the sensitive bit and the AuthPolicy using the PolicyOR
above.
-
- create a real session with
PolicyDuplicateSelect
bound to the remote TPM-B
-
copy the duplicated key to TPM-B
- on
TPM-B
-
- Create a
PolicyOR
with PolicyPCR
and PolicyDuplicateSelect
that match what is expected
-
- Import the duplicated key
-
- Decrypt the KEK using the TPM-based duplicated key (eg the AES key)
-
- Use the KEK to decrypt the DEK
Using swtpm
If you want to test locally with software TPMs:
### start two emulators
## TPM-A
rm -rf /tmp/myvtpm && mkdir /tmp/myvtpm
sudo swtpm_setup --tpmstate /tmp/myvtpm --tpm2 --create-ek-cert
sudo swtpm socket --tpmstate dir=/tmp/myvtpm --tpm2 --server type=tcp,port=2321 --ctrl type=tcp,port=2322 --flags not-need-init,startup-clear
## TPM-B
rm -rf /tmp/myvtpm2 && mkdir /tmp/myvtpm2
sudo swtpm_setup --tpmstate /tmp/myvtpm2 --tpm2 --create-ek-cert
sudo swtpm socket --tpmstate dir=/tmp/myvtpm2 --tpm2 --server type=tcp,port=2341 --ctrl type=tcp,port=2342 --flags not-need-init,startup-clear
### For TPM-A
export TPM2TOOLS_TCTI="swtpm:port=2321"
export TPM2OPENSSL_TCTI="swtpm:port=2321"
tpm2_pcrread sha256:0,23
tpm2_flushcontext -t && tpm2_flushcontext -s && tpm2_flushcontext -l
tpm2_createek -c /tmp/primaryA.ctx -G rsa -Q
tpm2_readpublic -c /tmp/primaryA.ctx -o /tmp/ekpubA.pem -f PEM -Q
tpm2_flushcontext -t && tpm2_flushcontext -s && tpm2_flushcontext -l
## for import create ek on TPM-B
export TPM2TOOLS_TCTI="swtpm:port=2341"
export TPM2OPENSSL_TCTI="swtpm:port=2341"
tpm2_pcrread sha256:0,23
tpm2_createek -c /tmp/primaryB.ctx -G rsa -Q
tpm2_readpublic -c /tmp/primaryB.ctx -o /tmp/ekpubB.pem -f PEM -Q
tpm2_flushcontext -t && tpm2_flushcontext -s && tpm2_flushcontext -l
swtpm
does not include a resource manager so you may need to run tpm2_flushcontext -t && tpm2_flushcontext -s && tpm2_flushcontext -l