/usr/lib/python3/dist-packages/lib389/utils.py is in python3-lib389 1.3.7.10-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 | # --- BEGIN COPYRIGHT BLOCK ---
# Copyright (C) 2015 Red Hat, Inc.
# All rights reserved.
#
# License: GPL (version 3 or any later version).
# See LICENSE for details.
# --- END COPYRIGHT BLOCK ---
"""Utilities for DirSrv.
TODO put them in a module!
"""
try:
from subprocess import Popen as my_popen, PIPE
except ImportError:
from popen2 import popen2
def my_popen(cmd_l, stdout=None):
class MockPopenResult(object):
def wait(self):
pass
p = MockPopenResult()
p.stdout, p.stdin = popen2(cmd_l)
return p
import re
import os
import logging
import shutil
import ldap
import socket
import time
import sys
import filecmp
from socket import getfqdn
from ldapurl import LDAPUrl
from contextlib import closing
import lib389
from lib389.paths import Paths
from lib389._constants import (
DEFAULT_USER, VALGRIND_WRAPPER, DN_CONFIG, CFGSUFFIX, LOCALHOST,
ReplicaRole, CONSUMER_REPLICAID
)
from lib389.properties import (
SER_HOST, SER_USER_ID, SER_GROUP_ID, SER_STRICT_HOSTNAME_CHECKING, SER_PORT,
SER_ROOT_DN, SER_ROOT_PW, SER_SERVERID_PROP, SER_CREATION_SUFFIX,
SER_INST_SCRIPTS_ENABLED, SER_SECURE_PORT, REPLICA_ID
)
MAJOR, MINOR, _, _, _ = sys.version_info
logging.basicConfig(level=logging.DEBUG)
log = logging.getLogger(__name__)
#
# Decorator
#
def static_var(varname, value):
def decorate(func):
setattr(func, varname, value)
return func
return decorate
#
# Various searches to be used in getEntry
# eg getEntry(*searches['NAMINGCONTEXTS'])
#
searches = {
'NAMINGCONTEXTS': ('', ldap.SCOPE_BASE, '(objectclass=*)',
['namingcontexts']),
'ZOMBIE': ('', ldap.SCOPE_SUBTREE,
'(&(objectclass=glue)(objectclass=extensibleobject))', ['dn'])
}
#
# Utilities
#
def is_a_dn(dn, allow_anon=True):
"""Returns True if the given string is a DN, False otherwise."""
try:
if dn == "" and allow_anon is True:
# The empty string is anonymous.
return True
if len(ldap.dn.str2dn(dn)) > 0:
# We have valid components in the dn.
return True
except ldap.DECODING_ERROR:
# An invalid dn was given.
pass
except TypeError:
# An invalid type was passed to be checked
pass
return False
def normalizeDN(dn, usespace=False):
# not great, but will do until we use a newer version of python-ldap
# that has DN utilities
ary = ldap.explode_dn(dn.lower())
joinstr = ","
if usespace:
joinstr = ", "
return joinstr.join(ary)
def escapeDNValue(dn):
'''convert special characters in a DN into LDAPv3 escapes.
e.g.
"dc=example,dc=com" -> \"dc\=example\,\ dc\=com\"'''
for cc in (' ', '"', '+', ',', ';', '<', '>', '='):
dn = dn.replace(cc, '\\' + cc)
return dn
def escapeDNFiltValue(dn):
'''convert special characters in a DN into LDAPv3 escapes
for use in search filters'''
for cc in (' ', '"', '+', ',', ';', '<', '>', '='):
dn = dn.replace(cc, '\\%x' % ord(cc))
return dn
def suffixfilt(suffix):
"""Return a filter matching any possible suffix form.
eg. normalized, escaped, spaced...
"""
nsuffix = normalizeDN(suffix)
spacesuffix = normalizeDN(nsuffix, True)
escapesuffix = escapeDNFiltValue(nsuffix)
filt = ('(|(cn=%s)(cn=%s)(cn=%s)(cn="%s")(cn="%s")(cn=%s)(cn="%s"))' %
(escapesuffix, nsuffix, spacesuffix, nsuffix, spacesuffix, suffix,
suffix))
return filt
#
# path tools
#
def get_sbin_dir(sroot=None, prefix=None):
"""Return the sbin directory (default /usr/sbin)."""
if sroot:
return "%s/bin/slapd/admin/bin" % sroot
elif prefix and prefix != '/':
return "%s/sbin" % prefix
return "/usr/sbin"
def get_bin_dir(sroot=None, prefix=None):
"""Return the sbin directory (default /usr/bin)."""
if sroot:
return "%s/bin/slapd/admin/bin" % sroot
elif prefix and prefix != '/':
return "%s/bin" % prefix
return "/usr/bin"
def get_data_dir(prefix=None):
"""Return the shared data directory (default /usr/share/dirsrv/data)."""
if prefix and prefix != '/':
return "%s/share/dirsrv/data" % prefix
return "/usr/share/dirsrv/data"
def get_plugin_dir(prefix=None):
"""
Return the plugin directory (default /usr/lib64/dirsrv/plugins).
This should be 64/32bit aware.
"""
if prefix and prefix != '/':
# With prefix installations, even 64 bit, it can be under /usr/lib/
if os.path.exists("%s/usr/lib/dirsrv/plugins" % prefix):
return "%s/usr/lib/dirsrv/plugins" % prefix
else:
if os.path.exists("%s/usr/lib64/dirsrv/plugins" % prefix):
return "%s/usr/lib64/dirsrv/plugins" % prefix
# Need to check for 32/64 bit installations
if not os.path.exists("/usr/lib64/dirsrv/plugins"):
if os.path.exists("/usr/lib/dirsrv/plugins"):
return "/usr/lib/dirsrv/plugins"
return "/usr/lib64/dirsrv/plugins"
#
# valgrind functions
#
def valgrind_enable(sbin_dir, wrapper=None):
'''
Copy the valgrind ns-slapd wrapper into the /sbin directory
(making a backup of the original ns-slapd binary).
The script calling valgrind_enable() must be run as the 'root' user
as selinux needs to be disabled for valgrind to work
The server instance(s) should be stopped prior to calling this function.
Then after calling valgrind_enable():
- Start the server instance(s) with a timeout of 60 (valgrind takes a
while to startup)
- Run the tests
- Stop the server
- Get the results file
- Run valgrind_check_file(result_file, "pattern", "pattern", ...)
- Run valgrind_disable()
:param sbin_dir: the location of the ns-slapd binary (e.g. /usr/sbin)
:param wrapper: The valgrind wrapper script for ns-slapd (if not set,
a default wrapper is used)
:raise IOError: If there is a problem setting up the valgrind scripts
:raise EnvironmentError: If script is not run as 'root'
'''
if os.geteuid() != 0:
log.error('This script must be run as root to use valgrind')
raise EnvironmentError
if not wrapper:
# use the default ns-slapd wrapper
wrapper = '%s/%s' % (os.path.dirname(os.path.abspath(__file__)),
VALGRIND_WRAPPER)
nsslapd_orig = '%s/ns-slapd' % sbin_dir
nsslapd_backup = '%s/ns-slapd.original' % sbin_dir
if os.path.isfile(nsslapd_backup):
# There is a backup which means we never cleaned up from a previous
# run(failed test?)
if not filecmp.cmp(nsslapd_backup, nsslapd_orig):
# Files are different sizes, we assume valgrind is already setup
log.info('Valgrind is already enabled.')
return
# Check both nsslapd's exist
if not os.path.isfile(wrapper):
raise IOError('The valgrind wrapper (%s) does not exist. file=%s' %
(wrapper, __file__))
if not os.path.isfile(nsslapd_orig):
raise IOError('The binary (%s) does not exist or is not accessible.' %
nsslapd_orig)
# Make a backup of the original ns-slapd and copy the wrapper into place
try:
shutil.copy2(nsslapd_orig, nsslapd_backup)
except IOError as e:
log.fatal('valgrind_enable(): failed to backup ns-slapd, error: %s' %
e.strerror)
raise IOError('failed to backup ns-slapd, error: %s' % e.strerror)
# Copy the valgrind wrapper into place
try:
shutil.copy2(wrapper, nsslapd_orig)
except IOError as e:
log.fatal('valgrind_enable(): failed to copy valgrind wrapper '
'to ns-slapd, error: %s' % e.strerror)
raise IOError('failed to copy valgrind wrapper to ns-slapd, error: %s' %
e.strerror)
# Disable selinux
os.system('setenforce 0')
log.info('Valgrind is now enabled.')
def valgrind_disable(sbin_dir):
'''
Restore the ns-slapd binary to its original state - the server instances
are expected to be stopped.
Note - selinux is enabled at the end of this process.
:param sbin_dir - the location of the ns-slapd binary (e.g. /usr/sbin)
:raise ValueError
:raise EnvironmentError: If script is not run as 'root'
'''
if os.geteuid() != 0:
log.error('This script must be run as root to use valgrind')
raise EnvironmentError
nsslapd_orig = '%s/ns-slapd' % sbin_dir
nsslapd_backup = '%s/ns-slapd.original' % sbin_dir
# Restore the original ns-slapd
try:
shutil.copyfile(nsslapd_backup, nsslapd_orig)
except IOError as e:
log.fatal('valgrind_disable: failed to restore ns-slapd, error: %s' %
e.strerror)
raise ValueError('failed to restore ns-slapd, error: %s' % e.strerror)
# Delete the backup now
try:
os.remove(nsslapd_backup)
except OSError as e:
log.fatal('valgrind_disable: failed to delete backup ns-slapd, error:'
' %s' % e.strerror)
raise ValueError('Failed to delete backup ns-slapd, error: %s' %
e.strerror)
# Enable selinux
os.system('setenforce 1')
log.info('Valgrind is now disabled.')
def valgrind_get_results_file(dirsrv_inst):
"""
Return the valgrind results file for the dirsrv instance.
"""
"""
The "ps -ef | grep valgrind" looks like:
nobody 26239 1 10 14:33 ? 00:00:06 valgrind -q --tool=memcheck
--leak-check=yes --leak-resolution=high --num-callers=50
--log-file=/var/tmp/slapd.vg.26179 /usr/sbin/ns-slapd.original
-D /etc/dirsrv/slapd-localhost -i /var/run/dirsrv/slapd-localhost.pid
-w /var/run/dirsrv/slapd-localhost.startpid
We need to extract the "--log-file" value
"""
cmd = ("ps -ef | grep valgrind | grep 'slapd-" + dirsrv_inst.serverid +
" ' | awk '{ print $14 }' | sed -e 's/\-\-log\-file=//'")
# Run the command and grab the output
p = os.popen(cmd)
results_file = p.readline()
p.close()
return results_file
def valgrind_check_file(results_file, *patterns):
'''
Check the valgrind results file for the all the patterns
@param result_file - valgrind results file (must be read after server is
stopped)
@param patterns - A plain text or regex pattern string args that should
be searched for
@return True/False - Return true if one if the patterns match a stack
trace
@raise IOError
'''
# Verify results file
if not results_file:
assert False
# Check the result file fo the leak text
results_file = results_file.replace('\n', '')
found = False
pattern_count = len(patterns)
matched_count = 0
vlog = open(results_file)
for line in vlog:
for match_txt in patterns:
if re.search(match_txt, line):
matched_count += 1
break
if len(line.split()) == 1:
# Check if this stack stack matched all the patterns
if pattern_count == matched_count:
found = True
print('valgrind: match found in results file: %s' %
(results_file))
break
else:
matched_count = 0
vlog.close()
return found
#
# functions using sockets
#
def isLocalHost(host_name):
"""True if host_name points to a local ip.
Uses gethostbyname()
"""
# first see if this is a "well known" local hostname
if host_name == 'localhost' or \
host_name == 'localhost.localdomain' or \
host_name == socket.gethostname():
return True
# first lookup ip addr
try:
ip_addr = socket.gethostbyname(host_name)
if ip_addr.startswith("127."):
# log.debug("this ip is on loopback, retain only the first octet")
ip_addr = '127.'
except socket.gaierror:
log.debug("no ip address for %r" % host_name)
return False
# next, see if this IP addr is one of our
# local addresses
p = my_popen(['/sbin/ip', 'addr'], stdout=PIPE)
child_stdout = p.stdout.read()
found = ('inet %s' % ip_addr).encode() in child_stdout
p.wait()
return found
def getdomainname(name=''):
fqdn = getfqdn(name)
index = fqdn.find('.')
if index >= 0:
return fqdn[index + 1:]
else:
# This isn't correct. There is no domain name, so return empty.str
# return fqdn
return ""
def getdefaultsuffix(name=''):
dm = getdomainname(name)
if dm:
return "dc=" + dm.replace('.', ',dc=')
else:
return 'dc=localdomain'
def get_server_user(args):
"""Return the unix username used from the server inspecting the following
keys in args.
'newuserid', 'admconf', 'sroot' -> ssusers.conf
"""
if 'newuserid' not in args:
if 'admconf' in args:
args['newuserid'] = args['admconf'].SuiteSpotUserID
elif 'sroot' in args:
ssusers = open("%s/shared/config/ssusers.conf" % args['sroot'])
for line in ssusers:
ary = line.split()
if len(ary) > 1 and ary[0] == 'SuiteSpotUser':
args['newuserid'] = ary[-1]
ssusers.close()
if 'newuserid' not in args:
args['newuserid'] = os.environ['LOGNAME']
if args['newuserid'] == 'root':
args['newuserid'] = DEFAULT_USER
def update_newhost_with_fqdn(args):
"""Replace args[SER_HOST] with its fqdn and returns True if local.
One of the arguments to createInstance is newhost. If this is specified,
we need to convert it to the fqdn. If not given, we need to figure out
what the fqdn of the local host is. This method sets newhost in args to
the appropriate value and returns True if newhost is the localhost, False
otherwise"""
if SER_HOST in args:
args[SER_HOST] = getfqdn(args[SER_HOST])
isLocal = isLocalHost(args[SER_HOST])
else:
isLocal = True
args[SER_HOST] = getfqdn()
return isLocal
def getcfgdsuserdn(cfgdn, args):
"""Return a DirSrv object bound anonymously or to the admin user.
If the config ds user ID was given, not the full DN, we need to figure
out the full DN.
Try in order to:
1- search the directory anonymously;
2- look in ldap.conf;
3- try the default DN.
This may raise a file or LDAP exception.
"""
# create a connection to the cfg ds
conn = lib389.DirSrv(args['cfgdshost'], args['cfgdsport'], "", "", None)
# if the caller gave a password, but not the cfguser DN, look it up
if 'cfgdspwd' in args and \
('cfgdsuser' not in args or not is_a_dn(args['cfgdsuser'])):
if 'cfgdsuser' in args:
ent = conn.getEntry(cfgdn, ldap.SCOPE_SUBTREE,
"(uid=%s)" % args['cfgdsuser'],
['dn'])
args['cfgdsuser'] = ent.dn
elif 'sroot' in args:
ldapconf = open(
"%s/shared/config/ldap.conf" % args['sroot'], 'r')
for line in ldapconf:
ary = line.split() # default split is all whitespace
if len(ary) > 1 and ary[0] == 'admnm':
args['cfgdsuser'] = ary[-1]
ldapconf.close()
elif 'admconf' in args:
args['cfgdsuser'] = args['admconf'].userdn
elif 'cfgdsuser' in args:
dsuser = ("uid=%s,ou=Administrators,ou=TopologyManagement,%s" %
(args['cfgdsuser'], cfgdn))
args['cfgdsuser'] = dsuser
conn.unbind()
conn = lib389.DirSrv(
args['cfgdshost'], args['cfgdsport'], args['cfgdsuser'],
args['cfgdspwd'], None)
return conn
def update_admin_domain(isLocal, args):
"""Get the admin domain to use."""
if isLocal and 'admin_domain' not in args:
if 'admconf' in args:
args['admin_domain'] = args['admconf'].admindomain
elif 'sroot' in args:
dsconf = open('%s/shared/config/ds.conf' % args['sroot'], 'r')
for line in dsconf:
ary = line.split(":")
if len(ary) > 1 and ary[0] == 'AdminDomain':
args['admin_domain'] = ary[1].strip()
dsconf.close()
def getoldcfgdsinfo(args):
"""Use the old style sroot/shared/config/dbswitch.conf to get the info"""
dbswitch = open("%s/shared/config/dbswitch.conf" % args['sroot'], 'r')
try:
matcher = re.compile(r'^directory\s+default\s+')
for line in dbswitch:
m = matcher.match(line)
if m:
url = LDAPUrl(line[m.end():])
ary = url.hostport.split(":")
if len(ary) < 2:
ary.append(389)
else:
ary[1] = int(ary[1])
ary.append(url.dn)
return ary
finally:
dbswitch.close()
def getnewcfgdsinfo(new_instance_arguments):
"""Use the new style prefix /etc/dirsrv/admin-serv/adm.conf.
new_instance_arguments = {'admconf': obj } where obj.ldapurl != None
"""
try:
url = LDAPUrl(new_instance_arguments['admconf'].ldapurl)
except AttributeError:
log.error("missing ldapurl attribute in new_instance_arguments: %r" %
new_instance_arguments)
raise
ary = url.hostport.split(":")
if len(ary) < 2:
ary.append(389)
else:
ary[1] = int(ary[1])
ary.append(url.dn)
return ary
def getcfgdsinfo(new_instance_arguments):
"""Returns a 3-tuple consisting of the host, port, and cfg suffix.
`new_instance_arguments` = {
'cfgdshost':
'cfgdsport':
'new_style':
}
We need the host and port of the configuration directory server in order
to create an instance. If this was not given, read the dbswitch.conf file
to get the information. This method will raise an exception if the file
was not found or could not be open. This assumes new_instance_arguments
contains the sroot parameter for the server root path.
"""
try:
return (new_instance_arguments['cfgdshost'],
int(new_instance_arguments['cfgdsport']),
CFGSUFFIX)
except KeyError: # if keys are missing...
if new_instance_arguments['new_style']:
return getnewcfgdsinfo(new_instance_arguments)
return getoldcfgdsinfo(new_instance_arguments)
def getserverroot(cfgconn, isLocal, args):
"""Grab the serverroot from the instance dir of the config ds if the user
did not specify a server root directory"""
if cfgconn and 'sroot' not in args and isLocal:
ent = cfgconn.getEntry(
DN_CONFIG, ldap.SCOPE_BASE, "(objectclass=*)",
['nsslapd-instancedir'])
if ent:
args['sroot'] = os.path.dirname(
ent.getValue('nsslapd-instancedir'))
def getadminport(cfgconn, cfgdn, args):
"""Return a 2-tuple (asport, True) if the admin server is using SSL,
False otherwise.
Get the admin server port so we can contact it via http. We get this from
the configuration entry using the CFGSUFFIX and cfgconn. Also get any
other information we may need from that entry.
"""
asport = 0
secure = False
if cfgconn:
dn = cfgdn
if 'admin_domain' in args:
dn = "cn=%s,ou=%s, %s" % (
args[SER_HOST], args['admin_domain'], cfgdn)
filt = "(&(objectclass=nsAdminServer)(serverHostName=%s)" % args[
SER_HOST]
if 'sroot' in args:
filt += "(serverRoot=%s)" % args['sroot']
filt += ")"
ent = cfgconn.getEntry(
dn, ldap.SCOPE_SUBTREE, filt, ['serverRoot'])
if ent:
if 'sroot' not in args and ent.serverRoot:
args['sroot'] = ent.serverRoot
if 'admin_domain' not in args:
ary = ldap.explode_dn(ent.dn, 1)
args['admin_domain'] = ary[-2]
dn = "cn=configuration, " + ent.dn
ent = cfgconn.getEntry(dn, ldap.SCOPE_BASE, '(objectclass=*)',
['nsServerPort',
'nsSuiteSpotUser',
'nsServerSecurity'])
if ent:
asport = ent.nsServerPort
secure = (ent.nsServerSecurity and (
ent.nsServerSecurity == 'on'))
if 'newuserid' not in args:
args['newuserid'] = ent.nsSuiteSpotUser
cfgconn.unbind()
return asport, secure
def formatInfData(args):
"""Return the .inf data for a silence setup via setup-ds.pl.
args = {
# new instance values
newhost, newuserid, newport, SER_ROOT_DN, newrootpw, newsuffix,
# The following parameters require to register the new instance
# in the admin server
have_admin, cfgdshost, cfgdsport, cfgdsuser,cfgdspwd, admin_domain
InstallLdifFile, AddOrgEntries, ConfigFile, SchemaFile,
ldapifilepath
# Setup the o=NetscapeRoot namingContext
setup_admin,
}
@see https://access.redhat.com/site/documentation/en-US/
Red_Hat_Directory_Server/8.2/html/Installation_Guide/
Installation_Guide-Advanced_Configuration-Silent.html
[General]
FullMachineName= dir.example.com
SuiteSpotUserID= nobody
SuiteSpotGroup= nobody
AdminDomain= example.com
ConfigDirectoryAdminID= admin
ConfigDirectoryAdminPwd= admin
ConfigDirectoryLdapURL= ldap://dir.example.com:389/o=NetscapeRoot
[slapd]
SlapdConfigForMC= Yes
UseExistingMC= 0
ServerPort= 389
ServerIdentifier= dir
Suffix= dc=example,dc=com
RootDN= cn=Directory Manager
RootDNPwd= password
ds_bename=exampleDB
AddSampleEntries= No
[admin]
Port= 9830
ServerIpAddress= 111.11.11.11
ServerAdminID= admin
ServerAdminPwd= admin
"""
args = args.copy()
args['CFGSUFFIX'] = CFGSUFFIX
content = ("[General]" "\n")
content += ("FullMachineName= %s\n" % args[SER_HOST])
content += ("SuiteSpotUserID= %s\n" % args[SER_USER_ID])
content += ("nSuiteSpotGroup= %s\n" % args[SER_GROUP_ID])
content += ("StrictHostCheck= %s\n" % args[SER_STRICT_HOSTNAME_CHECKING])
if args.get('have_admin'):
content += ("AdminDomain= %(admin_domain)s" "\n"
"ConfigDirectoryLdapURL= ldap://%(cfgdshost)s:%"
"(cfgdsport)d/%(CFGSUFFIX)s" "\n"
"ConfigDirectoryAdminID= %(cfgdsuser)s" "\n"
"ConfigDirectoryAdminPwd= %(cfgdspwd)s" "\n") % args
content += ("\n" "\n" "[slapd]" "\n")
content += ("ServerPort= %s\n" % args[SER_PORT])
content += ("RootDN= %s\n" % args[SER_ROOT_DN])
content += ("RootDNPwd= %s\n" % args[SER_ROOT_PW])
content += ("ServerIdentifier= %s\n" % args[SER_SERVERID_PROP])
content += ("Suffix= %s\n" % args[SER_CREATION_SUFFIX])
# Create admin?
if args.get('setup_admin'):
content += ("SlapdConfigForMC= Yes" "\n"
"UseExistingMC= 0 " "\n")
if 'InstallLdifFile' in args:
content += """\nInstallLdifFile= %s\n""" % args['InstallLdifFile']
if 'AddOrgEntries' in args:
content += """\nAddOrgEntries= %s\n""" % args['AddOrgEntries']
if 'ConfigFile' in args:
for ff in args['ConfigFile']:
content += """\nConfigFile= %s\n""" % ff
if 'SchemaFile' in args:
for ff in args['SchemaFile']:
content += """\nSchemaFile= %s\n""" % ff
if 'ldapifilepath' in args:
content += "\nldapifilepath=%s\n" % args['ldapifilepath']
if SER_INST_SCRIPTS_ENABLED in args:
content += "\n{}={}\n".format(SER_INST_SCRIPTS_ENABLED, args[SER_INST_SCRIPTS_ENABLED])
return content
def generate_ds_params(inst_num, role=ReplicaRole.STANDALONE):
"""Generate a host, port, secure port, server ID and replica ID
for the selected role and instance number. I.e. inst_num=1, role="master".
@param inst_num - an instance number in a range from 1 to 99
@param role - ReplicaRole.STANDALONE, ReplicaRole.MASTER, ReplicaRole.HUB, ReplicaRole.CONSUMER
@return - the dict with next keys: host, port, secure port, server id and replica id
"""
if inst_num not in range(1, 100):
raise ValueError("Instance number should be in a range from 1 to 99")
if role not in (ReplicaRole.STANDALONE, ReplicaRole.MASTER, ReplicaRole.HUB, ReplicaRole.CONSUMER):
raise ValueError('Role should be {}, {}, {}, {}'.format(ReplicaRole.STANDALONE, ReplicaRole.MASTER,
ReplicaRole.HUB, ReplicaRole.CONSUMER))
instance_data = {}
relevant_num = 38900
# Set relevant number for ports
if role == ReplicaRole.MASTER:
relevant_num += 100
elif role == ReplicaRole.HUB:
relevant_num += 200
elif role == ReplicaRole.CONSUMER:
relevant_num += 300
# Define replica ID
if role == ReplicaRole.MASTER:
replica_id = inst_num
else:
replica_id = CONSUMER_REPLICAID
# Fill the dict with data
server_id = "{}{}".format(role.name.lower(), inst_num)
instance_data[SER_HOST] = LOCALHOST
instance_data[SER_PORT] = relevant_num + inst_num
instance_data[SER_SECURE_PORT] = relevant_num + inst_num + 24700
instance_data[SER_SERVERID_PROP] = server_id
instance_data[REPLICA_ID] = replica_id
return instance_data
def get_ds_version():
"""
Return version of ns-slapd installed on this system. This is determined by the defaults.inf
file, so is correct for the built and installed ns-slapd binary. This function works without
root permissions.
returns a string of the form: 1.3.4.8
"""
p = Paths()
return p.version
def ds_is_older(ver):
"""Return True if current version of ns-slapd is older than provided
version"""
return get_ds_version() < ver
def ds_is_newer(ver):
return get_ds_version() >= ver
def getDateTime():
"""
Return the date and time:
2016-04-21 21:21:00
"""
return time.strftime("%Y-%m-%d %H:%M:%S")
def socket_check_open(host, port):
with closing(socket.socket(socket.AF_INET6, socket.SOCK_STREAM)) as sock:
if sock.connect_ex((host, port)) == 0:
return True
else:
return False
def ensure_bytes(val):
if val != None and type(val) != bytes:
return val.encode()
return val
def ensure_str(val):
if val != None and type(val) != str:
return val.decode('utf-8')
return val
def ensure_int(val):
if val is not None and not isinstance(val, int):
return int(val)
return val
def ensure_list_bytes(val):
return [ensure_bytes(v) for v in val]
def ensure_list_str(val):
return [ensure_str(v) for v in val]
def ensure_list_int(val):
return [ensure_int(v) for v in val]
def ensure_dict_str(val):
if MAJOR <= 2:
return val
retdict = {}
for k in val:
if isinstance(val[k], list):
retdict[k] = ensure_list_str(val[k])
else:
retdict[k] = ensure_str(val[k])
return retdict
|