added options --safety and --wipe, made encrypted files read-only, minor bug fix

Author: 8go

LICENSE

@@ -74,7 +74,7 @@ Run:
 Run-time command line options are
 
 ```
-TrezorSymmetricFileEncryption.py [-v] [-h] [-l <level>] [-t] [-2] [-o | -e | -d | -n] [-p <passphrase>] <files>
+TrezorSymmetricFileEncryption.py [-v] [-h] [-l <level>] [-t] [-2] [-s] [-w] [-o | -e | -d | -n] [-p <passphrase>] <files>
     -v, --verion
             print the version number
     -h, --help
@@ -107,6 +107,15 @@ TrezorSymmetricFileEncryption.py [-v] [-h] [-l <level>] [-t] [-2] [-o | -e | -d
             master passphrase used for Trezor.
             It is recommended that you do not use this command line option
             but rather give the passphrase through a small window interaction.
+    -s, --safety
+            doublechecks the encryption process by decrypting the just
+            encrypted file immediately and comparing it to original file;
+            only relevant for `-e` and `-o`; ignored in all other cases.
+            Primarily useful for testing.
+    -w, --wipe
+            shred the plaintext file after encryption;
+            only relevant for `-e` and `-o`; ignored in all other cases.
+            Use with caution. May be used together with `-s`.
     <files>
             one or multiple files to be encrypted or decrypted
 
@@ -139,6 +148,30 @@ TrezorSymmetricFileEncryption.py [-v] [-h] [-l <level>] [-t] [-2] [-o | -e | -d
     Be aware of computation time and file sizes when you use `-2` option.
     Encrypting on the Trezor takes time: 1M roughtly 75sec. 50M about 1h.
     Without `-2` it is very fast, a 1G file taking roughly 15 seconds.
+
+    For safety the file permission of encrypted files is set to read-only.
+
+    Examples:
+    # specify everything in the GUI
+    TrezorSymmetricFileEncryption.py
+
+    # specify everything in the GUI, set logging to verbose Debug level
+    TrezorSymmetricFileEncryption.py -l 1
+
+    # encrypt contract producing contract.doc.tsfe
+    TrezorSymmetricFileEncryption.py contract.doc
+
+    # encrypt contract and obfuscate output producing e.g. TQFYqK1nha1IfLy_qBxdGwlGRytelGRJ
+    TrezorSymmetricFileEncryption.py -o contract.doc
+
+    # decrypt contract producing contract.doc
+    TrezorSymmetricFileEncryption.py contract.doc.tsfe
+
+    # decrypt obfuscated contract producing contract.doc
+    TrezorSymmetricFileEncryption.py TQFYqK1nha1IfLy_qBxdGwlGRytelGRJ
+
+    # shows plaintext name of encrypted file, e.g. contract.doc
+    TrezorSymmetricFileEncryption.py -n TQFYqK1nha1IfLy_qBxdGwlGRytelGRJ
 ```
 
 # Testing

README.md

@@ -147,7 +147,7 @@ def chooseDevice(self, devices):
 		deviceStr = dialog.chosenDeviceStr()
 		return HidTransport([deviceStr, None])
 
