admongo 0.1.0__tar.gz

admongo-0.1.0/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2020, Karlsruhe Institute of Technology (KIT)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

admongo-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: admongo
+Version: 0.1.0
+Summary: MongoDB Administration Tool
+Author: The Virtmat Tools Team
+Author-email: virtmat-tools@lists.kit.edu
+License: BSD-2-Clause
+Keywords: database,database management system
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Other/Nonlisted Topic
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pymongo
+
+## About
+
+This code automates MongoDB administrative tasks without knowledge of mongo shell language (JavaScript).
+
+This repository contains scripts to automate adminstrative tasks on MongoDB.
+
+* A Python module using PyMongo, the Python API for MongoDB. Detailed usage instructions can be found [here](docs/pymongo_admin.md).
+* A bash script using the native JavaScript-based `mongo` client from the mongodb package.
+  This interface is not further maintained and is deprecated.
+
+## How to install
+
+From the PyPI repository:
+```
+pip install admongo
+```
+
+From the Gitlab repository:
+```
+pip install git+https://gitlab.kit.edu/ivan.kondov/mongo-admin.git
+```
+
+## How to use
+
+A short help can be obtained with the command:
+
+```
+mongo_admin --help
+```
+
+See the [detailed usage instructions](docs/pymongo_admin.md).

admongo-0.1.0/README.md

@@ -0,0 +1,31 @@
+## About
+
+This code automates MongoDB administrative tasks without knowledge of mongo shell language (JavaScript).
+
+This repository contains scripts to automate adminstrative tasks on MongoDB.
+
+* A Python module using PyMongo, the Python API for MongoDB. Detailed usage instructions can be found [here](docs/pymongo_admin.md).
+* A bash script using the native JavaScript-based `mongo` client from the mongodb package.
+  This interface is not further maintained and is deprecated.
+
+## How to install
+
+From the PyPI repository:
+```
+pip install admongo
+```
+
+From the Gitlab repository:
+```
+pip install git+https://gitlab.kit.edu/ivan.kondov/mongo-admin.git
+```
+
+## How to use
+
+A short help can be obtained with the command:
+
+```
+mongo_admin --help
+```
+
+See the [detailed usage instructions](docs/pymongo_admin.md).

admongo-0.1.0/setup.cfg

@@ -0,0 +1,53 @@
+[metadata]
+name = admongo
+version = 0.1.0
+author = The Virtmat Tools Team
+author_email = virtmat-tools@lists.kit.edu
+description = MongoDB Administration Tool
+long_description = file: README.md
+long_description_content_type = text/markdown
+keywords = database, database management system
+license = BSD-2-Clause
+classifiers = 
+	Development Status :: 4 - Beta
+	Environment :: Console
+	Intended Audience :: End Users/Desktop
+	Intended Audience :: System Administrators
+	License :: OSI Approved :: BSD License
+	Natural Language :: English
+	Operating System :: OS Independent
+	Programming Language :: Python
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.8
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
+	Topic :: Database
+	Topic :: Software Development :: User Interfaces
+	Topic :: Other/Nonlisted Topic
+
+[options]
+zip_safe = false
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.8
+install_requires = 
+	pymongo
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+console_scripts = 
+	mongo_admin = pymongo_admin.mongo_admin:main
+
+[flake8]
+max-line-length = 120
+exclude = __init__.py
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

admongo-0.1.0/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+if __name__ == '__main__':
+    setup()

admongo-0.1.0/src/admongo.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.1
+Name: admongo
+Version: 0.1.0
+Summary: MongoDB Administration Tool
+Author: The Virtmat Tools Team
+Author-email: virtmat-tools@lists.kit.edu
+License: BSD-2-Clause
+Keywords: database,database management system
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Other/Nonlisted Topic
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pymongo
+
+## About
+
+This code automates MongoDB administrative tasks without knowledge of mongo shell language (JavaScript).
+
+This repository contains scripts to automate adminstrative tasks on MongoDB.
+
+* A Python module using PyMongo, the Python API for MongoDB. Detailed usage instructions can be found [here](docs/pymongo_admin.md).
+* A bash script using the native JavaScript-based `mongo` client from the mongodb package.
+  This interface is not further maintained and is deprecated.
+
+## How to install
+
+From the PyPI repository:
+```
+pip install admongo
+```
+
+From the Gitlab repository:
+```
+pip install git+https://gitlab.kit.edu/ivan.kondov/mongo-admin.git
+```
+
+## How to use
+
+A short help can be obtained with the command:
+
+```
+mongo_admin --help
+```
+
+See the [detailed usage instructions](docs/pymongo_admin.md).

