2020年11月 – Sasapea's Lab

TP-LinkからHS105より低価格なTapo P105が発売されたのを知り、HS105同様に制御できるのかと試しに購入してみたが全く動かない。

Tapo系にはカメラもあるからセキュリティはより厳しくしてあるのかな？なーんて思っていたら最近になってリバースエンジニアリングしてプログラムを作ってしまった猛者が現れた。

どうやらTP-Linkの製品はリバースエンジニアリングされる運命にあるようだ。(笑)

Reverse engineering TP-Link TAPO
GitHub – fishbigger/TapoP100

試してみるとP105ではエラーで動作しなかったが、リクエストパラメタにP105のMACアドレスを設定したterminalUUIDパラメタを追加することで動作することが確認できた。ということで元のPythonのプログラムを参考にESP32に移殖しようと思ったのだが公開鍵暗号や共通鍵暗号などを使っていてそれをどう対応するかで暫し悩んでしまったが調べてみたらESP32に含まれているmbedtlsライブラリが使えそうだとわかる。その他、base64やcJSONなど実装に必要なライブラリは全てESP32に含まれていた。でも、JSONをC言語関数でゴリゴリ書く気にはならなかったのでより簡単に記述できそうなArduino_JSON(cJSONのC++ラッパーライブラリ)のみ別途インストールして使ってみた。バージョンが0.1.0で[BETA]版らしいが今のところ問題なく使えている。

しかし、久しぶりにハマりまくった。試験するとエラーレスポンスばかりで全く動かない。クッキーの内容が不正なことが原因だったがP105が返すエラーコードの意味がわからず、あーでもないこーでもないと手当たり次第に検証した結果、何日もかかってしまった。mbedtlsも公開鍵暗号(RSA)も共通鍵暗号(AES)も初めてだらけだったので単純なところよりも知らないほうにばかり目が行ってしまったのが敗因かもしれない。

あとP105の処理能力が低くて反応が鈍い？ためなのか連続制御すると時々HTTPエラーが発生してしまう。リトライ処理を追加し解決できたようだ。

ちなみにTapoアプリでデバイス登録した状態でないと動作しないことに注意しよう。

【概要】

void begin(const char *hostname, const char *username, const char *password)

1	void begin(const char hostname, const char username, const char *password)

hostnameにIPアドレス、usernameとpasswordにTapoアプリに登録したメールアドレスとパスワードを指定する。

void end(void)

1	void end(void)

空実装。

int httpStatus(void)

1	int httpStatus(void)

HTTPエラーコードを取得する。

int tapoStatus(void)

1	int tapoStatus(void)

TAPOデバイスのエラーコードを取得する。

int mbedStatus(void)

1	int mbedStatus(void)

mbedtls-apiのエラーコードを取得する。

String decode(String str)

1	String decode(String str)

base64エンコードされている文字列をデコードする。デバイス情報のnicknameとssidをデコードするさいに使う。

bool getEnergyUsage(String &info)

1	bool getEnergyUsage(String &info)

info引数に電力モニター情報をJSON文字列形式で格納する。戻り値は処理結果。trueは成功、falseは失敗。

bool getDeviceInfo(String &info)

1	bool getDeviceInfo(String &info)

info引数にデバイス情報をJSON文字列形式で格納する。戻り値は処理結果。trueは成功、falseは失敗。

bool setDeviceOn(bool on)

1	bool setDeviceOn(bool on)

デバイスをオン／オフ制御する。戻り値は処理結果。trueは成功、falseは失敗。

【対応ファームウェア】
P110M: 1.1.0 Build 231009 Rel.155719 以前
P105: 1.4.1 Build 20231103 Rel. 36519 以前

【修正】
2024-01-08
上記ファームウェア(Build 231009)以降に対応したものは下記を見るべし。
TP-LINK Tapo P110M のKlapプロトコル対応版 (ESP32)

2023-12-12
P110Mの最新ファームウェア(Build 231009)以降では通信プロトコルが変更されため1003エラーが発生します。動作中のP110Mをお持ちの方はTAPOアプリの自動更新をオフに設定することを推奨します。

2023-09-16
間違ってlinux/windows用のコードを掲載してしまっていたので正しいコードに変更。<(_ _)>

2023-09-15
いつからかはわからないがP105が動作しなくなっていたので修正。ついでにP110Mの電力モニター機能(getEnrgyUsage)に対応。

【サンプル・スケッチ】

#include "tapo.h"

TAPO tapo;

void setup()
{
  Serial.begin(115200);

  WiFi.begin("SSID", "PASSWPRD");
  while (WiFi.status() != WL_CONNECTED)
    delay(100);

  tapo.begin("ipaddress", "tapo-mailaddress", "tapo-password");
}

void loop()
{
  String info;

  /* Display Energy Usage */
  tapo.getEnergyUsage(info);
  Serial.println(info);

  /* Display Device Information */
  tapo.getDeviceInfo(info);
  Serial.println(info);

  /* Turn ON */
  tapo.setDeviceOn(true);

  /* Turn OFF */
  tapo.setDeviceOn(false);

  delay(5000);
}

#include "tapo.h"

TAPO tapo;

void setup()

