luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

update field name to change from pr feedback

This commit is contained in:
Becca Petrin 2019-06-19 09:54:18 -07:00
parent 57b2fbbd78
commit 35faaef504
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
website/source/api/auth/pcf/index.html.md
View File

@ -25,7 +25,7 @@ on how to obtain these values, please see the [Vault PCF method
documentation](/docs/auth/pcf.html). documentation](/docs/auth/pcf.html).
| Method | Path | | Method | Path |
| :------------------------------- | | :--------|---------------------- |
| `POST` | `/auth/pcf/config` | | `POST` | `/auth/pcf/config` |
### Parameters ### Parameters
@ -41,11 +41,11 @@ that presently exist.
- `pcf_api_trusted_certificates` `(array: [])`: The certificate that's presented by the - `pcf_api_trusted_certificates` `(array: [])`: The certificate that's presented by the
PCF API. This configures Vault to trust this certificate when making API calls, resolving PCF API. This configures Vault to trust this certificate when making API calls, resolving
`x509: certificate signed by unknown authority` errors. `x509: certificate signed by unknown authority` errors.
- `login_max_minutes_old` `(int: 5)`: The maximum number of minutes in the past when a - `login_max_seconds_old` `(int: 300)`: The maximum number of seconds in the past when a
signature could have been created. The lower the value, the lower the risk of replay signature could have been created. The lower the value, the lower the risk of replay
attacks. attacks.
- `login_max_minutes_ahead` `(int: 1)`: In case of clock drift, the maximum number of - `login_max_seconds_ahead` `(int: 60)`: In case of clock drift, the maximum number of
minutes in the future when a signature could have been created. The lower the value, seconds in the future when a signature could have been created. The lower the value,
the lower the risk of replay attacks. the lower the risk of replay attacks.
### Sample Payload ### Sample Payload
@ -57,8 +57,8 @@ the lower the risk of replay attacks.
"pcf_username": "vault", "pcf_username": "vault",
"pcf_password": "pa55w0rd", "pcf_password": "pa55w0rd",
"pcf_api_trusted_certificates": ["-----BEGIN CERTIFICATE-----\nMIIEtzCCA5+.......ZRtAfQ6r\nwlW975rYa1ZqEdA=\n-----END CERTIFICATE-----"], "pcf_api_trusted_certificates": ["-----BEGIN CERTIFICATE-----\nMIIEtzCCA5+.......ZRtAfQ6r\nwlW975rYa1ZqEdA=\n-----END CERTIFICATE-----"],
"login_max_minutes_old": 5, "login_max_seconds_old": 5,
"login_max_minutes_ahead": 1 "login_max_seconds_ahead": 1
} }
``` ```
@ -77,7 +77,7 @@ $ curl \
Returns the present PCF configuration. Returns the present PCF configuration.
| Method | Path | | Method | Path |
| :------------------------------- | | :--------|---------------------- |
| `GET` | `/auth/pcf/config` | | `GET` | `/auth/pcf/config` |
### Sample Request ### Sample Request
@ -96,8 +96,8 @@ $ curl \
"pcf_api_addr": "https://api.sys.somewhere.cf-app.com", "pcf_api_addr": "https://api.sys.somewhere.cf-app.com",
"pcf_username": "vault", "pcf_username": "vault",
"pcf_api_trusted_certificates": ["-----BEGIN CERTIFICATE-----\nMIIEtzCCA5+.......ZRtAfQ6r\nwlW975rYa1ZqEdA=\n-----END CERTIFICATE-----"], "pcf_api_trusted_certificates": ["-----BEGIN CERTIFICATE-----\nMIIEtzCCA5+.......ZRtAfQ6r\nwlW975rYa1ZqEdA=\n-----END CERTIFICATE-----"],
"login_max_minutes_old": 5, "login_max_seconds_old": 5,
"login_max_minutes_ahead": 1 "login_max_seconds_ahead": 1
} }
``` ```
@ -106,7 +106,7 @@ $ curl \
Deletes the present PCF configuration. Deletes the present PCF configuration.
| Method | Path | | Method | Path |
| :------------------------------- | | :--------|---------------------- |
| `DELETE` | `/auth/pcf/config` | | `DELETE` | `/auth/pcf/config` |
### Sample Request ### Sample Request
@ -129,7 +129,7 @@ If you list no `bound` parameters, then any entity with a valid
will be able to authenticate against this role. will be able to authenticate against this role.
| Method | Path | | Method | Path |
| :-------------------------------- | | :--------|----------------------- |
| `POST` | `/auth/pcf/roles/:role`| | `POST` | `/auth/pcf/roles/:role`|
### Parameters ### Parameters
@ -193,7 +193,7 @@ $ curl \
Returns a PCF role. Returns a PCF role.
| Method | Path | | Method | Path |
| :-------------------------------- | | :--------|----------------------- |
| `GET` | `/auth/pcf/roles/:role`| | `GET` | `/auth/pcf/roles/:role`|
### Sample Request ### Sample Request
@ -225,7 +225,7 @@ $ curl \
Deletes a PCF role. Deletes a PCF role.
| Method | Path | | Method | Path |
| :-------------------------------- | | :--------|----------------------- |
| `DELETE` | `/auth/pcf/roles/:role`| | `DELETE` | `/auth/pcf/roles/:role`|
### Sample Request ### Sample Request
@ -242,7 +242,7 @@ $ curl \
Returns a PCF role. Returns a PCF role.
| Method | Path | | Method | Path |
| :-------------------------------- | | :--------|----------------------- |
| `LIST` | `/auth/pcf/roles` | | `LIST` | `/auth/pcf/roles` |
### Sample Request ### Sample Request
@ -292,7 +292,7 @@ rsa.SignPSS(rand.Reader, rsaPrivateKey, crypto.SHA256, checksum, nil)
- Convert the signature to a string. - Convert the signature to a string.
| Method | Path | | Method | Path |
| :-------------------------------- | | :--------|----------------------- |
| `POST` | `/auth/pcf/login` | | `POST` | `/auth/pcf/login` |
### Parameters ### Parameters

2
website/source/docs/auth/pcf.html.md
View File

@ -14,7 +14,7 @@ for PCF instances. It leverages PCF's [App and Container Identity Assurance](htt
At a high level, this works as follows: At a high level, this works as follows:
1. You construct a request to Vault including your `CF_INSTANCE_CERT`, signed by your `CF_INSTANCE_KEY`. 1. You construct a request to Vault including your `CF_INSTANCE_CERT`, signed by your `CF_INSTANCE_KEY`.
2. Vault validates that the signature is no more than 5 minutes old, or 1 minute in the future. 2. Vault validates that the signature is no more than 300 seconds old, or 60 seconds in the future.
3. Vault validates that the cert was issued by the CA certificate you've pre-configured. 3. Vault validates that the cert was issued by the CA certificate you've pre-configured.
4. Vault validates that the request was signed by the private key for the `CF_INSTANCE_CERT`. 4. Vault validates that the request was signed by the private key for the `CF_INSTANCE_CERT`.
5. Vault validates that the `CF_INSTANCE_CERT` application ID, space ID, and org ID presently exist. 5. Vault validates that the `CF_INSTANCE_CERT` application ID, space ID, and org ID presently exist.