WIP: Implement LFS plugin storing large objects in an Amazon S3 bucket This plugin uses JGit's S3Repository class to provide a large file storage using an Amazon S3 bucket. The plugin supports only in-tree buck build. To build it clone the repository under .../plugins folder and then execute: $ buck build plugins/lfs-storage-s3 Change-Id: I635c1c5454a0b23a8e9f9fceab9743692f7c72cb Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1d324ed --- /dev/null +++ b/.gitignore
@@ -0,0 +1,3 @@ +/.classpath +/.project +/.settings/org.maven.ide.eclipse.prefs
diff --git a/BUCK b/BUCK new file mode 100644 index 0000000..147c902 --- /dev/null +++ b/BUCK
@@ -0,0 +1,58 @@ +include_defs('//lib/maven.defs') +include_defs('//lib/JGIT_VERSION') + +gerrit_plugin( + name = 'lfs-storage-s3', + srcs = glob(['src/main/java/**/*.java']), + resources = glob(['src/main/resources/**/*']), + deps = [ + ':jgit-http-apache', + ':jgit-lfs', + ':jgit-lfs-server', + ], + manifest_entries = [ + 'Gerrit-PluginName: lfs-storage-s3', + 'Gerrit-HttpModule: com.googlesource.gerrit.plugins.lfs.s3.HttpModule', + ], +) + +maven_jar( + name = 'jgit-http-apache', + id = 'org.eclipse.jgit:org.eclipse.jgit.http.apache:' + VERS, + sha1 = '8a589f2c7a623d8fc5a38edbaf11af2061a2baea', + license = 'jgit', + repository = REPO, + unsign = True, + exclude = [ + 'about.html', + 'plugin.properties', + ], +) + +maven_jar( + name = 'jgit-lfs', + id = 'org.eclipse.jgit:org.eclipse.jgit.lfs:' + VERS, + bin_sha1 = '3ac14ac1fe71b9390183b9a41a749182556c5bf2', + src_sha1 = '4008b18150f71a4eb6da77882ef222ce86a8a469', + license = 'jgit', + repository = REPO, + unsign = True, + exclude = [ + 'about.html', + 'plugin.properties', + ], +) + +maven_jar( + name = 'jgit-lfs-server', + id = 'org.eclipse.jgit:org.eclipse.jgit.lfs.server:' + VERS, + bin_sha1 = '0eb4803d6fa08100a4bd8dfbac44ec21f870ceff', + src_sha1 = '95b1695aca8ec1b53f6ca17f3d3361f2c2ac71f3', + license = 'jgit', + repository = REPO, + unsign = True, + exclude = [ + 'about.html', + 'plugin.properties', + ], +)
diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..11069ed --- /dev/null +++ b/LICENSE
@@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.
diff --git a/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/HttpModule.java b/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/HttpModule.java new file mode 100644 index 0000000..c9999ca --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/HttpModule.java
@@ -0,0 +1,28 @@ +// Copyright (C) 2016 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.googlesource.gerrit.plugins.lfs.s3; + +import static com.google.gerrit.httpd.plugins.LfsPluginServlet.URL_REGEX; + +import com.google.gerrit.httpd.plugins.HttpPluginModule; + +public class HttpModule extends HttpPluginModule { + + @Override + protected void configureServlets() { + serveRegex(URL_REGEX).with(LfsApiServlet.class); + bind(S3LargeFileRepository.class); + } +}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/LfsApiServlet.java b/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/LfsApiServlet.java new file mode 100644 index 0000000..985c663 --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/LfsApiServlet.java
@@ -0,0 +1,38 @@ +//Copyright (C) 2016 The Android Open Source Project +// +//Licensed under the Apache License, Version 2.0 (the "License"); +//you may not use this file except in compliance with the License. +//You may obtain a copy of the License at +// +//http://www.apache.org/licenses/LICENSE-2.0 +// +//Unless required by applicable law or agreed to in writing, software +//distributed under the License is distributed on an "AS IS" BASIS, +//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +//See the License for the specific language governing permissions and +//limitations under the License. + +package com.googlesource.gerrit.plugins.lfs.s3; + +import com.google.inject.Inject; +import com.google.inject.Singleton; + +import org.eclipse.jgit.lfs.server.LargeFileRepository; +import org.eclipse.jgit.lfs.server.LfsProtocolServlet; + +@Singleton +public class LfsApiServlet extends LfsProtocolServlet { + private static final long serialVersionUID = 1L; + + private final S3LargeFileRepository repository; + + @Inject + LfsApiServlet(S3LargeFileRepository repository) { + this.repository = repository; + } + + @Override + protected LargeFileRepository getLargeFileRepository() { + return repository; + } +} \ No newline at end of file
diff --git a/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/S3LargeFileRepository.java b/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/S3LargeFileRepository.java new file mode 100644 index 0000000..c9da0f3 --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/lfs/s3/S3LargeFileRepository.java
@@ -0,0 +1,46 @@ +// Copyright (C) 2015 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.googlesource.gerrit.plugins.lfs.s3; + +import com.google.gerrit.extensions.annotations.PluginName; +import com.google.gerrit.server.config.PluginConfig; +import com.google.gerrit.server.config.PluginConfigFactory; +import com.google.inject.Inject; + +import org.eclipse.jgit.lfs.server.s3.S3Config; +import org.eclipse.jgit.lfs.server.s3.S3Repository; + +public class S3LargeFileRepository extends S3Repository { + + @Inject + S3LargeFileRepository(PluginConfigFactory cfg, @PluginName String pluginName) { + super(getS3Config(cfg, pluginName)); + } + + private static S3Config getS3Config(PluginConfigFactory configFactory, + String pluginName) { + PluginConfig cfg = configFactory.getFromGerritConfig(pluginName); + String region = cfg.getString("region", null); + String bucket = cfg.getString("bucket", null); + String storageClass = cfg.getString("storageClass", "REDUCED_REDUNDANCY"); + String accessKey = cfg.getString("accessKey", null); + String secretKey = cfg.getString("secretKey", null); + int expirationSeconds = cfg.getInt("expirationSeconds", 60); + boolean disableSslVerify = cfg.getBoolean("disableSslVerify", false); + + return new S3Config(region, bucket, storageClass, accessKey, secretKey, + expirationSeconds, disableSslVerify); + } +}
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md new file mode 100644 index 0000000..c379e0c --- /dev/null +++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1 @@ +This plugin provides an Amazon S3 storage for the LFS service.
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md new file mode 100644 index 0000000..8aa0ccf --- /dev/null +++ b/src/main/resources/Documentation/config.md
@@ -0,0 +1,55 @@ +@PLUGIN@ Configuration +====================== + +The following options can be configured in `etc/gerrit.config` + +[[plugin "lfs-storage-s3"]] +=== Section plugin.lfs-storage-s3 + +[[plugin.lfs-storage-s3.region]]plugin.lfs-storage-s3.region:: ++ +link:http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions +[Amazon region] the S3 storage bucket is residing in. + +[[plugin.lfs-storage-s3.bucket]]plugin.lfs-storage-s3.bucket:: ++ +Name of the link:http://docs.aws.amazon.com/AmazonS3/latest/UG/CreatingaBucket.html +[Amazon S3 storage bucket] which will store large objects. + +[[plugin.lfs-storage-s3.storageClass]]plugin.lfs-storage-s3.storageClass:: ++ +link:http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html +[Amazon S3 storage class] used for storing large objects. ++ +Default is `REDUCED_REDUNDANCY` + +[[plugin.lfs-storage-s3.expiration]]plugin.lfs-storage-s3.expiration:: ++ +Expiration in seconds of validity of signed requests. Gerrit's LFS protocol +handler signs requests to be issued by the git-lfs extension with the configured +`accessKey` and `secretKey`. This way the git-lfs extension doesn't need +any credentials to access objects in the S3 bucket. Validity of these request +signatures expires after this period. ++ +Default is `60` seconds. + +[[plugin.lfs-storage-s3.disableSslVerify]]plugin.lfs-storage-s3.disableSslVerify:: ++ +`true`: SSL verification is disabled ++ +`false`: SSL verification is enabled ++ +Default is `false`. + +---- +The following options can be configured in `etc/secure.config` + +[[plugin.lfs-storage-s3.accessKey]]plugin.lfs-storage-s3.accessKey:: ++ +The link:http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html +[Amazon IAM accessKey] for authenticating to S3. + +[[plugin.lfs-storage-s3.secretKey]]plugin.lfs-storage-s3.secretKey:: ++ +The link:http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html +[Amazon IAM secretKey] for authenticating to S3.