Skip to content

Commit 576d79f

Browse files
author
Psilo
committed
integrate, tidy up docker-compose, add postman collection endpoint
1 parent aed5230 commit 576d79f

File tree

10 files changed

+454
-66
lines changed

10 files changed

+454
-66
lines changed

‎.gitlab-ci.yml

-26
This file was deleted.

‎deploy/docker-compose.yml

+18-15
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,17 @@ services:
1717
# - DB_NAME=httpserver
1818
# - DB_USER=httpserver
1919
# - DB_PASSWORD=DP5V7hi7xgknaH39lDTX
20+
# - KEYCLOAK_HOST=keycloak
21+
# - KEYCLOAK_REALM=nexus
2022
# labels:
2123
# - "traefik.enable=true"
2224
# - "traefik.http-server.port=8080"
2325
# - "traefik.http-server.backend=http-server"
2426
# - "traefik.http-server.frontend.rule=Host:http-server.unterrainer.info"
2527
# - "traefik.http-server.frontend.entryPoints=http,https"
2628

27-
db:
28-
image: mariadb:latest
29+
db-container:
30+
image: mysql:latest
2931
restart: always
3032
ports:
3133
- 14300:3306
@@ -51,19 +53,20 @@ services:
5153
- "/app/data/keycloak/mysql-data/db:/var/lib/mysql"
5254

5355
keycloak:
54-
image: quay.io/keycloak/keycloak:latest
55-
environment:
56-
DB_VENDOR: mariadb
57-
DB_ADDR: keycloak_db
58-
DB_DATABASE: keycloak
59-
DB_USER: keycloak
60-
DB_PASSWORD: 8KNM3flMpEyCYkFw5wrGoCN3
61-
KEYCLOAK_USER: admin
62-
KEYCLOAK_PASSWORD: cTWJiYZDutP6tYxXnv2yg0A
63-
ports:
64-
- 8080:8080
65-
depends_on:
66-
- keycloak_db
56+
image: quay.io/keycloak/keycloak:latest
57+
restart: always
58+
depends_on:
59+
- keycloak_db
60+
ports:
61+
- 14888:8080
62+
environment:
63+
DB_VENDOR: mariadb
64+
DB_ADDR: keycloak_db
65+
DB_DATABASE: keycloak
66+
DB_USER: keycloak
67+
DB_PASSWORD: 8KNM3flMpEyCYkFw5wrGoCN3
68+
KEYCLOAK_USER: admin
69+
KEYCLOAK_PASSWORD: cTWJiYZDutP6tYxXnv2yg0A
6770

6871
networks:
6972
default:

‎src/main/java/info/unterrainer/commons/httpserver/HttpServer.java

