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