@zappinginc/zm2 6.0.14

package/lib/API/pm2-plus/PM2IO.js

@@ -0,0 +1,372 @@
+'use strict'
+
+var cst = require('../../../constants.js');
+const chalk = require('ansis');
+const path = require('path');
+const fs  = require('fs');
+const Table = require('cli-tableau');
+const pkg = require('../../../package.json')
+const IOAPI = require('@pm2/js-api')
+const promptly = require('promptly')
+var CLIStrategy = require('./auth-strategies/CliAuth')
+var WebStrategy = require('./auth-strategies/WebAuth')
+const exec = require('child_process').exec
+
+const OAUTH_CLIENT_ID_WEB = '138558311'
+const OAUTH_CLIENT_ID_CLI = '0943857435'
+
+module.exports = class PM2ioHandler {
+
+  static usePM2Client (instance) {
+    this.pm2 = instance
+  }
+
+  static strategy () {
+    switch (process.platform) {
+      case 'darwin': {
+        return new WebStrategy({
+          client_id: OAUTH_CLIENT_ID_WEB
+        })
+      }
+      case 'win32': {
+        return new WebStrategy({
+          client_id: OAUTH_CLIENT_ID_WEB
+        })
+      }
+      case 'linux': {
+        const isDesktop = process.env.XDG_CURRENT_DESKTOP || process.env.XDG_SESSION_DESKTOP || process.env.DISPLAY
+        const isSSH = process.env.SSH_TTY || process.env.SSH_CONNECTION
+        if (isDesktop && !isSSH) {
+          return new WebStrategy({
+            client_id: OAUTH_CLIENT_ID_WEB
+          })
+        } else {
+          return new CLIStrategy({
+            client_id: OAUTH_CLIENT_ID_CLI
+          })
+        }
+      }
+      default: {
+        return new CLIStrategy({
+          client_id: OAUTH_CLIENT_ID_CLI
+        })
+      }
+    }
+  }
+
+  static init () {
+    this._strategy = this.strategy()
+    /**
+     * If you are using a local backend you should give those options :
+     * {
+     *   services: {
+     *    API: 'http://localhost:3000',
+     *    OAUTH: 'http://localhost:3100'
+     *   }
+     *  }
+     */
+    this.io = new IOAPI().use(this._strategy)
+  }
+
+  static launch (command, opts) {
+    // first init the strategy and the io client
+    this.init()
+
+    switch (command) {
+      case 'connect' :
+      case 'login' :
+      case 'register' :
+      case undefined :
+      case 'authenticate' : {
+        this.authenticate()
+        break
+      }
+      case 'validate' : {
+        this.validateAccount(opts)
+        break
+      }
+      case 'help' :
+      case 'welcome': {
+        var dt = fs.readFileSync(path.join(__dirname, './pres/welcome'));
+        console.log(dt.toString());
+        return process.exit(0)
+      }
+      case 'logout': {
+        this._strategy.isAuthenticated().then(isConnected => {
+          // try to kill the agent anyway
+          this.pm2.killAgent(err => {})
+
+          if (isConnected === false) {
+            console.log(`${cst.PM2_IO_MSG} Already disconnected`)
+            return process.exit(0)
+          }
+
+          this._strategy._retrieveTokens((err, tokens) => {
+            if (err) {
+              console.log(`${cst.PM2_IO_MSG} Successfully disconnected`)
+              return process.exit(0)
+            }
+            this._strategy.deleteTokens(this.io).then(_ => {
+              console.log(`${cst.PM2_IO_MSG} Successfully disconnected`)
+              return process.exit(0)
+            }).catch(err => {
+              console.log(`${cst.PM2_IO_MSG_ERR} Unexpected error: ${err.message}`)
+              return process.exit(1)
+            })
+          })
+        }).catch(err => {
+          console.error(`${cst.PM2_IO_MSG_ERR} Failed to logout: ${err.message}`)
+          console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+        })
+        break
+      }
+      case 'create': {
+        this._strategy.isAuthenticated().then(res => {
+          // if the user isn't authenticated, we make them do the whole flow
+          if (res !== true) {
+            this.authenticate()
+          } else {
+            this.createBucket(this.createBucketHandler.bind(this))
+          }
+        }).catch(err => {
+          console.error(`${cst.PM2_IO_MSG_ERR} Failed to create to the bucket: ${err.message}`)
+          console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+        })
+        break
+      }
+      case 'web': {
+        this._strategy.isAuthenticated().then(res => {
+          // if the user isn't authenticated, we make them do the whole flow
+          if (res === false) {
+            console.error(`${cst.PM2_IO_MSG_ERR} You need to be authenticated to do that, please use: pm2 plus login`)
+            return process.exit(1)
+          }
+          this._strategy._retrieveTokens(() => {
+            return this.openUI()
+          })
+        }).catch(err => {
+          console.error(`${cst.PM2_IO_MSG_ERR} Failed to open the UI: ${err.message}`)
+          console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+        })
+        break
+      }
+      default : {
+        console.log(`${cst.PM2_IO_MSG_ERR} Invalid command ${command}, available : login,register,validate,connect or web`)
+        process.exit(1)
+      }
+    }
+  }
+
+  static openUI () {
+    this.io.bucket.retrieveAll().then(res => {
+      const buckets = res.data
+
+      if (buckets.length === 0) {
+        return this.createBucket((err, bucket) => {
+          if (err) {
+            console.error(`${cst.PM2_IO_MSG_ERR} Failed to connect to the bucket: ${err.message}`)
+            if (bucket) {
+              console.error(`${cst.PM2_IO_MSG_ERR} You can retry using: pm2 plus link ${bucket.secret_id} ${bucket.public_id}`)
+            }
+            console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+            return process.exit(0)
+          }
+          const targetURL = `https://app.pm2.io/#/bucket/${bucket._id}`
+          console.log(`${cst.PM2_IO_MSG} Please follow the popup or go to this URL :`, '\n', '    ', targetURL)
+          this.open(targetURL)
+          return process.exit(0)
+        })
+      }
+
+      var table = new Table({
+        style : {'padding-left' : 1, head : ['cyan', 'bold'], compact : true},
+        head : ['Bucket name', 'Plan type']
+      })
+
+      buckets.forEach(function(bucket) {
+        table.push([bucket.name, bucket.credits.offer_type])
+      })
+      console.log(table.toString())
+      console.log(`${cst.PM2_IO_MSG} If you don't want to open the UI to a bucket, type 'none'`)
+
+      const choices = buckets.map(bucket => bucket.name)
+      choices.push('none')
+
+      promptly.choose(`${cst.PM2_IO_MSG} Type the name of the bucket you want to connect to :`, choices, (err, value) => {
+        if (value === 'none') process.exit(0)
+
+        const bucket = buckets.find(bucket => bucket.name === value)
+        if (bucket === undefined) return process.exit(0)
+
+        const targetURL = `https://app.pm2.io/#/bucket/${bucket._id}`
+        console.log(`${cst.PM2_IO_MSG} Please follow the popup or go to this URL :`, '\n', '    ', targetURL)
+        this.open(targetURL)
+        return process.exit(0)
+      })
+    })
+  }
+
+  static validateAccount (token) {
+    this.io.auth.validEmail(token)
+      .then(res => {
+        console.log(`${cst.PM2_IO_MSG} Email succesfully validated.`)
+        console.log(`${cst.PM2_IO_MSG} You can now proceed and use: pm2 plus connect`)
+        return process.exit(0)
+      }).catch(err => {
+        if (err.status === 401) {
+          console.error(`${cst.PM2_IO_MSG_ERR} Invalid token`)
+          return process.exit(1)
+        } else if (err.status === 301) {
+          console.log(`${cst.PM2_IO_MSG} Email succesfully validated.`)
+          console.log(`${cst.PM2_IO_MSG} You can now proceed and use: pm2 plus connect`)
+          return process.exit(0)
+        }
+        const msg = err.data ? err.data.error_description || err.data.msg : err.message
+        console.error(`${cst.PM2_IO_MSG_ERR} Failed to validate your email: ${msg}`)
+        console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+        return process.exit(1)
+      })
+  }
+
+  static createBucketHandler (err, bucket) {
+    if (err) {
+      console.trace(`${cst.PM2_IO_MSG_ERR} Failed to connect to the bucket: ${err.message}`)
+      if (bucket) {
+        console.error(`${cst.PM2_IO_MSG_ERR} You can retry using: pm2 plus link ${bucket.secret_id} ${bucket.public_id}`)
+      }
+      console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+      return process.exit(0)
+    }
+    if (bucket === undefined) {
+      return process.exit(0)
+    }
+    console.log(`${cst.PM2_IO_MSG} Successfully connected to bucket ${bucket.name}`)
+    var targetURL = `https://app.pm2.io/#/bucket/${bucket._id}`
+    console.log(`${cst.PM2_IO_MSG} You can use the web interface over there: ${targetURL}`)
+    this.open(targetURL)
+    return process.exit(0)
+  }
+
+  static createBucket (cb) {
+    console.log(`${cst.PM2_IO_MSG} By default we allow you to trial PM2 Plus for 14 days without any credit card.`)
+
+    this.io.bucket.create({
+      name: 'PM2 Plus Monitoring'
+    }).then(res => {
+      const bucket = res.data.bucket
+
+      console.log(`${cst.PM2_IO_MSG} Successfully created the bucket`)
+      this.pm2.link({
+        public_key: bucket.public_id,
+        secret_key: bucket.secret_id,
+        pm2_version: pkg.version
+      }, (err) => {
+        if (err) {
+          return cb(new Error('Failed to connect your local PM2 to your bucket'), bucket)
+        } else {
+          return cb(null, bucket)
+        }
+      })
+    }).catch(err => {
+      return cb(new Error(`Failed to create a bucket: ${err.message}`))
+    })
+  }
+
+  /**
+   * Connect the local agent to a specific bucket
+   * @param {Function} cb
+   */
+  static connectToBucket (cb) {
+    this.io.bucket.retrieveAll().then(res => {
+      const buckets = res.data
+
+      if (buckets.length === 0) {
+        return this.createBucket(cb)
+      }
+
+      var table = new Table({
+        style : {'padding-left' : 1, head : ['cyan', 'bold'], compact : true},
+        head : ['Bucket name', 'Plan type']
+      })
+
+      buckets.forEach(function(bucket) {
+        table.push([bucket.name, bucket.payment.offer_type])
+      })
+      console.log(table.toString())
+      console.log(`${cst.PM2_IO_MSG} If you don't want to connect to a bucket, type 'none'`)
+
+      const choices = buckets.map(bucket => bucket.name)
+      choices.push('none')
+
+      promptly.choose(`${cst.PM2_IO_MSG} Type the name of the bucket you want to connect to :`, choices, (err, value) => {
+        if (value === 'none') return cb()
+
+        const bucket = buckets.find(bucket => bucket.name === value)
+        if (bucket === undefined) return cb()
+        this.pm2.link({
+          public_key: bucket.public_id,
+          secret_key: bucket.secret_id,
+          pm2_version: pkg.version
+        }, (err) => {
+          return err ? cb(err) : cb(null, bucket)
+        })
+      })
+    })
+  }
+
+  /**
+   * Authenticate the user with either of the strategy
+   * @param {Function} cb
+   */
+  static authenticate () {
+    this._strategy._retrieveTokens((err, tokens) => {
+      if (err) {
+        const msg = err.data ? err.data.error_description || err.data.msg : err.message
+        console.log(`${cst.PM2_IO_MSG_ERR} Unexpected error : ${msg}`)
+        return process.exit(1)
+      }
+      console.log(`${cst.PM2_IO_MSG} Successfully authenticated`)
+      this.io.user.retrieve().then(res => {
+        const user = res.data
+
+        this.io.user.retrieve().then(res => {
+          const tmpUser = res.data
+          console.log(`${cst.PM2_IO_MSG} Successfully validated`)
+          this.connectToBucket(this.createBucketHandler.bind(this))
+        })
+      })
+    })
+  }
+
+  static open (target, appName, callback) {
+    let opener
+    const escape = function (s) {
+      return s.replace(/"/g, '\\"')
+    }
+
+    if (typeof (appName) === 'function') {
+      callback = appName
+      appName = null
+    }
+
+    switch (process.platform) {
+      case 'darwin': {
+        opener = appName ? `open -a "${escape(appName)}"` : `open`
+        break
+      }
+      case 'win32': {
+        opener = appName ? `start "" ${escape(appName)}"` : `start ""`
+        break
+      }
+      default: {
+        opener = appName ? escape(appName) : `xdg-open`
+        break
+      }
+    }
+
+    if (process.env.SUDO_USER) {
+      opener = 'sudo -u ' + process.env.SUDO_USER + ' ' + opener
+    }
+    return exec(`${opener} "${escape(target)}"`, callback)
+  }
+}

package/lib/API/pm2-plus/auth-strategies/CliAuth.js

@@ -0,0 +1,288 @@
+'use strict'
+
+const AuthStrategy = require('@pm2/js-api/src/auth_strategies/strategy')
+const querystring = require('querystring');
+
+const http = require('http')
+const fs = require('fs')
+const url = require('url')
+const exec = require('child_process').exec
+const tryEach = require('async/tryEach')
+const path = require('path')
+const os = require('os')
+const needle = require('needle')
+const chalk = require('ansis')
+const cst = require('../../../../constants.js')
+const promptly = require('promptly')
+
+module.exports = class CliStrategy extends AuthStrategy {
+  // the client will try to call this but we handle this part ourselves
+  retrieveTokens (km, cb) {
+    this.authenticated = false
+    this.callback = cb
+    this.km = km
+    this.BASE_URI = 'https://id.keymetrics.io';
+  }
+
+  // so the cli know if we need to tell user to login/register
+  isAuthenticated () {
+    return new Promise((resolve, reject) => {
+      if (this.authenticated) return resolve(true)
+
+      let tokensPath = cst.PM2_IO_ACCESS_TOKEN
+      fs.readFile(tokensPath, (err, tokens) => {
+        if (err && err.code === 'ENOENT') return resolve(false)
+        if (err) return reject(err)
+
+        // verify that the token is valid
+        try {
+          tokens = JSON.parse(tokens || '{}')
+        } catch (err) {
+          fs.unlinkSync(tokensPath)
+          return resolve(false)
+        }
+
+        // if the refresh tokens is here, the user could be automatically authenticated
+        return resolve(typeof tokens.refresh_token === 'string')
+      })
+    })
+  }
+
+  verifyToken (refresh) {
+    return this.km.auth.retrieveToken({
+      client_id: this.client_id,
+      refresh_token: refresh
+    })
+  }
+
+  // called when we are sure the user asked to be logged in
+  _retrieveTokens (optionalCallback) {
+    const km = this.km
+    const cb = this.callback
+
+    tryEach([
+      // try to find the token via the environment
+      (next) => {
+        if (!process.env.PM2_IO_TOKEN) {
+          return next(new Error('No token in env'))
+        }
+        this.verifyToken(process.env.PM2_IO_TOKEN)
+          .then((res) => {
+            return next(null, res.data)
+          }).catch(next)
+      },
+      // try to find it in the file system
+      (next) => {
+        fs.readFile(cst.PM2_IO_ACCESS_TOKEN, (err, tokens) => {
+          if (err) return next(err)
+          // verify that the token is valid
+          tokens = JSON.parse(tokens || '{}')
+          if (new Date(tokens.expire_at) > new Date(new Date().toISOString())) {
+            return next(null, tokens)
+          }
+
+          this.verifyToken(tokens.refresh_token)
+            .then((res) => {
+              return next(null, res.data)
+            }).catch(next)
+        })
+      },
+      // otherwise make the whole flow
+      (next) => {
+        return this.authenticate((err, data) => {
+          if (err instanceof Error) return next(err)
+          // verify that the token is valid
+          this.verifyToken(data.refresh_token)
+            .then((res) => {
+              return next(null, res.data)
+            }).catch(next)
+        })
+      }
+    ], (err, result) => {
+      // if present run the optional callback
+      if (typeof optionalCallback === 'function') {
+        optionalCallback(err, result)
+      }
+
+      if (result.refresh_token) {
+        this.authenticated = true
+        let file = cst.PM2_IO_ACCESS_TOKEN
+        fs.writeFile(file, JSON.stringify(result), () => {
+          return cb(err, result)
+        })
+      } else {
+        return cb(err, result)
+      }
+    })
+  }
+
+  authenticate (cb) {
+    console.log(`${cst.PM2_IO_MSG} Using non-browser authentication.`)
+    promptly.confirm(`${cst.PM2_IO_MSG} Do you have a pm2.io account? (y/n)`, (err, answer) => {
+      // Either login or register
+      return answer === true ? this.login(cb) : this.register(cb)
+    })
+  }
+
+  login (cb) {
+    let retry = () => {
+      promptly.prompt(`${cst.PM2_IO_MSG} Your username or email: `, (err, username) => {
+        if (err) return retry();
+
+        promptly.password(`${cst.PM2_IO_MSG} Your password: `, { replace : '*' }, (err, password) => {
+          if (err) return retry();
+
+          console.log(`${cst.PM2_IO_MSG} Authenticating ...`)
+          this._loginUser({
+            username: username,
+            password: password
+          }, (err, data) => {
+            if (err) {
+              console.error(`${cst.PM2_IO_MSG_ERR} Failed to authenticate: ${err.message}`)
+              return retry()
+            }
+            return cb(null, data)
+          })
+        })
+      })
+    }
+
+    retry()
+  }
+
+  register (cb) {
+    console.log(`${cst.PM2_IO_MSG} No problem ! We just need few informations to create your account`)
+
+    var retry = () => {
+      promptly.prompt(`${cst.PM2_IO_MSG} Please choose an username :`, {
+        validator : this._validateUsername,
+        retry : true
+      }, (err, username) => {
+        promptly.prompt(`${cst.PM2_IO_MSG} Please choose an email :`, {
+          validator : this._validateEmail,
+          retry : true
+        },(err, email) => {
+          promptly.password(`${cst.PM2_IO_MSG} Please choose a password :`, { replace : '*' }, (err, password) => {
+            promptly.confirm(`${cst.PM2_IO_MSG} Do you accept the terms and privacy policy (https://pm2.io/legals/terms_conditions.pdf) ?  (y/n)`, (err, answer) => {
+              if (err) {
+                console.error(chalk.bold.red(err));
+                return retry()
+              } else if (answer === false) {
+                console.error(`${cst.PM2_IO_MSG_ERR} You must accept the terms and privacy policy to contiue.`)
+                return retry()
+              }
+
+              this._registerUser({
+                email : email,
+                password : password,
+                username : username
+              }, (err, data) => {
+                console.log('\n')
+                if (err) {
+                  console.error(`${cst.PM2_IO_MSG_ERR} Unexpect error: ${err.message}`)
+                  console.error(`${cst.PM2_IO_MSG_ERR} You can also contact us to get help: contact@pm2.io`)
+                  return process.exit(1)
+                }
+                return cb(undefined, data)
+              })
+            })
+          })
+        })
+      })
+    }
+    retry()
+  }
+
+  /**
+   * Register function
+   * @param opts.username
+   * @param opts.password
+   * @param opts.email
+   */
+  _registerUser (opts, cb) {
+    const data = Object.assign(opts, {
+      password_confirmation: opts.password,
+      accept_terms: true
+    })
+    needle.post(this.BASE_URI + '/api/oauth/register', data, {
+      json: true,
+      headers: {
+        'X-Register-Provider': 'pm2-register',
+        'x-client-id': this.client_id
+      }
+    }, function (err, res, body) {
+      if (err) return cb(err)
+      if (body.email && body.email.message) return cb(new Error(body.email.message))
+      if (body.username && body.username.message) return cb(new Error(body.username.message))
+      if (!body.access_token) return cb(new Error(body.msg))
+
+      return cb(null, {
+        refresh_token : body.refresh_token.token,
+        access_token : body.access_token.token
+      })
+    });
+  }
+
+  _loginUser (user_info, cb) {
+    const URL_AUTH = '/api/oauth/authorize?response_type=token&scope=all&client_id=' +
+            this.client_id + '&redirect_uri=http://localhost:43532';
+
+    needle.get(this.BASE_URI + URL_AUTH, (err, res) => {
+      if (err) return cb(err);
+
+      var cookie = res.cookies;
+
+      needle.post(this.BASE_URI + '/api/oauth/login', user_info, {
+        cookies : cookie
+      }, (err, resp, body) => {
+        if (err) return cb(err)
+        if (resp.statusCode != 200) return cb('Wrong credentials')
+
+        var location = resp.headers['x-redirect']
+
+        needle.get(this.BASE_URI + location, {
+          cookies : cookie
+        }, (err, res) => {
+          if (err) return cb(err);
+          var refresh_token = querystring.parse(url.parse(res.headers.location).query).access_token;
+          needle.post(this.BASE_URI + '/api/oauth/token', {
+            client_id : this.client_id,
+            grant_type : 'refresh_token',
+            refresh_token : refresh_token,
+            scope : 'all'
+          }, (err, res, body) => {
+            if (err) return cb(err)
+            return cb(null, body)
+          })
+        })
+      })
+    })
+  }
+
+  _validateEmail (email) {
+    var re = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
+    if (re.test(email) == false)
+      throw new Error('Not an email');
+    return email;
+  }
+
+  _validateUsername (value) {
+    if (value.length < 6) {
+      throw new Error('Min length of 6');
+    }
+    return value;
+  };
+
+  deleteTokens (km) {
+    return new Promise((resolve, reject) => {
+      // revoke the refreshToken
+      km.auth.revoke()
+        .then(res => {
+          // remove the token from the filesystem
+          let file = cst.PM2_IO_ACCESS_TOKEN
+          fs.unlinkSync(file)
+          return resolve(res)
+        }).catch(reject)
+    })
+  }
+}