Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(spanner): add samples for fine grained access control (#2172)
* feat(spanner): add samples for fine grained access control * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fix sample checkstyles * incorporate review comment * incorporate requested changes * incorporate requested changes * fix checkstyle * incorporate review comments * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * refactoring * remove role check & exceptions Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
ff8c425
commit 77969e3
Showing
6 changed files
with
442 additions
and
0 deletions.
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
88 changes: 88 additions & 0 deletions
88
samples/snippets/src/main/java/com/example/spanner/AddAndDropDatabaseRole.java
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,88 @@ | ||
| /* | ||
| * Copyright 2022 Google Inc. | ||
| * | ||
| * 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.example.spanner; | ||
|
|
||
| // [START spanner_add_and_drop_database_role] | ||
| import com.google.api.gax.longrunning.OperationFuture; | ||
| import com.google.cloud.spanner.DatabaseAdminClient; | ||
| import com.google.cloud.spanner.Spanner; | ||
| import com.google.cloud.spanner.SpannerOptions; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| public class AddAndDropDatabaseRole { | ||
|
|
||
| static void addAndDropDatabaseRole() { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "my-project"; | ||
| String instanceId = "my-instance"; | ||
| String databaseId = "my-database"; | ||
| String parentRole = "my-new-parent-role"; | ||
| String childRole = "my-new-child-role"; | ||
| addAndDropDatabaseRole(projectId, instanceId, databaseId, parentRole, childRole); | ||
| } | ||
|
|
||
| static void addAndDropDatabaseRole( | ||
| String projectId, String instanceId, String databaseId, String parentRole, String childRole) { | ||
| try (Spanner spanner = | ||
| SpannerOptions.newBuilder() | ||
| .setProjectId(projectId) | ||
| .build() | ||
| .getService()) { | ||
| final DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient(); | ||
| OperationFuture<Void, UpdateDatabaseDdlMetadata> operation = | ||
| adminClient.updateDatabaseDdl( | ||
| instanceId, | ||
| databaseId, | ||
| ImmutableList.of( | ||
| "CREATE ROLE " + parentRole, | ||
| "GRANT SELECT ON TABLE Albums TO ROLE " + parentRole, | ||
| "CREATE ROLE " + childRole, | ||
| "GRANT ROLE " + parentRole + " TO ROLE " + childRole), | ||
| null); | ||
| try { | ||
| System.out.println("Waiting for role create operation to complete..."); | ||
| operation.get(5, TimeUnit.MINUTES); | ||
| System.out.printf( | ||
| "Created roles %s and %s and granted privileges%n", parentRole, childRole); | ||
| // Delete role and membership. | ||
| operation = | ||
| adminClient.updateDatabaseDdl( | ||
| instanceId, | ||
| databaseId, | ||
| ImmutableList.of( | ||
| "REVOKE ROLE " + parentRole + " FROM ROLE " + childRole, | ||
| "DROP ROLE " + childRole), | ||
| null); | ||
| System.out.println("Waiting for role revoke & drop operation to complete..."); | ||
| operation.get(5, TimeUnit.MINUTES); | ||
| System.out.printf("Revoked privileges and dropped role %s%n", childRole); | ||
| } catch (ExecutionException | TimeoutException e) { | ||
| System.out.printf( | ||
| "Error: AddAndDropDatabaseRole failed with error message %s\n", e.getMessage()); | ||
| e.printStackTrace(); | ||
| } catch (InterruptedException e) { | ||
| System.out.println( | ||
| "Error: Waiting for AddAndDropDatabaseRole operation to finish was interrupted"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // [END spanner_add_and_drop_database_role] |
102 changes: 102 additions & 0 deletions
102
samples/snippets/src/main/java/com/example/spanner/EnableFineGrainedAccess.java
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,102 @@ | ||
| /* | ||
| * Copyright 2022 Google Inc. | ||
| * | ||
| * 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.example.spanner; | ||
|
|
||
| // [START spanner_enable_fine_grained_access] | ||
| import com.google.cloud.Binding; | ||
| import com.google.cloud.Condition; | ||
| import com.google.cloud.Policy; | ||
| import com.google.cloud.spanner.DatabaseAdminClient; | ||
| import com.google.cloud.spanner.Spanner; | ||
| import com.google.cloud.spanner.SpannerOptions; | ||
| import com.google.common.collect.ImmutableList; | ||
|
|
||
| public class EnableFineGrainedAccess { | ||
|
|
||
| static void enableFineGrainedAccess() { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "my-project"; | ||
| String instanceId = "my-instance"; | ||
| String databaseId = "my-database"; | ||
| String iamMember = "user:alice@example.com"; | ||
| String role = "my-role"; | ||
| String title = "my-condition-title"; | ||
| enableFineGrainedAccess(projectId, instanceId, databaseId, iamMember, title, role); | ||
| } | ||
|
|
||
| static void enableFineGrainedAccess( | ||
| String projectId, | ||
| String instanceId, | ||
| String databaseId, | ||
| String iamMember, | ||
| String title, | ||
| String role) { | ||
| try (Spanner spanner = | ||
| SpannerOptions.newBuilder() | ||
| .setProjectId(projectId) | ||
| .build() | ||
| .getService()) { | ||
| final DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient(); | ||
| Policy policy = adminClient.getDatabaseIAMPolicy(instanceId, databaseId, 3); | ||
| int policyVersion = policy.getVersion(); | ||
| // The policy in the response from getDatabaseIAMPolicy might use the policy version | ||
| // that you specified, or it might use a lower policy version. For example, if you | ||
| // specify version 3, but the policy has no conditional role bindings, the response | ||
| // uses version 1. Valid values are 0, 1, and 3. | ||
| if (policy.getVersion() < 3) { | ||
| // conditional role bindings work with policy version 3 | ||
| policyVersion = 3; | ||
| } | ||
|
|
||
| Binding binding1 = | ||
| Binding.newBuilder() | ||
| .setRole("roles/spanner.fineGrainedAccessUser") | ||
| .setMembers(ImmutableList.of(iamMember)) | ||
| .build(); | ||
|
|
||
| Binding binding2 = | ||
| Binding.newBuilder() | ||
| .setRole("roles/spanner.databaseRoleUser") | ||
| .setCondition( | ||
| Condition.newBuilder() | ||
| .setDescription(title) | ||
| .setExpression( | ||
| String.format("resource.name.endsWith(\"/databaseRoles/%s\")", role)) | ||
| .setTitle(title) | ||
| .build()) | ||
| .setMembers(ImmutableList.of(iamMember)) | ||
| .build(); | ||
| ImmutableList<Binding> bindings = | ||
| ImmutableList.<Binding>builder() | ||
| .addAll(policy.getBindingsList()) | ||
| .add(binding1) | ||
| .add(binding2) | ||
| .build(); | ||
| Policy policyWithConditions = | ||
| Policy.newBuilder() | ||
| .setVersion(policyVersion) | ||
| .setEtag(policy.getEtag()) | ||
| .setBindings(bindings) | ||
| .build(); | ||
| Policy response = | ||
| adminClient.setDatabaseIAMPolicy(instanceId, databaseId, policyWithConditions); | ||
| System.out.printf( | ||
| "Enabled fine-grained access in IAM with version %d%n", response.getVersion()); | ||
| } | ||
| } | ||
| } | ||
| // [END spanner_enable_fine_grained_access] |
Oops, something went wrong.