Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 6.97 KB

README.md

File metadata and controls

149 lines (104 loc) · 6.97 KB
Raw

cdk-s3-upload-presignedurl-api

npmjs PyPI Maven Central

cdk-s3-upload-presignedurl-api is AWS CDK construct library that create an API to get a presigned url to upload a file in S3.

Background

In web and mobile applications, it's common to provide the ability to upload data (documents, images, ...). Uploading files on a web server can be challenging and AWS recommends to upload files directly to S3. To do that securely, you can use pre-signed URLs. This blog post provides some more details.

Architecture

Architecture

  1. The client makes a call to the API, specifying the "contentType" of the file to upload in request parameters (eg. ?contentType=image/png in the URL)
  2. API Gateway handles the request and execute the Lambda function.
  3. The Lambda function makes a call to the getSignedUrl api for a putObject operation.
  4. The Lambda function returns the generated URL and the key of the object in S3 to API Gateway.
  5. The API returns the generated URL and the key of the object in S3 to the client.
  6. The client can now use this URL to upload a file, directly to S3.

Getting Started

TypeScript

Installation

$ npm install --save cdk-s3-upload-presignedurl-api

Usage

import * as cdk from '@aws-cdk/core';
import { S3UploadPresignedUrlApi } from 'cdk-s3-upload-presignedurl-api';

const app = new cdk.App();
const stack = new cdk.Stack(app, '<your-stack-name>');

new S3UploadPresignedUrlApi(stack, 'S3UploadSignedUrl');

Python

Installation

$ pip install cdk-s3-upload-presignedurl-api

Usage

import aws_cdk as cdk
from cdk_s3_upload_presignedurl_api import S3UploadPresignedUrlApi

app = cdk.App()
stack = cdk.Stack(app, "<your-stack-name>")

S3UploadPresignedUrlApi(stack, 'S3UploadSignedUrl')

Java

Maven configuration

<dependency>
    <groupId>io.github.jeromevdl.awscdk</groupId>
    <artifactId>s3-upload-presignedurl-api</artifactId>
    <version>...</version>
</dependency>

Usage

import software.amazon.awscdk.App;
import software.amazon.awscdk.Stack;
import io.github.jeromevdl.awscdk.s3uploadpresignedurlapi.S3UploadPresignedUrlApi;

App app = new App();
Stack stack = new Stack(app, "<your-stack-name>");

new S3UploadPresignedUrlApi(stack, "S3UploadSignedUrl");

Configuration

By default and without any property, the S3UploadPresignedUrlApi construct will create:

  • The S3 Bucket, with the appropriate CORS configuration
  • The Lambda function, that will genereate the pre-signed URL
  • The REST API, that will expose the Lambda function to the client
  • The Cognito User Pool and User Pool Client to secure the API

You can shoose to let the construct do everything or you can reuse existing resources:

  • An S3 Bucket (existingBucketObj). Be carefull to configure CORS properly (doc)
  • A Cognito User Pool (existingUserPoolObj).

You can also customize the construct:

  • You can define the properties for the REST API (apiGatewayProps). Note that you cannot reuse an existing API.
  • You can configure the allowed origins (allowedOrigins) when configuring CORS. Default is *.
  • You can configure the expiration of the generated URLs, in seconds (expiration).
  • You can choose to let the API open, and remove Cognito, by setting secured to false.
  • You can choose the log retention period (logRetention) for Lambda and API Gateway.

See API reference for the details.

Client-side usage

Hint: A complete example (ReactJS / Amplify) if provided in the GitHub repository (frontend folder).

Once the components are deployed, you will need to query the API from the client. In order to do so, you need to retrieve the outputs of the CloudFormation Stack:

  • The API Endpoint (eg. https://12345abcd.execute-api.eu-west-1.amazonaws.com/prod/)
  • The User Pool Id (eg. eu-west-1_2b4C6E8g)
  • The User Pool Client Id (eg. g5465n67cvfc7n6jn54768)

Create a user in Cognito User Pool

If you let the Construct configuration by default (secured = true and no reuse of pre-existing User Pool), you will have to create users in the User Pool. See the documentation. Note that the user pool allows self-registration of users.

Client connection to Cognito User Pool

To authenticate the users on your client, you can use the amazon-cognito-identity-js library or Amplify which is much simpler to setup.

Calling the API

  • HTTP Method: GET
  • URL: https://12345abcd.execute-api.eu-west-1.amazonaws.com/prod/ (replace with yours)
  • Query Parameters: contentType (a valid MIME Type, eg. image/png or application/pdf)
  • Headers: Authorization header must contain the JWT Token retrieve from Cognito
    • Ex with Amplify: Auth.currentSession()).getIdToken().getJwtToken()

Ex with curl:

curl "https://ab12cd34.execute-api.eu-west-1.amazonaws.com/prod/?contentType=image/png" -H "Authorization: eyJraW...AZjp4gQA"

The API will return a JSON containing the uploadURL and the key of the S3 object:

{"uploadURL":"https://yourbucknetname.s3.eu-west-1.amazonaws.com/0454dfa5-8ca5-448a-ae30-9b734313362a.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=SADJKLJKJDF3%24NFDSFDFeu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20221218T095711Z&X-Amz-Expires=300&X-Amz-Security-Token=1234cdef&X-Amz-Signature=13579abcde&X-Amz-SignedHeaders=host&x-id=PutObject","key":"0454dfa5-8ca5-448a-ae30-9b734313362a.png"}

Upload the file

You can finally use the uploadURL and the PUT HTTP method to upload your file to S3. You need to specify the exact same content type in the headers.

Ex with curl:

curl  "https://yourbucknetname.s3.eu-west-1.amazonaws.com/0454dfa5-8ca5-448a-ae30-9b734313362a.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=SADJKLJKJDF3%24NFDSFDFeu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20221218T095711Z&X-Amz-Expires=300&X-Amz-Security-Token=1234cdef&X-Amz-Signature=13579abcde&X-Amz-SignedHeaders=host&x-id=PutObject" --upload-file "path/to/my/file.png" -H "Content-Type: image/png"