ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

Closed
ghost wants to merge 1 commit into from
Closed

ARROW-5877: [FlightRPC] Fix Python<->Java auth issues #4838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions cpp/src/arrow/flight/client.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
GrpcClientAuthSender outgoing{stream};
GrpcClientAuthReader incoming{stream};
RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
// Explicitly close our side of the connection
bool finished_writes = stream->WritesDone();
RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
if (!finished_writes) {
return Status::UnknownError("Could not finish writing before closing");
}
return Status::OK();
}

Expand Down
46 changes: 37 additions & 9 deletions java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
AuthObserver observer = new AuthObserver();
observer.responseObserver = stub.handshake(observer);
authHandler.authenticate(observer.sender, observer.iter);
observer.responseObserver.onCompleted();
if (!observer.sender.errored) {
observer.responseObserver.onCompleted();
}
try {
if (!observer.completed.get()) {
// TODO: ARROW-5681
throw new RuntimeException("Unauthenticated");
}
} catch (InterruptedException | ExecutionException e) {
throw new RuntimeException(e);
}
}

private static class AuthObserver implements StreamObserver<HandshakeResponse> {

private volatile StreamObserver<HandshakeRequest> responseObserver;
private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
private final AuthSender sender = new AuthSender();
private volatile boolean completed = false;
private Throwable ex = null;
private CompletableFuture<Boolean> completed;

public AuthObserver() {
super();
completed = new CompletableFuture<>();
}

@Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

@Override
public byte[] next() {
while (ex == null && (!completed || !messages.isEmpty())) {
while (!completed.isDone() || !messages.isEmpty()) {
byte[] bytes = messages.poll();
if (bytes == null) {
// busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
}
}

if (ex != null) {
throw Throwables.propagate(ex);
if (completed.isCompletedExceptionally()) {
// Preserve prior exception behavior
// TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
try {
completed.get();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ExecutionException e) {
if (e.getCause() instanceof StatusRuntimeException) {
throw (StatusRuntimeException) e.getCause();
}
throw new RuntimeException(e);
}
}

throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

@Override
public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
}

private class AuthSender implements ClientAuthSender {

private boolean errored = false;

@Override
public void send(byte[] payload) {
responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

@Override
public void onError(String message, Throwable cause) {
this.errored = true;
Objects.requireNonNull(cause);
responseObserver.onError(cause);
}

}

@Override
public void onCompleted() {
completed = true;
completed.complete(true);
}
}

Expand Down
2 changes: 2 additions & 0 deletions java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
/**
* Handle the initial handshake with the client.
*
* @param outgoing A writer to send messages to the client.
* @param incoming An iterator of messages from the client.
* @return true if client is authenticated, false otherwise.
*/
boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down
2 changes: 2 additions & 0 deletions java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

responseObserver.onError(Status.PERMISSION_DENIED.asException());
} catch (Exception ex) {
ex.printStackTrace();
responseObserver.onError(ex);
}
};
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

@Override
public void onError(Throwable t) {
completed = true;
while (future == null) {/* busy wait */}
future.cancel(true);
}
Expand Down
94 changes: 94 additions & 0 deletions java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
* 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

/** An auth handler that does not send messages should not block the server forever. */
@Test(expected = RuntimeException.class)
public void noMessages() throws Exception {
try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
final FlightServer s = FlightTestUtil
.getStartedServer(
location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
new OneshotAuthHandler()).build());
final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
client.authenticate(new ClientAuthHandler() {
@Override
public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
}

@Override
public byte[] getCallToken() {
return new byte[0];
}
});
}
}

/** An auth handler that sends an error should not block the server forever. */
@Test(expected = RuntimeException.class)
public void clientError() throws Exception {
try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
final FlightServer s = FlightTestUtil
.getStartedServer(
location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
new OneshotAuthHandler()).build());
final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
client.authenticate(new ClientAuthHandler() {
@Override
public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
outgoing.send(new byte[0]);
// Ensure the server-side runs
incoming.next();
outgoing.onError("test", new RuntimeException("test"));
}

@Override
public byte[] getCallToken() {
return new byte[0];
}
});
}
}

