Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Support for AOSS #366

Merged
merged 4 commits into from
Jan 23, 2023
Merged

Added Support for AOSS #366

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
910fa96
Added Support for AOSS
nhtruong Jan 20, 2023
6fc7192
# Added Unit test for x-amz-content-sha256
nhtruong Jan 23, 2023
1510ef4
# Increased test plans count
nhtruong Jan 23, 2023
21b3616
# updated x-amz-context-sha256 test
nhtruong Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ opensearch*
# documentation
docs/

# temporary
tmp/

test/benchmarks/macro/fixtures/*

*-junit.xml
Expand Down
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Documented Transport#request ([#335](https://github.com/opensearch-project/opensearch-js/issues/335))
- Documented all API methods ([#335](https://github.com/opensearch-project/opensearch-js/issues/335))
- Added point in time APIs ([#348](https://github.com/opensearch-project/opensearch-js/pull/348))
- Added support for Amazon OpenSearch Serverless ([#356](https://github.com/opensearch-project/opensearch-js/issues/356))

### Dependencies
- Bumps `xmlbuilder2` from 2.4.1 to 3.0.2
- Bumps `minimatch` from 3.0.4 to 3.1.2
Expand Down Expand Up @@ -47,4 +49,4 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Fix mutability of connection headers ([#291](https://github.com/opensearch-project/opensearch-js/issues/291))

[2.1]: https://github.com/opensearch-project/opensearch-js/releases/tag/2.1.0
[Unreleased]: https://github.com/opensearch-project/opensearch-js/compare/2.1...HEAD
[Unreleased]: https://github.com/opensearch-project/opensearch-js/compare/2.1...HEAD
8 changes: 7 additions & 1 deletion lib/aws/AwsSigv4Signer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const Connection = require('../Connection');
const Transport = require('../Transport');
const aws4 = require('aws4');
const AwsSigv4SignerError = require('./errors');
const crypto = require('crypto');

const getAwsSDKCredentialsProvider = async () => {
// First try V3
Expand Down Expand Up @@ -77,7 +78,12 @@ function AwsSigv4Signer(opts = {}) {
request.region = opts.region;
request.headers = request.headers || {};
request.headers['host'] = request.hostname;
return aws4.sign(request, credentialsState.credentials);
const signed = aws4.sign(request, credentialsState.credentials);
signed.headers['x-amz-content-sha256'] = crypto
.createHash('sha256')
.update(request.body || '', 'utf8')
.digest('hex');
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aws4 should do this already? Or is there some edge case I'm missing?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, my bad, only does it for S3. https://github.com/mhart/aws4/blob/master/aws4.js#L158

Copy link
Collaborator Author

@nhtruong nhtruong Jan 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what we thought too but it actually does not add x-amz-content-sha256 header, which is required by AOSS.
It's optionally for Managed Service, which is why we didn't need it before.

return signed;
}

class AwsSigv4SignerConnection extends Connection {
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
}
},
"homepage": "https://www.opensearch.org/",
"version": "2.1.1",
"version": "2.2.0",
"versionCanary": "7.10.0-canary.6",
"keywords": [
"opensearch",
Expand Down
3 changes: 2 additions & 1 deletion test/unit/lib/aws/awssigv4signer.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const { Connection } = require('../../../../index');
const { Client, buildServer } = require('../../../utils');

test('Sign with SigV4', (t) => {
t.plan(3);
t.plan(4);

const mockCreds = {
accessKeyId: uuidv4(),
Expand Down Expand Up @@ -50,6 +50,7 @@ test('Sign with SigV4', (t) => {
const signedRequest = auth.buildSignedRequestObject(request);
t.hasProp(signedRequest.headers, 'X-Amz-Date');
t.hasProp(signedRequest.headers, 'Authorization');
t.hasProp(signedRequest.headers, 'x-amz-content-sha256');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the value always the same? Maybe add a test that ensures this value is what you expect it to be?

t.same(signedRequest.service, 'es');
});

Expand Down