Skip to content

Supports strict JSON formats, fix basic authentication issues, general error message improvements #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Supports strict JSON formats, fix basic authentication issues, general error message improvements #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b191d35
Fixed support for JSON request bodies; rather than form requests.
darrensapalo Jun 18, 2021
197a3aa
Fixed JSON preparation; no longer has trailing comma.
darrensapalo Jun 29, 2021
34ec1d3
Added display JSON request body string if the request fails.
darrensapalo Jul 7, 2021
b2211b2
Fixed the for loop including the last comma at the end.
darrensapalo Jul 7, 2021
258b569
🐛 fix: The end quote is included, but the conditional element only is…
darrensapalo Jul 9, 2021
5530bab
FIX: Fixed Basic Authentication implementation.
Mar 9, 2022
ab7f7da
Merge pull request #1 from CesarD/master
darrensapalo Jan 6, 2023
9cea25d
Merge branch 'jessylenne:master' into master
darrensapalo Mar 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 47 additions & 41 deletions ...in/java/org/softwarefactory/keycloak/providers/events/http/HTTPEventListenerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.events.admin.OperationType;

import java.util.Base64;
import java.util.Map;
import java.util.Set;
import java.lang.Exception;

import okhttp3.*;
import okhttp3.OkHttpClient.Builder;

import java.io.IOException;

