Merge branch 'release/1.1.0'

Author: tknarr

VERSIONS.md

@@ -1,5 +1,9 @@
 # PyAuth version history:
 
+* 1.1.0 - Provisioning URIs
+  - Generate provisioning URIs.
+  - Display the QR code representation of the provisioning URI for scanning.
+
 * 1.0.0 - Initial release
 
 * 0.9.10 - Implement authenticated 256-bit encryption

pyauth/AuthEntryPanel.py

@@ -17,9 +17,11 @@
 ## You should have received a copy of the GNU General Public License
 ## along with this program.  If not, see http://www.gnu.org/licenses/
 
+import urllib
 import wx
 from AuthenticationStore import AuthenticationEntry
 from Logging import GetLogger
+from qrcode import QrCodeImage, QrCodeFrame
 
 class AuthEntryPanel( wx.Panel ):
     """Authentication code entry panel."""
@@ -115,6 +117,13 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
         self.timer_gauge.SetMinSize( self.timer_gauge.GetSize() )
         sizer.Add( self.timer_gauge, 0, wx.RIGHT | wx.ALIGN_CENTER, 2 )
 
+        # Create our context menu
+        self.context_menu = wx.Menu()
+        item = self.context_menu.Append( wx.ID_ANY, "Copy provisioning URI to clipboard" )
+        self.Bind( wx.EVT_MENU, self.OnProvisioningUri, item )
+        item = self.context_menu.Append( wx.ID_ANY, "Display QR code image" )
+        self.Bind( wx.EVT_MENU, self.OnQrCodeImage, item )
+
         self.UpdateContents()
 
         if entry != None:
