Full Code of dcreemer/1pass for AI

Repository: dcreemer/1pass
Branch: master
Commit: 79f821f2e332
Files: 10
Total size: 65.1 KB

Directory structure:
gitextract_l7zwjrhq/

├── .github/
│   └── workflows/
│       └── shellcheck.yml
├── .gitignore
├── 1pass
├── 1pass.el
├── LICENSE
├── README.md
├── bash_completion.sh
├── config.sample
├── fuzzpass.fish
└── fuzzpass.sh

================================================
FILE CONTENTS
================================================

================================================
FILE: .github/workflows/shellcheck.yml
================================================
# check with Shellcheck (https://www.shellcheck.net/) linter
#

name: shellcheck

on: push

jobs:
    shellcheck:
        name: Shellcheck
        runs-on: ubuntu-latest

        steps:
            - name: checkout code
              uses: actions/checkout@v2

            - name: Run ShellCheck
              uses: ludeeus/action-shellcheck@master
              env:
                  SHELLCHECK_OPTS: -x


================================================
FILE: .gitignore
================================================
*~
.DS_Store


================================================
FILE: 1pass
================================================
#! /usr/bin/env bash
#
# 1pass -- a simple caching wrapper for the "op" 1Password CLI.
#
# Copyright (C) 2017 David Creemer, (twitter: @dcreemer)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

set -e
set -o pipefail

VERSION="1.6.1"

if [ "$XDG_CONFIG_HOME" != "" ] && [ ! -d "${HOME}/.1pass" ]; then
    op_dir="${XDG_CONFIG_HOME}/1pass"
else
    op_dir=${HOME}/.1pass
fi

if [ "$XDG_CACHE_HOME" != "" ] && [ ! -d "${op_dir}/cache" ]; then
    cache_dir="${XDG_CACHE_HOME}/1pass"
else
    cache_dir=${op_dir}/cache
fi

os=$(uname)

