server/tools/peertube-auth.ts

   1 import * as program from 'commander'
   2 import * as prompt from 'prompt'
   3 import { getSettings, writeSettings, getNetrc } from './cli'
   4 import { isHostValid } from '../helpers/custom-validators/servers'
   5 import { isUserUsernameValid } from '../helpers/custom-validators/users'
   6
   7 const Table = require('cli-table')
   8
   9 async function delInstance (url: string) {
  10   const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
  11
  12   const index = settings.remotes.indexOf(url)
  13   settings.remotes.splice(index)
  14
  15   if (settings.default === index) settings.default = -1
  16
  17   await writeSettings(settings)
  18
  19   delete netrc.machines[url]
  20
  21   await netrc.save()
  22 }
  23
  24 async function setInstance (url: string, username: string, password: string, isDefault: boolean) {
  25   const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
  26
  27   if (settings.remotes.indexOf(url) === -1) {
  28     settings.remotes.push(url)
  29   }
  30
  31   if (isDefault || settings.remotes.length === 1) {
  32     settings.default = settings.remotes.length - 1
  33   }
  34
  35   await writeSettings(settings)
  36
  37   netrc.machines[url] = { login: username, password }
  38   await netrc.save()
  39 }
  40
  41 function isURLaPeerTubeInstance (url: string) {
  42   return isHostValid(url) || (url.includes('localhost'))
  43 }
  44
  45 program
  46   .name('auth')
  47   .usage('[command] [options]')
  48
  49 program
  50   .command('add')
  51   .description('remember your accounts on remote instances for easier use')
  52   .option('-u, --url <url>', 'Server url')
  53   .option('-U, --username <username>', 'Username')
  54   .option('-p, --password <token>', 'Password')
  55   .option('--default', 'add the entry as the new default')
  56   .action(options => {
  57     prompt.override = options
  58     prompt.start()
  59     prompt.get({
  60       properties: {
  61         url: {
  62           description: 'instance url',
  63           conform: (value) => isURLaPeerTubeInstance(value),
  64           required: true
  65         },
  66         username: {
  67           conform: (value) => isUserUsernameValid(value),
  68           message: 'Name must be only letters, spaces, or dashes',
  69           required: true
  70         },
  71         password: {
  72           hidden: true,
  73           replace: '*',
  74           required: true
  75         }
  76       }
  77     }, async (_, result) => {
  78       await setInstance(result.url, result.username, result.password, program['default'])
  79
  80       process.exit(0)
  81     })
  82   })
  83
  84 program
  85   .command('del <url>')
  86   .description('unregisters a remote instance')
  87   .action(async url => {
  88     await delInstance(url)
  89
  90     process.exit(0)
  91   })
  92
  93 program
  94   .command('list')
  95   .description('lists registered remote instances')
  96   .action(async () => {
  97     const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
  98
  99     const table = new Table({
 100       head: ['instance', 'login'],
 101       colWidths: [30, 30]
 102     })
 103
 104     settings.remotes.forEach(element => {
 105       if (!netrc.machines[element]) return
 106
 107       table.push([
 108         element,
 109         netrc.machines[element].login
 110       ])
 111     })
 112
 113     console.log(table.toString())
 114
 115     process.exit(0)
 116   })
 117
 118 program
 119   .command('set-default <url>')
 120   .description('set an existing entry as default')
 121   .action(async url => {
 122     const settings = await getSettings()
 123     const instanceExists = settings.remotes.indexOf(url) !== -1
 124
 125     if (instanceExists) {
 126       settings.default = settings.remotes.indexOf(url)
 127       await writeSettings(settings)
 128
 129       process.exit(0)
 130     } else {
 131       console.log('<url> is not a registered instance.')
 132       process.exit(-1)
 133     }
 134   })
 135
 136 program.on('--help', function () {
 137   console.log('  Examples:')
 138   console.log()
 139   console.log('    $ peertube add -u peertube.cpy.re -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD"')
 140   console.log('    $ peertube add -u peertube.cpy.re -U root')
 141   console.log('    $ peertube list')
 142   console.log('    $ peertube del peertube.cpy.re')
 143   console.log()
 144 })
 145
 146 if (!process.argv.slice(2).length) {
 147   program.outputHelp()
 148 }
 149
 150 program.parse(process.argv)