CLI command

skarbiec credential enrol

Start the authenticator enrolment of the account a role names, at the site whose two-step settings page the account names, tell its run the owner has the phone in hand (or never got the provider's prompt), and read where it stands. Weles does the browser work; the run asks the owner for nothing unless a step would reach his phone, and every skarbiec maintain pass starts it by itself for an account that asks for a code and keeps no seed.

Invocation#

Shell
skarbiec credential enrol role:<role>
skarbiec credential enrol role:<role> --answer ready|not-received
skarbiec credential enrol role:<role> --status [--wait]
skarbiec credential enrol role:<role> --verify

Purpose#

Start the authenticator enrolment of the account a role names, at the site whose two-step settings page the account names, tell its run the owner has the phone in hand (or never got the provider's prompt), and read where it stands. Weles does the browser work; the run asks the owner for nothing unless a step would reach his phone, and every skarbiec maintain pass starts it by itself for an account that asks for a code and keeps no seed.

Required inputs and options#

  • role:<role>, the account's identity or a login keeping its own factor; with nothing else it starts the enrolment at the host of the account's context.security_page. --answer ready|not-received answers the run; --status reads it, with --wait answering once the run waits for the owner or ends; --verify signs in where Google asks for the code. POST /v1/operator/credential takes operation enrol with the same flags.

Output and state effects#

  • Start sends Weles's credential admission operation enrol with the item keeping the seed, the login signed in with, the provider (the page's host) and the account address, and journals credential-enrol-started with the request id, the provider, the run Weles named and the item's revision. Weles runs Google's enrolment at Google's account pages, which waits for --answer ready only before a sign-in that may send Google's prompt to the phone, and a generic one at any other site, which reaches no phone; once the site took the first code it writes the seed, context.enrolled and the recovery codes (fields.recovery_codes) to the item. --answer and --status follow the newest start the journal records. --status prints Weles's answer (phase, waiting, stage, ending and its remedy) beside the item's seed state, verification and remaining recovery codes. --verify asks Weles (operation verify) to open the account's authenticator settings, where Google asks the account to sign in again, answers that sign-in from the vault (the code's outcome is recorded with totp verified), waits for the run to end, journals credential-verify-run, and prints the ending (signed_in_with_code, not_asked, phone_required, sign_in_refused, login_unfit), the verification read afterwards and next: when Google asks for the phone, nothing is approved and next names the end of its window for a new method. Desktop runs it as soon as an enrolment ends enrolled.

Refusals#

  • Every refusal is a declared cause of skarbiec.credential-enrol under /docs/errors. credential-enrol-no-security-page: the account names no page showing its two-step settings. credential-enrol-role-unheld: no live item plays the role. credential-enrol-holder-kind: the role is played by neither an identity nor a login. credential-enrol-no-login: the identity has no login signing in as it, so there is no password to sign in with. credential-enrol-seed-working: the account keeps a seed it accepts, is locked, or enrolled moments ago, so a new enrolment would make that seed stop answering. credential-enrol-none-started: --answer or --status with no enrolment started. credential-enrol-verify-no-seed: --verify on an account keeping no seed that computes a code. credential-enrol-verify-locked: --verify while the provider has locked the method. credential-enrol-weles-refused: Weles's admission refused, with its code and phase.