├── .gitignore ├── CONTRIB.md ├── LICENSE ├── README.md ├── conf.example.py ├── gcs-signed-url-example.py └── requirements.txt /.gitignore: -------------------------------------------------------------------------------- 1 | conf.py 2 | privatekey.der 3 | -------------------------------------------------------------------------------- /CONTRIB.md: -------------------------------------------------------------------------------- 1 | # How to become a contributor and submit your own code 2 | 3 | ## Contributor License Agreements 4 | 5 | We'd love to accept your sample apps and patches! Before we can take them, we have to jump a couple of legal hurdles. 6 | 7 | Please fill out either the individual or corporate Contributor License Agreement (CLA). 8 | 9 | * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). 10 | * If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). 11 | 12 | Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests. 13 | 14 | ## Contributing A Patch 15 | 16 | 1. Submit an issue describing your proposed change to the repo in question. 17 | 1. The repo owner will respond to your issue promptly. 18 | 1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). 19 | 1. Fork the desired repo, develop and test your code changes. 20 | 1. Ensure that your code adheres to the existing style in the sample to which you are contributing. Refer to the [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the recommended coding standards for this organization. 21 | 1. Ensure that your code has an appropriate set of unit tests which all pass. 22 | 1. Submit a pull request. 23 | 24 | ## Contributing A New Sample App 25 | 26 | 1. Submit an issue to the GoogleCloudPlatform/Template repo describing your proposed sample app. 27 | 1. The Template repo owner will respond to your enhancement issue promptly. Instructional value is the top priority when evaluating new app proposals for this collection of repos. 28 | 1. If your proposal is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). 29 | 1. Create your own repo for your app following this naming convention: 30 | * {product}-{app-name}-{language} 31 | * products: appengine, compute, storage, bigquery, prediction, cloudsql 32 | * example: appengine-guestbook-python 33 | * For multi-product apps, concatenate the primary products, like this: compute-appengine-demo-suite-python. 34 | * For multi-language apps, concatenate the primary languages like this: appengine-sockets-python-java-go. 35 | 1. Clone the README.md, CONTRIB.md and LICENSE files from the GoogleCloudPlatform/Template repo. 36 | 1. Ensure that your code adheres to the existing style in the sample to which you are contributing. Refer to the [Google Cloud Platform Samples Style Guide](https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the recommended coding standards for this organization. 37 | 1. Ensure that your code has an appropriate set of unit tests which all pass. 38 | 1. Submit a request to fork your repo in GoogleCloudPlatform organization via your proposal issue. 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Google Cloud Storage Signed URLs Example 2 | 3 | This script is an example of using a service account's private key to create 4 | signatures required for clients to access Google Cloud Storage using [signed URL 5 | authentication](https://developers.google.com/storage/docs/accesscontrol#Signed-URLs). 6 | 7 | ## Required Dependencies 8 | 9 | The following third-party Python modules are required: 10 | 11 | * [requests](http://docs.python-requests.org/en/latest/) 12 | * [PyCrypto](https://www.dlitz.net/software/pycrypto/) 13 | 14 | The easiest way to install the dependencies is to run: 15 | 16 | pip install -r requirements.txt 17 | 18 | ## Configuration 19 | 20 | The `conf.example.py` file must be copied to `conf.py` and the variables in the 21 | file must be filled in. See the example file for explanation of each variable. 22 | 23 | ## Example Flow 24 | 25 | The example script's flow is as follows: 26 | 27 | * Generates a signature for a PUT request and uses it to upload a new file. 28 | * Generates a signature for a GET request and uses it to download the new 29 | file that was just uploaded. 30 | * Generates a signature for a DELETE request and uses it to delete the file 31 | that was created. 32 | -------------------------------------------------------------------------------- /conf.example.py: -------------------------------------------------------------------------------- 1 | import os.path 2 | 3 | # The email address for your GCS service account being used for signatures. 4 | SERVICE_ACCOUNT_EMAIL = ('abcdef1234567890@developer.gserviceaccount.com') 5 | 6 | # Bucket name to use for writing example file. 7 | BUCKET_NAME = 'bucket-name' 8 | # Object name to use for writing example file. 9 | OBJECT_NAME = 'object.txt' 10 | 11 | # Set this to the path of your service account private key file, in DER format. 12 | # 13 | # PyCrypto requires using the DER key format, but GCS provides key files in 14 | # pkcs12 format. To convert between formats, you can use the provided commands 15 | # below. 16 | # 17 | # The default password for p12 file is `notasecret` 18 | # 19 | # Given a GCS key in pkcs12 format, convert it to PEM using this command: 20 | # openssl pkcs12 -in path/to/key.p12 -nodes -nocerts > path/to/key.pem 21 | # Given a GCS key in PEM format, convert it to DER format using this command: 22 | # openssl rsa -in privatekey.pem -inform PEM -out privatekey.der -outform DER 23 | PRIVATE_KEY_PATH = os.path.join(os.path.dirname(__file__), 'privatekey.der') 24 | -------------------------------------------------------------------------------- /gcs-signed-url-example.py: -------------------------------------------------------------------------------- 1 | # Copyright 2013 Google, Inc. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | """Contains an example of using Google Cloud Storage Signed URLs.""" 16 | 17 | import base64 18 | import datetime 19 | import md5 20 | import sys 21 | import time 22 | 23 | import Crypto.Hash.SHA256 as SHA256 24 | import Crypto.PublicKey.RSA as RSA 25 | import Crypto.Signature.PKCS1_v1_5 as PKCS1_v1_5 26 | import requests 27 | 28 | try: 29 | import conf 30 | except ImportError: 31 | sys.exit('Configuration module not found. You must create a conf.py file. ' 32 | 'See the example in conf.example.py.') 33 | 34 | # The Google Cloud Storage API endpoint. You should not need to change this. 35 | GCS_API_ENDPOINT = 'https://storage.googleapis.com' 36 | 37 | 38 | class CloudStorageURLSigner(object): 39 | """Contains methods for generating signed URLs for Google Cloud Storage.""" 40 | 41 | def __init__(self, key, client_id_email, gcs_api_endpoint, expiration=None, 42 | session=None): 43 | """Creates a CloudStorageURLSigner that can be used to access signed URLs. 44 | 45 | Args: 46 | key: A PyCrypto private key. 47 | client_id_email: GCS service account email. 48 | gcs_api_endpoint: Base URL for GCS API. 49 | expiration: An instance of datetime.datetime containing the time when the 50 | signed URL should expire. 51 | session: A requests.session.Session to use for issuing requests. If not 52 | supplied, a new session is created. 53 | """ 54 | self.key = key 55 | self.client_id_email = client_id_email 56 | self.gcs_api_endpoint = gcs_api_endpoint 57 | 58 | self.expiration = expiration or (datetime.datetime.now() + 59 | datetime.timedelta(days=1)) 60 | self.expiration = int(time.mktime(self.expiration.timetuple())) 61 | 62 | self.session = session or requests.Session() 63 | 64 | def _Base64Sign(self, plaintext): 65 | """Signs and returns a base64-encoded SHA256 digest.""" 66 | shahash = SHA256.new(plaintext) 67 | signer = PKCS1_v1_5.new(self.key) 68 | signature_bytes = signer.sign(shahash) 69 | return base64.b64encode(signature_bytes) 70 | 71 | def _MakeSignatureString(self, verb, path, content_md5, content_type): 72 | """Creates the signature string for signing according to GCS docs.""" 73 | signature_string = ('{verb}\n' 74 | '{content_md5}\n' 75 | '{content_type}\n' 76 | '{expiration}\n' 77 | '{resource}') 78 | return signature_string.format(verb=verb, 79 | content_md5=content_md5, 80 | content_type=content_type, 81 | expiration=self.expiration, 82 | resource=path) 83 | 84 | def _MakeUrl(self, verb, path, content_type='', content_md5=''): 85 | """Forms and returns the full signed URL to access GCS.""" 86 | base_url = '%s%s' % (self.gcs_api_endpoint, path) 87 | signature_string = self._MakeSignatureString(verb, path, content_md5, 88 | content_type) 89 | signature_signed = self._Base64Sign(signature_string) 90 | query_params = {'GoogleAccessId': self.client_id_email, 91 | 'Expires': str(self.expiration), 92 | 'Signature': signature_signed} 93 | return base_url, query_params 94 | 95 | def Get(self, path): 96 | """Performs a GET request. 97 | 98 | Args: 99 | path: The relative API path to access, e.g. '/bucket/object'. 100 | 101 | Returns: 102 | An instance of requests.Response containing the HTTP response. 103 | """ 104 | base_url, query_params = self._MakeUrl('GET', path) 105 | return self.session.get(base_url, params=query_params) 106 | 107 | def Put(self, path, content_type, data): 108 | """Performs a PUT request. 109 | 110 | Args: 111 | path: The relative API path to access, e.g. '/bucket/object'. 112 | content_type: The content type to assign to the upload. 113 | data: The file data to upload to the new file. 114 | 115 | Returns: 116 | An instance of requests.Response containing the HTTP response. 117 | """ 118 | md5_digest = base64.b64encode(md5.new(data).digest()) 119 | base_url, query_params = self._MakeUrl('PUT', path, content_type, 120 | md5_digest) 121 | headers = {} 122 | headers['Content-Type'] = content_type 123 | headers['Content-Length'] = str(len(data)) 124 | headers['Content-MD5'] = md5_digest 125 | return self.session.put(base_url, params=query_params, headers=headers, 126 | data=data) 127 | 128 | def Delete(self, path): 129 | """Performs a DELETE request. 130 | 131 | Args: 132 | path: The relative API path to access, e.g. '/bucket/object'. 133 | 134 | Returns: 135 | An instance of requests.Response containing the HTTP response. 136 | """ 137 | base_url, query_params = self._MakeUrl('DELETE', path) 138 | return self.session.delete(base_url, params=query_params) 139 | 140 | 141 | def ProcessResponse(r, expected_status=200): 142 | """Prints request and response information and checks for desired return code. 143 | 144 | Args: 145 | r: A requests.Response object. 146 | expected_status: The expected HTTP status code. 147 | 148 | Raises: 149 | SystemExit if the response code doesn't match expected_status. 150 | """ 151 | print '--- Request ---' 152 | print r.request.url 153 | for header, value in r.request.headers.iteritems(): 154 | print '%s: %s' % (header, value) 155 | print '---------------' 156 | print '--- Response (Status %s) ---' % r.status_code 157 | print r.content 158 | print '-----------------------------' 159 | print 160 | if r.status_code != expected_status: 161 | sys.exit('Exiting due to receiving %d status code when expecting %d.' 162 | % (r.status_code, expected_status)) 163 | 164 | 165 | def main(): 166 | try: 167 | keytext = open(conf.PRIVATE_KEY_PATH, 'rb').read() 168 | except IOError as e: 169 | sys.exit('Error while reading private key: %s' % e) 170 | 171 | private_key = RSA.importKey(keytext) 172 | signer = CloudStorageURLSigner(private_key, conf.SERVICE_ACCOUNT_EMAIL, 173 | GCS_API_ENDPOINT) 174 | 175 | file_path = '/%s/%s' % (conf.BUCKET_NAME, conf.OBJECT_NAME) 176 | 177 | print 'Creating file...' 178 | print '================' 179 | r = signer.Put(file_path, 'text/plain', 'blah blah') 180 | ProcessResponse(r) 181 | print 'Retrieving file...' 182 | print '==================' 183 | r = signer.Get(file_path) 184 | ProcessResponse(r) 185 | print 'Deleting file...' 186 | print '================' 187 | r = signer.Delete(file_path) 188 | ProcessResponse(r, expected_status=204) 189 | print 'Done.' 190 | 191 | if __name__ == '__main__': 192 | main() 193 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | requests 2 | PyCrypto 3 | --------------------------------------------------------------------------------