Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adds README, samples and integration tests for downscoping with…
… CAB (#1311) * Add description, samples and integration tests for CAB * fix lints * fix copyright format and import * add storage dependency * try on header fix * fix some comments * update readme * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * change yaml and fixes comments * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * revertbucketName and objectName * revert logic in try blocks * tweak child exec process * fix lint * set bucket name and object name environment variable Co-authored-by: Leo <39062083+lsirac@users.noreply.github.com> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
3 people
committed
Dec 15, 2021
1 parent
e91472a
commit 4549116
Showing
7 changed files
with
509 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| // Copyright 2021 Google LLC | ||
| // | ||
| // 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. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| /** | ||
| * Imports the Google Auth and Google Cloud libraries. | ||
| */ | ||
| const { | ||
| OAuth2Client, | ||
| GoogleAuth, | ||
| DownscopedClient, | ||
| } = require('google-auth-library'); | ||
| const {Storage} = require('@google-cloud/storage'); | ||
|
|
||
| /** | ||
| * The following sample demonstrates how to initialize a DownscopedClient using | ||
| * a credential access boundary and a client obtained via ADC. The | ||
| * DownscopedClient is used to create downscoped tokens which can be consumed | ||
| * via the OAuth2Client. A refresh handler is used to obtain new downscoped | ||
| * tokens seamlessly when they expire. Then the oauth2Client is used to define | ||
| * a cloud storage object and call GCS APIs to access specified object and | ||
| * print the contents. | ||
| */ | ||
| async function main() { | ||
| const bucketName = process.env.BUCKET_NAME; | ||
| const objectName = process.env.OBJECT_NAME; | ||
| // Defines a credential access boundary that grants objectViewer access in | ||
| // the specified bucket. | ||
| const cab = { | ||
| accessBoundary: { | ||
| accessBoundaryRules: [ | ||
| { | ||
| availableResource: `//storage.googleapis.com/projects/_/buckets/${bucketName}`, | ||
| availablePermissions: ['inRole:roles/storage.objectViewer'], | ||
| availabilityCondition: { | ||
| expression: | ||
| "resource.name.startsWith('projects/_/buckets/" + | ||
| `${bucketName}/objects/${objectName}')`, | ||
| }, | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
|
|
||
| const oauth2Client = new OAuth2Client(); | ||
| const googleAuth = new GoogleAuth({ | ||
| scopes: 'https://www.googleapis.com/auth/cloud-platform', | ||
| }); | ||
| const projectId = await googleAuth.getProjectId(); | ||
| // Obtain an authenticated client via ADC. | ||
| const client = await googleAuth.getClient(); | ||
| // Use the client to generate a DownscopedClient. | ||
| const cabClient = new DownscopedClient(client, cab); | ||
| // Define a refreshHandler that will be used to refresh the downscoped token | ||
| // when it expires. | ||
| oauth2Client.refreshHandler = async () => { | ||
| const refreshedAccessToken = await cabClient.getAccessToken(); | ||
| return { | ||
| access_token: refreshedAccessToken.token, | ||
| expiry_date: refreshedAccessToken.expirationTime, | ||
| }; | ||
| }; | ||
|
|
||
| const storageOptions = { | ||
| projectId, | ||
| authClient: { | ||
| getCredentials: async () => { | ||
| Promise.reject(); | ||
| }, | ||
| request: opts => { | ||
| return oauth2Client.request(opts); | ||
| }, | ||
| sign: () => { | ||
| Promise.reject('unsupported'); | ||
| }, | ||
| authorizeRequest: async opts => { | ||
| opts = opts || {}; | ||
| const url = opts.url || opts.uri; | ||
| const headers = await oauth2Client.getRequestHeaders(url); | ||
| opts.headers = Object.assign(opts.headers || {}, headers); | ||
| return opts; | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| const storage = new Storage(storageOptions); | ||
| const downloadFile = await storage | ||
| .bucket(bucketName) | ||
| .file(objectName) | ||
| .download(); | ||
| console.log(downloadFile.toString('utf8')); | ||
| } | ||
|
|
||
| main().catch(console.error); |
Oops, something went wrong.