# check for bare -V/version request first:
if [ $# -eq 1 ] && [ "$1" == "-V" ]; then
    echo "${VERSION}"
    exit 0
fi

# Try to find the GPG executable
if [ -z "$GPG" ]; then
    # Default to gpg, but prefer what gpgconf says
    GPG="gpg"
    if command -v gpgconf >/dev/null 2>&1; then
        GPG="$( gpgconf | awk -F: '/^gpg:/ { print $NF }' )"
    fi
fi

# test setup:
if [ ! -d "$op_dir" ] || [ ! -r "${op_dir}/config" ]; then
    mkdir -p "$cache_dir"
    cat > "${op_dir}/config" <<CONFIG
# configuration file for 1pass

# set to the ID of your GPG key
self_key=""

# set to the email address associated with your 1Password account
email=""

# set to your 1password domain (e.g. example.1password.com)
domain=""

# if using two-factor authentication automation with oathtool, set to 1
use_totp="0"

CONFIG
    chmod go-rw "${op_dir}/config"
    echo "please config 1pass by editing ${op_dir}/config"
    exit 1
fi
if [ ! -d "$cache_dir" ]; then
    mkdir -p "$cache_dir"
fi

# these are read from the config file:
email=""
self_key=""
domain=""
use_totp=""

# old setting, still supported
subdomain=""

# shellcheck source=config.sample
source "${op_dir}/config"

master=${op_dir}/_master.gpg
secret=${op_dir}/_secret.gpg
totp=${op_dir}/_totp.gpg

# check settings:

if [ "$email" == "" ]; then
    echo "please configure your 1Password email address in ${op_dir}/config"
    exit 1
fi

if [ "$self_key" == "" ]; then
    echo "please configure your GPG key in ${op_dir}/config"
    exit 1
fi

if [ "$subdomain" == "" ] && [ "$domain" == "" ]; then
    echo "please configure your 1Password domain in ${op_dir}/config, e.g. example.1password.com"
    exit 1
fi
domain=${domain:-${subdomain}.1password.com}

if [ ! -r "${master}" ]; then
    echo "please put your master password into ${master}"
    echo "ex: echo \"master-password\" | $GPG -er $email > ${master}"
    exit 1
fi

if [ ! -r "${secret}" ]; then
    echo "please put your ${domain} secret key into ${secret}"
    echo "ex: echo \"A3-XXXXXX-XXXXXX-XXXXX-XXXXX-XXXXX-XXXXX\" | $GPG -er $email > ${secret}"
    exit 1
fi

if [ "${use_totp}" == "1" ] && [ ! -r "${totp}" ]; then
    echo "please put your ${domain} totp secret into ${totp}"
    echo "ex: echo \"XXXXXXXXXXXXXXXX\" | $GPG -er $email > ${totp}"
    exit 1
fi

index=${cache_dir}/_index.gpg
session=${cache_dir}/_session.gpg
token=""
get_result=""
OPTIND=1
refresh=0
verbose=0
print_output=0
clip_time=30
OP_SESSION_NAME=$(echo "$domain" | cut -f1 -d'.' | tr '-' '_')
list_fields=0
OPBIN="op1"

usage()
{
cat <<USAGE
usage: 1pass [-fhprv] [<Item>|- [<username|password|totp>]]

  -f   Forget GPG key from gpg-agent, and remove local session
  -h   Help
  -p   Print the 1pass output to stdout, rather than copying to the clipboard
  -l   List all the known fields for the specified item
  -r   Refresh all appropriate data from 1password.com, ignoring local cache
  -v   Verbose output
  -V   Print 1pass version and exit

With no arguments, prints a list of all Logins and Passwords in all 1Password vaults.

With a single argument, fetches the Item (Login, Password, or TOTP) matching the
given name, and copies the resulting password to the clipboard. If "-" is supplied
for <Item>, the item is read from stdin.

With two arguments, fetches the specified field (e.g.) "username" from the named
item, and copies the results to the clipboard.
USAGE
}

sanity_check()
{
    programs=("$OPBIN" jq "$GPG" expect)

    if [ "$use_totp" == "1" ]; then
        programs+=(oathtool)
    fi
    if [ "$os" == "Linux" ] || [ "$os" == "FreeBSD" ]; then
        if [ "$XDG_SESSION_TYPE" == "wayland" ]; then
            programs+=(wl-copy)
        else
            programs+=(xclip)
        fi
    fi

    for cmd in "${programs[@]}"
    do
        if [ $verbose -eq 1 ]; then
            echo "checking for $cmd" 1>&2
        fi
        if ! command -v "$cmd" > /dev/null; then
            echo "Cannot find the '$cmd' command. Please make sure it is installed" 1>&2
            exit 1
        fi
    done

    opversion=$("$OPBIN" --version)
    if [ "${opversion:0:1}" -gt 1 ]; then
        echo "Only 1Password CLI version 1 is supported (found $opversion)" 1>&2
        exit 1
    fi
}

signin()
{
    local pw
    pw=$("$GPG" -d -q "$master")
    local se
    se=$("$GPG" -d -q "$secret")
    if [ "${use_totp}" == "1" ]; then
        local ot
        totp=$("$GPG" -d -q "$totp")
        ot=$(oathtool -b --totp "$totp")
    fi
    if [ $verbose -eq 1 ]; then
        echo "signing in to ${domain} $email" 1>&2
    fi
    local script
    if [ "${use_totp}" == "0" ]; then
        script="
            spawn ${OPBIN} signin ${domain} ${email} ${se}
            expect \"${domain}:\"
            send \"${pw}\n\"
            expect {
                   \"Enter your six-digit authentication code:\" {
                           puts -nonewline stderr \"Enter your six-digit authentication code: \"
                           flush stderr
                           interact -o \"\r\" return
                           puts stderr \"\"
                           exp_continue
                   }
                   eof
            }
        "
    else
        local script="
            spawn ${OPBIN} signin ${domain} ${email} ${se}
            expect \"${domain}:\"
            send \"${pw}\n\"
            expect {
                   \"Enter your six-digit authentication code:\" {
                           flush stderr
                           send -- \"$ot\r\"
                           puts stderr \"\"
                           exp_continue
                   }
                   eof
            }
        "
    fi
    local output0
    output0=$(expect -c "${script}")
    local output
    output=$(echo "${output0}" | grep "export" || echo -n "_fail_")
    if [ "$output" == "_fail_" ]; then
        echo "1pass failed to signin to ${domain}"
        exit 1
    fi
    # extract token from 'export OP_SESSION_domain="asdsad"'
    local token
    token=$(expr "${output}" : '.*="\(.*\)"')
    echo -n "${token}" | "$GPG" -qe --batch -r "$self_key" > "$session"
}

init_session()
{
    if [ "${token}" != "" ]; then
        # already have token
        return
    fi
    # test for stale session
    if [ ! -r "$session" ] || [ ! "$(find "$session" -mmin -29)" ] || [ $refresh -eq 1 ]; then
        signin
    else
        if [ $verbose -eq 1 ]; then
            echo "using existing session token" 1>&2
        fi
    fi
    token=$("$GPG" -d -q "$session")
    touch "$session"
}

forget_session()
{
    unset "$OP_SESSION_NAME"
    rm -f "$session"
    gpgconf --kill gpg-agent
    echo "cleared local session"
}

#
# fetch the index of all items from the net, and cache
#
fetch_index()
{
    init_session
    if [ $verbose -eq 1 ]; then
        echo "fetching index of all items" 1>&2
    fi
    local items
    items=$("$OPBIN" list items --session="${token}" || echo -n "_fail_")
    if [ "$items" == "_fail_" ]; then
        echo "1pass: failed to fetch index of all items"
        exit 1
    fi
    # backup current index
    if [ -r "$index" ]; then
        cp -a "$index" "${index}.bak"
    fi
    echo -n "${items}" | "$GPG" -qe --batch -r "$self_key" > "$index"
}

