Skip to content

Commit

Permalink
feat: Replace Jetty with HttpServer.
Browse files Browse the repository at this point in the history 
Remove Jetty v8.2 and replace with com.sun.net.httpserver.HttpServer.  Jetty has had breaking changes since 8.2 (specifically with version 9.4).  This causes with conflicts with newer code using later versions of Jetty.  Removing dependency on Jetty resolves this issue.

Fixes googleapis#397.
  • Loading branch information
@ericraskin
ericraskin committed Feb 18, 2020
1 parent 851af81 commit cb0a581
Show file tree
Hide file tree
Showing 3 changed files with 150 additions and 60 deletions.
4 changes: 0 additions & 4 deletions google-oauth-client-jetty/pom.xml
View file
Expand Up @@ -86,10 +86,6 @@
<groupId>com.google.oauth-client</groupId>
<artifactId>google-oauth-client-java6</artifactId>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-server</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
Expand Down
198 changes: 147 additions & 51 deletions ...src/main/java/com/google/api/client/extensions/jetty/auth/oauth2/LocalServerReceiver.java
View file
Expand Up @@ -16,15 +16,19 @@

import com.google.api.client.extensions.java6.auth.oauth2.VerificationCodeReceiver;
import com.google.api.client.util.Throwables;
import com.sun.net.httpserver.*;

import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Semaphore;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.handler.AbstractHandler;

import static java.net.HttpURLConnection.HTTP_MOVED_TEMP;
import static java.net.HttpURLConnection.HTTP_OK;

/**
* OAuth 2.0 verification code receiver that runs a Jetty server on a free port, waiting for a
Expand All @@ -34,34 +38,48 @@
* Implementation is thread-safe.
* </p>
*
* @since 1.11
* @author Yaniv Inbar
* @since 1.11
*/
public final class LocalServerReceiver implements VerificationCodeReceiver {

private static final String LOCALHOST = "localhost";

private static final String CALLBACK_PATH = "/Callback";

/** Server or {@code null} before {@link #getRedirectUri()}. */
private Server server;
/**
* Server or {@code null} before {@link #getRedirectUri()}.
*/
private HttpServer server;

/** Verification code or {@code null} for none. */
/**
* Verification code or {@code null} for none.
*/
String code;

/** Error code or {@code null} for none. */
/**
* Error code or {@code null} for none.
*/
String error;

/** To block until receiving an authorization response or stop() is called. */
/**
* To block until receiving an authorization response or stop() is called.
*/
final Semaphore waitUnlessSignaled = new Semaphore(0 /* initially zero permit */);

/** Port to use or {@code -1} to select an unused port in {@link #getRedirectUri()}. */
/**
* Port to use or {@code -1} to select an unused port in {@link #getRedirectUri()}.
*/
private int port;

/** Host name to use. */
/**
* Host name to use.
*/
private final String host;

/** Callback path of redirect_uri */
/**
* Callback path of redirect_uri.
*/
private final String callbackPath;

/**
Expand Down Expand Up @@ -115,28 +133,63 @@ public LocalServerReceiver() {

@Override
public String getRedirectUri() throws IOException {

server = HttpServer.create(new InetSocketAddress(port != -1 ? port : findOpenPort()), 0);
HttpContext context = server.createContext(callbackPath, new CallbackHandler());
server.setExecutor(null);
/*
server = new Server(port != -1 ? port : 0);
Connector connector = server.getConnectors()[0];
ServerConnector connector = new ServerConnector(server);
connector.setHost(host);
server.setConnectors(new Connector[] { connector } );
server.setHandler(new CallbackHandler());
*/
try {
server.start();
port = connector.getLocalPort();
port = server.getAddress().getPort();
} catch (Exception e) {
Throwables.propagateIfPossible(e);
throw new IOException(e);
}
return "http://" + connector.getHost() + ":" + port + callbackPath;
return "http://" + this.getHost() + ":" + port + callbackPath;
}

/*
*Copied from Jetty findFreePort() as referenced by: https://gist.github.com/vorburger/3429822
*/

private int findOpenPort() {
ServerSocket socket = null;
try {
socket = new ServerSocket(0);
socket.setReuseAddress(true);
int port = socket.getLocalPort();
try {
socket.close();
} catch (IOException e) {
// Ignore IOException on close()
}
return port;
} catch (IOException e) {
} finally {
if (socket != null) {
try {
socket.close();
} catch (IOException e) {
}
}
}
throw new IllegalStateException("No free TCP/IP port to start embedded HTTP Server on");
}

