123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647 |
- # -*- coding: utf-8 -*-
- """
- # Simple password manager
- # Copyright (c) 2011-2024 Michael Büsch <m@bues.ch>
- # Licensed under the GNU/GPL version 2 or later.
- """
- from libpwman.database import *
- from libpwman.dbdiff import *
- from libpwman.exception import *
- from libpwman.otp import *
- from libpwman.ui_escape import *
- from libpwman.util import *
- import functools
- import os
- import pathlib
- import re
- import readline
- import sys
- import time
- import traceback
- from cmd import Cmd
- from copy import copy
- from dataclasses import dataclass, field
- from typing import Optional, Tuple
- if osIsPosix:
- import signal
- __all__ = [
- "PWMan",
- "PWManTimeout",
- ]
- class PWManTimeout(Exception):
- def __init__(self, seconds):
- if seconds is not None and seconds >= 0:
- self.seconds = seconds
- if osIsPosix:
- signal.signal(signal.SIGALRM, self.__timeout)
- self.poke()
- else:
- raise PWManError("Timeout is not supported on this OS.")
- else:
- self.seconds = None
- def poke(self):
- if self.seconds is not None:
- signal.alarm(self.seconds)
- def __timeout(self, signum, frame):
- raise self
- @dataclass
- class PWManOpts:
- """UI command option parser.
- """
- __opts : list = field(default_factory=list)
- __params : list = field(default_factory=list)
- __atCmdIndex : dict = field(default_factory=dict)
- __error : Optional[Tuple[str, str]] = None
- @classmethod
- def parse(cls,
- line,
- optTemplates,
- ignoreFirst=False,
- unescape=True,
- softFail=False):
- """Parses the command options in 'line' and returns an Opts instance.
- optTemplates is a tuple of the possible options.
- """
- optTemplatesRaw = cls.rawOptTemplates(optTemplates)
- opts = cls()
- i = 0
- while True:
- p = cls.parseParam(line, i,
- ignoreFirst=ignoreFirst,
- unescape=unescape)
- if not p:
- break
- if opts.nrParams:
- opts._appendParam(i, p)
- else:
- try:
- optIdx = optTemplatesRaw.index(p)
- except ValueError:
- opts._appendParam(i, p)
- i += 1
- continue
- if optTemplates[optIdx].endswith(":"):
- i += 1
- arg = cls.parseParam(line, i,
- ignoreFirst=ignoreFirst,
- unescape=unescape)
- if not arg and softFail:
- opts._setError(p, "no_arg")
- break
- if not arg:
- PWMan._err(None, "Option '%s' "
- "requires an argument." % p)
- opts._appendOpt(i, p, arg)
- else:
- opts._appendOpt(i, p)
- i += 1
- return opts
- def _appendOpt(self, cmdIndex, optName, optValue=None):
- self.__opts.append( (optName, optValue) )
- self.__atCmdIndex[cmdIndex] = (optName, optValue)
- def _appendParam(self, cmdIndex, param):
- self.__params.append(param)
- self.__atCmdIndex[cmdIndex] = (None, param)
- def _setError(self, optName, error):
- self.__error = (optName, error)
- def __contains__(self, optName):
- """Check if we have a specific "-X" style option.
- """
- return optName in (o[0] for o in self.__opts)
- @property
- def error(self):
- return self.__error
- @property
- def hasOpts(self):
- """Do we have -X style options?
- """
- return bool(self.__opts)
- def getOpt(self, optName, default=None):
- """Get an option value by "-X" style name.
- """
- if optName in self:
- return [ o[1] for o in self.__opts if o[0] == optName ][-1]
- return default
- @property
- def nrParams(self):
- """The number of trailing parameters.
- """
- return len(self.__params)
- def getParam(self, index, default=None):
- """Get a trailing parameter at index.
- """
- if index < 0 or index >= self.nrParams:
- return default
- return self.__params[index]
- def getComplParamIdx(self, complText):
- """Get the parameter index in an active completion.
- complText: The partial parameter text in the completion.
- """
- if complText:
- paramIdx = self.nrParams - 1
- else:
- paramIdx = self.nrParams
- if paramIdx < 0:
- return None
- return paramIdx
- def atCmdIndex(self, cmdIndex):
- """Get an item (option or parameter) at command line index cmdIndex.
- Returns (optName, optValue) if it is an option.
- Returns (None, parameter) if it is a parameter.
- Returns (None, None) if it does not exist.
- """
- return self.__atCmdIndex.get(cmdIndex, (None, None))
- @classmethod
- def skipParams(cls, line, count,
- lineIncludesCommand=False, unescape=True):
- """Return a parameter string with the first 'count'
- parameters skipped.
- """
- sline = cls.patchSpaceEscapes(line)
- if lineIncludesCommand:
- count += 1
- i = 0
- while i < len(sline) and count > 0:
- while i < len(sline) and not sline[i].isspace():
- i += 1
- while i < len(sline) and sline[i].isspace():
- i += 1
- count -= 1
- if i >= len(sline):
- return ""
- s = line[i:]
- if unescape:
- s = unescapeCmd(s)
- return s
- @classmethod
- def calcParamIndex(cls, line, endidx):
- """Returns the parameter index into the commandline
- given the character end-index. This honors space-escape.
- """
- line = cls.patchSpaceEscapes(line)
- startidx = endidx - 1
- while startidx > 0 and not line[startidx].isspace():
- startidx -= 1
- return len([l for l in line[:startidx].split() if l]) - 1
- @classmethod
- def patchSpaceEscapes(cls, line):
- # Patch a commandline for simple whitespace based splitting.
- # We just replace the space escape sequence by a random
- # non-whitespace string. The line remains the same size.
- return line.replace('\\ ', '_S')
- @classmethod
- def parseParam(cls, line, paramIndex,
- ignoreFirst=False, unescape=True):
- """Returns the full parameter from the commandline.
- """
- sline = cls.patchSpaceEscapes(line)
- if ignoreFirst:
- paramIndex += 1
- inParam = False
- idx = 0
- for startIndex, c in enumerate(sline):
- if c.isspace():
- if inParam:
- idx += 1
- inParam = False
- else:
- inParam = True
- if idx == paramIndex:
- break
- else:
- return ""
- endIndex = startIndex
- while endIndex < len(sline) and not sline[endIndex].isspace():
- endIndex += 1
- p = line[startIndex : endIndex]
- if unescape:
- p = unescapeCmd(p)
- return p
- @classmethod
- def parseComplParam(cls, line, paramIndex, unescape=True):
- return cls.parseParam(line, paramIndex,
- ignoreFirst=True, unescape=unescape)
- @classmethod
- def parseParams(cls, line, paramIndex, count,
- ignoreFirst=False, unescape=True):
- """Returns a generator of the specified parameters from the commandline.
- paramIndex: start index.
- count: Number of paramerts to fetch.
- """
- return ( cls.parseParam(line, i, ignoreFirst, unescape)
- for i in range(paramIndex, paramIndex + count) )
- @classmethod
- def parseComplParams(cls, line, paramIndex, count, unescape=True):
- return cls.parseParams(line, paramIndex, count,
- ignoreFirst=True, unescape=unescape)
- @classmethod
- def rawOptTemplates(cls, optTemplates):
- """Remove the modifiers from opt templates.
- """
- return [ ot.replace(":", "") for ot in optTemplates ]
- # PWMan completion decorator that does common things and workarounds.
- def completion(func):
- @functools.wraps(func)
- def wrapper(self, text, line, begidx, endidx):
- try:
- self._timeout.poke()
- # Find the real begidx that takes space escapes into account.
- sline = PWManOpts.patchSpaceEscapes(line)
- realBegidx = endidx
- while realBegidx > 0:
- if sline[realBegidx - 1] == " ":
- break
- realBegidx -= 1
- if begidx == realBegidx:
- textPrefix = ""
- else:
- # Workaround: Patch the begidx to fully
- # honor all escapes. Remember the text
- # between the real begidx and the orig begidx.
- # It must be removed from the results.
- textPrefix = line[realBegidx : begidx]
- begidx = realBegidx
- # Fixup text.
- # By fetching the parameter again it is ensured that
- # it is properly unescaped.
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- text = PWManOpts.parseComplParam(line, paramIdx)
- # Call the PWMan completion handler.
- completions = func(self, text, line, begidx, endidx)
- # If we fixed begidx in the workaround above,
- # we need to remove the additional prefix from the results,
- # because Cmd/readline won't expect it.
- if textPrefix:
- for i, comp in enumerate(copy(completions)):
- if comp.startswith(textPrefix):
- completions[i] = comp[len(textPrefix) : ]
- return completions
- except (EscapeError, CSQLError, PWManError, PWManTimeout) as e:
- return []
- except Exception as e:
- print("\nException in completion handler:\n\n%s" % (
- traceback.format_exc()),
- file=sys.stderr)
- return []
- return wrapper
- class PWManMeta(type):
- def __new__(cls, name, bases, dct):
- for name, attr in dct.items():
- # Fixup command docstrings.
- if (name.startswith("do_") and
- not getattr(attr, "_pwman_fixed", False) and
- attr.__doc__):
- # Remove leading double-tabs.
- attr.__doc__, n = re.subn("^\t\t", "\t", attr.__doc__,
- 0, re.MULTILINE)
- # Remove trailing white space.
- attr.__doc__ = attr.__doc__.rstrip()
- # Tabs to spaces.
- attr.__doc__, n = re.subn("\t", " " * 8, attr.__doc__,
- 0, re.MULTILINE)
- attr._pwman_fixed = True
- return super().__new__(cls, name, bases, dct)
- class PWMan(Cmd, metaclass=PWManMeta):
- class CommandError(Exception): pass
- class Quit(Exception): pass
- def __init__(self, filename, passphrase, timeout=None):
- super().__init__()
- self.__isInteractive = False
- if sys.flags.optimize >= 2:
- # We need docstrings.
- raise PWManError("pwman does not support "
- "Python optimization level 2 (-OO). "
- "Please call with python3 -O or less.")
- # argument delimiter shall be space.
- readline.set_completer_delims(" ")
- self.__dbs = {
- "main" : PWManDatabase(filename, passphrase, readOnly=False),
- }
- self.__selDbName = "main"
- self.__updatePrompt()
- self._timeout = PWManTimeout(timeout)
- @property
- def __db(self):
- return self._getDb(self.__selDbName)
- def _getDb(self, name):
- return self.__dbs.get(name, None)
- def __updatePrompt(self):
- if len(self.__dbs) > 1:
- dbName = self.__selDbName
- lim = 20
- if len(dbName) > lim - 3:
- dbName = dbName[:lim-3] + "..."
- else:
- dbName = ""
- dirty = any(db.isDirty() for db in self.__dbs.values())
- self.prompt = "%spwman%s%s$ " % (
- "*" if dirty else "",
- "/" if dbName else "",
- dbName
- )
- @classmethod
- def _err(cls, source, message):
- source = (" " + source + ":") if source else ""
- raise cls.CommandError("***%s %s" % (source, message))
- @classmethod
- def _warn(cls, source, message):
- source = (" " + source + ":") if source else ""
- print("***%s %s" % (source, message))
- @classmethod
- def _info(cls, source, message):
- source = ("+++ " + source + ": ") if source else ""
- print("%s%s" % (source, message))
- def precmd(self, line):
- self._timeout.poke()
- first = PWManOpts.parseParam(line, 0, unescape=False)
- if first.endswith('?'):
- return "help %s" % first[:-1]
- return line
- def postcmd(self, stop, line):
- self.__updatePrompt()
- self._timeout.poke()
- def default(self, line):
- extra = "\nType 'help' for more help." if self.__isInteractive else ""
- self._err(None, "Unknown command: %s%s" % (line, extra))
- def emptyline(self):
- self._timeout.poke()
- # Don't repeat the last command
- @completion
- def __complete_category_title(self, text, line, begidx, endidx):
- # Generic [category] [title] completion
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx == 0:
- # Category completion
- return self.__getCategoryCompletions(text)
- elif paramIdx == 1:
- # Entry title completion
- return self.__getEntryTitleCompletions(PWManOpts.parseComplParam(line, 0),
- text)
- return []
- @completion
- def __complete_category_title_item(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx in (0, 1):
- return self.__complete_category_title(text, line, begidx, endidx)
- category, title, item = PWManOpts.parseComplParams(line, 0, 3)
- cmpl = []
- if paramIdx == 2:
- cmpl.extend(escapeCmd(n) + " "
- for n in ("user", "password", "bulk", "totpkey")
- if n.startswith(item))
- cmpl.extend(self.__getEntryAttrCompletions(category, title, item,
- doName=(paramIdx == 2),
- doData=False,
- text=text))
- return cmpl
- def __getCategoryCompletions(self, text, db=None):
- db = db or self.__db
- return [ escapeCmd(n) + " "
- for n in db.getCategoryNames()
- if n.startswith(text) ]
- def __getEntryTitleCompletions(self, category, text, db=None):
- db = db or self.__db
- return [ escapeCmd(t) + " "
- for t in db.getEntryTitles(category)
- if t.startswith(text) ]
- def __getEntryAttrCompletions(self, category, title, name, doName, doData, text, db=None):
- db = db or self.__db
- if category and title:
- entry = db.getEntry(category, title)
- if entry:
- if doName: # complete name
- entryAttrs = db.getEntryAttrs(entry)
- if entryAttrs:
- return [ escapeCmd(entryAttr.name) + " "
- for entryAttr in entryAttrs
- if entryAttr.name.startswith(name) ]
- elif doData: # complete data
- entryAttr = db.getEntryAttr(entry, name)
- if entryAttr:
- return [ escapeCmd(entryAttr.data) + " " ]
- return []
- def __getDatabaseCompletions(self, text):
- return [ escapeCmd(n) + " "
- for n in self.__dbs.keys()
- if n.startswith(text) ]
- def __getPathCompletions(self, text):
- """Return an escaped file system path completion.
- 'text' is the unescaped partial path string.
- """
- try:
- path = pathlib.Path(text)
- trailingChar = text[-1] if text else ""
- sep = os.path.sep
- base = path.parts[-1] if path.parts else ""
- dirPath = pathlib.Path(*path.parts[:-1])
- dirPathListing = [ f for f in dirPath.iterdir()
- if f.parts[-1].startswith(base) ]
- if (path.is_dir() and
- (trailingChar in (sep, "/", "\\") or
- len(dirPathListing) <= 1)):
- # path is an unambiguous directory.
- # Show its contents.
- useListing = path.iterdir()
- else:
- # path is a file or an ambiguous directory.
- # Show the alternatives.
- useListing = dirPathListing
- return [ escapeCmd(str(f)) + (escapeCmd(sep) if f.is_dir() else " ")
- for f in useListing ]
- except OSError:
- pass
- return []
- cmdHelpShow = (
- ("list", ("ls", "cat"), "List/print entry contents"),
- ("find", ("f",), "Search the database for patterns"),
- ("totp", ("t",), "Generate TOTP token"),
- ("diff", (), "Show the database differences"),
- )
- cmdHelpEdit = (
- ("new", ("n", "add"), "Create new entry"),
- ("edit_user", ("eu",), "Edit the 'user' field of an entry"),
- ("edit_pw", ("ep",), "Edit the 'password' field of an entry"),
- ("edit_bulk", ("eb",), "Edit the 'bulk' field of an entry"),
- ("edit_totp", ("et",), "Edit the TOTP key and parameters"),
- ("edit_attr", ("ea",), "Edit an entry attribute"),
- ("move", ("mv", "rename"), "Move/rename an existing entry"),
- ("copy", ("cp",), "Copy an existing entry or category"),
- ("remove", ("rm", "del"), "Remove an existing entry"),
- )
- cmdHelpDatabase = (
- ("database", ("db",), "Open or select another database"),
- ("commit", ("c", "w"), "Commit/write selected db to disk"),
- ("drop", (), "Drop uncommitted changes in selected db"),
- ("close", (), "Close a database"),
- ("dbdump", (), "Dump the selected database"),
- ("dbimport", (), "Import a database dump file"),
- ("masterp", (), "Change the master passphrase"),
- )
- cmdHelpMisc = (
- ("help", ("h",), "Show help about commands"),
- ("quit", ("q", "exit", "^D"), "Quit pwman"),
- ("cls", (), "Clear screen"),
- )
- def do_help(self, params):
- """--- Shows help text about a command ---
- Command: help [COMMAND]
- If COMMAND is not given: Show a command summary.
- If COMMAND is given: Show detailed help about that command.
- Aliases: h
- """
- if params:
- Cmd.do_help(self, params)
- return
- def printCmdHelp(cmdHelp):
- for cmd, aliases, desc in cmdHelp:
- spc = " " * (10 - len(cmd))
- msg = " %s%s%s" % (cmd, spc, desc)
- if aliases:
- msg += " " * (52 - len(msg))
- msg += " Alias%s: %s" %\
- ("es" if len(aliases) > 1 else "",
- ", ".join(aliases))
- self._info(None, msg)
- self._info(None, "\nSearching/listing commands:")
- printCmdHelp(self.cmdHelpShow)
- self._info(None, "\nEditing commands:")
- printCmdHelp(self.cmdHelpEdit)
- self._info(None, "\nDatabase commands:")
- printCmdHelp(self.cmdHelpDatabase)
- self._info(None, "\nMisc commands:")
- printCmdHelp(self.cmdHelpMisc)
- self._info(None, "\nType 'command?' or 'help command' for more help on a command.")
- do_h = do_help
- def do_quit(self, params):
- """--- Exit pwman ---
- Command: quit [!]
- Use the exclamation mark to force quit and discard changes.
- Aliases: q exit ^D
- """
- if params == "!":
- for db in self.__dbs.values():
- db.flunkDirty()
- raise self.Quit()
- do_q = do_quit
- do_exit = do_quit
- do_EOF = do_quit
- def do_cls(self, params):
- """--- Clear console screen ---
- Command: cls
- Clear the console screen.
- Note that this does not clear a possibly existing
- 'screen' session buffer or other advanced console buffers.
- Aliases: None
- """
- clearScreen()
- __commit_opts = ("-a",)
- def do_commit(self, params):
- """--- Write changes to the database file(s) ---
- Command: commit
- Options:
- -a Commit all open databases.
- Aliases: c w
- """
- opts = PWManOpts.parse(params, self.__commit_opts)
- dbs = self.__dbs.values() if "-a" in opts else [ self.__db ]
- try:
- for db in dbs:
- db.commit()
- except PWManError as e:
- self._err("commit", str(e))
- do_c = do_commit
- do_w = do_commit
- @completion
- def complete_commit(self, text, line, begidx, endidx):
- if text == "-":
- return PWManOpts.rawOptTemplates(self.__commit_opts)
- return []
- complete_c = complete_commit
- complete_w = complete_commit
- def do_masterp(self, params):
- """--- Change the master passphrase ---
- Command: masterp
- Aliases: None
- """
- p = readPassphrase("Current master passphrase")
- if p != self.__db.getPassphrase():
- time.sleep(1)
- self._warn(None, "Passphrase mismatch! ")
- return
- p = readPassphrase("Master passphrase", verify=True)
- if p is None:
- self._info(None, "Passphrase not changed.")
- return
- if p != self.__db.getPassphrase():
- self.__db.setPassphrase(p)
- def do_list(self, params):
- """--- Print a listing ---
- Command: list [category] [title] [item]
- If a category is given as parameter, list the
- contents of the category. If category and entry
- are given, list the contents of the entry.
- If item is given, then only list one specific content item.
- Item may be one of: user, password, bulk, totpkey or any attribute name.
- Aliases: ls cat
- """
- category, title, item = PWManOpts.parseParams(params, 0, 3)
- if not category and not title and not item:
- self._info(None, "Categories:")
- self._info(None, "\t" + "\n\t".join(self.__db.getCategoryNames()))
- elif category and not title and not item:
- self._info(None, "Entries in category '%s':" % category)
- self._info(None, "\t" + "\n\t".join(self.__db.getEntryTitles(category)))
- elif category and title and not item:
- entry = self.__db.getEntry(category, title)
- if entry:
- self._info(None, self.__db.dumpEntry(entry))
- else:
- self._err("list", "'%s/%s' not found" % (category, title))
- elif category and title and item:
- entry = self.__db.getEntry(category, title)
- if entry:
- if item == "user":
- if not entry.user:
- self._err("list", "'%s/%s' has no 'user' field." % (
- category, title))
- self._info(None, entry.user)
- elif item == "password":
- if not entry.pw:
- self._err("list", "'%s/%s' has no 'password' field." % (
- category, title))
- self._info(None, entry.pw)
- elif item == "bulk":
- bulk = self.__db.getEntryBulk(entry)
- if not bulk:
- self._err("list", "'%s/%s' has no 'bulk' field." % (
- category, title))
- self._info(None, bulk.data)
- elif item == "totpkey":
- entryTotp = self.__db.getEntryTotp(entry)
- if not entryTotp:
- self._err("list", "'%s/%s' has no 'TOTP key'." % (
- category, title))
- self._info(None, "TOTP key: %s (base32 encoding)" % entryTotp.key)
- self._info(None, "TOTP digits: %d" % entryTotp.digits)
- self._info(None, "TOTP hash: %s" % entryTotp.hmacHash)
- else: # attribute
- attr = self.__db.getEntryAttr(entry, item)
- if not attr:
- self._err("list", "'%s/%s' has no attribute '%s'." % (
- category, title, item))
- self._info(None, attr.data)
- else:
- self._err("list", "'%s/%s' not found" % (category, title))
- else:
- self._err("list", "Invalid parameter")
- do_ls = do_list
- do_cat = do_list
- complete_list = __complete_category_title_item
- complete_ls = complete_list
- complete_cat = complete_list
- def do_new(self, params):
- """--- Create a new entry ---
- Command: new [category] [title] [user] [password]
- Create a new database entry. If no parameters are given,
- they are asked for interactively.
- Aliases: n add
- """
- if params:
- category, title, user, pw = PWManOpts.parseParams(params, 0, 4)
- else:
- self._info("new", "Create new entry:")
- category = input("\tCategory: ")
- title = input("\tEntry title: ")
- user = input("\tUsername: ")
- pw = input("\tPassword: ")
- if not category or not title:
- self._err("new", "Invalid parameters. "
- "Need to supply category and title.")
- entry = PWManEntry(category=category, title=title, user=user, pw=pw)
- try:
- self.__db.addEntry(entry)
- except (PWManError) as e:
- self._err("new", str(e))
- do_n = do_new
- do_add = do_new
- complete_new = __complete_category_title
- complete_n = complete_new
- complete_add = complete_new
- def __do_edit_entry(self, params, commandName,
- entry2data, data2entry):
- category, title = PWManOpts.parseParams(params, 0, 2)
- if not category or not title:
- self._err(commandName, "Invalid parameters. "
- "Need to supply category and title.")
- newData = PWManOpts.skipParams(params, 2).strip()
- try:
- self.__db.editEntry(data2entry(category, title, newData))
- except (PWManError) as e:
- self._err(commandName, str(e))
- def do_edit_user(self, params):
- """--- Edit the 'user' field of an existing entry ---
- Command: edit_user category title NEWDATA...
- Change the 'user' field of an existing database entry.
- NEWDATA is the new data to write into the 'user' field.
- The NEWDATA must _not_ be escaped (however, category and
- title must be escaped).
- Aliases: eu
- """
- self.__do_edit_entry(params, "edit_user",
- lambda entry: entry.user,
- lambda cat, tit, data: PWManEntry(cat, tit, user=data))
- do_eu = do_edit_user
- @completion
- def complete_edit_user(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx == 0:
- # Category completion
- return self.__getCategoryCompletions(text)
- elif paramIdx == 1:
- # Entry title completion
- return self.__getEntryTitleCompletions(PWManOpts.parseComplParam(line, 0),
- text)
- elif paramIdx == 2:
- # User data
- entry = self.__db.getEntry(PWManOpts.parseComplParam(line, 0),
- PWManOpts.parseComplParam(line, 1))
- return [ escapeCmd(entry.user) ]
- return []
- complete_eu = complete_edit_user
- def do_edit_pw(self, params):
- """--- Edit the 'password' field of an existing entry ---
- Command: edit_pw category title NEWDATA...
- Change the 'password' field of an existing database entry.
- NEWDATA is the new data to write into the 'password' field.
- The NEWDATA must _not_ be escaped (however, category and
- title must be escaped).
- Aliases: ep
- """
- self.__do_edit_entry(params, "edit_pw",
- lambda entry: entry.pw,
- lambda cat, tit, data: PWManEntry(cat, tit, pw=data))
- do_ep = do_edit_pw
- @completion
- def complete_edit_pw(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx == 0:
- # Category completion
- return self.__getCategoryCompletions(text)
- elif paramIdx == 1:
- # Entry title completion
- return self.__getEntryTitleCompletions(PWManOpts.parseComplParam(line, 0),
- text)
- elif paramIdx == 2:
- # Password data
- entry = self.__db.getEntry(PWManOpts.parseComplParam(line, 0),
- PWManOpts.parseComplParam(line, 1))
- return [ escapeCmd(entry.pw) ]
- return []
- complete_ep = complete_edit_pw
- def do_edit_bulk(self, params):
- """--- Edit the 'bulk' field of an existing entry ---
- Command: edit_bulk category title NEWDATA...
- Change the 'bulk' field of an existing database entry.
- NEWDATA is the new data to write into the 'bulk' field.
- The NEWDATA must _not_ be escaped (however, category and
- title must be escaped).
- Aliases: eb
- """
- category, title = PWManOpts.parseParams(params, 0, 2)
- data = PWManOpts.skipParams(params, 2).strip()
- if not category:
- self._err("edit_bulk", "Category parameter is required.")
- if not title:
- self._err("edit_bulk", "Title parameter is required.")
- entry = self.__db.getEntry(category, title)
- if not entry:
- self._err("edit_bulk", "'%s/%s' not found" % (category, title))
- entryBulk = self.__db.getEntryBulk(entry)
- if not entryBulk:
- entryBulk = PWManEntryBulk(entry=entry)
- entryBulk.data = data
- self.__db.setEntryBulk(entryBulk)
- do_eb = do_edit_bulk
- @completion
- def complete_edit_bulk(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx == 0:
- # Category completion
- return self.__getCategoryCompletions(text)
- elif paramIdx == 1:
- # Entry title completion
- return self.__getEntryTitleCompletions(PWManOpts.parseComplParam(line, 0),
- text)
- elif paramIdx == 2:
- # Bulk data
- entry = self.__db.getEntry(PWManOpts.parseComplParam(line, 0),
- PWManOpts.parseComplParam(line, 1))
- if entry:
- entryBulk = self.__db.getEntryBulk(entry)
- if entryBulk:
- return [ escapeCmd(entryBulk.data) ]
- return []
- complete_eb = complete_edit_bulk
- def do_remove(self, params):
- """--- Remove an existing entry ---
- Command: remove category [title]
- Remove an existing database entry.
- Aliases: rm del
- """
- category, title = PWManOpts.parseParams(params, 0, 2)
- if not category:
- self._err("remove", "Category parameter is required.")
- if not title:
- # Remove whole category
- for title in self.__db.getEntryTitles(category):
- p = "%s %s" % (escapeCmd(category),
- escapeCmd(title))
- self._info("remove", "running command: remove %s" % p)
- self.do_remove(p)
- return
- try:
- self.__db.delEntry(PWManEntry(category, title))
- except (PWManError) as e:
- self._err("remove", str(e))
- do_rm = do_remove
- do_del = do_remove
- complete_remove = __complete_category_title
- complete_rm = complete_remove
- complete_del = complete_remove
- __move_copy_opts = ("-s:", "-d:")
- def __do_move_copy(self, command, params):
- opts = PWManOpts.parse(params, self.__move_copy_opts)
- sourceDbName = opts.getOpt("-s", default=self.__selDbName)
- sourceDb = self._getDb(sourceDbName)
- if sourceDb is None:
- self._err(command, "Source database '%s' does not exist" % sourceDbName)
- destDbName = opts.getOpt("-d", default=self.__selDbName)
- destDb = self._getDb(destDbName)
- if destDb is None:
- self._err(command, "Destination database '%s' does not exist" % destDbName)
- if opts.nrParams in (3, 4):
- # Entry rename/move or copy
- fromCategory, fromTitle, toCategory, toTitle =\
- (opts.getParam(0), opts.getParam(1),
- opts.getParam(2), opts.getParam(3))
- toTitle = toTitle or fromTitle
- entry = sourceDb.getEntry(fromCategory, fromTitle)
- if not entry:
- self._err(command, "Source entry does not exist.")
- if sourceDb is destDb and fromCategory == toCategory and fromTitle == toTitle:
- return
- try:
- sourceDb.moveEntry(entry, toCategory, toTitle,
- toDb=destDb,
- copy=(command == "copy"))
- except (PWManError) as e:
- self._err(command, str(e))
- elif (sourceDb is destDb and opts.nrParams == 2) or\
- (sourceDb is not destDb and opts.nrParams in (1, 2)):
- # Whole category move or copy.
- fromCategory, toCategory = opts.getParam(0), opts.getParam(1)
- toCategory = toCategory or fromCategory
- try:
- sourceDb.moveEntries(fromCategory, toCategory,
- toDb=destDb,
- copy=(command == "copy"))
- except (PWManError) as e:
- self._err(command, str(e))
- else:
- self._err(command, "Invalid parameters.")
- @completion
- def __complete_move_copy(self, text, line, begidx, endidx):
- if text == "-":
- return PWManOpts.rawOptTemplates(self.__move_copy_opts)
- if len(text) == 2 and text.startswith("-"):
- return [ text + " " ]
- dbOpts = ("-s", "-d")
- opts = PWManOpts.parse(line, self.__move_copy_opts, ignoreFirst=True, softFail=True)
- if opts.error:
- opt, error = opts.error
- if error == "no_arg" and opt in dbOpts:
- return self.__getDatabaseCompletions(text)
- return []
- optName, value = opts.atCmdIndex(PWManOpts.calcParamIndex(line, endidx))
- if optName in dbOpts:
- return self.__getDatabaseCompletions(text)
- sourceDbName = opts.getOpt("-s", default=self.__selDbName)
- sourceDb = self._getDb(sourceDbName)
- if sourceDb is None:
- return []
- destDbName = opts.getOpt("-d", default=self.__selDbName)
- destDb = self._getDb(destDbName)
- if destDb is None:
- return []
- paramIdx = opts.getComplParamIdx(text)
- if paramIdx == 0:
- # Category completion
- return self.__getCategoryCompletions(text, db=sourceDb)
- elif paramIdx == 1:
- # Entry title completion
- category = opts.getParam(0)
- if category:
- compl = self.__getEntryTitleCompletions(category, text, db=sourceDb)
- if compl:
- return compl
- # Category completion
- return self.__getCategoryCompletions(text, db=destDb)
- elif paramIdx == 2:
- # Category completion
- return self.__getCategoryCompletions(text, db=destDb)
- elif paramIdx == 3:
- # Entry title completion
- category = opts.getParam(2)
- if category:
- return self.__getEntryTitleCompletions(category, text, db=destDb)
- return []
- def do_move(self, params):
- """--- Move/rename an existing entry or a category ---
- Move/rename an existing entry:
- Command: move CATEGORY TITLE TO_CATEGORY [NEW_TITLE]
- (NEW_TITLE defaults to TITLE)
- Move all entries from one category into another category.
- Command: move FROM_CATEGORY TO_CATEGORY
- Move an entry from one database to another:
- Command: move -s main -d other CATEGORY TITLE TO_CATEGORY [NEW_TITLE]
- (NEW_TITLE defaults to TITLE)
- Move all entries from a category from one database into another database:
- Command: move -s main -d other FROM_CATEGORY [TO_CATEGORY]
- (TO_CATEGORY defaults to FROM_CATEGORY)
- Options:
- -s SOURCE_DATABASE_NAME
- -d DESTINATION_DATABASE_NAME
- Databases default to the currently selected database.
- The named databases must be open. See 'database' command.
- Aliases: mv rename
- """
- self.__do_move_copy("move", params)
- do_mv = do_move
- do_rename = do_move
- complete_move = __complete_move_copy
- complete_mv = complete_move
- complete_rename = complete_move
- __copy_opts = ("-s:", "-d:")
- def do_copy(self, params):
- """--- Copy an entry or a category ---
- Copy an existing entry:
- Command: copy CATEGORY TITLE TO_CATEGORY [NEW_TITLE]
- (NEW_TITLE defaults to TITLE)
- Copy all entries from a category into another category:
- Command: copy FROM_CATEGORY TO_CATEGORY
- Copy an entry from one database to another:
- Command: copy -s main -d other CATEGORY TITLE TO_CATEGORY [NEW_TITLE]
- (NEW_TITLE defaults to TITLE)
- Copy all entries from a category from one database into another database:
- Command: copy -s main -d other FROM_CATEGORY [TO_CATEGORY]
- (TO_CATEGORY defaults to FROM_CATEGORY)
- Options:
- -s SOURCE_DATABASE_NAME
- -d DESTINATION_DATABASE_NAME
- Databases default to the currently selected database.
- The named databases must be open. See 'database' command.
- Aliases: cp
- """
- self.__do_move_copy("copy", params)
- do_cp = do_copy
- complete_copy = __complete_move_copy
- complete_cp = complete_copy
- __database_opts = ("-f:",)
- def do_database(self, params):
- """--- Open a database or switch to an already opened database ---
- Command: database [-f FILEPATH] [NAME]
- If neither FILEPATH nor NAME are given, then
- a list of all currently opened databases will be printed.
- The currently selected database will be marked with [@].
- All databases with uncommitted changes will be marked with [*].
- If only NAME is given, then the selected database will
- be switched to the named one. NAME must already be open.
- A new database can be opened with -f FILEPATH.
- NAME is optional in this case.
- The selected database will be switched to the newly opened one.
- Aliases: db
- """
- opts = PWManOpts.parse(params, self.__database_opts)
- path = opts.getOpt("-f")
- name = opts.getParam(0)
- if path:
- if opts.nrParams not in (0, 1):
- self._err("database", "Invalid parameters.")
- # Open a new db.
- path = pathlib.Path(path)
- name = name or path.name
- if name == "main":
- self._err("database",
- "The database name 'main' is reserved. "
- "Please select another name.")
- if name in self.__dbs:
- self._err("database",
- ("The database name '%' is already used. "
- "Please select another name.") % name)
- try:
- passphrase = readPassphrase(
- "Master passphrase of '%s'" % path,
- verify=not path.exists())
- if passphrase is None:
- self._err("database", "Could not get passphrase.")
- db = PWManDatabase(filename=path,
- passphrase=passphrase,
- readOnly=False)
- except PWManError as e:
- self._err("database", str(e))
- self.__dbs[name] = db
- self.__selDbName = name
- elif opts.nrParams == 1:
- # Switch selected db to NAME.
- if name not in self.__dbs:
- self._err("database", "The database '%s' does not exist." % name)
- if name != self.__selDbName:
- self.__selDbName = name
- elif opts.nrParams == 0:
- # Print db list.
- for name, db in self.__dbs.items():
- flags = "@" if db is self.__db else " "
- flags += "*" if db.isDirty() else " "
- path = db.getFilename()
- self._info(None, "[%s] %s: %s" % (
- flags, name, path))
- else:
- self._err("database", "Invalid parameters.")
- do_db = do_database
- @completion
- def complete_database(self, text, line, begidx, endidx):
- if text == "-":
- return PWManOpts.rawOptTemplates(self.__database_opts)
- if len(text) == 2 and text.startswith("-"):
- return [ text + " " ]
- opts = PWManOpts.parse(line, self.__database_opts, ignoreFirst=True, softFail=True)
- if opts.error:
- opt, error = opts.error
- if error == "no_arg" and opt == "-f":
- return self.__getPathCompletions(text)
- return []
- optName, value = opts.atCmdIndex(PWManOpts.calcParamIndex(line, endidx))
- if optName == "-f":
- return self.__getPathCompletions(text)
- paramIdx = opts.getComplParamIdx(text)
- if paramIdx == 0:
- # Database name
- return self.__getDatabaseCompletions(text)
- return []
- complete_db = complete_database
- __dbdump_opts = ("-s", "-h", "-c")
- def do_dbdump(self, params):
- """--- Dump the pwman SQL database ---
- Command: dbdump [OPTS] [FILEPATH]
- If FILEPATH is given, the database is dumped
- unencrypted to the file.
- If FILEPATH is omitted, the database is dumped
- unencrypted to stdout.
- OPTS may be one of:
- -s Dump format SQL. (default)
- -h Dump format human readable text.
- -c Dump format CSV.
- WARNING: The database dump is not encrypted.
- Aliases: None
- """
- opts = PWManOpts.parse(params, self.__dbdump_opts)
- if opts.nrParams > 1:
- self._err("dbdump", "Too many arguments.")
- optFmtSqlDump = "-s" in opts
- optFmtHumanReadable = "-h" in opts
- optFmtCsv = "-c" in opts
- numFmtOpts = int(optFmtSqlDump) + int(optFmtHumanReadable) + int(optFmtCsv)
- if not 0 <= numFmtOpts <= 1:
- self._err("dbdump", "Multiple format OPTions. "
- "Only one is allowed.")
- if numFmtOpts == 0:
- optFmtSqlDump = True
- dumpFile = opts.getParam(0)
- try:
- if optFmtSqlDump:
- dump = self.__db.sqlPlainDump() + b"\n"
- elif optFmtHumanReadable:
- dump = self.__db.dumpEntries(totp="show")
- dump = dump.encode("UTF-8") + b"\n"
- elif optFmtCsv:
- dump = self.__db.dumpEntriesCsv(totp="show")
- dump = dump.encode("UTF-8")
- else:
- assert(0)
- if dumpFile:
- with open(dumpFile, "wb") as f:
- f.write(dump)
- else:
- stdout(dump)
- except UnicodeError as e:
- self._err("dbdump", "Unicode error.")
- except IOError as e:
- self._err("dbdump", "Failed to write dump: %s" % e.strerror)
- @completion
- def complete_dbdump(self, text, line, begidx, endidx):
- if text == "-":
- return PWManOpts.rawOptTemplates(self.__dbdump_opts)
- if len(text) == 2 and text.startswith("-"):
- return [ text + " " ]
- opts = PWManOpts.parse(line, self.__dbdump_opts, ignoreFirst=True, softFail=True)
- if opts.error:
- return []
- paramIdx = opts.getComplParamIdx(text)
- if paramIdx == 0:
- # filepath
- return self.__getPathCompletions(text)
- return []
- def do_dbimport(self, params):
- """--- Import an SQL database dump ---
- Command: dbimport FILEPATH
- Import the FILEPATH into the current database.
- The database is cleared before importing the file!
- Aliases: None
- """
- try:
- if not params.strip():
- raise IOError("FILEPATH is empty.")
- with open(params, "rb") as f:
- data = f.read().decode("UTF-8")
- self.__db.importSqlScript(data)
- self._info("dbimport", "success.")
- except (CSQLError, IOError, UnicodeError) as e:
- self._err("dbimport", "Failed to import dump: %s" % str(e))
- @completion
- def complete_dbimport(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx == 0:
- return self.__getPathCompletions(text)
- return []
- def do_drop(self, params):
- """--- Drop all uncommitted changes ---
- Command: drop
- Aliases: None
- """
- self.__db.dropUncommitted()
- def do_close(self, params):
- """--- Close a database ---
- Command: close [!] [NAME]
- If NAME is not given, then this closes the currently selected database.
- If NAME is given, then this closes the named database.
- If ! is specified, then the uncommitted changes will be dropped.
- If the currently used database is closed, the selected database
- will be switched to 'main'.
- The 'main' database can only be closed last,
- which in turn closes the application.
- Aliases: None
- """
- flunk = params.startswith("!")
- if flunk:
- params = params[1:].strip()
- name = params if params else self.__selDbName
- if name == "main" and len(self.__dbs) > 1:
- self._err("close", "The 'main' database can only be closed last")
- db = self._getDb(name)
- if db is None:
- self._err("close", "The database '%s' does not exist" % name)
- if db.isDirty():
- if not flunk:
- self._err("close", "The database '%s' contains "
- "uncommitted changes" % name)
- db.flunkDirty()
- if len(self.__dbs) > 1:
- self.__dbs.pop(name)
- if self.__selDbName == name:
- self.__selDbName = "main"
- else:
- raise self.Quit()
- @completion
- def complete_close(self, text, line, begidx, endidx):
- if text == "!":
- return [ text + " " ]
- opts = PWManOpts.parse(line, (), ignoreFirst=True, softFail=True)
- if opts.error:
- return []
- paramIdx = opts.getComplParamIdx(text)
- if paramIdx == 0 or (paramIdx == 1 and opts.getParam(0) == "!"):
- # Database name
- return self.__getDatabaseCompletions(text)
- return []
- __find_opts = ("-c", "-t", "-u", "-p", "-b", "-a", "-A", "-r")
- def do_find(self, params):
- """--- Search the database ---
- Command: find [OPTS] [IN_CATEGORY] PATTERN
- Searches the database for patterns. If 'IN_CATEGORY' is given, only search
- in the specified category.
- PATTERN may either use SQL LIKE wildcards (without -r)
- or Python Regular Expression special characters (with -r).
- OPTS may be one or multiple of:
- -c Match 'category' (only if no IN_CATEGORY parameter)
- -t Match 'title' (*)
- -u Match 'user' (*)
- -p Match 'password' (*)
- -b Match 'bulk' (*)
- -a Match 'attribute data' (*)
- -A Match 'attribute name'
- -r Use Python Regular Expression matching
- (*) = These OPTS are enabled by default, if and only if
- none of them are specified by the user.
- Aliases: f
- """
- opts = PWManOpts.parse(params, self.__find_opts)
- mCategory = "-c" in opts
- mTitle = "-t" in opts
- mUser = "-u" in opts
- mPw = "-p" in opts
- mBulk = "-b" in opts
- mAttrData = "-a" in opts
- mAttrName = "-A" in opts
- regexp = "-r" in opts
- if not any( (mTitle, mUser, mPw, mBulk, mAttrData) ):
- mTitle, mUser, mPw, mBulk, mAttrData = (True,) * 5
- if opts.nrParams < 1 or opts.nrParams > 2:
- self._err("find", "Invalid parameters.")
- inCategory = opts.getParam(0) if opts.nrParams > 1 else None
- pattern = opts.getParam(1) if opts.nrParams > 1 else opts.getParam(0)
- if inCategory and mCategory:
- self._err("find", "-c and [IN_CATEGORY] cannot be used at the same time.")
- entries = self.__db.findEntries(pattern=pattern,
- useRegexp=regexp,
- inCategory=inCategory,
- matchCategory=mCategory,
- matchTitle=mTitle,
- matchUser=mUser,
- matchPw=mPw,
- matchBulk=mBulk,
- matchAttrName=mAttrName,
- matchAttrData=mAttrData)
- if not entries:
- self._err("find", "'%s' not found" % pattern)
- for entry in entries:
- self._info(None, self.__db.dumpEntry(entry))
- do_f = do_find
- @completion
- def complete_find(self, text, line, begidx, endidx):
- if text == "-":
- return PWManOpts.rawOptTemplates(self.__find_opts)
- if len(text) == 2 and text.startswith("-"):
- return [ text + " " ]
- opts = PWManOpts.parse(line, self.__find_opts, ignoreFirst=True, softFail=True)
- if opts.error:
- return []
- paramIdx = opts.getComplParamIdx(text)
- if paramIdx == 0:
- # category
- return self.__getCategoryCompletions(text)
- return []
- complete_f = complete_find
- def do_totp(self, params):
- """--- Generate a TOTP token ---
- Command: totp [CATEGORY TITLE] OR [TITLE]
- Generates a token using the Time-Based One-Time Password Algorithm.
- Aliases: t
- """
- first, second = PWManOpts.parseParams(params, 0, 2)
- if not first:
- self._err("totp", "First parameter is required.")
- if second:
- category, title = first, second
- else:
- entries = self.__db.findEntries(first, matchTitle=True)
- if not entries:
- self._err("totp", "Entry title not found.")
- return
- elif len(entries) == 1:
- category = entries[0].category
- title = entries[0].title
- else:
- self._err("totp", "Entry title ambiguous.")
- return
- entry = self.__db.getEntry(category, title)
- if not entry:
- self._err("totp", "'%s/%s' not found" % (category, title))
- entryTotp = self.__db.getEntryTotp(entry)
- if not entryTotp:
- self._err("totp", "'%s/%s' does not have "
- "TOTP key information" % (category, title))
- try:
- token = entryTotp.generate()
- except OtpError as e:
- self._err("totp", "Failed to generate TOTP: %s" % str(e))
- self._info(None, "%s" % token)
- do_t = do_totp
- complete_totp = __complete_category_title
- complete_t = complete_totp
- def do_edit_totp(self, params):
- """--- Edit TOTP key and parameters ---
- Command: edit_totp category title [KEY] [DIGITS] [HASH]
- Set Time-Based One-Time Password Algorithm key and parameters.
- If KEY is not provided, the TOTP parameters for this entry are deleted.
- DIGITS default to 6, if not provided.
- HASH defaults to SHA1, if not provided.
- Aliases: et
- """
- category, title, key, digits, _hash = PWManOpts.parseParams(params, 0, 5)
- if not category:
- self._err("edit_totp", "Category parameter is required.")
- if not title:
- self._err("edit_totp", "Title parameter is required.")
- entry = self.__db.getEntry(category, title)
- if not entry:
- self._err("edit_totp", "'%s/%s' not found" % (category, title))
- entryTotp = self.__db.getEntryTotp(entry)
- if not entryTotp:
- entryTotp = PWManEntryTOTP(key=None, entry=entry)
- entryTotp.key = key
- if digits:
- try:
- entryTotp.digits = int(digits)
- except ValueError:
- self._err("edit_totp", "Invalid digits parameter.")
- if _hash:
- entryTotp.hmacHash = _hash
- try:
- # Check parameters.
- entryTotp.generate()
- except OtpError as e:
- self._err("edit_totp", "TOTP error: %s" % str(e))
- self.__db.setEntryTotp(entryTotp)
- do_et = do_edit_totp
- @completion
- def complete_edit_totp(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx in (0, 1):
- return self.__complete_category_title(text, line, begidx, endidx)
- category, title = PWManOpts.parseComplParams(line, 0, 2)
- if category and title:
- entry = self.__db.getEntry(category, title)
- if entry:
- entryTotp = self.__db.getEntryTotp(entry)
- if entryTotp:
- if paramIdx == 2: # key
- return [ escapeCmd(entryTotp.key) + " " ]
- elif paramIdx == 3: # digits
- return [ escapeCmd(str(entryTotp.digits)) + " " ]
- elif paramIdx == 4: # hash
- return [ escapeCmd(entryTotp.hmacHash) + " " ]
- return []
- complete_et = complete_edit_totp
- def do_edit_attr(self, params):
- """--- Edit an entry attribute ---
- Command: edit_attr category title NAME [DATA]
- Edit or delete an entry attribute.
- Aliases: ea
- """
- category, title, name, data = PWManOpts.parseParams(params, 0, 4)
- if not category:
- self._err("edit_attr", "Category parameter is required.")
- if not title:
- self._err("edit_attr", "Title parameter is required.")
- entry = self.__db.getEntry(category, title)
- if not entry:
- self._err("edit_attr", "'%s/%s' not found" % (category, title))
- entryAttr = self.__db.getEntryAttr(entry, name)
- if not entryAttr:
- entryAttr = PWManEntryAttr(name=name, entry=entry)
- entryAttr.data = data
- self.__db.setEntryAttr(entryAttr)
- do_ea = do_edit_attr
- @completion
- def complete_edit_attr(self, text, line, begidx, endidx):
- paramIdx = PWManOpts.calcParamIndex(line, endidx)
- if paramIdx in (0, 1):
- return self.__complete_category_title(text, line, begidx, endidx)
- category, title, name = PWManOpts.parseComplParams(line, 0, 3)
- return self.__getEntryAttrCompletions(category, title, name,
- doName=(paramIdx == 2),
- doData=(paramIdx == 3),
- text=text)
- complete_ea = complete_edit_attr
- __diff_opts = ("-u", "-c", "-n")
- def do_diff(self, params):
- """--- Diff the current database to another database ---
- Command: diff [OPTS] [DATABASE_FILE]
- If no DATABASE_FILE is provided: Diffs the latest changes in the
- currently open database to the committed changes in the current database.
- This can be used to review changes before commit.
- If DATABASE_FILE is provided: Diffs the latest changes in the
- currently opened database to the contents of DATABASE_FILE.
- OPTS may be one of:
- -u Generate a unified diff (default if no OPT is given).
- -c Generate a context diff
- -n Generate an ndiff
- Aliases: None
- """
- opts = PWManOpts.parse(params, self.__diff_opts)
- if opts.nrParams > 1:
- self._err("diff", "Too many arguments.")
- optUnified = "-u" in opts
- optContext = "-c" in opts
- optNdiff = "-n" in opts
- numFmtOpts = int(optUnified) + int(optContext) + int(optNdiff)
- if not 0 <= numFmtOpts <= 1:
- self._err("diff", "Multiple format OPTions. "
- "Only one is allowed.")
- if numFmtOpts == 0:
- optUnified = True
- dbFile = opts.getParam(0)
- try:
- if dbFile:
- path = pathlib.Path(dbFile)
- if not path.exists():
- self._err("diff", "'%s' does not exist." % path)
- passphrase = readPassphrase(
- "Master passphrase of '%s'" % path,
- verify=False)
- if passphrase is None:
- self._err("diff", "Could not get passphrase.")
- oldDb = PWManDatabase(filename=path,
- passphrase=passphrase,
- readOnly=True)
- else:
- oldDb = self.__db.getOnDiskDb()
- diff = PWManDatabaseDiff(db=self.__db, oldDb=oldDb)
- if optUnified:
- diffText = diff.getUnifiedDiff()
- elif optContext:
- diffText = diff.getContextDiff()
- elif optNdiff:
- diffText = diff.getNdiffDiff()
- else:
- assert(0)
- self._info(None, diffText)
- except PWManError as e:
- self._err("diff", "Failed: %s" % str(e))
- @completion
- def complete_diff(self, text, line, begidx, endidx):
- if text == "-":
- return PWManOpts.rawOptTemplates(self.__diff_opts)
- if len(text) == 2 and text.startswith("-"):
- return [ text + " " ]
- opts = PWManOpts.parse(line, self.__diff_opts, ignoreFirst=True, softFail=True)
- if opts.error:
- return []
- paramIdx = opts.getComplParamIdx(text)
- if paramIdx == 0:
- # database file path
- return self.__getPathCompletions(text)
- return []
- def __mayQuit(self):
- if self.__db.isDirty():
- self._warn(None,
- "Warning: Uncommitted changes. Operation not performed.\n"
- "Use command 'commit' to write the changes to the database.\n"
- "Use command 'quit!' to quit without saving.")
- return False
- return True
- def flunkDirty(self):
- self.__db.flunkDirty()
- def interactive(self):
- self.__isInteractive = True
- try:
- while True:
- try:
- self.cmdloop()
- break
- except self.Quit as e:
- if self.__mayQuit():
- self.do_cls("")
- break
- except EscapeError as e:
- self._warn(None, str(e))
- except self.CommandError as e:
- print(str(e), file=sys.stderr)
- except (KeyboardInterrupt, EOFError) as e:
- print("")
- except CSQLError as e:
- self._warn(None, "SQL error: %s" % str(e))
- finally:
- self.__isInteractive = False
- def runOneCommand(self, command):
- self.__isInteractive = False
- try:
- self.onecmd(command)
- except self.Quit as e:
- raise PWManError("Quit command executed in non-interactive mode.")
- except (EscapeError, self.CommandError) as e:
- raise PWManError(str(e))
- except (KeyboardInterrupt, EOFError) as e:
- raise PWManError("Interrupted.")
- except CSQLError as e:
- raise PWManError("SQL error: %s" % str(e))
|