#
# fetch an item from the net by uuid and cache it locally
#
fetch_item()
{
    local uuid=$1
    init_session
    if [ $verbose -eq 1 ]; then
        echo "fetching item $uuid" 1>&2
    fi
    local item
    item=$("$OPBIN" get item "$uuid" --session="$token" || echo -n "_fail_")
    if [ "$item" == "_fail_" ]; then
        echo "1pass: failed to fetch item $uuid"
        exit 1
    fi
    echo -n "${item}" | "$GPG" -qe --batch -r "$self_key" > "${cache_dir}/${uuid}.gpg"
}

#
# list the titles of all items in the index
#
list_items()
{
    if [ ! -r "$index" ] || [ $refresh -eq 1 ]; then
        fetch_index
    fi
    "$GPG" -qd "$index" | jq -r ".[].overview.title" | LC_ALL="C" bash -c 'sort -bf'
}

#
# ensure we have the local gpg encoded file of the item given by the uuid
#
ensure_item()
{
    local uuid=$1
    local file=${cache_dir}/${uuid}.gpg
    if [ ! -r "$file" ] || [ $refresh -eq 1 ]; then
        fetch_item "$uuid"
    fi
}

#
# fetch a field from template 001 ("Login")
#
get_001()
{
    local uuid=$1
    local field=${2/"DEFAULT"/"password"}
    local q=""
    if [ "$field" == "username" ] || [ "$field" == "password" ]; then
        q=".details.fields[] | select(.designation==\"${field}\").value"
    else
        q=".details.sections[] | select(.fields).fields[] | select(.t==\"${field}\").v"
    fi
    ensure_item "$uuid"
    get_result=$("$GPG" -qd "${cache_dir}/${uuid}.gpg" | jq -r "${q}" || echo -n "_fail_")
}

#
# fetch a field from template 005 ("Password")
#
get_005()
{
    local uuid=$1
    local field=${2/"DEFAULT"/"password"}
    local q=""
    if [ "$field" == "password" ]; then
        q=".details.${field}"
    else
        q=".details.sections[] | select(.fields).fields[] | select(.t==\"${field}\").v"
    fi
    ensure_item "$uuid"
    get_result=$("$GPG" -qd "${cache_dir}/${uuid}.gpg" | jq -r "${q}" || echo -n "_fail_")
}

#
# fetch a field from template 003 ("Secure Note / notesPlain")
#
get_003()
{
    local uuid=$1
    local field=${2/"DEFAULT"/"notes"}
    if [ "$field" == "notes" ]; then
        # notes feels more natural than notesPlain
        q=".details.notesPlain"
    else
        q=".details.sections[] | select(.fields).fields[] | select(.t==\"${field}\").v"
    fi

    ensure_item "$uuid"

    get_result=$("$GPG" -qd "${cache_dir}/${uuid}.gpg" | jq -r "${q}" || echo -n "_fail_")
}

#
# fetch a field from template 110 ("Server")
#
get_110()
{
    local uuid=$1
    local field=${2/"DEFAULT"/"password"}
    local q=".details.sections[] | select(.fields).fields[] | select(.t==\"${field}\").v"

    ensure_item "$uuid"

    get_result=$("$GPG" -qd "${cache_dir}/${uuid}.gpg" | jq -r "${q}" || echo -n "_fail_")
}

#
# fetch the list of fields from template 001 ("Login")
#
get_fields_001()
{
    _get_fields_template "$1" "username" "password"
}

#
# fetch the list of fields from template 003 ("Secure Note")
#
get_fields_003()
{
    _get_fields_template "$1" "notes"
}

#
# fetch the list of fields from template 005 ("Password")
#
get_fields_005()
{
    _get_fields_template "$1" "password"
}

#
# fetch the list of fields from template 110 ("Server")
#
get_fields_110()
{
    _get_fields_template "$1"
}

_get_fields_template()
{
    local uuid=$1
    shift
    local q='.details.sections[] | select(.fields).fields[] | select(.t!="").t'
    local fields=("${@}")
    ensure_item "$uuid"
    while read -r f; do
        fields+=("$f")
    done < <("$GPG" -qd "${cache_dir}/${uuid}.gpg" | jq -r "${q}" || echo -n "_fail_")
    get_result=$(_join_by $'\n' "${fields[@]}")
}

function _join_by { local IFS="$1"; shift; echo "$*"; }

#
# fetch a TOTP value for the given item
#
get_totp()
{
    # Make sure we have a current and valid session and then get the UUID
    init_session
    if [ ! -r "$index" ] || [ $refresh -eq 1 ]; then
        fetch_index
    fi
    local title
    title="${1}"
    if [ "$title" == "-" ]; then
        # read title from stdin. turn off error propogation to handle EOF as well as NL
        set +e
        read -r title
        set -e
    fi

    local uuid
    uuid=$("$GPG" -qd "$index" | jq -r ".[] | select(.overview.title==\"$title\").uuid")
    # Fetch the TOTP
    if [ $verbose -eq 1 ]; then
        echo "fetching TOTP for $uuid" 1>&2
    fi
    local totp
    totp=$("$OPBIN" get totp "$uuid" --session="$token" || echo -n "_fail_")
    if [ "$item" == "_fail_" ]; then
        echo "1pass: failed to fetch TOTP for $uuid"
        exit 1
    fi
    if [ $? ]; then
        get_result="${totp}"
        output_result
    fi
}

