Skip to content

Commit 200b263

Browse files
committed
awsSigV4 signature (Issue: MUR-11346)
1 parent 99772a0 commit 200b263

File tree

2 files changed

+61
-1
lines changed

2 files changed

+61
-1
lines changed

Diff for: README.md

+58-1
Original file line numberDiff line numberDiff line change
@@ -619,6 +619,63 @@ createServer({key, cert}, (req, res) => {
619619
}).listen(8000);
620620
```
621621
622+
###### AWS V4 Signature
623+
624+
Murano support native AWS signature header construction, enable easy integration with any AWS services.
625+
See more info at https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html.
626+
627+
To use it add the signature definition flag: `x-exosite-from: awsSigV4`
628+
629+
To use it the request **MUST** provide `aws_key_id` & `aws_secret` along with the optional `aws_region` as request parameters.
630+
Those parameters should be defined in the service [Config Parameters](#config-parameters-object) with the flag `x-exosite-restricted: true` for user input.
631+
632+
*Example (can be added as is in your service swagger)*
633+
634+
```
635+
x-exosite-config-parameters:
636+
- name: aws_key_id
637+
title: AWS Key ID
638+
description: Your AWS Access KEY ID
639+
type: string
640+
required: true
641+
- name: aws_secret
642+
title: AWS Secret
643+
description: Your AWS Access KEY Secret
644+
type: string
645+
format: password
646+
required: true
647+
- name: aws_region
648+
title: AWS Region
649+
description: Your AWS Region
650+
type: string
651+
enum:
652+
- us-east-2
653+
- us-east-1
654+
- us-west-1
655+
- us-west-2
656+
- af-south-1
657+
- ap-east-1
658+
- ap-south-1
659+
- ap-northeast-3
660+
- ap-northeast-2
661+
- ap-southeast-1
662+
- ap-southeast-2
663+
- ap-northeast-1
664+
- ca-central-1
665+
- cn-north-1
666+
- cn-northwest-1
667+
- eu-central-1
668+
- eu-west-1
669+
- eu-west-2
670+
- eu-south-1
671+
- eu-west-3
672+
- eu-north-1
673+
- me-south-1
674+
- sa-east-1
675+
- us-gov-east-1
676+
- us-gov-west-1
677+
```
678+
622679
##### ClientCA
623680
624681
Validating request from murano using client certificate.
@@ -763,7 +820,7 @@ x-exosite-token: "myprivatetoken"
763820
# ...
764821
```
765822

766-
Once the service swagger has been published and processed, the token will be removed and will not be accessible from Murano anymore.
823+
Once the service swagger has been published and processed, the token will be removed and will not be accessible from Murano anymore.
767824
So you MUST keep it securely saved. If you forget it you can overload the current token by updating the service swagger definition.
768825

769826
##### Step 2: call dispatcher

Diff for: examples/muranoauth.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ securityDefinitions:
2828
# See doc at https://github.com/exosite/open_api_integration/blob/master/README.md#signature
2929
type: signature
3030
# name: signature # optional by default goint in signature header
31+
# To use AWS V4 signature (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
32+
# add following option
33+
# x-exosite-from: awsSigV4
3134
clientCA:
3235
# Client CA authentication, using Murano Services CA
3336
# See doc at https://github.com/exosite/open_api_integration/blob/master/README.md#clientca

0 commit comments

Comments
 (0)