add documentation for aws-sigv4

This commit is contained in:
apparentorder 2023-08-13 11:58:47 +02:00
parent 56d4fa4485
commit a9b8a5acbf
No known key found for this signature in database
3 changed files with 24 additions and 0 deletions

View File

@ -143,6 +143,14 @@ HTTP 200
will follow a redirection only for the second entry.
### --aws-sigv4 <PROVIDER1[:PROVIDER2[:REGION[:SERVICE]]]> {#aws-sigv4}
Generate an `Authorization` header with an AWS SigV4 signature.
Use [`-u, --user`](#user) to specify Access Key Id (username) and Secret Key (password).
To use temporary session credentials (e.g. for an AWS IAM Role), add the `X-Amz-Security-Token` header containing the session token.
### --cacert <FILE> {#cacert}
Specifies the certificate file for peer verification. The file may contain multiple CA certificates and must be in PEM format.

View File

@ -637,6 +637,7 @@ to the command line), while other requests are unaffected.
GET https://example.org
# An options section, each option is optional and applied only to this request...
[Options]
aws-sigv4: aws:amz:... # generate AWS SigV4 Authorization header
cacert: /etc/cert.pem # a custom certificate file
compressed: true # request a compressed response
insecure: true # allows insecure SSL connections and transfers

View File

@ -510,6 +510,21 @@ bytes startsWith hex,efbbbf;
[Doc](/docs/asserting-response.md#bytes-assert)
### AWS SigV4 requests
Generate signed API requests with AWS SigV4, as used by several cloud providers.
```hurl
POST https://sts.eu-central-1.amazonaws.com/
[Options]
aws-sigv4: aws:amz:eu-central-1:sts
[FormParams]
Action: GetCallerIdentity
Version: 2011-06-15
```
The Access Key is given per `--user`. [Doc](/docs/manual.md#aws-sigv4)
[JSON body]: /docs/request.md#json-body
[XML body]: /docs/request.md#xml-body