2017-11-14 11:13:11 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
|
|
|
page_title: "Vault Enterprise Control Groups"
|
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: "Control Groups"
|
2017-11-14 11:13:11 +00:00
|
|
|
sidebar_current: "docs-vault-enterprise-control-groups"
|
|
|
|
description: |-
|
|
|
|
Vault Enterprise has support for Control Group Authorization.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
# Vault Enterprise Control Group Support
|
|
|
|
|
|
|
|
Vault Enterprise has support for Control Group Authorization. Control Groups
|
|
|
|
add additional authorization factors to be required before satisfying a request.
|
|
|
|
|
|
|
|
When a Control Group is required for a request, a limited duration response
|
|
|
|
wrapping token is returned to the user instead of the requested data. The
|
|
|
|
accessor of the response wrapping token can be passed to the authorizers
|
2018-03-20 18:54:10 +00:00
|
|
|
required by the control group policy. Once all authorizations are satisfied,
|
2017-11-14 11:13:11 +00:00
|
|
|
the wrapping token can be used to unwrap and process the original request.
|
|
|
|
|
|
|
|
## Control Group Factors
|
|
|
|
|
|
|
|
Control Groups can verify the following factors:
|
|
|
|
|
|
|
|
- `Identity Groups` - Require an authorizer to be in a specific set of identity
|
|
|
|
groups.
|
|
|
|
|
|
|
|
## Control Groups In ACL Policies
|
|
|
|
|
|
|
|
Control Group requirements on paths are specified as `control_group` along
|
|
|
|
with other ACL parameters.
|
|
|
|
|
|
|
|
### Sample ACL Policies
|
|
|
|
|
|
|
|
```
|
|
|
|
path "secret/foo" {
|
|
|
|
capabilities = ["read"]
|
|
|
|
control_group = {
|
|
|
|
factor "ops_manager" {
|
|
|
|
identity {
|
|
|
|
group_names = ["managers"]
|
|
|
|
approvals = 1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
The above policy grants `read` access to `secret/foo` only after one member of
|
|
|
|
the "managers" group authorizes the request.
|
|
|
|
|
|
|
|
```
|
|
|
|
path "secret/foo" {
|
|
|
|
capabilities = ["create", "update"]
|
|
|
|
control_group = {
|
|
|
|
ttl = "4h"
|
|
|
|
factor "tech leads" {
|
|
|
|
identity {
|
|
|
|
group_names = ["managers", "leads"]
|
|
|
|
approvals = 2
|
|
|
|
}
|
|
|
|
}
|
|
|
|
factor "super users" {
|
|
|
|
identity {
|
|
|
|
group_names = ["superusers"]
|
|
|
|
approvals = 1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
The above policy grants `create` and `update` access to `secret/foo` only after
|
|
|
|
two member of the "managers" or "leads" group and one member of the "superusers"
|
|
|
|
group authorizes the request. If an authorizer is a member of both the
|
|
|
|
"managers" and "superusers" group, one authorization for both factors will be
|
|
|
|
satisfied.
|
|
|
|
|
|
|
|
## Control Groups in Sentinel
|
|
|
|
|
|
|
|
Control Groups are also supported in Sentinel policies using the `controlgroup`
|
|
|
|
import. See [Sentinel Documentation](/docs/enterprise/sentinel/index.html) for more
|
|
|
|
details on available properties.
|
|
|
|
|
|
|
|
### Sample Sentinel Policy
|
|
|
|
|
|
|
|
```
|
|
|
|
import "time"
|
|
|
|
import "controlgroup"
|
|
|
|
|
|
|
|
control_group = func() {
|
|
|
|
numAuthzs = 0
|
|
|
|
for controlgroup.authorizations as authz {
|
|
|
|
if "managers" in authz.groups.by_name {
|
|
|
|
if time.load(authz.time).unix > time.now.unix - 3600 {
|
|
|
|
numAuthzs = numAuthzs + 1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if numAuthzs >= 2 {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
main = rule {
|
|
|
|
control_group()
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
The above policy will reject the request unless two members of the `managers`
|
|
|
|
group have authorized the request. Additionally it verifies the authorizations
|
|
|
|
happened in the last hour.
|
|
|
|
|
|
|
|
### API
|
|
|
|
|
|
|
|
Control Groups can be managed over the HTTP API. Please see
|
|
|
|
[Control Groups API](/api/system/control-group.html) for more details.
|