+11-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import info.unterrainer.commons.httpserver.handlers.AppVersionHandler;
2424
import info.unterrainer.commons.httpserver.handlers.DateTimeHandler;
2525
import info.unterrainer.commons.httpserver.handlers.HealthHandler;
26+
import info.unterrainer.commons.httpserver.handlers.PostmanCollectionHandler;
2627
import info.unterrainer.commons.httpserver.jsons.MessageJson;
2728
import info.unterrainer.commons.jreutils.ShutdownHook;
2829
import info.unterrainer.commons.rdbutils.entities.BasicJpa;
@@ -96,11 +97,14 @@ private void create() {
9697
connector.setPort(config.port());
9798
server.setConnectors(new ServerConnector[] { connector });
9899

99-
javalin = Javalin.create(config -> {
100-
config.server(() -> server).accessManager(new HttpAccessManager()).enableCorsForAllOrigins();
100+
javalin = Javalin.create(c -> {
101+
c.server(() -> server)
102+
.accessManager(new HttpAccessManager(config.keycloakHost(), config.keycloakRealm()))
103+
.enableCorsForAllOrigins();
101104
}).start(config.port());
102105

103106
javalin.before(ctx -> ctx.attribute(Attribute.JAVALIN_SERVER, this));
107+
javalin.before(ctx -> ctx.attribute(Attribute.RESPONSE_TYPE, "json"));
104108
javalin.before(ctx -> ctx.contentType("application/json"));
105109

106110
javalin.after(ctx -> render(ctx));
@@ -120,6 +124,7 @@ private void create() {
120124
get("/version", new AppVersionHandler(appVersionFqns));
121125
get("/datetime", new DateTimeHandler());
122126
get("/health", new HealthHandler());
127+
get("/postman", new PostmanCollectionHandler());
123128

124129
registerShutdownHook();
125130
}
@@ -215,7 +220,10 @@ private void render(final Context ctx) throws IOException {
215220

216221
Object dto = ctx.attribute(Attribute.RESPONSE_OBJECT);
217222
if (dto != null)
218-
ctx.result(jsonMapper.toStringFrom(dto));
223+
if (ctx.attribute(Attribute.RESPONSE_TYPE) == "json")
224+
ctx.result(jsonMapper.toStringFrom(dto));
225+
else
226+
ctx.result((String) dto);
219227

220228
Integer status = ctx.attribute(Attribute.RESPONSE_STATUS);
221229
if (status != null)

‎src/main/java/info/unterrainer/commons/httpserver/HttpServerConfiguration.java

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ private HttpServerConfiguration() {
1414

1515
private int port;
1616
private String host;
17+
private String keycloakHost;
18+
private String keycloakRealm;
1719

1820
public static HttpServerConfiguration read() {
1921
return read(null);
@@ -26,6 +28,8 @@ public static HttpServerConfiguration read(final String prefix) {
2628
HttpServerConfiguration config = new HttpServerConfiguration();
2729
config.port = Integer.parseInt(Optional.ofNullable(System.getenv(p + "HTTP_PORT")).orElse("8080"));
2830
config.host = Optional.ofNullable(System.getenv(p + "HTTP_HOST")).orElse("0.0.0.0");
31+
config.keycloakHost = Optional.ofNullable(System.getenv(p + "KEYCLOAK_HOST")).orElse("http://localhost:14888");
32+
config.keycloakRealm = Optional.ofNullable(System.getenv(p + "KEYCLOAK_REALM")).orElse("nexus");
2933
return config;
3034
}
3135
}

‎src/main/java/info/unterrainer/commons/httpserver/accessmanager/DefaultRoles.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
import io.javalin.core.security.Role;
44

55
public enum DefaultRoles implements Role {
6-
PUBLIC, AUTHENTICATED;
6+
PUBLIC,
7+
AUTHENTICATED;
78
}

‎src/main/java/info/unterrainer/commons/httpserver/accessmanager/HttpAccessManager.java

+54-21
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
import java.net.URISyntaxException;
77
import java.net.http.HttpClient;
88
import java.net.http.HttpRequest;
9-
import java.net.http.HttpResponse;
109
import java.net.http.HttpResponse.BodyHandlers;
1110
import java.security.PublicKey;
1211
import java.util.Set;
@@ -20,63 +19,97 @@
2019
import com.fasterxml.jackson.databind.ObjectMapper;
2120

2221
import info.unterrainer.commons.httpserver.exceptions.ForbiddenException;
22+
import info.unterrainer.commons.httpserver.exceptions.GatewayTimeoutException;
2323
import info.unterrainer.commons.httpserver.exceptions.UnauthorizedException;
2424
import io.javalin.core.security.AccessManager;
2525
import io.javalin.core.security.Role;
2626
import io.javalin.http.Context;
2727
import io.javalin.http.Handler;
28+
import lombok.extern.slf4j.Slf4j;
2829

30+
@Slf4j
2931
public class HttpAccessManager implements AccessManager {
3032

31-
private PublicKey publicKey;
33+
private String host;
34+
private String realm;
35+
private PublicKey publicKey = null;
3236

33-
public HttpAccessManager() {
37+
public HttpAccessManager(final String host, final String realm) {
38+
this.host = host;
39+
this.realm = realm;
3440
try {
35-
String authUrl = "http://localhost:8080" + "/auth/realms/" + "nexus";
41+
initPublicKey();
42+
} catch (Exception e) {
43+
// Exceptions will terminate a request later on, but should not terminate the
44+
// main-thread here.
45+
}
46+
}
47+
48+
@Override
49+
public void manage(final Handler handler, final Context ctx, final Set<Role> permittedRoles) throws Exception {
50+
checkAccess(ctx, permittedRoles);
51+
handler.handle(ctx);
52+
}
53+
54+
private void initPublicKey() {
55+
if (publicKey != null)
56+
return;
57+
58+
if (!host.endsWith("/"))
59+
host += "/";
60+
61+
if (!realm.startsWith("/"))
62+
realm = "/" + realm;
3663

64+
String authUrl = host + "auth/realms" + realm;
65+
try {
66+
log.info("Getting public key from: [{}]", authUrl);
3767
HttpClient client = HttpClient.newHttpClient();
3868
HttpRequest request = HttpRequest.newBuilder().uri(new URI(authUrl)).build();
3969
ObjectMapper objectMapper = new ObjectMapper();
4070

41-
client.sendAsync(request, BodyHandlers.ofString()).thenApply(HttpResponse::body).thenAccept(body -> {
71+
client.sendAsync(request, BodyHandlers.ofString()).thenApply(response -> {
72+
if (response.statusCode() >= 300) {
73+
log.error("HTTP status [{}] getting public key from keycloak instance [{}].", response.statusCode(),
74+
authUrl);
75+
throw new GatewayTimeoutException(String
76+
.format("The keycloak instance returned an error (status: %d).", response.statusCode()));
77+
}
78+
return response.body();
79+
}).thenAccept(body -> {
80+
if (body == null)
81+
return;
4282
try {
4383
publicKey = objectMapper.readValue(body, PublishedRealmRepresentation.class).getPublicKey();
4484
} catch (IOException e) {
85+
log.error("Error parsing answer from keycloak.");
4586
throw new UncheckedIOException(e);
4687
}
4788
}).join();
4889
} catch (URISyntaxException e) {
90+
log.error("The keycloak URL was illegal [{}].", authUrl);
4991
throw new IllegalStateException(e);
5092
}
51-
5293
}
5394

54-
@Override
55-
public void manage(Handler handler, Context ctx, Set<Role> permittedRoles) throws Exception {
56-
57-
checkAccess(ctx, permittedRoles);
95+
private void checkAccess(final Context ctx, final Set<Role> permittedRoles) {
5896

59-
handler.handle(ctx);
60-
}
61-
62-
private void checkAccess(Context ctx, Set<Role> permittedRoles) {
63-
64-
if (permittedRoles.isEmpty() || permittedRoles.contains(DefaultRoles.PUBLIC)) {
97+
if (permittedRoles.isEmpty() || permittedRoles.contains(DefaultRoles.PUBLIC))
6598
return;
66-
}
6799

100+
initPublicKey();
68101
String authorizationHeader = ctx.header(HttpHeader.AUTHORIZATION.asString());
69-
TokenVerifier<AccessToken> accessToken = TokenVerifier.create(authorizationHeader, AccessToken.class);
70-
accessToken.publicKey(publicKey);
102+
TokenVerifier<AccessToken> tokenVerifier = TokenVerifier.create(authorizationHeader, AccessToken.class);
103+
tokenVerifier.publicKey(publicKey);
71104

72105
try {
73-
accessToken.verifySignature();
106+
tokenVerifier.verifySignature();
74107
} catch (VerificationException e) {
75108
throw new UnauthorizedException();
76109
}
77110

78111
try {
79-
accessToken.verify();
112+
tokenVerifier.verify();
80113
} catch (VerificationException e) {
81114
throw new ForbiddenException();
82115
}

‎src/main/java/info/unterrainer/commons/httpserver/enums/Attribute.java

+1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ public class Attribute {
44
public static final String JAVALIN_SERVER = "javalin_server";
55
public static final String RESPONSE_OBJECT = "response_object";
66
public static final String RESPONSE_STATUS = "response_status";
7+
public static final String RESPONSE_TYPE = "response_type";
78
}

‎src/main/java/info/unterrainer/commons/httpserver/exceptions/GatewayTimeoutException.java

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package info.unterrainer.commons.httpserver.exceptions;
2+
3+
public class GatewayTimeoutException extends HttpException {
4+
5+
private static final long serialVersionUID = 6409374003218276906L;
6+
7+
public static final int HTTP_STATUS = 504;
8+
public static final String HTTP_TEXT = "Gateway Timeout";
9+
10+
public GatewayTimeoutException(final String message, final Throwable cause) {
11+
super(HTTP_STATUS, HTTP_TEXT, message, cause);
12+
}
13+
14+
public GatewayTimeoutException(final String message) {
15+
super(HTTP_STATUS, HTTP_TEXT, message);
16+
}
17+
18+
public GatewayTimeoutException() {
19+
super(HTTP_STATUS, HTTP_TEXT);
20+
}
21+
}

‎src/main/java/info/unterrainer/commons/httpserver/handlers/PostmanCollectionHandler.java

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
package info.unterrainer.commons.httpserver.handlers;
2+
3+
import info.unterrainer.commons.httpserver.enums.Attribute;
4+
import info.unterrainer.commons.jreutils.Resources;
5+
import io.javalin.http.Context;
6+
import io.javalin.http.Handler;
7+
import lombok.RequiredArgsConstructor;
8+
9+
@RequiredArgsConstructor
10+
public class PostmanCollectionHandler implements Handler {
11+
12+
private String collection;
13+
14+
@Override
15+
public void handle(final Context ctx) throws Exception {
16+
if (collection == null)
17+
collection = Resources.readResource(PostmanCollectionHandler.class, "/postman_collection.json");
18+
19+
ctx.attribute(Attribute.RESPONSE_OBJECT, collection);
20+
ctx.attribute(Attribute.RESPONSE_TYPE, "text");
21+
ctx.attribute(Attribute.RESPONSE_STATUS, 200);
22+
}
23+
}

0 commit comments

Comments
 (0)