admongo-0.1.0/src/admongo.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.cfg
+setup.py
+src/admongo.egg-info/PKG-INFO
+src/admongo.egg-info/SOURCES.txt
+src/admongo.egg-info/dependency_links.txt
+src/admongo.egg-info/entry_points.txt
+src/admongo.egg-info/not-zip-safe
+src/admongo.egg-info/requires.txt
+src/admongo.egg-info/top_level.txt
+src/pymongo_admin/__init__.py
+src/pymongo_admin/mongo_admin.py

admongo-0.1.0/src/admongo.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

admongo-0.1.0/src/admongo.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mongo_admin = pymongo_admin.mongo_admin:main

admongo-0.1.0/src/admongo.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

admongo-0.1.0/src/admongo.egg-info/requires.txt

@@ -0,0 +1 @@
+pymongo

admongo-0.1.0/src/admongo.egg-info/top_level.txt

@@ -0,0 +1 @@
+pymongo_admin

admongo-0.1.0/src/pymongo_admin/mongo_admin.py

@@ -0,0 +1,216 @@
+"""
+Developed at Karlsruhe Institute of Technology (KIT), December 2019
+This script uses pymongo commands to automate user management of mongodb instances.
+"""
+import argparse
+import getpass
+from bson.json_util import dumps
+from pymongo import MongoClient
+
+
+def pass_set():
+    """Return a set password with password retype checking."""
+    pwd = -999
+    re_pwd = 111
+    while pwd != re_pwd:
+        pwd = getpass.getpass('New password for user: ')
+        re_pwd = getpass.getpass('Re-type password: ')
+        if pwd == re_pwd:
+            return pwd
+        print('Passwords do not match, try again: ')
+    return None
+
+
+def main():
+    """the main function"""
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--host', required=True,
+                        help='Hostname of MongoDB instance')
+    parser.add_argument('--cacert', required=True,
+                        help='Path to CA certificate')
+    parser.add_argument('--clcert', default=None, required=False,
+                        help='Path to client certificate')
+    args = parser.parse_args()
+    opt = 0
+
+    while True:
+        try:
+            print('\nYour login credentials for '+args.host+':\n')
+            x509 = input('Do you use x509 authentication? [no/yes]\n' +
+                         '(press "Enter" if you don\'t know or "0" to quit): ')
+            assert x509.lower() in ['yes', 'no', '', '0']
+            if x509.lower() == 'yes':
+                certkeyfile = input('Locate your certificate/key file: ')
+                client = MongoClient(host=args.host, authSource='$external',
+                                     tlsCertificateKeyFile=certkeyfile,
+                                     tlsCAFile=args.cacert, tls=True,
+                                     authMechanism='MONGODB-X509')
+                db = client['$external']
+                client.server_info()
+            elif x509.lower() in ['no', '']:
+                db_auth = input('Your authentication database: ')
+                user_auth = input('Your username to login: ')
+                pwd_auth = getpass.getpass(f'Your password for {user_auth}: ')
+                client = MongoClient(host=args.host, username=user_auth,
+                                     authSource=db_auth, password=pwd_auth,
+                                     tlsCertificateKeyFile=args.clcert,
+                                     tlsCAFile=args.cacert, tls=True)
+                db = client[db_auth]
+                client.server_info()
+            elif x509 == '0':
+                opt = 'quit'
+            break
+        except Exception as err:
+            print(err)
+
+    while opt != 'quit':
+        try:
+            choice = input("""
+        1: Create user
+        2: Change password
+        3: Remove user
+        4: Grant a role to user
+        5: Revoke a role from user
+        6: Show users
+        7: List available databases
+        8: Create a database
+        9: Drop a database
+        0: Quit/Log out
+
+        your choice (0 for Quit): """)
+
+            if choice == '1':
+                opt = 'createUser'
+            elif choice == '2':
+                opt = 'updatePass'
+            elif choice == '3':
+                opt = 'dropuser'
+            elif choice == '4':
+                opt = 'grant'
+            elif choice == '5':
+                opt = 'revoke'
+            elif choice == '6':
+                opt = 'showusers'
+            elif choice == '7':
+                opt = 'listdb'
+            elif choice == '8':
+                opt = 'createdb'
+            elif choice == '9':
+                opt = 'dropdb'
+            elif choice == '0':
+                opt = 'quit'
+            else:
+                raise Exception('WrongChoice')
+
+            if opt == 'createUser':
+                try:
+                    x509_newuser = input('Do you use X509 authentication for new user [no/yes]: ')
+                    if x509_newuser == 'yes':
+                        subject_dn = input('Subject DN of new user: ')
+                        role_newuser = input('Role of new user: ')
+                        db = client['$external']
+                        db.command({'createUser': subject_dn,
+                                    'roles': [{'role': role_newuser, 'db': 'admin'}]})
+                        print(f'\n {subject_dn} is created for admin database with {role_newuser} role.')
+                    else:
+                        new_user = input('New username: ')
+                        db_sibling_in = input('Authentication database of new user: ')
+                        db_sibling = client[db_sibling_in]
+                        pass_newuser = pass_set()
+                        role_newuser = input('Role of new user: ')
+                        db_sibling.command(opt, new_user, pwd=pass_newuser,
+                                           roles=[{'role': role_newuser, 'db': db_sibling_in}])
+                        print(f'\n {new_user} is created for {db_sibling} database with {role_newuser} role.')
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'updatePass':
+                try:
+                    user_update = input('Username to update the password: ')
+                    db_sibling_in = input('Authentication database of user: ')
+                    db_sibling = client[db_sibling_in]
+                    pass_newuser = pass_set()
+                    db_sibling.command('updateUser', user_update, pwd=pass_newuser)
+                    print(f'\n Password is changed successfully for {user_update}.')
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'dropuser':
+                try:
+                    user_drop = input('Username to be removed: ')
+                    db_sibling_in = input(f'Authentication database of {user_drop}: ')
+                    db_sibling = client[db_sibling_in]
+                    db_sibling.command('dropUser', user_drop)
+                    print(f'The user {user_drop} is removed from {db_sibling_in} database.')
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'grant':
+                try:
+                    user_grant = input('Username to be granted: ')
+                    db_sibling_in = input('Authentication database of user: ')
+                    db_sibling = client[db_sibling_in]
+                    target_db = input('Database for which new role will be granted, target database: ')
+                    new_role = input(f'New role for {user_grant}: ')
+                    db_sibling.command('grantRolesToUser', user_grant,
+                                       roles=[{'role': new_role, 'db': target_db}])
+                    print(f'\n The {new_role} role is granted to {user_grant} on {target_db} database.')
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'revoke':
+                try:
+                    user_revoked = input('Username to revoke a role from: ')
+                    db_sibling_in = input('Authentication database of user: ')
+                    db_sibling = client[db_sibling_in]
+                    target_db = input('Database for which role will be revoked, target database:')
+                    role_drop = input('Role to be revoked from {user_revoked}: ')
+                    db_sibling.command('revokeRolesFromUser', user_revoked,
+                                       roles=[{'role': role_drop, 'db': target_db}])
+                    print(f'\n The {role_drop} role is revoked from {user_revoked} on {target_db} database.')
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'showusers':
+                try:
+                    db_sibling_in = input('Database to print: ')
+                    db_sibling = client[db_sibling_in]
+                    command_exit = db_sibling.command('usersInfo')
+                    print(dumps(command_exit, indent=4))
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'listdb':
+                try:
+                    db_sibling = client['admin']
+                    command_exit = db_sibling.command('listDatabases')
+                    print(dumps(command_exit, indent=4))
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'createdb':
+                try:
+                    db_name = input('Name of new database: ')
+                    db_sibling = client[db_name]
+                    privs = [{'resource': {'db': db_name, 'collection': ''},
+                              'actions': ['changeOwnPassword']}]
+                    command_exit = db_sibling.command('createRole',
+                                                      'changeOwnPassword',
+                                                      privileges=privs,
+                                                      roles=[])
+                    print(dumps(command_exit, indent=4))
+                except Exception as err:
+                    print(err)
+
+            elif opt == 'dropdb':
+                try:
+                    db_name = input('Database to drop: ')
+                    db_sibling = client[db_name]
+                    command_exit = db_sibling.command('dropAllUsersFromDatabase')
+                    print(dumps(command_exit, indent=4))
+                    client.drop_database(db_name)
+                except Exception as err:
+                    print(err)
+
+        except Exception:
+            print('Wrong choice. Please try again.')