Skip to main content

Construct to create a private asset S3 bucket. A cognito token can be used to allow access to he S3 asset.

Project description

NPM version PyPI version .NET version Release

cdk-private-asset-bucket

A construct to create a private asset S3 bucket. Cognito will be used for token validation with Lambda@Edge.

Architecture

Diagram

Curious how I did the diagram? Have a look here https://martinmueller.dev/cdk-dia-eng .

Example

    import { PrivateAssetBucket } from 'cdk-private-assets-bucket';
    ...
    const userPool = new cognito.UserPool(stack, 'userPool', {
      removalPolicy: core.RemovalPolicy.DESTROY,
    });

    const userPoolWebClient = new cognito.UserPoolClient(stack, 'userPoolWebClient', {
      userPool: userPool,
      generateSecret: false,
      preventUserExistenceErrors: true,
      authFlows: {
        adminUserPassword: true,
        userPassword: true,
      },
      oAuth: {
        flows: {
          authorizationCodeGrant: false,
          implicitCodeGrant: true,
        },
      },
    });

    const privateAssetBucket = new PrivateAssetBucket(stack, 'privateAssetBucket', {
      userPoolId: userPool.userPoolId,
      userPoolClientId: userPoolWebClient.userPoolClientId,
      tokenUse: 'access',
    });

    new core.CfnOutput(stack, 'AssetBucketName', {
      value: privateAssetBucket.assetBucketName,
    });

    new core.CfnOutput(stack, 'AssetBucketCloudfrontUrl', {
      value: privateAssetBucket.assetBucketCloudfrontUrl,
    });

Properties

API.md

Test PrivateBucketAsset

If you forged / cloned that repo you can test directly from here. Don't forget to init with:

yarn install

Create a test cdk stack with one of the following:

yarn cdk deploy
yarn cdk deploy --watch
yarn cdk deploy --require-approval never
  • Upload a picture named like pic.png to the private asset bucket
  • Create a user pool user and get / save the token:
USER_POOL_ID=us-east-1_0Aw1oPvD6
CLIENT_ID=3eqcgvghjbv4d5rv32hopmadu8
USER_NAME=martindev
USER_PASSWORD=M@rtindev1
REGION=us-east-1
CFD=d1f2bfdek3mzi7.cloudfront.net

aws cognito-idp admin-create-user --user-pool-id $USER_POOL_ID --username $USER_NAME --region $REGION
aws cognito-idp admin-set-user-password --user-pool-id $USER_POOL_ID --username $USER_NAME --password $USER_PASSWORD  --permanent --region $REGION
ACCESS_TOKEN=$(aws cognito-idp initiate-auth --auth-flow USER_PASSWORD_AUTH --client-id $CLIENT_ID --auth-parameters USERNAME=$USER_NAME,PASSWORD=$USER_PASSWORD  --region $REGION | jq -r '.AuthenticationResult.AccessToken')

echo "curl --location --request GET "https://$CFD/pic.png" --cookie "Cookie: token=$ACCESS_TOKEN""
  • You can use the curl for importing in Postman. but it looks like Postman can't import the cookie. So you need to set the cookie manually in Postman!
  • In Postman you should see your picture :)
  • For Debugging the Lambda@Edge with Cloudwatch go to the AWS Console --> Cloudwatch --> Log groups --> switch to the region you are closest to --> figure out which log group is correct

Planned Features

  • Support custom authorizer
  • Leverage Cloudfront Function for cheaper costs

Misc

git tag -a v2.16.0 -m "prepare tag version" && git push --tags

Thanks To

I love to work on Content Management Open Source projects. A lot from my stuff you can already use on https://github.com/mmuller88 . If you like my work there and my blog posts, please consider supporting me on Patreon:

Become a Patreon!

Buy Me a Coffee at ko-fi.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk-private-asset-bucket-2.19.1.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

cdk_private_asset_bucket-2.19.1-py3-none-any.whl (10.0 MB view details)

Uploaded Python 3

File details

Details for the file cdk-private-asset-bucket-2.19.1.tar.gz.

File metadata

File hashes

Hashes for cdk-private-asset-bucket-2.19.1.tar.gz
Algorithm Hash digest
SHA256 f855cf7d16486a1f404a978981ccefebb5bc0a8b86f726593297e47861959c5e
MD5 be147efba66001ca8f30b96abd1b31b9
BLAKE2b-256 5a2e056ebb7962be4241846d4e297ed3c6ba209635dab71252aa158e3c106295

See more details on using hashes here.

File details

Details for the file cdk_private_asset_bucket-2.19.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cdk_private_asset_bucket-2.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 12d3ec4e8ef8ef782315582371790c08f2537005ebbc33e5d5ea196ad24c10df
MD5 02749677f45a72efd4e35a276aba5072
BLAKE2b-256 27b77d822b534f1b975622a4417ab2ef12e4d063331f7e3191ce8b98406ac703

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page