private static class OneshotAuthHandler implements ServerAuthHandler {

@Override
public Optional<String> isValid(byte[] token) {
return Optional.of("test");
}

@Override
public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
incoming.next();
outgoing.send(new byte[0]);
return false;
}
}
}
2 changes: 1 addition & 1 deletion ...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
final String PERMISSION_DENIED = "PERMISSION_DENIED";

private static final String USERNAME = "flight";
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ARROW-5877: [FlightRPC] Fix Python<->Java auth issues#4838

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

 Closed

ghost
wants to merge
1
commit into

from

 Closed


ARROW-5877: [FlightRPC] Fix Python<->Java auth issues
#4838
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


5 changes: 5 additions & 0 deletions
cpp/src/arrow/flight/client.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -430,7 +430,12 @@ class FlightClient::FlightClientImpl {
 GrpcClientAuthSender outgoing{stream};
 GrpcClientAuthReader incoming{stream};
 RETURN_NOT_OK(auth_handler_->Authenticate(&outgoing, &incoming));
 // Explicitly close our side of the connection
 bool finished_writes = stream->WritesDone();
 RETURN_NOT_OK(internal::FromGrpcStatus(stream->Finish()));
 if (!finished_writes) {
 return Status::UnknownError("Could not finish writing before closing");
 }
 return Status::OK();
 }

Expand Down

46 changes: 37 additions & 9 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ClientAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,16 +18,19 @@
package org.apache.arrow.flight.auth;

import java.util.Iterator;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.LinkedBlockingQueue;

import org.apache.arrow.flight.auth.ClientAuthHandler.ClientAuthSender;
import org.apache.arrow.flight.impl.Flight.HandshakeRequest;
import org.apache.arrow.flight.impl.Flight.HandshakeResponse;
import org.apache.arrow.flight.impl.FlightServiceGrpc.FlightServiceStub;

import com.google.common.base.Throwables;
import com.google.protobuf.ByteString;

import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

/**
Expand All@@ -45,19 +48,29 @@ public static void doClientAuth(ClientAuthHandler authHandler, FlightServiceStub
 AuthObserver observer = new AuthObserver();
 observer.responseObserver = stub.handshake(observer);
 authHandler.authenticate(observer.sender, observer.iter);
 observer.responseObserver.onCompleted();
 if (!observer.sender.errored) {
 observer.responseObserver.onCompleted();
 }
 try {
 if (!observer.completed.get()) {
 // TODO: ARROW-5681
 throw new RuntimeException("Unauthenticated");
 }
 } catch (InterruptedException | ExecutionException e) {
 throw new RuntimeException(e);
 }
 }

 private static class AuthObserver implements StreamObserver<HandshakeResponse> {

 private volatile StreamObserver<HandshakeRequest> responseObserver;
 private final LinkedBlockingQueue<byte[]> messages = new LinkedBlockingQueue<>();
 private final AuthSender sender = new AuthSender();
 private volatile boolean completed = false;
 private Throwable ex = null;
 private CompletableFuture<Boolean> completed;

 public AuthObserver() {
 super();
 completed = new CompletableFuture<>();
 }

 @Override
Expand All@@ -72,7 +85,7 @@ public void onNext(HandshakeResponse value) {

 @Override
 public byte[] next() {
 while (ex == null && (!completed || !messages.isEmpty())) {
 while (!completed.isDone() || !messages.isEmpty()) {
 byte[] bytes = messages.poll();
 if (bytes == null) {
 // busy wait.
Expand All@@ -82,8 +95,19 @@ public byte[] next() {
 }
 }

 if (ex != null) {
 throw Throwables.propagate(ex);
 if (completed.isCompletedExceptionally()) {
 // Preserve prior exception behavior
 // TODO: with ARROW-5681, throw an appropriate Flight exception if gRPC raised an exception
 try {
 completed.get();
 } catch (InterruptedException e) {
 throw new RuntimeException(e);
 } catch (ExecutionException e) {
 if (e.getCause() instanceof StatusRuntimeException) {
 throw (StatusRuntimeException) e.getCause();
 }
 throw new RuntimeException(e);
 }
 }

 throw new IllegalStateException("You attempted to retrieve messages after there were none.");
Expand All@@ -97,11 +121,13 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
ex = t;
completed.completeExceptionally(t);
 }

 private class AuthSender implements ClientAuthSender {

 private boolean errored = false;

 @Override
 public void send(byte[] payload) {
 responseObserver.onNext(HandshakeRequest.newBuilder()
Expand All@@ -111,14 +137,16 @@ public void send(byte[] payload) {

 @Override
 public void onError(String message, Throwable cause) {
 this.errored = true;
 Objects.requireNonNull(cause);
 responseObserver.onError(cause);
 }

 }

 @Override
 public void onCompleted() {
 completed = true;
 completed.complete(true);
 }
 }

Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,6 +36,8 @@ public interface ServerAuthHandler {
 /**
 * Handle the initial handshake with the client.
 *
 * @param outgoing A writer to send messages to the client.
 * @param incoming An iterator of messages from the client.
 * @return true if client is authenticated, false otherwise.
 */
 boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming);
