refactor(1password): support CLI 2 and soft-deprecate CLI 1 (#10787)

This change still supports CLI 1, but shows a deprecation warning
on the first run of `opswd`. Support for CLI 1 shall be removed
in the near future.

Closes #10787

Co-authored-by: Marc Cornellà <hello@mcornella.com>
This commit is contained in:
Adam Pike 2022-03-26 15:11:04 +01:00 committed by Marc Cornellà
parent a64d940377
commit dbadfa0810
No known key found for this signature in database
GPG key ID: 0314585E776A9C1B
3 changed files with 63 additions and 9 deletions

View file

@ -25,11 +25,14 @@ which service you want to get.
For example, `opswd github.com` will put your GitHub password into your clipboard, and if For example, `opswd github.com` will put your GitHub password into your clipboard, and if
a TOTP is available, it will be copied to the clipboard after 10 seconds. a TOTP is available, it will be copied to the clipboard after 10 seconds.
> NOTE: you need to be logged in for `opswd` to work. See: > NOTE: you need to be signed in for `opswd` to work. If you are using biometric unlock,
> 1Password CLI will automatically prompt you to sign in. See:
> >
> - [Sign in or out](https://support.1password.com/command-line/#sign-in-or-out) > - [Get started with 1Password CLI 2: Sign in](https://developer.1password.com/docs/cli/get-started#sign-in)
> - [Session management](https://support.1password.com/command-line/#appendix-session-management) > - [Sign in to your 1Password account manually](https://developer.1password.com/docs/cli/sign-in-manually)
## Requirements ## Requirements
- [1Password's command line utility](https://1password.com/downloads/command-line/). - [1Password CLI 2](https://developer.1password.com/docs/cli/get-started#install)
> NOTE: if you're using 1Password CLI 1, [see how to upgrade to CLI 2](https://developer.1password.com/docs/cli/upgrade).

View file

@ -1,9 +1,19 @@
#compdef opswd #compdef opswd
function _opswd() {
local -a services
services=("${(@f)$(op item list --categories Login --cache 2>/dev/null | awk 'NR != 1 { print $2 }')}")
[[ -z "$services" ]] || compadd -a -- services
}
# TODO: 2022-03-26: Remove support for op CLI 1
autoload -Uz is-at-least
is-at-least 2.0.0 $(op --version) || {
function _opswd() { function _opswd() {
local -a services local -a services
services=("${(@f)$(op list items --categories Login 2>/dev/null | op get item - --fields title 2>/dev/null)}") services=("${(@f)$(op list items --categories Login 2>/dev/null | op get item - --fields title 2>/dev/null)}")
[[ -z "$services" ]] || compadd -a -- services [[ -z "$services" ]] || compadd -a -- services
} }
}
_opswd "$@" _opswd "$@"

View file

@ -1,5 +1,45 @@
#autoload #autoload
# opswd puts the password of the named service into the clipboard. If there's a
# one time password, it will be copied into the clipboard after 10 seconds. The
# clipboard is cleared after another 20 seconds.
function opswd() {
if [[ $# -lt 1 ]]; then
echo "Usage: opswd <service>"
return 1
fi
local service=$1
# If not logged in, print error and return
op user list > /dev/null || return
local password
# Copy the password to the clipboard
if ! password=$(op item get "$service" --fields password 2>/dev/null); then
echo "error: could not obtain password for $service"
return 1
fi
echo -n "$password" | clipcopy
echo "✔ password for $service copied to clipboard"
# If there's a one time password, copy it to the clipboard after 10 seconds
local totp
if totp=$(op item get --otp "$service" 2>/dev/null) && [[ -n "$totp" ]]; then
sleep 10 && echo -n "$totp" | clipcopy
echo "✔ TOTP for $service copied to clipboard"
fi
(sleep 20 && clipcopy </dev/null 2>/dev/null) &!
}
# TODO: 2022-03-26: Remove support for op CLI 1
autoload -Uz is-at-least
is-at-least 2.0.0 $(op --version) || {
print -ru2 ${(%):-"%F{yellow}opswd: usage with op version $(op --version) is deprecated. Upgrade to CLI 2 and reload zsh.
For instructions, see https://developer.1password.com/docs/cli/upgrade.%f"}
# opswd puts the password of the named service into the clipboard. If there's a # opswd puts the password of the named service into the clipboard. If there's a
# one time password, it will be copied into the clipboard after 10 seconds. The # one time password, it will be copied into the clipboard after 10 seconds. The
# clipboard is cleared after another 20 seconds. # clipboard is cleared after another 20 seconds.
@ -33,5 +73,6 @@ function opswd() {
(sleep 20 && clipcopy </dev/null 2>/dev/null) &! (sleep 20 && clipcopy </dev/null 2>/dev/null) &!
} }
}
opswd "$@" opswd "$@"