Blob Blame Raw
From 4faec52810e12070ef72da347bb590c57d8761e4 Mon Sep 17 00:00:00 2001
From: Mark Reynolds <mreynolds@redhat.com>
Date: Fri, 20 Nov 2020 17:47:18 -0500
Subject: [PATCH 1/2] Issue 3657 - Add options to dsctl for dsrc file

Description:  Add options to create, modify, delete, and display
              the .dsrc CLI tool shortcut file.

Relates: https://github.com/389ds/389-ds-base/issues/3657

Reviewed by: firstyear(Thanks!)
---
 dirsrvtests/tests/suites/clu/dsrc_test.py | 136 ++++++++++
 src/lib389/cli/dsctl                      |   2 +
 src/lib389/lib389/cli_ctl/dsrc.py         | 312 ++++++++++++++++++++++
 3 files changed, 450 insertions(+)
 create mode 100644 dirsrvtests/tests/suites/clu/dsrc_test.py
 create mode 100644 src/lib389/lib389/cli_ctl/dsrc.py

diff --git a/dirsrvtests/tests/suites/clu/dsrc_test.py b/dirsrvtests/tests/suites/clu/dsrc_test.py
new file mode 100644
index 000000000..1b27700ec
--- /dev/null
+++ b/dirsrvtests/tests/suites/clu/dsrc_test.py
@@ -0,0 +1,136 @@
+import logging
+import pytest
+import os
+from os.path import expanduser
+from lib389.cli_base import FakeArgs
+from lib389.cli_ctl.dsrc import create_dsrc, modify_dsrc, delete_dsrc, display_dsrc
+from lib389._constants import DEFAULT_SUFFIX, DN_DM
+from lib389.topologies import topology_st as topo
+
+log = logging.getLogger(__name__)
+
+
+@pytest.fixture(scope="function")
+def setup(topo, request):
+    """Preserve any existing .dsrc file"""
+
+    dsrc_file = f'{expanduser("~")}/.dsrc'
+    backup_file = dsrc_file + ".original"
+    if os.path.exists(dsrc_file):
+        os.rename(dsrc_file, backup_file)
+
+    def fin():
+        if os.path.exists(backup_file):
+            os.rename(backup_file, dsrc_file)
+
+    request.addfinalizer(fin)
+
+
+def test_dsrc(topo, setup):
+    """Test "dsctl dsrc" command
+
+    :id: 0610de6c-e167-4761-bdab-3e677b2d44bb
+    :setup: Standalone Instance
+    :steps:
+        1. Test creation works
+        2. Test creating duplicate section
+        3. Test adding an additional inst config works
+        4. Test removing an instance works
+        5. Test modify works
+        6. Test delete works
+        7. Test display fails when no file is present
+
+    :expectedresults:
+        1. Success
+        2. Success
+        3. Success
+        4. Success
+        5. Success
+        6. Success
+        7. Success
+    """
+
+    inst = topo.standalone
+    serverid = inst.serverid
+    second_inst_name = "Second"
+    second_inst_basedn = "o=second"
+    different_suffix = "o=different"
+
+    # Setup our args
+    args = FakeArgs()
+    args.basedn = DEFAULT_SUFFIX
+    args.binddn = DN_DM
+    args.json = None
+    args.uri = None
+    args.saslmech = None
+    args.tls_cacertdir = None
+    args.tls_cert = None
+    args.tls_key = None
+    args.tls_reqcert = None
+    args.starttls = None
+    args.cancel_starttls = None
+    args.pwdfile = None
+    args.do_it = True
+
+    # Create a dsrc configuration entry
+    create_dsrc(inst, log, args)
+    display_dsrc(inst, topo.logcap.log, args)
+    assert topo.logcap.contains("basedn = " + args.basedn)
+    assert topo.logcap.contains("binddn = " + args.binddn)
+    assert topo.logcap.contains("[" + serverid + "]")
+    topo.logcap.flush()
+
+    # Attempt to add duplicate instance section
+    with pytest.raises(ValueError):
+        create_dsrc(inst, log, args)
+
+    # Test adding a second instance works correctly
+    inst.serverid = second_inst_name
+    args.basedn = second_inst_basedn
+    create_dsrc(inst, log, args)
+    display_dsrc(inst, topo.logcap.log, args)
+    assert topo.logcap.contains("basedn = " + args.basedn)
+    assert topo.logcap.contains("[" + second_inst_name + "]")
+    topo.logcap.flush()
+
+    # Delete second instance
+    delete_dsrc(inst, log, args)
+    inst.serverid = serverid  # Restore original instance name
+    display_dsrc(inst, topo.logcap.log, args)
+    assert not topo.logcap.contains("[" + second_inst_name + "]")
+    assert not topo.logcap.contains("basedn = " + args.basedn)
+    # Make sure first instance config is still present
+    assert topo.logcap.contains("[" + serverid + "]")
+    assert topo.logcap.contains("binddn = " + args.binddn)
+    topo.logcap.flush()
+
+    # Modify the config
+    args.basedn = different_suffix
+    modify_dsrc(inst, log, args)
+    display_dsrc(inst, topo.logcap.log, args)
+    assert topo.logcap.contains(different_suffix)
+    topo.logcap.flush()
+
+    # Remove an arg from the config
+    args.basedn = ""
+    modify_dsrc(inst, log, args)
+    display_dsrc(inst, topo.logcap.log, args)
+    assert not topo.logcap.contains(different_suffix)
+    topo.logcap.flush()
+
+    # Remove the last entry, which should delete the file
+    delete_dsrc(inst, log, args)
+    dsrc_file = f'{expanduser("~")}/.dsrc'
+    assert not os.path.exists(dsrc_file)
+
+    # Make sure display fails
+    with pytest.raises(ValueError):
+        display_dsrc(inst, log, args)
+
+
+if __name__ == '__main__':
+    # Run isolated
+    # -s for DEBUG mode
+    CURRENT_FILE = os.path.realpath(__file__)
+    pytest.main(["-s", CURRENT_FILE])
+
diff --git a/src/lib389/cli/dsctl b/src/lib389/cli/dsctl
index fe9bc10e9..69f069297 100755
--- a/src/lib389/cli/dsctl
+++ b/src/lib389/cli/dsctl
@@ -23,6 +23,7 @@ from lib389.cli_ctl import tls as cli_tls
 from lib389.cli_ctl import health as cli_health
 from lib389.cli_ctl import nsstate as cli_nsstate
 from lib389.cli_ctl import dbgen as cli_dbgen
