2017-02-07 21:04:27 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2017-09-13 01:48:52 +00:00
|
|
|
page_title: "RADIUS - Auth Methods"
|
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: "RADIUS"
|
2017-02-07 21:04:27 +00:00
|
|
|
sidebar_current: "docs-auth-radius"
|
|
|
|
description: |-
|
2017-09-13 01:48:52 +00:00
|
|
|
The "radius" auth method allows users to authenticate with Vault using an
|
|
|
|
existing RADIUS server.
|
2017-02-07 21:04:27 +00:00
|
|
|
---
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
# RADIUS Auth Method
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
The `radius` auth method allows users to authenticate with Vault using an
|
|
|
|
existing RADIUS server that accepts the PAP authentication scheme.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
|
|
|
## Authentication
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
The default path is `/radius`. If this auth method was enabled at a different
|
|
|
|
path, specify `-path=/my-path` in the CLI.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
### Via the CLI
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
```text
|
|
|
|
$ vault login -path=radius username=sethvargo
|
|
|
|
```
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
### Via the API
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
The default endpoint is `auth/radius/login`. If this auth method was enabled
|
|
|
|
at a different path, use that value instead of `radius`.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
|
|
|
```shell
|
2017-09-13 01:48:52 +00:00
|
|
|
$ curl \
|
|
|
|
--request POST \
|
|
|
|
--data '{"password": "..."}' \
|
2018-03-23 15:41:51 +00:00
|
|
|
http://127.0.0.1:8200/v1/auth/radius/login/sethvargo
|
2017-02-07 21:04:27 +00:00
|
|
|
```
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
The response will contain a token at `auth.client_token`:
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
```json
|
2017-02-07 21:04:27 +00:00
|
|
|
{
|
|
|
|
"auth": {
|
|
|
|
"client_token": "c4f280f6-fdb2-18eb-89d3-589e2e834cdb",
|
|
|
|
"policies": [
|
|
|
|
"admins"
|
|
|
|
],
|
|
|
|
"metadata": {
|
|
|
|
"username": "mitchellh"
|
2017-09-13 01:48:52 +00:00
|
|
|
}
|
2017-02-07 21:04:27 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
### Via the CLI
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
1. Enable the radius auth method:
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
```text
|
|
|
|
$ vault auth enable radius
|
|
|
|
```
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
1. Configure connection details for your RADIUS server.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
```text
|
|
|
|
$ vault write auth/radius/users/mitchellh policies=admins
|
|
|
|
```
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
For the complete list of configuration options, please see the API
|
|
|
|
documentation.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
The above creates a new mapping for user "mitchellh" that will be associated
|
|
|
|
with the "admins" policy.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
Alternatively, Vault can assign a configurable set of policies to any user
|
|
|
|
that successfully authenticates with the RADIUS server but has no explicit
|
|
|
|
mapping in the `users/` path. This is done through the
|
|
|
|
`unregistered_user_policies` configuration parameter.
|
2017-02-07 21:04:27 +00:00
|
|
|
|
|
|
|
## API
|
|
|
|
|
2017-09-13 01:48:52 +00:00
|
|
|
The RADIUS auth method has a full HTTP API. Please see the
|
2017-08-08 16:28:17 +00:00
|
|
|
[RADIUS Auth API](/api/auth/radius/index.html) for more
|
|
|
|
details.
|