{

Serial.begin(115200);

WiFi.begin("SSID", "PASSWPRD");

while (WiFi.status() != WL_CONNECTED)

delay(100);

tapo.begin("ipaddress", "tapo-mailaddress", "tapo-password");

}

void loop()

{

String info;

/* Display Energy Usage */

tapo.getEnergyUsage(info);

Serial.println(info);

/* Display Device Information */

tapo.getDeviceInfo(info);

Serial.println(info);

/* Turn ON */

tapo.setDeviceOn(true);

/* Turn OFF */

tapo.setDeviceOn(false);

delay(5000);

}

【ライブラリ】

/*
  tapo.h - TP-Link TAPO Control Library for P100/P105/P110

  Copyright (c) 2020-2023 Sasapea's Lab. All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/
#ifndef __TAPO_H
#define __TAPO_H

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>

// Included in ESP32.
#include "libb64/cencode.h"
#include "libb64/cdecode.h"
#include "mbedtls/entropy.h"
#include "mbedtls/ctr_drbg.h"
#include "mbedtls/cipher.h"
#include "mbedtls/pk.h"
#include "HTTPClient.h"

// Requires installation.
#include "Arduino_JSON.h"

typedef enum
{
  TAPO_ERROR_SUCCESS                       = 0,
  TAPO_ERROR_INCORRECT_REQUEST             = -1002,
  TAPO_ERROR_JSON_FORMATTING_ERROR         = -1003,
  TAPO_ERROR_INVALID_PUBLIC_KEY_LENGTH     = -1010, // invalid cookie
  TAPO_ERROR_INVALID_TERMINALUUID          = -1012,
  TAPO_ERROR_INVALID_REQUEST_OR_CREDENTIAL = -1501,
  TAPO_ERROR_DEVICE_BUSY                   =  9999,
} TAPO_ERROR;

#define TAPO_SESSION_TIMEOUT(t) ((t) * 60 * 1000)

#define TAPO_MD_LENGTH       20
#define TAPO_CIPHER_KEY_BITS 128
#define TAPO_RSA_KEY_BITS    1024
#define TAPO_RSA_EXPONENT    65537
#define TAPO_SEED_PERSONAL   "rsa_genkey"

#define TAPO_METHOD_HANDSHAKE         "handshake"
#define TAPO_METHOD_LOGIN_DEVICE      "login_device"
#define TAPO_METHOD_GET_DEVICE_INFO   "get_device_info"
#define TAPO_METHOD_SET_DEVICE_INFO   "set_device_info"
#define TAPO_METHOD_GET_ENERGY_USAGE  "get_energy_usage"
#define TAPO_METHOD_SECUREPASSTHROUGH "securePassthrough"

#define TAPO_DEBUG_PRINTF(format, ...)   debug_printf(__FILE__, __LINE__, format, __VA_ARGS__)
#define TAPO_DEBUG_MBEDTLS(name, status) mbedtls_status(__FILE__, __LINE__, name, status)

class TAPO
{
  private:

    String      _hostname;
    String      _username;
    String      _password;
    HTTPClient  _httpClient;
    int         _httpStatus;
    int         _tapoStatus;
    int         _mbedStatus;
    String      _tapoCookie;
    String      _tapoToken;
    String      _terminalUUID;
    uint32_t    _sessionTimeout;
    uint32_t    _sessionStart;
    String      _publicKey;
    String      _privateKey;
    uint8_t     _cipherKey[TAPO_CIPHER_KEY_BITS >> 3];
    uint8_t     _cipherIv [TAPO_CIPHER_KEY_BITS >> 3];
    uint8_t     _buffer[2048];

    void debug_printf(const char *file, int line, const char *format, ...)
    {
      char buf[256];
      Serial.printf("[%s:%d] ", file, line);
      va_list ap;
      va_start(ap, format);
      vsnprintf(buf, sizeof(buf), format, ap);
      va_end(ap);
      Serial.print(buf);
    }

    int mbedtls_status(const char *file, int line, const char *name, int status)
    {
      _mbedStatus = status;
      if (status)
        debug_printf(file, line, "%s = -0x%04X\n", name, abs(status));
      return status;
    }

    String toHEX(uint8_t *buf, uint16_t len)
    {
      const static char HEX_DIGITS[] = "0123456789abcdef";
      String hex;
      while (len-- > 0)
      {
        uint8_t b = *buf++;
        hex += HEX_DIGITS[b >> 4];
        hex += HEX_DIGITS[b & 0x0F];
      }
      return hex;
    }

    int b64encode(const uint8_t *bin, int len, uint8_t *b64)
    {
      return base64_encode_chars((char *)bin, len, (char *)b64);
    }

    int b64decode(const uint8_t *b64, int len, uint8_t *bin)
    {
      return base64_decode_chars((char *)b64, len, (char *)bin);
    }

    String removePemLF(const String &pem)
    {
      int    head = pem.indexOf('\n');
      int    tail = pem.lastIndexOf('\n', pem.length() - 2);
      String body = pem.substring(head + 1, tail);
      body.replace("\n", "");
      return pem.substring(0, head + 1) + body + pem.substring(tail + 1);
    }

    bool generateKeyPair(void)
    {
      bool rv = false;
      int olen;
      mbedtls_pk_context       pk;
      mbedtls_entropy_context  entropy;
      mbedtls_ctr_drbg_context ctr_drbg;
      _buffer[0] = 0;
      mbedtls_pk_init(&pk);
      mbedtls_entropy_init(&entropy);
      mbedtls_ctr_drbg_init(&ctr_drbg);
      if (TAPO_DEBUG_MBEDTLS("mbedtls_ctr_drbg_seed()", mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy, (uint8_t *)TAPO_SEED_PERSONAL, strlen(TAPO_SEED_PERSONAL)))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_setup()", mbedtls_pk_setup(&pk, mbedtls_pk_info_from_type(MBEDTLS_PK_RSA)))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_rsa_gen_key()", mbedtls_rsa_gen_key(mbedtls_pk_rsa(pk), mbedtls_ctr_drbg_random, &ctr_drbg, TAPO_RSA_KEY_BITS, TAPO_RSA_EXPONENT))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_write_pubkey_pem()", mbedtls_pk_write_pubkey_pem(&pk, _buffer, sizeof(_buffer)))) ;
      else if ((olen = strlen((char *)_buffer)) == 0) TAPO_DEBUG_PRINTF("invalid public key length = %d\n", olen);
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_write_key_pem()", mbedtls_pk_write_key_pem(&pk, _buffer + olen + 1, sizeof(_buffer) - olen - 1))) ;
      else
      {
        _publicKey  = removePemLF(String((char *)_buffer));
        _privateKey = (char *)_buffer + olen + 1;
        rv = true;
      }
      mbedtls_ctr_drbg_free(&ctr_drbg);
      mbedtls_entropy_free(&entropy);
      mbedtls_pk_free(&pk);
      return rv;
    }

    bool cipherKey(const char *key)
    {
      bool rv = false;
      mbedtls_pk_context       pk;
      mbedtls_entropy_context  entropy;
      mbedtls_ctr_drbg_context ctr_drbg;
      uint16_t ilen = strlen(key);
      size_t   olen = b64decode((uint8_t *)key, ilen, _buffer + ilen);
      mbedtls_pk_init(&pk);
      mbedtls_entropy_init(&entropy);
      mbedtls_ctr_drbg_init(&ctr_drbg);
      if (TAPO_DEBUG_MBEDTLS("mbedtls_ctr_drbg_seed()", mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy, (uint8_t *)TAPO_SEED_PERSONAL, strlen(TAPO_SEED_PERSONAL)))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_parse_key()", mbedtls_pk_parse_key(&pk, (uint8_t *)_privateKey.c_str(), _privateKey.length() + 1, NULL, 0))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_decrypt()", mbedtls_pk_decrypt(&pk, _buffer + ilen, olen, _buffer, &olen, ilen, mbedtls_ctr_drbg_random, &ctr_drbg))) ;
      else if (olen != sizeof(_cipherKey) + sizeof(_cipherIv)) TAPO_DEBUG_PRINTF("invalid cipher key length = %d\n", olen);
      else
      {
        memcpy(_cipherKey, _buffer, sizeof(_cipherKey));
        memcpy(_cipherIv, _buffer + sizeof(_cipherKey), sizeof(_cipherIv));
        rv = true;
      }
      mbedtls_ctr_drbg_free(&ctr_drbg);
      mbedtls_entropy_free(&entropy);
      mbedtls_pk_free(&pk);
      return rv;
    }

    String digest(const char *msg)
    {
      return TAPO_DEBUG_MBEDTLS("mbedtls_md(mbedtls_md_info_from_type()", mbedtls_md(mbedtls_md_info_from_type(MBEDTLS_MD_SHA1), (const uint8_t *)msg, strlen(msg), _buffer))
        ? String() : toHEX(_buffer, TAPO_MD_LENGTH);
    }

    size_t cipher0(mbedtls_operation_t operation, const uint8_t *input, size_t ilen, uint8_t *output)
    {
      size_t olen, olen2;
      mbedtls_cipher_context_t cipher;
      mbedtls_cipher_init(&cipher);
      if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_setup()", mbedtls_cipher_setup(&cipher, mbedtls_cipher_info_from_values(MBEDTLS_CIPHER_ID_AES, TAPO_CIPHER_KEY_BITS, MBEDTLS_MODE_CBC)))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_set_padding_mode()", mbedtls_cipher_set_padding_mode(&cipher, MBEDTLS_PADDING_PKCS7))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_set_iv()", mbedtls_cipher_set_iv(&cipher, _cipherIv, sizeof(_cipherIv)))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_setkey()", mbedtls_cipher_setkey(&cipher, _cipherKey, TAPO_CIPHER_KEY_BITS, operation))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_update()", mbedtls_cipher_update(&cipher, input, ilen, output, &olen))) ;
      else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_finish()", mbedtls_cipher_finish(&cipher, output + olen, &olen2))) olen = olen2 = 0;
      mbedtls_cipher_free(&cipher);
      return _mbedStatus ? 0 : olen + olen2;
    }

    String encrypt(const String &plain)
    {
      size_t ilen = plain.length();
      size_t olen = cipher0(MBEDTLS_ENCRYPT, (uint8_t *)plain.c_str(), ilen, _buffer + ilen);
      _buffer[b64encode(_buffer + ilen, olen, _buffer)] = 0;
      return String((char *)_buffer);
    }

    String decrypt(const String &cipher)
    {
      size_t ilen = cipher.length();
      size_t olen = b64decode((uint8_t *)cipher.c_str(), ilen, _buffer + ilen);
      _buffer[cipher0(MBEDTLS_DECRYPT, _buffer + ilen, olen, _buffer)] = 0;
      return String((char *)_buffer);
    }

    String request0(const String &payload)
    {
      _tapoStatus = 0;
      _httpStatus = 0;
      _mbedStatus = 0;
      String response;
      const char *url = (_tapoToken.length() ? "http://%s/app?token=%s" : "http://%s/app");
      snprintf((char *)_buffer, sizeof(_buffer), url, _hostname.c_str(), _tapoToken.c_str());
      if (_httpClient.begin((char *)_buffer))
      {
        const static char *headers[] = {"Set-Cookie"};
        _httpClient.collectHeaders(headers, sizeof(headers) / sizeof(headers[0]));
        if (_tapoCookie.length())
          _httpClient.addHeader("Cookie", _tapoCookie.c_str(), false, true);
        _httpClient.addHeader("Content-type", "application/json;charset=UTF-8", false, true);
        _httpStatus = _httpClient.POST(payload);
        if (_httpStatus == HTTP_CODE_OK)
        {
          String cookie = _httpClient.header("Set-Cookie");
          if (cookie.length())
          {
            _sessionStart = millis();
            // parse cookie
            int left  = 0;
            int right = -1;
            while (right + 1 < cookie.length())
            {
              left  = right + 1;
              right = cookie.indexOf(';', left);
              if (right < 0)
                right = cookie.length();
              int mid = cookie.indexOf('=', left);
              if (mid < 0)
                mid = right;
              String name  = cookie.substring(left, mid);
              String value = cookie.substring(mid + 1, right);
              name.toUpperCase();
              if (name == "TP_SESSIONID")
                _tapoCookie = cookie.substring(left, right);
              if (name == "TIMEOUT")
                _sessionTimeout = TAPO_SESSION_TIMEOUT(atoi(value.c_str()) - 1);
            }
          }
          response = _httpClient.getString();
        }
        _httpClient.end();
      }
      return response;
    }

    String request(const String &payload)
    {
      String response;
      int retry = 3;
      while (1)
      {
        response = request0(payload);
        if (_httpStatus == HTTP_CODE_OK)
          break;
        if (--retry == 0)
          break;
        delay(1000);
      }
      return response;
    }

    bool handshake(void)
    {
      JSONVar payload;
      payload["method"] = TAPO_METHOD_HANDSHAKE;
      payload["params"]["key"] = _publicKey;
      payload["requestTimeMils"] = millis();
      String response = request(JSONVar::stringify(payload));
      if (response.length())
      {
        JSONVar res = JSONVar::parse(response);
        _tapoStatus = res["error_code"];
        if (_tapoStatus == 0)
        {
          if (cipherKey(res["result"]["key"]) && _tapoCookie.length())
            return true;
        }
      }
      return false;
    }

    bool login(void)
    {
      JSONVar payload;
      payload["method"] = TAPO_METHOD_LOGIN_DEVICE;
      payload["params"]["username"] = _username;
      payload["params"]["password"] = _password;
      payload["requestTimeMils"] = millis();
      JSONVar envelope;
      envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;
      envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));
      String response = request(JSONVar::stringify(envelope));
      if (response.length())
      {
        JSONVar res = JSONVar::parse(response);
        _tapoStatus = res["error_code"];
        if (_tapoStatus == 0)
        {
          JSONVar res2 = JSONVar::parse(decrypt(JSONVar::stringify(res["result"]["response"])));
          _tapoStatus = res2["error_code"];
          if (_tapoStatus == 0)
          {
            _tapoToken = JSONVar::stringify(res2["result"]["token"]);
            if (_tapoToken.startsWith("\"") && _tapoToken.endsWith("\""))
              _tapoToken = _tapoToken.substring(1, _tapoToken.length() - 1);
            if (_tapoToken.length())
              return true;
          }
        }
      }
      return false;
    }

    bool beginSession(void)
    {
      if (_tapoCookie.length() && _tapoToken.length())
      {
        if (millis() - _sessionStart < _sessionTimeout)
          return true;
        endSession();
      }
      return handshake() ? login() : false;
    }

    void endSession(void)
    {
      _tapoCookie.clear();
      _tapoToken.clear();
      _terminalUUID.clear();
    }

    String getTerminalUUID(void)
    {
      if (_terminalUUID.length() == 0)
      {
        String info;
        if (getDeviceInfo(info))
          _terminalUUID = JSONVar::stringify(JSONVar::parse(info)["result"]["mac"]);
      }
      return _terminalUUID;
    }

  public:

    TAPO(void)
    : _httpStatus(0)
    , _tapoStatus(0)
    , _mbedStatus(0)
    , _sessionTimeout(TAPO_SESSION_TIMEOUT(1440 - 1))
    {
    }

    virtual ~TAPO(void)
    {
    }

    bool begin(const char *hostname, const char *username, const char *password)
    {
      if (!generateKeyPair())
      {
        TAPO_DEBUG_PRINTF("generateKeyPair() failed.\n", 0);
        return false;
      }
      // hostname (ipaddress only)
      _hostname = hostname;
      // username
      String id = digest(username);
      _buffer[b64encode((uint8_t *)id.c_str(), id.length(), _buffer)] = 0;
      _username = (char *)_buffer;
      // password
      _buffer[b64encode((uint8_t *)password, strlen(password), _buffer)] = 0;
      _password = (char *)_buffer;
      //
      endSession();
      return true;
    }

    void end(void)
    {
    }

    int httpStatus(void)
    {
      return _httpStatus;
    }

    int tapoStatus(void)
    {
      return _tapoStatus;
    }

    int mbedStatus(void)
    {
      return _mbedStatus;
    }

    /*
     * String info;
     * getDeviceInfo(info);
     * decode(JSONVar::parse(info)["result"]["nickname" or "ssid"]);
     */
    String decode(const char *str)
    {
      _buffer[b64decode((uint8_t *)str, strlen(str), _buffer)] = 0;
      return String((char *)_buffer);
    }

    bool getEnergyUsage(String &info)
    {
      if (beginSession())
      {
        JSONVar payload;
        payload["method"] = TAPO_METHOD_GET_ENERGY_USAGE;
        payload["requestTimeMils"] = millis();
        JSONVar envelope;
        envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;
        envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));
        String response = request(JSONVar::stringify(envelope));
        if (response.length())
        {
          JSONVar res = JSONVar::parse(response);
          _tapoStatus = res["error_code"];
          if (_tapoStatus == 0)
          {
            info = decrypt(JSONVar::stringify(res["result"]["response"]));
            return true;
          }
        }
      }
      endSession();
      return false;
    }

    bool getDeviceInfo(String &info)
    {
      if (beginSession())
      {
        JSONVar payload;
        payload["method"] = TAPO_METHOD_GET_DEVICE_INFO;
        payload["requestTimeMils"] = millis();
        JSONVar envelope;
        envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;
        envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));
        String response = request(JSONVar::stringify(envelope));
        if (response.length())
        {
          JSONVar res = JSONVar::parse(response);
          _tapoStatus = res["error_code"];
          if (_tapoStatus == 0)
          {
            info = decrypt(JSONVar::stringify(res["result"]["response"]));
            return true;
          }
        }
      }
      endSession();
      return false;
    }

    bool setDeviceOn(bool on)
    {
      if (beginSession())
      {
        JSONVar payload;
        payload["method"] = TAPO_METHOD_SET_DEVICE_INFO;
        payload["params"]["device_on"] = on;
        payload["terminalUUID"] = getTerminalUUID();
        payload["requestTimeMils"] = millis();
        JSONVar envelope;
        envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;
        envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));
        String response = request(JSONVar::stringify(envelope));
        if (response.length())
        {
          JSONVar res = JSONVar::parse(response);
          _tapoStatus = res["error_code"];
          if (_tapoStatus == 0)
            return true;
        }
      }
      endSession();
      return false;
    }
};

