@aws-sdk/signature-v4 - npm Package Compare versions

Comparing version 3.341.0 to 3.342.0

dist-cjs/SignatureV4.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignatureV4 = void 0;
+const eventstream_codec_1 = require("@aws-sdk/eventstream-codec");
 const util_hex_encoding_1 = require("@aws-sdk/util-hex-encoding");
@@ -18,2 +19,3 @@ const util_middleware_1 = require("@aws-sdk/util-middleware");
     constructor({ applyChecksum, credentials, region, service, sha256, uriEscapePath = true, }) {
+        this.headerMarshaller = new eventstream_codec_1.HeaderMarshaller(util_utf8_1.toUtf8, util_utf8_1.fromUtf8);
         this.service = service;
@@ -56,2 +58,5 @@ this.sha256 = sha256;
         }
+        else if (toSign.message) {
+            return this.signMessage(toSign, options);
+        }
         else {
@@ -79,2 +84,16 @@ return this.signRequest(toSign, options);
     }
+    async signMessage(signableMessage, { signingDate = new Date(), signingRegion, signingService }) {
+        const promise = this.signEvent({
+            headers: this.headerMarshaller.format(signableMessage.message.headers),
+            payload: signableMessage.message.body,
+        }, {
+            signingDate,
+            signingRegion,
+            signingService,
+            priorSignature: signableMessage.priorSignature,
+        });
+        return promise.then((signature) => {
+            return { message: signableMessage.message, signature };
+        });
+    }
     async signString(stringToSign, { signingDate = new Date(), signingRegion, signingService } = {}) {
@@ -81,0 +100,0 @@ const credentials = await this.credentialProvider();

dist-es/SignatureV4.js

@@ -0,4 +1,5 @@
+import { HeaderMarshaller } from "@aws-sdk/eventstream-codec";
 import { toHex } from "@aws-sdk/util-hex-encoding";
 import { normalizeProvider } from "@aws-sdk/util-middleware";
-import { toUint8Array } from "@aws-sdk/util-utf8";
+import { fromUtf8, toUint8Array, toUtf8 } from "@aws-sdk/util-utf8";
 import { ALGORITHM_IDENTIFIER, ALGORITHM_QUERY_PARAM, AMZ_DATE_HEADER, AMZ_DATE_QUERY_PARAM, AUTH_HEADER, CREDENTIAL_QUERY_PARAM, EVENT_ALGORITHM_IDENTIFIER, EXPIRES_QUERY_PARAM, MAX_PRESIGNED_TTL, SHA256_HEADER, SIGNATURE_QUERY_PARAM, SIGNED_HEADERS_QUERY_PARAM, TOKEN_HEADER, TOKEN_QUERY_PARAM, } from "./constants";
@@ -15,2 +16,3 @@ import { createScope, getSigningKey } from "./credentialDerivation";
     constructor({ applyChecksum, credentials, region, service, sha256, uriEscapePath = true, }) {
+        this.headerMarshaller = new HeaderMarshaller(toUtf8, fromUtf8);
         this.service = service;
@@ -53,2 +55,5 @@ this.sha256 = sha256;
         }
+        else if (toSign.message) {
+            return this.signMessage(toSign, options);
+        }
         else {
@@ -76,2 +81,16 @@ return this.signRequest(toSign, options);
     }
+    async signMessage(signableMessage, { signingDate = new Date(), signingRegion, signingService }) {
+        const promise = this.signEvent({
+            headers: this.headerMarshaller.format(signableMessage.message.headers),
+            payload: signableMessage.message.body,
+        }, {
+            signingDate,
+            signingRegion,
+            signingService,
+            priorSignature: signableMessage.priorSignature,
+        });
+        return promise.then((signature) => {
+            return { message: signableMessage.message, signature };
+        });
+    }
     async signString(stringToSign, { signingDate = new Date(), signingRegion, signingService } = {}) {
@@ -78,0 +97,0 @@ const credentials = await this.credentialProvider();

dist-types/SignatureV4.d.ts

@@ -1,2 +0,2 @@
-import { AwsCredentialIdentity, ChecksumConstructor, EventSigner, EventSigningArguments, FormattedEvent, HashConstructor, HttpRequest, Provider, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments, SigningArguments, StringSigner } from "@aws-sdk/types";
+import { AwsCredentialIdentity, ChecksumConstructor, EventSigner, EventSigningArguments, FormattedEvent, HashConstructor, HttpRequest, MessageSigner, Provider, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments, SignableMessage, SignedMessage, SigningArguments, StringSigner } from "@aws-sdk/types";
 export interface SignatureV4Init {
@@ -43,3 +43,3 @@ /**
 }
-export declare class SignatureV4 implements RequestPresigner, RequestSigner, StringSigner, EventSigner {
+export declare class SignatureV4 implements RequestPresigner, RequestSigner, StringSigner, EventSigner, MessageSigner {
     private readonly service;
@@ -51,2 +51,3 @@ private readonly regionProvider;
     private readonly applyChecksum;
+    private readonly headerMarshaller;
     constructor({ applyChecksum, credentials, region, service, sha256, uriEscapePath, }: SignatureV4Init & SignatureV4CryptoInit);
@@ -56,4 +57,6 @@ presign(originalRequest: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;
     sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
+    sign(event: SignableMessage, options: SigningArguments): Promise<SignedMessage>;
     sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
     private signEvent;
+    signMessage(signableMessage: SignableMessage, { signingDate, signingRegion, signingService }: SigningArguments): Promise<SignedMessage>;
     private signString;
@@ -60,0 +63,0 @@ private signRequest;

dist-types/ts3.4/SignatureV4.d.ts

@@ -9,2 +9,3 @@ import {
   HttpRequest,
+  MessageSigner,
   Provider,
@@ -15,2 +16,4 @@ RequestPresigner,
   RequestSigningArguments,
+  SignableMessage,
+  SignedMessage,
   SigningArguments,
@@ -31,3 +34,8 @@ StringSigner,
 export declare class SignatureV4
-  implements RequestPresigner, RequestSigner, StringSigner, EventSigner
+  implements
+    RequestPresigner,
+    RequestSigner,
+    StringSigner,
+    EventSigner,
+    MessageSigner
 {
@@ -40,2 +48,3 @@ private readonly service;
   private readonly applyChecksum;
+  private readonly headerMarshaller;
   constructor({
@@ -56,2 +65,6 @@ applyChecksum,
   sign(
+    event: SignableMessage,
+    options: SigningArguments
+  ): Promise<SignedMessage>;
+  sign(
     requestToSign: HttpRequest,
@@ -61,2 +74,6 @@ options?: RequestSigningArguments
   private signEvent;
+  signMessage(
+    signableMessage: SignableMessage,
+    { signingDate, signingRegion, signingService }: SigningArguments
+  ): Promise<SignedMessage>;
   private signString;
@@ -63,0 +80,0 @@ private signRequest;

package.json

 {
   "name": "@aws-sdk/signature-v4",
-  "version": "3.341.0",
+  "version": "3.342.0",
   "description": "A standalone implementation of the AWS Signature V4 request signing algorithm",
@@ -25,6 +25,7 @@ "main": "./dist-cjs/index.js",
   "dependencies": {
+    "@aws-sdk/eventstream-codec": "3.342.0",
     "@aws-sdk/is-array-buffer": "3.310.0",
-    "@aws-sdk/types": "3.341.0",
+    "@aws-sdk/types": "3.342.0",
     "@aws-sdk/util-hex-encoding": "3.310.0",
-    "@aws-sdk/util-middleware": "3.341.0",
+    "@aws-sdk/util-middleware": "3.342.0",
     "@aws-sdk/util-uri-escape": "3.310.0",
@@ -36,3 +37,3 @@ "@aws-sdk/util-utf8": "3.310.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/protocol-http": "3.341.0",
+    "@aws-sdk/protocol-http": "3.342.0",
     "@tsconfig/recommended": "1.0.1",
@@ -39,0 +40,0 @@ "concurrently": "7.0.0",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

104264

increased by2.38%

Lines of code

2118

increased by2.82%

Worsened metrics

Dependency count

8

increased by14.29%

Dependency changes

• + Added@aws-sdk/eventstream-codec@3.342.0

• + Added@aws-crypto/crc32@3.0.0(transitive)

• + Added@aws-crypto/util@3.0.0(transitive)

• + Added@aws-sdk/eventstream-codec@3.342.0(transitive)

• + Added@aws-sdk/types@3.342.0(transitive)

• + Added@aws-sdk/util-middleware@3.342.0(transitive)

• + Added@aws-sdk/util-utf8-browser@3.259.0(transitive)

• + Addedtslib@1.14.1(transitive)

• - Removed@aws-sdk/types@3.341.0(transitive)

• - Removed@aws-sdk/util-middleware@3.341.0(transitive)

• Updated@aws-sdk/types@3.342.0

• Updated@aws-sdk/util-middleware@3.342.0