v0.5.0

.gitignore

@@ -6,6 +6,7 @@ npm-debug.log
 
 # Config
 app/config/config.json
+app/config/*.key
 
 # TMP files
 /app/tmp/

README.md

@@ -28,6 +28,11 @@ This repository is a command line interface for passbolt API.
 It allows a user to interact with the passbolt server without the user of web extension.
 Currently works as a read only access only.
 
+# Prerequisite
+In order to use passbolt CLI you will need:
+- Gnupg v2
+- Nodejs LTS or more recent
+
 # How to get started?
 
 Copy the repository
@@ -66,8 +71,9 @@ You also need to make sure the server public key is in your GnuPG keyring.
 
 If you do not know the domain public key or fingerprint you can get them like follow
 ```
-$ passbolt keyring server-public-key --display-fingerprint
-$ passbolt keyring server-public-key --display-armored
+$ passbolt server-key --domain=https://www.passbolt.test > app/config/server.key
+$ gpg --import app/config/server.key
+$ passbolt server-key --fingerprint --domain=https://www.passbolt.test
 ```
 
 ## User config
@@ -145,14 +151,13 @@ Right now the basics, only authentication and read operations.
 
 
   Commands:
-
-    auth        Authentication actions, login or logout
-    get         View the OpenPGP data block of a given resource
-    find        Find one or more resources
-    keyring     Synchronize public keys
-    users       List all users
-    user        List information for a given user
-    help [cmd]  display help for [cmd]
+    auth           Authentication actions, login or logout
+    get            View the OpenPGP data block of a given resource
+    find           Find one or more resources
+    server-key     Fetch the server public key
+    users          List all users
+    user           View one user details
+    help [cmd]     display help for [cmd]
 
   Options:
 
@@ -193,6 +198,7 @@ ftp                             user                 ftp://192.168.1.1
 ...
 ```
 Your can select the columns you want to display using the `--columns` arguments.
+Non existing collumns will be ignored.
 
 ```
 $ passbolt find --columns=name,uuid
@@ -235,7 +241,7 @@ $ passbolt get $(passbolt find  | awk '/inkscape/ { print $NF }') | gpg -q --no-
 -q and --no-tty 
 ```
 are optional and ensures that only the password is printed.
-## Runnning the tests
+## Running the tests
 
 ```
 $ [sudo] npm install -g mocha

app/controllers/appController.js

@@ -1,8 +1,14 @@
 /**
- * Authentication Controller
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
  *
- * @copyright (c) 2019 Passbolt SA
- * @licence AGPL-3.0 http://www.gnu.org/licenses/agpl-3.0.en.html
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
  */
 const i18n = require('../models/i18n.js');
 const GpgAuthController = require('./gpgAuthController.js');

app/controllers/cliController.js

@@ -1,8 +1,14 @@
 /**
- * Command Line Interface Controller
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
  *
- * @copyright (c) 2019 Passbolt SA
- * @licence AGPL-3.0 http://www.gnu.org/licenses/agpl-3.0.en.html
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
  */
 const Controller = require('./controller.js');
 const prompt = require('prompt');
@@ -19,32 +25,6 @@ class CliController extends Controller {
     this._prompt.delimiter = ': ';
   }
 
-  /**
-   * Log a message in console
-   * @param msg
-   * @param priority
-   */
-  log(msg, priority) {
-    if (priority === undefined || (priority === 'verbose' && this._verbose)) {
-      console.log(msg);
-    }
-  }
-
-  /**
-   * Handle an error
-   * @param error
-   */
-  error(error) {
-    if (error instanceof Error) {
-      this.log(error.message);
-    } else if (typeof error === 'string') {
-      this.log(error);
-    } else {
-      this.log(error);
-    }
-    process.exit(1);
-  }
-
   /**
    * Capture data from command line
    * @param schema

app/controllers/controller.js

@@ -1,8 +1,14 @@
 /**
- * Controller
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
  *
- * @copyright (c) 2019 Passbolt SA
- * @licence AGPL-3.0 http://www.gnu.org/licenses/agpl-3.0.en.html
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
  */
 const i18n = require('../models/i18n.js');
 const Config = require('../models/config.js');