#endif

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

tapo.h - TP-Link TAPO Control Library for P100/P105/P110

This library is free software; you can redistribute it and/or

modify it under the terms of the GNU Lesser General Public

License as published by the Free Software Foundation; either

version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General

Public License along with this library; if not, write to the

Free Software Foundation, Inc., 59 Temple Place, Suite 330,

Boston, MA 02111-1307 USA

#ifndef __TAPO_H

#define __TAPO_H

#include <stdio.h>

#include <stdlib.h>

#include <stdarg.h>

#include <stdint.h>

#include <stdbool.h>

#include <string.h>

// Included in ESP32.

#include "libb64/cencode.h"

#include "libb64/cdecode.h"

#include "mbedtls/entropy.h"

#include "mbedtls/ctr_drbg.h"

#include "mbedtls/cipher.h"

#include "mbedtls/pk.h"

#include "HTTPClient.h"

// Requires installation.

#include "Arduino_JSON.h"

typedef enum

{

TAPO_ERROR_SUCCESS = 0,

TAPO_ERROR_INCORRECT_REQUEST = -1002,

TAPO_ERROR_JSON_FORMATTING_ERROR = -1003,

TAPO_ERROR_INVALID_PUBLIC_KEY_LENGTH = -1010, // invalid cookie

TAPO_ERROR_INVALID_TERMINALUUID = -1012,

TAPO_ERROR_INVALID_REQUEST_OR_CREDENTIAL = -1501,

TAPO_ERROR_DEVICE_BUSY = 9999,

} TAPO_ERROR;

