tr064.h

Go to the documentation of this file.

#ifndef tr064_h
#define tr064_h

#include "Arduino.h"
#include <MD5Builder.h>
#if defined(ESP8266)
    //if(Serial) Serial.println(F("Version compiled for ESP8266."));
    #include <ESP8266WiFi.h>
    #include <ESP8266HTTPClient.h>
#elif defined(ESP32)
    //if(Serial) Serial.println(F("Version compiled for ESP32."));
    #include <WiFi.h>
    #include <HTTPClient.h>

#else
    //INCOMPATIBLE!
#endif

typedef enum {
    
     //TR064_CODE_UNAUTHORIZED = 401, //If a user is not authenticated, 401 (“Unauthorized”) will be returned.
     TR064_CODE_UNKNOWNACTION = 401, 
     TR064_CODE_FALSEARGUMENTS = 402, //If a user is not authenticated, 401 (“Unauthorized”) will be returned.
     TR064_CODE_ACTIONNOTAUTHORIZED = 606, //If a user is authenticated but has not the needed rights, 606 (“Action not authorized”) will be returned
     TR064_CODE_SECONDFACTORAUTHREQUIRED = 866, //If an action needs 2FA, the status code 866 (“second factor authentication required”)
     TR064_CODE_SECONDFACTORAUTHBLOCKED = 867, // (“second factor authentication blocked”) or 
     TR064_CODE_SECONDFACTORAUTHBUSY = 868, // (“second factorauthentication busy”) will be returned and the 2FA procedure    
} t_tr064_codes;



#define arr_len( x )  ( sizeof( x ) / sizeof( *x ) ) 

// Possible values for client.state()
#define TR064_NO_SERVICES           -1 
#define TR064_SERVICES_LOADED       0 

// Possible values for client.state()
#define TR064_NO_SERVICES           -1
#define TR064_SERVICES_LOADED       0

// Possible values for client.state()
#define TR064_NO_SERVICES          -1
#define TR064_SERVICES_LOADED       0

/**************************************************************************/
/**************************************************************************/

class TR064 {
    public:
        enum LoggingLevels {DEBUG_NONE, DEBUG_ERROR, DEBUG_WARNING, DEBUG_INFO, DEBUG_VERBOSE}; 
        
        enum tr064_codes{
            
            //TR064_CODE_UNAUTHORIZED = 401, //If a user is not authenticated, 401 (“Unauthorized”) will be returned.
            TR064_CODE_UNKNOWNACTION = 401, 
            TR064_CODE_FALSEARGUMENTS = 402, //If a user is not authenticated, 401 (“Unauthorized”) will be returned.
            TR064_CODE_AUTHFAILED = 503, //If a user is not authenticated, 401 (“Unauthorized”) will be returned.
            TR064_CODE_ARGUMENTVALUEINVALIDE = 600, //  Argument Value Invalid
            TR064_CODE_ACTIONNOTAUTHORIZED = 606, //If a user is authenticated but has not the needed rights, 606 (“Action not authorized”) will be returned
            TR064_CODE_ARRAYINDEXINVALID = 713, //SpecifiedArrayIndexInvalid
            TR064_CODE_NOSUCHENTRY = 714, //No such array entry in array
            TR064_CODE_INTERNALERROR = 820, // Internal Error
            TR064_CODE_SECONDFACTORAUTHREQUIRED = 866, //If an action needs 2FA, the status code 866 (“second factor authentication required”)
            TR064_CODE_SECONDFACTORAUTHBLOCKED = 867, // (“second factor authentication blocked”) or 
            TR064_CODE_SECONDFACTORAUTHBUSY = 868, // (“second factorauthentication busy”) will be returned and the 2FA procedure    
        } ;

        TR064();
        TR064(uint16_t port, const String& ip, const String& user, const String& pass);
        ~TR064() {}
        TR064& setServer(uint16_t port, const String& ip, const String& user, const String& pass);
        void init();
        int state();       
        
        bool action(const String& service, const String& act, String params[][2] = {}, int nParam = 0,const String& url = "");
        //bool action(const String& service, const String& act, String params[][2], int nParam, const String& url = "");
        bool action(const String& service, const String& act, String params[][2], int nParam, String (*req)[2], int nReq, const String& url = "");

        String md5String(const String& s);
        String byte2hex(byte number);        
        int debug_level; 
         
    private:
        WiFiClient tr064client;
        HTTPClient http;
        
        //TODO: More consistent naming
        
        void initServiceURLs();
        void deb_print(const String& message, int level);
        void deb_println(const String& message, int level);
        bool action_raw(const String& service,const String& act, String params[][2], int nParam, const String& url = "");
        bool httpRequest(const String& url,  const String& xml, const  String& action, bool retry);
        String generateAuthToken();
        String generateAuthXML();
        String findServiceURL(const String& service);
        String cleanOldServiceName(const String& service);
        bool xmlTakeParam(String (*params)[2], int nParam);
        bool xmlTakeParam(String& value, const String& needParam);
        static String errorToString(int error);

        int _state;
        String _ip;
        uint16_t _port;
        String _user;
        String _pass;
        String _realm; // To be requested from the router
        String _secretH; // To be generated
        String _nonce = "";
        String _status;

        const char* const _requestStart = "<?xml version=\"1.0\"?><s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">";
        const char* const _detectPage = "/tr64desc.xml";
        const char* const _servicePrefix = "urn:dslforum-org:service:";
        unsigned long lastOutActivity;
        unsigned long lastInActivity;
        /* 
            * TODO: We should give access to this data for users to inspect the
        * possibilities of their device(s) - see #9 on Github.
        * TODO: Remove 100 services limits here
        */
        String _services[100][2];
};

#endif