Merge lp:~mrooney/ecryptfs/pythonapi into lp:~ecryptfs/ecryptfs/ecryptfs-utils

[Michael Rooney]

[Michael Rooney (mrooney)]

Dustin, this is the API branch and is ready to go. I created a new python/ directory in src/ which the UI utilities assume is shipped as a dist/site package of python named "ecryptfs" (for example as /usr/lib/python2.6/dist-packages/ecryptfs/)

The two things to resolve before packaging are:
 - should it be somewhere different in the ecryptfs source?
 - I'm expecting an 'ecryptfs' module to be added to dist-packages but 'ecryptfs-utils' already exists for the swig wrappers. They should perhaps be unified, and you can't import something with a dash in the name in python anyway so the existing module is suboptimal. If it isn't too invasive we might want to move the three methods (ecryptfs_passphrase_blob, ecryptfs_passphrase_sig_from_blob, ecryptfs_add_blob_to_keyring) to ecryptapi.py and adjust any references.

[Michael Rooney (mrooney)]

Hi Dustin, I just wanted to ping you on this to see if you had any updates. Probably it is fine to have these two different python folders, one for the swig wrappers and one for native python which exists currently. This way it could be merged as-is.

This merge is blocking the nautilus integration merge which would be pretty awesome to have for Karmic and is coming along nicely.

[Dustin Kirkland  (kirkland)]

Approved, merged. One (minor?) change... I renamed ecryptapi.py to ecryptfsapi.py.

Thanks!

review: Approve

=== added directory 'src/python'
=== added file 'src/python/__init__.py'
=== added file 'src/python/ecryptapi.py'
--- src/python/ecryptapi.py	1970-01-01 00:00:00 +0000
+++ src/python/ecryptapi.py	2009-05-28 13:27:44 +0000
@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+#
+#    ecryptapi.py, Copyright 2008, 2009 Michael Rooney <[e-mail]>
+#    Date: 2009-05-28
+#    Version: 0.4
+#
+#    This is a python API for interacting with ecryptfs-utils and its
+#    encrypted directories.
+#
+#    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 commands, os
+
+AUTOMOUNT_FILE = os.path.expanduser("~/.ecryptfs/auto-mount")
+AUTOUMOUNT_FILE = os.path.expanduser("~/.ecryptfs/auto-umount")
+PRIVATE_LOCATION_FILE = os.path.expanduser("~/.ecryptfs/Private.mnt")
+PRIVATE_LOCATION = os.path.exists(PRIVATE_LOCATION_FILE) and open(PRIVATE_LOCATION_FILE).read().strip()
+
+def set_automount(doAuto):
+    """Enable or disable automounting for this user."""
+    if doAuto:
+        command = "touch %s" % AUTOMOUNT_FILE
+        #open(AUTOMOUNT_FILE, "w")
+    else:
+        command = "rm %s" % AUTOMOUNT_FILE
+        #os.remove(AUTOMOUNT_FILE)
+
+    return commands.getstatusoutput(command)
+
+def get_automount():
+    """Return whether or not automounting is enabled for this user."""
+    return os.path.exists(AUTOMOUNT_FILE)
+
+def set_autounmount(doAuto):
+    """Enable or disable automounting for this user."""
+    if doAuto:
+        command = "touch %s" % AUTOUMOUNT_FILE
+    else:
+        command = "rm %s" % AUTOUMOUNT_FILE
+
+    return commands.getstatusoutput(command)
+
+def get_autounmount():
+    """Return whether or not autounmounting is enabled for this user."""
+    return os.path.exists(AUTOUMOUNT_FILE)
+
+def set_mounted(doMount):
+    """Set the mounted (unencrypted) state of ~/Private."""
+    if doMount:
+        command = "mount.ecryptfs_private"
+    else:
+        command = "umount.ecryptfs_private"
+
+    return commands.getstatusoutput(command)
+
+def get_mounted():
+    """Return whether or not ~/Private is mounted (unencrypted)."""
+    if PRIVATE_LOCATION:
+        mounts = open("/proc/mounts").read()
+        return PRIVATE_LOCATION in mounts
+    else:
+        return False
+
+def needs_setup():
+    """
+    Return whether or not an encrypted directory has been set up by ecryptfs
+    for this user, either Home or Private.
+    """
+    encryptedHome = False #TODO: implement
+    encryptedPrivate = PRIVATE_LOCATION
+    return not (encryptedHome or encryptedPrivate)