Skip to content

AWS Lambda powered drop-in replacement for ImageMagick convert command line tool

License

Notifications You must be signed in to change notification settings

envoy/lambda-convert

Repository files navigation

lambda-convert

AWS Lambda powered drop-in replacement for ImageMagick convert command line tool

Background

At Envoy, we have many image file uploaded by users and will be resized via convert (ImageMagick) command line tool. It works fine, the only problems are

Dealing with big GIF image

When user upload a GIF image, to resize it, ImageMagick will need to load the all frames into memory. In that case, even the GIF image file is very small, could posiblly consume huge amount of memory. This brings big impact to our API server, and sometimes the uploading request fails due to this reason.

Security concerns

Despite it's not really easy to perform, it still possible to leverage exploits of certain image file format loading code in ImageMagick.

Solution

To eliminate the big image file uploading issue and the security risk, the idea here is to do image resizing on AWS Lambda instead of localhost. This command line tool is a drop-in replacement for convert command, except it upload the input image file to S3, does the resizing on AWS Lambda and finally down the result image back to localhost.

Environment variables

  • CONVERT_S3_REGION - AWS region for S3, default value will be read from AWS_REGION if this environment variable is not set.
  • CONVERT_LAMBDA_REGION - AWS region for Lambda, default value will be read from AWS_REGION if this environment variable is not set.
  • CONVERT_ACCESS_KEY - AWS access key, default value will follow standard aws-sdk credential lookup sequence
  • CONVERT_SECRET_ACCESS_KEY - AWS secret key, default value will follow standard aws-sdk credential lookup sequence
  • CONVERT_S3_BUCKET - AWS S3 bucket. (required)
  • CONVERT_S3_KEY_PREFIX - AWS S3 temporary file uploading prefix, default value is _convert_tmp/
  • CONVERT_LAMBDA_FUNCTION - Name of the AWS Lambda function to invoke, default value is image-convert-prod
  • CONVERT_DISABLE_FALLBACK - By default, this command line tool fallbacks to local convert command if remote operation fails. Set this value to 1 to disable the fallback behavior.

The AWS Lambda function

The AWS Lambda function for running ImageMagick can be found here at https://github.com/envoy/envoy-convert

About

AWS Lambda powered drop-in replacement for ImageMagick convert command line tool

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages