mirror of
https://github.com/bitwarden/browser.git
synced 2024-09-19 02:51:14 +02:00
fcd0c529ca
* Remove Get file capability This needs to be removed because the SendFileResponse no longer contains a url to download the file from. Instead, a GetDownloadLink method must be used. That method increments access count, which is not desirable for the owner of the Send. The cleanest approach is to remove the capability, which also matches Web client's behavior * jslib updates * Use GetDownloadData method to receive download Url * Update jslib
421 lines
18 KiB
TypeScript
421 lines
18 KiB
TypeScript
import * as chk from 'chalk';
|
|
import * as program from 'commander';
|
|
|
|
import { Main } from './bw';
|
|
|
|
import { ConfigCommand } from './commands/config.command';
|
|
import { EncodeCommand } from './commands/encode.command';
|
|
import { GenerateCommand } from './commands/generate.command';
|
|
import { LockCommand } from './commands/lock.command';
|
|
import { LoginCommand } from './commands/login.command';
|
|
import { StatusCommand } from './commands/status.command';
|
|
import { SyncCommand } from './commands/sync.command';
|
|
import { UnlockCommand } from './commands/unlock.command';
|
|
|
|
import { CompletionCommand } from './commands/completion.command';
|
|
|
|
import { LogoutCommand } from 'jslib/cli/commands/logout.command';
|
|
import { UpdateCommand } from 'jslib/cli/commands/update.command';
|
|
|
|
import { Response } from 'jslib/cli/models/response';
|
|
import { MessageResponse } from 'jslib/cli/models/response/messageResponse';
|
|
|
|
import { TemplateResponse } from './models/response/templateResponse';
|
|
import { CliUtils } from './utils';
|
|
|
|
import { BaseProgram } from 'jslib/cli/baseProgram';
|
|
|
|
const chalk = chk.default;
|
|
const writeLn = CliUtils.writeLn;
|
|
|
|
export class Program extends BaseProgram {
|
|
constructor(protected main: Main) {
|
|
super(main.userService, writeLn);
|
|
}
|
|
|
|
register() {
|
|
program
|
|
.option('--pretty', 'Format output. JSON is tabbed with two spaces.')
|
|
.option('--raw', 'Return raw output instead of a descriptive message.')
|
|
.option('--response', 'Return a JSON formatted version of response output.')
|
|
.option('--quiet', 'Don\'t return anything to stdout.')
|
|
.option('--nointeraction', 'Do not prompt for interactive user input.')
|
|
.option('--session <session>', 'Pass session key instead of reading from env.')
|
|
.version(this.main.platformUtilsService.getApplicationVersion(), '-v, --version');
|
|
|
|
program.on('option:pretty', () => {
|
|
process.env.BW_PRETTY = 'true';
|
|
});
|
|
|
|
program.on('option:raw', () => {
|
|
process.env.BW_RAW = 'true';
|
|
});
|
|
|
|
program.on('option:quiet', () => {
|
|
process.env.BW_QUIET = 'true';
|
|
});
|
|
|
|
program.on('option:response', () => {
|
|
process.env.BW_RESPONSE = 'true';
|
|
});
|
|
|
|
program.on('option:nointeraction', () => {
|
|
process.env.BW_NOINTERACTION = 'true';
|
|
});
|
|
|
|
program.on('option:session', key => {
|
|
process.env.BW_SESSION = key;
|
|
});
|
|
|
|
program.on('command:*', () => {
|
|
writeLn(chalk.redBright('Invalid command: ' + program.args.join(' ')), false, true);
|
|
writeLn('See --help for a list of available commands.', true, true);
|
|
process.exitCode = 1;
|
|
});
|
|
|
|
program.on('--help', () => {
|
|
writeLn('\n Examples:');
|
|
writeLn('');
|
|
writeLn(' bw login');
|
|
writeLn(' bw lock');
|
|
writeLn(' bw unlock myPassword321');
|
|
writeLn(' bw list --help');
|
|
writeLn(' bw list items --search google');
|
|
writeLn(' bw get item 99ee88d2-6046-4ea7-92c2-acac464b1412');
|
|
writeLn(' bw get password google.com');
|
|
writeLn(' echo \'{"name":"My Folder"}\' | bw encode');
|
|
writeLn(' bw create folder eyJuYW1lIjoiTXkgRm9sZGVyIn0K');
|
|
writeLn(' bw edit folder c7c7b60b-9c61-40f2-8ccd-36c49595ed72 eyJuYW1lIjoiTXkgRm9sZGVyMiJ9Cg==');
|
|
writeLn(' bw delete item 99ee88d2-6046-4ea7-92c2-acac464b1412');
|
|
writeLn(' bw generate -lusn --length 18');
|
|
writeLn(' bw config server https://bitwarden.example.com');
|
|
writeLn(' bw send -f ./file.ext');
|
|
writeLn(' bw send "text to send"');
|
|
writeLn(' echo "text to send" | bw send');
|
|
writeLn(' bw receive https://vault.bitwarden.com/#/send/rg3iuoS_Akm2gqy6ADRHmg/Ht7dYjsqjmgqUM3rjzZDSQ');
|
|
writeLn('', true);
|
|
});
|
|
|
|
program
|
|
.command('login [email] [password]')
|
|
.description('Log into a user account.')
|
|
.option('--method <method>', 'Two-step login method.')
|
|
.option('--code <code>', 'Two-step login code.')
|
|
.option('--sso', 'Log in with Single-Sign On.')
|
|
.option('--apikey', 'Log in with an Api Key.')
|
|
.option('--passwordenv <passwordenv>', 'Environment variable storing your password')
|
|
.option('--passwordfile <passwordfile>', 'Path to a file containing your password as its first line')
|
|
.option('--check', 'Check login status.', async () => {
|
|
const authed = await this.main.userService.isAuthenticated();
|
|
if (authed) {
|
|
const res = new MessageResponse('You are logged in!', null);
|
|
this.processResponse(Response.success(res), true);
|
|
}
|
|
this.processResponse(Response.error('You are not logged in.'), true);
|
|
})
|
|
.on('--help', () => {
|
|
writeLn('\n Notes:');
|
|
writeLn('');
|
|
writeLn(' See docs for valid `method` enum values.');
|
|
writeLn('');
|
|
writeLn(' Pass `--raw` option to only return the session key.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' bw login');
|
|
writeLn(' bw login john@example.com myPassword321 --raw');
|
|
writeLn(' bw login john@example.com myPassword321 --method 1 --code 249213');
|
|
writeLn(' bw login --sso');
|
|
writeLn('', true);
|
|
})
|
|
.action(async (email: string, password: string, options: program.OptionValues) => {
|
|
if (!options.check) {
|
|
await this.exitIfAuthed();
|
|
const command = new LoginCommand(this.main.authService, this.main.apiService,
|
|
this.main.cryptoFunctionService, this.main.syncService, this.main.i18nService,
|
|
this.main.environmentService, this.main.passwordGenerationService,
|
|
this.main.platformUtilsService);
|
|
const response = await command.run(email, password, options);
|
|
this.processResponse(response);
|
|
}
|
|
});
|
|
|
|
program
|
|
.command('logout')
|
|
.description('Log out of the current user account.')
|
|
.on('--help', () => {
|
|
writeLn('\n Examples:');
|
|
writeLn('');
|
|
writeLn(' bw logout');
|
|
writeLn('', true);
|
|
})
|
|
.action(async cmd => {
|
|
await this.exitIfNotAuthed();
|
|
const command = new LogoutCommand(this.main.authService, this.main.i18nService,
|
|
async () => await this.main.logout());
|
|
const response = await command.run();
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('lock')
|
|
.description('Lock the vault and destroy active session keys.')
|
|
.on('--help', () => {
|
|
writeLn('\n Examples:');
|
|
writeLn('');
|
|
writeLn(' bw lock');
|
|
writeLn('', true);
|
|
})
|
|
.action(async cmd => {
|
|
await this.exitIfNotAuthed();
|
|
const command = new LockCommand(this.main.vaultTimeoutService);
|
|
const response = await command.run(cmd);
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('unlock [password]')
|
|
.description('Unlock the vault and return a new session key.')
|
|
.on('--help', () => {
|
|
writeLn('\n Notes:');
|
|
writeLn('');
|
|
writeLn(' After unlocking, any previous session keys will no longer be valid.');
|
|
writeLn('');
|
|
writeLn(' Pass `--raw` option to only return the session key.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' bw unlock');
|
|
writeLn(' bw unlock myPassword321');
|
|
writeLn(' bw unlock myPassword321 --raw');
|
|
writeLn('', true);
|
|
})
|
|
.option('--check', 'Check lock status.', async () => {
|
|
const locked = await this.main.vaultTimeoutService.isLocked();
|
|
if (!locked) {
|
|
const res = new MessageResponse('Vault is unlocked!', null);
|
|
this.processResponse(Response.success(res), true);
|
|
}
|
|
this.processResponse(Response.error('Vault is locked.'), true);
|
|
})
|
|
.action(async (password, cmd) => {
|
|
if (!cmd.check) {
|
|
await this.exitIfNotAuthed();
|
|
const command = new UnlockCommand(this.main.cryptoService, this.main.userService,
|
|
this.main.cryptoFunctionService, this.main.apiService);
|
|
const response = await command.run(password, cmd);
|
|
this.processResponse(response);
|
|
}
|
|
});
|
|
|
|
program
|
|
.command('sync')
|
|
.description('Pull the latest vault data from server.')
|
|
.option('-f, --force', 'Force a full sync.')
|
|
.option('--last', 'Get the last sync date.')
|
|
.on('--help', () => {
|
|
writeLn('\n Examples:');
|
|
writeLn('');
|
|
writeLn(' bw sync');
|
|
writeLn(' bw sync -f');
|
|
writeLn(' bw sync --last');
|
|
writeLn('', true);
|
|
})
|
|
.action(async cmd => {
|
|
await this.exitIfLocked();
|
|
const command = new SyncCommand(this.main.syncService);
|
|
const response = await command.run(cmd);
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('generate')
|
|
.description('Generate a password/passphrase.')
|
|
.option('-u, --uppercase', 'Include uppercase characters.')
|
|
.option('-l, --lowercase', 'Include lowercase characters.')
|
|
.option('-n, --number', 'Include numeric characters.')
|
|
.option('-s, --special', 'Include special characters.')
|
|
.option('-p, --passphrase', 'Generate a passphrase.')
|
|
.option('--length <length>', 'Length of the password.')
|
|
.option('--words <words>', 'Number of words.')
|
|
.option('--separator <separator>', 'Word separator.')
|
|
.on('--help', () => {
|
|
writeLn('\n Notes:');
|
|
writeLn('');
|
|
writeLn(' Default options are `-uln --length 14`.');
|
|
writeLn('');
|
|
writeLn(' Minimum `length` is 5.');
|
|
writeLn('');
|
|
writeLn(' Minimum `words` is 3.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' bw generate');
|
|
writeLn(' bw generate -u -l --length 18');
|
|
writeLn(' bw generate -ulns --length 25');
|
|
writeLn(' bw generate -ul');
|
|
writeLn(' bw generate -p --separator _');
|
|
writeLn(' bw generate -p --words 5 --separator space');
|
|
writeLn('', true);
|
|
})
|
|
.action(async options => {
|
|
const command = new GenerateCommand(this.main.passwordGenerationService);
|
|
const response = await command.run(options);
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('encode')
|
|
.description('Base 64 encode stdin.')
|
|
.on('--help', () => {
|
|
writeLn('\n Notes:');
|
|
writeLn('');
|
|
writeLn(' Use to create `encodedJson` for `create` and `edit` commands.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' echo \'{"name":"My Folder"}\' | bw encode');
|
|
writeLn('', true);
|
|
})
|
|
.action(async () => {
|
|
const command = new EncodeCommand();
|
|
const response = await command.run();
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('config <setting> [value]')
|
|
.description('Configure CLI settings.')
|
|
.option('--web-vault <url>', 'Provides a custom web vault URL that differs from the base URL.')
|
|
.option('--api <url>', 'Provides a custom API URL that differs from the base URL.')
|
|
.option('--identity <url>', 'Provides a custom identity URL that differs from the base URL.')
|
|
.option('--icons <url>', 'Provides a custom icons service URL that differs from the base URL.')
|
|
.option('--notifications <url>', 'Provides a custom notifications URL that differs from the base URL.')
|
|
.option('--events <url>', 'Provides a custom events URL that differs from the base URL.')
|
|
.on('--help', () => {
|
|
writeLn('\n Settings:');
|
|
writeLn('');
|
|
writeLn(' server - On-premises hosted installation URL.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' bw config server');
|
|
writeLn(' bw config server https://bw.company.com');
|
|
writeLn(' bw config server bitwarden.com');
|
|
writeLn(' bw config server --api http://localhost:4000 --identity http://localhost:33656');
|
|
writeLn('', true);
|
|
})
|
|
.action(async (setting, value, options) => {
|
|
const command = new ConfigCommand(this.main.environmentService);
|
|
const response = await command.run(setting, value, options);
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('update')
|
|
.description('Check for updates.')
|
|
.on('--help', () => {
|
|
writeLn('\n Notes:');
|
|
writeLn('');
|
|
writeLn(' Returns the URL to download the newest version of this CLI tool.');
|
|
writeLn('');
|
|
writeLn(' Use the `--raw` option to return only the download URL for the update.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' bw update');
|
|
writeLn(' bw update --raw');
|
|
writeLn('', true);
|
|
})
|
|
.action(async () => {
|
|
const command = new UpdateCommand(this.main.platformUtilsService, this.main.i18nService,
|
|
'cli', 'bw', true);
|
|
const response = await command.run();
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('completion')
|
|
.description('Generate shell completions.')
|
|
.option('--shell <shell>', 'Shell to generate completions for.')
|
|
.on('--help', () => {
|
|
writeLn('\n Notes:');
|
|
writeLn('');
|
|
writeLn(' Valid shells are `zsh`.');
|
|
writeLn('');
|
|
writeLn(' Examples:');
|
|
writeLn('');
|
|
writeLn(' bw completion --shell zsh');
|
|
writeLn('', true);
|
|
})
|
|
.action(async (options: program.OptionValues, cmd: program.Command) => {
|
|
const command = new CompletionCommand();
|
|
const response = await command.run(options);
|
|
this.processResponse(response);
|
|
});
|
|
|
|
program
|
|
.command('status')
|
|
.description('Show server, last sync, user information, and vault status.')
|
|
.on('--help', () => {
|
|
writeLn('');
|
|
writeLn('');
|
|
writeLn(' Example return value:');
|
|
writeLn('');
|
|
writeLn(' {');
|
|
writeLn(' "serverUrl": "https://bitwarden.example.com",');
|
|
writeLn(' "lastSync": "2020-06-16T06:33:51.419Z",');
|
|
writeLn(' "userEmail": "user@example.com,');
|
|
writeLn(' "userId": "00000000-0000-0000-0000-000000000000",');
|
|
writeLn(' "status": "locked"');
|
|
writeLn(' }');
|
|
writeLn('');
|
|
writeLn(' Notes:');
|
|
writeLn('');
|
|
writeLn(' `status` is one of:');
|
|
writeLn(' - `unauthenticated` when you are not logged in');
|
|
writeLn(' - `locked` when you are logged in and the vault is locked');
|
|
writeLn(' - `unlocked` when you are logged in and the vault is unlocked');
|
|
writeLn('', true);
|
|
})
|
|
.action(async () => {
|
|
const command = new StatusCommand(
|
|
this.main.environmentService,
|
|
this.main.syncService,
|
|
this.main.userService,
|
|
this.main.vaultTimeoutService);
|
|
const response = await command.run();
|
|
this.processResponse(response);
|
|
});
|
|
|
|
}
|
|
|
|
protected processResponse(response: Response, exitImmediately = false) {
|
|
super.processResponse(response, exitImmediately, () => {
|
|
if (response.data.object === 'template') {
|
|
return this.getJson((response.data as TemplateResponse).template);
|
|
}
|
|
return null;
|
|
});
|
|
}
|
|
|
|
protected async exitIfLocked() {
|
|
await this.exitIfNotAuthed();
|
|
const hasKey = await this.main.cryptoService.hasKey();
|
|
if (!hasKey) {
|
|
const canInteract = process.env.BW_NOINTERACTION !== 'true';
|
|
if (canInteract) {
|
|
const command = new UnlockCommand(this.main.cryptoService, this.main.userService,
|
|
this.main.cryptoFunctionService, this.main.apiService);
|
|
const response = await command.run(null, null);
|
|
if (!response.success) {
|
|
this.processResponse(response, true);
|
|
}
|
|
} else {
|
|
this.processResponse(Response.error('Vault is locked.'), true);
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|