Skip to content

Commit 391b875

Browse files
bevzzzbevzzz
authored
Merge pull request #539 from fer-marino/feature/system-props
feat: integrate proxy support for REST/gRPC/OIDC and add new OIDC authentication grant
2 parents 3bfe741 + 202572c commit 391b875

21 files changed

Lines changed: 443 additions & 52 deletions

File tree

‎src/it/java/io/weaviate/integration/RbacITest.java‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,6 @@ public void test_roles_Lifecycle() throws IOException {
8484
Permission.groups("my-group", GroupType.OIDC, GroupsPermission.Action.READ));
8585
});
8686

87-
requireAtLeast(Weaviate.Version.V132, () -> {
88-
permissions.add(
89-
Permission.aliases("ThingsAlias", myCollection, AliasesPermission.Action.CREATE));
90-
});
91-
requireAtLeast(Weaviate.Version.V133, () -> {
92-
permissions.add(
93-
Permission.groups("my-group", GroupType.OIDC, GroupsPermission.Action.READ));
94-
});
95-
9687
// Act: create role
9788
client.roles.create(nsRole, permissions);
9889

‎src/main/java/io/weaviate/client6/v1/api/Authentication.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,26 @@ public static Authentication resourceOwnerPassword(String username, String passw
5656
};
5757
}
5858