#define TAPO_SESSION_TIMEOUT(t) ((t) * 60 * 1000)

#define TAPO_MD_LENGTH 20

#define TAPO_CIPHER_KEY_BITS 128

#define TAPO_RSA_KEY_BITS 1024

#define TAPO_RSA_EXPONENT 65537

#define TAPO_SEED_PERSONAL "rsa_genkey"

#define TAPO_METHOD_HANDSHAKE "handshake"

#define TAPO_METHOD_LOGIN_DEVICE "login_device"

#define TAPO_METHOD_GET_DEVICE_INFO "get_device_info"

#define TAPO_METHOD_SET_DEVICE_INFO "set_device_info"

#define TAPO_METHOD_GET_ENERGY_USAGE "get_energy_usage"

#define TAPO_METHOD_SECUREPASSTHROUGH "securePassthrough"

#define TAPO_DEBUG_PRINTF(format, ...) debug_printf(__FILE__, __LINE__, format, __VA_ARGS__)

#define TAPO_DEBUG_MBEDTLS(name, status) mbedtls_status(__FILE__, __LINE__, name, status)

class TAPO

{

private:

String _hostname;

String _username;

String _password;

HTTPClient _httpClient;

int _httpStatus;

int _tapoStatus;

int _mbedStatus;

String _tapoCookie;

String _tapoToken;

String _terminalUUID;

uint32_t _sessionTimeout;

uint32_t _sessionStart;

String _publicKey;

String _privateKey;

uint8_t _cipherKey[TAPO_CIPHER_KEY_BITS >> 3];

uint8_t _cipherIv [TAPO_CIPHER_KEY_BITS >> 3];

uint8_t _buffer[2048];

void debug_printf(const char *file, int line, const char *format, ...)

{

char buf[256];

Serial.printf("[%s:%d] ", file, line);

va_list ap;

va_start(ap, format);

vsnprintf(buf, sizeof(buf), format, ap);

va_end(ap);

Serial.print(buf);

}

int mbedtls_status(const char *file, int line, const char *name, int status)

{

_mbedStatus = status;

if (status)

debug_printf(file, line, "%s = -0x%04X\n", name, abs(status));

return status;

}

String toHEX(uint8_t *buf, uint16_t len)

{

const static char HEX_DIGITS[] = "0123456789abcdef";

String hex;

while (len-- > 0)

{

uint8_t b = *buf++;

hex += HEX_DIGITS[b >> 4];

hex += HEX_DIGITS[b & 0x0F];

}

return hex;

}

int b64encode(const uint8_t *bin, int len, uint8_t *b64)

{

return base64_encode_chars((char *)bin, len, (char *)b64);

}

int b64decode(const uint8_t *b64, int len, uint8_t *bin)

{

return base64_decode_chars((char *)b64, len, (char *)bin);

}

String removePemLF(const String &pem)

{

int head = pem.indexOf('\n');

int tail = pem.lastIndexOf('\n', pem.length() - 2);

String body = pem.substring(head + 1, tail);

body.replace("\n", "");

return pem.substring(0, head + 1) + body + pem.substring(tail + 1);

}

bool generateKeyPair(void)

{

bool rv = false;

int olen;

mbedtls_pk_context pk;

mbedtls_entropy_context entropy;

mbedtls_ctr_drbg_context ctr_drbg;

_buffer[0] = 0;

mbedtls_pk_init(&pk);

mbedtls_entropy_init(&entropy);

mbedtls_ctr_drbg_init(&ctr_drbg);

if (TAPO_DEBUG_MBEDTLS("mbedtls_ctr_drbg_seed()", mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy, (uint8_t *)TAPO_SEED_PERSONAL, strlen(TAPO_SEED_PERSONAL)))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_setup()", mbedtls_pk_setup(&pk, mbedtls_pk_info_from_type(MBEDTLS_PK_RSA)))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_rsa_gen_key()", mbedtls_rsa_gen_key(mbedtls_pk_rsa(pk), mbedtls_ctr_drbg_random, &ctr_drbg, TAPO_RSA_KEY_BITS, TAPO_RSA_EXPONENT))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_write_pubkey_pem()", mbedtls_pk_write_pubkey_pem(&pk, _buffer, sizeof(_buffer)))) ;

else if ((olen = strlen((char *)_buffer)) == 0) TAPO_DEBUG_PRINTF("invalid public key length = %d\n", olen);

else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_write_key_pem()", mbedtls_pk_write_key_pem(&pk, _buffer + olen + 1, sizeof(_buffer) - olen - 1))) ;

else

{

_publicKey = removePemLF(String((char *)_buffer));

_privateKey = (char *)_buffer + olen + 1;

rv = true;

}

mbedtls_ctr_drbg_free(&ctr_drbg);

mbedtls_entropy_free(&entropy);

mbedtls_pk_free(&pk);

return rv;

}

