Skip to content

Commit

Permalink
fix some documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Morten Linderud <[email protected]>
  • Loading branch information
Foxboron committed Aug 10, 2024
1 parent 892f425 commit d306013
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ are produced on and can't be transferred to other machines.
This allows you to utilize a native client instead of having to side load
existing PKCS11 libraries into the ssh-agent and/or ssh client.

The project uses [TPM 2.0 Key Files](https://www.hansenpartnership.com/draft-bottomley-tpm2-keys.html)
implemented through the [`go-tpm-keyfiles`](https://github.com/Foxboron/go-tpm-keyfiles) project.

# Features

* A working `ssh-agent`.
* Create sealed ssh keys on the TPM.
* Create shielded ssh keys on the TPM.
* Creation of remotely wrapped SSH keys for import.
* PIN support, dictionary attack protection from the TPM allows you to use low entropy PINs instead of passphrases.
* TPM session encryption.
* Proxy support towards other `ssh-agent` servers for fallbacks.
Expand Down Expand Up @@ -63,7 +67,10 @@ $ export SSH_AUTH_SOCK="$(ssh-tpm-agent --print-socket)"
$ ssh [email protected]
```
**Note:** For `ssh-tpm-agent` you can specify the TPM owner password using the command line flags `-o` or `--owner-password`, which are preferred. Alternatively, you can use the environment variable `SSH_TPM_AGENT_OWNER_PASSWORD`.
**Note:** For `ssh-tpm-agent` you can specify the TPM owner password using the
command line flags `-o` or `--owner-password`, which are preferred.
Alternatively, you can use the environment variable
`SSH_TPM_AGENT_OWNER_PASSWORD`.
### Import existing key
Expand Down
6 changes: 4 additions & 2 deletions cmd/ssh-tpm-add/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@ var Version string

const usage = `Usage:
ssh-tpm-add [FILE]
ssh-tpm-add --ca [URL] --user [USER] --host [HOSTNAME]
Options for CA provisioning:
--ca URL URL to the CA authority for CA key provisioning
--host HOSTNAME Hostname for the ssh server
--ca URL URL to the CA authority for CA key provisioning.
--user USER Username of the ssh server user.
--host HOSTNAME Hostname of the ssh server.
Add a sealed TPM key to ssh-tpm-agent. Allows CA key provisioning with the --ca
option.
Expand Down

0 comments on commit d306013

Please sign in to comment.