Implement MDX Remote (#10581)

* implement mdx remote

* fix an unfenced code block

* fix partials path

Co-authored-by: Jim Kalafut <jkalafut@hashicorp.com>
This commit is contained in:
Jeff Escalante
2020-12-17 16:53:33 -05:00
committed by GitHub
parent c019849e98
commit 179df992c0
592 changed files with 6363 additions and 8749 deletions

View File

@@ -0,0 +1,106 @@
---
layout: api
page_title: /sys/tools - HTTP API
sidebar_title: <code>/sys/tools</code>
description: This is the API documentation for a general set of crypto tools.
---
# `/sys/tools`
The `/sys/tools` endpoints are a general set of tools.
## Generate Random Bytes
This endpoint returns high-quality random bytes of the specified length.
| Method | Path |
| :----- | :--------------------------- |
| `POST` | `/sys/tools/random(/:bytes)` |
### Parameters
- `bytes` `(int: 32)`  Specifies the number of bytes to return. This value can
be specified either in the request body, or as a part of the URL.
- `format` `(string: "base64")` Specifies the output encoding. Valid options
are `hex` or `base64`.
### Sample Payload
```json
{
"format": "hex"
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/tools/random/164
```
### Sample Response
```json
{
"data": {
"random_bytes": "dGhlIHF1aWNrIGJyb3duIGZveAo="
}
}
```
## Hash Data
This endpoint returns the cryptographic hash of given data using the specified
algorithm.
| Method | Path |
| :----- | :----------------------------- |
| `POST` | `/sys/tools/hash(/:algorithm)` |
### Parameters
- `algorithm` `(string: "sha2-256")` Specifies the hash algorithm to use. This
can also be specified as part of the URL. Currently-supported algorithms are:
- `sha2-224`
- `sha2-256`
- `sha2-384`
- `sha2-512`
- `input` `(string: <required>)`  Specifies the **base64 encoded** input data.
- `format` `(string: "hex")`  Specifies the output encoding. This can be either
`hex` or `base64`.
### Sample Payload
```json
{
"input": "adba32=="
}
```
### Sample Request
```shell-session
$ curl \
--header "X-Vault-Token: ..." \
--request POST \
--data @payload.json \
http://127.0.0.1:8200/v1/sys/tools/hash/sha2-512
```
### Sample Response
```json
{
"data": {
"sum": "dGhlIHF1aWNrIGJyb3duIGZveAo="
}
}
```