2017-08-14 14:49:41 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2017-09-20 20:05:00 +00:00
|
|
|
page_title: "One-Time SSH Passwords (OTP) - SSH - Secrets Engines"
|
New Docs Website (#5535)
* conversion stage 1
* correct image paths
* add sidebar title to frontmatter
* docs/concepts and docs/internals
* configuration docs and multi-level nav corrections
* commands docs, index file corrections, small item nav correction
* secrets converted
* auth
* add enterprise and agent docs
* add extra dividers
* secret section, wip
* correct sidebar nav title in front matter for apu section, start working on api items
* auth and backend, a couple directory structure fixes
* remove old docs
* intro side nav converted
* reset sidebar styles, add hashi-global-styles
* basic styling for nav sidebar
* folder collapse functionality
* patch up border length on last list item
* wip restructure for content component
* taking middleman hacking to the extreme, but its working
* small css fix
* add new mega nav
* fix a small mistake from the rebase
* fix a content resolution issue with middleman
* title a couple missing docs pages
* update deps, remove temporary markup
* community page
* footer to layout, community page css adjustments
* wip downloads page
* deps updated, downloads page ready
* fix community page
* homepage progress
* add components, adjust spacing
* docs and api landing pages
* a bunch of fixes, add docs and api landing pages
* update deps, add deploy scripts
* add readme note
* update deploy command
* overview page, index title
* Update doc fields
Note this still requires the link fields to be populated -- this is solely related to copy on the description fields
* Update api_basic_categories.yml
Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages.
* Add bottom hero, adjust CSS, responsive friendly
* Add mega nav title
* homepage adjustments, asset boosts
* small fixes
* docs page styling fixes
* meganav title
* some category link corrections
* Update API categories page
updated to reflect the second level headings for api categories
* Update docs_detailed_categories.yml
Updated to represent the existing docs structure
* Update docs_detailed_categories.yml
* docs page data fix, extra operator page remove
* api data fix
* fix makefile
* update deps, add product subnav to docs and api landing pages
* Rearrange non-hands-on guides to _docs_
Since there is no place for these on learn.hashicorp, we'll put them
under _docs_.
* WIP Redirects for guides to docs
* content and component updates
* font weight hotfix, redirects
* fix guides and intro sidenavs
* fix some redirects
* small style tweaks
* Redirects to learn and internally to docs
* Remove redirect to `/vault`
* Remove `.html` from destination on redirects
* fix incorrect index redirect
* final touchups
* address feedback from michell for makefile and product downloads
2018-10-19 15:40:11 +00:00
|
|
|
sidebar_title: "SSH OTP"
|
2017-08-14 14:49:41 +00:00
|
|
|
sidebar_current: "docs-secrets-ssh-one-time-ssh-passwords"
|
|
|
|
description: |-
|
2017-09-20 20:05:00 +00:00
|
|
|
The One-Time SSH Password (OTP) SSH secrets engine type allows a Vault server
|
2017-08-14 14:49:41 +00:00
|
|
|
to issue a One-Time Password every time a client wants to SSH into a remote
|
|
|
|
host using a helper command on the remote host to perform verification.
|
|
|
|
---
|
|
|
|
|
|
|
|
# One-Time SSH Passwords
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
The One-Time SSH Password (OTP) SSH secrets engine type allows a Vault server to
|
2017-08-14 14:49:41 +00:00
|
|
|
issue a One-Time Password every time a client wants to SSH into a remote host
|
|
|
|
using a helper command on the remote host to perform verification.
|
|
|
|
|
|
|
|
An authenticated client requests credentials from the Vault server and, if
|
|
|
|
authorized, is issued an OTP. When the client establishes an SSH connection to
|
|
|
|
the desired remote host, the OTP used during SSH authentication is received by
|
|
|
|
the Vault helper, which then validates the OTP with the Vault server. The Vault
|
|
|
|
server then deletes this OTP, ensuring that it is only used once.
|
|
|
|
|
|
|
|
Since the Vault server is contacted during SSH connection establishment, every
|
|
|
|
login attempt and the correlating Vault lease information is logged to the audit
|
2017-09-20 20:05:00 +00:00
|
|
|
secrets engine.
|
2017-08-14 14:49:41 +00:00
|
|
|
|
|
|
|
See [Vault-SSH-Helper](https://github.com/hashicorp/vault-ssh-helper) for
|
|
|
|
details on the helper.
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
This page will show a quick start for this secrets engine. For detailed
|
|
|
|
documentation on every path, use `vault path-help` after mounting the secrets
|
|
|
|
engine.
|
2017-08-14 14:49:41 +00:00
|
|
|
|
|
|
|
### Drawbacks
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
The main concern with the OTP secrets engine type is the remote host's
|
|
|
|
connection to Vault; if compromised, an attacker could spoof the Vault server
|
|
|
|
returning a successful request. This risk can be mitigated by using TLS for the
|
|
|
|
connection to Vault and checking certificate validity; future enhancements to
|
|
|
|
this secrets engine may allow for extra security on top of what TLS provides.
|
2017-08-14 14:49:41 +00:00
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
### Mount the secrets engine
|
2017-08-14 14:49:41 +00:00
|
|
|
|
|
|
|
```text
|
2018-03-02 20:54:28 +00:00
|
|
|
$ vault secrets enable ssh
|
2017-08-14 14:49:41 +00:00
|
|
|
Successfully mounted 'ssh' at 'ssh'!
|
|
|
|
```
|
|
|
|
|
|
|
|
### Create a Role
|
|
|
|
|
|
|
|
Create a role with the `key_type` parameter set to `otp`. All of the machines
|
|
|
|
represented by the role's CIDR list should have helper properly installed and
|
|
|
|
configured.
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault write ssh/roles/otp_key_role \
|
|
|
|
key_type=otp \
|
|
|
|
default_user=username \
|
|
|
|
cidr_list=x.x.x.x/y,m.m.m.m/n
|
|
|
|
Success! Data written to: ssh/roles/otp_key_role
|
|
|
|
```
|
|
|
|
|
|
|
|
### Create a Credential
|
|
|
|
|
|
|
|
Create an OTP credential for an IP of the remote host that belongs to
|
|
|
|
`otp_key_role`.
|
|
|
|
|
|
|
|
```text
|
|
|
|
$ vault write ssh/creds/otp_key_role ip=x.x.x.x
|
|
|
|
Key Value
|
|
|
|
lease_id ssh/creds/otp_key_role/73bbf513-9606-4bec-816c-5a2f009765a5
|
|
|
|
lease_duration 600
|
|
|
|
lease_renewable false
|
|
|
|
port 22
|
|
|
|
username username
|
|
|
|
ip x.x.x.x
|
|
|
|
key 2f7e25a2-24c9-4b7b-0d35-27d5e5203a5c
|
|
|
|
key_type otp
|
|
|
|
```
|
|
|
|
|
|
|
|
### Establish an SSH session
|
|
|
|
|
|
|
|
```text
|
2018-08-28 19:34:48 +00:00
|
|
|
$ ssh username@x.x.x.x
|
2017-08-14 14:49:41 +00:00
|
|
|
Password: <Enter OTP>
|
2018-08-28 19:34:48 +00:00
|
|
|
username@x.x.x.x:~$
|
2017-08-14 14:49:41 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### Automate it!
|
|
|
|
|
|
|
|
A single CLI command can be used to create a new OTP and invoke SSH with the
|
|
|
|
correct parameters to connect to the host.
|
|
|
|
|
|
|
|
```text
|
2018-04-17 17:47:41 +00:00
|
|
|
$ vault ssh -role otp_key_role -mode otp username@x.x.x.x
|
2017-08-14 14:49:41 +00:00
|
|
|
OTP for the session is `b4d47e1b-4879-5f4e-ce5c-7988d7986f37`
|
|
|
|
[Note: Install `sshpass` to automate typing in OTP]
|
|
|
|
Password: <Enter OTP>
|
|
|
|
```
|
|
|
|
|
|
|
|
The OTP will be entered automatically using `sshpass` if it is installed.
|
|
|
|
|
|
|
|
```text
|
2018-04-17 17:47:41 +00:00
|
|
|
$ vault ssh -role otp_key_role -mode otp -strict-host-key-checking=no username@x.x.x.x
|
2017-08-14 14:49:41 +00:00
|
|
|
username@<IP of remote host>:~$
|
|
|
|
```
|
|
|
|
|
|
|
|
Note: `sshpass` cannot handle host key checking. Host key checking can be
|
|
|
|
disabled by setting `-strict-host-key-checking=no`.
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
2017-09-20 20:05:00 +00:00
|
|
|
The SSH secrets engine has a full HTTP API. Please see the
|
|
|
|
[SSH secrets engine API](/api/secret/ssh/index.html) for more
|
2017-08-14 14:49:41 +00:00
|
|
|
details.
|