Expand All @@ -37,21 +37,20 @@
*/
public class HTTPEventListenerProvider implements EventListenerProvider {
private final OkHttpClient httpClient = new OkHttpClient();
public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
private Set<EventType> excludedEvents;
private Set<OperationType> excludedAdminOperations;
private String serverUri;
private String username;
private String password;
public static final String publisherId = "keycloak";
public String TOPIC;

public HTTPEventListenerProvider(Set<EventType> excludedEvents, Set<OperationType> excludedAdminOperations, String serverUri, String username, String password, String topic) {
public HTTPEventListenerProvider(Set<EventType> excludedEvents, Set<OperationType> excludedAdminOperations, String serverUri, String username, String password) {
this.excludedEvents = excludedEvents;
this.excludedAdminOperations = excludedAdminOperations;
this.serverUri = serverUri;
this.username = username;
this.password = password;
this.TOPIC = topic;
}

@Override
Expand All @@ -62,20 +61,18 @@ public void onEvent(Event event) {
} else {
String stringEvent = toString(event);
try {
RequestBody formBody = new FormBody.Builder()
.add("json", stringEvent)
.build();

okhttp3.RequestBody jsonRequestBody = okhttp3.RequestBody.create(stringEvent, JSON);

okhttp3.Request.Builder builder = new Request.Builder()
.url(this.serverUri)
.addHeader("User-Agent", "KeycloakHttp Bot");


if (this.username != null && this.password != null) {
builder.addHeader("Authorization", "Basic " + this.username + ":" + this.password.toCharArray());
builder.addHeader("Authorization", this.getAuthHeader());
}

Request request = builder.post(formBody)
Request request = builder.post(jsonRequestBody)
.build();

Response response = httpClient.newCall(request).execute();
Expand All @@ -88,7 +85,8 @@ public void onEvent(Event event) {
System.out.println(response.body().string());
} catch(Exception e) {
// ?
System.out.println("UH OH!! " + e.toString());
System.out.println("Failed to forward webhook Event " + e.toString());
System.out.println("Request body string: " + stringEvent);
e.printStackTrace();
return;
}
Expand All @@ -102,21 +100,19 @@ public void onEvent(AdminEvent event, boolean includeRepresentation) {
return;
} else {
String stringEvent = toString(event);

try {
RequestBody formBody = new FormBody.Builder()
.add("json", stringEvent)
.build();
okhttp3.RequestBody jsonRequestBody = okhttp3.RequestBody.create(stringEvent, JSON);

okhttp3.Request.Builder builder = new Request.Builder()
.url(this.serverUri)
.addHeader("User-Agent", "KeycloakHttp Bot");


if (this.username != null && this.password != null) {
builder.addHeader("Authorization", "Basic " + this.username + ":" + this.password.toCharArray());
builder.addHeader("Authorization", this.getAuthHeader());
}

Request request = builder.post(formBody)
Request request = builder.post(jsonRequestBody)
.build();

Response response = httpClient.newCall(request).execute();
Expand All @@ -129,71 +125,81 @@ public void onEvent(AdminEvent event, boolean includeRepresentation) {
System.out.println(response.body().string());
} catch(Exception e) {
// ?
System.out.println("UH OH!! " + e.toString());
System.out.println("Failed to forward webhook AdminEvent " + e.toString());
System.out.println("Request body string: " + stringEvent);
e.printStackTrace();
return;
}
}
}

private String getAuthHeader() {
String token = this.username + ":" + this.password;
String encodedToken = Base64.getEncoder().encodeToString(token.getBytes());
return "Basic " + encodedToken;
}

private String toString(Event event) {
StringBuilder sb = new StringBuilder();

sb.append("{'type': '");
sb.append("{\"type\": \"");
sb.append(event.getType());
sb.append("', 'realmId': '");
sb.append("\", \"realmId\": \"");
sb.append(event.getRealmId());
sb.append("', 'clientId': '");
sb.append("\", \"clientId\": \"");
sb.append(event.getClientId());
sb.append("', 'userId': '");
sb.append("\", \"userId\": \"");
sb.append(event.getUserId());
sb.append("', 'ipAddress': '");
sb.append("\", \"ipAddress\": \"");
sb.append(event.getIpAddress());
sb.append("'");
sb.append("\"");

if (event.getError() != null) {
sb.append(", 'error': '");
sb.append(", \"error\": \"");
sb.append(event.getError());
sb.append("'");
sb.append("\"");
}
sb.append(", 'details': {");
sb.append(", \"details\": {");
if (event.getDetails() != null) {
int i = 0;
for (Map.Entry<String, String> e : event.getDetails().entrySet()) {
sb.append("'");
sb.append("\"");
sb.append(e.getKey());
sb.append("': '");
sb.append("\": \"");
sb.append(e.getValue());
sb.append("', ");
sb.append("\"");
if (i < event.getDetails().entrySet().size() - 1) {
sb.append(", ");
}
i = i + 1;
}
}
sb.append("}}");

return sb.toString();
}



private String toString(AdminEvent adminEvent) {
StringBuilder sb = new StringBuilder();

sb.append("{'type': '");
sb.append("{\"type\": \"");
sb.append(adminEvent.getOperationType());
sb.append("', 'realmId': '");
sb.append("\", \"realmId\": \"");
sb.append(adminEvent.getAuthDetails().getRealmId());
sb.append("', 'clientId': '");
sb.append("\", \"clientId\": \"");
sb.append(adminEvent.getAuthDetails().getClientId());
sb.append("', 'userId': '");
sb.append("\", \"userId\": \"");
sb.append(adminEvent.getAuthDetails().getUserId());
sb.append("', 'ipAddress': '");
sb.append("\", \"ipAddress\": \"");
sb.append(adminEvent.getAuthDetails().getIpAddress());
sb.append("', 'resourcePath': '");
sb.append("\", \"resourcePath\": \"");
sb.append(adminEvent.getResourcePath());
sb.append("'");
sb.append("\"");

if (adminEvent.getError() != null) {
sb.append(", 'error': '");
sb.append(", \"error\": \"");
sb.append(adminEvent.getError());
sb.append("'");
sb.append("\"");
}
sb.append("}");
return sb.toString();
Expand Down
7 changes: 3 additions & 4 deletions .../org/softwarefactory/keycloak/providers/events/http/HTTPEventListenerProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@

import java.util.HashSet;
import java.util.Set;
import java.lang.Exception;

/**
* @author <a href="mailto:[email protected]">Jessy Lennee</a>
Expand All @@ -39,11 +38,10 @@ public class HTTPEventListenerProviderFactory implements EventListenerProviderFa
private String serverUri;
private String username;
private String password;
private String topic;

@Override
public EventListenerProvider create(KeycloakSession session) {
return new HTTPEventListenerProvider(excludedEvents, excludedAdminOperations, serverUri, username, password, topic);
return new HTTPEventListenerProvider(excludedEvents, excludedAdminOperations, serverUri, username, password);
}

@Override
Expand All @@ -67,7 +65,8 @@ public void init(Config.Scope config) {
serverUri = config.get("serverUri", "http://nginx/frontend_dev.php/webhook/keycloak");
username = config.get("username", null);
password = config.get("password", null);
topic = config.get("topic", "keycloak/events");

System.out.println("Forwarding keycloak events to: " + serverUri);
}

@Override
Expand Down
Binary file modified ...lasses/org/softwarefactory/keycloak/providers/events/http/HTTPEventListenerProvider.class
View file
Open in desktop
Binary file not shown.
Binary file modified ...org/softwarefactory/keycloak/providers/events/http/HTTPEventListenerProviderFactory.class
View file
Open in desktop
Binary file not shown.