@@ -13,21 +19,10 @@ class Controller {
    * @param program
    */
   constructor(program) {
-    const config = Config.get();
     this._request = require('request');
-    this._agentOptions = config.agentOptions;
     this._verbose = (program !== undefined && program.verbose !== undefined && program.verbose);
-  }
-
-  /**
-   * Log a message in console
-   * @param msg
-   * @param priority
-   */
-  log(msg, priority) {
-    if (priority === undefined || (priority === 'verbose' && this._verbose)) {
-      console.log(msg);
-    }
+    const config = Config.get();
+    this._agentOptions = config.agentOptions;
   }
 
   /**
@@ -105,6 +100,51 @@ class Controller {
       }
     });
   }
+
+  /**
+   * Log a message in console
+   * @param msg
+   * @param priority
+   */
+  log(msg, priority) {
+    if (priority === undefined || (priority === 'verbose' && this._verbose)) {
+      console.log(msg);
+    }
+  }
+
+  /**
+   * Handle an error
+   * @param error
+   */
+  error(error) {
+    if (error instanceof Error) {
+      this.log(error.message);
+    } else if (typeof error === 'string') {
+      this.log(error);
+    } else {
+      this.log(error);
+    }
+    process.exit(1);
+  }
+
+  /**
+   * Server response handler
+   * @param response
+   * @returns {*}
+   * @private
+   */
+  _parseResponse(response) {
+    let body;
+    try {
+      // parse json body
+      body = JSON.parse(response.body);
+    } catch (syntaxError) {
+      this.log(response.body.toString(), 'verbose');
+      this.error(`${i18n.__('Error')} ${response.statusCode} ${i18n.__('could not parse server response.')}`);
+      return;
+    }
+    return body;
+  }
 }
 
 module.exports = Controller;

app/controllers/gpgAuthController.js

@@ -1,8 +1,14 @@
 /**
- * Authentication Controller
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
  *
- * @copyright (c) 2019 Passbolt SA
- * @licence AGPL-3.0 http://www.gnu.org/licenses/agpl-3.0.en.html
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
  */
 const MfaController = require('./mfaController.js');
 const Compat = require('../lib/phpjs.js');
@@ -19,7 +25,14 @@ class GpgAuthController extends MfaController {
    * Constructor
    */
   constructor(program) {
-    super(program);
+    try {
+      super(program);
+    } catch (error) {
+      console.error(error.message);
+      console.error('Make sure you created a valid configuration file in app/config/config.json.');
+      console.error('See app/config/config.default.json for an example.');
+      process.exit(1);
+    }
     try {
       this._parseProgramArg(program);
     } catch (e) {
@@ -48,6 +61,7 @@ class GpgAuthController extends MfaController {
    */
   async checkStatus() {
     if (this.force) {
+      this.log('Clearing cookies', 'verbose');
       this._clearCookie();
       return true;
     }

app/controllers/mfaController.js

@@ -1,8 +1,14 @@
 /**
- * Command Line Interface Controller
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
  *
- * @copyright (c) 2019 Passbolt SA
- * @licence AGPL-3.0 http://www.gnu.org/licenses/agpl-3.0.en.html
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
  */
 const CliController = require('./cliController.js');
 const Domain = require('../models/domain.js');

app/controllers/resourceController.js

@@ -1,8 +1,14 @@
 /**
- * Resource Controller
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) Passbolt SA (https://www.passbolt.com)
  *
- * @copyright (c) 2019 Passbolt SA
- * @licence AGPL-3.0 http://www.gnu.org/licenses/agpl-3.0.en.html
+ * Licensed under GNU Affero General Public License version 3 of the or any later version.
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
  */
 const AppController = require('./appController.js');