bool cipherKey(const char *key)

{

bool rv = false;

mbedtls_pk_context pk;

mbedtls_entropy_context entropy;

mbedtls_ctr_drbg_context ctr_drbg;

uint16_t ilen = strlen(key);

size_t olen = b64decode((uint8_t *)key, ilen, _buffer + ilen);

mbedtls_pk_init(&pk);

mbedtls_entropy_init(&entropy);

mbedtls_ctr_drbg_init(&ctr_drbg);

if (TAPO_DEBUG_MBEDTLS("mbedtls_ctr_drbg_seed()", mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy, (uint8_t *)TAPO_SEED_PERSONAL, strlen(TAPO_SEED_PERSONAL)))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_parse_key()", mbedtls_pk_parse_key(&pk, (uint8_t *)_privateKey.c_str(), _privateKey.length() + 1, NULL, 0))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_pk_decrypt()", mbedtls_pk_decrypt(&pk, _buffer + ilen, olen, _buffer, &olen, ilen, mbedtls_ctr_drbg_random, &ctr_drbg))) ;

else if (olen != sizeof(_cipherKey) + sizeof(_cipherIv)) TAPO_DEBUG_PRINTF("invalid cipher key length = %d\n", olen);

else

{

memcpy(_cipherKey, _buffer, sizeof(_cipherKey));

memcpy(_cipherIv, _buffer + sizeof(_cipherKey), sizeof(_cipherIv));

rv = true;

}

