[
{
"path": ".github/workflows/shellcheck.yml",
"content": "# check with Shellcheck (https://www.shellcheck.net/) linter\n#\n\nname: shellcheck\n\non: push\n\njobs:\n shellcheck:\n name: Shellcheck\n runs-on: ubuntu-latest\n\n steps:\n - name: checkout code\n uses: actions/checkout@v2\n\n - name: Run ShellCheck\n uses: ludeeus/action-shellcheck@master\n env:\n SHELLCHECK_OPTS: -x\n"
},
{
"path": ".gitignore",
"content": "*~\n.DS_Store\n"
},
{
"path": "1pass",
"content": "#! /usr/bin/env bash\n#\n# 1pass -- a simple caching wrapper for the \"op\" 1Password CLI.\n#\n# Copyright (C) 2017 David Creemer, (twitter: @dcreemer)\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with this program. If not, see .\n#\n\nset -e\nset -o pipefail\n\nVERSION=\"1.6.1\"\n\nif [ \"$XDG_CONFIG_HOME\" != \"\" ] && [ ! -d \"${HOME}/.1pass\" ]; then\n op_dir=\"${XDG_CONFIG_HOME}/1pass\"\nelse\n op_dir=${HOME}/.1pass\nfi\n\nif [ \"$XDG_CACHE_HOME\" != \"\" ] && [ ! -d \"${op_dir}/cache\" ]; then\n cache_dir=\"${XDG_CACHE_HOME}/1pass\"\nelse\n cache_dir=${op_dir}/cache\nfi\n\nos=$(uname)\n\n# check for bare -V/version request first:\nif [ $# -eq 1 ] && [ \"$1\" == \"-V\" ]; then\n echo \"${VERSION}\"\n exit 0\nfi\n\n# Try to find the GPG executable\nif [ -z \"$GPG\" ]; then\n # Default to gpg, but prefer what gpgconf says\n GPG=\"gpg\"\n if command -v gpgconf >/dev/null 2>&1; then\n GPG=\"$( gpgconf | awk -F: '/^gpg:/ { print $NF }' )\"\n fi\nfi\n\n# test setup:\nif [ ! -d \"$op_dir\" ] || [ ! -r \"${op_dir}/config\" ]; then\n mkdir -p \"$cache_dir\"\n cat > \"${op_dir}/config\" < ${master}\"\n exit 1\nfi\n\nif [ ! -r \"${secret}\" ]; then\n echo \"please put your ${domain} secret key into ${secret}\"\n echo \"ex: echo \\\"A3-XXXXXX-XXXXXX-XXXXX-XXXXX-XXXXX-XXXXX\\\" | $GPG -er $email > ${secret}\"\n exit 1\nfi\n\nif [ \"${use_totp}\" == \"1\" ] && [ ! -r \"${totp}\" ]; then\n echo \"please put your ${domain} totp secret into ${totp}\"\n echo \"ex: echo \\\"XXXXXXXXXXXXXXXX\\\" | $GPG -er $email > ${totp}\"\n exit 1\nfi\n\nindex=${cache_dir}/_index.gpg\nsession=${cache_dir}/_session.gpg\ntoken=\"\"\nget_result=\"\"\nOPTIND=1\nrefresh=0\nverbose=0\nprint_output=0\nclip_time=30\nOP_SESSION_NAME=$(echo \"$domain\" | cut -f1 -d'.' | tr '-' '_')\nlist_fields=0\nOPBIN=\"op1\"\n\nusage()\n{\ncat <|- []]\n\n -f Forget GPG key from gpg-agent, and remove local session\n -h Help\n -p Print the 1pass output to stdout, rather than copying to the clipboard\n -l List all the known fields for the specified item\n -r Refresh all appropriate data from 1password.com, ignoring local cache\n -v Verbose output\n -V Print 1pass version and exit\n\nWith no arguments, prints a list of all Logins and Passwords in all 1Password vaults.\n\nWith a single argument, fetches the Item (Login, Password, or TOTP) matching the\ngiven name, and copies the resulting password to the clipboard. If \"-\" is supplied\nfor - , the item is read from stdin.\n\nWith two arguments, fetches the specified field (e.g.) \"username\" from the named\nitem, and copies the results to the clipboard.\nUSAGE\n}\n\nsanity_check()\n{\n programs=(\"$OPBIN\" jq \"$GPG\" expect)\n\n if [ \"$use_totp\" == \"1\" ]; then\n programs+=(oathtool)\n fi\n if [ \"$os\" == \"Linux\" ] || [ \"$os\" == \"FreeBSD\" ]; then\n if [ \"$XDG_SESSION_TYPE\" == \"wayland\" ]; then\n programs+=(wl-copy)\n else\n programs+=(xclip)\n fi\n fi\n\n for cmd in \"${programs[@]}\"\n do\n if [ $verbose -eq 1 ]; then\n echo \"checking for $cmd\" 1>&2\n fi\n if ! command -v \"$cmd\" > /dev/null; then\n echo \"Cannot find the '$cmd' command. Please make sure it is installed\" 1>&2\n exit 1\n fi\n done\n\n opversion=$(\"$OPBIN\" --version)\n if [ \"${opversion:0:1}\" -gt 1 ]; then\n echo \"Only 1Password CLI version 1 is supported (found $opversion)\" 1>&2\n exit 1\n fi\n}\n\nsignin()\n{\n local pw\n pw=$(\"$GPG\" -d -q \"$master\")\n local se\n se=$(\"$GPG\" -d -q \"$secret\")\n if [ \"${use_totp}\" == \"1\" ]; then\n local ot\n totp=$(\"$GPG\" -d -q \"$totp\")\n ot=$(oathtool -b --totp \"$totp\")\n fi\n if [ $verbose -eq 1 ]; then\n echo \"signing in to ${domain} $email\" 1>&2\n fi\n local script\n if [ \"${use_totp}\" == \"0\" ]; then\n script=\"\n spawn ${OPBIN} signin ${domain} ${email} ${se}\n expect \\\"${domain}:\\\"\n send \\\"${pw}\\n\\\"\n expect {\n \\\"Enter your six-digit authentication code:\\\" {\n puts -nonewline stderr \\\"Enter your six-digit authentication code: \\\"\n flush stderr\n interact -o \\\"\\r\\\" return\n puts stderr \\\"\\\"\n exp_continue\n }\n eof\n }\n \"\n else\n local script=\"\n spawn ${OPBIN} signin ${domain} ${email} ${se}\n expect \\\"${domain}:\\\"\n send \\\"${pw}\\n\\\"\n expect {\n \\\"Enter your six-digit authentication code:\\\" {\n flush stderr\n send -- \\\"$ot\\r\\\"\n puts stderr \\\"\\\"\n exp_continue\n }\n eof\n }\n \"\n fi\n local output0\n output0=$(expect -c \"${script}\")\n local output\n output=$(echo \"${output0}\" | grep \"export\" || echo -n \"_fail_\")\n if [ \"$output\" == \"_fail_\" ]; then\n echo \"1pass failed to signin to ${domain}\"\n exit 1\n fi\n # extract token from 'export OP_SESSION_domain=\"asdsad\"'\n local token\n token=$(expr \"${output}\" : '.*=\"\\(.*\\)\"')\n echo -n \"${token}\" | \"$GPG\" -qe --batch -r \"$self_key\" > \"$session\"\n}\n\ninit_session()\n{\n if [ \"${token}\" != \"\" ]; then\n # already have token\n return\n fi\n # test for stale session\n if [ ! -r \"$session\" ] || [ ! \"$(find \"$session\" -mmin -29)\" ] || [ $refresh -eq 1 ]; then\n signin\n else\n if [ $verbose -eq 1 ]; then\n echo \"using existing session token\" 1>&2\n fi\n fi\n token=$(\"$GPG\" -d -q \"$session\")\n touch \"$session\"\n}\n\nforget_session()\n{\n unset \"$OP_SESSION_NAME\"\n rm -f \"$session\"\n gpgconf --kill gpg-agent\n echo \"cleared local session\"\n}\n\n#\n# fetch the index of all items from the net, and cache\n#\nfetch_index()\n{\n init_session\n if [ $verbose -eq 1 ]; then\n echo \"fetching index of all items\" 1>&2\n fi\n local items\n items=$(\"$OPBIN\" list items --session=\"${token}\" || echo -n \"_fail_\")\n if [ \"$items\" == \"_fail_\" ]; then\n echo \"1pass: failed to fetch index of all items\"\n exit 1\n fi\n # backup current index\n if [ -r \"$index\" ]; then\n cp -a \"$index\" \"${index}.bak\"\n fi\n echo -n \"${items}\" | \"$GPG\" -qe --batch -r \"$self_key\" > \"$index\"\n}\n\n#\n# fetch an item from the net by uuid and cache it locally\n#\nfetch_item()\n{\n local uuid=$1\n init_session\n if [ $verbose -eq 1 ]; then\n echo \"fetching item $uuid\" 1>&2\n fi\n local item\n item=$(\"$OPBIN\" get item \"$uuid\" --session=\"$token\" || echo -n \"_fail_\")\n if [ \"$item\" == \"_fail_\" ]; then\n echo \"1pass: failed to fetch item $uuid\"\n exit 1\n fi\n echo -n \"${item}\" | \"$GPG\" -qe --batch -r \"$self_key\" > \"${cache_dir}/${uuid}.gpg\"\n}\n\n#\n# list the titles of all items in the index\n#\nlist_items()\n{\n if [ ! -r \"$index\" ] || [ $refresh -eq 1 ]; then\n fetch_index\n fi\n \"$GPG\" -qd \"$index\" | jq -r \".[].overview.title\" | LC_ALL=\"C\" bash -c 'sort -bf'\n}\n\n#\n# ensure we have the local gpg encoded file of the item given by the uuid\n#\nensure_item()\n{\n local uuid=$1\n local file=${cache_dir}/${uuid}.gpg\n if [ ! -r \"$file\" ] || [ $refresh -eq 1 ]; then\n fetch_item \"$uuid\"\n fi\n}\n\n#\n# fetch a field from template 001 (\"Login\")\n#\nget_001()\n{\n local uuid=$1\n local field=${2/\"DEFAULT\"/\"password\"}\n local q=\"\"\n if [ \"$field\" == \"username\" ] || [ \"$field\" == \"password\" ]; then\n q=\".details.fields[] | select(.designation==\\\"${field}\\\").value\"\n else\n q=\".details.sections[] | select(.fields).fields[] | select(.t==\\\"${field}\\\").v\"\n fi\n ensure_item \"$uuid\"\n get_result=$(\"$GPG\" -qd \"${cache_dir}/${uuid}.gpg\" | jq -r \"${q}\" || echo -n \"_fail_\")\n}\n\n#\n# fetch a field from template 005 (\"Password\")\n#\nget_005()\n{\n local uuid=$1\n local field=${2/\"DEFAULT\"/\"password\"}\n local q=\"\"\n if [ \"$field\" == \"password\" ]; then\n q=\".details.${field}\"\n else\n q=\".details.sections[] | select(.fields).fields[] | select(.t==\\\"${field}\\\").v\"\n fi\n ensure_item \"$uuid\"\n get_result=$(\"$GPG\" -qd \"${cache_dir}/${uuid}.gpg\" | jq -r \"${q}\" || echo -n \"_fail_\")\n}\n\n#\n# fetch a field from template 003 (\"Secure Note / notesPlain\")\n#\nget_003()\n{\n local uuid=$1\n local field=${2/\"DEFAULT\"/\"notes\"}\n if [ \"$field\" == \"notes\" ]; then\n # notes feels more natural than notesPlain\n q=\".details.notesPlain\"\n else\n q=\".details.sections[] | select(.fields).fields[] | select(.t==\\\"${field}\\\").v\"\n fi\n\n ensure_item \"$uuid\"\n\n get_result=$(\"$GPG\" -qd \"${cache_dir}/${uuid}.gpg\" | jq -r \"${q}\" || echo -n \"_fail_\")\n}\n\n#\n# fetch a field from template 110 (\"Server\")\n#\nget_110()\n{\n local uuid=$1\n local field=${2/\"DEFAULT\"/\"password\"}\n local q=\".details.sections[] | select(.fields).fields[] | select(.t==\\\"${field}\\\").v\"\n\n ensure_item \"$uuid\"\n\n get_result=$(\"$GPG\" -qd \"${cache_dir}/${uuid}.gpg\" | jq -r \"${q}\" || echo -n \"_fail_\")\n}\n\n#\n# fetch the list of fields from template 001 (\"Login\")\n#\nget_fields_001()\n{\n _get_fields_template \"$1\" \"username\" \"password\"\n}\n\n#\n# fetch the list of fields from template 003 (\"Secure Note\")\n#\nget_fields_003()\n{\n _get_fields_template \"$1\" \"notes\"\n}\n\n#\n# fetch the list of fields from template 005 (\"Password\")\n#\nget_fields_005()\n{\n _get_fields_template \"$1\" \"password\"\n}\n\n#\n# fetch the list of fields from template 110 (\"Server\")\n#\nget_fields_110()\n{\n _get_fields_template \"$1\"\n}\n\n_get_fields_template()\n{\n local uuid=$1\n shift\n local q='.details.sections[] | select(.fields).fields[] | select(.t!=\"\").t'\n local fields=(\"${@}\")\n ensure_item \"$uuid\"\n while read -r f; do\n fields+=(\"$f\")\n done < <(\"$GPG\" -qd \"${cache_dir}/${uuid}.gpg\" | jq -r \"${q}\" || echo -n \"_fail_\")\n get_result=$(_join_by $'\\n' \"${fields[@]}\")\n}\n\nfunction _join_by { local IFS=\"$1\"; shift; echo \"$*\"; }\n\n#\n# fetch a TOTP value for the given item\n#\nget_totp()\n{\n # Make sure we have a current and valid session and then get the UUID\n init_session\n if [ ! -r \"$index\" ] || [ $refresh -eq 1 ]; then\n fetch_index\n fi\n local title\n title=\"${1}\"\n if [ \"$title\" == \"-\" ]; then\n # read title from stdin. turn off error propogation to handle EOF as well as NL\n set +e\n read -r title\n set -e\n fi\n\n local uuid\n uuid=$(\"$GPG\" -qd \"$index\" | jq -r \".[] | select(.overview.title==\\\"$title\\\").uuid\")\n # Fetch the TOTP\n if [ $verbose -eq 1 ]; then\n echo \"fetching TOTP for $uuid\" 1>&2\n fi\n local totp\n totp=$(\"$OPBIN\" get totp \"$uuid\" --session=\"$token\" || echo -n \"_fail_\")\n if [ \"$item\" == \"_fail_\" ]; then\n echo \"1pass: failed to fetch TOTP for $uuid\"\n exit 1\n fi\n if [ $? ]; then\n get_result=\"${totp}\"\n output_result\n fi\n}\n\noutput_result()\n{\n if [ $print_output -eq 1 ]; then\n echo \"${get_result}\"\n else\n local pbcopy\n pbcopy=pbcopy\n if [ \"$os\" == \"Linux\" ] || [ \"$os\" == \"FreeBSD\" ]; then\n if [ \"$XDG_SESSION_TYPE\" == \"wayland\" ]; then\n pbcopy=\"wl-copy\"\n else\n pbcopy=\"xclip -selection clipboard\"\n fi\n fi\n echo -n \"${get_result}\" | $pbcopy\n # sleep and reset clipboard\n local sleep_argv0\n sleep_argv0=\"1pass sleep for user $(id -u)\"\n pkill -f \"^$sleep_argv0\" 2>/dev/null && sleep 0.5\n (\n ( exec -a \"$sleep_argv0\" sleep \"$clip_time\" )\n echo -n \"CLEAR\" | $pbcopy\n ) 2>/dev/null & disown\n fi\n}\n\nget_by_title()\n{\n _get_by \"get_\" \"${@}\"\n}\n\nget_fields_by_title()\n{\n _get_by \"get_fields_\" \"${@}\"\n}\n\n_get_by()\n{\n local func=$1\n local title=$2\n local field=$3\n if [ \"$title\" == \"-\" ]; then\n # read title from stdin. turn off error propogation to handle EOF as well as NL\n set +e\n read -r title\n set -e\n fi\n if [ ! -r \"$index\" ] || [ $refresh -eq 1 ]; then\n fetch_index\n fi\n # read both uuid and templateUuid. Complicated call is so that we only call GPG once\n q=\".[] | select(.overview.title==\\\"${title}\\\").uuid + \\\":\\\" + select(.overview.title==\\\"${title}\\\").templateUuid\"\n IFS=':' read -r uuid tid <<< \"$(\"$GPG\" -qd \"$index\" | jq -r \"${q}\")\"\n if [ \"$tid\" != \"\" ]; then\n \"${func}${tid}\" \"$uuid\" \"$field\"\n if [ $? ]; then\n output_result\n fi\n fi\n}\n\nwhile getopts \"f?h?p?l?r?v?:\" opt; do\n case $opt in\n h)\n usage\n exit 0\n ;;\n f)\n forget_session\n exit 0\n ;;\n p)\n print_output=1\n ;;\n l)\n print_output=1\n list_fields=1\n ;;\n r)\n refresh=1\n ;;\n v)\n verbose=1\n ;;\n \\?)\n echo \"Invalid option: -$OPTARG\" >&2\n ;;\n esac\ndone\n\nshift $((OPTIND-1))\n\nsanity_check\n\nif [ $# -eq 0 ]; then\n list_items\nelif [ $# -eq 1 ]; then\n if [[ $list_fields -eq 1 ]]; then\n get_fields_by_title \"$1\"\n else\n get_by_title \"$1\" DEFAULT\n fi\nelif [ $# -eq 2 ]; then\n case \"$2\" in\n totp ) get_totp \"$1\" ;;\n * ) get_by_title \"$1\" \"$2\" ;;\n esac\nfi\n"
},
{
"path": "1pass.el",
"content": ";;; 1pass.el -- tiny wrapper to get usernames & passwords from 1pass\n;;\n;; Copyright (C) 2017 David Creemer, (twitter: @dcreemer)\n;;\n;; This program is free software: you can redistribute it and/or modify\n;; it under the terms of the GNU General Public License as published by\n;; the Free Software Foundation, either version 3 of the License, or\n;; (at your option) any later version.\n;;\n;; This program is distributed in the hope that it will be useful,\n;; but WITHOUT ANY WARRANTY; without even the implied warranty of\n;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n;; GNU General Public License for more details.\n;;\n;; You should have received a copy of the GNU General Public License\n;; along with this program. If not, see .\n;;\n\n;;; Commentary:\n;;\n;; Thin wrapper around the 1pass CLI utility. It is likely that bugs will be\n;; found, so please report any findings as issues or pull requests here:\n;; https://github.com/dcreemer/1pass\n\n;;; Code:\n(require 's)\n\n(defvar 1pass-cli-executable\n (executable-find \"1pass\")\n \"Path to the 1pass executable.\")\n\n;; private helpers\n(defun 1pass--cli-run (item field)\n \"Call 1pass with given ITEM and FIELD.\"\n (with-temp-buffer\n (let* ((exit-code\n (apply #'call-process\n (list 1pass-cli-executable nil t nil \"-p\" item field))))\n (if (zerop exit-code)\n (s-chomp (buffer-string))\n (error (s-chomp (buffer-string)))))))\n\n;; public API\n(defun 1pass-field-for (item field)\n \"Lookup ITEM in 1pass and return the data from the given FIELD, if any.\"\n (1pass--cli-run item field))\n\n(defun 1pass-password-for (item)\n \"Lookup ITEM in 1pass and return the password, if any.\"\n (1pass--cli-run item \"password\"))\n\n(defun 1pass-username-for (item)\n \"Lookup ITEM in 1pass and return the username, if any.\"\n (1pass--cli-run item \"username\"))\n\n;; deprecated API:\n(define-obsolete-function-alias '1pass--item-field '1pass-field-for)\n(define-obsolete-function-alias '1pass--item-password '1pass-password-for)\n(define-obsolete-function-alias '1pass--item-username '1pass-username-for)\n\n(provide '1pass)\n\n;;; 1pass.el ends here\n"
},
{
"path": "LICENSE",
"content": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n"
},
{
"path": "README.md",
"content": "# 1pass\n\n**1pass** is a caching wrapper for the [1Password\nCLI](https://support.1password.com/command-line-getting-started/) `op`.\n\n\n\n## NO LONGER MAINTAINED\n\nI am no longer maintaining this software, as the 1Password CLI version 2\nprovides all of the features I need.\n\n## WARNING 1password 2 CLI compatibility\n\nDo not upgrade to 1password CLI version 2! This `1pass` tool is not yet compatible with\nit.\n\n## UPGRADE NOTE\n\nUpgrading to version 1.1 requires installation of the\n[expect](https://core.tcl.tk/expect/index) tool. `1pass` will check for this (and\nother) dependencies and remind you to install them.\n\n## Introduction\n\n**1pass** is designed to make using your 1Password usernames and passwords quick and easy. It is\nintended for use within an interactive shell as well as from scripts. Once installed and configured\nas described below, you can obtain an account password in a shell simply by typing:\n\n```sh\n$ 1pass Github\n```\n\nand your Github password will be copied to the clipboard.\n\nThe official 1Password CLI application (```op```) can be difficult to use interactively, and unlike\nthe macOS or Windows 1Password native applications, requires an internet connection to fetch data\nfrom your password vaults. **1pass** solves both of these problems. ```Op``` needs session tokens to\nbe revalidated manually after 30 minutes of inactivity and produces rich output in JSON format. The\nJSON output is easy for a program to use, but is not trivially consumed by humans without help.\n**1pass** provides that help, with two main features:\n\n- a simplified interface for listing and fetching usernames, passwords, and other fields for\n individual items.\n- an encrypted local cache of 1Password CLI results.\n\nTogether these features enable easy use of 1Password-stored credentials.\n\n## Installation\n\nFirst make sure that the `op` [1Password\nCLI](https://support.1password.com/command-line-getting-started/) and the `jq`\n[JQ](https://stedolan.github.io/jq) and\n[expect](https://core.tcl.tk/expect/index) requirements are installed. If you use\nhomebrew cask on macOS, this works well:\n\n```sh\n$ brew install 1password-cli\n$ brew install jq expect\n```\n\nIf you want to automate 2FA (TOTP) logging into 1password.com, then also install the oathtool, and\nsee further instructions below.\n\n```sh\n$ brew install oath-toolkit\n```\n\nCopy the 1pass executable file to a suitable location on your PATH (for example, /usr/local/bin)\nand ensure that it is executable. For example:\n\n```sh\ncurl https://raw.githubusercontent.com/dcreemer/1pass/master/1pass > /usr/local/bin/1pass\nchmod a+x /usr/local/bin/1pass\n```\n\n### Bash Completion\n\nIf you would like to install bash-completion for 1pass, place the `bash-completion.sh` script in\nand accessible location and then source it from your `.bash_profile`. For example:\n\n```sh\nmkdir -p /usr/local/etc/1pass\ncurl https://raw.githubusercontent.com/dcreemer/1pass/master/bash_completion.sh > /usr/local/etc/1pass/bash_completion.sh\necho \"source /usr/local/etc/1pass/bash_completion.sh\" >> ~/.bash_profile\n```\n\nBy default the completion script will look for `fzf` completion support in your environment. If present,\nit will use fzf completion ([see here](https://github.com/junegunn/fzf#fuzzy-completion-for-bash-and-zsh)).\n\n_Note: If you have installed `fzf` using homebrew on macOS, make sure you have enabled completion by\nrunning `$(brew --prefix)/opt/fzf/install --completion` and follow the prompts._\n\nIf you do not have fzf or if you turn this feature off it will revert to standard bash completion\nbehavior. If you would like to explicitly disable FZF completion for 1pass, you can do so as follows:\n\n```sh\nexport ONEPASS_FZF_COMPLETE=false\n```\nThis line should be added to your `.bash_profile`\n\n## Security and Warning\n\n**1pass** requires you to store your 1Password master password in a local GPG-encrypted file. You\nshould inspect the source code to ensure that you trust the software, as well as read this\ndocumentation to understand the security tradeoffs.\n\nLike the 1Password application itself, **1pass** relies on *one password*. However that password is\n**not** your 1Password \"master password\" -- it is your Gnu Privacy Guard ([gpg](https://gnupg.org/))\nprivate key. GPG, when configured to use the GPG-agent, will cache your private key password for a\nconfigurable length of time (a few hours to a day is perhaps reasonable). **1pass** uses your GPG\nkey to store an encrypted copies of your 1Password master password and your 1Password account secret\nkey.\n\nWhen data is needed from your online 1Password data store, the master password and secret key are\ntemporarily decrypted and exchanged for a session token, which is also then encrypted and stored.\nThe session token will be refreshed as needed. These actions happen automatically once your GPG key\nis available in the GPG-agent.\n\nThe data that is fetched from the 1Password service is cached in local files -- once again also\nencrypted using your GPG private key.\n\nYou can \"lock\" your **1pass** session by running the \"forget\" command:\n\n```sh\n$ 1pass -f\ncleared local session\n```\n\nwhich removes the local session token (if any), and calls ```gpgconf --kill gpg-agent``` to purge\nany running gpg-agent of your GPG secret keys.\n\n## Configuration\n\nIn order to run with minimum user input, **1pass** relies on the Gnu Privacy Guard\n[gpg](https://gnupg.org/) to encrypt all locally stored data. 1Password needs both a *master\npassword* and a *secret key* to access your vault. Each of these must be stored in an encrypted\nfile (in ~/.1pass or `$XDG_CONFIG_HOME/1pass`) for 1pass to work correctly. 1pass encrypts these\nand all other files with your own gpg key. This key, as well as your 1Password login email and\ndomain must be configured in the ~/.1pass/config file. The domain is the full domain name that you\nuse to sign-in when you use the 1Password website, for example `example.1password.com` or\n`subdomain.1password.ca`.\n\nGPG can be configured to use the ```gpg-agent```, which can prompt for your *gpg* password, and\ncache it in a local agent for a fixed amount of time. If you configure GPG this way, you will only\nneed to enter you GPG password (e.g.) once a day, and then seldom need to enter your 1Password\nmaster password.\n\nRunning ```1pass -rv``` repeatedly will output instructions on how to configure this file and safely\nstore your master password and secret key.\n\n```sh\n$ ./1pass -rv\nplease config 1pass by editing /home/me/.1pass/config\n$ vi ~/.1pass/config\n$ ./1pass -rv\nplease put your master password into /home/me/.1pass/_master.gpg\nex: echo \"master-password\" | gpg -er me@example.com > /home/me/.1pass/_master.gpg\n$ echo \"sEcre77\" | gpg -er me@example.com > /home/me/.1pass/_master.gpg\n$ ./1pass -rv\nplease put your mysubdomain.1password.com secret key into /home/me/.1pass/_secret.gpg\nex: echo \"A3-XXXXXX-XXXXXX-XXXXX-XXXXX-XXXXX-XXXXX\" | gpg -er me@example.com > /home/me/.1pass/_secret.gpg\n$ echo \"A3-XXXXXX-XXXXXX-XXXXX-XXXXX-XXXXX-XXXXX\" | gpg -er me@example.com > /home/me/.1pass/_secret.gpg\n$ ./1pass -rv\nsigning in to mysubdomain.1password.com me@example.com\n...\n```\n\n## Usage\n\nOnce you are configured and signed in, you are ready to use **1pass**. The simplest command is\n**1pass** with no arguments to list all items in your vault:\n\n```sh\n$ 1pass\nGithub\nMyBankAccount\ngmail.com\n...\n```\n\nThe list consists of the *titles* of each item. You can then retrieve the password of an item:\n\n```sh\n$ 1pass -p Github\nsjd$kh23@0dfjs1DDj\n```\n\nThe password is echoed to the standard output (when the '-p' option is used). You can easily use\nthis in scripts, for example:\n\n```sh\nexport PGPASSWORD=$(1pass -p MyPostgresServer)\n```\n\nWithout the '-p' option, 1pass copies the password to the clipboard:\n\n```sh\n$ 1pass Github\n```\n\nThe contents of the clipboard will be automatically cleared after 30 seconds. You can also pass\n**1pass** an optional field argument -- for example \"username\" to retrieve that field from the item:\n\n```sh\n$ 1pass -p MyBankAccount username\nme@example.com\n```\n\nSometimes it's easier to pass the title to search for via stdin, rather than as a command line\nargument. Use the `-` character to force 1pass to read from stdin for the value.\n\n```sh\n$ echo \"MyBankAccount\" | 1pass -p - username\nme@example.com\n```\n\n**1pass** can lookup other fields besides username or password. They field name is the \"label\" for\nthe field in the 1Password GUI.\n\n```sh\n$ 1pass -p MyBankAccount pin\n1234\n```\n\n**1pass** has special support for TOTP fields -- these are fetched directly via `op`\nrather than a local cache. (Thanks to (@ev0rtex)[https://github.com/ev0rtex]).\nNote that this **is different** from using TOTP 2FA to log into your 1Password\naccount (that is supported too -- see below)\n\n```sh\n$ 1pass -p MyBankAccount totp\n9865432\n```\n\n## FZF Integration\n\n**1pass** can be nicely combined with [fzf](https://github.com/junegunn/fzf) for fuzzy search and\ncompletion.\n\nStarting with 1pass v1.5:\n\n```sh\n$ 1pass | fzf | 1pass -p -\n```\n\nwhich can be easily created as an alias in your `.bashrc` or equivalent:\n\n`alias fp=\"1pass | fzf | 1pass -p -\"`\n\nIn older versions: See [fuzzpass.sh](fuzzpass.sh) or [fuzzpass.fish](fuzzpass.fish) for sample\nintegration functions.\n\n## Emacs\n\nFor the brave, a trivial Emacs wrapper library is included. E.g.\n\n```elisp\n(setq freenode-nick-username (1pass--item-username \"Freenode/nick1\"))\n(setq freenode-nick-password (1pass--item-password \"Freenode/nick1\"))\n(setq freenode-nick-password (1pass--item-field \"Freenode\" \"server\"))\n```\n\n## Iterm2 integration\n\n(This work is thanks to [birlog](https://github.com/birlorg)). This integration lets you select and\ninsert passwords into programs running in iTerm2(shell). If you are tired of typing in your sudo\npassword, this is for you.\n\nThis is effectively a clone of [sudolikeaboss](https://github.com/ravenac95/sudolikeaboss)\nfunctionality. with the caveat that all of your passwords are available, not just ones tagged\nx-sudolikeaboss\n\nUsing [choose](https://github.com/chipsenkbeil/choose) (a GUI fzf clone)\n\nin iTerm2, go to preferences, then keys, add a new key `open-apple+/` to run coprocess and then\ncopy paste in the command to run box:\n\n`export PATH=\"/usr/local/bin:/usr/bin\"; 1pass | choose | 1pass -p -`\n\nThen start a program asking for input like `sudo -s` and then at the password prompt push the key\nyou assigned earlier(`open-apple+/` above) and select the password title by typing or arrowing\ndown/up and then hit enter. It might take a second, as 1pass has to go fetch your password from\n1pass, but it then should type in your password and hit enter for you.\n\nIf you run into trouble, iTerm2 should attach a little yellow bar at the top, select 'view errors'\nand it should then open a new window showing the output of the commands above, you will need to\nwork through whatever issue comes up.\n\nIf you get a `Command not found error` You installed choose, 1pass or op other than\n`/usr/local/bin/`, you will need to edit the PATH part of the line above.\n\nFZF will not work in place of choose, as coprocesses if they want to ask for user input need to\nhappen in their own window.\n\n\n## Caching and Sessions\n\nWhen using **1pass**, all response data from 1Password is encrypted and then cached to\n```~/.1pass/cache```. Sometimes this cache will be out of date -- for example if you have created a\nnew password entry via the 1Password application. Passing ```-r``` to **1pass** will force a refresh\nfrom the online 1Password vault.\n\nSimilarly, 1Password CLI sessions last for 30 minutes from the time of last use. **1pass** will\nmanage the session for you, and refresh it as needed.\n\n## 2FA for 1Password\n\nIf you have turned on two-factor authentication (2FA) support for your 1Password account, then\n1pass will prompt for you to enter a TOTP code when creating a session. You can either re-enter\nthis code after every session expiration (30 minutes of inactivity), or automate entry of the code\nusing the oath-toolkit `oathtool` command. If you wish to automate the 2FA process, add\n`use_totp=\"1\"` to your config file, and follow the instructions to store the TOTP secret:\n\n```sh\n$ ./1pass -rv\nplease put your ${domain} totp secret into /home/me/.1pass/_totp.gpg\nex: echo \\\"XXXXXXXXXXXXXXXX\\\" | $GPG -er $email > /home/me/.1pass/_totp.gpg\n```\n\n## License\n\nCopyright (c) 2017-2021, David Creemer (twitter:\n[@dcreemer](https://twitter.com/dcreemer)) with some components from other GPL 2+\nsoftware.\n\n[GPL3](https://raw.githubusercontent.com/dcreemer/1pass/master/LICENSE)\n\n## Credits\n\nSome ideas, and a tiny bit of code are taken from [pass](https://www.passwordstore.org) by Jason\nA. Donenfeld. Please see the git commit log for contributions from others.\n"
},
{
"path": "bash_completion.sh",
"content": "#! /usr/bin/env bash\n# add fuzzyfind (fzf) completion for 1pass objects\n\nfunction _fzf_complete_1pass() {\n local doFzf=false\n local cword=\"${COMP_WORDS[$COMP_CWORD]}\"\n if _should_1p_fzf_complete; then\n doFzf=true\n local trigger=${FZF_COMPLETION_TRIGGER-'**'}\n if [[ -z \"$cword\" ]]; then\n COMP_WORDS[$COMP_CWORD]=$trigger\n elif [[ \"$cword\" != *\"$trigger\" ]]; then\n COMP_WORDS[$COMP_CWORD]=\"$cword$trigger\"\n fi\n fi\n\n local item\n local words=(\"${COMP_WORDS[@]::${#COMP_WORDS[@]}-1}\")\n for i in \"${!words[@]}\"; do\n local curr=${words[$i]}\n if [[ $i -ne 0 ]] && [[ ${curr} != \"-\"* ]]; then\n item=${curr}\n break\n fi\n done\n # Avoid any aliases that might be set\n local opcmd=\"command 1pass\"\n local rcmd=\"\"\n if [[ -z \"$item\" ]]; then\n rcmd=\"${opcmd}\"\n else\n rcmd=\"${opcmd} -l \\\"$item\\\"\"\n fi\n if ${doFzf}; then\n _fzf_complete --reverse --prompt=\"1pass> \" -- \"${@}\" < <(eval \"$rcmd\")\n else\n COMPREPLY=()\n local search\n # The rest adapted from https://stackoverflow.com/a/1146716/190100\n search=$(eval echo \"$cword\" 2>/dev/null || eval echo \"$cword'\" 2>/dev/null || eval echo \"$cword\\\"\" 2>/dev/null || eval echo \"\" 2>/dev/null )\n local IFS=$'\\n'\n while read -r line; do COMPREPLY+=(\"$line\"); done < <(compgen -W \"$(_1p_entries \"${rcmd}\")\" -- \"$search\")\n local escaped_single_qoute=\"'\\''\"\n local i=0\n for entry in \"${COMPREPLY[@]}\"\n do\n if [[ \"${cword:0:1}\" == \"'\" ]]\n then\n # started with single quote, escaping only other single quotes\n # [']bla'bla\"bla\\bla bla --> [']bla'\\''bla\"bla\\bla bla\n COMPREPLY[$i]=\"${entry//\\'/${escaped_single_qoute}}\"\n elif [[ \"${cword:0:1}\" == \"\\\"\" ]]\n then\n # started with double quote, escaping all double quotes and all backslashes\n # [\"]bla'bla\"bla\\bla bla --> [\"]bla'bla\\\"bla\\\\bla bla\n entry=\"${entry//\\\\/\\\\\\\\}\"\n COMPREPLY[$i]=\"${entry//\\\"/\\\\\\\"}\"\n else\n # no quotes in front, escaping _everything_\n # [ ]bla'bla\"bla\\bla bla --> [ ]bla\\'bla\\\"bla\\\\bla\\ bla\n entry=\"${entry//\\\\/\\\\\\\\}\"\n entry=\"${entry//\\'/\\'}\"\n entry=\"${entry//\\\"/\\\\\\\"}\"\n COMPREPLY[$i]=\"${entry// /\\\\ }\"\n fi\n (( i++ ))\n done\n fi\n}\ncomplete -F _fzf_complete_1pass -o default -o bashdefault 1pass\n\nfunction _should_1p_fzf_complete() {\n ${ONEPASS_FZF_COMPLETE:-true} && declare -f _fzf_complete > /dev/null 2>&1\n}\n\nfunction _1p_entries() {\n eval \"$*\" | sed -e \"{\" -e 's#\\\\#\\\\\\\\#g' -e \"s#'#\\\\\\'#g\" -e 's#\"#\\\\\\\"#g' -e \"}\"\n}\n"
},
{
"path": "config.sample",
"content": "# configuration file for 1pass\n\n# set to the ID of your GPG key\nself_key=\"\"\n\n# set to the email address associated with your 1Password account\nemail=\"\"\n\n# set to your 1password domain (e.g. example.1password.com)\ndomain=\"\"\n"
},
{
"path": "fuzzpass.fish",
"content": "function fuzzpass\n set arg $argv[1]\n if test -z \"$arg\"\n set arg \"password\"\n end \n set item (1pass | fzf)\n\n [ -n $item ] & 1pass $item $arg\nend\n"
},
{
"path": "fuzzpass.sh",
"content": "#!/usr/bin/env bash\n#\n# -*- shell-script -*-\n#\n# Use fzf (https://github.com/junegunn/fzf) to rapidly select an account,\n# and run 1pass (with optional argument) on the result.\n# To use this, source this file in your .bashrc or .profile as appropriate,\n# e.g.\n#\n# source fuzzpass.sh\n#\n\nfuzzpass() {\n local arg\n arg=$1\n if [ \"$arg\" = \"\" ]; then\n arg=\"password\"\n fi\n local item\n item=$(1pass | fzf);\n [[ -n \"$item\" ]] && 1pass \"$item\" \"$arg\"\n}\n"
}
]