/**
* Blocks until the server receives a login result, or the server is stopped
* by {@link #stop()}, to return an authorization code.
*
* @return authorization code if login succeeds; may return {@code null} if the server
* is stopped by {@link #stop()}
* is stopped by {@link #stop()}
* @throws IOException if the server receives an error code (through an HTTP request
* parameter {@code error})
* parameter {@code error})
*/
@Override
public String waitForCode() throws IOException {
Expand All @@ -152,7 +205,7 @@ public void stop() throws IOException {
waitUnlessSignaled.release();
if (server != null) {
try {
server.stop();
server.stop(0);
} catch (Exception e) {
Throwables.propagateIfPossible(e);
throw new IOException(e);
Expand All @@ -161,7 +214,9 @@ public void stop() throws IOException {
}
}

/** Returns the host name to use. */
/**
* Returns the host name to use.
*/
public String getHost() {
return host;
}
Expand Down Expand Up @@ -189,51 +244,69 @@ public String getCallbackPath() {
*/
public static final class Builder {

/** Host name to use. */
/**
* Host name to use.
*/
private String host = LOCALHOST;

/** Port to use or {@code -1} to select an unused port. */
/**
* Port to use or {@code -1} to select an unused port.
*/
private int port = -1;

private String successLandingPageUrl;
private String failureLandingPageUrl;

private String callbackPath = CALLBACK_PATH;

/** Builds the {@link LocalServerReceiver}. */
/**
* Builds the {@link LocalServerReceiver}.
*/
public LocalServerReceiver build() {
return new LocalServerReceiver(host, port, callbackPath,
successLandingPageUrl, failureLandingPageUrl);
}

/** Returns the host name to use. */
/**
* Returns the host name to use.
*/
public String getHost() {
return host;
}

/** Sets the host name to use. */
/**
* Sets the host name to use.
*/
public Builder setHost(String host) {
this.host = host;
return this;
}

/** Returns the port to use or {@code -1} to select an unused port. */
/**
* Returns the port to use or {@code -1} to select an unused port.
*/
public int getPort() {
return port;
}

/** Sets the port to use or {@code -1} to select an unused port. */
/**
* Sets the port to use or {@code -1} to select an unused port.
*/
public Builder setPort(int port) {
this.port = port;
return this;
}

/** Returns the callback path of redirect_uri */
/**
* Returns the callback path of redirect_uri.
*/
public String getCallbackPath() {
return callbackPath;
}

/** Set the callback path of redirect_uri */
/**
* Set the callback path of redirect_uri.
*/
public Builder setCallbackPath(String callbackPath) {
this.callbackPath = callbackPath;
return this;
Expand All @@ -247,51 +320,74 @@ public Builder setLandingPages(String successLandingPageUrl, String failureLandi
}

/**
* Jetty handler that takes the verifier token passed over from the OAuth provider and stashes it
* HttpServer handler that takes the verifier token passed over
* from the OAuth provider and stashes it
* where {@link #waitForCode} will find it.
*/
class CallbackHandler extends AbstractHandler {
class CallbackHandler implements HttpHandler {

@Override
public void handle(
String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response
)
throws IOException {
if (!callbackPath.equals(target)) {
public void handle(HttpExchange httpExchange) throws IOException {

if (!callbackPath.equals(httpExchange.getRequestURI().getPath())) {
return;
}

StringBuilder body = new StringBuilder();

try {
((Request) request).setHandled(true);
error = request.getParameter("error");
code = request.getParameter("code");
Map<String, String> parms =
this.queryToMap(httpExchange.getRequestURI().getQuery());
error = parms.get("error");
code = parms.get("code");

Headers respHeaders = httpExchange.getResponseHeaders();
if (error == null && successLandingPageUrl != null) {
response.sendRedirect(successLandingPageUrl);
respHeaders.add("Location", successLandingPageUrl);
httpExchange.sendResponseHeaders(HTTP_MOVED_TEMP, -1);
} else if (error != null && failureLandingPageUrl != null) {
response.sendRedirect(failureLandingPageUrl);
respHeaders.add("Location", failureLandingPageUrl);
httpExchange.sendResponseHeaders(HTTP_MOVED_TEMP, -1);
} else {
writeLandingHtml(response);
writeLandingHtml(httpExchange, respHeaders);
}
response.flushBuffer();
}
finally {
httpExchange.close();
} finally {
waitUnlessSignaled.release();
}
}

private void writeLandingHtml(HttpServletResponse response) throws IOException {
response.setStatus(HttpServletResponse.SC_OK);
response.setContentType("text/html");
private Map<String, String> queryToMap(String query) {
Map<String, String> result = new HashMap<String, String>();
if (query != null) {
for (String param : query.split("&")) {
String pair[] = param.split("=");
if (pair.length > 1) {
result.put(pair[0], pair[1]);
} else {
result.put(pair[0], "");
}
}
}
return result;
}

private void writeLandingHtml(HttpExchange exchange, Headers headers) throws IOException {
OutputStream os = exchange.getResponseBody();
exchange.sendResponseHeaders(HTTP_OK, 0);
headers.add("ContentType", "text/html");

PrintWriter doc = response.getWriter();
PrintWriter doc = new PrintWriter(os);
doc.println("<html>");
doc.println("<head><title>OAuth 2.0 Authentication Token Received</title></head>");
doc.println("<body>");
doc.println("Received verification code. You may now close this window.");
doc.println("</body>");
doc.println("</html>");
doc.flush();
os.close();
}

}

}
8 changes: 3 additions & 5 deletions pom.xml
View file
Expand Up @@ -150,11 +150,6 @@
<artifactId>google-oauth-client-jetty</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-server</artifactId>
<version>${project.jetty.version}</version>
</dependency>
<dependency>
<groupId>org.datanucleus</groupId>
<artifactId>datanucleus-core</artifactId>
Expand Down Expand Up @@ -399,6 +394,9 @@
<artifactId>java17</artifactId>
<version>1.0</version>
</signature>
<ignores>
<ignore>com.sun.net.httpserver.*</ignore>
</ignores>
</configuration>
<executions>
<execution>
Expand Down

0 comments on commit cb0a581

Please sign in to comment.