server/tools/peertube-auth.ts

   1 // eslint-disable @typescript-eslint/no-unnecessary-type-assertion
   2
   3 import { registerTSPaths } from '../helpers/register-ts-paths'
   4 registerTSPaths()
   5
   6 import { OptionValues, program } from 'commander'
   7 import * as prompt from 'prompt'
   8 import { assignToken, buildServer, getNetrc, getSettings, writeSettings } from './cli'
   9 import { isUserUsernameValid } from '../helpers/custom-validators/users'
  10 import * as CliTable3 from 'cli-table3'
  11
  12 async function delInstance (url: string) {
  13   const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
  14
  15   const index = settings.remotes.indexOf(url)
  16   settings.remotes.splice(index)
  17
  18   if (settings.default === index) settings.default = -1
  19
  20   await writeSettings(settings)
  21
  22   delete netrc.machines[url]
  23
  24   await netrc.save()
  25 }
  26
  27 async function setInstance (url: string, username: string, password: string, isDefault: boolean) {
  28   const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
  29
  30   if (settings.remotes.includes(url) === false) {
  31     settings.remotes.push(url)
  32   }
  33
  34   if (isDefault || settings.remotes.length === 1) {
  35     settings.default = settings.remotes.length - 1
  36   }
  37
  38   await writeSettings(settings)
  39
  40   netrc.machines[url] = { login: username, password }
  41   await netrc.save()
  42 }
  43
  44 function isURLaPeerTubeInstance (url: string) {
  45   return url.startsWith('http://') || url.startsWith('https://')
  46 }
  47
  48 function stripExtraneousFromPeerTubeUrl (url: string) {
  49   // Get everything before the 3rd /.
  50   const urlLength = url.includes('/', 8)
  51     ? url.indexOf('/', 8)
  52     : url.length
  53
  54   return url.substr(0, urlLength)
  55 }
  56
  57 program
  58   .name('auth')
  59   .usage('[command] [options]')
  60
  61 program
  62   .command('add')
  63   .description('remember your accounts on remote instances for easier use')
  64   .option('-u, --url <url>', 'Server url')
  65   .option('-U, --username <username>', 'Username')
  66   .option('-p, --password <token>', 'Password')
  67   .option('--default', 'add the entry as the new default')
  68   .action((options: OptionValues) => {
  69     /* eslint-disable no-import-assign */
  70     prompt.override = options
  71     prompt.start()
  72     prompt.get({
  73       properties: {
  74         url: {
  75           description: 'instance url',
  76           conform: (value) => isURLaPeerTubeInstance(value),
  77           message: 'It should be an URL (https://peertube.example.com)',
  78           required: true
  79         },
  80         username: {
  81           conform: (value) => isUserUsernameValid(value),
  82           message: 'Name must be only letters, spaces, or dashes',
  83           required: true
  84         },
  85         password: {
  86           hidden: true,
  87           replace: '*',
  88           required: true
  89         }
  90       }
  91     }, async (_, result) => {
  92
  93       // Check credentials
  94       try {
  95         // Strip out everything after the domain:port.
  96         // @see https://github.com/Chocobozzz/PeerTube/issues/3520
  97         result.url = stripExtraneousFromPeerTubeUrl(result.url)
  98
  99         const server = buildServer(result.url)
 100         await assignToken(server, result.username, result.password)
 101       } catch (err) {
 102         console.error(err.message)
 103         process.exit(-1)
 104       }
 105
 106       await setInstance(result.url, result.username, result.password, options.default)
 107
 108       process.exit(0)
 109     })
 110   })
 111
 112 program
 113   .command('del <url>')
 114   .description('unregisters a remote instance')
 115   .action(async url => {
 116     await delInstance(url)
 117
 118     process.exit(0)
 119   })
 120
 121 program
 122   .command('list')
 123   .description('lists registered remote instances')
 124   .action(async () => {
 125     const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
 126
 127     const table = new CliTable3({
 128       head: [ 'instance', 'login' ],
 129       colWidths: [ 30, 30 ]
 130     }) as any
 131
 132     settings.remotes.forEach(element => {
 133       if (!netrc.machines[element]) return
 134
 135       table.push([
 136         element,
 137         netrc.machines[element].login
 138       ])
 139     })
 140
 141     console.log(table.toString())
 142
 143     process.exit(0)
 144   })
 145
 146 program
 147   .command('set-default <url>')
 148   .description('set an existing entry as default')
 149   .action(async url => {
 150     const settings = await getSettings()
 151     const instanceExists = settings.remotes.includes(url)
 152
 153     if (instanceExists) {
 154       settings.default = settings.remotes.indexOf(url)
 155       await writeSettings(settings)
 156
 157       process.exit(0)
 158     } else {
 159       console.log('<url> is not a registered instance.')
 160       process.exit(-1)
 161     }
 162   })
 163
 164 program.addHelpText('after', '\n\n  Examples:\n\n' +
 165   '    $ peertube auth add -u https://peertube.cpy.re -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD"\n' +
 166   '    $ peertube auth add -u https://peertube.cpy.re -U root\n' +
 167   '    $ peertube auth list\n' +
 168   '    $ peertube auth del https://peertube.cpy.re\n'
 169 )
 170
 171 if (!process.argv.slice(2).length) {
 172   program.outputHelp()
 173 }
 174
 175 program.parse(process.argv)