package io.vertx.ext.auth.oauth2.providers;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.http.HttpClientOptions;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.auth.PubSecKeyOptions;
import io.vertx.ext.auth.oauth2.OAuth2Auth;
import io.vertx.ext.auth.oauth2.OAuth2ClientOptions;
import io.vertx.ext.auth.oauth2.OAuth2FlowType;
import io.vertx.ext.jwt.JWTOptions;

Simplified factory to create an OAuth2Auth for Google.
Author:Paulo Lopes
/** * Simplified factory to create an {@link io.vertx.ext.auth.oauth2.OAuth2Auth} for Google. * * @author <a href="mailto:plopes@redhat.com">Paulo Lopes</a> */
@VertxGen public interface GoogleAuth extends OpenIDConnectAuth {
Create a OAuth2Auth provider for Google
Params:
  • clientId – the client id given to you by Google
  • clientSecret – the client secret given to you by Google
/** * Create a OAuth2Auth provider for Google * * @param clientId the client id given to you by Google * @param clientSecret the client secret given to you by Google */
static OAuth2Auth create(Vertx vertx, String clientId, String clientSecret) { return create(vertx, clientId, clientSecret, new HttpClientOptions()); }
Create a OAuth2Auth provider for Google
Params:
  • clientId – the client id given to you by Google
  • clientSecret – the client secret given to you by Google
  • httpClientOptions – custom http client options
/** * Create a OAuth2Auth provider for Google * * @param clientId the client id given to you by Google * @param clientSecret the client secret given to you by Google * @param httpClientOptions custom http client options */
static OAuth2Auth create(Vertx vertx, String clientId, String clientSecret, HttpClientOptions httpClientOptions) { return OAuth2Auth.create(vertx, new OAuth2ClientOptions(httpClientOptions) .setSite("https://accounts.google.com") .setFlow(OAuth2FlowType.AUTH_CODE) .setTokenPath("https://www.googleapis.com/oauth2/v3/token") .setAuthorizationPath("/o/oauth2/auth") .setIntrospectionPath("https://www.googleapis.com/oauth2/v3/tokeninfo") .setUserInfoPath("https://www.googleapis.com/oauth2/v3/userinfo") .setJwkPath("https://www.googleapis.com/oauth2/v3/certs") .setUserInfoParameters(new JsonObject() .put("alt", "json")) .setScopeSeparator(" ") .setClientID(clientId) .setClientSecret(clientSecret)); }
Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the configuration options and attempt to load the well known descriptor. If a site is provided (for example when running on a custom instance) that site will be used to do the lookup.

If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded into the OAuth provider so tokens can be decoded.

Params:
  • vertx – the vertx instance
  • config – the initial config
  • handler – the instantiated Oauth2 provider instance handler
/** * Create a OAuth2Auth provider for OpenID Connect Discovery. The discovery will use the default site in the * configuration options and attempt to load the well known descriptor. If a site is provided (for example when * running on a custom instance) that site will be used to do the lookup. * <p> * If the discovered config includes a json web key url, it will be also fetched and the JWKs will be loaded * into the OAuth provider so tokens can be decoded. * * @param vertx the vertx instance * @param config the initial config * @param handler the instantiated Oauth2 provider instance handler */
static void discover(final Vertx vertx, final OAuth2ClientOptions config, final Handler<AsyncResult<OAuth2Auth>> handler) { // don't override if already set final String site = config.getSite() == null ? "https://accounts.google.com" : config.getSite(); OpenIDConnectAuth.discover( vertx, new OAuth2ClientOptions(config) .setSite(site) .setUserInfoParameters(new JsonObject() .put("alt", "json")) .setScopeSeparator(" "), handler); }
Create a OAuth2Auth provider for Google Service Account (Server to Server)
Params:
  • serviceAccountJson – the configuration json file from your Google API page
/** * Create a OAuth2Auth provider for Google Service Account (Server to Server) * * @param serviceAccountJson the configuration json file from your Google API page */
static OAuth2Auth create(Vertx vertx, JsonObject serviceAccountJson) { return create(vertx, serviceAccountJson, new HttpClientOptions()); }
Create a OAuth2Auth provider for Google Service Account (Server to Server)
Params:
  • serviceAccountJson – the configuration json file from your Google API page
  • httpClientOptions – custom http client options
/** * Create a OAuth2Auth provider for Google Service Account (Server to Server) * * @param serviceAccountJson the configuration json file from your Google API page * @param httpClientOptions custom http client options */
static OAuth2Auth create(Vertx vertx, JsonObject serviceAccountJson, HttpClientOptions httpClientOptions) { final StringBuilder privateKey = new StringBuilder(); for (String s : serviceAccountJson.getString("private_key").split("\n")) { if ("-----BEGIN PRIVATE KEY-----".equals(s) || "-----END PRIVATE KEY-----".equals(s)) { continue; } privateKey.append(s); } return OAuth2Auth.create(vertx, new OAuth2ClientOptions(httpClientOptions) .setFlow(OAuth2FlowType.AUTH_JWT) .setClientID(serviceAccountJson.getString("client_id")) .setSite("https://accounts.google.com") .setTokenPath(serviceAccountJson.getString("token_uri")) .addPubSecKey(new PubSecKeyOptions() .setAlgorithm("RS256") .setSecretKey(privateKey.toString())) .setJWTOptions(new JWTOptions() .setAlgorithm("RS256") .setExpiresInMinutes(60) .addAudience(serviceAccountJson.getString("token_uri")) .setIssuer(serviceAccountJson.getString("client_email")))); } }