Expand Down

2 changes: 2 additions & 0 deletions
java/flight/src/main/java/org/apache/arrow/flight/auth/ServerAuthWrapper.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ public static StreamObserver<HandshakeRequest> wrapHandshake(ServerAuthHandler a

 responseObserver.onError(Status.PERMISSION_DENIED.asException());
 } catch (Exception ex) {
 ex.printStackTrace();
 responseObserver.onError(ex);
 }
 };
Expand DownExpand Up@@ -109,6 +110,7 @@ public boolean hasNext() {

 @Override
 public void onError(Throwable t) {
 completed = true;
 while (future == null) {/* busy wait */}
 future.cancel(true);
 }
Expand Down

94 changes: 94 additions & 0 deletions
java/flight/src/test/java/org/apache/arrow/flight/TestAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
/*
 * 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 org.apache.arrow.flight;

import java.util.Iterator;
import java.util.Optional;

import org.apache.arrow.flight.auth.ClientAuthHandler;
import org.apache.arrow.flight.auth.ServerAuthHandler;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;

import org.junit.Test;

public class TestAuth {

 /** An auth handler that does not send messages should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void noMessages() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 /** An auth handler that sends an error should not block the server forever. */
 @Test(expected = RuntimeException.class)
 public void clientError() throws Exception {
 try (final BufferAllocator allocator = new RootAllocator(Integer.MAX_VALUE);
 final FlightServer s = FlightTestUtil
 .getStartedServer(
 location -> FlightServer.builder(allocator, location, new NoOpFlightProducer()).authHandler(
 new OneshotAuthHandler()).build());
 final FlightClient client = FlightClient.builder(allocator, s.getLocation()).build()) {
 client.authenticate(new ClientAuthHandler() {
 @Override
 public void authenticate(ClientAuthSender outgoing, Iterator<byte[]> incoming) {
 outgoing.send(new byte[0]);
 // Ensure the server-side runs
 incoming.next();
 outgoing.onError("test", new RuntimeException("test"));
 }

 @Override
 public byte[] getCallToken() {
 return new byte[0];
 }
 });
 }
 }

 private static class OneshotAuthHandler implements ServerAuthHandler {

 @Override
 public Optional<String> isValid(byte[] token) {
 return Optional.of("test");
 }

 @Override
 public boolean authenticate(ServerAuthSender outgoing, Iterator<byte[]> incoming) {
 incoming.next();
 outgoing.send(new byte[0]);
 return false;
 }
 }
}

2 changes: 1 addition & 1 deletion
...rg/apache/arrow/flight/auth/TestAuth.java → ...ache/arrow/flight/auth/TestBasicAuth.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,7 @@

import io.grpc.StatusRuntimeException;

public class TestAuth {
public class TestBasicAuth {
 final String PERMISSION_DENIED = "PERMISSION_DENIED";

 private static final String USERNAME = "flight";
Expand Down