+from lib389.cli_ctl import dsrc as cli_dsrc
 from lib389.cli_ctl.instance import instance_remove_all
 from lib389.cli_base import (
     disconnect_instance,
@@ -61,6 +62,7 @@ cli_tls.create_parser(subparsers)
 cli_health.create_parser(subparsers)
 cli_nsstate.create_parser(subparsers)
 cli_dbgen.create_parser(subparsers)
+cli_dsrc.create_parser(subparsers)
 
 argcomplete.autocomplete(parser)
 
diff --git a/src/lib389/lib389/cli_ctl/dsrc.py b/src/lib389/lib389/cli_ctl/dsrc.py
new file mode 100644
index 000000000..e49c7f819
--- /dev/null
+++ b/src/lib389/lib389/cli_ctl/dsrc.py
@@ -0,0 +1,312 @@
+# --- BEGIN COPYRIGHT BLOCK ---
+# Copyright (C) 2020 Red Hat, Inc.
+# All rights reserved.
+#
+# License: GPL (version 3 or any later version).
+# See LICENSE for details.
+# --- END COPYRIGHT BLOCK ---
+
+import json
+from os.path import expanduser
+from os import path, remove
+from ldapurl import isLDAPUrl
+from ldap.dn import is_dn
+import configparser
+
+
+def create_dsrc(inst, log, args):
+    """Create the .dsrc file
+
+    [instance]
+    uri = ldaps://hostname:port
+    basedn = dc=example,dc=com
+    binddn = uid=user,....
+    saslmech = [EXTERNAL|PLAIN]
+    tls_cacertdir = /path/to/cacertdir
+    tls_cert = /path/to/user.crt
+    tls_key = /path/to/user.key
+    tls_reqcert = [never, hard, allow]
+    starttls = [true, false]
+    pwdfile = /path/to/file
+    """
+
+    dsrc_file = f'{expanduser("~")}/.dsrc'
+    config = configparser.ConfigParser()
+    config.read(dsrc_file)
+
+    # Verify this section does not already exist
+    instances = config.sections()
+    if inst.serverid in instances:
+        raise ValueError("There is already a configuration section for this instance!")
+
+    # Process and validate the args
+    config[inst.serverid] = {}
+
+    if args.uri is not None:
+        if not isLDAPUrl(args.uri):
+            raise ValueError("The uri is not a valid LDAP URL!")
+        if args.uri.startswith("ldapi"):
+            # We must use EXTERNAL saslmech for LDAPI
+            args.saslmech = "EXTERNAL"
+        config[inst.serverid]['uri'] = args.uri
+    if args.basedn is not None:
+        if not is_dn(args.basedn):
+            raise ValueError("The basedn is not a valid DN!")
+        config[inst.serverid]['basedn'] = args.basedn
+    if args.binddn is not None:
+        if not is_dn(args.binddn):
+            raise ValueError("The binddn is not a valid DN!")
+        config[inst.serverid]['binddn'] = args.binddn
+    if args.saslmech is not None:
+        if args.saslmech not in ['EXTERNAL', 'PLAIN']:
+            raise ValueError("The saslmech must be EXTERNAL or PLAIN!")
+        config[inst.serverid]['saslmech'] = args.saslmech
+    if args.tls_cacertdir is not None:
+        if not path.exists(args.tls_cacertdir):
+            raise ValueError('--tls-cacertdir directory does not exist!')
+        config[inst.serverid]['tls_cacertdir'] = args.tls_cacertdir
+    if args.tls_cert is not None:
+        if not path.exists(args.tls_cert):
+            raise ValueError('--tls-cert does not point to an existing file!')
+        config[inst.serverid]['tls_cert'] = args.tls_cert
+    if args.tls_key is not None:
+        if not path.exists(args.tls_key):
+            raise ValueError('--tls-key does not point to an existing file!')
+        config[inst.serverid]['tls_key'] = args.tls_key
+    if args.tls_reqcert is not None:
+        if args.tls_reqcert not in ['never', 'hard', 'allow']:
+            raise ValueError('--tls-reqcert value is invalid (must be either "never", "allow", or "hard")!')
+        config[inst.serverid]['tls_reqcert'] = args.tls_reqcert
+    if args.starttls:
+         config[inst.serverid]['starttls'] = 'true'
+    if args.pwdfile is not None:
+        if not path.exists(args.pwdfile):
+            raise ValueError('--pwdfile does not exist!')
+        config[inst.serverid]['pwdfile'] = args.pwdfile
+
+    if len(config[inst.serverid]) == 0:
+        # No args set
+        raise ValueError("You must set at least one argument for the new dsrc file!")
+
+    # Print a preview of the config
+    log.info(f'Updating "{dsrc_file}" with:\n')
+    log.info(f'    [{inst.serverid}]')
+    for k, v in config[inst.serverid].items():
+        log.info(f'    {k} = {v}')
+
+    # Perform confirmation?
+    if not args.do_it:
+        while 1:
+            val = input(f'\nUpdate "{dsrc_file}" ? [yes]: ').rstrip().lower()
+            if val == '' or val == 'y' or val == 'yes':
+                break
+            if val == 'n' or val == 'no':
+                return
+
+    # Now write the file
+    with open(dsrc_file, 'w') as configfile:
+        config.write(configfile)
+
+    log.info(f'Successfully updated: {dsrc_file}')
+
+
+def modify_dsrc(inst, log, args):
+    """Modify the instance config
+    """
+    dsrc_file = f'{expanduser("~")}/.dsrc'
+
+    if path.exists(dsrc_file):
+        config = configparser.ConfigParser()
+        config.read(dsrc_file)
+
+        # Verify we have a section to modify
+        instances = config.sections()
+        if inst.serverid not in instances:
+            raise ValueError("There is no configuration section for this instance to modify!")
+
+        # Process and validate the args
+        if args.uri is not None:
+            if not isLDAPUrl(args.uri):
+                raise ValueError("The uri is not a valid LDAP URL!")
+            if args.uri.startswith("ldapi"):
+                # We must use EXTERNAL saslmech for LDAPI
+                args.saslmech = "EXTERNAL"
+            if args.uri == '':
+                del config[inst.serverid]['uri']
+            else:
+                config[inst.serverid]['uri'] = args.uri
+        if args.basedn is not None:
+            if not is_dn(args.basedn):
+                raise ValueError("The basedn is not a valid DN!")
+            if args.basedn == '':
+                del config[inst.serverid]['basedn']
+            else:
+                config[inst.serverid]['basedn'] = args.basedn
+        if args.binddn is not None:
+            if not is_dn(args.binddn):
+                raise ValueError("The binddn is not a valid DN!")
+            if args.binddn == '':
+                del config[inst.serverid]['binddn']
+            else:
+                config[inst.serverid]['binddn'] = args.binddn
+        if args.saslmech is not None:
+            if args.saslmech not in ['EXTERNAL', 'PLAIN']:
+                raise ValueError("The saslmech must be EXTERNAL or PLAIN!")
+            if args.saslmech == '':
+                del config[inst.serverid]['saslmech']
+            else:
+                config[inst.serverid]['saslmech'] = args.saslmech
+        if args.tls_cacertdir is not None:
+            if not path.exists(args.tls_cacertdir):
+                raise ValueError('--tls-cacertdir directory does not exist!')
+            if args.tls_cacertdir == '':
+                del config[inst.serverid]['tls_cacertdir']
+            else:
+                config[inst.serverid]['tls_cacertdir'] = args.tls_cacertdir
+        if args.tls_cert is not None:
+            if not path.exists(args.tls_cert):
+                raise ValueError('--tls-cert does not point to an existing file!')
+            if args.tls_cert == '':
+                del config[inst.serverid]['tls_cert']
+            else:
+                config[inst.serverid]['tls_cert'] = args.tls_cert
+        if args.tls_key is not None:
+            if not path.exists(args.tls_key):
+                raise ValueError('--tls-key does not point to an existing file!')
+            if args.tls_key == '':
+                del config[inst.serverid]['tls_key']
+            else:
+                config[inst.serverid]['tls_key'] = args.tls_key
+        if args.tls_reqcert is not None:
+            if args.tls_reqcert not in ['never', 'hard', 'allow']:
+                raise ValueError('--tls-reqcert value is invalid (must be either "never", "allow", or "hard")!')
+            if args.tls_reqcert == '':
+                del config[inst.serverid]['tls_reqcert']
+            else:
+                config[inst.serverid]['tls_reqcert'] = args.tls_reqcert
+        if args.starttls:
+             config[inst.serverid]['starttls'] = 'true'
+        if args.cancel_starttls:
+            config[inst.serverid]['starttls'] = 'false'
+        if args.pwdfile is not None:
+            if not path.exists(args.pwdfile):
+                raise ValueError('--pwdfile does not exist!')
+            if args.pwdfile == '':
+                del config[inst.serverid]['pwdfile']
+            else:
+                config[inst.serverid]['pwdfile'] = args.pwdfile
+
+        # Okay now rewrite the file
+        with open(dsrc_file, 'w') as configfile:
+            config.write(configfile)
+
+        log.info(f'Successfully updated: {dsrc_file}')
+    else:
+        raise ValueError(f'There is no .dsrc file "{dsrc_file}" to update!')
+
+
+def delete_dsrc(inst, log, args):
+    """Delete the .dsrc file
+    """
+    dsrc_file = f'{expanduser("~")}/.dsrc'
+    if path.exists(dsrc_file):
+        if not args.do_it:
+            # Get confirmation
+            while 1:
+                val = input(f'\nAre you sure you want to remove this instances configuration ? [no]: ').rstrip().lower()
+                if val == 'y' or val == 'yes':
+                    break
+                if val == '' or val == 'n' or val == 'no':
+                    return
+
+        config = configparser.ConfigParser()
+        config.read(dsrc_file)
+        instances = config.sections()
+        if inst.serverid not in instances:
+            raise ValueError("The is no configuration for this instance")
+
+        # Update the config object
+        del config[inst.serverid]
+
+        if len(config.sections()) == 0:
+            # The file would be empty so just delete it
+            try:
+                remove(dsrc_file)
+                log.info(f'Successfully removed: {dsrc_file}')
+                return
+            except OSError as e:
+                raise ValueError(f'Failed to delete "{dsrc_file}",  error: {str(e)}')
+        else:
+            # write the updated config
+            with open(dsrc_file, 'w') as configfile:
+                config.write(configfile)
+    else:
+        raise ValueError(f'There is no .dsrc file "{dsrc_file}" to update!')
+
+    log.info(f'Successfully updated: {dsrc_file}')
+
+def display_dsrc(inst, log, args):
+    """Display the contents of the ~/.dsrc file
+    """
+    dsrc_file = f'{expanduser("~")}/.dsrc'
+
+    if not path.exists(dsrc_file):
+        raise ValueError(f'There is no dsrc file "{dsrc_file}" to display!')
+
+    config = configparser.ConfigParser()
+    config.read(dsrc_file)
+    instances = config.sections()
+
+    for inst_section in instances:
+        if args.json:
+            log.info(json.dumps({inst_section: dict(config[inst_section])}, indent=4))
+        else:
+            log.info(f'[{inst_section}]')
+            for k, v in config[inst_section].items():
+                log.info(f'{k} = {v}')
+            log.info("")
+
+
+def create_parser(subparsers):
+    dsrc_parser = subparsers.add_parser('dsrc', help="Manage the .dsrc file")
+    subcommands = dsrc_parser.add_subparsers(help="action")
+
+    # Create .dsrc file
+    dsrc_create_parser = subcommands.add_parser('create', help='Generate the .dsrc file')
+    dsrc_create_parser.set_defaults(func=create_dsrc)
+    dsrc_create_parser.add_argument('--uri', help="The URI (LDAP URL) for the Directory Server instance.")
+    dsrc_create_parser.add_argument('--basedn', help="The default database suffix.")
+    dsrc_create_parser.add_argument('--binddn', help="The default Bind DN used or authentication.")
+    dsrc_create_parser.add_argument('--saslmech', help="The SASL mechanism to use: PLAIN or EXTERNAL.")
+    dsrc_create_parser.add_argument('--tls-cacertdir', help="The directory containing the Trusted Certificate Authority certificate.")
+    dsrc_create_parser.add_argument('--tls-cert', help="The absolute file name to the server certificate.")
+    dsrc_create_parser.add_argument('--tls-key', help="The absolute file name to the server certificate key.")
+    dsrc_create_parser.add_argument('--tls-reqcert', help="Request certificate strength: 'never', 'allow', 'hard'")
+    dsrc_create_parser.add_argument('--starttls', action='store_true', help="Use startTLS for connection to the server.")
+    dsrc_create_parser.add_argument('--pwdfile', help="The absolute path to a file containing the Bind DN's password.")
+    dsrc_create_parser.add_argument('--do-it', action='store_true', help="Create the file without any confirmation.")
+
+    dsrc_modify_parser = subcommands.add_parser('modify', help='Modify the .dsrc file')
+    dsrc_modify_parser.set_defaults(func=modify_dsrc)
+    dsrc_modify_parser.add_argument('--uri', nargs='?', const='', help="The URI (LDAP URL) for the Directory Server instance.")
+    dsrc_modify_parser.add_argument('--basedn', nargs='?', const='', help="The default database suffix.")
+    dsrc_modify_parser.add_argument('--binddn', nargs='?', const='', help="The default Bind DN used or authentication.")
+    dsrc_modify_parser.add_argument('--saslmech', nargs='?', const='', help="The SASL mechanism to use: PLAIN or EXTERNAL.")
+    dsrc_modify_parser.add_argument('--tls-cacertdir', nargs='?', const='', help="The directory containing the Trusted Certificate Authority certificate.")
+    dsrc_modify_parser.add_argument('--tls-cert', nargs='?', const='', help="The absolute file name to the server certificate.")
+    dsrc_modify_parser.add_argument('--tls-key', nargs='?', const='', help="The absolute file name to the server certificate key.")
+    dsrc_modify_parser.add_argument('--tls-reqcert', nargs='?', const='', help="Request certificate strength: 'never', 'allow', 'hard'")
+    dsrc_modify_parser.add_argument('--starttls', action='store_true', help="Use startTLS for connection to the server.")
+    dsrc_modify_parser.add_argument('--cancel-starttls', action='store_true', help="Do not use startTLS for connection to the server.")
+    dsrc_modify_parser.add_argument('--pwdfile', nargs='?', const='', help="The absolute path to a file containing the Bind DN's password.")
+    dsrc_modify_parser.add_argument('--do-it', action='store_true', help="Update the file without any confirmation.")
+
+    # Delete the instance from the .dsrc file
+    dsrc_delete_parser = subcommands.add_parser('delete', help='Delete instance configuration from the .dsrc file.')
+    dsrc_delete_parser.set_defaults(func=delete_dsrc)
+    dsrc_delete_parser.add_argument('--do-it', action='store_true',
+                                    help="Delete this instance's configuration from the .dsrc file.")
+
+    # Display .dsrc file
+    dsrc_display_parser = subcommands.add_parser('display', help='Display the contents of the .dsrc file.')
+    dsrc_display_parser.set_defaults(func=display_dsrc)
-- 
2.26.2