-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
313539854 Add Pub/Sub as notification backend (#204)
Add Pub/Sub as an optional notification backend. When configured, JIT Access sends
the following three types of notifications to a Pub/Sub topic:
JIT self approval:
```
{
type: "ActivationSelfApproved",
attributes: {
role: "roles/automl.viewer",
beneficiary: "alice@example.com",
start_time: "2023-11-28T22:13:44Z",
end_time: "2023-11-28T22:23:44Z",
justification: "...",
project_id: "project-1"
}
}
```
MPA approval request:
```
{
"type": "RequestActivation",
"attributes": {
"role": "roles/genomics.editor",
"beneficiary": "alice@example.com",
"start_time": "2023-11-28T22:19:06Z",
"end_time": "2023-11-28T22:29:06Z",
"reviewers": [
"a-bob@example.com",
"jitaccess-testuser1@example.com",
"jitaccess-testuser2@example.com"
],
"justification": "test",
"action_url": "http://localhost:8080/?activation=JhbGciOi...",
"request_expiry_time": "2023-11-28T23:19:06Z",
"base_url": "http://localhost:8080/",
"project_id": "project-1"
}
}
```
MPA approval:
```
{
"type": "ActivationApproved",
"attributes": {
"role": "roles/genomics.editor",
"beneficiary": "alice@example.com",
"start_time": "2023-11-28T22:19:06Z",
"end_time": "2023-11-28T22:29:06Z",
"reviewers": [
"a-bob@example.com",
"jitaccess-testuser1@example.com",
"jitaccess-testuser2@example.com"
],
"justification": "test",
"base_url": "http://localhost:8080/",
"approver": "a-bob@example.com",
"project_id": "project-1"
}
}
```
This PR is derived from #154.- Loading branch information
Showing
15 changed files
with
559 additions
and
21 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
111 changes: 111 additions & 0 deletions
111
sources/src/main/java/com/google/solutions/jitaccess/core/adapters/PubSubAdapter.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,111 @@ | ||
| // | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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.google.solutions.jitaccess.core.adapters; | ||
|
|
||
| import com.google.api.client.json.gson.GsonFactory; | ||
| import com.google.api.client.googleapis.json.GoogleJsonResponseException; | ||
| import com.google.auth.http.HttpCredentialsAdapter; | ||
| import com.google.auth.oauth2.GoogleCredentials; | ||
| import com.google.api.services.pubsub.Pubsub; | ||
| import com.google.api.services.pubsub.model.PubsubMessage; | ||
| import com.google.api.services.pubsub.model.PublishRequest; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.solutions.jitaccess.core.AccessDeniedException; | ||
| import com.google.solutions.jitaccess.core.AccessException; | ||
| import com.google.solutions.jitaccess.core.ApplicationVersion; | ||
| import com.google.solutions.jitaccess.core.NotAuthenticatedException; | ||
| import com.google.solutions.jitaccess.core.data.Topic; | ||
| import jakarta.enterprise.context.ApplicationScoped; | ||
| import java.io.IOException; | ||
| import java.security.GeneralSecurityException; | ||
| import java.util.Arrays; | ||
|
|
||
| @ApplicationScoped | ||
| public class PubSubAdapter { | ||
| private final GoogleCredentials credentials; | ||
| private final HttpTransport.Options httpOptions; | ||
|
|
||
| public PubSubAdapter( | ||
| GoogleCredentials credentials, | ||
| HttpTransport.Options httpOptions) | ||
| { | ||
| Preconditions.checkNotNull(credentials, "credentials"); | ||
| Preconditions.checkNotNull(httpOptions, "httpOptions"); | ||
|
|
||
| this.credentials = credentials; | ||
| this.httpOptions = httpOptions; | ||
| } | ||
|
|
||
| private Pubsub createClient() throws IOException { | ||
| try { | ||
| return new Pubsub.Builder( | ||
| HttpTransport.newTransport(), | ||
| new GsonFactory(), | ||
| HttpTransport.newAuthenticatingRequestInitializer(this.credentials, this.httpOptions)) | ||
| .setApplicationName(ApplicationVersion.USER_AGENT) | ||
| .build(); | ||
| } | ||
| catch (GeneralSecurityException e) { | ||
| throw new IOException("Creating a PubSub client failed", e); | ||
| } | ||
| } | ||
|
|
||
| public String publish( | ||
| Topic topic, | ||
| PubsubMessage message | ||
| ) throws AccessException, IOException { | ||
| var client = createClient(); | ||
|
|
||
| try { | ||
| var request = new PublishRequest(); | ||
| request.setMessages(Arrays.asList(message)); | ||
|
|
||
| var result = client | ||
| .projects() | ||
| .topics() | ||
| .publish(topic.getFullResourceName(), request) | ||
| .execute(); | ||
| if (result.getMessageIds().size() < 1){ | ||
| throw new IOException( | ||
| String.format("Publishing message to topic %s returned empty response", topic)); | ||
| } | ||
|
|
||
| return result.getMessageIds().get(0); | ||
| } | ||
| catch (GoogleJsonResponseException e) { | ||
| switch (e.getStatusCode()) { | ||
| case 401: | ||
| throw new NotAuthenticatedException("Not authenticated", e); | ||
| case 403: | ||
| case 404: | ||
| throw new AccessDeniedException( | ||
| String.format( | ||
| "Pub/Sub topic '%s' cannot be accessed or does not exist: %s", | ||
| topic, | ||
| e.getMessage()), | ||
| e); | ||
| default: | ||
| throw (GoogleJsonResponseException)e.fillInStackTrace(); | ||
| } | ||
| } | ||
| } | ||
| } |
33 changes: 33 additions & 0 deletions
33
sources/src/main/java/com/google/solutions/jitaccess/core/data/Topic.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,33 @@ | ||
| // | ||
| // Copyright 2023 Google LLC | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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.google.solutions.jitaccess.core.data; | ||
|
|
||
| public record Topic(String projectId, String topicName) { | ||
| @Override | ||
| public String toString() { | ||
| return getFullResourceName(); | ||
| } | ||
|
|
||
| public String getFullResourceName() { | ||
| return String.format("projects/%s/topics/%s", this.projectId, this.topicName); | ||
| } | ||
| } |
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
95 changes: 95 additions & 0 deletions
95
...src/main/java/com/google/solutions/jitaccess/core/services/PubSubNotificationService.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,95 @@ | ||
| package com.google.solutions.jitaccess.core.services; | ||
|
|
||
| import com.google.api.client.json.GenericJson; | ||
| import com.google.api.services.pubsub.model.PubsubMessage; | ||
| import com.google.common.base.Preconditions; | ||
| import com.google.gson.Gson; | ||
| import com.google.solutions.jitaccess.core.AccessException; | ||
| import com.google.solutions.jitaccess.core.adapters.PubSubAdapter; | ||
| import com.google.solutions.jitaccess.core.data.Topic; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.time.Instant; | ||
| import java.util.Collection; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Concrete class that delivers notifications over Pub/Sub. | ||
| */ | ||
| public class PubSubNotificationService extends NotificationService { | ||
| private final PubSubAdapter adapter; | ||
| private final Options options; | ||
|
|
||
| public PubSubNotificationService( | ||
| PubSubAdapter adapter, | ||
| Options options | ||
| ) { | ||
| Preconditions.checkNotNull(adapter, "adapter"); | ||
| Preconditions.checkNotNull(options, "options"); | ||
| Preconditions.checkNotNull(options.topic, "options"); | ||
|
|
||
| this.adapter = adapter; | ||
| this.options = options; | ||
| } | ||
|
|
||
| // ------------------------------------------------------------------------- | ||
| // NotificationService implementation. | ||
| // ------------------------------------------------------------------------- | ||
|
|
||
| @Override | ||
| public boolean canSendNotifications() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public void sendNotification(Notification notification) throws NotificationException { | ||
| var attributes = new GenericJson(); | ||
| for (var property : notification.properties.entrySet()) | ||
| { | ||
| Object propertyValue; | ||
| if (property.getValue() instanceof Instant) { | ||
| // | ||
| // Serialize ISO-8601 representation instead of individual | ||
| // object fields. | ||
| // | ||
| propertyValue = ((Instant)property.getValue()).toString(); | ||
| } | ||
| else if (property.getValue() instanceof Collection<?>) { | ||
| propertyValue = ((Collection<?>)property.getValue()).stream() | ||
| .map(i -> i.toString()) | ||
| .collect(Collectors.toList()); | ||
| } | ||
| else { | ||
| propertyValue = property.getValue().toString(); | ||
| } | ||
|
|
||
| attributes.set(property.getKey().toLowerCase(), propertyValue); | ||
| } | ||
|
|
||
| var payload = new GenericJson() | ||
| .set("type", notification.getType()) | ||
| .set("attributes", attributes); | ||
|
|
||
| var payloadAsJson = new Gson().toJson(payload); | ||
|
|
||
| try { | ||
| var message = new PubsubMessage() | ||
| .encodeData(payloadAsJson.getBytes(StandardCharsets.UTF_8)); | ||
|
|
||
| this.adapter.publish(options.topic, message); | ||
| } catch (AccessException | IOException e){ | ||
| throw new NotificationException("Publishing event to Pub/Sub failed", e); | ||
| } | ||
| } | ||
|
|
||
| // ------------------------------------------------------------------------- | ||
| // Inner classes. | ||
| // ------------------------------------------------------------------------- | ||
|
|
||
| /** | ||
| * @param topicResourceName PubSub topic in format projects/{project}/topics/{topic} | ||
| */ | ||
| public record Options(Topic topic) { | ||
| } | ||
| } |
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
Oops, something went wrong.