59+
/**
60+
* Authenticate using Resource Owner Password Credentials authorization grant.
61+
*
62+
* @param clientSecret Client secret.
63+
* @param username Resource owner username.
64+
* @param password Resource owner password.
65+
* @param scopes Client scopes.
66+
*
67+
* @return Authentication provider.
68+
* @throws WeaviateOAuthException if an error occurred at any point of the token
69+
* exchange process.
70+
*/
71+
public static Authentication resourceOwnerPasswordCredentials(String clientSecret, String username, String password,
72+
List<String> scopes) {
73+
return transport -> {
74+
OidcConfig oidc = OidcUtils.getConfig(transport).withScopes(scopes).withScopes("offline_access");
75+
return TokenProvider.resourceOwnerPasswordCredentials(oidc, clientSecret, username, password);
76+
};
77+
}
78+
5979
/**
6080
* Authenticate using Client Credentials authorization grant.
6181
*

‎src/main/java/io/weaviate/client6/v1/api/Config.java‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
import io.weaviate.client6.v1.internal.BuildInfo;
1111
import io.weaviate.client6.v1.internal.ObjectBuilder;
12+
import io.weaviate.client6.v1.internal.Proxy;
1213
import io.weaviate.client6.v1.internal.Timeout;
1314
import io.weaviate.client6.v1.internal.TokenProvider;
1415
import io.weaviate.client6.v1.internal.TransportOptions;
@@ -24,7 +25,8 @@ public record Config(
2425
Map<String, String> headers,
2526
Authentication authentication,
2627
TrustManagerFactory trustManagerFactory,
27-
Timeout timeout) {
28+
Timeout timeout,
29+
Proxy proxy) {
2830

2931
public static Config of(Function<Custom, ObjectBuilder<Config>> fn) {
3032
return fn.apply(new Custom()).build();
@@ -40,23 +42,24 @@ private Config(Builder<?> builder) {
4042
builder.headers,
4143
builder.authentication,
4244
builder.trustManagerFactory,
43-
builder.timeout);
45+
builder.timeout,
46+
builder.proxy);
4447
}
4548

4649
RestTransportOptions restTransportOptions() {
4750
return restTransportOptions(null);
4851
}
4952

5053
RestTransportOptions restTransportOptions(TokenProvider tokenProvider) {
51-
return new RestTransportOptions(scheme, httpHost, httpPort, headers, tokenProvider, trustManagerFactory, timeout);
54+
return new RestTransportOptions(scheme, httpHost, httpPort, headers, tokenProvider, trustManagerFactory, timeout, proxy);
5255
}
5356

5457
GrpcChannelOptions grpcTransportOptions() {
5558
return grpcTransportOptions(null);
5659
}
5760

5861
GrpcChannelOptions grpcTransportOptions(TokenProvider tokenProvider) {
59-
return new GrpcChannelOptions(scheme, grpcHost, grpcPort, headers, tokenProvider, trustManagerFactory, timeout);
62+
return new GrpcChannelOptions(scheme, grpcHost, grpcPort, headers, tokenProvider, trustManagerFactory, timeout, proxy);
6063
}
6164

6265
private abstract static class Builder<SelfT extends Builder<SelfT>> implements ObjectBuilder<Config> {
@@ -70,6 +73,7 @@ private abstract static class Builder<SelfT extends Builder<SelfT>> implements O
7073
protected TrustManagerFactory trustManagerFactory;
7174
protected Timeout timeout = new Timeout();
7275
protected Map<String, String> headers = new HashMap<>();
76+
protected Proxy proxy;
7377

7478
/**
7579
* Set URL scheme. Subclasses may increase the visibility of this method to
@@ -175,6 +179,15 @@ public SelfT timeout(int initSeconds, int querySeconds, int insertSeconds) {
175179
return (SelfT) this;
176180
}
177181

182+
/**
183+
* Set proxy for all requests.
184+
*/
185+
@SuppressWarnings("unchecked")
186+
public SelfT proxy(Proxy proxy) {
187+
this.proxy = proxy;
188+
return (SelfT) this;
189+
}
190+
178191
/**
179192
* Weaviate will use the URL in this header to call Weaviate Embeddings
180193
* Service if an appropriate vectorizer is configured for collection.

‎src/main/java/io/weaviate/client6/v1/api/WeaviateClient.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,13 @@ public class WeaviateClient implements AutoCloseable {
6363
public final WeaviateClusterClient cluster;
6464

6565
public WeaviateClient(Config config) {
66-
RestTransportOptions restOpt;
66+
RestTransportOptions restOpt = config.restTransportOptions();
6767
GrpcChannelOptions grpcOpt;
6868
if (config.authentication() == null) {
69-
restOpt = config.restTransportOptions();
7069
grpcOpt = config.grpcTransportOptions();
7170
} else {
7271
TokenProvider tokenProvider;
73-
try (final var noAuthRest = new DefaultRestTransport(config.restTransportOptions())) {
72+
try (final var noAuthRest = new DefaultRestTransport(restOpt)) {
7473
tokenProvider = config.authentication().getTokenProvider(noAuthRest);
7574
} catch (Exception e) {
7675
// Generally exceptions are caught in TokenProvider internals.
@@ -126,6 +125,10 @@ public WeaviateClient(Config config) {
126125
this.config = config;
127126
}
128127

128+
public Config getConfig() {
129+
return config;
130+
}
131+
129132
/**
130133
* Create {@link WeaviateClientAsync} with identical configurations.
131134
* It is a shorthand for:

‎src/main/java/io/weaviate/client6/v1/api/collections/WeaviateCollectionsClient.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public CollectionHandle<Map<String, Object>> use(
7575
return use(CollectionDescriptor.ofMap(collectionName), fn);
7676
}
7777

78-
private <PropertiesT> CollectionHandle<PropertiesT> use(CollectionDescriptor<PropertiesT> collection,
78+
public <PropertiesT> CollectionHandle<PropertiesT> use(CollectionDescriptor<PropertiesT> collection,
7979
Function<CollectionHandleDefaults.Builder, ObjectBuilder<CollectionHandleDefaults>> fn) {
8080
return new CollectionHandle<>(restTransport, grpcTransport, collection, CollectionHandleDefaults.of(fn));
8181
}

‎src/main/java/io/weaviate/client6/v1/internal/Proxy.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
package io.weaviate.client6.v1.internal;
2+
3+
import javax.annotation.Nullable;
4+
5+
public record Proxy(
6+
String scheme,
7+
String host,
8+
int port,
9+
@Nullable String username,
10+
@Nullable String password
11+
) {
12+
public Proxy(String host, int port) {
13+
this("http", host, port, null, null);
14+
}
15+
}

‎src/main/java/io/weaviate/client6/v1/internal/TokenProvider.java‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,24 @@ public static TokenProvider resourceOwnerPassword(OidcConfig oidc, String userna
141141
return background(reuse(null, exchange(oidc, passwordGrant), DEFAULT_EARLY_EXPIRY));
142142
}
143143

144+
/**
145+
* Create a TokenProvider that uses Resource Owner Password Credentials authorization grant.
146+
*
147+
* @param oidc OIDC config.
148+
* @param clientSecret Client secret.
149+
* @param username Resource owner username.
150+
* @param password Resource owner password.
151+
*
152+
* @return Internal TokenProvider implementation.
153+
* @throws WeaviateOAuthException if an error occurred at any point of the token
154+
* exchange process.
155+
*/
156+
public static TokenProvider resourceOwnerPasswordCredentials(OidcConfig oidc, String clientSecret, String username,
157+
String password) {
158+
final var passwordGrant = NimbusTokenProvider.resouceOwnerPasswordCredentials(oidc, clientSecret, username, password);
159+
return background(reuse(null, exchange(oidc, passwordGrant), DEFAULT_EARLY_EXPIRY));
160+
}
161+
144162
/**
145163
* Create a TokenProvider that uses Client Credentials authorization grant.
146164
*

‎src/main/java/io/weaviate/client6/v1/internal/TransportOptions.java‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,18 @@ public abstract class TransportOptions<H> {
1111
protected final H headers;
1212
protected final TrustManagerFactory trustManagerFactory;
1313
protected final Timeout timeout;
14+
protected final Proxy proxy;
1415

1516
protected TransportOptions(String scheme, String host, int port, H headers, TokenProvider tokenProvider,
16-
TrustManagerFactory tmf, Timeout timeout) {
17+
TrustManagerFactory tmf, Timeout timeout, Proxy proxy) {
1718
this.scheme = scheme;
1819
this.host = host;
1920
this.port = port;
2021
this.tokenProvider = tokenProvider;
2122
this.headers = headers;
2223
this.timeout = timeout;
2324
this.trustManagerFactory = tmf;
25+
this.proxy = proxy;
2426
}
2527

2628
public boolean isSecure() {
@@ -58,6 +60,11 @@ public TrustManagerFactory trustManagerFactory() {
5860
return this.trustManagerFactory;
5961
}
6062

63+
@Nullable
64+
public Proxy proxy() {
65+
return this.proxy;
66+
}
67+
6168
/**
6269
* isWeaviateDomain returns true if the host matches weaviate.io,
6370
* semi.technology, or weaviate.cloud domain.

‎src/main/java/io/weaviate/client6/v1/internal/grpc/DefaultGrpcTransport.java‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
import com.google.common.util.concurrent.FutureCallback;
1313
import com.google.common.util.concurrent.Futures;
1414
import com.google.common.util.concurrent.ListenableFuture;
15-
15+
import io.grpc.HttpConnectProxiedSocketAddress;
1616
import io.grpc.ManagedChannel;
1717
import io.grpc.StatusRuntimeException;
1818
import io.grpc.netty.shaded.io.grpc.netty.GrpcSslContexts;
@@ -22,12 +22,19 @@
2222
import io.grpc.stub.MetadataUtils;
2323
import io.grpc.stub.StreamObserver;
2424
import io.weaviate.client6.v1.api.WeaviateApiException;
25+
import io.weaviate.client6.v1.internal.Proxy;
2526
import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateGrpc;
2627
import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateGrpc.WeaviateBlockingStub;
2728
import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateGrpc.WeaviateFutureStub;
2829
import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateProtoBatch.BatchStreamReply;
2930
import io.weaviate.client6.v1.internal.grpc.protocol.WeaviateProtoBatch.BatchStreamRequest;
3031

32+
import javax.net.ssl.SSLException;
33+
import java.net.InetSocketAddress;
34+
import java.net.SocketAddress;
35+
import java.util.concurrent.CompletableFuture;
36+
import java.util.concurrent.TimeUnit;
37+
3138
public final class DefaultGrpcTransport implements GrpcTransport {
3239
/**
3340
* ListenableFuture callbacks are executed
@@ -92,7 +99,7 @@ public <RequestT, RequestM, ReplyM, ResponseT> CompletableFuture<ResponseT> perf
9299
var method = rpc.methodAsync();
93100
var stub = applyTimeout(futureStub, rpc);
94101
var reply = method.apply(stub, message);
95-
return toCompletableFuture(reply).thenApply(r -> rpc.unmarshal(r));
102+
return toCompletableFuture(reply).thenApply(rpc::unmarshal);
96103
}
97104

98105
/**
@@ -146,6 +153,27 @@ private static ManagedChannel buildChannel(GrpcChannelOptions transportOptions)
146153
channel.sslContext(sslCtx);
147154
}
148155

156+
if (transportOptions.proxy() != null) {
157+
Proxy proxy = transportOptions.proxy();
158+
if ("http".equals(proxy.scheme()) || "https".equals(proxy.scheme())) {
159+
final SocketAddress proxyAddress = new InetSocketAddress(proxy.host(), proxy.port());
160+
channel.proxyDetector(targetAddress -> {
161+
if (targetAddress instanceof InetSocketAddress) {
162+
HttpConnectProxiedSocketAddress.Builder builder = HttpConnectProxiedSocketAddress.newBuilder()
163+
.setProxyAddress(proxyAddress)
164+
.setTargetAddress((InetSocketAddress) targetAddress);
165+
166+
if (proxy.username() != null && proxy.password() != null) {
167+
builder.setUsername(proxy.username());
168+
builder.setPassword(proxy.password());
169+
}
170+
return builder.build();
171+
}
172+
return null;
173+
});
174+
}
175+
}
176+
149177
channel.intercept(MetadataUtils.newAttachHeadersInterceptor(transportOptions.headers()));
150178
return channel.build();
151179
}

‎src/main/java/io/weaviate/client6/v1/internal/grpc/GrpcChannelOptions.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import javax.net.ssl.TrustManagerFactory;
77

88
import io.grpc.Metadata;
9+
import io.weaviate.client6.v1.internal.Proxy;
910
import io.weaviate.client6.v1.internal.Timeout;
1011
import io.weaviate.client6.v1.internal.TokenProvider;
1112
import io.weaviate.client6.v1.internal.TransportOptions;
@@ -14,20 +15,19 @@ public class GrpcChannelOptions extends TransportOptions<Metadata> {
1415
private final OptionalInt maxMessageSize;
1516

1617
public GrpcChannelOptions(String scheme, String host, int port, Map<String, String> headers,
17-
TokenProvider tokenProvider, TrustManagerFactory tmf, Timeout timeout) {
18-
this(scheme, host, port, buildMetadata(headers), tokenProvider, tmf, null, timeout);
18+
TokenProvider tokenProvider, TrustManagerFactory tmf, Timeout timeout, Proxy proxy) {
19+
this(scheme, host, port, buildMetadata(headers), tokenProvider, tmf, OptionalInt.empty(), timeout, proxy);
1920
}
2021

2122
private GrpcChannelOptions(String scheme, String host, int port, Metadata headers,
22-
TokenProvider tokenProvider, TrustManagerFactory tmf, OptionalInt maxMessageSize, Timeout timeout) {
23-
super(scheme, host, port, headers, tokenProvider, tmf, timeout);
23+
TokenProvider tokenProvider, TrustManagerFactory tmf, OptionalInt maxMessageSize, Timeout timeout, Proxy proxy) {
24+
super(scheme, host, port, headers, tokenProvider, tmf, timeout, proxy);
2425
this.maxMessageSize = maxMessageSize;
2526
}
2627

2728
public GrpcChannelOptions withMaxMessageSize(int maxMessageSize) {
2829
return new GrpcChannelOptions(scheme, host, port, headers, tokenProvider, trustManagerFactory,
29-
OptionalInt.of(maxMessageSize),
30-
timeout);
30+
OptionalInt.of(maxMessageSize), timeout, proxy);
3131
}
3232

3333
public OptionalInt maxMessageSize() {

0 commit comments

Comments
 (0)