Added Support for AOSS #366

nhtruong · 2023-01-20T22:34:15Z

Signed-off-by: Theo Truong theotr@amazon.com

Issues Resolved

Closes #356

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

dblock · 2023-01-20T22:38:28Z

lib/aws/AwsSigv4Signer.js

@@ -77,6 +77,12 @@ function AwsSigv4Signer(opts = {}) {
    request.region = opts.region;
    request.headers = request.headers || {};
    request.headers['host'] = request.hostname;
+    if (opts.service === 'aoss') {


I am strongly opposed to this. The Amazon managed service and serverless now work the same way if you sign the content. Signing the body is optional in the managed service, but required in serverless. Let's make the client do it for both without the if.

Adding x-ams-context-sha256 works for both :)

Signed-off-by: Theo Truong <theotr@amazon.com>

dblock · 2023-01-21T02:52:37Z

Nicely done @nhtruong. Add a test for the added header and we're good to go?

nhtruong · 2023-01-23T16:42:43Z

@dblock Yes. I've tested and it's working for both. the x-ams-context-sha256 header is optional for managed service but required by AOSS. Adding it makes it work for both services for requests with and without a body.

Signed-off-by: Theo Truong <theotr@amazon.com>

dblock · 2023-01-23T20:26:20Z

test/unit/lib/aws/awssigv4signer.test.js

@@ -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');


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

Signed-off-by: Theo Truong <theotr@amazon.com>

mhart · 2023-01-23T22:20:32Z

lib/aws/AwsSigv4Signer.js

+    signed.headers['x-amz-content-sha256'] = crypto
+      .createHash('sha256')
+      .update(request.body || '', 'utf8')
+      .digest('hex');


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

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

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.

dblock · 2023-01-23T23:26:39Z

@nhtruong Care to do #371 as well? thx

opensearch-trigger-bot · 2023-02-21T02:36:30Z

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.x 1.x
# Navigate to the new working tree
cd .worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-366-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 52010ba66cf58138bfb4324fdefac9fde99c4454
# Push it to GitHub
git push --set-upstream origin backport/backport-366-to-1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-366-to-1.x.

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com> (cherry picked from commit 52010ba)

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

* Backport #366 into 1.x Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com> * Add missing types for AwsSigv4SignerOptions.service (#377) * Add missing types for AwsSigv4SignerOptions.service Signed-off-by: magoz <apps@magoz.is> * update changelog with Add missing types for AwsSigv4SignerOptions.service Signed-off-by: magoz <apps@magoz.is> * fix: service is optional Signed-off-by: magoz <apps@magoz.is> --------- Signed-off-by: magoz <apps@magoz.is> (cherry picked from commit c44cc1c) --------- Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com> Co-authored-by: Magoz <apps@magoz.is>

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com>

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com>

* Manually sync CHANGELOG.md, release-drafter.yml, RELEASING.md, and USER_GUIDE.md * Version Bump: 2.3.0 (opensearch-project#546) * Upgrade and secure the backport workflow (opensearch-project#547) * Add serialization and deserialization of numerals larger than `Number.MAX_SAFE_INTEGER` (opensearch-project#544) * Add upgrading NPM to all workflows running older Node.js versions (opensearch-project#545) * Bump @types/node from 20.1.4 to 20.2.5 (opensearch-project#528) * Bump @aws-sdk/types from 3.329.0 to 3.341.0 (opensearch-project#527) * Bump ora from 6.3.0 to 6.3.1 (opensearch-project#524) * Bump node-fetch from 3.2.10 to 3.3.1 (opensearch-project#526) * Bump eslint from 8.39.0 to 8.41.0 (opensearch-project#525) * Bump @types/node from 18.16.0 to 20.1.4 (opensearch-project#518) * Bump xmlbuilder2 from 3.1.0 to 3.1.1 (opensearch-project#519) * Bump semver from 7.3.8 to 7.5.1 (opensearch-project#520) * Added timursaurus to MAINTAINERS.md (opensearch-project#517) * Bump @aws-sdk/types from 3.257.0 to 3.329.0 (opensearch-project#516) * Bump @babel/eslint-parser from 7.21.3 to 7.21.8 (opensearch-project#513) * Bump simple-git from 3.17.0 to 3.18.0 (opensearch-project#512) * Bump xmlbuilder2 from 3.0.2 to 3.1.0 (opensearch-project#503) * Bump eslint from 8.38.0 to 8.39.0 (opensearch-project#504) * Bump @types/node from 18.15.11 to 18.16.0 (opensearch-project#499) * Bump ora from 6.1.2 to 6.3.0 (opensearch-project#500) * Bump prettier from 2.8.7 to 2.8.8 (opensearch-project#501) * Implemented Docker Image caching for `integration-unreleased` workflow (opensearch-project#498) * [Bug] Fixed bundler.yml (opensearch-project#497) * Bumped Version 2.2.1 In preparation for release (opensearch-project#495) * Bump @types/node from 18.15.10 to 18.15.11 (opensearch-project#493) * Bump eslint from 8.33.0 to 8.38.0 (opensearch-project#494) * Bump rimraf from 4.4.0 to 5.0.0 (opensearch-project#492) * [CCI] feat: add missing createConnection type (opensearch-project#490) * Add Search guide (opensearch-project#489) * Create search guide (opensearch-project#488) * [CCI] Create advanced index actions guide (opensearch-project#483) * [CCI] Connection `request` method callback (opensearch-project#478) * feat: NotCompatibleError (opensearch-project#484) * Bump @babel/eslint-parser from 7.19.1 to 7.21.3 (opensearch-project#486) * Bump jsdoc from 4.0.0 to 4.0.2 (opensearch-project#485) * Bump prettier from 2.8.4 to 2.8.7 (opensearch-project#487) * Create document lifecycle guide (opensearch-project#481) * Create index lifecycle guide (opensearch-project#482) * Create bulk guide (opensearch-project#480) * [CCI] Create index_template guide (opensearch-project#479) * Bump split2 from 4.1.0 to 4.2.0 (opensearch-project#467) * Bump deepmerge from 4.3.0 to 4.3.1 (opensearch-project#468) * Bump @types/node from 18.15.3 to 18.15.10 (opensearch-project#462) * Bump eslint-config-prettier from 8.6.0 to 8.8.0 (opensearch-project#463) * [CCI] Update developerGuide regarding yarn troubleshoot steps (opensearch-project#456) * [CCI] Bump caniuse-lite from 1.0.30001249 to 1.0.30001469 (opensearch-project#459) * added the solution for the possible error during yarn installation on Windows OS (opensearch-project#453) * Fixed deprecation warnings (opensearch-project#446) * [CCI] Don't run tests on PRs with doc changes only (opensearch-project#441) * [CCI] Add pull request template (opensearch-project#440) * Bump @types/node from 17.0.45 to 18.15.3 (opensearch-project#448) * Bump simple-git from 3.16.0 to 3.17.0 (opensearch-project#447) * [CCI] Update Developer Guide (opensearch-project#436) * [CCI] Remove waitCluster in Integration Tests (opensearch-project#423) * Bump tsd from 0.25.0 to 0.27.0 (opensearch-project#431) * Bump rimraf from 4.1.1 to 4.4.0 (opensearch-project#432) * [CCI] doc: fix grammar (opensearch-project#427) * Fix deprecated folder mapping "./" in the "exports" field (opensearch-project#416) * [CCI] fix: pass required `data` argument to SerializationError class (opensearch-project#419) * Bump tap from 16.3.0 to 16.3.4 (opensearch-project#413) * [CCI] Refactor: Remove unnecessary `data` argument when invoking `OpenSearchClientError` (opensearch-project#421) * Bump deepmerge from 4.2.2 to 4.3.0 (opensearch-project#414) * Updated Maintainers list and changelogs (opensearch-project#409) * Downgraded @types/node to 17 from 18 due to breaking changes. (opensearch-project#405) * Bump aws4 from 1.11.0 to 1.12.0 (opensearch-project#406) * Bump prettier from 2.8.3 to 2.8.4 (opensearch-project#407) * Bump minimist from 1.2.7 to 1.2.8 (opensearch-project#388) * Bump tsd from 0.24.1 to 0.25.0 (opensearch-project#389) * Add missing types for AwsSigv4SignerOptions.service (opensearch-project#377) * Created untriaged issue workflow. (opensearch-project#386) Daniel (dB.) Doubrovkine* 2/14/23, 12:14 PM * Bump dezalgo from 1.0.3 to 1.0.4 (opensearch-project#383) * Bump simple-statistics from 7.7.0 to 7.8.3 (opensearch-project#384) * Bump eslint from 8.32.0 to 8.33.0 (opensearch-project#379) * Allow fields in BulkOperation to be optional (opensearch-project#378) * Bump @types/node from 18.11.18 to 18.11.19 (opensearch-project#380) * Bump ora from 5.4.1 to 6.1.2 (opensearch-project#376) * Bump @aws-sdk/types from 3.226.0 to 3.257.0 (opensearch-project#375) * Bump secure-json-parse from 2.4.0 to 2.7.0 (opensearch-project#369) * Bump simple-git from 3.15.1 to 3.16.0 (opensearch-project#373) * Updated user guide to include Amazon OpenSearch Serverless (opensearch-project#372) * Added Support for AOSS (opensearch-project#366) * Bump rimraf from 3.0.2 to 4.1.1 (opensearch-project#370) * Bump eslint-config-prettier from 8.5.0 to 8.6.0 (opensearch-project#368) * Bump hpagent from 0.1.2 to 1.2.0 (opensearch-project#361) * Bump eslint from 8.30.0 to 8.32.0 (opensearch-project#362) * Fixed missing namespace for API-PIT endpoints (opensearch-project#364) * Bump prettier from 2.7.1 to 2.8.3 (opensearch-project#363) * Ensure Dependabot PR workflow retriggers on label change (opensearch-project#360) * Added point in time APIs (opensearch-project#348) * Bump @types/node from 15.14.7 to 18.11.18 (opensearch-project#353) * Bump split2 from 3.2.2 to 4.1.0 (opensearch-project#354) * Bump json5 from 2.2.0 to 2.2.3 (opensearch-project#359) * Bump @aws-sdk/types from 3.190.0 to 3.226.0 (opensearch-project#355) * Updated MAINTAINERS.md to match recommended opensearch-project format. (opensearch-project#358) Daniel (dB.) Doubrovkine* 1/6/23, 8:36 AM * Bump minimist from 1.2.6 to 1.2.7 (opensearch-project#350) * Bump eslint from 7.32.0 to 8.30.0 (opensearch-project#346) * Bump eslint-plugin-prettier from 4.0.0 to 4.2.1 (opensearch-project#351) * Removed test artifacts from gh_pages workflow (opensearch-project#347) * Bump minimatch from 3.0.4 to 3.1.2 (opensearch-project#345) * Bump xmlbuilder2 from 2.4.1 to 3.0.2 (opensearch-project#321) * Implement JSDOC (opensearch-project#337) * Added skip-changelog label (opensearch-project#339) * Bumps simple-git from 3.4.0 to 3.15.0 (opensearch-project#341) * [FEATURE] Allow overriding the aws service identifier in AwsSigv4Signer (opensearch-project#333) * Add release details and bump the jenkins lib version (opensearch-project#319) * Bump Version from 2.1.0 to 2.1.1 (opensearch-project#318) * Bump semver from 7.3.7 to 7.3.8 (opensearch-project#313) * Add release workflows (opensearch-project#317) * issue opensearch-project#291 mutability of headers (opensearch-project#311) * Bump tsd from 0.22.0 to 0.24.1 (opensearch-project#312) * Add changelog and changelog verifier (opensearch-project#306) * Bump prettier from 2.6.2 to 2.7.1 (opensearch-project#310) * Bump @aws-sdk/types from 3.160.0 to 3.190.0 (opensearch-project#309) * Bump node-fetch from 2.6.7 to 3.2.10 (opensearch-project#281) * Update Maintainers List (opensearch-project#308) * Implemented Retry for OpenSearch Container (opensearch-project#304) * Feature/add default credentials provider (opensearch-project#295) * Fix new line problem between diffs (opensearch-project#302) * Removed Unused Variables (opensearch-project#301) * fix awssigv4signer.test.js tests not running (opensearch-project#294) * fix: support TS resolution for .mjs (opensearch-project#296) * Add AwsSigV4 signing functionality (opensearch-project#279) * Fix opensearch-project#253 Cannot read property 'then' of null in Transport.js issue. (opensearch-project#283) * Bump simple-git from 3.5.0 to 3.13.0 (opensearch-project#286) * Bump semver from 7.3.5 to 7.3.7 (opensearch-project#280) * Adds bulk example to README (opensearch-project#277) * Adding Dependabot configuration (opensearch-project#278) * Removing OpenDistro integration tests (opensearch-project#271) * Upgrade dependencies (opensearch-project#272) * fix: add missing memory circuit breaker options (opensearch-project#266) * feat: allow `doc` overwrite in `onDocument` (opensearch-project#263) * Adding link checker workflow (opensearch-project#262) * Using standardized templates from .github (opensearch-project#249) * Adding new OpenSearch versions and updating compatibility matrix (opensearch-project#257) Signed-off-by: Miki <miki@amazon.com>

nhtruong requested review from ananzh, kavilla, seanneumann, dblock and VachaShah as code owners January 20, 2023 22:34

dblock requested changes Jan 20, 2023

View reviewed changes

Added Support for AOSS

910fa96

Signed-off-by: Theo Truong <theotr@amazon.com>

nhtruong force-pushed the aoss branch from fbef00a to 910fa96 Compare January 21, 2023 00:41

dblock mentioned this pull request Jan 21, 2023

Fix serverless signing with body #367

Closed

nhtruong requested a review from dblock January 23, 2023 20:04

nhtruong added 2 commits January 23, 2023 13:18

# Added Unit test for x-amz-content-sha256

6fc7192

Signed-off-by: Theo Truong <theotr@amazon.com>

# Increased test plans count

1510ef4

Signed-off-by: Theo Truong <theotr@amazon.com>

dblock approved these changes Jan 23, 2023

View reviewed changes

# updated x-amz-context-sha256 test

21b3616

Signed-off-by: Theo Truong <theotr@amazon.com>

nhtruong merged commit 52010ba into opensearch-project:main Jan 23, 2023

nhtruong deleted the aoss branch January 23, 2023 21:03

mhart reviewed Jan 23, 2023

View reviewed changes

This was referenced Jan 28, 2023

Add missing types for AwsSigv4SignerOptions.service #374

Closed

Add missing types for AwsSigv4SignerOptions.service #377

Merged

harshavamsi added the backport 1.x Backport to 1.x branch label Feb 21, 2023

harshavamsi pushed a commit to harshavamsi/opensearch-js that referenced this pull request Feb 21, 2023

Added Support for AOSS (opensearch-project#366)

d9abc46

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com> (cherry picked from commit 52010ba)

harshavamsi pushed a commit to harshavamsi/opensearch-js that referenced this pull request Feb 21, 2023

Added Support for AOSS (opensearch-project#366)

cf52ec4

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com> (cherry picked from commit 52010ba)

harshavamsi added a commit to harshavamsi/opensearch-js that referenced this pull request Feb 21, 2023

Backport opensearch-project#366 into 1.x

4bbdc47

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

harshavamsi added a commit to harshavamsi/opensearch-js that referenced this pull request Feb 21, 2023

Backport opensearch-project#366 into 1.x

c112d90

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

nhtruong pushed a commit that referenced this pull request Feb 22, 2023

Backport #366 into 1.x (#399)

fbbfed4

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

nhtruong added a commit to nhtruong/opensearch-js that referenced this pull request Feb 27, 2023

Added Support for AOSS (opensearch-project#366)

5d1cb31

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com>

nhtruong pushed a commit to nhtruong/opensearch-js that referenced this pull request Feb 27, 2023

Backport opensearch-project#366 into 1.x (opensearch-project#399)

fc3f9a0

Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>

AMoo-Miki pushed a commit to AMoo-Miki/opensearch-js that referenced this pull request Jul 12, 2023

Added Support for AOSS (opensearch-project#366)

90694dc

* Added Support for AOSS Signed-off-by: Theo Truong <theotr@amazon.com>

AMoo-Miki mentioned this pull request Jul 12, 2023

Manual master cherrypick into 2.x #550

Merged

5 tasks

dblock mentioned this pull request Aug 9, 2024

Added X-Amz-Content-Sha256 for aoss. mhart/aws4#169

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Support for AOSS #366

Added Support for AOSS #366

nhtruong commented Jan 20, 2023

dblock Jan 20, 2023 •

edited

Loading

nhtruong Jan 21, 2023

wbeckler Jan 21, 2023

dblock commented Jan 21, 2023

nhtruong commented Jan 23, 2023

dblock Jan 23, 2023

mhart Jan 23, 2023

mhart Jan 23, 2023

nhtruong Jan 23, 2023 •

edited

Loading

dblock commented Jan 23, 2023

opensearch-trigger-bot bot commented Feb 21, 2023

Added Support for AOSS #366

Added Support for AOSS #366

Conversation

nhtruong commented Jan 20, 2023

Issues Resolved

dblock Jan 20, 2023 • edited Loading

Choose a reason for hiding this comment

nhtruong Jan 21, 2023

Choose a reason for hiding this comment

wbeckler Jan 21, 2023

Choose a reason for hiding this comment

dblock commented Jan 21, 2023

nhtruong commented Jan 23, 2023

dblock Jan 23, 2023

Choose a reason for hiding this comment

mhart Jan 23, 2023

Choose a reason for hiding this comment

mhart Jan 23, 2023

Choose a reason for hiding this comment

nhtruong Jan 23, 2023 • edited Loading

Choose a reason for hiding this comment

dblock commented Jan 23, 2023

opensearch-trigger-bot bot commented Feb 21, 2023

dblock Jan 20, 2023 •

edited

Loading

nhtruong Jan 23, 2023 •

edited

Loading