├── .gitignore ├── package.json ├── sam.yaml ├── index.js ├── README.md ├── test └── unit.js └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .DS_Store 3 | node_modules 4 | npm-debug.log 5 | *.log 6 | git-commit.json 7 | .vscode 8 | standard-redirects-for-cloudfront-sam.yaml 9 | standard-redirects-for-cloudfront-sam-test.yaml -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "standard-redirects-for-cloudfront", 3 | "version": "1.4.3", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "mocha", 8 | "test-coverage": "istanbul cover _mocha", 9 | "predeploy": "git log -1 --pretty=format:'{ \"date\":\"%cI\", \"commit\":\"%H\" }' > git-commit.json", 10 | "deploy": "zip -r LATE-standard-redirects-for-cloudfront.zip . -i \\*.js -i git-commit.json -i node_modules/\\* -x test/\\* -x node_modules/aws-sdk/\\* -x node_modules/mocha/\\* && echo Uploading... && aws lambda update-function-code --region us-east-1 --function-name LATE-standard-redirects-for-cloudfront --zip-file fileb://LATE-standard-redirects-for-cloudfront.zip --publish", 11 | "package": "aws cloudformation package --template-file sam.yaml --output-template-file standard-redirects-for-cloudfront-sam.yaml --s3-bucket public.digital-sailors.de --s3-prefix serverless-application-repo/standard-redirects-for-cloudfront", 12 | "package-test": "aws cloudformation package --template-file sam.yaml --output-template-file standard-redirects-for-cloudfront-sam-test.yaml --s3-bucket demo.digital-sailors.work --s3-prefix serverless-application-repo/standard-redirects-for-cloudfront-test" 13 | }, 14 | "license": "Apache-2.0", 15 | "author": { 16 | "name": "DigitalSailors e.K.", 17 | "email": "contact@digital-sailors.de", 18 | "url": "https://www.digital-sailors.de" 19 | }, 20 | "devDependencies": { 21 | "mocha": "^8.4.0" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /sam.yaml: -------------------------------------------------------------------------------- 1 | AWSTemplateFormatVersion: '2010-09-09' 2 | Transform: AWS::Serverless-2016-10-31 3 | Outputs: 4 | StandardRedirectsForCloudFrontVersionOutput: 5 | Description: The ARN of the function, including the version 6 | Value: !Ref StandardRedirectsForCloudFront.Version 7 | Export: 8 | Name: StandardRedirectsForCloudFrontARN 9 | Resources: 10 | StandardRedirectsForCloudFront: 11 | Type: AWS::Serverless::Function 12 | Properties: 13 | Handler: index.handler 14 | Runtime: nodejs14.x 15 | Description: 'Standard Redirects for CloudFront by Digital Sailors via the Serverless Application Repository.' 16 | Role: !GetAtt LambdaRole.Arn 17 | MemorySize: 128 18 | Timeout: 3 19 | AutoPublishAlias: 'CurrentProd' 20 | 21 | LambdaRole: 22 | Type: AWS::IAM::Role 23 | Properties: 24 | AssumeRolePolicyDocument: 25 | Version: '2012-10-17' 26 | Statement: 27 | Effect: Allow 28 | Principal: 29 | Service: 30 | - lambda.amazonaws.com 31 | - edgelambda.amazonaws.com 32 | Action: sts:AssumeRole 33 | Policies: 34 | - PolicyName: edgelambda-policy 35 | PolicyDocument: 36 | Version: "2012-10-17" 37 | Statement: 38 | - Effect: Allow 39 | Action: 40 | - logs:CreateLogGroup 41 | - logs:CreateLogStream 42 | - logs:PutLogEvents 43 | Resource: '*' 44 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /* 4 | Copyright 2017-2021 DigitalSailors e.K. 5 | 6 | Licensed under the Apache License, Version 2.0 (the "License"); 7 | you may not use this file except in compliance with the License. 8 | You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, software 13 | distributed under the License is distributed on an "AS IS" BASIS, 14 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | See the License for the specific language governing permissions and 16 | limitations under the License. 17 | */ 18 | 19 | exports.handler = (event, context, callback) => { 20 | const request = event.Records[0].cf.request; 21 | 22 | let prefixPath; // needed for 2nd condition 23 | 24 | if (request.uri.match('.+/$')) { 25 | request.uri += 'index.html'; 26 | callback(null, request); 27 | } else if (prefixPath = request.uri.match('(.+)/index.html')) { 28 | const modifiedPrefixPath = prefixPath[1].replace(/^\/+/, '/'); 29 | const response = { 30 | status: '301', 31 | statusDescription: 'Found', 32 | headers: { 33 | location: [{ 34 | key: 'Location', value: modifiedPrefixPath + '/', 35 | }], 36 | } 37 | }; 38 | callback(null, response); 39 | } else if (request.uri.match('/[^/.]+$')) { 40 | const modifiedRequestURI = request.uri.replace(/^\/+/, '/'); 41 | const response = { 42 | status: '301', 43 | statusDescription: 'Found', 44 | headers: { 45 | location: [{ 46 | key: 'Location', value: modifiedRequestURI + '/', 47 | }], 48 | } 49 | }; 50 | callback(null, response); 51 | } else { 52 | callback(null, request); 53 | } 54 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # standard-redirects-for-cloudfront 2 | 3 | A Lambda@Edge function that implements standard web server redirects that simplify directory handling. 4 | 5 | For example, requests for URI paths that end in "/" are rewritten into "/index.html" before the request is passed on to the CloudFront Origin. You may think of that as an "internal" redirect in webserver terms. 6 | 7 | URI paths that end in ".../index.html" are redirected to ".../" with an HTTP status code 301 (Moved Permanently). This is the same as an "external" redirect by a webserver. 8 | 9 | URI paths that do not have an extension and do not end with a "/" are redirected to the same path with an appended "/" with an HTTP status code 301 (Moved Permanently). This is again an "external" redirect. (This may hide actual content from the Origin, if you use paths without extensions!). 10 | 11 | ## Examples 12 | 13 | /foo/bar/ -> internal redirect -> /foo/bar/index.html 14 | /foo -> external redirect (301) -> /foo/ -> internal redirect -> /foo/index.html 15 | /foo.html -> no redirect 16 | /foo/bar.html -> no redirect 17 | /foo/index.html -> external redirect (301) -> /foo/ 18 | 19 | ## Notes 20 | 21 | This URL scheme is somewhat opinionated. It tries to balance SEO requirements with server-side tooling. (E.g. S3 tooling tries to infer the content-type from the file extension.) 22 | 23 | It allows you to have very nice outward facing URLs like "/cooltopic", that internally use a file with a correct extension: "cooltopic/index.html". To have content other than index.html in a folder, you need to expose the file extension: "/cooltopic/somecontent.html" 24 | 25 | Make sure that your CloudFront distribution handles the URL "/" directly by having the property "Default Root Object" set to "index.html". 26 | 27 | ## Updating 28 | 29 | ### Lambda Runtime 30 | 31 | This package uses the `nodejs10.x` Node.js 10 Runtime. Updating the package in your AWS account requires one manual step, which is outlined below. 32 | 33 | ### Procedure 34 | 35 | 1. Install the application "standard-redirects-for-cloudfront". 36 | 2. Go to the Cloudformation Console 37 | 3. Select the Output Value, this is the ARN (including the version) for the Lambda function. 38 | 4. In CloudFront edit a **Behaviour** and add a **Lambda Function Association** with the *Event Type* "Origin Request" and enter the Lambda function ARN from the previous step. 39 | 5. Wait for the CloudFront distribution to deploy. 40 | 41 | ## Installation 42 | 43 | ### Installation via the Serverless Application Repository 44 | 45 | 1. Install the application "standard-redirects-for-cloudfront". 46 | 2. Go to the Cloudformation Console 47 | 3. Select the Output Value, this is the ARN (including the version) for the Lambda function. 48 | 4. In CloudFront edit a **Behaviour** and add a **Lambda Function Association** with the *Event Type* "Origin Request" and enter the Lambda function ARN from the previous step. 49 | 5. Wait for the CloudFront distribution to deploy. 50 | 51 | ### Contact 52 | 53 | For any questions or comments, do contact us! 54 | 55 | Email: contact@digital-sailors.de 56 | Web: https://www.digital-sailors.de/ 57 | 58 | Enjoy! 59 | -------------------------------------------------------------------------------- /test/unit.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | /* 4 | Copyright 2017 DigitalSailors e.K. 5 | 6 | Licensed under the Apache License, Version 2.0 (the "License"); 7 | you may not use this file except in compliance with the License. 8 | You may obtain a copy of the License at 9 | 10 | http://www.apache.org/licenses/LICENSE-2.0 11 | 12 | Unless required by applicable law or agreed to in writing, software 13 | distributed under the License is distributed on an "AS IS" BASIS, 14 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | See the License for the specific language governing permissions and 16 | limitations under the License. 17 | */ 18 | 19 | const assert = require('assert'); 20 | 21 | const index = require('../index.js'); 22 | 23 | describe('Testing index.js', function() { 24 | it('/ -> no redirect', function(done) { 25 | const event = { 26 | Records:[{ cf: { 27 | request: { 28 | uri: '/' 29 | } 30 | } }] }; 31 | index.handler(event, {}, (err, data) => { 32 | done(assert(data.uri === '/')); 33 | }); 34 | }); 35 | 36 | it('/foo/ -> internal redirect -> /foo/index.html', function(done) { 37 | const event = { 38 | Records:[{ cf: { 39 | request: { 40 | uri: '/foo/' 41 | } 42 | } }] }; 43 | index.handler(event, {}, (err, data) => { 44 | done(assert.strictEqual(data.uri, '/foo/index.html')); 45 | }); 46 | }); 47 | 48 | it('/foo/bar/ -> internal redirect -> /foo/bar/index.html', function(done) { 49 | const event = { 50 | Records:[{ cf: { 51 | request: { 52 | uri: '/foo/bar/' 53 | } 54 | } }] }; 55 | index.handler(event, {}, (err, data) => { 56 | done(assert.strictEqual(data.uri, '/foo/bar/index.html')); 57 | }); 58 | }); 59 | 60 | it('/foo -> external redirect (301) -> /foo/', function(done) { 61 | const event = { 62 | Records:[{ cf: { 63 | request: { 64 | uri: '/foo' 65 | } 66 | } }] }; 67 | index.handler(event, {}, (err, data) => { 68 | done(assert.strictEqual(data.status, '301') 69 | || assert.strictEqual(data.headers.location[0].key, 'Location') 70 | || assert.strictEqual(data.headers.location[0].value, '/foo/')); 71 | }); 72 | }); 73 | 74 | it('/foo.html -> no redirect', function(done) { 75 | const event = { 76 | Records:[{ cf: { 77 | request: { 78 | uri: '/foo.html' 79 | } 80 | } }] }; 81 | index.handler(event, {}, (err, data) => { 82 | done(assert.strictEqual(data.uri, '/foo.html')); }); 83 | }); 84 | 85 | it('/foo/bar.html -> no redirect', function(done) { 86 | const event = { 87 | Records:[{ cf: { 88 | request: { 89 | uri: '/foo/bar.html' 90 | } 91 | } }] }; 92 | index.handler(event, {}, (err, data) => { 93 | done(assert.strictEqual(data.uri, '/foo/bar.html')); }); 94 | }); 95 | 96 | it('/foo/index.html -> external redirect (301) -> /foo/', function(done) { 97 | const event = { 98 | Records:[{ cf: { 99 | request: { 100 | uri: '/foo/index.html' 101 | } 102 | } }] }; 103 | index.handler(event, {}, (err, data) => { 104 | done(assert.strictEqual(data.status, '301') 105 | || assert.strictEqual(data.headers.location[0].key, 'Location') 106 | || assert.strictEqual(data.headers.location[0].value, '/foo/')); 107 | }); 108 | }); 109 | 110 | it('//foo/index.html -> external redirect (301) -> /foo/', function(done) { 111 | const event = { 112 | Records:[{ cf: { 113 | request: { 114 | uri: '//foo/index.html' 115 | } 116 | } }] }; 117 | index.handler(event, {}, (err, data) => { 118 | done(assert.strictEqual(data.status, '301') 119 | || assert.strictEqual(data.headers.location[0].key, 'Location') 120 | || assert.strictEqual(data.headers.location[0].value, '/foo/')); 121 | }); 122 | }); 123 | 124 | it('///foo -> external redirect (301) -> /foo/', function(done) { 125 | const event = { 126 | Records:[{ cf: { 127 | request: { 128 | uri: '//foo/index.html' 129 | } 130 | } }] }; 131 | index.handler(event, {}, (err, data) => { 132 | done(assert.strictEqual(data.status, '301') 133 | || assert.strictEqual(data.headers.location[0].key, 'Location') 134 | || assert.strictEqual(data.headers.location[0].value, '/foo/')); 135 | }); 136 | }); 137 | 138 | }); -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------