Merge pull request #428 from MatrixAI/feature-align-with-tailscale-login

Aligned command with tailscale login flow

Author: aryanjassal

npmDepsHash

@@ -1 +1 @@
-sha256-23Yx1RJcaNEL1YmNz/LRFYL+5g++B+aoT0CSSbreAx8=
+sha256-j3S6Zig9cm8n29qoJxBmj82WE6YHG2SOSFBuDhJ7xmo=

package-lock.json

@@ -126,21 +126,21 @@
   },
   "optionalDependencies": {
     "@matrixai/db": "*",
+    "@matrixai/exec-darwin-universal": "*",
+    "@matrixai/exec-linux-x64": "*",
     "@matrixai/mdns-linux-x64": "*",
     "@matrixai/quic-darwin-universal": "*",
     "@matrixai/quic-linux-x64": "*",
     "@matrixai/quic-win32-x64": "*",
-    "@matrixai/exec-darwin-universal": "*",
-    "@matrixai/exec-linux-x64": "*",
     "fd-lock": "*",
     "sodium-native": "*"
   },
   "devDependencies": {
-    "@matrixai/lint": "^0.2.11",
+    "@fast-check/jest": "^2.1.1",
     "@matrixai/errors": "^2.1.3",
-    "@matrixai/logger": "^4.0.3",
     "@matrixai/exec": "^1.0.3",
-    "@fast-check/jest": "^2.1.1",
+    "@matrixai/lint": "^0.2.11",
+    "@matrixai/logger": "^4.0.3",
     "@swc/core": "1.3.82",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^29.5.14",
@@ -161,7 +161,8 @@
     "mocked-env": "^1.3.5",
     "nexpect": "^0.6.0",
     "node-gyp-build": "^4.8.4",
-    "polykey": "^2.4.0",
+    "open": "^10.1.2",
+    "polykey": "^2.5.0",
     "shelljs": "^0.8.5",
     "shx": "^0.3.4",
     "tsx": "^3.12.7",

package.json

@@ -1,35 +1,24 @@
 import type PolykeyClient from 'polykey/PolykeyClient.js';
-import type {
-  TokenPayloadEncoded,
-  TokenProtectedHeaderEncoded,
-  TokenSignatureEncoded,
-} from 'polykey/tokens/types.js';
-import type { IdentityRequestData } from 'polykey/client/types.js';
 import CommandPolykey from '../CommandPolykey.js';
 import * as binProcessors from '../utils/processors.js';
-import * as binParsers from '../utils/parsers.js';
 import * as binUtils from '../utils/index.js';
 import * as binOptions from '../utils/options.js';
-import * as errors from '../errors.js';
 
 class CommandLogin extends CommandPolykey {
   constructor(...args: ConstructorParameters<typeof CommandPolykey>) {
     super(...args);
     this.name('login');
-    this.description('Login to a platform with Polykey identity');
-    this.argument(
-      '<token>',
-      'Token provided by platform for logging in',
-      binParsers.parseCompactJWT,
-    );
+    this.description('Login to a platform with your Polykey identity');
+    this.argument('<url>', 'The URL to login using Polykey');
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);
     this.addOption(binOptions.clientPort);
-    this.action(async (encodedToken, options) => {
+    this.addOption(binOptions.returnURLPath);
+    this.action(async (url: string, options) => {
       const { default: PolykeyClient } = await import(
         'polykey/PolykeyClient.js'
       );
-      const tokensUtils = await import('polykey/tokens/utils.js');
+      const { default: open } = await import('open');
       const clientOptions = await binProcessors.processClientOptions(
         options.nodePath,
         options.nodeId,
@@ -58,51 +47,35 @@ class CommandLogin extends CommandPolykey {
           logger: this.logger.getChild(PolykeyClient.name),
         });
 
-        // Create a JSON representation of the encoded header
-        const [protectedHeader, payload, signature] = encodedToken;
-        const incomingTokenEncoded = {
-          payload: payload as TokenPayloadEncoded,
-          signatures: [
-            {
-              protected: protectedHeader as TokenProtectedHeaderEncoded,
-              signature: signature as TokenSignatureEncoded,
-            },
-          ],
-        };
-
-        // Get it verified and signed by the agent
+        // Get a signed token by the agent
         const response = await binUtils.retryAuthentication(
           (auth) =>
-            pkClient.rpcClient.methods.authSignToken({
-              metadata: auth,
-              ...incomingTokenEncoded,
-            }),
+            pkClient.rpcClient.methods.authIdentityToken({ metadata: auth }),
           meta,
         );
 
         // Send the returned JWT to the returnURL provided by the initial token
         const compactHeader = binUtils.jsonToCompactJWT(response);
-        const incomingPayload =
-          tokensUtils.parseTokenPayload<IdentityRequestData>(payload);
-        let result: Response;
-        try {
-          result = await fetch(incomingPayload.returnURL, {
-            method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
-            body: JSON.stringify({ token: compactHeader }),
-          });
-        } catch (e) {
-          throw new errors.ErrorPolykeyCLILoginFailed(
-            'Failed to send token to return url',
-            { cause: e },
-          );
-        }
+        const targetURL = new URL(
+          url.endsWith('/') ? url.slice(0, url.length) : url,
+        );
+        const subPath: string = options.returnURLPath ?? '/oauth2/oidc';
+        targetURL.pathname = subPath.startsWith('/') ? subPath : `/${subPath}`;
+        targetURL.searchParams.append('token', compactHeader);
+
+        // Print out the URL to stderr
+        process.stderr.write(
+          `Open the following URL in your browser:\n\t${targetURL}\n`,
+        );
 
-        // Handle non-200 response
-        if (!result.ok) {
-          throw new errors.ErrorPolykeyCLILoginFailed(
-            `Return url returned failure with code ${result.status}`,
+        // Try to open the URL in the browser
+        try {
+          process.stderr.write(
+            'Attempting to open this URL in your browser...\n',
           );
+          await open(targetURL.toString());
+        } catch (e) {
+          process.stderr.write(`Failed to open browser: ${e.message}\n`);
         }
       } finally {
         if (pkClient! != null) await pkClient.stop();

src/auth/CommandLogin.ts

@@ -201,11 +201,6 @@ class ErrorPolykeyCLIInvalidJWT<T> extends ErrorPolykeyCLI<T> {
   exitCode = sysexits.USAGE;
 }
 
-class ErrorPolykeyCLILoginFailed<T> extends ErrorPolykeyCLI<T> {
-  static description = 'Failed to login using Polykey';
-  exitCode = sysexits.SOFTWARE;
-}
-
 export {
   ErrorPolykeyCLI,
   ErrorPolykeyCLIUncaughtException,
@@ -235,5 +230,4 @@ export {
   ErrorPolykeyCLIEditSecret,
   ErrorPolykeyCLITouchSecret,
   ErrorPolykeyCLIInvalidJWT,
-  ErrorPolykeyCLILoginFailed,
 };