mbedtls_ctr_drbg_free(&ctr_drbg);

mbedtls_entropy_free(&entropy);

mbedtls_pk_free(&pk);

return rv;

}

String digest(const char *msg)

{

return TAPO_DEBUG_MBEDTLS("mbedtls_md(mbedtls_md_info_from_type()", mbedtls_md(mbedtls_md_info_from_type(MBEDTLS_MD_SHA1), (const uint8_t *)msg, strlen(msg), _buffer))

? String() : toHEX(_buffer, TAPO_MD_LENGTH);

}

size_t cipher0(mbedtls_operation_t operation, const uint8_t *input, size_t ilen, uint8_t *output)

{

size_t olen, olen2;

mbedtls_cipher_context_t cipher;

mbedtls_cipher_init(&cipher);

if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_setup()", mbedtls_cipher_setup(&cipher, mbedtls_cipher_info_from_values(MBEDTLS_CIPHER_ID_AES, TAPO_CIPHER_KEY_BITS, MBEDTLS_MODE_CBC)))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_set_padding_mode()", mbedtls_cipher_set_padding_mode(&cipher, MBEDTLS_PADDING_PKCS7))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_set_iv()", mbedtls_cipher_set_iv(&cipher, _cipherIv, sizeof(_cipherIv)))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_setkey()", mbedtls_cipher_setkey(&cipher, _cipherKey, TAPO_CIPHER_KEY_BITS, operation))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_update()", mbedtls_cipher_update(&cipher, input, ilen, output, &olen))) ;

