baseui.py 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. # ===========================================================================
  2. # This file is part of Pwman3.
  3. #
  4. # Pwman3 is free software; you can redistribute it and/or modify
  5. # it under the terms of the GNU General Public License, version 2
  6. # as published by the Free Software Foundation;
  7. #
  8. # Pwman3 is distributed in the hope that it will be useful,
  9. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. # GNU General Public License for more details.
  12. #
  13. # You should have received a copy of the GNU General Public License
  14. # along with Pwman3; if not, write to the Free Software
  15. # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  16. # ============================================================================
  17. # Copyright (C) 2013, 2014 Oz Nahum Tiram <nahumoz@gmail.com>
  18. # ============================================================================
  19. from __future__ import print_function
  20. import sys
  21. import os
  22. import ast
  23. import csv
  24. import time
  25. import re
  26. import select as uselect
  27. from colorama import Fore
  28. from pwman.data.nodes import Node
  29. from pwman.ui import tools
  30. from pwman.util.crypto_engine import CryptoEngine
  31. from pwman.util.crypto_engine import zerome
  32. from pwman.ui.tools import CliMenuItem
  33. from pwman.ui.tools import CMDLoop, get_or_create_pass
  34. if sys.version_info.major > 2: # pragma: no cover
  35. raw_input = input
  36. def _heard_enter(): # pragma: no cover
  37. i, o, e = uselect.select([sys.stdin], [], [], 0.0001)
  38. for s in i:
  39. if s == sys.stdin:
  40. sys.stdin.readline()
  41. return True
  42. return False
  43. def _wait_until_enter(predicate, timeout, period=0.25): # pragma: no cover
  44. mustend = time.time() + timeout
  45. while time.time() < mustend:
  46. cond = predicate()
  47. if cond:
  48. break
  49. time.sleep(period)
  50. class HelpUIMixin(object): # pragma: no cover
  51. """
  52. this class holds all the UI help functionality.
  53. in PwmanCliNew. The later inherits from this class
  54. and allows it to print help messages to the console.
  55. """
  56. def _usage(self, string):
  57. print ("Usage: %s" % (string))
  58. def help_open(self):
  59. self._usage("open|o <ID>")
  60. print ("Launch default browser with 'xdg-open url',\n",
  61. "the url must contain http:// or https://.")
  62. def help_copy(self):
  63. self._usage("copy|cp <ID>")
  64. print ("Copy password to X clipboard (xsel required)")
  65. def help_cls(self):
  66. self._usage("cls")
  67. print ("Clear the Screen from information.")
  68. def help_list(self):
  69. self._usage("list|ls <tag> ...")
  70. print ("List nodes that match current or specified filter.",
  71. " ls is an alias.")
  72. def help_delete(self):
  73. self._usage("delete|rm <ID|tag> ...")
  74. print ("Deletes nodes.")
  75. self._mult_id_help()
  76. def help_help(self):
  77. self._usage("help|h [topic]")
  78. print ("Prints a help message for a command.")
  79. def help_edit(self):
  80. self.usage("edit <ID|tag> ... ")
  81. print ("Edits a nodes.")
  82. def help_export(self):
  83. self.usage("export [{'filename': 'foo.csv', 'delimiter':'|'}] ")
  84. print("All nodes under the current filter are exported.")
  85. def help_new(self):
  86. self.usage("new")
  87. print ("Creates a new node.,",
  88. "You can override default config settings the following way:\n",
  89. "pwman> n {'leetify':False, 'numerics':True}")
  90. def help_print(self):
  91. self.usage("print <ID|tag> ...")
  92. print ("Displays a node. ")
  93. self._mult_id_help()
  94. def _mult_id_help(self):
  95. print("Multiple ids and nodes can be specified, separated by a space.",
  96. " A range of ids can be specified in the format n-N. e.g. ",
  97. " '10-20' would specify all nodes having ids from 10 to 20 ",
  98. " inclusive. Tags are considered one-by-one. e.g. 'foo 2 bar'",
  99. " would yield to all nodes with tag 'foo', node 2 and all ",
  100. " nodes with tag 'bar'.")
  101. def help_exit(self):
  102. self._usage("exit|EOF")
  103. print("Exits the application.")
  104. def help_passwd(self):
  105. self._usage("passwd")
  106. print("Changes the password on the database. ")
  107. def help_forget(self):
  108. self._usage("forget")
  109. print("Forgets the database password. Your password will need to ",
  110. "be reentered before accessing the database again.")
  111. def help_tags(self):
  112. self._usage("tags")
  113. print("Displays all tags in used in the database.")
  114. class AliasesMixin(object): # pragma: no cover
  115. """
  116. Define all the alias you want here...
  117. """
  118. def do_cp(self, args):
  119. self.do_copy(args)
  120. def do_EOF(self, args): # pragma: no cover
  121. self.do_exit(args)
  122. def do_ls(self, args):
  123. self.do_list(args)
  124. def do_p(self, arg):
  125. self.do_print(arg)
  126. def do_rm(self, arg):
  127. self.do_delete(arg)
  128. def do_o(self, args):
  129. self.do_open(args)
  130. def do_e(self, args):
  131. self.do_edit(args)
  132. def do_h(self, arg):
  133. self.do_help(arg)
  134. def do_n(self, arg):
  135. self.do_new(arg)
  136. class BaseCommands(HelpUIMixin, AliasesMixin):
  137. @property
  138. def _xsel(self): # pragma: no cover
  139. if self.hasxsel:
  140. return True
  141. def do_EOF(self, args):
  142. return self.do_exit(args)
  143. def _get_ids(self, args):
  144. """
  145. Command can get a single ID or
  146. a range of IDs, with begin-end.
  147. e.g. 1-3 , will get 1 to 3.
  148. """
  149. ids = []
  150. rex = re.compile("^(?P<begin>\d+)(?:-(?P<end>\d+))?$")
  151. rex = rex.match(args)
  152. if hasattr(rex, 'groupdict'):
  153. try:
  154. begin = int(rex.groupdict()['begin'])
  155. end = int(rex.groupdict()['end'])
  156. if not end > begin:
  157. print("Start node should be smaller than end node")
  158. return ids
  159. ids += range(begin, end+1)
  160. return ids
  161. except TypeError:
  162. ids.append(int(begin))
  163. else:
  164. print("Could not understand your input...")
  165. return ids
  166. def error(self, exception): # pragma: no cover
  167. if (isinstance(exception, KeyboardInterrupt)):
  168. print('')
  169. else:
  170. print("Error: {0} ".format(exception))
  171. def do_copy(self, args): # pragma: no cover
  172. """copy item to clipboard"""
  173. if not self._xsel:
  174. return
  175. if not args.isdigit():
  176. print("Copy accepts only IDs ...")
  177. return
  178. ids = args.split()
  179. if len(ids) > 1:
  180. print("Can copy only 1 password at a time...")
  181. return
  182. ce = CryptoEngine.get()
  183. nodes = self._db.getnodes(ids)
  184. for node in nodes:
  185. password = ce.decrypt(node[2])
  186. tools.text_to_clipboards(password)
  187. flushtimeout = self.config.get_value('Global', 'cp_timeout')
  188. flushtimeout = flushtimeout or 10
  189. print("erasing in {} sec...".format(flushtimeout))
  190. time.sleep(int(flushtimeout))
  191. tools.text_to_clipboards("")
  192. def do_open(self, args): # pragma: no cover
  193. ids = self._get_ids(args)
  194. if not args:
  195. self.help_open()
  196. return
  197. nodes = self._db.getnodes(ids)
  198. ce = CryptoEngine.get()
  199. for node in nodes:
  200. url = ce.decrypt(node[3])
  201. if not url.startswith(("http://", "https://")):
  202. url = "https://" + url
  203. tools.open_url(url)
  204. def do_exit(self, args): # pragma: no cover
  205. """close the text console"""
  206. self._db.close()
  207. return True
  208. def do_cls(self, args): # pragma: no cover
  209. """clear the screen"""
  210. os.system("clear")
  211. def do_export(self, args):
  212. """export the database to a given format"""
  213. try:
  214. args = ast.literal_eval(args)
  215. except Exception:
  216. args = {}
  217. filename = args.get('filename', 'pwman-export.csv')
  218. delim = args.get('delimiter', ';')
  219. nodeids = self._db.listnodes()
  220. nodes = self._db.getnodes(nodeids)
  221. with open(filename, 'w') as csvfile:
  222. writer = csv.writer(csvfile, delimiter=delim)
  223. writer.writerow(['Username', 'URL', 'Password', 'Notes',
  224. 'Tags'])
  225. for node in nodes:
  226. n = Node.from_encrypted_entries(node[1], node[2], node[3],
  227. node[4],
  228. node[5:])
  229. tags = n.tags
  230. tags = ','.join(t.strip() for t in tags)
  231. r = list([n.username, n.url, n.password, n.notes])
  232. writer.writerow(r + [tags])
  233. print("Successfuly exported database to {}".format(
  234. os.path.join(os.getcwd(), filename)))
  235. def do_forget(self, args):
  236. """
  237. drop saved key forcing the user to re-enter the master
  238. password
  239. """
  240. enc = CryptoEngine.get()
  241. enc.forget()
  242. def do_passwd(self, args): # pragma: no cover
  243. """change the master password of the database"""
  244. pass
  245. def do_tags(self, args):
  246. """
  247. print all existing tags
  248. """
  249. ce = CryptoEngine.get()
  250. print("Tags:")
  251. tags = self._db.listtags()
  252. for t in tags:
  253. print(ce.decrypt(t).decode())
  254. def _get_tags(self, default=None, reader=raw_input):
  255. """
  256. Read tags from user input.
  257. Tags are simply returned as a list
  258. """
  259. # TODO: add method to read tags from db, so they
  260. # could be used for tab completer
  261. print("Tags: ", end="")
  262. sys.stdout.flush()
  263. taglist = sys.stdin.readline()
  264. tagstrings = taglist.split()
  265. tags = [tn for tn in tagstrings]
  266. return tags
  267. def _prep_term(self):
  268. self.do_cls('')
  269. if sys.platform != 'win32':
  270. rows, cols = tools.gettermsize()
  271. else: # pragma: no cover
  272. rows, cols = 18, 80 # fix this !
  273. return rows, cols
  274. def _format_line(self, tag_pad, nid="ID", user="USER", url="URL",
  275. tags="TAGS"):
  276. return ("{ID:<3} {USER:<{us}}{URL:<{ur}}{Tags:<{tg}}"
  277. "".format(ID=nid, USER=user,
  278. URL=url, Tags=tags, us=25,
  279. ur=25, tg=20))
  280. def _print_node_line(self, node, rows, cols):
  281. tagstring = ','.join([t for t in node.tags])
  282. fmt = self._format_line(cols, node._id, node.username,
  283. node.url[:20]+'...' if (len(node.url) > 22)
  284. else node.url,
  285. tagstring)
  286. formatted_entry = tools.typeset(fmt, Fore.YELLOW, False)
  287. print(formatted_entry)
  288. def _get_node_ids(self, args):
  289. filter = None
  290. if args:
  291. filter = args.split()[0]
  292. ce = CryptoEngine.get()
  293. filter = ce.encrypt(filter)
  294. nodeids = self._db.listnodes(filter=filter)
  295. return nodeids
  296. def _db_entries_to_nodes(self, raw_nodes):
  297. _nodes_inst = []
  298. # user, pass, url, notes
  299. for node in raw_nodes:
  300. _nodes_inst.append(Node.from_encrypted_entries(
  301. node[1],
  302. node[2],
  303. node[3],
  304. node[4],
  305. node[5:]))
  306. _nodes_inst[-1]._id = node[0]
  307. return _nodes_inst
  308. def do_edit(self, args, menu=None):
  309. ids = self._get_ids(args)
  310. for i in ids:
  311. i = int(i)
  312. node = self._db.getnodes([i])
  313. if not node:
  314. print("Node not found ...")
  315. return
  316. node = node[0]
  317. node = node[1:5] + [node[5:]]
  318. node = Node.from_encrypted_entries(*node)
  319. if not menu:
  320. menu = CMDLoop(self.config)
  321. print ("Editing node %d." % (i))
  322. menu.add(CliMenuItem("Username", node.username))
  323. menu.add(CliMenuItem("Password", node.password))
  324. menu.add(CliMenuItem("Url", node.url))
  325. menunotes = CliMenuItem("Notes", node.notes)
  326. menu.add(menunotes)
  327. tgetter = lambda: ', '.join(t for t in node.tags)
  328. menu.add(CliMenuItem("Tags", tgetter()))
  329. menu.run(node)
  330. self._db.editnode(i, **node.to_encdict())
  331. # when done with node erase it
  332. zerome(node._password)
  333. def do_list(self, args):
  334. """
  335. list all existing nodes in database
  336. """
  337. rows, cols = self._prep_term()
  338. nodeids = self._get_node_ids(args)
  339. raw_nodes = self._db.getnodes(nodeids)
  340. _nodes_inst = self._db_entries_to_nodes(raw_nodes)
  341. head = self._format_line(cols-32)
  342. print(tools.typeset(head, Fore.YELLOW, False))
  343. for idx, node in enumerate(_nodes_inst):
  344. self._print_node_line(node, rows, cols)
  345. def _get_input(self, prompt):
  346. print(prompt, end="")
  347. sys.stdout.flush()
  348. return sys.stdin.readline().strip()
  349. def _get_secret(self):
  350. if sys.stdin.isatty(): # pragma: no cover
  351. p = get_or_create_pass()
  352. else:
  353. p = sys.stdin.readline().rstrip()
  354. return p
  355. def _do_new(self, args):
  356. node = {}
  357. node['username'] = self._get_input("Username: ")
  358. node['password'] = self._get_secret()
  359. node['url'] = self._get_input("Url: ")
  360. node['notes'] = self._get_input("Notes: ")
  361. node['tags'] = self._get_tags()
  362. node = Node(clear_text=True, **node)
  363. self._db.add_node(node)
  364. return node
  365. def do_new(self, args): # pragma: no cover
  366. # The cmd module stops if and of do_* return something
  367. # else than None ...
  368. # This is bad for testing, so everything that is do_*
  369. # should call _do_* method which is testable
  370. self._do_new(args)
  371. def do_print(self, args):
  372. if not args.isdigit():
  373. print("print accepts only a single ID ...")
  374. return
  375. nodes = self._db.getnodes([args])
  376. if not nodes: # pragma: no cover
  377. print("Node not found ...")
  378. return
  379. node = self._db_entries_to_nodes(nodes)[0]
  380. print(node)
  381. flushtimeout = self.config.get_value('Global', 'cls_timeout')
  382. flushtimeout = flushtimeout or 10
  383. print("Type Enter to flush screen or wait %s sec. " % flushtimeout)
  384. _wait_until_enter(_heard_enter, float(flushtimeout))
  385. self.do_cls('')
  386. def _do_rm(self, args):
  387. for i in args.split():
  388. if not i.isdigit():
  389. print("%s is not a node ID" % i)
  390. return None
  391. for i in args.split():
  392. ans = tools.getinput(("Are you sure you want to delete node {}"
  393. " [y/N]?".format(i)))
  394. if ans.lower() == 'y':
  395. self._db.removenodes([i])
  396. def do_delete(self, args): # pragma: no cover
  397. CryptoEngine.get()
  398. self._do_rm(args)