output_result()
{
    if [ $print_output -eq 1 ]; then
        echo "${get_result}"
    else
        local pbcopy
        pbcopy=pbcopy
        if [ "$os" == "Linux" ] || [ "$os" == "FreeBSD" ]; then
            if [ "$XDG_SESSION_TYPE" == "wayland" ]; then
                pbcopy="wl-copy"
            else
                pbcopy="xclip -selection clipboard"
            fi
        fi
        echo -n "${get_result}" | $pbcopy
        # sleep and reset clipboard
        local sleep_argv0
        sleep_argv0="1pass sleep for user $(id -u)"
        pkill -f "^$sleep_argv0" 2>/dev/null && sleep 0.5
        (
            ( exec -a "$sleep_argv0" sleep "$clip_time" )
            echo -n "CLEAR" | $pbcopy
        ) 2>/dev/null & disown
    fi
}

get_by_title()
{
    _get_by "get_" "${@}"
}

get_fields_by_title()
{
    _get_by "get_fields_" "${@}"
}

_get_by()
{
    local func=$1
    local title=$2
    local field=$3
    if [ "$title" == "-" ]; then
        # read title from stdin. turn off error propogation to handle EOF as well as NL
        set +e
        read -r title
        set -e
    fi
    if [ ! -r "$index" ] || [ $refresh -eq 1 ]; then
        fetch_index
    fi
    # read both uuid and templateUuid. Complicated call is so that we only call GPG once
    q=".[] | select(.overview.title==\"${title}\").uuid + \":\" + select(.overview.title==\"${title}\").templateUuid"
    IFS=':' read -r uuid tid <<< "$("$GPG" -qd "$index" | jq -r "${q}")"
    if [ "$tid" != "" ]; then
        "${func}${tid}" "$uuid" "$field"
        if [ $? ]; then
            output_result
        fi
    fi
}

while getopts "f?h?p?l?r?v?:" opt; do
    case $opt in
        h)
            usage
            exit 0
            ;;
        f)
            forget_session
            exit 0
            ;;
        p)
            print_output=1
            ;;
        l)
            print_output=1
            list_fields=1
            ;;
        r)
            refresh=1
            ;;
        v)
            verbose=1
            ;;
        \?)
            echo "Invalid option: -$OPTARG" >&2
            ;;
    esac
done

shift $((OPTIND-1))

sanity_check

