Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move tkey-runapp and qemu script to tkey-tools #99

Merged
merged 1 commit into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.PHONY: all
all: apps tkey-runapp tkey-ssh-agent runtimer
all: apps tkey-ssh-agent runtimer

.PHONY: windows
windows: tkey-ssh-agent.exe tkey-ssh-agent-tray.exe
Expand Down Expand Up @@ -41,11 +41,6 @@ podman:
apps:
$(MAKE) -C apps

# .PHONY to let go-build handle deps and rebuilds
.PHONY: tkey-runapp
tkey-runapp:
go build ./cmd/tkey-runapp

# .PHONY to let go-build handle deps and rebuilds
.PHONY: tkey-sign
tkey-sign:
Expand Down Expand Up @@ -83,7 +78,7 @@ tkey-ssh-agent-tray.exe:

.PHONY: clean
clean:
rm -f tkey-runapp tkey-sign runsign.sh \
rm -f \
tkey-ssh-agent cmd/tkey-ssh-agent/app.bin \
tkey-ssh-agent.exe cmd/tkey-ssh-agent/rsrc_windows_amd64.syso \
tkey-ssh-agent-tray.exe cmd/tkey-ssh-agent-tray/rsrc_windows_amd64.syso \
Expand Down
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ This repository contains some applications for the

Client apps:

- `tkey-runapp`: A simple development tool to load and start any TKey
device app, like those below.
- `tkey-ssh-agent`: An OpenSSH compatible agent.
- `runtimer`: Control the `timer` device app.

Expand Down Expand Up @@ -108,13 +106,6 @@ To help prevent unpleasant surprises we keep a hash of the `signer` in
`cmd/tkey-ssh-agent/app.bin.sha512`. The compilation will fail if this
is not the expected binary.

### Using tkey-runapp

The client app `tkey-runapp` only loads and starts a device app. It's
mostly a development tool. You'll then have to switch to a different
client app that speaks your app's specific protocol. Run with `-h` to
get help.

### Using tkey-ssh-agent

This client app is a complete, alternative SSH agent with practical
Expand Down Expand Up @@ -150,8 +141,8 @@ $ SSH_AUTH_SOCK=/path/to/agent.sock ssh -F /dev/null localhost
`-F /dev/null` is used to ignore your ~/.ssh/config which could
interfere with this test.

The tkey-ssh-agent also supports the `--uss` and `--uss-file` flags,
as described for `tkey-runapp` above.
The tkey-ssh-agent also supports the `--uss` and `--uss-file` flags to
enter a User Supplied Secret.

You can use `--show-pubkey` (short flag: `-p`) to only output the
pubkey. The pubkey is printed to stdout for easy redirection, but some
Expand Down Expand Up @@ -182,10 +173,9 @@ itself passed. For automatically starting the SSH agent when logging
onto the computer, a shortcut to `tkey-ssh-agent-tray.exe`, with the
required arguments, can be added in your user's `Startup` folder.

When using the `--uss` option (as described for `tkey-runapp` above),
the Windows build by default uses the pinentry program from Gpg4win
for requesting the User-Supplied Secret. This package can be installed
using: `winget install GnuPG.Gpg4win`.
When using the `--uss` option the Windows build by default uses the
pinentry program from Gpg4win for requesting the User-Supplied Secret.
This package can be installed using: `winget install GnuPG.Gpg4win`.

The SSH Agent supports being used by the native OpenSSH client
`ssh.exe` (part of Windows Optional Features and installable using
Expand Down
167 changes: 0 additions & 167 deletions cmd/tkey-runapp/main.go

This file was deleted.

57 changes: 0 additions & 57 deletions contrib/run-tkey-qemu

This file was deleted.

71 changes: 0 additions & 71 deletions contrib/tkey-qemu.dockerfile

This file was deleted.

2 changes: 0 additions & 2 deletions tools/spdx-ensure
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ apps/rng_stream/README.md
build.sh
cmd/tkey-ssh-agent/app.bin.sha512
cmd/tkey-ssh-agent-tray/trayicon.ico
contrib/run-tkey-qemu
contrib/tkey-qemu.dockerfile
dco.md
go.mod
go.sum
Expand Down