PeerTube/server/tools/peertube-auth.ts

172 lines
4.5 KiB
TypeScript
Raw Normal View History

import CliTable3 from 'cli-table3'
2021-06-25 17:48:27 +02:00
import { OptionValues, program } from 'commander'
import { isUserUsernameValid } from '../helpers/custom-validators/users'
import { assignToken, buildServer, getNetrc, getSettings, writeSettings } from './shared'
2021-08-27 14:32:44 +02:00
import prompt = require('prompt')
2018-11-14 15:45:50 +01:00
async function delInstance (url: string) {
const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
2018-11-14 15:45:50 +01:00
2019-06-13 11:09:38 +02:00
const index = settings.remotes.indexOf(url)
settings.remotes.splice(index)
if (settings.default === index) settings.default = -1
2018-11-14 15:45:50 +01:00
await writeSettings(settings)
delete netrc.machines[url]
2018-11-14 15:45:50 +01:00
await netrc.save()
}
2019-06-13 11:09:38 +02:00
async function setInstance (url: string, username: string, password: string, isDefault: boolean) {
const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
2020-06-17 10:55:40 +02:00
if (settings.remotes.includes(url) === false) {
2018-11-14 15:45:50 +01:00
settings.remotes.push(url)
}
2019-06-13 11:09:38 +02:00
if (isDefault || settings.remotes.length === 1) {
settings.default = settings.remotes.length - 1
}
2018-11-14 15:45:50 +01:00
await writeSettings(settings)
netrc.machines[url] = { login: username, password }
await netrc.save()
}
function isURLaPeerTubeInstance (url: string) {
return url.startsWith('http://') || url.startsWith('https://')
}
2020-12-30 11:26:24 +01:00
function stripExtraneousFromPeerTubeUrl (url: string) {
// Get everything before the 3rd /.
const urlLength = url.includes('/', 8)
? url.indexOf('/', 8)
: url.length
2022-01-20 09:33:49 +01:00
return url.substring(0, urlLength)
2020-12-30 11:26:24 +01:00
}
program
.name('auth')
.usage('[command] [options]')
program
.command('add')
.description('remember your accounts on remote instances for easier use')
.option('-u, --url <url>', 'Server url')
.option('-U, --username <username>', 'Username')
.option('-p, --password <token>', 'Password')
.option('--default', 'add the entry as the new default')
2021-06-25 17:48:27 +02:00
.action((options: OptionValues) => {
2021-02-03 09:33:05 +01:00
/* eslint-disable no-import-assign */
prompt.override = options
prompt.start()
prompt.get({
properties: {
url: {
description: 'instance url',
conform: (value) => isURLaPeerTubeInstance(value),
message: 'It should be an URL (https://peertube.example.com)',
required: true
},
username: {
conform: (value) => isUserUsernameValid(value),
message: 'Name must be only letters, spaces, or dashes',
required: true
},
password: {
hidden: true,
replace: '*',
required: true
}
}
2018-11-14 15:45:50 +01:00
}, async (_, result) => {
// Check credentials
try {
// Strip out everything after the domain:port.
2022-01-20 09:33:49 +01:00
// See https://github.com/Chocobozzz/PeerTube/issues/3520
result.url = stripExtraneousFromPeerTubeUrl(result.url)
2021-07-13 11:44:16 +02:00
const server = buildServer(result.url)
await assignToken(server, result.username, result.password)
} catch (err) {
console.error(err.message)
process.exit(-1)
}
2021-02-03 09:33:05 +01:00
await setInstance(result.url, result.username, result.password, options.default)
2018-11-14 15:45:50 +01:00
process.exit(0)
})
})
program
.command('del <url>')
.description('unregisters a remote instance')
2018-11-14 15:45:50 +01:00
.action(async url => {
await delInstance(url)
process.exit(0)
})
program
.command('list')
.description('lists registered remote instances')
2018-11-14 15:45:50 +01:00
.action(async () => {
const [ settings, netrc ] = await Promise.all([ getSettings(), getNetrc() ])
2020-01-28 11:07:23 +01:00
const table = new CliTable3({
2020-01-31 16:56:52 +01:00
head: [ 'instance', 'login' ],
colWidths: [ 30, 30 ]
}) as any
2018-11-14 15:45:50 +01:00
settings.remotes.forEach(element => {
2019-06-11 09:25:20 +02:00
if (!netrc.machines[element]) return
2018-11-14 15:45:50 +01:00
table.push([
element,
netrc.machines[element].login
])
})
console.log(table.toString())
process.exit(0)
})
program
.command('set-default <url>')
.description('set an existing entry as default')
2018-11-14 15:45:50 +01:00
.action(async url => {
const settings = await getSettings()
2020-02-28 16:03:39 +01:00
const instanceExists = settings.remotes.includes(url)
2018-11-14 15:45:50 +01:00
if (instanceExists) {
settings.default = settings.remotes.indexOf(url)
await writeSettings(settings)
process.exit(0)
} else {
console.log('<url> is not a registered instance.')
process.exit(-1)
}
})
2021-02-03 09:33:05 +01:00
program.addHelpText('after', '\n\n Examples:\n\n' +
' $ peertube auth add -u https://peertube.cpy.re -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD"\n' +
' $ peertube auth add -u https://peertube.cpy.re -U root\n' +
' $ peertube auth list\n' +
' $ peertube auth del https://peertube.cpy.re\n'
)
if (!process.argv.slice(2).length) {
program.outputHelp()
}
program.parse(process.argv)