Allow credentials instead of key/secret for the S3 store (#282)

Author: phillip-causing

README.md

@@ -30,6 +30,8 @@ $ npm install tus-node-server
     ```
 
 - **Amazon S3**
+    
+    using Key/Secret
     ```js
 
     server.datastore = new tus.S3Store({
@@ -41,6 +43,23 @@ $ npm install tus-node-server
     });
     ```
 
+    using [credentials](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Credentials.html#constructor-property) to fetch credentials inside a AWS container, such as an ECS container, which will inject the required environment variables. The `credentials` config is directly passed into the AWS SDK so you can refer to the AWS docs for the supported values for `credentials`.
+    
+    For example, with `ECSCredentials`:
+    
+    ```js
+    server.datastore = new tus.S3Store({
+        path: '/files',
+        bucket: 'bucket-name',
+        credentials: new AWS.ECSCredentials({
+            httpOptions: { timeout: 5000 },
+            maxRetries: 10,
+        }),
+        region: 'eu-west-1',
+        partSize: 8 * 1024 * 1024, // each uploaded part will have ~8MB,
+        tmpDirPrefix: 'tus-s3-store',
+    });
+    ```
 ## Quick Start
 
 #### Use the [tus-node-deploy](https://hub.docker.com/r/bhstahl/tus-node-deploy/) Docker image

index.d.ts

@@ -1,5 +1,7 @@
 import { EventEmitter } from "events";
 import * as http from "http";
+import { RemoteCredentials } from 'aws-sdk'
+
 
 declare interface Configstore {
     get(key: string) : Promise<IFile | undefined> | IFile | undefined;
@@ -10,7 +12,7 @@ declare interface Configstore {
 declare interface ServerOptions {
     path: string;
     relativeLocation?: boolean;
-    namingFunction?: () => string;
+    namingFunction?: (req: http.IncomingMessage) => string;
 }
 
 /**
@@ -30,10 +32,9 @@ declare interface GCStoreOptions extends DataStoreOptions {
 }
 
 declare interface S3StoreOptions extends DataStoreOptions {
-    accessKeyId: string;
-    secretAccessKey: string;
     bucket: string;
     region?: string;
+    tmpDirPrefix?: string;
     partSize: number;
 }
 
@@ -97,7 +98,9 @@ export declare class GCSDataStore extends DataStore {
  * file store in AWS S3
  */
 export declare class S3Store extends DataStore {
-    constructor(options: S3StoreOptions);
+    constructor(options: S3StoreOptions & { accessKeyId: string, secretAccessKey: string });
+    constructor(options: S3StoreOptions & { credentials: RemoteCredentials });
+    getOffset(file_id: string, with_parts?: boolean): Promise<any>;
 }
 
 /**

lib/stores/S3Store.js

@@ -53,8 +53,15 @@ class S3Store extends DataStore {
 
         this.extensions = ['creation', 'creation-with-upload', 'creation-defer-length'];
 
-        assert.ok(options.accessKeyId, '[S3Store] `accessKeyId` must be set');
-        assert.ok(options.secretAccessKey, '[S3Store] `secretAccessKey` must be set');
+
+        if (options.accessKeyId || options.secretAccessKey) {
+            assert.ok(options.accessKeyId, '[S3Store] `accessKeyId` must be set');
+            assert.ok(options.secretAccessKey, '[S3Store] `secretAccessKey` must be set');
+        }
+        else {
+            assert.ok(options.credentials, '[S3Store] `credentials` must be set');
+        }
+
         assert.ok(options.bucket, '[S3Store] `bucket` must be set');
 
         this.bucket_name = options.bucket;