if [ $# -eq 0 ]; then
    list_items
elif [ $# -eq 1 ]; then
    if [[ $list_fields -eq 1 ]]; then
        get_fields_by_title "$1"
    else
        get_by_title "$1" DEFAULT
    fi
elif [ $# -eq 2 ]; then
    case "$2" in
        totp ) get_totp "$1"          ;;
        *    ) get_by_title "$1" "$2" ;;
    esac
fi


================================================
FILE: 1pass.el
================================================
;;; 1pass.el -- tiny wrapper to get usernames & passwords from 1pass
;;
;; Copyright (C) 2017 David Creemer, (twitter: @dcreemer)
;;
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
;;

;;; Commentary:
;;
;; Thin wrapper around the 1pass CLI utility.  It is likely that bugs will be
;; found, so please report any findings as issues or pull requests here:
;; https://github.com/dcreemer/1pass

;;; Code:
(require 's)

(defvar 1pass-cli-executable
  (executable-find "1pass")
  "Path to the 1pass executable.")

;; private helpers
(defun 1pass--cli-run (item field)
  "Call 1pass with given ITEM and FIELD."
  (with-temp-buffer
    (let* ((exit-code
            (apply #'call-process
                   (list 1pass-cli-executable nil t nil "-p" item field))))
      (if (zerop exit-code)
          (s-chomp (buffer-string))
        (error (s-chomp (buffer-string)))))))

;; public API
(defun 1pass-field-for (item field)
  "Lookup ITEM in 1pass and return the data from the given FIELD, if any."
  (1pass--cli-run item field))

(defun 1pass-password-for (item)
  "Lookup ITEM in 1pass and return the password, if any."
  (1pass--cli-run item "password"))

(defun 1pass-username-for (item)
  "Lookup ITEM in 1pass and return the username, if any."
  (1pass--cli-run item "username"))

;; deprecated API:
(define-obsolete-function-alias '1pass--item-field    '1pass-field-for)
(define-obsolete-function-alias '1pass--item-password '1pass-password-for)
(define-obsolete-function-alias '1pass--item-username '1pass-username-for)

(provide '1pass)

;;; 1pass.el ends here


================================================
FILE: LICENSE
================================================
                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The GNU General Public License is a free, copyleft license for
software and other kinds of works.

  The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.  We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors.  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

  To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights.  Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received.  You must make sure that they, too, receive
or can get the source code.  And you must show them these terms so they
know their rights.

  Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

  For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software.  For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

  Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so.  This is fundamentally incompatible with the aim of
protecting users' freedom to change the software.  The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable.  Therefore, we
have designed this version of the GPL to prohibit the practice for those
products.  If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.

  Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary.  To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

  The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 3 of the GNU General Public License.

  "Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

  "The Program" refers to any copyrightable work licensed under this
License.  Each licensee is addressed as "you".  "Licensees" and
"recipients" may be individuals or organizations.

  To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy.  The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

  A "covered work" means either the unmodified Program or a work based
on the Program.

  To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy.  Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

  To "convey" a work means any kind of propagation that enables other
parties to make or receive copies.  Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

  An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License.  If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

  1. Source Code.

  The "source code" for a work means the preferred form of the work
for making modifications to it.  "Object code" means any non-source
form of a work.

  A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

  The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form.  A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

  The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities.  However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work.  For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

  The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

  The Corresponding Source for a work in source code form is that
same work.

  2. Basic Permissions.

  All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met.  This License explicitly affirms your unlimited
permission to run the unmodified Program.  The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work.  This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

  You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force.  You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright.  Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

  Conveying under any other circumstances is permitted solely under
the conditions stated below.  Sublicensing is not allowed; section 10
makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

  No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

  When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

  4. Conveying Verbatim Copies.

  You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

  You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

  You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

  A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit.  Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

  6. Conveying Non-Source Forms.

  You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

  A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

  A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling.  In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage.  For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product.  A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

  "Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source.  The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

  If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information.  But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

  The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed.  Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

  Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

  7. Additional Terms.

  "Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law.  If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

  When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it.  (Additional permissions may be written to require their own
removal in certain cases when you modify the work.)  You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

  Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

  All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10.  If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term.  If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

  If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

  Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

  8. Termination.

  You may not propagate or modify a covered work except as expressly
provided under this License.  Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

  However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

  Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

  Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

  9. Acceptance Not Required for Having Copies.

  You are not required to accept this License in order to receive or
run a copy of the Program.  Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance.  However,
nothing other than this License grants you permission to propagate or
modify any covered work.  These actions infringe copyright if you do
not accept this License.  Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

  10. Automatic Licensing of Downstream Recipients.

  Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License.  You are not responsible
for enforcing compliance by third parties with this License.

  An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations.  If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

  You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License.  For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

  11. Patents.

  A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.  The
work thus licensed is called the contributor's "contributor version".

  A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version.  For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

  Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

  In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement).  To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

  If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients.  "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

  If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

  A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License.  You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

  Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

  12. No Surrender of Others' Freedom.

  If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all.  For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

  13. Use with the GNU Affero General Public License.

  Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work.  The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

  14. Revised Versions of this License.

  The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

  Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.

  If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

  Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS


================================================
FILE: README.md
================================================
# 1pass

**1pass** is a caching wrapper for the [1Password
CLI](https://support.1password.com/command-line-getting-started/) `op`.

![Shellcheck](https://github.com/dcreemer/1pass/workflows/shellcheck/badge.svg)

## NO LONGER MAINTAINED

I am no longer maintaining this software, as the 1Password CLI version 2
provides all of the features I need.

## WARNING 1password 2 CLI compatibility

Do not upgrade to 1password CLI version 2! This `1pass` tool is not yet compatible with
it.

## UPGRADE NOTE

Upgrading to version 1.1 requires installation of the
[expect](https://core.tcl.tk/expect/index) tool. `1pass` will check for this (and
other) dependencies and remind you to install them.

## Introduction

**1pass** is designed to make using your 1Password usernames and passwords quick and easy. It is
intended for use within an interactive shell as well as from scripts. Once installed and configured
as described below, you can obtain an account password in a shell simply by typing:

```sh
$ 1pass Github
```

and your Github password will be copied to the clipboard.

The official 1Password CLI application (```op```) can be difficult to use interactively, and unlike
the macOS or Windows 1Password native applications, requires an internet connection to fetch data
from your password vaults. **1pass** solves both of these problems. ```Op``` needs session tokens to
be revalidated manually after 30 minutes of inactivity and produces rich output in JSON format. The
JSON output is easy for a program to use, but is not trivially consumed by humans without help.
**1pass** provides that help, with two main features:

- a simplified interface for listing and fetching usernames, passwords, and other fields for
  individual items.
- an encrypted local cache of 1Password CLI results.

Together these features enable easy use of 1Password-stored credentials.

## Installation

First make sure that the `op` [1Password
CLI](https://support.1password.com/command-line-getting-started/) and the `jq`
[JQ](https://stedolan.github.io/jq) and
[expect](https://core.tcl.tk/expect/index) requirements are installed. If you use
homebrew cask on macOS, this works well:

```sh
$ brew install 1password-cli
$ brew install jq expect
```

If you want to automate 2FA (TOTP) logging into 1password.com, then also install the oathtool, and
see further instructions below.

```sh
$ brew install oath-toolkit
```

Copy the 1pass executable file to a suitable location on your PATH (for example, /usr/local/bin)
and ensure that it is executable. For example:

```sh
curl https://raw.githubusercontent.com/dcreemer/1pass/master/1pass > /usr/local/bin/1pass
chmod a+x /usr/local/bin/1pass
```

### Bash Completion

If you would like to install bash-completion for 1pass, place the `bash-completion.sh` script in
and accessible location and then source it from your `.bash_profile`.  For example:

```sh
mkdir -p /usr/local/etc/1pass
curl https://raw.githubusercontent.com/dcreemer/1pass/master/bash_completion.sh > /usr/local/etc/1pass/bash_completion.sh
echo "source /usr/local/etc/1pass/bash_completion.sh" >> ~/.bash_profile
```

By default the completion script will look for `fzf` completion support in your environment. If present,
it will use fzf completion ([see here](https://github.com/junegunn/fzf#fuzzy-completion-for-bash-and-zsh)).

_Note: If you have installed `fzf` using homebrew on macOS, make sure you have enabled completion by
running `$(brew --prefix)/opt/fzf/install --completion` and follow the prompts._

If you do not have fzf or if you turn this feature off it will revert to standard bash completion
behavior. If you would like to explicitly disable FZF completion for 1pass, you can do so as follows:

```sh
export ONEPASS_FZF_COMPLETE=false
```
This line should be added to your `.bash_profile`

## Security and Warning

**1pass** requires you to store your 1Password master password in a local GPG-encrypted file. You
should inspect the source code to ensure that you trust the software, as well as read this
documentation to understand the security tradeoffs.

Like the 1Password application itself, **1pass** relies on *one password*. However that password is
**not** your 1Password "master password" -- it is your Gnu Privacy Guard ([gpg](https://gnupg.org/))
private key. GPG, when configured to use the GPG-agent, will cache your private key password for a
configurable length of time (a few hours to a day is perhaps reasonable). **1pass** uses your GPG
key to store an encrypted copies of your 1Password master password and your 1Password account secret
key.

When data is needed from your online 1Password data store, the master password and secret key are
temporarily decrypted and exchanged for a session token, which is also then encrypted and stored.
The session token will be refreshed as needed. These actions happen automatically once your GPG key
is available in the GPG-agent.

The data that is fetched from the 1Password service is cached in local files -- once again also
encrypted using your GPG private key.

You can "lock" your **1pass** session by running the "forget" command:

```sh
$ 1pass -f
cleared local session
```

which removes the local session token (if any), and calls ```gpgconf --kill gpg-agent``` to purge
any running gpg-agent of your GPG secret keys.

## Configuration

In order to run with minimum user input, **1pass** relies on the Gnu Privacy Guard
[gpg](https://gnupg.org/) to encrypt all locally stored data. 1Password needs both a *master
password* and a *secret key* to access your vault. Each of these must be stored in an encrypted
file (in ~/.1pass or `$XDG_CONFIG_HOME/1pass`) for 1pass to work correctly. 1pass encrypts these
and all other files with your own gpg key. This key, as well as your 1Password login email and
domain must be configured in the ~/.1pass/config file. The domain is the full domain name that you
use to sign-in when you use the 1Password website, for example `example.1password.com` or
`subdomain.1password.ca`.

GPG can be configured to use the ```gpg-agent```, which can prompt for your *gpg* password, and
cache it in a local agent for a fixed amount of time. If you configure GPG this way, you will only
need to enter you GPG password (e.g.) once a day, and then seldom need to enter your 1Password
master password.

Running ```1pass -rv``` repeatedly will output instructions on how to configure this file and safely
store your master password and secret key.

```sh
$ ./1pass -rv
please config 1pass by editing /home/me/.1pass/config
$ vi ~/.1pass/config
$ ./1pass -rv
please put your master password into /home/me/.1pass/_master.gpg
ex: echo "master-password" | gpg -er me@example.com > /home/me/.1pass/_master.gpg
$ echo "sEcre77" | gpg -er me@example.com > /home/me/.1pass/_master.gpg
$ ./1pass -rv
please put your mysubdomain.1password.com secret key into /home/me/.1pass/_secret.gpg
ex: echo "A3-XXXXXX-XXXXXX-XXXXX-XXXXX-XXXXX-XXXXX" | gpg -er me@example.com > /home/me/.1pass/_secret.gpg
$ echo "A3-XXXXXX-XXXXXX-XXXXX-XXXXX-XXXXX-XXXXX" | gpg -er me@example.com > /home/me/.1pass/_secret.gpg
$ ./1pass -rv
signing in to mysubdomain.1password.com me@example.com
...
```

## Usage

Once you are configured and signed in, you are ready to use **1pass**. The simplest command is
**1pass** with no arguments to list all items in your vault:

```sh
$ 1pass
Github
MyBankAccount
gmail.com
...
```

The list consists of the *titles* of each item. You can then retrieve the password of an item:

```sh
$ 1pass -p Github
sjd$kh23@0dfjs1DDj
```

The password is echoed to the standard output (when the '-p' option is used). You can easily use
this in scripts, for example:

```sh
export PGPASSWORD=$(1pass -p MyPostgresServer)
```

Without the '-p' option, 1pass copies the password to the clipboard:

```sh
$ 1pass Github
```

The contents of the clipboard will be automatically cleared after 30 seconds. You can also pass
**1pass** an optional field argument -- for example "username" to retrieve that field from the item:

```sh
$ 1pass -p MyBankAccount username
me@example.com
```

Sometimes it's easier to pass the title to search for via stdin, rather than as a command line
argument. Use the `-` character to force 1pass to read from stdin for the value.

```sh
$ echo "MyBankAccount" | 1pass -p - username
me@example.com
```

**1pass** can lookup other fields besides username or password. They field name is the "label" for
the field in the 1Password GUI.

```sh
$ 1pass -p MyBankAccount pin
1234
```

**1pass** has special support for TOTP fields -- these are fetched directly via `op`
rather than a local cache. (Thanks to (@ev0rtex)[https://github.com/ev0rtex]).
Note that this **is different** from using TOTP 2FA to log into your 1Password
account (that is supported too -- see below)

```sh
$ 1pass -p MyBankAccount totp
9865432
```

## FZF Integration

**1pass** can be nicely combined with [fzf](https://github.com/junegunn/fzf) for fuzzy search and
completion.

Starting with 1pass v1.5:

```sh
$ 1pass | fzf | 1pass -p -
```

which can be easily created as an alias in your `.bashrc` or equivalent:

`alias fp="1pass | fzf | 1pass -p -"`

In older versions: See [fuzzpass.sh](fuzzpass.sh) or [fuzzpass.fish](fuzzpass.fish) for sample
integration functions.

## Emacs

For the brave, a trivial Emacs wrapper library is included. E.g.

```elisp
(setq freenode-nick-username (1pass--item-username "Freenode/nick1"))
(setq freenode-nick-password (1pass--item-password "Freenode/nick1"))
(setq freenode-nick-password (1pass--item-field "Freenode" "server"))
```

## Iterm2 integration

(This work is thanks to [birlog](https://github.com/birlorg)). This integration lets you select and
insert passwords into programs running in iTerm2(shell). If you are tired of typing in your sudo
password, this is for you.

This is effectively a clone of [sudolikeaboss](https://github.com/ravenac95/sudolikeaboss)
functionality. with the caveat that all of your passwords are available, not just ones tagged
x-sudolikeaboss

Using [choose](https://github.com/chipsenkbeil/choose) (a GUI fzf clone)

in iTerm2, go to preferences, then keys, add a new key `open-apple+/` to run coprocess and then
copy paste in the command to run box:

`export PATH="/usr/local/bin:/usr/bin"; 1pass | choose | 1pass -p -`

Then start a program asking for input like `sudo -s` and then at the password prompt push the key
you assigned earlier(`open-apple+/` above) and select the password title by typing or arrowing
down/up and then hit enter. It might take a second, as 1pass has to go fetch your password from
1pass, but it then should type in your password and hit enter for you.

If you run into trouble, iTerm2 should attach a little yellow bar at the top, select 'view errors'
and it should then open a new window showing the output of the commands above, you will need to
work through whatever issue comes up.

If you get a `Command not found error` You installed choose, 1pass or op other than
`/usr/local/bin/`, you will need to edit the PATH part of the line above.

FZF will not work in place of choose, as coprocesses if they want to ask for user input need to
happen in their own window.


## Caching and Sessions

When using **1pass**, all response data from 1Password is encrypted and then cached to
```~/.1pass/cache```. Sometimes this cache will be out of date -- for example if you have created a
new password entry via the 1Password application. Passing ```-r``` to **1pass** will force a refresh
from the online 1Password vault.

Similarly, 1Password CLI sessions last for 30 minutes from the time of last use. **1pass** will
manage the session for you, and refresh it as needed.

## 2FA for 1Password

If you have turned on two-factor authentication (2FA) support for your 1Password account, then
1pass will prompt for you to enter a TOTP code when creating a session. You can either re-enter
this code after every session expiration (30 minutes of inactivity), or automate entry of the code
using the oath-toolkit `oathtool` command. If you wish to automate the 2FA process, add
`use_totp="1"` to your config file, and follow the instructions to store the TOTP secret:

```sh
$ ./1pass -rv
please put your ${domain} totp secret into /home/me/.1pass/_totp.gpg
ex: echo \"XXXXXXXXXXXXXXXX\" | $GPG -er $email > /home/me/.1pass/_totp.gpg
```

## License

Copyright (c) 2017-2021, David Creemer (twitter:
[@dcreemer](https://twitter.com/dcreemer)) with some components from other GPL 2+
software.

[GPL3](https://raw.githubusercontent.com/dcreemer/1pass/master/LICENSE)

## Credits

Some ideas, and a tiny bit of code are taken from [pass](https://www.passwordstore.org) by Jason
A. Donenfeld. Please see the git commit log for contributions from others.


================================================
FILE: bash_completion.sh
================================================
#! /usr/bin/env bash
# add fuzzyfind (fzf) completion for 1pass objects

function _fzf_complete_1pass() {
  local doFzf=false
  local cword="${COMP_WORDS[$COMP_CWORD]}"
  if _should_1p_fzf_complete; then
    doFzf=true
    local trigger=${FZF_COMPLETION_TRIGGER-'**'}
    if [[ -z "$cword" ]]; then
      COMP_WORDS[$COMP_CWORD]=$trigger
    elif [[ "$cword" != *"$trigger" ]]; then
      COMP_WORDS[$COMP_CWORD]="$cword$trigger"
    fi
  fi

  local item
  local words=("${COMP_WORDS[@]::${#COMP_WORDS[@]}-1}")
  for i in "${!words[@]}"; do
    local curr=${words[$i]}
    if [[ $i -ne 0 ]] && [[ ${curr} != "-"* ]]; then
      item=${curr}
      break
    fi
  done
  # Avoid any aliases that might be set
  local opcmd="command 1pass"
  local rcmd=""
  if [[ -z "$item" ]]; then
    rcmd="${opcmd}"
  else
    rcmd="${opcmd} -l \"$item\""
  fi
  if ${doFzf}; then
      _fzf_complete --reverse --prompt="1pass> " -- "${@}" < <(eval "$rcmd")
  else
    COMPREPLY=()
    local search
    # The rest adapted from https://stackoverflow.com/a/1146716/190100
    search=$(eval echo "$cword" 2>/dev/null || eval echo "$cword'" 2>/dev/null || eval echo "$cword\"" 2>/dev/null || eval echo "" 2>/dev/null )
    local IFS=$'\n'
    while read -r line; do COMPREPLY+=("$line"); done < <(compgen -W "$(_1p_entries "${rcmd}")" -- "$search")
    local escaped_single_qoute="'\''"
    local i=0
    for entry in "${COMPREPLY[@]}"
    do
        if [[ "${cword:0:1}" == "'" ]]
        then
            # started with single quote, escaping only other single quotes
            # [']bla'bla"bla\bla bla --> [']bla'\''bla"bla\bla bla
            COMPREPLY[$i]="${entry//\'/${escaped_single_qoute}}"
        elif [[ "${cword:0:1}" == "\"" ]]
        then
            # started with double quote, escaping all double quotes and all backslashes
            # ["]bla'bla"bla\bla bla --> ["]bla'bla\"bla\\bla bla
            entry="${entry//\\/\\\\}"
            COMPREPLY[$i]="${entry//\"/\\\"}"
        else
            # no quotes in front, escaping _everything_
            # [ ]bla'bla"bla\bla bla --> [ ]bla\'bla\"bla\\bla\ bla
            entry="${entry//\\/\\\\}"
            entry="${entry//\'/\'}"
            entry="${entry//\"/\\\"}"
            COMPREPLY[$i]="${entry// /\\ }"
        fi
        (( i++ ))
    done
  fi
}
complete -F _fzf_complete_1pass -o default -o bashdefault 1pass

function _should_1p_fzf_complete() {
  ${ONEPASS_FZF_COMPLETE:-true} && declare -f _fzf_complete > /dev/null 2>&1
}

function _1p_entries() {
  eval "$*" | sed -e "{" -e 's#\\#\\\\#g' -e "s#'#\\\'#g" -e 's#"#\\\"#g' -e "}"
}


================================================
FILE: config.sample
================================================
# configuration file for 1pass

# set to the ID of your GPG key
self_key="<key-id>"

# set to the email address associated with your 1Password account
email="<email address>"

# set to your 1password domain (e.g. example.1password.com)
domain="<example.1password.com>"


================================================
FILE: fuzzpass.fish
================================================
function fuzzpass
  set arg $argv[1]
  if test -z "$arg"
    set arg "password"
  end 
  set item (1pass | fzf)

  [ -n $item ] & 1pass $item $arg
end


================================================
FILE: fuzzpass.sh
================================================
#!/usr/bin/env bash
#
# -*- shell-script -*-
#
# Use fzf (https://github.com/junegunn/fzf) to rapidly select an account,
# and run 1pass (with optional argument) on the result.
# To use this, source this file in your .bashrc or .profile as appropriate,
# e.g.
#
# source fuzzpass.sh
#

fuzzpass() {
    local arg
    arg=$1
    if [ "$arg" = "" ]; then
        arg="password"
    fi
    local item
    item=$(1pass | fzf);
    [[ -n "$item" ]] && 1pass "$item" "$arg"
}