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

   1 /**
   2  * Copyright (c) 2010-2022 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.miio.internal.cloud;
  14
  15 import java.io.IOException;
  16 import java.net.CookieStore;
  17 import java.net.HttpCookie;
  18 import java.net.MalformedURLException;
  19 import java.net.URI;
  20 import java.net.URL;
  21 import java.time.ZonedDateTime;
  22 import java.time.format.DateTimeFormatter;
  23 import java.util.ArrayList;
  24 import java.util.Date;
  25 import java.util.HashMap;
  26 import java.util.List;
  27 import java.util.Locale;
  28 import java.util.Map;
  29 import java.util.Random;
  30 import java.util.TimeZone;
  31 import java.util.concurrent.ExecutionException;
  32 import java.util.concurrent.TimeUnit;
  33 import java.util.concurrent.TimeoutException;
  34
  35 import org.eclipse.jdt.annotation.NonNullByDefault;
  36 import org.eclipse.jetty.client.HttpClient;
  37 import org.eclipse.jetty.client.HttpResponseException;
  38 import org.eclipse.jetty.client.api.ContentResponse;
  39 import org.eclipse.jetty.client.api.Request;
  40 import org.eclipse.jetty.client.util.FormContentProvider;
  41 import org.eclipse.jetty.http.HttpHeader;
  42 import org.eclipse.jetty.http.HttpMethod;
  43 import org.eclipse.jetty.http.HttpStatus;
  44 import org.eclipse.jetty.util.Fields;
  45 import org.openhab.binding.miio.internal.MiIoCrypto;
  46 import org.openhab.binding.miio.internal.MiIoCryptoException;
  47 import org.openhab.binding.miio.internal.Utils;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 import com.google.gson.Gson;
  52 import com.google.gson.GsonBuilder;
  53 import com.google.gson.JsonElement;
  54 import com.google.gson.JsonObject;
  55 import com.google.gson.JsonParseException;
  56 import com.google.gson.JsonParser;
  57 import com.google.gson.JsonSyntaxException;
  58
  59 /**
  60  * The {@link MiCloudConnector} class is used for connecting to the Xiaomi cloud access
  61  *
  62  * @author Marcel Verpaalen - Initial contribution
  63  */
  64 @NonNullByDefault
  65 public class MiCloudConnector {
  66
  67     private static final int REQUEST_TIMEOUT_SECONDS = 10;
  68     private static final String UNEXPECTED = "Unexpected :";
  69     private static final String AGENT_ID = (new Random().ints(65, 70).limit(13)
  70             .collect(StringBuilder::new, StringBuilder::appendCodePoint, StringBuilder::append).toString());
  71     private static final String USERAGENT = "Android-7.1.1-1.0.0-ONEPLUS A3010-136-" + AGENT_ID
  72             + " APP/xiaomi.smarthome APPV/62830";
  73     private static Locale locale = Locale.getDefault();
  74     private static final TimeZone TZ = TimeZone.getDefault();
  75     private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern("OOOO");
  76     private static final Gson GSON = new GsonBuilder().serializeNulls().create();
  77
  78     private final String clientId;
  79
  80     private String username;
  81     private String password;
  82     private String userId = "";
  83     private String serviceToken = "";
  84     private String ssecurity = "";
  85     private int loginFailedCounter = 0;
  86     private HttpClient httpClient;
  87
  88     private final Logger logger = LoggerFactory.getLogger(MiCloudConnector.class);
  89
  90     public MiCloudConnector(String username, String password, HttpClient httpClient) throws MiCloudException {
  91         this.username = username;
  92         this.password = password;
  93         this.httpClient = httpClient;
  94         if (!checkCredentials()) {
  95             throw new MiCloudException("username or password can't be empty");
  96         }
  97         clientId = (new Random().ints(97, 122 + 1).limit(6)
  98                 .collect(StringBuilder::new, StringBuilder::appendCodePoint, StringBuilder::append).toString());
  99     }
 100
 101     void startClient() throws MiCloudException {
 102         if (!httpClient.isStarted()) {
 103             try {
 104                 httpClient.start();
 105                 CookieStore cookieStore = httpClient.getCookieStore();
 106                 // set default cookies
 107                 addCookie(cookieStore, "sdkVersion", "accountsdk-18.8.15", "mi.com");
 108                 addCookie(cookieStore, "sdkVersion", "accountsdk-18.8.15", "xiaomi.com");
 109                 addCookie(cookieStore, "deviceId", this.clientId, "mi.com");
 110                 addCookie(cookieStore, "deviceId", this.clientId, "xiaomi.com");
 111             } catch (Exception e) {
 112                 throw new MiCloudException("No http client cannot be started: " + e.getMessage(), e);
 113             }
 114         }
 115     }
 116
 117     public void stopClient() {
 118         try {
 119             this.httpClient.stop();
 120         } catch (Exception e) {
 121             logger.debug("Error stopping httpclient :{}", e.getMessage(), e);
 122         }
 123     }
 124
 125     private boolean checkCredentials() {
 126         if (username.trim().isEmpty() || password.trim().isEmpty()) {
 127             logger.info("Xiaomi Cloud: username or password missing.");
 128             return false;
 129         }
 130         return true;
 131     }
 132
 133     private String getApiUrl(String country) {
 134         return "https://" + (country.trim().equalsIgnoreCase("cn") ? "" : country.trim().toLowerCase() + ".")
 135                 + "api.io.mi.com/app";
 136     }
 137
 138     public String getClientId() {
 139         return clientId;
 140     }
 141
 142     String parseJson(String data) {
 143         if (data.contains("&&&START&&&")) {
 144             return data.replace("&&&START&&&", "");
 145         } else {
 146             return UNEXPECTED.concat(data);
 147         }
 148     }
 149
 150     public String getMapUrl(String vacuumMap, String country) throws MiCloudException {
 151         String url = getApiUrl(country) + "/home/getmapfileurl";
 152         Map<String, String> map = new HashMap<String, String>();
 153         map.put("data", "{\"obj_name\":\"" + vacuumMap + "\"}");
 154         String mapResponse = request(url, map);
 155         logger.trace("response: {}", mapResponse);
 156         String errorMsg = "";
 157         try {
 158             JsonElement response = JsonParser.parseString(mapResponse);
 159             if (response.isJsonObject()) {
 160                 logger.debug("Received  JSON message {}", response);
 161                 if (response.getAsJsonObject().has("result")
 162                         && response.getAsJsonObject().get("result").isJsonObject()) {
 163                     JsonObject jo = response.getAsJsonObject().get("result").getAsJsonObject();
 164                     if (jo.has("url")) {
 165                         return jo.get("url").getAsString();
 166                     } else {
 167                         errorMsg = "Could not get url";
 168                     }
 169                 } else {
 170                     errorMsg = "Could not get result";
 171                 }
 172             } else {
 173                 errorMsg = "Received message is invalid JSON";
 174             }
 175         } catch (ClassCastException | IllegalStateException e) {
 176             errorMsg = "Received message could not be parsed";
 177         }
 178         logger.debug("{}: {}", errorMsg, mapResponse);
 179         return "";
 180     }
 181
 182     public String getDeviceStatus(String device, String country) throws MiCloudException {
 183         final String response = request("/home/device_list", country, "{\"dids\":[\"" + device + "\"]}");
 184         logger.debug("response: {}", response);
 185         return response;
 186     }
 187
 188     public String sendRPCCommand(String device, String country, String command) throws MiCloudException {
 189         if (device.length() != 8) {
 190             logger.debug("Device ID ('{}') incorrect or missing. Command not send: {}", device, command);
 191         }
 192         if (country.length() > 3 || country.length() < 2) {
 193             logger.debug("Country ('{}') incorrect or missing. Command not send: {}", device, command);
 194         }
 195         String id = "";
 196         try {
 197             id = String.valueOf(Long.parseUnsignedLong(device, 16));
 198         } catch (NumberFormatException e) {
 199             String err = "Could not parse device ID ('" + device.toString() + "')";
 200             logger.debug("{}", err);
 201             throw new MiCloudException(err, e);
 202         }
 203         final String response = request("/home/rpc/" + id, country, command);
 204         logger.debug("response: {}", response);
 205         return response;
 206     }
 207
 208     public List<CloudDeviceDTO> getDevices(String country) {
 209         final String response = getDeviceString(country);
 210         List<CloudDeviceDTO> devicesList = new ArrayList<>();
 211         try {
 212             final JsonElement resp = JsonParser.parseString(response);
 213             if (resp.isJsonObject()) {
 214                 final JsonObject jor = resp.getAsJsonObject();
 215                 if (jor.has("result")) {
 216                     CloudDeviceListDTO cdl = GSON.fromJson(jor.get("result"), CloudDeviceListDTO.class);
 217                     if (cdl != null) {
 218                         devicesList.addAll(cdl.getCloudDevices());
 219                         for (CloudDeviceDTO device : devicesList) {
 220                             device.setServer(country);
 221                             logger.debug("Xiaomi cloud info: {}", device);
 222                         }
 223                     }
 224                 } else {
 225                     logger.debug("Response missing result: '{}'", response);
 226                 }
 227             } else {
 228                 logger.debug("Response is not a json object: '{}'", response);
 229             }
 230         } catch (JsonSyntaxException | IllegalStateException | ClassCastException e) {
 231             loginFailedCounter++;
 232             logger.info("Error while parsing devices: {}", e.getMessage());
 233         }
 234         return devicesList;
 235     }
 236
 237     public String getDeviceString(String country) {
 238         String resp;
 239         try {
 240             resp = request("/home/device_list_page", country, "{\"getVirtualModel\":true,\"getHuamiDevices\":1}");
 241             logger.trace("Get devices response: {}", resp);
 242             if (resp.length() > 2) {
 243                 CloudUtil.saveDeviceInfoFile(resp, country, logger);
 244                 return resp;
 245             }
 246         } catch (MiCloudException e) {
 247             logger.info("{}", e.getMessage());
 248             loginFailedCounter++;
 249         }
 250         return "";
 251     }
 252
 253     public String request(String urlPart, String country, String params) throws MiCloudException {
 254         Map<String, String> map = new HashMap<String, String>();
 255         map.put("data", params);
 256         return request(urlPart, country, map);
 257     }
 258
 259     public String request(String urlPart, String country, Map<String, String> params) throws MiCloudException {
 260         String url = urlPart.trim();
 261         url = getApiUrl(country) + (url.startsWith("/app") ? url.substring(4) : url);
 262         String response = request(url, params);
 263         logger.debug("Request to '{}' server '{}'. Response: '{}'", country, urlPart, response);
 264         return response;
 265     }
 266
 267     public String request(String url, Map<String, String> params) throws MiCloudException {
 268         if (this.serviceToken.isEmpty() || this.userId.isEmpty()) {
 269             throw new MiCloudException("Cannot execute request. service token or userId missing");
 270         }
 271         loginFailedCounterCheck();
 272         startClient();
 273         logger.debug("Send request to {} with data '{}'", url, params.get("data"));
 274         Request request = httpClient.newRequest(url).timeout(REQUEST_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 275         request.agent(USERAGENT);
 276         request.header("x-xiaomi-protocal-flag-cli", "PROTOCAL-HTTP2");
 277         request.header(HttpHeader.CONTENT_TYPE, "application/x-www-form-urlencoded");
 278         request.cookie(new HttpCookie("userId", this.userId));
 279         request.cookie(new HttpCookie("yetAnotherServiceToken", this.serviceToken));
 280         request.cookie(new HttpCookie("serviceToken", this.serviceToken));
 281         request.cookie(new HttpCookie("locale", locale.toString()));
 282         request.cookie(new HttpCookie("timezone", ZonedDateTime.now().format(FORMATTER)));
 283         request.cookie(new HttpCookie("is_daylight", TZ.inDaylightTime(new Date()) ? "1" : "0"));
 284         request.cookie(new HttpCookie("dst_offset", Integer.toString(TZ.getDSTSavings())));
 285         request.cookie(new HttpCookie("channel", "MI_APP_STORE"));
 286
 287         if (logger.isTraceEnabled()) {
 288             for (HttpCookie cookie : request.getCookies()) {
 289                 logger.trace("Cookie set for request ({}) : {} --> {}     (path: {})", cookie.getDomain(),
 290                         cookie.getName(), cookie.getValue(), cookie.getPath());
 291             }
 292         }
 293         String method = "POST";
 294         request.method(method);
 295
 296         try {
 297             String nonce = CloudUtil.generateNonce(System.currentTimeMillis());
 298             String signedNonce = CloudUtil.signedNonce(ssecurity, nonce);
 299             String signature = CloudUtil.generateSignature(url.replace("/app", ""), signedNonce, nonce, params);
 300
 301             Fields fields = new Fields();
 302             fields.put("signature", signature);
 303             fields.put("_nonce", nonce);
 304             fields.put("data", params.get("data"));
 305             request.content(new FormContentProvider(fields));
 306
 307             logger.trace("fieldcontent: {}", fields.toString());
 308             final ContentResponse response = request.send();
 309             if (response.getStatus() >= HttpStatus.BAD_REQUEST_400
 310                     && response.getStatus() < HttpStatus.INTERNAL_SERVER_ERROR_500) {
 311                 this.serviceToken = "";
 312             }
 313             return response.getContentAsString();
 314         } catch (HttpResponseException e) {
 315             serviceToken = "";
 316             logger.debug("Error while executing request to {} :{}", url, e.getMessage());
 317             loginFailedCounter++;
 318         } catch (InterruptedException | TimeoutException | ExecutionException | IOException e) {
 319             logger.debug("Error while executing request to {} :{}", url, e.getMessage());
 320             loginFailedCounter++;
 321         } catch (MiIoCryptoException e) {
 322             logger.debug("Error while decrypting response of request to {} :{}", url, e.getMessage(), e);
 323             loginFailedCounter++;
 324         }
 325         return "";
 326     }
 327
 328     private void addCookie(CookieStore cookieStore, String name, String value, String domain) {
 329         HttpCookie cookie = new HttpCookie(name, value);
 330         cookie.setDomain("." + domain);
 331         cookie.setPath("/");
 332         cookieStore.add(URI.create("https://" + domain), cookie);
 333     }
 334
 335     public synchronized boolean login() {
 336         if (!checkCredentials()) {
 337             return false;
 338         }
 339         if (!userId.isEmpty() && !serviceToken.isEmpty()) {
 340             return true;
 341         }
 342         logger.debug("Xiaomi cloud login with userid {}", username);
 343         try {
 344             if (loginRequest()) {
 345                 loginFailedCounter = 0;
 346             } else {
 347                 loginFailedCounter++;
 348                 logger.debug("Xiaomi cloud login attempt {}", loginFailedCounter);
 349             }
 350         } catch (MiCloudException e) {
 351             logger.info("Error logging on to Xiaomi cloud ({}): {}", loginFailedCounter, e.getMessage());
 352             loginFailedCounter++;
 353             serviceToken = "";
 354             loginFailedCounterCheck();
 355             return false;
 356         }
 357         return true;
 358     }
 359
 360     void loginFailedCounterCheck() {
 361         if (loginFailedCounter > 10) {
 362             logger.info("Repeated errors logging on to Xiaomi cloud. Cleaning stored cookies");
 363             dumpCookies(".xiaomi.com", true);
 364             dumpCookies(".mi.com", true);
 365             serviceToken = "";
 366             loginFailedCounter = 0;
 367         }
 368     }
 369
 370     protected boolean loginRequest() throws MiCloudException {
 371         try {
 372             startClient();
 373             String sign = loginStep1();
 374             String location;
 375             if (!sign.startsWith("http")) {
 376                 location = loginStep2(sign);
 377             } else {
 378                 location = sign; // seems we already have login location
 379             }
 380             final ContentResponse responseStep3 = loginStep3(location);
 381             switch (responseStep3.getStatus()) {
 382                 case HttpStatus.FORBIDDEN_403:
 383                     throw new MiCloudException("Access denied. Did you set the correct api-key and/or username?");
 384                 case HttpStatus.OK_200:
 385                     return true;
 386                 default:
 387                     logger.trace("request returned status '{}', reason: {}, content = {}", responseStep3.getStatus(),
 388                             responseStep3.getReason(), responseStep3.getContentAsString());
 389                     throw new MiCloudException(responseStep3.getStatus() + responseStep3.getReason());
 390             }
 391         } catch (InterruptedException | TimeoutException | ExecutionException e) {
 392             throw new MiCloudException("Cannot logon to Xiaomi cloud: " + e.getMessage(), e);
 393         } catch (MiIoCryptoException e) {
 394             throw new MiCloudException("Error decrypting. Cannot logon to Xiaomi cloud: " + e.getMessage(), e);
 395         } catch (MalformedURLException | JsonParseException e) {
 396             throw new MiCloudException("Error getting logon URL. Cannot logon to Xiaomi cloud: " + e.getMessage(), e);
 397         }
 398     }
 399
 400     private String loginStep1() throws InterruptedException, TimeoutException, ExecutionException, MiCloudException {
 401         final ContentResponse responseStep1;
 402
 403         logger.trace("Xiaomi Login step 1");
 404         String url = "https://account.xiaomi.com/pass/serviceLogin?sid=xiaomiio&_json=true";
 405         Request request = httpClient.newRequest(url).timeout(REQUEST_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 406         request.agent(USERAGENT);
 407         request.header(HttpHeader.CONTENT_TYPE, "application/x-www-form-urlencoded");
 408         request.cookie(new HttpCookie("userId", this.userId.length() > 0 ? this.userId : this.username));
 409
 410         responseStep1 = request.send();
 411         final String content = responseStep1.getContentAsString();
 412         logger.trace("Xiaomi Login step 1 content response= {}", content);
 413         logger.trace("Xiaomi Login step 1 response = {}", responseStep1);
 414         try {
 415             JsonElement resp = JsonParser.parseString(parseJson(content));
 416             if (resp.isJsonObject() && resp.getAsJsonObject().has("_sign")) {
 417                 String sign = resp.getAsJsonObject().get("_sign").getAsString();
 418                 logger.trace("Xiaomi Login step 1 sign = {}", sign);
 419                 return sign;
 420             } else {
 421                 logger.debug("Xiaomi Login _sign missing. Maybe still has login cookie.");
 422                 return "";
 423             }
 424         } catch (JsonParseException | IllegalStateException | ClassCastException e) {
 425             throw new MiCloudException("Error getting logon sign. Cannot parse response: " + e.getMessage(), e);
 426         }
 427     }
 428
 429     private String loginStep2(String sign) throws MiIoCryptoException, InterruptedException, TimeoutException,
 430             ExecutionException, MiCloudException, JsonSyntaxException, JsonParseException {
 431         String passToken;
 432         String cUserId;
 433
 434         logger.trace("Xiaomi Login step 2");
 435         String url = "https://account.xiaomi.com/pass/serviceLoginAuth2";
 436         Request request = httpClient.newRequest(url).timeout(REQUEST_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 437         request.agent(USERAGENT);
 438         request.method(HttpMethod.POST);
 439         final ContentResponse responseStep2;
 440
 441         Fields fields = new Fields();
 442         fields.put("sid", "xiaomiio");
 443         fields.put("hash", Utils.getHex(MiIoCrypto.md5(password.getBytes())));
 444         fields.put("callback", "https://sts.api.io.mi.com/sts");
 445         fields.put("qs", "%3Fsid%3Dxiaomiio%26_json%3Dtrue");
 446         fields.put("user", username);
 447         if (!sign.isEmpty()) {
 448             fields.put("_sign", sign);
 449         }
 450         fields.put("_json", "true");
 451
 452         request.content(new FormContentProvider(fields));
 453         responseStep2 = request.send();
 454
 455         final String content2 = responseStep2.getContentAsString();
 456         logger.trace("Xiaomi login step 2 response = {}", responseStep2);
 457         logger.trace("Xiaomi login step 2 content = {}", content2);
 458
 459         JsonElement resp2 = JsonParser.parseString(parseJson(content2));
 460         CloudLoginDTO jsonResp = GSON.fromJson(resp2, CloudLoginDTO.class);
 461         if (jsonResp == null) {
 462             throw new MiCloudException("Error getting logon details from step 2: " + content2);
 463         }
 464         ssecurity = jsonResp.getSsecurity();
 465         userId = jsonResp.getUserId();
 466         cUserId = jsonResp.getcUserId();
 467         passToken = jsonResp.getPassToken();
 468         String location = jsonResp.getLocation();
 469         String code = jsonResp.getCode();
 470
 471         logger.trace("Xiaomi login ssecurity = {}", ssecurity);
 472         logger.trace("Xiaomi login userId = {}", userId);
 473         logger.trace("Xiaomi login cUserId = {}", cUserId);
 474         logger.trace("Xiaomi login passToken = {}", passToken);
 475         logger.trace("Xiaomi login location = {}", location);
 476         logger.trace("Xiaomi login code = {}", code);
 477         if (logger.isTraceEnabled()) {
 478             dumpCookies(url, false);
 479         }
 480         if (!location.isEmpty()) {
 481             return location;
 482         } else {
 483             throw new MiCloudException("Error getting logon location URL. Return code: " + code);
 484         }
 485     }
 486
 487     private ContentResponse loginStep3(String location)
 488             throws MalformedURLException, InterruptedException, TimeoutException, ExecutionException {
 489         final ContentResponse responseStep3;
 490         Request request;
 491         logger.trace("Xiaomi Login step 3 @ {}", (new URL(location)).getHost());
 492         request = httpClient.newRequest(location).timeout(REQUEST_TIMEOUT_SECONDS, TimeUnit.SECONDS);
 493         request.agent(USERAGENT);
 494         request.header(HttpHeader.CONTENT_TYPE, "application/x-www-form-urlencoded");
 495         responseStep3 = request.send();
 496         logger.trace("Xiaomi login step 3 content = {}", responseStep3.getContentAsString());
 497         logger.trace("Xiaomi login step 3 response = {}", responseStep3);
 498         if (logger.isTraceEnabled()) {
 499             dumpCookies(location, false);
 500         }
 501         URI uri = URI.create("http://sts.api.io.mi.com");
 502         String serviceToken = extractServiceToken(uri);
 503         if (!serviceToken.isEmpty()) {
 504             this.serviceToken = serviceToken;
 505         }
 506         return responseStep3;
 507     }
 508
 509     private void dumpCookies(String url, boolean delete) {
 510         if (logger.isTraceEnabled()) {
 511             try {
 512                 URI uri = URI.create(url);
 513                 logger.trace("Cookie dump for {}", uri);
 514                 CookieStore cs = httpClient.getCookieStore();
 515                 if (cs != null) {
 516                     List<HttpCookie> cookies = cs.get(uri);
 517                     for (HttpCookie cookie : cookies) {
 518                         logger.trace("Cookie ({}) : {} --> {}     (path: {}. Removed: {})", cookie.getDomain(),
 519                                 cookie.getName(), cookie.getValue(), cookie.getPath(), delete);
 520                         if (delete) {
 521                             cs.remove(uri, cookie);
 522                         }
 523                     }
 524                 } else {
 525                     logger.trace("Could not create cookiestore from {}", url);
 526                 }
 527             } catch (IllegalArgumentException e) {
 528                 logger.trace("Error dumping cookies from {}: {}", url, e.getMessage(), e);
 529             }
 530         }
 531     }
 532
 533     private String extractServiceToken(URI uri) {
 534         String serviceToken = "";
 535         List<HttpCookie> cookies = httpClient.getCookieStore().get(uri);
 536         for (HttpCookie cookie : cookies) {
 537             logger.trace("Cookie :{} --> {}", cookie.getName(), cookie.getValue());
 538             if (cookie.getName().contentEquals("serviceToken")) {
 539                 serviceToken = cookie.getValue();
 540                 logger.debug("Xiaomi cloud logon succesfull.");
 541                 logger.trace("Xiaomi cloud servicetoken: {}", serviceToken);
 542             }
 543         }
 544         return serviceToken;
 545     }
 546
 547     public boolean hasLoginToken() {
 548         return !serviceToken.isEmpty();
 549     }
 550 }