Skip to content

Commit

Permalink
mention new agent-askpass and agent-add behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
Burnett01 committed Aug 2, 2021
1 parent 317ea9b commit 39550df
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ This command adds a key to the currently running SSH agent. The key is taken fro
This command starts the SSH agent and loads the private key from the "SSH_PRIVATE_KEY" environment var. The command takes one optional argument, for the name of the agent to be started. Defaults to "default".
As with agent-start, this command needs to be sourced.

#### agent-askpass
This command is called by ssh-add when the [SSH_ASKPASS](https://man.openbsd.org/ssh-add.1#ENVIRONMENT) variable is set active. The command returns the SSH_PASS to [ssh-askpass(1)](https://man.openbsd.org/ssh-askpass.1).

This command is ignored by ssh-add if the key does not require a passphrase.

### known_hosts management
#### hosts-clear
This command truncates the known_hosts file and sets its permissions.
Expand Down Expand Up @@ -78,3 +83,11 @@ deploy:
script:
- rsync -zrSlhaO --chmod=D2775,F664 --delete-after . $FTP_USER@$FTP_HOST:/var/www/deployment/
```

## Using with passphrase protected key

You can supply a passphrase with ``SSH_PASS`` to ``agent-add``, ``agent-start`` or ``agent-autostart``.

```
SSH_PASS="THE_PASSPHRASE" agent-add
```

0 comments on commit 39550df

Please sign in to comment.