diff --git a/README.md b/README.md index 1857bdb..78674c5 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,9 @@ Naturally, enterprises have solutions to this, but self hosters may not. This pr The idea is to record all of this information to a text file, which is backed up off-site as a normal file. This file can then be read by the utility to restore permissions, thereby making the restored backup as close as possible to how it was before it crashed. If mounted to the same locations, this solves any permissions issues a self hoster could face getting back up and running after a catastrophe. ## Status -- ❎ Recurse a directory (index) -- ❎ Store Unix file permissions and ownership data -- ❎ Restore Unix file permissions and ownership data using index file as an input +- ✅ Recurse a directory (index) +- ✅ Store Unix file permissions and ownership data +- ✅ Restore Unix file permissions and ownership data using index file as an input - ❎ Diff index file and restored backup and inform the user of file inconsistencies -- ❎ Index file encryption with bcrypt \ No newline at end of file + - Sort of. It only detects when a file doesn't exist. +- ❎ Index file encryption with bcrypt diff --git a/create.py b/create.py new file mode 100644 index 0000000..93af56a --- /dev/null +++ b/create.py @@ -0,0 +1,12 @@ +#from libufps import ufps +#import libufps +#from inspect import getmembers, isfunction +#import os + +def createIndex(ufps, indexFile): + print("Creating index") + index = ufps.createIndex("") # For ufpsutil we just index from the selected base directory + file = open(indexFile, "w") + file.write(index) + file.close() + print("Index has been written to " + indexFile) diff --git a/libufps/ufps.py b/libufps/ufps.py index bb64d04..d6ed6d9 100644 --- a/libufps/ufps.py +++ b/libufps/ufps.py @@ -13,10 +13,10 @@ class ufps: """I_PERMS = index for permissions""" I_USERN = 1 - """I_USERN = index for username""" + """I_USERN = index for user id""" I_GROUP = 2 - """I_GROUP = index for group""" + """I_GROUP = index for group id""" I_ISDIR = 3 """I_ISDIR = index for directory boolean""" @@ -165,11 +165,11 @@ class ufps: :param path: Path to directory or file :type path: str - :return ownername: Owner name - :rtype ownername: str + :return uid: Owner ID + :rtype uid: int - :return groupname: Group name - :rtype groupname: str + :return gid: Group ID + :rtype gid: int """ realpath = self.basedir+path @@ -179,10 +179,10 @@ class ufps: gid = stats.st_gid # Turn the funny numbers we just got into names. - ownername = pwd.getpwuid(stats.st_uid).pw_name - groupname = grp.getgrgid(stats.st_gid).gr_name + #ownername = pwd.getpwuid(stats.st_uid).pw_name + #groupname = grp.getgrgid(stats.st_gid).gr_name - return ownername, groupname + return uid, gid # def getDirectoryContents(self, path): # realpath = self.basedir + path @@ -222,11 +222,11 @@ class ufps: # For every item in the list, we get it's permissions and owner/group info. for p in fileList: pPerms, pIsDir, pIsLink, pLinkTarget = self.getFilePermissions(p) - ownername, groupname = self.getFileOwner(p) + uid, gid = self.getFileOwner(p) # Stanardized table entry for ufps indexes. # Future additions get added to the end. - D_userFriendlyString = pPerms + " | " + ownername + " | " + groupname + " | " + str(pIsDir) + " | " + str(pIsLink) + " | " + p + " | " + str(pLinkTarget) + "\n" + D_userFriendlyString = pPerms + " | " + str(uid) + " | " + str(gid) + " | " + str(pIsDir) + " | " + str(pIsLink) + " | " + p + " | " + str(pLinkTarget) + "\n" outputIndex+=D_userFriendlyString # Remove tailing newline once again @@ -267,10 +267,13 @@ class ufps: indexRealPath = realpath + indexEntry[self.I_IPATH] pathExists = os.path.exists(indexRealPath) permsToSet = int(indexEntry[self.I_PERMS], base=8) + uid = int(indexEntry[self.I_USERN]) + gid = int(indexEntry[self.I_GROUP]) # If the path doesn't exist, we log this. Otherwise, set the permissions. if pathExists: os.chmod(indexRealPath, permsToSet) + os.chown(indexRealPath, uid, gid) else: # If the path doesn't exist, an inconsistency has been detected. # We report this so that the user can manually rectify it. @@ -279,3 +282,6 @@ class ufps: return results # def diff(self, index): + + def test(self): + print("Test") diff --git a/restore.py b/restore.py new file mode 100644 index 0000000..a104669 --- /dev/null +++ b/restore.py @@ -0,0 +1,2 @@ +def restoreIndex(ufps, indexFile): + ufps.restore(indexFile, "") diff --git a/ufpsutil.py b/ufpsutil.py index 2d2d281..3efaf25 100644 --- a/ufpsutil.py +++ b/ufpsutil.py @@ -3,6 +3,8 @@ import libufps from inspect import getmembers, isfunction import os import argparse +import create +import restore parser = argparse.ArgumentParser( prog='ufpsutil', @@ -17,17 +19,18 @@ parser.add_argument("--i-know-what-im-doing", help = "Force the utility to run w args = parser.parse_args() # Just make argument variables a bit more human readable. +basedir = args.path indexFile = args.index -m_create = args.create -m_restore = args.restore +modeCreate = args.create +modeRestore = args.restore forceWithoutRoot = args.i_know_what_im_doing # Check that both -c and -r arent specified. -if m_create and m_restore: +if modeCreate and modeRestore: exit("[Fatal] Both --create and --restore specified. That doesn't make sense!") # That said, at least -c or -r must be specified. -if not m_create and not m_restore: +if not modeCreate and not modeRestore: exit("[Fatal] I'm not sure what you want me to do. Must specify --create or --restore.") @@ -41,14 +44,19 @@ if uid != 0: else: exit("[Fatal] Root privileges are usually required for this utility to do it's job. If you know what you're doing, try running with --i-know-what-im-doing") -#print(args) +ufps = ufps.ufps(basedir) + +if modeCreate: + create.createIndex(ufps, indexFile) + +if modeRestore: + restore.restoreIndex(ufps, indexFile) #basedir = "tests/testfiles/" #basedirbad = "tests/testfiles_bad/" #ufps = ufps.ufps(basedir) - #print("Regular dir: " + ufps.getInformationRecursive(".")) #print("Regular file: " + ufps.getInformationRecursive("0644")) #print("Linked dir: " + ufps.getInformationRecursive("linktests/link"))