411 lines
13 KiB
Python
411 lines
13 KiB
Python
#!/usr/bin/env python3
|
|
|
|
# SPDX-FileCopyrightText: Chris Braun (cryzed) <cryzed@googlemail.com>
|
|
#
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
"""
|
|
Insert login information using pass and a dmenu-compatible application (e.g. dmenu, rofi -dmenu, ...). A short
|
|
demonstration can be seen here: https://i.imgur.com/KN3XuZP.gif.
|
|
"""
|
|
|
|
USAGE = """The domain of the site has to appear as a segment in the pass path,
|
|
for example: "github.com/cryzed" or "websites/github.com". Alternatively the
|
|
parameter `--unfiltered` may be used to get a list of all passwords. How the
|
|
username and password are determined is freely configurable using the CLI
|
|
arguments. As an example, if you instead store the username as part of the
|
|
secret (and use a site's name as filename), instead of the default configuration,
|
|
use `--username-target secret` and `--username-pattern "username: (.+)"`.
|
|
|
|
The login information is inserted by emulating key events using qutebrowser's
|
|
fake-key command in this manner: [USERNAME]<Tab>[PASSWORD], which is compatible
|
|
with almost all login forms.
|
|
|
|
If you use gopass with multiple mounts, use the CLI switch --mode gopass to switch to gopass mode.
|
|
|
|
Suggested bindings similar to Uzbl's `formfiller` script:
|
|
|
|
config.bind('<z><l>', 'spawn --userscript qute-pass')
|
|
config.bind('<z><u><l>', 'spawn --userscript qute-pass --username-only')
|
|
config.bind('<z><p><l>', 'spawn --userscript qute-pass --password-only')
|
|
config.bind('<z><o><l>', 'spawn --userscript qute-pass --otp-only')
|
|
"""
|
|
|
|
EPILOG = """Dependencies: tldextract (Python 3 module), pass, pass-otp (optional).
|
|
|
|
WARNING: The login details are viewable as plaintext in qutebrowser's debug log (qute://log) and might be shared if
|
|
you decide to submit a crash report!"""
|
|
|
|
import argparse
|
|
import enum
|
|
import fnmatch
|
|
import functools
|
|
import idna
|
|
import os
|
|
import re
|
|
import shlex
|
|
import subprocess
|
|
import sys
|
|
import unicodedata
|
|
from urllib.parse import urlparse
|
|
|
|
import tldextract
|
|
|
|
|
|
def expanded_path(path):
|
|
# Expand potential ~ in paths, since this script won't be called from a shell that does it for us
|
|
expanded = os.path.expanduser(path)
|
|
# Add trailing slash if not present
|
|
return os.path.join(expanded, "")
|
|
|
|
|
|
argument_parser = argparse.ArgumentParser(
|
|
description=__doc__, usage=USAGE, epilog=EPILOG
|
|
)
|
|
argument_parser.add_argument("url", nargs="?", default=os.getenv("QUTE_URL"))
|
|
argument_parser.add_argument(
|
|
"--password-store",
|
|
"-p",
|
|
default=expanded_path(os.getenv("PASSWORD_STORE_DIR", default="~/.password-store")),
|
|
help="Path to your pass password-store (only used in pass-mode)",
|
|
type=expanded_path,
|
|
)
|
|
argument_parser.add_argument(
|
|
"--mode",
|
|
"-M",
|
|
choices=["pass", "gopass"],
|
|
default="pass",
|
|
help="Select mode [gopass] to use gopass instead of the standard pass.",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--prefix",
|
|
type=str,
|
|
help="Search only the given subfolder of the store (only used in gopass-mode)",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--username-pattern",
|
|
"-u",
|
|
default=r".*/(.+)",
|
|
help="Regular expression that matches the username",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--username-target",
|
|
"-U",
|
|
choices=["path", "secret"],
|
|
default="path",
|
|
help="The target for the username regular expression",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--password-pattern",
|
|
"-P",
|
|
default=r"(.*)",
|
|
help="Regular expression that matches the password",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--dmenu-invocation",
|
|
"-d",
|
|
default="rofi -dmenu",
|
|
help="Invocation used to execute a dmenu-provider",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--no-insert-mode",
|
|
"-n",
|
|
dest="insert_mode",
|
|
action="store_false",
|
|
help="Don't automatically enter insert mode",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--io-encoding",
|
|
"-i",
|
|
default="UTF-8",
|
|
help="Encoding used to communicate with subprocesses",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--merge-candidates",
|
|
"-m",
|
|
action="store_true",
|
|
help="Merge pass candidates for fully-qualified and registered domain name",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--extra-url-suffixes",
|
|
"-s",
|
|
default="",
|
|
help="Comma-separated string containing extra suffixes (e.g local)",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--unfiltered",
|
|
dest="unfiltered",
|
|
action="store_true",
|
|
help="Show an unfiltered selection of all passwords in the store",
|
|
)
|
|
argument_parser.add_argument(
|
|
"--always-show-selection",
|
|
dest="always_show_selection",
|
|
action="store_true",
|
|
help="Always show selection, even if there is only a single match",
|
|
)
|
|
group = argument_parser.add_mutually_exclusive_group()
|
|
group.add_argument(
|
|
"--username-only", "-e", action="store_true", help="Only insert username"
|
|
)
|
|
group.add_argument(
|
|
"--password-only", "-w", action="store_true", help="Only insert password"
|
|
)
|
|
group.add_argument("--otp-only", "-o", action="store_true", help="Only insert OTP code")
|
|
|
|
stderr = functools.partial(print, file=sys.stderr)
|
|
|
|
|
|
class ExitCodes(enum.IntEnum):
|
|
SUCCESS = 0
|
|
FAILURE = 1
|
|
# 1 is automatically used if Python throws an exception
|
|
NO_PASS_CANDIDATES = 2
|
|
COULD_NOT_MATCH_USERNAME = 3
|
|
COULD_NOT_MATCH_PASSWORD = 4
|
|
|
|
|
|
class CouldNotMatchUsername(Exception):
|
|
pass
|
|
|
|
|
|
class CouldNotMatchPassword(Exception):
|
|
pass
|
|
|
|
|
|
def qute_command(command):
|
|
with open(os.environ["QUTE_FIFO"], "w") as fifo:
|
|
fifo.write(command + "\n")
|
|
fifo.flush()
|
|
|
|
|
|
# Encode candidate string parts as Internationalized Domain Name, doing
|
|
# Unicode normalization before. This allows to properly match (non-ASCII)
|
|
# pass entries with the corresponding domain names.
|
|
def idna_encode(name):
|
|
# Do Unicode normalization first, we use form NFKC because:
|
|
# 1. Use the compatibility normalization because these sequences have "the same meaning in some contexts"
|
|
# 2. idna.encode() below requires the Unicode strings to be in normalization form C
|
|
# See https://en.wikipedia.org/wiki/Unicode_equivalence#Normal_forms
|
|
unicode_normalized = unicodedata.normalize("NFKC", name)
|
|
# Empty strings can not be encoded, they appear for example as empty
|
|
# parts in split_path. If something like this happens, we just fall back
|
|
# to the unicode representation (which may already be ASCII then).
|
|
try:
|
|
idna_encoded = idna.encode(unicode_normalized)
|
|
except idna.IDNAError:
|
|
idna_encoded = unicode_normalized
|
|
return idna_encoded
|
|
|
|
|
|
def find_pass_candidates(domain, unfiltered=False):
|
|
candidates = []
|
|
|
|
if arguments.mode == "gopass":
|
|
gopass_args = ["gopass", "list", "--flat"]
|
|
if arguments.prefix:
|
|
gopass_args.append(arguments.prefix)
|
|
all_passwords = (
|
|
subprocess.run(gopass_args, stdout=subprocess.PIPE)
|
|
.stdout.decode("UTF-8")
|
|
.splitlines()
|
|
)
|
|
|
|
for password in all_passwords:
|
|
if unfiltered or domain in password:
|
|
candidates.append(password)
|
|
else:
|
|
idna_domain = idna_encode(domain)
|
|
for path, directories, file_names in os.walk(
|
|
arguments.password_store, followlinks=True
|
|
):
|
|
secrets = fnmatch.filter(file_names, "*.gpg")
|
|
if not secrets:
|
|
continue
|
|
|
|
# Strip password store path prefix to get the relative pass path
|
|
pass_path = path[len(arguments.password_store) :]
|
|
split_path = pass_path.split(os.path.sep)
|
|
idna_split_path = [idna_encode(part) for part in split_path]
|
|
for secret in secrets:
|
|
secret_base = os.path.splitext(secret)[0]
|
|
idna_secret_base = idna_encode(secret_base)
|
|
if not unfiltered and idna_domain not in (
|
|
idna_split_path + [idna_secret_base]
|
|
):
|
|
continue
|
|
|
|
# Append the unencoded Unicode path/name since this is how pass uses them
|
|
candidates.append(os.path.join(pass_path, secret_base))
|
|
return candidates
|
|
|
|
|
|
def _run_pass(pass_arguments):
|
|
# The executable is conveniently named after it's mode [pass|gopass].
|
|
pass_command = [arguments.mode]
|
|
env = os.environ.copy()
|
|
env["PASSWORD_STORE_DIR"] = arguments.password_store
|
|
process = subprocess.run(
|
|
pass_command + pass_arguments, env=env, stdout=subprocess.PIPE
|
|
)
|
|
return process.stdout.decode(arguments.io_encoding).strip()
|
|
|
|
|
|
def pass_(path):
|
|
return _run_pass(["show", path])
|
|
|
|
|
|
def pass_otp(path):
|
|
if arguments.mode == "gopass":
|
|
return _run_pass(["otp", "-o", path])
|
|
return _run_pass(["otp", path])
|
|
|
|
|
|
def dmenu(items, invocation):
|
|
command = shlex.split(invocation)
|
|
process = subprocess.run(
|
|
command,
|
|
input="\n".join(items).encode(arguments.io_encoding),
|
|
stdout=subprocess.PIPE,
|
|
)
|
|
return process.stdout.decode(arguments.io_encoding).strip()
|
|
|
|
|
|
def fake_key_raw(text):
|
|
for character in text:
|
|
# Escape all characters by default, space requires special handling
|
|
sequence = '" "' if character == " " else r"\{}".format(character)
|
|
qute_command("fake-key {}".format(sequence))
|
|
|
|
|
|
def extract_password(secret, pattern):
|
|
match = re.match(pattern, secret)
|
|
if not match:
|
|
raise CouldNotMatchPassword("Pattern did not match target")
|
|
try:
|
|
return match.group(1)
|
|
except IndexError:
|
|
raise CouldNotMatchPassword(
|
|
"Pattern did not contain capture group, please use capture group. Example: (.*)"
|
|
)
|
|
|
|
|
|
def extract_username(target, pattern):
|
|
match = re.search(pattern, target, re.MULTILINE)
|
|
if not match:
|
|
raise CouldNotMatchUsername("Pattern did not match target")
|
|
try:
|
|
return match.group(1)
|
|
except IndexError:
|
|
raise CouldNotMatchUsername(
|
|
"Pattern did not contain capture group, please use capture group. Example: (.*)"
|
|
)
|
|
|
|
|
|
def main(arguments):
|
|
if not arguments.url:
|
|
argument_parser.print_help()
|
|
return ExitCodes.FAILURE
|
|
|
|
extractor = tldextract.TLDExtract(
|
|
extra_suffixes=arguments.extra_url_suffixes.split(",")
|
|
)
|
|
extract_result = extractor(arguments.url)
|
|
|
|
# Try to find candidates using targets in the following order: fully-qualified domain name (includes subdomains),
|
|
# the registered domain name, the IPv4 address if that's what the URL represents and finally the private domain
|
|
# (if a non-public suffix was used), and the URL netloc.
|
|
candidates = set()
|
|
attempted_targets = []
|
|
|
|
private_domain = ""
|
|
if not extract_result.suffix:
|
|
private_domain = (
|
|
".".join((extract_result.subdomain, extract_result.domain))
|
|
if extract_result.subdomain
|
|
else extract_result.domain
|
|
)
|
|
|
|
netloc = urlparse(arguments.url).netloc
|
|
|
|
for target in filter(
|
|
None,
|
|
[
|
|
extract_result.fqdn,
|
|
extract_result.registered_domain,
|
|
extract_result.ipv4,
|
|
private_domain,
|
|
netloc,
|
|
],
|
|
):
|
|
attempted_targets.append(target)
|
|
target_candidates = find_pass_candidates(
|
|
target, unfiltered=arguments.unfiltered
|
|
)
|
|
if not target_candidates:
|
|
continue
|
|
|
|
candidates.update(target_candidates)
|
|
if not arguments.merge_candidates:
|
|
break
|
|
else:
|
|
if not candidates:
|
|
stderr(
|
|
"No pass candidates for URL {!r} found! (I tried {!r})".format(
|
|
arguments.url, attempted_targets
|
|
)
|
|
)
|
|
return ExitCodes.NO_PASS_CANDIDATES
|
|
|
|
if len(candidates) == 1 and not arguments.always_show_selection:
|
|
selection = candidates.pop()
|
|
else:
|
|
selection = dmenu(sorted(candidates), arguments.dmenu_invocation)
|
|
|
|
# Nothing was selected, simply return
|
|
if not selection:
|
|
return ExitCodes.SUCCESS
|
|
|
|
# If username-target is path and user asked for username-only, we don't need to run pass.
|
|
# Or if using otp-only, it will run pass on its own.
|
|
secret = None
|
|
if (
|
|
not (arguments.username_target == "path" and arguments.username_only)
|
|
and not arguments.otp_only
|
|
):
|
|
secret = pass_(selection)
|
|
username_target = selection if arguments.username_target == "path" else secret
|
|
try:
|
|
if arguments.username_only:
|
|
fake_key_raw(extract_username(username_target, arguments.username_pattern))
|
|
elif arguments.password_only:
|
|
fake_key_raw(extract_password(secret, arguments.password_pattern))
|
|
elif arguments.otp_only:
|
|
otp = pass_otp(selection)
|
|
fake_key_raw(otp)
|
|
else:
|
|
# Enter username and password using fake-key and <Tab> (which seems to work almost universally), then switch
|
|
# back into insert-mode, so the form can be directly submitted by hitting enter afterwards
|
|
fake_key_raw(extract_username(username_target, arguments.username_pattern))
|
|
qute_command("fake-key <Tab>")
|
|
fake_key_raw(extract_password(secret, arguments.password_pattern))
|
|
except CouldNotMatchPassword as e:
|
|
stderr("Failed to match password, target: secret, error: {}".format(e))
|
|
return ExitCodes.COULD_NOT_MATCH_PASSWORD
|
|
except CouldNotMatchUsername as e:
|
|
stderr(
|
|
"Failed to match username, target: {}, error: {}".format(
|
|
arguments.username_target, e
|
|
)
|
|
)
|
|
return ExitCodes.COULD_NOT_MATCH_USERNAME
|
|
|
|
if arguments.insert_mode:
|
|
qute_command("mode-enter insert")
|
|
|
|
return ExitCodes.SUCCESS
|
|
|
|
|
|
if __name__ == "__main__":
|
|
arguments = argument_parser.parse_args()
|
|
sys.exit(main(arguments))
|