alexa-cookie2 5.0.0 → 5.0.2

package/README.md

@@ -16,13 +16,19 @@ If the automatic authentication fails (which is more common case in the meantime
 
 Starting with version 2.0 of this library the proxy approach was changed to be more "as the Amazon mobile Apps" which registers a device at Amazon and uses OAuth tokens to handle the automatic refresh of the cookies afterwards. This should work seamless. A cookie is valid for 14 days, so it is preferred to refresh the cookie after 5-13 days (please report if it should be shorter).
 
+## Troubleshooting for getting the cookie and tokens initially
+If you still use the E-Mail or SMS based 2FA flow then this might not work. Please update the 2FA/OTP method in the amazon settings to the current process.
+
+If you open the Proxy URL from a mobile device where also the Alexa App is installed on it might be that it do not work because Amazon might open the Alexa App. So please use a device or PC where the Alexa App is not installed
+
+If you see a page that tells you that "alexa.amazon.xx is deprecated" and you should use the alexa app and with a QR code on it when you enter the Proxy URL" then this means that you call the proxy URL with a different IP/Domainname then the one you entered in the "proxy own IP" settings or you adjusted the IP shown in the Adapter configuration. The "proxy own IP" setting **needs to** match the IP/Domainname you use to call the proxy URL!
+
 ## Example:
 See example folder!
 
 * **example.js** shows how to use the library to initially get a cookie
 * **refresh.js** shown how to use the library to refresh the cookies
 
-
 ## Usage 
 Special note for callback return for parameter result:
 
@@ -42,9 +48,6 @@ Please use the new method "refreshAlexaCookie" to refresh the cookie data. It ta
 
 Since 4.0.0 of this library a new key called "macDms" is also returned when cookies are generated or refreshed. This is (right now Oct 2021) needed to use the Push Connection (alexa-remote library). Better strt also persisting this field, might be needed more later on. 
 
-## Troubleshooting
-If you still use the SMS based 2FA flow then this might now work. Please update the 2fa method in the amazon settings to the current process.
-
 ## Thanks:
 A big thanks go to soef for the initial version of this library and to many other community users to support in finding out what Amazon changes here and there.
 
@@ -52,6 +55,13 @@ Partly based on [Amazon Alexa Remote Control](http://blog.loetzimmer.de/2017/10/
 Thank you for that work.
 
 ## Changelog:
+### 5.0.2 (2023-11-25)
+* (Apollon77) Adjust some texts
+
+### 5.0.1 (2023-11-24)
+* (adn77) make registered device name configurable by Appname
+* (Apollon77) Prevent some error/crash cases
+
 ### 5.0.0 (2023-09-08)
 * IMPORTANT: Node.js 16 is now required minimum Node.js version!
 * (Apollon77) Enhance registration process by also registering the app capabilities to allow usage of new HTTP/2 push connection

package/alexa-cookie.js

@@ -350,7 +350,7 @@ function AlexaCookie() {
                             }
                             if (_options.setupProxy) {
                                 if (proxyServer) {
-                                    errMessage += ` You can try to get the cookie manually by opening http://${_options.proxyOwnIp}:${_options.proxyPort}/ with your browser.`;
+                                    errMessage += ` Please open http://${_options.proxyOwnIp}:${_options.proxyPort}/ with your browser and login to Amazon. The cookie will be output here after successfull login.`;
                                 } else {
                                     amazonProxy.initAmazonProxy(_options, prepareResult,
                                         (server) => {
@@ -361,7 +361,7 @@ function AlexaCookie() {
                                             if (!_options.proxyPort || _options.proxyPort === 0) {
                                                 _options.proxyPort = proxyServer.address().port;
                                             }
-                                            errMessage += ` You can try to get the cookie manually by opening http://${_options.proxyOwnIp}:${_options.proxyPort}/ with your browser.`;
+                                            errMessage += ` Please open http://${_options.proxyOwnIp}:${_options.proxyPort}/ with your browser and login to Amazon. The cookie will be output here after successfull login.`;
                                             callback && callback(new Error(errMessage), null);
                                         }
                                     );
@@ -386,7 +386,7 @@ function AlexaCookie() {
                 if (!_options.proxyPort || _options.proxyPort === 0) {
                     _options.proxyPort = proxyServer.address().port;
                 }
-                const errMessage = `You can try to get the cookie manually by opening http://${_options.proxyOwnIp}:${_options.proxyPort}/ with your browser.`;
+                const errMessage = `Please open http://${_options.proxyOwnIp}:${_options.proxyPort}/ with your browser and login to Amazon. The cookie will be output here after successfull login.`;
                 callback && callback(new Error(errMessage), null);
             });
         }
@@ -442,7 +442,7 @@ function AlexaCookie() {
                 'domain': 'Device',
                 'app_version': apiCallVersion,
                 'device_type': 'A2IVLV5VM2W81',
-                'device_name': '%FIRST_NAME%\u0027s%DUPE_STRATEGY_1ST%ioBroker Alexa2',
+                'device_name': '%FIRST_NAME%\u0027s%DUPE_STRATEGY_1ST%' + _options.deviceAppName,
                 'os_version': '16.6',
                 'device_serial': deviceSerial,
                 'device_model': 'iPhone',

package/example/example.js

@@ -8,12 +8,17 @@ const alexaCookie = require('../alexa-cookie');
 
 const config = {
     logger: console.log,
-    amazonPage: 'amazon.com',  // optional: possible to use with different countries, default is 'amazon.de'
-    acceptLanguage: 'en-US',   // optional: webpage language, should match to amazon-Page, default is 'de-DE'
+    proxyOwnIp: '...',         // required if proxy enabled: provide the own IP with which you later access the proxy.
+                               // Providing/Using a hostname here can lead to issues!
+                               // Needed to set up all rewriting and proxy stuff internally
+
+    // The following options are optional. Try without them first and just use really needed ones!!
+
+    amazonPage: 'amazon.de',   // optional: possible to use with different countries, default is 'amazon.de'
+    acceptLanguage: 'de-DE',   // optional: webpage language, should match to amazon-Page, default is 'de-DE'
     userAgent: '...',          // optional: own userAgent to use for all request, overwrites default one, should not be needed
     proxyOnly: true,           // optional: should only the proxy method be used? When no email/password are provided this will set to true automatically, default: false
     setupProxy: true,          // optional: should the library setup a proxy to get cookie when automatic way did not worked? Default false!
-    proxyOwnIp: '...',         // required if proxy enabled: provide own IP or hostname to later access the proxy. needed to setup all rewriting and proxy stuff internally
     proxyPort: 3456,           // optional: use this port for the proxy, default is 0 means random port is selected
     proxyListenBind: '0.0.0.0',// optional: set this to bind the proxy to a special IP, default is '0.0.0.0'
     proxyLogLevel: 'info',     // optional: Loglevel of Proxy, default 'warn'

package/lib/proxy.js

@@ -28,7 +28,7 @@ function addCookies(Cookie, headers) {
     }
     Cookie = '';
     for (const name of Object.keys(cookies)) {
-        Cookie += name + '=' + cookies[name] + '; ';
+        Cookie += `${name}=${cookies[name]}; `;
     }
     Cookie = Cookie.replace(/[; ]*$/, '');
     return Cookie;
@@ -175,7 +175,7 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
 
     function router(req) {
         const url = (req.originalUrl || req.url);
-        _options.logger && _options.logger('Router: ' + url + ' / ' + req.method + ' / ' + JSON.stringify(req.headers));
+        _options.logger && _options.logger(`Router: ${url} / ${req.method} / ${JSON.stringify(req.headers)}`);
         if (req.headers.host === `${_options.proxyOwnIp}:${_options.proxyPort}`) {
             if (url.startsWith(`/www.${_options.baseAmazonPage}/`)) {
                 return `https://www.${_options.baseAmazonPage}`;
@@ -190,7 +190,7 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
             }
             if (url === '/') { // initial redirect
                 returnedInitUrl =  `https://www.${_options.baseAmazonPage}/ap/signin?openid.return_to=https%3A%2F%2Fwww.${_options.baseAmazonPage}%2Fap%2Fmaplanding&openid.assoc_handle=amzn_dp_project_dee_ios${_options.baseAmazonPageHandle}&openid.identity=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0%2Fidentifier_select&pageId=amzn_dp_project_dee_ios${_options.baseAmazonPageHandle}&accountStatusPolicy=P1&openid.claimed_id=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0%2Fidentifier_select&openid.mode=checkid_setup&openid.ns.oa2=http%3A%2F%2Fwww.${_options.baseAmazonPage}%2Fap%2Fext%2Foauth%2F2&openid.oa2.client_id=device%3A${deviceId}&openid.ns.pape=http%3A%2F%2Fspecs.openid.net%2Fextensions%2Fpape%2F1.0&openid.oa2.response_type=code&openid.ns=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0&openid.pape.max_auth_age=0&openid.oa2.scope=device_auth_access&openid.oa2.code_challenge_method=S256&openid.oa2.code_challenge=${code_challenge}&language=${_options.amazonPageProxyLanguage}`;
-                _options.logger && _options.logger('Alexa-Cookie: Initial Page Request: ' + returnedInitUrl);
+                _options.logger && _options.logger(`Alexa-Cookie: Initial Page Request: ${returnedInitUrl}`);
                 return returnedInitUrl;
             }
             else {
@@ -201,12 +201,12 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
     }
 
     function onError(err, req, res) {
-        _options.logger && _options.logger('ERROR: ' + err);
+        _options.logger && _options.logger(`ERROR: ${err}`);
         try {
             res.writeHead(500, {
                 'Content-Type': 'text/plain'
             });
-            res.end('Proxy-Error: ' + err);
+            res.end(`Proxy-Error: ${err}`);
         } catch (err) {
             // ignore
         }
@@ -239,18 +239,18 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
         if (url.endsWith('.ico') || url.endsWith('.js') || url.endsWith('.ttf') || url.endsWith('.svg') || url.endsWith('.png') || url.endsWith('.appcache')) return;
         //if (url.startsWith('/ap/uedata')) return;
 
-        _options.logger && _options.logger('Alexa-Cookie: Proxy-Request: ' + req.method + ' ' + url);
+        _options.logger && _options.logger(`Alexa-Cookie: Proxy-Request: ${req.method} ${url}`);
         //_options.logger && _options.logger('Alexa-Cookie: Proxy-Request-Data: ' + customStringify(proxyReq, null, 2));
 
         if (typeof proxyReq.getHeader === 'function') {
-            _options.logger && _options.logger('Alexa-Cookie: Headers: ' + JSON.stringify(proxyReq.getHeaders()));
+            _options.logger && _options.logger(`Alexa-Cookie: Headers: ${JSON.stringify(proxyReq.getHeaders())}`);
             let reqCookie = proxyReq.getHeader('cookie');
             if (reqCookie === undefined) {
                 reqCookie = '';
             }
             for (const cookie of Object.keys(initialCookies)) {
-                if (!reqCookie.includes(cookie + '=')) {
-                    reqCookie += '; ' + cookie + '=' + initialCookies[cookie];
+                if (!reqCookie.includes(`${cookie}=`)) {
+                    reqCookie += `; ${cookie}=${initialCookies[cookie]}`;
                 }
             }
             if (reqCookie.startsWith('; ')) {
@@ -260,9 +260,9 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
             if (!proxyCookies.length) {
                 proxyCookies = reqCookie;
             } else {
-                proxyCookies += '; ' + reqCookie;
+                proxyCookies += `; ${reqCookie}`;
             }
-            _options.logger && _options.logger('Alexa-Cookie: Headers: ' + JSON.stringify(proxyReq.getHeaders()));
+            _options.logger && _options.logger(`Alexa-Cookie: Headers: ${JSON.stringify(proxyReq.getHeaders())}`);
         }
 
         let modified = false;
@@ -271,11 +271,11 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
                 const fixedReferer = replaceHostsBack(proxyReq.getHeader('referer'));
                 if (fixedReferer ) {
                     proxyReq.setHeader('referer', fixedReferer);
-                    _options.logger && _options.logger('Alexa-Cookie: Modify headers: Changed Referer: ' + fixedReferer);
+                    _options.logger && _options.logger(`Alexa-Cookie: Modify headers: Changed Referer: ${fixedReferer}`);
                     modified = true;
                 }
             }
-            if (typeof proxyReq.getHeader === 'function' && proxyReq.getHeader('origin') !== 'https://' + proxyReq.getHeader('host')) {
+            if (typeof proxyReq.getHeader === 'function' && proxyReq.getHeader('origin') !== `https://${proxyReq.getHeader('host')}`) {
                 proxyReq.setHeader('origin', `https://www.${_options.baseAmazonPage}`);
                 _options.logger && _options.logger('Alexa-Cookie: Modify headers: Delete Origin');
                 modified = true;
@@ -286,7 +286,7 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
                 postBody += chunk.toString(); // convert Buffer to string
             });
         }
-        _options.proxyLogLevel === 'debug' && _options.logger && _options.logger('Alexa-Cookie: Proxy-Request: (modified:' + modified + ')' + customStringify(proxyReq, null, 2));
+        _options.proxyLogLevel === 'debug' && _options.logger && _options.logger(`Alexa-Cookie: Proxy-Request: (modified:${modified})${customStringify(proxyReq, null, 2)}`);
     }
 
     function onProxyRes(proxyRes, req, res) {
@@ -296,9 +296,9 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
         //_options.logger && _options.logger('Proxy-Response: ' + customStringify(proxyRes, null, 2));
         let reqestHost = null;
         if (proxyRes.socket && proxyRes.socket._host) reqestHost = proxyRes.socket._host;
-        _options.logger && _options.logger('Alexa-Cookie: Proxy Response from Host: ' + reqestHost);
-        _options.proxyLogLevel === 'debug' && _options.logger && _options.logger('Alexa-Cookie: Proxy-Response Headers: ' + customStringify(proxyRes.headers, null, 2));
-        _options.proxyLogLevel === 'debug' && _options.logger && _options.logger('Alexa-Cookie: Proxy-Response Outgoing: ' + customStringify(proxyRes.socket.parser.outgoing, null, 2));
+        _options.logger && _options.logger(`Alexa-Cookie: Proxy Response from Host: ${reqestHost}`);
+        _options.proxyLogLevel === 'debug' && _options.logger && _options.logger(`Alexa-Cookie: Proxy-Response Headers: ${customStringify(proxyRes.headers, null, 2)}`);
+        _options.proxyLogLevel === 'debug' && _options.logger && _options.logger(`Alexa-Cookie: Proxy-Response Outgoing: ${customStringify(proxyRes.socket.parser.outgoing, null, 2)}`);
         //_options.logger && _options.logger('Proxy-Response RES!!: ' + customStringify(res, null, 2));
 
         if (proxyRes && proxyRes.headers && proxyRes.headers['set-cookie']) {
@@ -308,7 +308,7 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
             }
             proxyCookies = addCookies(proxyCookies, proxyRes.headers);
         }
-        _options.logger && _options.logger('Alexa-Cookie: Cookies handled: ' + JSON.stringify(proxyCookies));
+        _options.logger && _options.logger(`Alexa-Cookie: Cookies handled: ${JSON.stringify(proxyCookies)}`);
 
         if (
             (proxyRes.socket && proxyRes.socket._host === `www.${_options.baseAmazonPage}` && proxyRes.socket.parser.outgoing && proxyRes.socket.parser.outgoing.method === 'GET' && proxyRes.socket.parser.outgoing.path.startsWith('/ap/maplanding')) ||
@@ -324,8 +324,8 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
             proxyRes.headers.location = `http://${_options.proxyOwnIp}:${_options.proxyPort}/cookie-success`;
             delete proxyRes.headers.referer;
 
-            _options.logger && _options.logger('Alexa-Cookie: Proxy catched cookie: ' + proxyCookies);
-            _options.logger && _options.logger('Alexa-Cookie: Proxy catched parameters: ' + JSON.stringify(queryParams));
+            _options.logger && _options.logger(`Alexa-Cookie: Proxy catched cookie: ${proxyCookies}`);
+            _options.logger && _options.logger(`Alexa-Cookie: Proxy catched parameters: ${JSON.stringify(queryParams)}`);
 
             callbackCookie && callbackCookie(null, {
                 'loginCookie': proxyCookies,
@@ -340,12 +340,12 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
 
         // If we detect a redirect, rewrite the location header
         if (proxyRes.headers.location) {
-            _options.logger && _options.logger('Redirect: Original Location ----> ' + proxyRes.headers.location);
+            _options.logger && _options.logger(`Redirect: Original Location ----> ${proxyRes.headers.location}`);
             proxyRes.headers.location = replaceHosts(proxyRes.headers.location);
             if (reqestHost && proxyRes.headers.location.startsWith('/')) {
-                proxyRes.headers.location = `http://${_options.proxyOwnIp}:${_options.proxyPort}/` + reqestHost + proxyRes.headers.location;
+                proxyRes.headers.location = `http://${_options.proxyOwnIp}:${_options.proxyPort}/${reqestHost}${proxyRes.headers.location}`;
             }
-            _options.logger && _options.logger('Redirect: Final Location ----> ' + proxyRes.headers.location);
+            _options.logger && _options.logger(`Redirect: Final Location ----> ${proxyRes.headers.location}`);
             return;
         }
 
@@ -374,12 +374,16 @@ function initAmazonProxy(_options, callbackCookie, callbackListening) {
     app.get('/cookie-success', function(req, res) {
         res.send(_options.proxyCloseWindowHTML);
     });
+    if (_options.proxyPort< 1 || _options.proxyPort > 65535) {
+        _options.logger && _options.logger(`Alexa-Cookie: Error: Port ${_options.proxyPort} invalid. Use random port.`);
+        _options.proxyPort = undefined;
+    }
     const server = app.listen(_options.proxyPort, _options.proxyListenBind, function() {
-        _options.logger && _options.logger('Alexa-Cookie: Proxy-Server listening on port ' + server.address().port);
+        _options.logger && _options.logger(`Alexa-Cookie: Proxy-Server listening on port ${server.address().port}`);
         callbackListening && callbackListening(server);
         callbackListening = null;
     }).on('error', err => {
-        _options.logger && _options.logger('Alexa-Cookie: Proxy-Server Error: ' + err);
+        _options.logger && _options.logger(`Alexa-Cookie: Proxy-Server Error: ${err}`);
         callbackListening && callbackListening(null);
         callbackListening = null;
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alexa-cookie2",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "Generate Cookie and CSRF for Alexa Remote",
   "author": {
     "name": "Apollon77",
@@ -21,7 +21,7 @@
     "layla.amazon.de"
   ],
   "dependencies": {
-    "cookie": "^0.5.0",
+    "cookie": "^0.6.0",
     "express": "^4.18.2",
     "http-proxy-middleware": "^2.0.6",
     "http-proxy-response-rewrite": "^0.0.1",
@@ -31,7 +31,7 @@
   "devDependencies": {
     "@alcalzone/release-script": "^3.6.0",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "eslint": "^8.48.0"
+    "eslint": "^8.54.0"
   },
   "repository": {
     "type": "git",