-def showGui(trezor, settings, fileMap, logger):
+def showGui(trezor, settings, fileMap, logger, feedback):
 	"""
 	Initialize, ask for encrypt/decrypt options,
 	ask for files to be decrypted/encrypted,
@@ -165,16 +165,23 @@ def showGui(trezor, settings, fileMap, logger):
 	settings.settings2Gui(dialog, trezor)
 	if settings.logger.getEffectiveLevel() <= logging.INFO:
 		dialog.appendDescription("<br>Trezor label: " + trezor.features.label)
+	if settings.WArg and settings.logger.getEffectiveLevel() <= logging.WARN:
+		dialog.appendDescription("<br>Warning: The option `--wipe` is set. Plaintext files will "
+			"be shredded after encryption. Abort if you are uncertain or don't understand.")
 	if not dialog.exec_():
-		logger.debug("Shutting down due to user request (Done/Quit was called).")
+		settings.guiExists = False
+		processing.reportLogging("Shutting down due to user request "
+			"(Done/Quit was called).", logging.DEBUG,
+			"GUI IO", settings, logger)
 		sys.exit(4) # Esc or exception
 	settings.guiExists = False
 	settings.gui2Settings(dialog,trezor)
 
 # root
 
 logging.basicConfig(stream=sys.stderr, level=basics.LOGGINGLEVEL)
-logger = logging.getLogger('')
+logger = logging.getLogger('tsfe')
+feedback = processing.Feedback()
 
 app = QtGui.QApplication(sys.argv)
 
@@ -186,21 +193,13 @@ def showGui(trezor, settings, fileMap, logger):
 	trezorChooser = TrezorChooser()
 	trezor = trezorChooser.getDevice()
 except (ConnectionError, RuntimeError), e:
-	if settings.TArg:
-		logger.critical("Connection to Trezor failed: %s", e.message)
-	else:
-		msgBox = QtGui.QMessageBox(QtGui.QMessageBox.Critical,
-			"Trezor error", "Error: Connection to Trezor failed: " + e.message)
-		msgBox.exec_()
+	processing.reportLogging("Connection to Trezor failed: %s" % e.message,
+		logging.CRITICAL, "Trezor Error", settings, logger)
 	sys.exit(1)
 
 if trezor is None:
-	if settings.TArg:
-		logger.critical("No available Trezor found, quitting.")
-	else:
-		msgBox = QtGui.QMessageBox(QtGui.QMessageBox.Critical,
-			"Trezor error", "No available Trezor found, quitting.")
-		msgBox.exec_()
+	processing.reportLogging("No available Trezor found, quitting.",
+		logging.CRITICAL, "Trezor Error", settings, logger)
 	sys.exit(1)
 
 trezor.clear_session()
@@ -213,13 +212,12 @@ def showGui(trezor, settings, fileMap, logger):
 # if everything is specified in the command line then do not call the GUI
 if ((settings.PArg is None) or (len(settings.inputFiles) <= 0)) and (not settings.TArg):
 	# something was not specified, so we call the GUI
-	showGui(trezor, settings, fileMap, logger)
+	showGui(trezor, settings, fileMap, logger, feedback)
 else:
 	logger.info("Everything was specified or --terminal was set, "
 		"hence the GUI will not be called.")
-	if settings.PArg is None:
-		settings.PArg = ""
+	if settings.PArg is not None:
+		trezor.prefillPassphrase(settings.PArg)
 
-	feedback = processing.Feedback()
 	processing.processAll(trezor, settings, fileMap, logger, feedback)
 	sys.exit(0)

TrezorSymmetricFileEncryption.py

@@ -7,7 +7,7 @@
 TSFEFILEFORMATVERSION = 1
 
 # Name of software version, must be less than 16 long
-TSFEVERSION = "v0.3.1"
+TSFEVERSION = "v0.3.2"
 
 # default log level
 LOGGINGLEVEL = logging.INFO # CRITICAL, ERROR, WARNING, INFO, DEBUG

basics.py

@@ -1,17 +1,18 @@
-from PyQt4 import QtGui, QtCore
-
 import os
 import os.path
 import base64
 import hashlib
+import logging
+
+from PyQt4 import QtGui, QtCore
 
 from ui_trezor_passphrase_dialog import Ui_TrezorPassphraseDialog
 from ui_dialog import Ui_Dialog
 from ui_enter_pin_dialog import Ui_EnterPinDialog
 from ui_trezor_chooser_dialog import Ui_TrezorChooserDialog
 
 from encoding import q2s, s2q
-from processing import processAllFromApply
+from processing import processAllFromApply, reportLogging
 
 class TrezorPassphraseDialog(QtGui.QDialog, Ui_TrezorPassphraseDialog):
 
@@ -79,12 +80,15 @@ def selectionChanged(self):
 		called whenever selected text in textarea is changed
 		"""
 		# self.textBrowser.copy() # copy selected to clipboard
-		# print self.clipboard.text() # print clipboard
+		# reportLogging("Copied text to clipboard: %s" % self.clipboard.text(),
+		#	logging.DEBUG, "Clipboard", self.settings, self.logger)
 		""" empty """
 
 	def copy2Clipboard(self):
 		self.textBrowser.copy() # copy selected to clipboard
-		self.logger.debug("Copied to clipboard: %s", self.clipboard.text()) # print clipboard
+		# This is content from the Status textarea, so no secrets here, we can log it
+		reportLogging("Copied text to clipboard: %s" % self.clipboard.text(), logging.DEBUG,
+			"Clipboard", self.settings, self.logger)
 
 	def setVersion(self, version):
 		self.version = version
@@ -231,14 +235,16 @@ def validate(self):
 #			feedback = processAllFromApply(self, self.trezor, self.settings, self.fileMap, self.logger) #
 #			self.appendDescription(feedback)
 #		# elif sb == QtGui.QDialogButtonBox.Reset:
-#		#	print('Reset Clicked, quitting now...')
+#		#	reportLogging("Reset Clicked, quitting now...", logging.DEBUG,
+#		#		"UI", self.settings, self.logger)
 
 	def accept(self):
 		"""
-		Apply button was pinpadPressed
+		Apply button was pressed
 		"""
 		if self.validate():
-			self.logger.debug("Apply was called by user request. Start processing now.")
+			reportLogging("Apply was called by user request. Start processing now.",
+				logging.DEBUG, "GUI IO", self.settings, self.logger)
 			feedback = processAllFromApply(self, self.trezor, self.settings, self.fileMap, self.logger) #
 			self.appendDescription(feedback)
 			# move the cursor to the end of the text, scroll to the bottom
@@ -247,7 +253,9 @@ def accept(self):
 			self.textBrowser.ensureCursorVisible()
 			self.textBrowser.setTextCursor(cursor)
 		else:
-			self.logger.debug("Apply was called by user request. Apply is denied. User input is not valid for processing. Did you select a file?")
+			reportLogging("Apply was called by user request. Apply is denied. "
+				"User input is not valid for processing. Did you select a file?",
+				logging.DEBUG, "GUI IO", self.settings, self.logger)
 
 	# Don't set up a reject() method, it is automatically created.
 	# If created here again it would overwrite the default one
@@ -270,7 +278,8 @@ def selectFile(self):
 
 		qFnameList = dialog.selectedFiles() # QStringList
 		self.fileNames = str(qFnameList.join("<join>")).split("<join>") # convert to Py list
-		self.logger.debug("Selected files are: " + str(self.fileNames))
+		reportLogging("Selected files are: %s" % str(self.fileNames),
+			logging.DEBUG, "GUI IO", self.settings, self.logger)
 		self.setSelectedFile(self.fileNames)
 
 class EnterPinDialog(QtGui.QDialog, Ui_EnterPinDialog):