else if (TAPO_DEBUG_MBEDTLS("mbedtls_cipher_finish()", mbedtls_cipher_finish(&cipher, output + olen, &olen2))) olen = olen2 = 0;

mbedtls_cipher_free(&cipher);

return _mbedStatus ? 0 : olen + olen2;

}

String encrypt(const String &plain)

{

size_t ilen = plain.length();

size_t olen = cipher0(MBEDTLS_ENCRYPT, (uint8_t *)plain.c_str(), ilen, _buffer + ilen);

_buffer[b64encode(_buffer + ilen, olen, _buffer)] = 0;

return String((char *)_buffer);

}

String decrypt(const String &cipher)

{

size_t ilen = cipher.length();

size_t olen = b64decode((uint8_t *)cipher.c_str(), ilen, _buffer + ilen);

_buffer[cipher0(MBEDTLS_DECRYPT, _buffer + ilen, olen, _buffer)] = 0;

return String((char *)_buffer);

}

String request0(const String &payload)

{

_tapoStatus = 0;

_httpStatus = 0;

_mbedStatus = 0;

String response;

const char *url = (_tapoToken.length() ? "http://%s/app?token=%s" : "http://%s/app");

snprintf((char *)_buffer, sizeof(_buffer), url, _hostname.c_str(), _tapoToken.c_str());

if (_httpClient.begin((char *)_buffer))

{

const static char *headers[] = {"Set-Cookie"};

_httpClient.collectHeaders(headers, sizeof(headers) / sizeof(headers[0]));

if (_tapoCookie.length())

_httpClient.addHeader("Cookie", _tapoCookie.c_str(), false, true);

_httpClient.addHeader("Content-type", "application/json;charset=UTF-8", false, true);

_httpStatus = _httpClient.POST(payload);

if (_httpStatus == HTTP_CODE_OK)

{

String cookie = _httpClient.header("Set-Cookie");

if (cookie.length())

{

_sessionStart = millis();

// parse cookie

int left = 0;

int right = -1;

while (right + 1 < cookie.length())

{

left = right + 1;

right = cookie.indexOf(';', left);

if (right < 0)

right = cookie.length();

int mid = cookie.indexOf('=', left);

if (mid < 0)

mid = right;

String name = cookie.substring(left, mid);

String value = cookie.substring(mid + 1, right);

name.toUpperCase();

if (name == "TP_SESSIONID")

_tapoCookie = cookie.substring(left, right);

if (name == "TIMEOUT")

_sessionTimeout = TAPO_SESSION_TIMEOUT(atoi(value.c_str()) - 1);

}

response = _httpClient.getString();

}

_httpClient.end();

}

return response;

}

String request(const String &payload)

{

String response;

int retry = 3;

while (1)

{

response = request0(payload);

if (_httpStatus == HTTP_CODE_OK)

break;

if (--retry == 0)

break;

delay(1000);

}

return response;

}

bool handshake(void)

{

JSONVar payload;

payload["method"] = TAPO_METHOD_HANDSHAKE;

payload["params"]["key"] = _publicKey;

payload["requestTimeMils"] = millis();

String response = request(JSONVar::stringify(payload));

if (response.length())

{

JSONVar res = JSONVar::parse(response);

_tapoStatus = res["error_code"];

if (_tapoStatus == 0)

{

if (cipherKey(res["result"]["key"]) && _tapoCookie.length())

return true;

}

return false;

}

bool login(void)

{

JSONVar payload;

payload["method"] = TAPO_METHOD_LOGIN_DEVICE;

payload["params"]["username"] = _username;

payload["params"]["password"] = _password;

payload["requestTimeMils"] = millis();

JSONVar envelope;

envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;

envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));

String response = request(JSONVar::stringify(envelope));

if (response.length())

{

JSONVar res = JSONVar::parse(response);

_tapoStatus = res["error_code"];

if (_tapoStatus == 0)

{

JSONVar res2 = JSONVar::parse(decrypt(JSONVar::stringify(res["result"]["response"])));

_tapoStatus = res2["error_code"];

if (_tapoStatus == 0)

{

_tapoToken = JSONVar::stringify(res2["result"]["token"]);

if (_tapoToken.startsWith("\"") && _tapoToken.endsWith("\""))

_tapoToken = _tapoToken.substring(1, _tapoToken.length() - 1);

if (_tapoToken.length())

return true;

}

return false;

}

bool beginSession(void)

{

if (_tapoCookie.length() && _tapoToken.length())

{

if (millis() - _sessionStart < _sessionTimeout)

return true;

endSession();

}

return handshake() ? login() : false;

}

void endSession(void)

{

_tapoCookie.clear();

_tapoToken.clear();

_terminalUUID.clear();

}

String getTerminalUUID(void)

{

if (_terminalUUID.length() == 0)

{

String info;

if (getDeviceInfo(info))

_terminalUUID = JSONVar::stringify(JSONVar::parse(info)["result"]["mac"]);

}

return _terminalUUID;

}

public:

TAPO(void)

: _httpStatus(0)

, _tapoStatus(0)

, _mbedStatus(0)

, _sessionTimeout(TAPO_SESSION_TIMEOUT(1440 - 1))

{

}

virtual ~TAPO(void)

{

}

bool begin(const char *hostname, const char *username, const char *password)

{

if (!generateKeyPair())

{

TAPO_DEBUG_PRINTF("generateKeyPair() failed.\n", 0);

return false;

}

// hostname (ipaddress only)

_hostname = hostname;

// username

String id = digest(username);

_buffer[b64encode((uint8_t *)id.c_str(), id.length(), _buffer)] = 0;

_username = (char *)_buffer;

// password

_buffer[b64encode((uint8_t *)password, strlen(password), _buffer)] = 0;

_password = (char *)_buffer;

endSession();

return true;

}

void end(void)

{

}

int httpStatus(void)

{

return _httpStatus;

}

int tapoStatus(void)

{

return _tapoStatus;

}

int mbedStatus(void)

{

return _mbedStatus;

}

* String info;

* getDeviceInfo(info);

* decode(JSONVar::parse(info)["result"]["nickname" or "ssid"]);

String decode(const char *str)

{

_buffer[b64decode((uint8_t *)str, strlen(str), _buffer)] = 0;

return String((char *)_buffer);

}

bool getEnergyUsage(String &info)

{

if (beginSession())

{

JSONVar payload;

payload["method"] = TAPO_METHOD_GET_ENERGY_USAGE;

payload["requestTimeMils"] = millis();

JSONVar envelope;

envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;

envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));

String response = request(JSONVar::stringify(envelope));

if (response.length())

{

JSONVar res = JSONVar::parse(response);

_tapoStatus = res["error_code"];

if (_tapoStatus == 0)

{

info = decrypt(JSONVar::stringify(res["result"]["response"]));

return true;

}

endSession();

return false;

}

bool getDeviceInfo(String &info)

{

if (beginSession())

{

JSONVar payload;

payload["method"] = TAPO_METHOD_GET_DEVICE_INFO;

payload["requestTimeMils"] = millis();

JSONVar envelope;

envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;

envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));

String response = request(JSONVar::stringify(envelope));

if (response.length())

{

JSONVar res = JSONVar::parse(response);

_tapoStatus = res["error_code"];

if (_tapoStatus == 0)

{

info = decrypt(JSONVar::stringify(res["result"]["response"]));

return true;

}

endSession();

return false;

}

bool setDeviceOn(bool on)

{

if (beginSession())

{

JSONVar payload;

payload["method"] = TAPO_METHOD_SET_DEVICE_INFO;

payload["params"]["device_on"] = on;

payload["terminalUUID"] = getTerminalUUID();

payload["requestTimeMils"] = millis();

JSONVar envelope;

envelope["method"] = TAPO_METHOD_SECUREPASSTHROUGH;

envelope["params"]["request"] = encrypt(JSONVar::stringify(payload));

String response = request(JSONVar::stringify(envelope));

if (response.length())

{

JSONVar res = JSONVar::parse(response);

_tapoStatus = res["error_code"];

if (_tapoStatus == 0)

return true;

}

endSession();

return false;

}

};

#endif

【参照ライブラリ】
Arduino_JSON

月: 2020年11月

TP-LINK TAPO P100/P105/P110をESP32から直接制御する