git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.myq.internal.handler;
  14
  15 import static org.openhab.binding.myq.internal.MyQBindingConstants.*;
  16
  17 import java.io.IOException;
  18 import java.net.CookieStore;
  19 import java.net.HttpCookie;
  20 import java.net.URI;
  21 import java.net.URISyntaxException;
  22 import java.nio.charset.StandardCharsets;
  23 import java.security.MessageDigest;
  24 import java.security.NoSuchAlgorithmException;
  25 import java.security.SecureRandom;
  26 import java.util.ArrayList;
  27 import java.util.Arrays;
  28 import java.util.Base64;
  29 import java.util.Collection;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Random;
  33 import java.util.Set;
  34 import java.util.concurrent.CompletableFuture;
  35 import java.util.concurrent.ExecutionException;
  36 import java.util.concurrent.Future;
  37 import java.util.concurrent.TimeUnit;
  38 import java.util.concurrent.TimeoutException;
  39 import java.util.stream.Collectors;
  40
  41 import org.eclipse.jdt.annotation.NonNullByDefault;
  42 import org.eclipse.jdt.annotation.Nullable;
  43 import org.eclipse.jetty.client.HttpClient;
  44 import org.eclipse.jetty.client.HttpContentResponse;
  45 import org.eclipse.jetty.client.api.ContentProvider;
  46 import org.eclipse.jetty.client.api.ContentResponse;
  47 import org.eclipse.jetty.client.api.Request;
  48 import org.eclipse.jetty.client.api.Response;
  49 import org.eclipse.jetty.client.api.Result;
  50 import org.eclipse.jetty.client.util.BufferingResponseListener;
  51 import org.eclipse.jetty.client.util.FormContentProvider;
  52 import org.eclipse.jetty.http.HttpMethod;
  53 import org.eclipse.jetty.http.HttpStatus;
  54 import org.eclipse.jetty.util.Fields;
  55 import org.jsoup.Jsoup;
  56 import org.jsoup.nodes.Document;
  57 import org.jsoup.nodes.Element;
  58 import org.openhab.binding.myq.internal.MyQDiscoveryService;
  59 import org.openhab.binding.myq.internal.config.MyQAccountConfiguration;
  60 import org.openhab.binding.myq.internal.dto.AccountDTO;
  61 import org.openhab.binding.myq.internal.dto.AccountsDTO;
  62 import org.openhab.binding.myq.internal.dto.DeviceDTO;
  63 import org.openhab.binding.myq.internal.dto.DevicesDTO;
  64 import org.openhab.core.auth.client.oauth2.AccessTokenRefreshListener;
  65 import org.openhab.core.auth.client.oauth2.AccessTokenResponse;
  66 import org.openhab.core.auth.client.oauth2.OAuthClientService;
  67 import org.openhab.core.auth.client.oauth2.OAuthException;
  68 import org.openhab.core.auth.client.oauth2.OAuthFactory;
  69 import org.openhab.core.auth.client.oauth2.OAuthResponseException;
  70 import org.openhab.core.thing.Bridge;
  71 import org.openhab.core.thing.ChannelUID;
  72 import org.openhab.core.thing.Thing;
  73 import org.openhab.core.thing.ThingStatus;
  74 import org.openhab.core.thing.ThingStatusDetail;
  75 import org.openhab.core.thing.ThingTypeUID;
  76 import org.openhab.core.thing.binding.BaseBridgeHandler;
  77 import org.openhab.core.thing.binding.ThingHandler;
  78 import org.openhab.core.thing.binding.ThingHandlerService;
  79 import org.openhab.core.types.Command;
  80 import org.slf4j.Logger;
  81 import org.slf4j.LoggerFactory;
  82
  83 import com.google.gson.FieldNamingPolicy;
  84 import com.google.gson.Gson;
  85 import com.google.gson.GsonBuilder;
  86 import com.google.gson.JsonSyntaxException;
  87
  88 /**
  89  * The {@link MyQAccountHandler} is responsible for communicating with the MyQ API based on an account.
  90  *
  91  * @author Dan Cunningham - Initial contribution
  92  */
  93 @NonNullByDefault
  94 public class MyQAccountHandler extends BaseBridgeHandler implements AccessTokenRefreshListener {
  95     /*
  96      * MyQ oAuth relate fields
  97      */
  98     private static final String CLIENT_SECRET = "VUQ0RFhuS3lQV3EyNUJTdw==";
  99     private static final String CLIENT_ID = "ANDROID_CGI_MYQ";
 100     private static final String REDIRECT_URI = "com.myqops://android";
 101     private static final String SCOPE = "MyQ_Residential offline_access";
 102     /*
 103      * MyQ authentication API endpoints
 104      */
 105     private static final String LOGIN_BASE_URL = "https://partner-identity.myq-cloud.com";
 106     private static final String LOGIN_AUTHORIZE_URL = LOGIN_BASE_URL + "/connect/authorize";
 107     private static final String LOGIN_TOKEN_URL = LOGIN_BASE_URL + "/connect/token";
 108     // this should never happen, but lets be safe and give up after so many redirects
 109     private static final int LOGIN_MAX_REDIRECTS = 30;
 110     /*
 111      * MyQ device and account API endpoints
 112      */
 113     private static final String ACCOUNTS_URL = "https://accounts.myq-cloud.com/api/v6.0/accounts";
 114     private static final String DEVICES_URL = "https://devices.myq-cloud.com/api/v5.2/Accounts/%s/Devices";
 115     private static final String CMD_LAMP_URL = "https://account-devices-lamp.myq-cloud.com/api/v5.2/Accounts/%s/lamps/%s/%s";
 116     private static final String CMD_DOOR_URL = "https://account-devices-gdo.myq-cloud.com/api/v5.2/Accounts/%s/door_openers/%s/%s";
 117
 118     private static final Integer RAPID_REFRESH_SECONDS = 5;
 119     private final Logger logger = LoggerFactory.getLogger(MyQAccountHandler.class);
 120     private final Gson gsonLowerCase = new GsonBuilder()
 121             .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES).create();
 122     private final OAuthFactory oAuthFactory;
 123     private @Nullable Future<?> normalPollFuture;
 124     private @Nullable Future<?> rapidPollFuture;
 125     private @Nullable AccountsDTO accounts;
 126
 127     private List<DeviceDTO> devicesCache = new ArrayList<DeviceDTO>();
 128     private @Nullable OAuthClientService oAuthService;
 129     private Integer normalRefreshSeconds = 60;
 130     private HttpClient httpClient;
 131     private String username = "";
 132     private String password = "";
 133     private String userAgent = "";
 134     // force login, even if we have a token
 135     private boolean needsLogin = false;
 136
 137     public MyQAccountHandler(Bridge bridge, HttpClient httpClient, final OAuthFactory oAuthFactory) {
 138         super(bridge);
 139         this.httpClient = httpClient;
 140         this.oAuthFactory = oAuthFactory;
 141     }
 142
 143     @Override
 144     public void handleCommand(ChannelUID channelUID, Command command) {
 145     }
 146
 147     @Override
 148     public void initialize() {
 149         MyQAccountConfiguration config = getConfigAs(MyQAccountConfiguration.class);
 150         normalRefreshSeconds = config.refreshInterval;
 151         username = config.username;
 152         password = config.password;
 153         // MyQ can get picky about blocking user agents apparently
 154         userAgent = ""; // no agent string
 155         needsLogin = true;
 156         updateStatus(ThingStatus.UNKNOWN);
 157         restartPolls(false);
 158     }
 159
 160     @Override
 161     public void dispose() {
 162         stopPolls();
 163         OAuthClientService oAuthService = this.oAuthService;
 164         if (oAuthService != null) {
 165             oAuthService.removeAccessTokenRefreshListener(this);
 166             oAuthFactory.ungetOAuthService(getThing().toString());
 167             this.oAuthService = null;
 168         }
 169     }
 170
 171     @Override
 172     public void handleRemoval() {
 173         oAuthFactory.deleteServiceAndAccessToken(getThing().toString());
 174         super.handleRemoval();
 175     }
 176
 177     @Override
 178     public Collection<Class<? extends ThingHandlerService>> getServices() {
 179         return Set.of(MyQDiscoveryService.class);
 180     }
 181
 182     @Override
 183     public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) {
 184         List<DeviceDTO> localDeviceCaches = devicesCache;
 185         if (childHandler instanceof MyQDeviceHandler deviceHandler) {
 186             localDeviceCaches.stream().filter(d -> deviceHandler.getSerialNumber().equalsIgnoreCase(d.serialNumber))
 187                     .findFirst().ifPresent(deviceHandler::handleDeviceUpdate);
 188         }
 189     }
 190
 191     @Override
 192     public void onAccessTokenResponse(AccessTokenResponse tokenResponse) {
 193         logger.debug("Auth Token Refreshed, expires in {}", tokenResponse.getExpiresIn());
 194     }
 195
 196     /**
 197      * Sends a door action to the MyQ API
 198      *
 199      * @param device
 200      * @param action
 201      */
 202     public void sendDoorAction(DeviceDTO device, String action) {
 203         sendAction(device, action, CMD_DOOR_URL);
 204     }
 205
 206     /**
 207      * Sends a lamp action to the MyQ API
 208      *
 209      * @param device
 210      * @param action
 211      */
 212     public void sendLampAction(DeviceDTO device, String action) {
 213         sendAction(device, action, CMD_LAMP_URL);
 214     }
 215
 216     private void sendAction(DeviceDTO device, String action, String urlFormat) {
 217         if (getThing().getStatus() != ThingStatus.ONLINE) {
 218             logger.debug("Account offline, ignoring action {}", action);
 219             return;
 220         }
 221
 222         try {
 223             ContentResponse response = sendRequest(
 224                     String.format(urlFormat, device.accountId, device.serialNumber, action), HttpMethod.PUT, null,
 225                     null);
 226             if (HttpStatus.isSuccess(response.getStatus())) {
 227                 restartPolls(true);
 228             } else {
 229                 logger.debug("Failed to send action {} : {}", action, response.getContentAsString());
 230             }
 231         } catch (InterruptedException | MyQCommunicationException | MyQAuthenticationException e) {
 232             logger.debug("Could not send action", e);
 233         }
 234     }
 235
 236     /**
 237      * Last known state of MyQ Devices
 238      *
 239      * @return cached MyQ devices
 240      */
 241     public @Nullable List<DeviceDTO> devicesCache() {
 242         return devicesCache;
 243     }
 244
 245     private void stopPolls() {
 246         stopNormalPoll();
 247         stopRapidPoll();
 248     }
 249
 250     private synchronized void stopNormalPoll() {
 251         stopFuture(normalPollFuture);
 252         normalPollFuture = null;
 253     }
 254
 255     private synchronized void stopRapidPoll() {
 256         stopFuture(rapidPollFuture);
 257         rapidPollFuture = null;
 258     }
 259
 260     private void stopFuture(@Nullable Future<?> future) {
 261         if (future != null) {
 262             future.cancel(true);
 263         }
 264     }
 265
 266     private synchronized void restartPolls(boolean rapid) {
 267         stopPolls();
 268         if (rapid) {
 269             normalPollFuture = scheduler.scheduleWithFixedDelay(this::normalPoll, 35, normalRefreshSeconds,
 270                     TimeUnit.SECONDS);
 271             rapidPollFuture = scheduler.scheduleWithFixedDelay(this::rapidPoll, 3, RAPID_REFRESH_SECONDS,
 272                     TimeUnit.SECONDS);
 273         } else {
 274             normalPollFuture = scheduler.scheduleWithFixedDelay(this::normalPoll, 0, normalRefreshSeconds,
 275                     TimeUnit.SECONDS);
 276         }
 277     }
 278
 279     private void normalPoll() {
 280         stopRapidPoll();
 281         fetchData();
 282     }
 283
 284     private void rapidPoll() {
 285         fetchData();
 286     }
 287
 288     private synchronized void fetchData() {
 289         try {
 290             if (accounts == null) {
 291                 getAccounts();
 292             }
 293             getDevices();
 294         } catch (MyQCommunicationException e) {
 295             logger.debug("MyQ communication error", e);
 296             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
 297         } catch (MyQAuthenticationException e) {
 298             logger.debug("MyQ authentication error", e);
 299             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
 300             stopPolls();
 301         } catch (InterruptedException e) {
 302             // we were shut down, ignore
 303         }
 304     }
 305
 306     /**
 307      * This attempts to navigate the MyQ oAuth login flow in order to obtain a @AccessTokenResponse
 308      *
 309      * @return AccessTokenResponse token
 310      * @throws InterruptedException
 311      * @throws MyQCommunicationException
 312      * @throws MyQAuthenticationException
 313      */
 314     private AccessTokenResponse login()
 315             throws InterruptedException, MyQCommunicationException, MyQAuthenticationException {
 316         try {
 317             // make sure we have a fresh session
 318             URI authUri = new URI(LOGIN_BASE_URL);
 319             CookieStore store = httpClient.getCookieStore();
 320             store.get(authUri).forEach(cookie -> {
 321                 store.remove(authUri, cookie);
 322             });
 323
 324             String codeVerifier = generateCodeVerifier();
 325
 326             ContentResponse loginPageResponse = getLoginPage(codeVerifier);
 327
 328             // load the login page to get cookies and form parameters
 329             Document loginPage = Jsoup.parse(loginPageResponse.getContentAsString());
 330             Element form = loginPage.select("form").first();
 331             Element requestToken = loginPage.select("input[name=__RequestVerificationToken]").first();
 332             Element returnURL = loginPage.select("input[name=ReturnUrl]").first();
 333
 334             if (form == null || requestToken == null) {
 335                 throw new MyQCommunicationException("Could not load login page");
 336             }
 337
 338             // url that the form will submit to
 339             String action = LOGIN_BASE_URL + form.attr("action");
 340
 341             // post our user name and password along with elements from the scraped form
 342             String location = postLogin(action, requestToken.attr("value"), returnURL.attr("value"));
 343             if (location == null) {
 344                 throw new MyQAuthenticationException("Could not login with credentials");
 345             }
 346
 347             // finally complete the oAuth flow and retrieve a JSON oAuth token response
 348             ContentResponse tokenResponse = getLoginToken(location, codeVerifier);
 349             String loginToken = tokenResponse.getContentAsString();
 350
 351             try {
 352                 AccessTokenResponse accessTokenResponse = gsonLowerCase.fromJson(loginToken, AccessTokenResponse.class);
 353                 if (accessTokenResponse == null) {
 354                     throw new MyQAuthenticationException("Could not parse token response");
 355                 }
 356                 getOAuthService().importAccessTokenResponse(accessTokenResponse);
 357                 return accessTokenResponse;
 358             } catch (JsonSyntaxException e) {
 359                 throw new MyQCommunicationException("Invalid Token Response " + loginToken);
 360             }
 361         } catch (IOException | ExecutionException | TimeoutException | OAuthException | URISyntaxException e) {
 362             throw new MyQCommunicationException(e.getMessage());
 363         }
 364     }
 365
 366     private void getAccounts() throws InterruptedException, MyQCommunicationException, MyQAuthenticationException {
 367         ContentResponse response = sendRequest(ACCOUNTS_URL, HttpMethod.GET, null, null);
 368         accounts = parseResultAndUpdateStatus(response, gsonLowerCase, AccountsDTO.class);
 369     }
 370
 371     private void getDevices() throws InterruptedException, MyQCommunicationException, MyQAuthenticationException {
 372         AccountsDTO localAccounts = accounts;
 373         if (localAccounts == null) {
 374             return;
 375         }
 376
 377         List<DeviceDTO> currentDevices = new ArrayList<DeviceDTO>();
 378
 379         for (AccountDTO account : localAccounts.accounts) {
 380             ContentResponse response = sendRequest(String.format(DEVICES_URL, account.id), HttpMethod.GET, null, null);
 381             DevicesDTO devices = parseResultAndUpdateStatus(response, gsonLowerCase, DevicesDTO.class);
 382             currentDevices.addAll(devices.items);
 383             devices.items.forEach(device -> {
 384                 ThingTypeUID thingTypeUID = new ThingTypeUID(BINDING_ID, device.deviceFamily);
 385                 if (SUPPORTED_DISCOVERY_THING_TYPES_UIDS.contains(thingTypeUID)) {
 386                     for (Thing thing : getThing().getThings()) {
 387                         ThingHandler handler = thing.getHandler();
 388                         if (handler != null && ((MyQDeviceHandler) handler).getSerialNumber()
 389                                 .equalsIgnoreCase(device.serialNumber)) {
 390                             ((MyQDeviceHandler) handler).handleDeviceUpdate(device);
 391                         }
 392                     }
 393                 }
 394             });
 395         }
 396         devicesCache = currentDevices;
 397     }
 398
 399     private synchronized ContentResponse sendRequest(String url, HttpMethod method, @Nullable ContentProvider content,
 400             @Nullable String contentType)
 401             throws InterruptedException, MyQCommunicationException, MyQAuthenticationException {
 402         AccessTokenResponse tokenResponse = null;
 403         // if we don't need to force a login, attempt to use the token we have
 404         if (!needsLogin) {
 405             try {
 406                 tokenResponse = getOAuthService().getAccessTokenResponse();
 407             } catch (OAuthException | IOException | OAuthResponseException e) {
 408                 // ignore error, will try to login below
 409                 logger.debug("Error accessing token, will attempt to login again", e);
 410             }
 411         }
 412
 413         // if no token, or we need to login, do so now
 414         if (tokenResponse == null) {
 415             tokenResponse = login();
 416             needsLogin = false;
 417         }
 418
 419         Request request = httpClient.newRequest(url).method(method).agent(userAgent).timeout(10, TimeUnit.SECONDS)
 420                 .header("Authorization", authTokenHeader(tokenResponse));
 421         if (content != null & contentType != null) {
 422             request = request.content(content, contentType);
 423         }
 424
 425         // use asyc jetty as the API service will response with a 401 error when credentials are wrong,
 426         // but not a WWW-Authenticate header which causes Jetty to throw a generic execution exception which
 427         // prevents us from knowing the response code
 428         logger.trace("Sending {} to {}", request.getMethod(), request.getURI());
 429         final CompletableFuture<ContentResponse> futureResult = new CompletableFuture<>();
 430         request.send(new BufferingResponseListener() {
 431             @NonNullByDefault({})
 432             @Override
 433             public void onComplete(Result result) {
 434                 Response response = result.getResponse();
 435                 futureResult.complete(new HttpContentResponse(response, getContent(), getMediaType(), getEncoding()));
 436             }
 437         });
 438
 439         try {
 440             ContentResponse result = futureResult.get();
 441             logger.trace("Account Response - status: {} content: {}", result.getStatus(), result.getContentAsString());
 442             return result;
 443         } catch (ExecutionException e) {
 444             throw new MyQCommunicationException(e.getMessage());
 445         }
 446     }
 447
 448     private <T> T parseResultAndUpdateStatus(ContentResponse response, Gson parser, Class<T> classOfT)
 449             throws MyQCommunicationException {
 450         if (HttpStatus.isSuccess(response.getStatus())) {
 451             try {
 452                 T responseObject = parser.fromJson(response.getContentAsString(), classOfT);
 453                 if (responseObject != null) {
 454                     if (getThing().getStatus() != ThingStatus.ONLINE) {
 455                         updateStatus(ThingStatus.ONLINE);
 456                     }
 457                     return responseObject;
 458                 } else {
 459                     throw new MyQCommunicationException("Bad response from server");
 460                 }
 461             } catch (JsonSyntaxException e) {
 462                 throw new MyQCommunicationException("Invalid JSON Response " + response.getContentAsString());
 463             }
 464         } else if (response.getStatus() == HttpStatus.UNAUTHORIZED_401) {
 465             // our tokens no longer work, will need to login again
 466             needsLogin = true;
 467             throw new MyQCommunicationException("Token was rejected for request");
 468         } else {
 469             throw new MyQCommunicationException(
 470                     "Invalid Response Code " + response.getStatus() + " : " + response.getContentAsString());
 471         }
 472     }
 473
 474     /**
 475      * Returns the MyQ login page which contains form elements and cookies needed to login
 476      *
 477      * @param codeVerifier
 478      * @return
 479      * @throws InterruptedException
 480      * @throws ExecutionException
 481      * @throws TimeoutException
 482      */
 483     private ContentResponse getLoginPage(String codeVerifier)
 484             throws InterruptedException, ExecutionException, TimeoutException {
 485         try {
 486             Request request = httpClient.newRequest(LOGIN_AUTHORIZE_URL) //
 487                     .param("client_id", CLIENT_ID) //
 488                     .param("code_challenge", generateCodeChallange(codeVerifier)) //
 489                     .param("code_challenge_method", "S256") //
 490                     .param("redirect_uri", REDIRECT_URI) //
 491                     .param("response_type", "code") //
 492                     .param("scope", SCOPE) //
 493                     .agent(userAgent).followRedirects(true);
 494             request.header("Accept", "\"*/*\"");
 495             request.header("Authorization",
 496                     "Basic " + Base64.getEncoder().encodeToString((CLIENT_ID + ":").getBytes()));
 497             logger.debug("Sending {} to {}", request.getMethod(), request.getURI());
 498             ContentResponse response = request.send();
 499             logger.debug("Login Code {} Response {}", response.getStatus(), response.getContentAsString());
 500             return response;
 501         } catch (NoSuchAlgorithmException e) {
 502             throw new ExecutionException(e.getCause());
 503         }
 504     }
 505
 506     /**
 507      * Sends configured credentials and elements from the login page in order to obtain a redirect location header value
 508      *
 509      * @param url
 510      * @param requestToken
 511      * @param returnURL
 512      * @return The location header value
 513      * @throws InterruptedException
 514      * @throws ExecutionException
 515      * @throws TimeoutException
 516      */
 517     @Nullable
 518     private String postLogin(String url, String requestToken, String returnURL)
 519             throws InterruptedException, ExecutionException, TimeoutException {
 520         /*
 521          * on a successful post to this page we will get several redirects, and a final 301 to:
 522          * com.myqops://ios?code=0123456789&scope=MyQ_Residential%20offline_access&iss=https%3A%2F%2Fpartner-identity.
 523          * myq-cloud.com
 524          *
 525          * We can then take the parameters out of this location and continue the process
 526          */
 527         Fields fields = new Fields();
 528         fields.add("Email", username);
 529         fields.add("Password", password);
 530         fields.add("__RequestVerificationToken", requestToken);
 531         fields.add("ReturnUrl", returnURL);
 532
 533         Request request = httpClient.newRequest(url).method(HttpMethod.POST) //
 534                 .content(new FormContentProvider(fields)) //
 535                 .agent(userAgent) //
 536                 .followRedirects(false);
 537         setCookies(request);
 538
 539         logger.debug("Posting Login to {}", url);
 540         ContentResponse response = request.send();
 541
 542         String location = null;
 543
 544         // follow redirects until we match our REDIRECT_URI or hit a redirect safety limit
 545         for (int i = 0; i < LOGIN_MAX_REDIRECTS && HttpStatus.isRedirection(response.getStatus()); i++) {
 546
 547             String loc = response.getHeaders().get("location");
 548             if (logger.isTraceEnabled()) {
 549                 logger.trace("Redirect Login: Code {} Location Header: {} Response {}", response.getStatus(), loc,
 550                         response.getContentAsString());
 551             }
 552             if (loc == null) {
 553                 logger.debug("No location value");
 554                 break;
 555             }
 556             if (loc.indexOf(REDIRECT_URI) == 0) {
 557                 location = loc;
 558                 break;
 559             }
 560             request = httpClient.newRequest(LOGIN_BASE_URL + loc).agent(userAgent).followRedirects(false);
 561             setCookies(request);
 562             response = request.send();
 563         }
 564         return location;
 565     }
 566
 567     /**
 568      * Final step of the login process to get an oAuth access response token
 569      *
 570      * @param redirectLocation
 571      * @param codeVerifier
 572      * @return
 573      * @throws InterruptedException
 574      * @throws ExecutionException
 575      * @throws TimeoutException
 576      */
 577     private ContentResponse getLoginToken(String redirectLocation, String codeVerifier)
 578             throws InterruptedException, ExecutionException, TimeoutException {
 579         try {
 580             Map<String, String> params = parseLocationQuery(redirectLocation);
 581
 582             Fields fields = new Fields();
 583             fields.add("client_id", CLIENT_ID);
 584             fields.add("client_secret", Base64.getEncoder().encodeToString(CLIENT_SECRET.getBytes()));
 585             fields.add("code", params.get("code"));
 586             fields.add("code_verifier", codeVerifier);
 587             fields.add("grant_type", "authorization_code");
 588             fields.add("redirect_uri", REDIRECT_URI);
 589             fields.add("scope", params.get("scope"));
 590
 591             Request request = httpClient.newRequest(LOGIN_TOKEN_URL) //
 592                     .content(new FormContentProvider(fields)) //
 593                     .method(HttpMethod.POST) //
 594                     .agent(userAgent).followRedirects(true);
 595             setCookies(request);
 596
 597             ContentResponse response = request.send();
 598             if (logger.isTraceEnabled()) {
 599                 logger.trace("Login Code {} Response {}", response.getStatus(), response.getContentAsString());
 600             }
 601             return response;
 602         } catch (URISyntaxException e) {
 603             throw new ExecutionException(e.getCause());
 604         }
 605     }
 606
 607     private OAuthClientService getOAuthService() {
 608         OAuthClientService oAuthService = this.oAuthService;
 609         if (oAuthService == null || oAuthService.isClosed()) {
 610             oAuthService = oAuthFactory.createOAuthClientService(getThing().toString(), LOGIN_TOKEN_URL,
 611                     LOGIN_AUTHORIZE_URL, CLIENT_ID, CLIENT_SECRET, SCOPE, false);
 612             oAuthService.addAccessTokenRefreshListener(this);
 613             this.oAuthService = oAuthService;
 614         }
 615         return oAuthService;
 616     }
 617
 618     private static String randomString(int length) {
 619         int low = 97; // a-z
 620         int high = 122; // A-Z
 621         StringBuilder sb = new StringBuilder(length);
 622         Random random = new Random();
 623         for (int i = 0; i < length; i++) {
 624             sb.append((char) (low + (int) (random.nextFloat() * (high - low + 1))));
 625         }
 626         return sb.toString();
 627     }
 628
 629     private String generateCodeVerifier() {
 630         SecureRandom secureRandom = new SecureRandom();
 631         byte[] codeVerifier = new byte[32];
 632         secureRandom.nextBytes(codeVerifier);
 633         return Base64.getUrlEncoder().withoutPadding().encodeToString(codeVerifier);
 634     }
 635
 636     private String generateCodeChallange(String codeVerifier) throws NoSuchAlgorithmException {
 637         byte[] bytes = codeVerifier.getBytes(StandardCharsets.US_ASCII);
 638         MessageDigest messageDigest = MessageDigest.getInstance("SHA-256");
 639         messageDigest.update(bytes, 0, bytes.length);
 640         byte[] digest = messageDigest.digest();
 641         return Base64.getUrlEncoder().withoutPadding().encodeToString(digest);
 642     }
 643
 644     private Map<String, String> parseLocationQuery(String location) throws URISyntaxException {
 645         URI uri = new URI(location);
 646         return Arrays.stream(uri.getQuery().split("&")).map(str -> str.split("="))
 647                 .collect(Collectors.toMap(str -> str[0], str -> str[1]));
 648     }
 649
 650     private void setCookies(Request request) {
 651         for (HttpCookie c : httpClient.getCookieStore().getCookies()) {
 652             request.cookie(c);
 653         }
 654     }
 655
 656     private String authTokenHeader(AccessTokenResponse tokenResponse) {
 657         return tokenResponse.getTokenType() + " " + tokenResponse.getAccessToken();
 658     }
 659
 660     /**
 661      * Exception for authenticated related errors
 662      */
 663     class MyQAuthenticationException extends Exception {
 664         private static final long serialVersionUID = 1L;
 665
 666         public MyQAuthenticationException(String message) {
 667             super(message);
 668         }
 669     }
 670
 671     /**
 672      * Generic exception for non authentication related errors when communicating with the MyQ service.
 673      */
 674     class MyQCommunicationException extends IOException {
 675         private static final long serialVersionUID = 1L;
 676
 677         public MyQCommunicationException(@Nullable String message) {
 678             super(message);
 679         }
 680     }
 681 }