/usr/lib/python3/dist-packages/lib389/tools.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 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 | # --- 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 ---
"""Tools for creating and managing servers
uses DirSrv
"""
import sys
import os
import os.path
import base64
import select
import time
import shutil
import subprocess
import tarfile
import re
import glob
import pwd
import grp
import logging
import ldap
import shlex
import socket
import getpass
# from .nss_ssl import nss_create_new_database
from threading import Timer
from lib389.paths import Paths
from lib389._constants import *
from lib389._ldifconn import LDIFConn
from lib389.properties import *
from lib389.utils import (
is_a_dn,
getcfgdsuserdn,
getcfgdsinfo,
getcfgdsuserdn,
update_newhost_with_fqdn,
get_sbin_dir,
get_server_user,
getdomainname,
isLocalHost,
formatInfData,
getserverroot,
update_admin_domain,
getadminport,
getdefaultsuffix,
ensure_bytes,
ensure_str,
socket_check_open,)
from lib389.passwd import password_hash, password_generate
# The poc backend api
from lib389.backend import Backends
try:
# There are too many issues with this on EL7
# Out of the box, it's just outright broken ...
import six.moves.urllib.request
import six.moves.urllib.parse
import six.moves.urllib.error
import six
except ImportError:
pass
MAJOR, MINOR, _, _, _ = sys.version_info
if MAJOR >= 3:
import configparser
else:
import ConfigParser as configparser
__all__ = ['DirSrvTools']
try:
from subprocess import Popen, PIPE, STDOUT
HASPOPEN = True
except ImportError:
import popen2
HASPOPEN = False
_ds_paths = Paths()
logging.basicConfig(level=logging.DEBUG)
log = logging.getLogger(__name__)
# Private constants
PATH_SETUP_DS_ADMIN = CMD_PATH_SETUP_DS_ADMIN
PATH_SETUP_DS = CMD_PATH_SETUP_DS
PATH_REMOVE_DS = CMD_PATH_REMOVE_DS
PATH_ADM_CONF = "/etc/dirsrv/admin-serv/adm.conf"
GROUPADD = "/usr/sbin/groupadd"
USERADD = "/usr/sbin/useradd"
NOLOGIN = "/sbin/nologin"
def kill_proc(proc, timeout):
"""Kill a process after the timeout is reached
@param proc - The subprocess process
@param timeout - timeout in seconds
"""
timeout["value"] = True
proc.kill()
def runCmd(cmd, timeout_sec):
"""Run a system command with a timeout
@param cmd - The full system command
@param timeout_sec - The timeoput value in seconds
@return - The result code
"""
proc = subprocess.Popen(shlex.split(cmd), stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
timeout = {"value": False}
timer = Timer(timeout_sec, kill_proc, [proc, timeout])
timer.start()
stdout, stderr = proc.communicate()
timer.cancel()
return proc.returncode
class DirSrvTools(object):
"""DirSrv mix-in."""
@staticmethod
def cgiFake(sroot, verbose, prog, args):
"""Run the local program prog as a CGI using the POST method."""
content = urllib.parse.urlencode(args)
length = len(content)
# setup CGI environment
env = os.environ.copy()
env['REQUEST_METHOD'] = "POST"
env['NETSITE_ROOT'] = sroot
env['CONTENT_LENGTH'] = str(length)
progdir = os.path.dirname(prog)
if HASPOPEN:
pipe = Popen(prog, cwd=progdir, env=env,
stdin=PIPE, stdout=PIPE, stderr=STDOUT)
child_stdin = pipe.stdin
child_stdout = pipe.stdout
else:
saveenv = os.environ
os.environ = env
child_stdout, child_stdin = popen2.popen2(prog)
os.environ = saveenv
child_stdin.write(content)
child_stdin.close()
for line in child_stdout:
if verbose:
sys.stdout.write(line)
ary = line.split(":")
if len(ary) > 1 and ary[0] == 'NMC_Status':
exitCode = ary[1].strip()
break
child_stdout.close()
if HASPOPEN:
osCode = pipe.wait()
print("%s returned NMC code %s and OS code %s" %
(prog, exitCode, osCode))
return exitCode
@staticmethod
def cgiPost(host, port, username, password, uri, verbose, secure,
args=None):
"""Post the request to the admin server.
Admin server requires authentication, so we use the auth handler
classes.
NOTE: the url classes in python use the deprecated
base64.encodestring() function, which truncates lines,
causing Apache to give us a 400 Bad Request error for the
Authentication string. So, we have to tell
base64.encodestring() not to truncate."""
args = args or {}
prefix = 'http'
if secure:
prefix = 'https'
hostport = host + ":" + port
# construct our url
url = '%s://%s:%s%s' % (prefix, host, port, uri)
# tell base64 not to truncate lines
savedbinsize = base64.MAXBINSIZE
base64.MAXBINSIZE = 256
# create the password manager - we don't care about the realm
passman = urllib.request.HTTPPasswordMgrWithDefaultRealm()
# add our password
passman.add_password(None, hostport, username, password)
# create the auth handler
authhandler = urllib.request.HTTPBasicAuthHandler(passman)
# create our url opener that handles basic auth
opener = urllib.request.build_opener(authhandler)
# make admin server think we are the console
opener.addheaders = [('User-Agent', 'Fedora-Console/1.0')]
if verbose:
print("requesting url", url)
sys.stdout.flush()
exitCode = 1
try:
req = opener.open(url, urllib.parse.urlencode(args))
for line in req:
if verbose:
print (line)
ary = line.split(":")
if len(ary) > 1 and ary[0] == 'NMC_Status':
exitCode = ary[1].strip()
break
req.close()
# except IOError, e:
# print e
# print e.code
# print e.headers
# raise
finally:
# restore binsize
base64.MAXBINSIZE = savedbinsize
return exitCode
@staticmethod
def _infoInstanceBackupFS(dirsrv):
"""
Return the information to retrieve the backup file of a given
instance
It returns:
- Directory name containing the backup
(e.g. /tmp/slapd-standalone.bck)
- The pattern of the backup files
(e.g. /tmp/slapd-standalone.bck/backup*.tar.gz)
"""
backup_dir = "%s/slapd-%s.bck" % (dirsrv.backupdir, dirsrv.inst)
backup_pattern = os.path.join(backup_dir, "backup*.tar.gz")
return backup_dir, backup_pattern
@staticmethod
def clearInstanceBackupFS(dirsrv=None, backup_file=None):
"""
Remove a backup_file or all backup up of a given instance
"""
if backup_file:
if os.path.isfile(backup_file):
try:
os.remove(backup_file)
except:
log.info("clearInstanceBackupFS: fail to remove %s" %
backup_file)
pass
elif dirsrv:
backup_dir, backup_pattern = \
DirSrvTools._infoInstanceBackupFS(dirsrv)
list_backup_files = glob.glob(backup_pattern)
for f in list_backup_files:
try:
os.remove(f)
except:
log.info("clearInstanceBackupFS: fail to remove %s" %
backup_file)
pass
@staticmethod
def checkInstanceBackupFS(dirsrv):
"""
If it exits a backup file, it returns it
else it returns None
"""
backup_dir, backup_pattern = DirSrvTools._infoInstanceBackupFS(dirsrv)
list_backup_files = glob.glob(backup_pattern)
if not list_backup_files:
return None
else:
# returns the first found backup
return list_backup_files[0]
@staticmethod
def instanceBackupFS(dirsrv):
"""
Saves the files of an instance under
/tmp/slapd-<instance_name>.bck/backup_HHMMSS.tar.gz
and return the archive file name.
If it already exists a such file, it assums it is a valid backup
and returns its name
dirsrv.sroot: root of the instance (e.g. /usr/lib64/dirsrv)
dirsrv.inst: instance name (e.g. standalone for
/etc/dirsrv/slapd-standalone)
dirsrv.confdir: root of the instance config (e.g. /etc/dirsrv)
dirsrv.dbdir: directory where is stored the database
(e.g. /var/lib/dirsrv/slapd-standalone/db)
dirsrv.changelogdir: directory where is stored the changelog
(e.g. /var/lib/dirsrv/slapd-master/changelogdb)
"""
# First check it if already exists a backup file
backup_dir, backup_pattern = DirSrvTools._infoInstanceBackupFS(dirsrv)
backup_file = DirSrvTools.checkInstanceBackupFS(dirsrv)
if backup_file is None:
if not os.path.exists(backup_dir):
os.makedirs(backup_dir)
else:
return backup_file
# goes under the directory where the DS is deployed
listFilesToBackup = []
here = os.getcwd()
os.chdir(dirsrv.prefix)
prefix_pattern = "%s/" % dirsrv.prefix
# build the list of directories to scan
instroot = "%s/slapd-%s" % (dirsrv.sroot, dirsrv.inst)
ldir = [instroot]
if hasattr(dirsrv, 'confdir'):
ldir.append(dirsrv.confdir)
if hasattr(dirsrv, 'dbdir'):
ldir.append(dirsrv.dbdir)
if hasattr(dirsrv, 'changelogdir'):
ldir.append(dirsrv.changelogdir)
if hasattr(dirsrv, 'errlog'):
ldir.append(os.path.dirname(dirsrv.errlog))
if hasattr(dirsrv, 'accesslog') and \
os.path.dirname(dirsrv.accesslog) not in ldir:
ldir.append(os.path.dirname(dirsrv.accesslog))
# now scan the directory list to find the files to backup
for dirToBackup in ldir:
for root, dirs, files in os.walk(dirToBackup):
for file in files:
name = os.path.join(root, file)
name = re.sub(prefix_pattern, '', name)
if os.path.isfile(name):
listFilesToBackup.append(name)
log.debug("instanceBackupFS add = %s (%s)" %
(name, dirsrv.prefix))
# create the archive
name = "backup_%s.tar.gz" % (time.strftime("%m%d%Y_%H%M%S"))
backup_file = os.path.join(backup_dir, name)
tar = tarfile.open(backup_file, "w:gz")
for name in listFilesToBackup:
if os.path.isfile(name):
tar.add(name)
tar.close()
log.info("instanceBackupFS: archive done : %s" % backup_file)
# return to the directory where we were
os.chdir(here)
return backup_file
@staticmethod
def instanceRestoreFS(dirsrv, backup_file):
"""
"""
# First check the archive exists
if backup_file is None:
log.warning("Unable to restore the instance (missing backup)")
return 1
if not os.path.isfile(backup_file):
log.warning("Unable to restore the instance (%s is not a file)" %
backup_file)
return 1
#
# Second do some clean up
#
# previous db (it may exists new db files not in the backup)
log.debug("instanceRestoreFS: remove subtree %s/*" % os.path.dirname(dirsrv.dbdir))
for root, dirs, files in os.walk(os.path.dirname(dirsrv.dbdir)):
for d in dirs:
if d not in ("bak", "ldif"):
log.debug(
"instanceRestoreFS: before restore remove directory "
"%s/%s" % (root, d))
shutil.rmtree("%s/%s" % (root, d))
# previous error/access logs
log.debug("instanceRestoreFS: remove error logs %s" % dirsrv.errlog)
for f in glob.glob("%s*" % dirsrv.errlog):
log.debug("instanceRestoreFS: before restore remove file %s" %
(f))
os.remove(f)
log.debug("instanceRestoreFS: remove access logs %s" %
dirsrv.accesslog)
for f in glob.glob("%s*" % dirsrv.accesslog):
log.debug("instanceRestoreFS: before restore remove file %s" %
(f))
os.remove(f)
# Then restore from the directory where DS was deployed
here = os.getcwd()
os.chdir(dirsrv.prefix)
tar = tarfile.open(backup_file)
for member in tar.getmembers():
if os.path.isfile(member.name):
#
# restore only writable files
# It could be a bad idea and preferably restore all.
# Now it will be easy to enhance that function.
if os.access(member.name, os.W_OK):
log.debug("instanceRestoreFS: restored %s" % member.name)
tar.extract(member.name)
else:
log.debug("instanceRestoreFS: not restored %s "
"(no write access)" % member.name)
else:
log.debug("instanceRestoreFS: restored %s" % member.name)
tar.extract(member.name)
tar.close()
#
# Now be safe, triggers a recovery at restart
#
guardian_file = os.path.join(dirsrv.dbdir, "guardian")
if os.path.isfile(guardian_file):
try:
log.debug("instanceRestoreFS: remove %s" % guardian_file)
os.remove(guardian_file)
except:
log.warning("instanceRestoreFS: fail to remove %s" %
guardian_file)
pass
os.chdir(here)
@staticmethod
def setupSSL(dirsrv, secport=636, sourcedir=None, secargs=None):
"""configure and setup SSL with a given certificate and
restart the server.
See DirSrv.configSSL for the secargs values
"""
e = dirsrv.configSSL(secport, secargs)
log.info("entry is %r" % [e])
dn_config = e.dn
# get our cert dir
e_config = dirsrv.getEntry(
dn_config, ldap.SCOPE_BASE, '(objectclass=*)')
certdir = e_config.getValue('nsslapd-certdir')
# have to stop the server before replacing any security files
DirSrvTools.stop(dirsrv)
# allow secport for selinux
if secport != 636:
try:
log.debug("Configuring SELinux on port: %s", str(secport))
subprocess.check_call(["semanage", "port", "-a", "-t",
"ldap_port_t", "-p", "tcp",
str(secport)])
except OSError:
log.debug("Likely SELinux not supported")
pass
except subprocess.CalledProcessError:
log.debug("SELinux fails to configure")
pass
# eventually copy security files from source dir to our cert dir
if sourcedir:
for ff in ['cert8.db', 'key3.db', 'secmod.db', 'pin.txt',
'certmap.conf']:
srcf = os.path.join(sourcedir, ff)
destf = os.path.join(certdir, ff)
# make sure dest is writable so we can copy over it
try:
log.info("Copying security files: %s to %s" %
(srcf, destf))
mode = os.stat(destf).st_mode
newmode = mode | 0o600
os.chmod(destf, newmode)
except Exception as e:
print(e)
pass # oh well
# copy2 will copy the mode too
shutil.copy2(srcf, destf)
# now, restart the ds
DirSrvTools.start(dirsrv, True)
@staticmethod
def runInfProg(prog, content, verbose, prefix=None):
"""run a program that takes an .inf style file on stdin"""
cmd = [prog]
if verbose:
cmd.append('-ddd')
else:
cmd.extend(['-l', '/dev/null'])
cmd.extend(['-s', '-f', '-'])
log.debug("running: %s " % cmd)
if HASPOPEN:
pipe = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=STDOUT)
child_stdin = pipe.stdin
child_stdout = pipe.stdout
else:
pipe = popen2.Popen4(cmd)
child_stdin = pipe.tochild
child_stdout = pipe.fromchild
child_stdin.write(ensure_bytes(content))
child_stdin.close()
if verbose:
log.debug("PID %s" % pipe.pid)
while pipe.poll() is None:
(rr, wr, xr) = select.select([child_stdout], [], [], 1.0)
if rr and len(rr) > 0:
line = rr[0].readline()
if not line:
break
if verbose:
sys.stdout.write(ensure_str(line))
elif verbose:
print("timed out waiting to read from pid %s : %s " % (pipe.pid, cmd))
child_stdout.close()
exitCode = pipe.wait()
# if verbose:
log.debug("%s returned exit code %s" % (prog, exitCode))
return exitCode
@staticmethod
def removeInstance(dirsrv):
"""run the remove instance command"""
if hasattr(dirsrv, 'prefix'):
prefix = dirsrv.prefix
else:
prefix = None
prog = os.path.join(_ds_paths.sbin_dir, PATH_REMOVE_DS)
try:
cmd = [prog, '-i', 'slapd-{}'.format(dirsrv.serverid)]
log.info('Running: {}'.format(" ".join(cmd)))
subprocess.check_call(cmd)
except subprocess.CalledProcessError as e:
log.debug('DS has failed to remove the instance {}, '
'output is: {}'.format(dirsrv.serverid, e.output))
@staticmethod
def _offlineDirsrv(args):
'''
Function to allocate an offline DirSrv instance.
This instance is not initialized with the Directory instance
(__localinit__() and __add_brookers__() are not called)
The properties set are:
instance.host
instance.port
instance.serverid
instance.inst
instance.prefix
instance.backup
'''
instance = lib389.DirSrv(verbose=True)
instance.allocate(args)
return instance
@staticmethod
def existsBackup(args):
'''
If the backup of the instance exists, it returns it.
Else None
'''
instance = DirSrvTools._offlineDirsrv(args)
return DirSrvTools.checkInstanceBackupFS(instance)
@staticmethod
def existsInstance(args):
'''
Check if an instance exists.
It checks if the following directories/files exist:
<confdir>/slapd-<name>
<errlog>
If it exists it returns a DirSrv instance NOT initialized,
else None
'''
instance = DirSrvTools._offlineDirsrv(args)
dirname = _ds_paths.config_dir.format(instance_name=instance.serverid)
errorlog = _ds_paths.error_log.format(instance_name=instance.serverid)
sroot = os.path.join(instance.prefix, "lib/dirsrv")
if os.path.isdir(dirname) and \
os.path.isfile(errorlog) and \
os.path.isdir(sroot):
instance.sroot = sroot
instance.errlog = errorlog
return instance
return None
@staticmethod
def createInstance(args, verbose=0):
"""Create a new instance of directory server and return a connection
to it.
This function:
- guesses the hostname where to create the DS, using
localhost by default;
- figures out if the given hostname is the local host or not.
@param args - a dict with the following values {
# new instance compulsory values
'newinstance': 'rpolli',
'newsuffix': 'dc=example,dc=com',
'newhost': 'localhost.localdomain',
'newport': 22389,
'newrootpw': 'password',
# optionally register instance on an admin tree
'have_admin': True,
# optionally directory where to store instance backup
'backupdir': [ /tmp ]
# you can configure a new dirsrv-admin
'setup_admin': True,
# or you need the dirsrv-admin to be already setup
'cfgdshost': 'localhost.localdomain',
'cfgdsport': 22389,
'cfgdsuser': 'admin',
'cfgdspwd': 'admin',
}
"""
cfgdn = lib389.CFGSUFFIX
isLocal = update_newhost_with_fqdn(args)
# use prefix if binaries are relocated
sroot = args.get('sroot', '')
prefix = args.setdefault('prefix', '')
# get the backup directory to store instance backup
backupdir = args.get('backupdir', '/tmp')
# new style - prefix or FHS?
args['new_style'] = not args.get('sroot')
# do we have ds only or ds+admin?
if 'no_admin' not in args:
ds_admin_path = os.path.join(_ds_paths.sbin_dir, PATH_SETUP_DS_ADMIN)
if os.path.isfile(ds_admin_path):
args['have_admin'] = True
# set default values
args['have_admin'] = args.get('have_admin', False)
args['setup_admin'] = args.get('setup_admin', False)
# get default values from adm.conf
if args['new_style'] and args['have_admin']:
admconf = LDIFConn(
args['prefix'] + PATH_ADM_CONF)
args['admconf'] = admconf.get('')
# next, get the configuration ds host and port
if args['have_admin']:
args['cfgdshost'], args['cfgdsport'], cfgdn = getcfgdsinfo(args)
#
# if a Config DS is passed, get the userdn. This creates
# a connection to the given DS. If you don't want to connect
# to this server you should pass 'setup_admin' too.
#
if args['have_admin'] and not args['setup_admin']:
cfgconn = getcfgdsuserdn(cfgdn, args)
# next, get the server root if not given
if not args['new_style']:
getserverroot(cfgconn, isLocal, args)
# next, get the admin domain
if args['have_admin']:
update_admin_domain(isLocal, args)
# next, get the admin server port and any other information -
# close the cfgconn
if args['have_admin'] and not args['setup_admin']:
asport, secure = getadminport(cfgconn, cfgdn, args)
# next, get the posix username
get_server_user(args)
# fixup and verify other args
args['newport'] = args.get('newport', 389)
args['newrootdn'] = args.get('newrootdn', DN_DM)
args['newsuffix'] = args.get('newsuffix',
getdefaultsuffix(args['newhost']))
if not isLocal or 'cfgdshost' in args:
if 'admin_domain' not in args:
args['admin_domain'] = getdomainname(args['newhost'])
if isLocal and 'cfgdspwd' not in args:
args['cfgdspwd'] = "dummy"
if isLocal and 'cfgdshost' not in args:
args['cfgdshost'] = args['newhost']
if isLocal and 'cfgdsport' not in args:
args['cfgdsport'] = 55555
missing = False
for param in ('newhost', 'newport', 'newrootdn', 'newrootpw',
'newinstance', 'newsuffix'):
if param not in args:
log.error("missing required argument: ", param)
missing = True
if missing:
raise InvalidArgumentError("missing required arguments")
# try to connect with the given parameters
try:
newconn = lib389.DirSrv(args['newhost'], args['newport'],
args['newrootdn'], args['newrootpw'],
args['newinstance'])
newconn.prefix = prefix
newconn.backupdir = backupdir
newconn.isLocal = isLocal
if args['have_admin'] and not args['setup_admin']:
newconn.asport = asport
newconn.cfgdsuser = args['cfgdsuser']
newconn.cfgdspwd = args['cfgdspwd']
host = args['newhost']
port = args['newport']
print("Warning: server at %s:%s " % (host, port) +
"already exists, returning connection to it")
return newconn
except ldap.SERVER_DOWN:
pass # not running - create new one
if not isLocal or 'cfgdshost' in args:
for param in ('cfgdshost', 'cfgdsport', 'cfgdsuser', 'cfgdspwd',
'admin_domain'):
if param not in args:
print("missing required argument", param)
missing = True
if not isLocal and not asport:
print("missing required argument admin server port")
missing = True
if missing:
raise InvalidArgumentError("missing required arguments")
# construct a hash table with our CGI arguments - used with cgiPost
# and cgiFake
cgiargs = {
'servname': args['newhost'],
'servport': args['newport'],
'rootdn': args['newrootdn'],
'rootpw': args['newrootpw'],
'servid': args['newinstance'],
'suffix': args['newsuffix'],
'servuser': args['newuserid'],
'start_server': 1
}
if 'cfgdshost' in args:
cgiargs['cfg_sspt_uid'] = args['cfgdsuser']
cgiargs['cfg_sspt_uid_pw'] = args['cfgdspwd']
cgiargs['ldap_url'] = "ldap://%s:%d/%s" % (
args['cfgdshost'], args['cfgdsport'], cfgdn)
cgiargs['admin_domain'] = args['admin_domain']
if not isLocal:
DirSrvTools.cgiPost(args['newhost'], asport, args['cfgdsuser'],
args['cfgdspwd'],
"/slapd/Tasks/Operation/Create",
verbose, secure, cgiargs)
elif not args['new_style']:
prog = sroot + "/bin/slapd/admin/bin/ds_create"
if not os.access(prog, os.X_OK):
prog = sroot + "/bin/slapd/admin/bin/ds_newinstance"
DirSrvTools.cgiFake(sroot, verbose, prog, cgiargs)
else:
prog = ''
if args['have_admin']:
prog = os.path.join(_ds_paths.sbin_dir, PATH_SETUP_DS_ADMIN)
else:
prog = os.path.join(_ds_paths.sbin_dir, PATH_SETUP_DS)
if not os.path.isfile(prog):
log.error("Can't find file: %r, removing extension" % prog)
prog = prog[:-3]
content = formatInfData(args)
DirSrvTools.runInfProg(prog, content, verbose)
newconn = lib389.DirSrv(args['newhost'], args['newport'],
args['newrootdn'], args['newrootpw'],
args['newinstance'])
newconn.prefix = prefix
newconn.backupdir = backupdir
newconn.isLocal = isLocal
# Now the admin should have been created
# but still I should have taken all the required infos
# before.
if args['have_admin'] and not args['setup_admin']:
newconn.asport = asport
newconn.cfgdsuser = args['cfgdsuser']
newconn.cfgdspwd = args['cfgdspwd']
return newconn
@staticmethod
def createAndSetupReplica(createArgs, repArgs):
"""
Pass this sub two dicts - the first one is a dict suitable to create
a new instance - see createInstance for more details
the second is a dict suitable for replicaSetupAll -
see replicaSetupAll
"""
conn = DirSrvTools.createInstance(createArgs)
if not conn:
print("Error: could not create server", createArgs)
return 0
conn.replicaSetupAll(repArgs)
return conn
@staticmethod
def makeGroup(group=DEFAULT_USER):
"""
Create a system group
"""
try:
grp.getgrnam(group)
print("OK group %s exists" % group)
except KeyError:
print("Adding group %s" % group)
cmd = [GROUPADD, '-r', group]
subprocess.Popen(cmd)
@staticmethod
def makeUser(user=DEFAULT_USER, group=DEFAULT_USER, home=DEFAULT_USERHOME):
"""
Create a system user
"""
try:
pwd.getpwnam(user)
print("OK user %s exists" % user)
except KeyError:
print("Adding user %s" % user)
cmd = [USERADD, '-g', group, '-c', DEFAULT_USER_COMMENT, '-r',
'-d', home, '-s', NOLOGIN, user]
subprocess.Popen(cmd)
@staticmethod
def lib389User(user=DEFAULT_USER):
"""
Create the lib389 user/group
"""
DirSrvTools.makeGroup(group=user)
time.sleep(1) # Need a little time for the group to get fully created
DirSrvTools.makeUser(user=user, group=user, home=DEFAULT_USERHOME)
@staticmethod
def searchHostsFile(expectedHost, ipPattern=None):
"""
Search the hosts file
"""
hostFile = '/etc/hosts'
with open(hostFile, 'r') as hostfp:
# The with statement will automatically close the file after use
try:
for line in hostfp.readlines():
if ipPattern is None:
words = line.split()
if words[1] == expectedHost:
return True
else:
if line.find(ipPattern) >= 0:
words = line.split()
# We just want to make sure it's in there somewhere
if expectedHost in words:
return True
except AssertionError:
raise AssertionError(
"Error: %s should contain '%s' host for %s" %
('/etc/hosts', expectedHost, ipPattern))
raise AssertionError(
"Error: /etc/hosts does not contain '%s' as a host for %s"
% (expectedHost, ipPattern))
@staticmethod
def getLocalhost():
"""Get the first host value after 127.0.0.1
from /etc/hosts file
"""
with open('/etc/hosts', 'r') as f:
for line in f.readlines():
if line.startswith('127.0.0.1'):
localhost = line.split()[1]
return localhost
return None
@staticmethod
def testLocalhost():
'''
Checks that the 127.0.0.1 is resolved as localhost.localdomain
This is required by DSUtil.pm:checkHostname else setup-ds.pl fails
'''
# One day I'll make this ::1. Ipv6 is the future. The future is now.
loopbackIpPattern = '127.0.0.1'
DirSrvTools.searchHostsFile(LOCALHOST, loopbackIpPattern)
DirSrvTools.searchHostsFile(LOCALHOST_SHORT, loopbackIpPattern)
@staticmethod
def runUpgrade(prefix, online=True):
'''
Run "setup-ds.pl --update" We simply pass in one DirSrv isntance, and
this will update all the instances that are in this prefix. For the
update to work we must fix/adjust the permissions of the scripts in:
/prefix/lib[64]/dirsrv/slapd-INSTANCE/
'''
libdir = os.path.join(_ds_paths.lib_dir, 'dirsrv')
# Gather all the instances so we can adjust the permissions, otherwise
servers = []
path = os.path.join(_ds_paths.sysconf_dir, 'dirsrv')
for files in os.listdir(path):
if files.startswith('slapd-') and not files.endswith('.removed'):
servers.append(os.path.join(libdir, files))
if len(servers) == 0:
# This should not happen
log.fatal('runUpgrade: no servers found!')
assert False
'''
The setup script calls things like /lib/dirsrv/slapd-instance/db2bak,
etc, and when we run the setup perl script it gets permission denied
as the default permissions are 750. Adjust the permissions to 755.
'''
for instance in servers:
for files in os.listdir(instance):
os.chmod(os.path.join(instance, files), 755)
# Run the "upgrade"
try:
prog = os.path.join(_ds_paths.sbin_dir, PATH_SETUP_DS)
process = subprocess.Popen([prog, '--update'], shell=False,
stdin=subprocess.PIPE)
# Answer the interactive questions, as "--update" currently does
# not work with INF files
process.stdin.write('yes\n')
if(online):
process.stdin.write('online\n')
for x in servers:
process.stdin.write(DN_DM + '\n')
process.stdin.write(PW_DM + '\n')
else:
process.stdin.write('offline\n')
process.stdin.close()
process.wait()
if process.returncode != 0:
log.fatal('runUpgrade failed! Error: %s ' % process.returncode)
assert(False)
except:
log.fatal('runUpgrade failed!')
raise
@staticmethod
def searchFile(filename, pattern):
"""
Search file (or files using a wildcard) for the pattern
"""
found = False
file_list = glob.glob(filename)
for file_name in file_list:
try:
myfile = open(file_name)
for line in myfile:
result = re.search(pattern, line)
if result:
found = True
break
myfile.close()
if found:
break
except IOError as e:
log.error('Problem opening/searching file ' +
'(%s): I/O error(%d): %s' %
(file_name, e.errno, e.strerror))
return found
class MockDirSrv(object):
"""
Mock DirSrv Object
"""
host = 'localhost'
port = 22389
sslport = 0
def __init__(self, dict_=None):
"""
Init object
"""
if dict_:
self.host = dict_['host']
self.port = dict_['port']
if 'sslport' in dict_:
self.sslport = dict_['sslport']
def __str__(self):
"""
Return ldap URL
"""
if self.sslport:
return 'ldaps://%s:%s' % (self.host, self.sslport)
else:
return 'ldap://%s:%s' % (self.host, self.port)
|