From 0cdc353b3ef9f9063a4844f51b5eef3aa0d246be Mon Sep 17 00:00:00 2001 From: Matt Samudio Date: Thu, 2 Nov 2023 12:05:29 -0500 Subject: [PATCH 1/2] Initial draft --- .gitignore | 8 ++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 1 + README.md | 66 ++++++++++++++- gam/__init__.py | 8 ++ gam/storage.py | 87 ++++++++++++++++++++ gpg/__init__.py | 9 ++ gpg/artifactgpg.py | 109 ++++++++++++++++++++++++ setup.py | 65 +++++++++++++++ 9 files changed, 552 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 gam/__init__.py create mode 100644 gam/storage.py create mode 100644 gpg/__init__.py create mode 100755 gpg/artifactgpg.py create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4be5c8f --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# Ensure this file isn't ignored +!.gitignore +# Ignore files with these extensions +*.swp +*.pyc +# Ignore these specific directories +build/ +gpg.egg-info/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..1aba38f --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include LICENSE diff --git a/README.md b/README.md index f4e86f6..a60c10b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,64 @@ -# python -Python modules +# Carleton GAM Library + +## Installation + +### Native Installation +As root: +``` +pip3 install git+https://github.com/carleton/python#egg=gam +``` +Sometimes, `pip3` installs files with permissions such that only root can see them.\ +This has to be remediated with manual permission corrections. + +### Dependency-based Installation +In `requirements.txt`: +``` +git+https://github.com/carleton/python.git@main#egg=gam +``` + +# Carleton GnuPG Library + +## Installation + +### Encryption Installation +As root: +``` +pip3 install git+https://github.com/carleton/python#egg=gpg +``` +For some reason, `pip` installs files with permissions such that only root can see them.\ +This has to be remediated with manual permission corrections. + +### Dependency-based Encryption Installation +In `requirements.txt`: +``` +git+https://github.com/carleton/python.git@main#egg=gpg +``` + +On CLI *(as root)*: +``` +pip3 install git+https://github.com/carleton/python#egg=gpg +``` + +### Encryption Module Usage +Assuming a JSON artifact (file) named `creds.json`: +``` +{"login":"you","password":"yourpassword","token":"SOMETOKENTEXT"} +``` +*Note: token is optional* + +... and it were encrypted with something like: +``` +gpg --encrypt --armor -r you@youremail.com -o creds.asc creds.json +``` + +Sample program: +``` +#!/usr/bin/python +from __future__ import print_function +from gpg import ArtifactCredentials + +art = ArtifactCredentials() +art.fromFile("creds.asc") +print( '%s=>>> login: %s, password: %s' % ('DBG',art.login(),art.password())) +``` + diff --git a/gam/__init__.py b/gam/__init__.py new file mode 100644 index 0000000..b723144 --- /dev/null +++ b/gam/__init__.py @@ -0,0 +1,8 @@ +# Author: Matt Samudio +from __future__ import absolute_import +from .storage import Drive + +__version__ = '0.2.0' +__all__ = [ + 'Drive' +] diff --git a/gam/storage.py b/gam/storage.py new file mode 100644 index 0000000..61c124d --- /dev/null +++ b/gam/storage.py @@ -0,0 +1,87 @@ +#!/usr/bin/python3 +from os.path import expanduser +import sys +import json +import csv + +__all__ = [ + 'Drive' +] + +class Storage(object): + def __init__(self): + self.sTxt='' + +class Drive(Storage): + def __init__(self): + super(Storage,self).__init__() + self.sJSON = {} + + def csvDumpByIdx(self,filename): + with open(filename) as aCSV: + rdr = csv.reader(aCSV) + lno = 0 + for row in rdr: + lno += 1 + line = None + for fld in row: + if line: + line += ','+str(fld) + else: + line = str(fld) + print('%d:%s' % (lno,line)) + aCSV.close() + + def csvDump(self,filename): + with open(filename) as aCSV: + rdr = csv.DictReader(aCSV) + keys = [] + lno = 0 + for row in rdr: + lno += 1 + line = None + for key in row: + if lno < 2: + keys.append(key) + fld = str(row[key]) + line = line+','+fld if line else fld + if lno < 2: + keyline=None + for key in keys: + keyline = keyline+','+str(key) if keyline else str(key) + print('%d:%s' % (0,keyline)) + print('%d:%s' % (lno,line)) + aCSV.close() + + def csvCut(self,filename,fields): + with open(filename) as aCSV: + line = None + for key in fields: + line = line+','+str(key) if line else str(key) + print('%s:%s' % (str(0).rjust(6),line)) + rdr = csv.DictReader(aCSV) + line = None + lno = 0 + for row in rdr: + lno += 1 + line = None + for key in fields: + fld = str(row[key]) + line = line+','+fld if line else fld + print('%s:%s' % (str(lno).rjust(6),line)) + aCSV.close() + + def gamListUsers(self): + pass + + def gamListUserFiles(self,user): + print('%s=>>> gam user %s print filelist id name' % ('DBG',user),file=sys.stderr) + + def gamReportUserFiles(self,user,csv='rpt.csv'): + print('%s=>>> gam user %s show filelist allfields > %s' % ('DBG',user,csv),file=sys.stderr) + + def gamRemoveFile(self,user,fileid): + print('%s=>>> gam user %s delete drivefile %s purge' % ('DBG',user,fileid),file=sys.stderr) + + def gamBatchRemoveFiles(self,batchcsv): + print("%s=>>> gam csv %s gam user '~user' delete drivefile '~id' purge" % ('DBG',batchcsv),file=sys.stderr) diff --git a/gpg/__init__.py b/gpg/__init__.py new file mode 100644 index 0000000..e44d4e7 --- /dev/null +++ b/gpg/__init__.py @@ -0,0 +1,9 @@ +# Author: Matt Samudio +from __future__ import absolute_import +from .artifactgpg import ArtifactCredentials,ArtifactJson + +__version__ = '1.0.1' +__all__ = [ + 'ArtifactCredentials', + 'ArtifactJson' +] diff --git a/gpg/artifactgpg.py b/gpg/artifactgpg.py new file mode 100755 index 0000000..1f5150b --- /dev/null +++ b/gpg/artifactgpg.py @@ -0,0 +1,109 @@ +# Author: Matt Samudio +from __future__ import absolute_import +from __future__ import print_function +from os.path import expanduser +import json +import gnupg + +__all__ = [ + 'ArtifactJson', + 'ArtifactCredentials' +] + +class ArtifactGnuPG(object): + + def __init__(self): + self.encoding='utf-8' + self.sDir=expanduser("~")+"/.gnupg" + self.bRendered=False + self.sTxt='' + + def txtRender(self): + # print( "%s=>>> %s" % ('DBG','ArtifactGnuPG::txtRender invoked')) + pass + + def __str__(self): + if not self.bRendered: + self.txtRender() + self.bRendered=True + return(self.sTxt) + + def _parse(self,txt): + return txt + + def decrypt(self,sTxt,isFilename=False): + sRet=None + pGPG=None + # If one convention fails, try the other ... + try: + pGPG = gnupg.GPG(homedir=self.sDir) + except: + pGPG = gnupg.GPG(gnupghome=self.sDir) + # ... + pGPG.encoding = 'utf-8' + try: + sDat=None + if isFilename: + pDat=None + # print( "%s=>>> opening credentials file: %s" % ('DBG',sFile)) + with open(sTxt,'r') as fIn: + pDat = fIn.read() + # print( "%s=>>> raw data: %s" % ('DBG',pDat)) + try: + # NOTE: versions of python-gnupg prior to 3.0.3 produce + # an exception in another thread after the decryption + # is complete, which is (mostly) harmless. + # https://github.com/isislovecruft/python-gnupg/pull/220 + sDat = pGPG.decrypt(str(pDat),always_trust=True) + except: + pass + else: + try: + sDat = pGPG.decrypt(sTxt,always_trust=True) + except: + pass + # Allow sub-class to parse/process ... + sRet = self._parse(sDat) + except Exception as pE: + print(pE) + return(str(sRet)) + +class ArtifactJson(ArtifactGnuPG): + + def __init__(self): + super(ArtifactJson, self).__init__() + self.sJson = {} + + def _parse(self,txt): + self.sJson = json.loads(str(txt)) + return json.dumps(self.sJson) + + def json(self): + return self.sJson + + def txtRender(self): + self.sTxt = json.dumps(self.sJson) + +class ArtifactCredentials(ArtifactJson): + + def __init__(self): + super(ArtifactCredentials,self).__init__() + self.sLogin=None + self.sPassword=None + self.sToken=None + + def _parse(self,txt): + super(ArtifactCredentials,self)._parse(txt) + nfo = self.json() + self.sLogin = nfo.get('login') + self.sPassword = nfo.get('password') + self.sToken = nfo.get('token') + + def login(self): + return self.sLogin + + def password(self): + return self.sPassword + + def token(self): + return self.sToken diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..55d7a66 --- /dev/null +++ b/setup.py @@ -0,0 +1,65 @@ +# Author: Matt Samudio +from setuptools import setup, find_packages +from distutils.version import StrictVersion +import sys +import os +import re + +MOD = os.path.dirname(os.path.abspath(__file__)) +IFN = os.path.join(MOD,'gam','__init__.py') + +def pipver(minver='6.0.0'): + bRet=True + try: + import pip + if StrictVersion(pip.__version__) < StrictVersion(minver): + sMsg="Upgrade pip, your version '{0}' is outdated. Minimum required version is '{1}':\n{2}" + print(sMsg.format(pip.__version__, minver, 'Try: pip install --upgrade pip')) + bRet=False + except ImportError as e: + sMsg="Failed to import pip, try: {0}" + print(sMsg.format('pip3 install --upgrade pip')) + bRet=False + return bRet + +def getver(initfile): + with open(initfile, 'r') as fIn: + haystack = fIn.read() + match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", haystack, re.M) + if not match: + raise RuntimeError('Unable to find version string in %s.' % (initfile)) + return match.group(1) + +ver = getver(IFN) +#reqs=['python-gnupg>=0.4.7'] +reqs=[] + +if pipver(): + setup( + name='gam', + version=ver, + description='Carleton python modules', + author='Matt Samudio', + author_email='noreply@carleton.edu', + url='https://github.com/carleton/python/', + license='Apache License (2.0)', + download_url='https://github.com/carleton/python/', + classifiers=[ + 'License :: OSI Approved :: Apache Software License', + 'Programming Language :: Python', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + 'Environment :: Console', + ], + platforms=['Any'], + scripts=[], + provides=['gam'], + packages=find_packages(), + include_package_data=True, + install_requires=reqs, + # dependency_links=links, + zip_safe=False + ) From 40c0702c70597759510ecfee8842383413d07a12 Mon Sep 17 00:00:00 2001 From: Matt Samudio Date: Thu, 2 Nov 2023 12:28:55 -0500 Subject: [PATCH 2/2] Pruned executable from module file --- gam/storage.py | 1 - 1 file changed, 1 deletion(-) diff --git a/gam/storage.py b/gam/storage.py index 61c124d..96a415d 100644 --- a/gam/storage.py +++ b/gam/storage.py @@ -1,4 +1,3 @@ -#!/usr/bin/python3 from os.path import expanduser import sys import json