File: //usr/share/nodejs/npm/lib/profile.js
const inspect = require('util').inspect
const { URL } = require('url')
const ansistyles = require('ansistyles')
const log = require('npmlog')
const npmProfile = require('npm-profile')
const qrcodeTerminal = require('qrcode-terminal')
const Table = require('cli-table3')
const npm = require('./npm.js')
const otplease = require('./utils/otplease.js')
const output = require('./utils/output.js')
const pulseTillDone = require('./utils/pulse-till-done.js')
const readUserInfo = require('./utils/read-user-info.js')
const usageUtil = require('./utils/usage.js')
const usage = usageUtil(
'npm profile enable-2fa [auth-only|auth-and-writes]\n',
'npm profile disable-2fa\n',
'npm profile get [<key>]\n',
'npm profile set <key> <value>'
)
const completion = (opts, cb) => {
var argv = opts.conf.argv.remain
const subcommands = ['enable-2fa', 'disable-2fa', 'get', 'set']
if (!argv[2])
return cb(null, subcommands)
switch (argv[2]) {
case 'enable-2fa':
case 'enable-tfa':
return cb(null, ['auth-and-writes', 'auth-only'])
case 'disable-2fa':
case 'disable-tfa':
case 'get':
case 'set':
return cb(null, [])
default:
return cb(new Error(argv[2] + ' not recognized'))
}
}
const cmd = (args, cb) => profile(args).then(() => cb()).catch(cb)
const profile = async (args) => {
if (args.length === 0)
throw new Error(usage)
log.gauge.show('profile')
const [subcmd, ...opts] = args
switch (subcmd) {
case 'enable-2fa':
case 'enable-tfa':
case 'enable2fa':
case 'enabletfa':
return enable2fa(opts)
case 'disable-2fa':
case 'disable-tfa':
case 'disable2fa':
case 'disabletfa':
return disable2fa()
case 'get':
return get(opts)
case 'set':
return set(opts)
default:
throw new Error('Unknown profile command: ' + subcmd)
}
}
const knownProfileKeys = [
'name',
'email',
'two-factor auth',
'fullname',
'homepage',
'freenode',
'twitter',
'github',
'created',
'updated',
]
const get = async args => {
const tfa = 'two-factor auth'
const conf = { ...npm.flatOptions }
const info = await pulseTillDone.withPromise(npmProfile.get(conf))
if (!info.cidr_whitelist)
delete info.cidr_whitelist
if (conf.json) {
output(JSON.stringify(info, null, 2))
return
}
// clean up and format key/values for output
const cleaned = {}
for (const key of knownProfileKeys)
cleaned[key] = info[key] || ''
const unknownProfileKeys = Object.keys(info).filter((k) => !(k in cleaned))
for (const key of unknownProfileKeys)
cleaned[key] = info[key] || ''
delete cleaned.tfa
delete cleaned.email_verified
cleaned.email += info.email_verified ? ' (verified)' : '(unverified)'
if (info.tfa && !info.tfa.pending)
cleaned[tfa] = info.tfa.mode
else
cleaned[tfa] = 'disabled'
if (args.length) {
const values = args // comma or space separated
.join(',')
.split(/,/)
.filter((arg) => arg.trim() !== '')
.map((arg) => cleaned[arg])
.join('\t')
output(values)
} else {
if (conf.parseable) {
for (const key of Object.keys(info)) {
if (key === 'tfa')
output(`${key}\t${cleaned[tfa]}`)
else
output(`${key}\t${info[key]}`)
}
} else {
const table = new Table()
for (const key of Object.keys(cleaned))
table.push({ [ansistyles.bright(key)]: cleaned[key] })
output(table.toString())
}
}
}
const writableProfileKeys = [
'email',
'password',
'fullname',
'homepage',
'freenode',
'twitter',
'github',
]
const set = async (args) => {
const conf = { ...npm.flatOptions }
const prop = (args[0] || '').toLowerCase().trim()
let value = args.length > 1 ? args.slice(1).join(' ') : null
const readPasswords = async () => {
const newpassword = await readUserInfo.password('New password: ')
const confirmedpassword = await readUserInfo.password(' Again: ')
if (newpassword !== confirmedpassword) {
log.warn('profile', 'Passwords do not match, please try again.')
return readPasswords()
}
return newpassword
}
if (prop !== 'password' && value === null)
throw new Error('npm profile set <prop> <value>')
if (prop === 'password' && value !== null) {
throw new Error(
'npm profile set password\n' +
'Do not include your current or new passwords on the command line.')
}
if (writableProfileKeys.indexOf(prop) === -1) {
throw new Error(`"${prop}" is not a property we can set. ` +
`Valid properties are: ` + writableProfileKeys.join(', '))
}
if (prop === 'password') {
const current = await readUserInfo.password('Current password: ')
const newpassword = await readPasswords()
value = { old: current, new: newpassword }
}
// FIXME: Work around to not clear everything other than what we're setting
const user = await pulseTillDone.withPromise(npmProfile.get(conf))
const newUser = {}
for (const key of writableProfileKeys)
newUser[key] = user[key]
newUser[prop] = value
const result = await otplease(conf, conf => npmProfile.set(newUser, conf))
if (conf.json)
output(JSON.stringify({ [prop]: result[prop] }, null, 2))
else if (conf.parseable)
output(prop + '\t' + result[prop])
else if (result[prop] != null)
output('Set', prop, 'to', result[prop])
else
output('Set', prop)
}
const enable2fa = async (args) => {
if (args.length > 1)
throw new Error('npm profile enable-2fa [auth-and-writes|auth-only]')
const mode = args[0] || 'auth-and-writes'
if (mode !== 'auth-only' && mode !== 'auth-and-writes') {
throw new Error(
`Invalid two-factor authentication mode "${mode}".\n` +
'Valid modes are:\n' +
' auth-only - Require two-factor authentication only when logging in\n' +
' auth-and-writes - Require two-factor authentication when logging in ' +
'AND when publishing'
)
}
const conf = { ...npm.flatOptions }
if (conf.json || conf.parseable) {
throw new Error(
'Enabling two-factor authentication is an interactive operation and ' +
(conf.json ? 'JSON' : 'parseable') + ' output mode is not available'
)
}
const info = {
tfa: {
mode: mode,
},
}
// if they're using legacy auth currently then we have to
// update them to a bearer token before continuing.
const auth = getAuth(conf)
if (!auth.basic && !auth.token) {
throw new Error(
'You need to be logged in to registry ' +
`${conf.registry} in order to enable 2fa`
)
}
if (auth.basic) {
log.info('profile', 'Updating authentication to bearer token')
const result = await npmProfile.createToken(
auth.basic.password, false, [], conf
)
if (!result.token) {
throw new Error(
`Your registry ${conf.registry} does not seem to ` +
'support bearer tokens. Bearer tokens are required for ' +
'two-factor authentication'
)
}
npm.config.setCredentialsByURI(conf.registry, { token: result.token })
await npm.config.save('user')
}
log.notice('profile', 'Enabling two factor authentication for ' + mode)
const password = await readUserInfo.password()
info.tfa.password = password
log.info('profile', 'Determine if tfa is pending')
const userInfo = await pulseTillDone.withPromise(npmProfile.get(conf))
if (userInfo && userInfo.tfa && userInfo.tfa.pending) {
log.info('profile', 'Resetting two-factor authentication')
await pulseTillDone.withPromise(
npmProfile.set({ tfa: { password, mode: 'disable' } }, conf)
)
} else if (userInfo && userInfo.tfa) {
if (conf.otp)
conf.otp = conf.otp
else {
const otp = await readUserInfo.otp(
'Enter one-time password from your authenticator app: '
)
conf.otp = otp
}
}
log.info('profile', 'Setting two-factor authentication to ' + mode)
const challenge = await pulseTillDone.withPromise(npmProfile.set(info, conf))
if (challenge.tfa === null) {
output('Two factor authentication mode changed to: ' + mode)
return
}
const badResponse = typeof challenge.tfa !== 'string'
|| !/^otpauth:[/][/]/.test(challenge.tfa)
if (badResponse) {
throw new Error(
'Unknown error enabling two-factor authentication. Expected otpauth URL' +
', got: ' + inspect(challenge.tfa)
)
}
const otpauth = new URL(challenge.tfa)
const secret = otpauth.searchParams.get('secret')
const code = await qrcode(challenge.tfa)
output(
'Scan into your authenticator app:\n' + code + '\n Or enter code:', secret
)
const interactiveOTP =
await readUserInfo.otp('And an OTP code from your authenticator: ')
log.info('profile', 'Finalizing two-factor authentication')
const result = await npmProfile.set({ tfa: [interactiveOTP] }, conf)
output(
'2FA successfully enabled. Below are your recovery codes, ' +
'please print these out.'
)
output(
'You will need these to recover access to your account ' +
'if you lose your authentication device.'
)
for (const tfaCode of result.tfa)
output('\t' + tfaCode)
}
const getAuth = conf => {
const creds = npm.config.getCredentialsByURI(conf.registry)
const auth = {}
if (creds.token)
auth.token = creds.token
else if (creds.username)
auth.basic = { username: creds.username, password: creds.password }
else if (creds.auth) {
const basic = Buffer.from(creds.auth, 'base64').toString().split(':', 2)
auth.basic = { username: basic[0], password: basic[1] }
}
if (conf.otp)
auth.otp = conf.otp
return auth
}
const disable2fa = async args => {
const conf = { ...npm.flatOptions }
const info = await pulseTillDone.withPromise(npmProfile.get(conf))
if (!info.tfa || info.tfa.pending) {
output('Two factor authentication not enabled.')
return
}
const password = await readUserInfo.password()
if (!conf.otp) {
const msg = 'Enter one-time password from your authenticator app: '
conf.otp = await readUserInfo.otp(msg)
}
log.info('profile', 'disabling tfa')
await pulseTillDone.withPromise(npmProfile.set({
tfa: { password: password, mode: 'disable' },
}, conf))
if (conf.json)
output(JSON.stringify({ tfa: false }, null, 2))
else if (conf.parseable)
output('tfa\tfalse')
else
output('Two factor authentication disabled.')
}
const qrcode = url =>
new Promise((resolve) => qrcodeTerminal.generate(url, resolve))
module.exports = Object.assign(cmd, { usage, completion })