@@ -125,6 +134,7 @@ def __init__( self, parent, id = wx.ID_ANY, pos = wx.DefaultPosition, size = wx.
         self.Bind( wx.EVT_TIMER, self.OnTimerTick )
         self.Bind( wx.EVT_ENTER_WINDOW, self.OnMouseEnter )
         self.Bind( wx.EVT_LEAVE_WINDOW, self.OnMouseLeave )
+        self.Bind( wx.EVT_CONTEXT_MENU, self.OnContextMenu )
         self.MouseBind( wx.EVT_LEFT_DCLICK, self.OnDoubleClick )
         self.MouseBind( wx.EVT_LEFT_DOWN, self.OnLeftDown )
         self.MouseBind( wx.EVT_LEFT_UP, self.OnLeftUp )
@@ -192,6 +202,26 @@ def OnDoubleClick( self, event ):
                 wx.Bell()
         event.Skip()
 
+    def OnContextMenu( self, event ):
+        """Offer choice of provisioning URL or QR code image URL from right-click menu."""
+        pos = event.GetPosition()
+        cl_pos = self.ScreenToClient( pos )
+        self.PopupMenu( self.context_menu, cl_pos )
+
+    def OnProvisioningUri( self, event ):
+        """Copy the provisioning URI to the clipboard."""
+        GetLogger().info( "%s copying provisioning URI to the clipboard.", self.GetName() )
+        if not self.CopyProvisioningUriToClipboard():
+            wx.Bell()
+        event.Skip()
+
+    def OnQrCodeImage( self, event ):
+        """Display the QR code image."""
+        GetLogger().info( "%s displaying QR code image.", self.GetName() )
+        if not self.DisplayQrCodeImage():
+            wx.Bell()
+        event.Skip()
+
     def OnMouseEnter( self, event ):
         """Clear mouse button state when the mouse enters the panel."""
         self.left_down = False
@@ -366,3 +396,39 @@ def CopyCodeToClipboard( self ):
             GetLogger().error( "%s cannot open clipboard.", self.GetName() )
             sts = False
         return sts
+
+    def GetProvisioningUri( self ):
+        return self.entry.GetKeyUri()
+
+    def GetQrCodeUrl( self ):
+        qr = QrCodeImage( self.entry )
+        return qr.GetUrl()
+
+    def GetQrCodeImage( self ):
+        qr = QrCodeImage( self.entry )
+        return qr.GetImage()
+
+    def CopyProvisioningUriToClipboard( self ):
+        """Copy the provisioning URI to the clipboard."""
+        sts = True
+        if wx.TheClipboard.Open():
+            if  wx.TheClipboard.SetData( wx.TextDataObject( self.GetProvisioningUri() ) ):
+                wx.TheClipboard.Flush()
+            else:
+                GetLogger().error( "%s encountered an error copying the provisioning URI to the clipboard.",
+                                   self.GetName() )
+                sts = False
+            wx.TheClipboard.Close()
+        else:
+            GetLogger().error( "%s cannot open clipboard.", self.GetName() )
+            sts = False
+        return sts
+
+    def DisplayQrCodeImage( self ):
+        """Display the QR code image."""
+        sts = True
+        title = self.entry.GetQualifiedAccount()
+        image = self.GetQrCodeImage()
+        fr = QrCodeFrame( self, wx.ID_ANY, title, image = image )
+        fr.Show()
+        return sts

pyauth/AuthFrame.py

@@ -285,6 +285,7 @@ def OnCreate( self, event ):
         self.Bind( wx.EVT_MENU, self.OnMenuNewEntry,     id = wx.ID_NEW )
         self.Bind( wx.EVT_MENU, self.OnMenuReindex,      id = self.MENU_REINDEX )
         self.Bind( wx.EVT_MENU, self.OnMenuRegroup,      id = self.MENU_REGROUP )
+        self.Bind( wx.EVT_MENU, self.OnMenuExportProvisioningUris, id = self.MENU_EXPORT_PROVISIONING_URIS )
         self.Bind( wx.EVT_MENU, self.OnMenuQuit,         id = wx.ID_EXIT )
         self.Bind( wx.EVT_MENU, self.OnMenuCopyCode,     id = self.MENU_COPY_CODE )
         self.Bind( wx.EVT_MENU, self.OnMenuEditEntry,    id = wx.ID_EDIT )
@@ -852,6 +853,19 @@ def OnMenuRegroup( self, event ):
         self.populate_entries_window()
         self.UpdatePanelSize()
 
+    def OnMenuExportProvisioningUris( self, event ):
+        """Export provisioning URIs for all entry panels to the clipboard in one block."""
+        uri_text = ""
+        for panel in self.entry_panels:
+            uri_text += panel.GetProvisioningUri() + "\n"
+        if wx.TheClipboard.Open():
+            if  wx.TheClipboard.SetData( wx.TextDataObject( uri_text ) ):
+                wx.TheClipboard.Flush()
+            else:
+                GetLogger().error( "Encountered an error exporting the provisioning URIs to the clipboard." )
+            wx.TheClipboard.Close()
+        else:
+            GetLogger().error( "Cannot open clipboard." )
 
     def create_menu_bar( self ):
         """Create and populate the menu bar."""
@@ -867,11 +881,23 @@ def create_menu_bar( self ):
         self.MENU_REGROUP = mi.GetId()
         db_menu.AppendItem( mi )
 
+        # Export submenu
+        export_menu = wx.Menu()
+        mi = wx.MenuItem( export_menu, wx.ID_ANY, "Provisioning URIs",
+                          "Copy all provisioning URIs to the clipboard" )
+        self.MENU_EXPORT_PROVISIONING_URIS = mi.GetId()
+        export_menu.AppendItem( mi )
+        mi = wx.MenuItem( export_menu, wx.ID_ANY, "QR code URLs",
+                          "Copy all QR code image URLs to the clipboard" )
+        self.MENU_EXPORT_QRCODE_URLS = mi.GetId()
+        export_menu.AppendItem( mi )
+
         # File menu
         menu = wx.Menu()
         menu.Append( wx.ID_NEW, "&New entry\tCtrl-N", "Create a new account entry" )
         menu.AppendSeparator()
         menu.AppendSubMenu( db_menu, "DB Maintenance" )
+        menu.AppendSubMenu( export_menu, "Export" )
         menu.AppendSeparator()
         menu.Append( wx.ID_EXIT, "E&xit\tCtrl-Q", "Exit the program" )
         mb.Append( menu, "&File" )

pyauth/AuthenticationStore.py

@@ -21,6 +21,7 @@
 import errno
 import string
 import base64
+import urllib
 import wx
 import pyotp
 from About import GetProgramName, GetVendorName
@@ -425,6 +426,15 @@ def SetAccount( self, account ):
         self.account = account
         self.modified = True
 
+    def GetQualifiedAccount( self ):
+        """Return the complete provider-qualified account identifier string."""
+        if self.provider != '':
+            qacct = self.provider + ':'
+        else:
+            qacct = ''
+        qacct += self.account
+        return qacct
+
     def GetDigits( self ):
         """Return the number of code digits."""
         return self.digits
@@ -473,6 +483,23 @@ def GetPeriod( self ):
         """Return the time period between code changes."""
         return 30 # Google Authenticator uses a 30-second period
 
+    def GetAlgorithm( self ):
+        """The hashing algorithm to use."""
+        return 'SHA1'
+
+    def GetKeyUri( self ):
+        """Get the provisioning key URI."""
+        uri = "otpauth://totp/" + urllib.quote( self.GetQualifiedAccount() )
+        qs_params = {}
+        qs_params['secret'] = self.secret
+        if self.provider != '':
+            qs_params['issuer'] = self.provider
+        qs_params['digits'] = self.digits
+        qs_params['period'] = self.GetPeriod()
+        qs_params['algorithm'] = self.GetAlgorithm()
+        uri += '?' + urllib.urlencode( qs_params )
+        return uri
+
 
     def GenerateNextCode( self ):
         """Generate the next code in sequence from the secret."""

pyauth/__init__.py

@@ -20,6 +20,6 @@
 __program_name__ = "PyAuth"
 
 # Version info
-__version__ = '1.0.0'
+__version__ = '1.1.0'
 __version_tag__ = ''
 __version_status__ = ''

pyauth/qrcode.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+"""Generate a QR code image for an entry."""
+
+## PyAuth - Google Authenticator desktop application
+## Copyright (C) 2016 Todd T Knarr <tknarr@silverglass.org>
+
+## This program is free software: you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 3 of the License, or
+## (at your option) any later version.
+
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+
+## You should have received a copy of the GNU General Public License
+## along with this program.  If not, see http://www.gnu.org/licenses/
+
+import wx
+import requests
+import urllib
+from io import BytesIO
+from AuthenticationStore import AuthenticationEntry
+from Logging import GetLogger
+
+class QrCodeImage:
+    """Represents a QR code image."""
+
+    def __init__( self, entry ):
+        self.provisioning_uri = entry.GetKeyUri()
+
+    def GetUrl( self ):
+        return "https://www.google.com/chart?chs=240x240&chld=M|0&cht=qr&chl=" + urllib.quote( self.provisioning_uri )
+
+    def GetImage( self ):
+        url = self.GetUrl()
+        GetLogger().debug( "Requesting QR code image from %s", url )
+        resp = requests.get( url )
+        GetLogger().debug( "HTTP status: %d", resp.status_code )
+        if resp.status_code == requests.codes.ok:
+            input_strm = BytesIO( resp.content )
+            image = wx.ImageFromStream( input_strm, wx.BITMAP_TYPE_PNG )
+        else:
+            GetLogger().error( "HTTP error %d", resp.status_code )
+            GetLogger().error( "Error response body:\n%s", resp.text )
+            image = None
+        return image
+
+
+class QrCodeFrame( wx.Frame ):
+
+    def __init__( self, parent, id, title, pos = wx.DefaultPosition, size = wx.DefaultSize,
+                  style = wx.DEFAULT_FRAME_STYLE, name = wx.FrameNameStr, image = None, border = 0 ):
+
+        self.border = border
+        self.x_loc = border
+        self.y_loc = border
+        self.bitmap = image.ConvertToBitmap()
+
+        wx.Frame.__init__( self, parent, id, title, pos, size, style, name )
+
+        client_size = self.bitmap.GetSize()
+        client_size.IncBy( self.border * 2, self.border * 2 )
+        self.SetClientSize( client_size )
+
+        self.Bind( wx.EVT_PAINT, self.OnPaint )
+
+    def OnPaint( self, event ):
+        dc = wx.PaintDC( self )
+        dc.DrawBitmap( self.bitmap, self.x_loc, self.y_loc )

setup.py

@@ -82,6 +82,7 @@
 
     install_requires = [
         #'wxPython>=3.0',
+        'requests>=2.10',
         'pyotp>=2.0.1',
         'pycrypto>=2.6.1',
         'cryptography>=1.3'