2013-11-27 07:53:57 -06:00
|
|
|
#! /usr/bin/python2 -E
|
2009-11-23 02:26:50 -06:00
|
|
|
# Authors: Martin Nagy <mnagy@redhat.com>
|
|
|
|
# Based on ipa-server-install by Karl MacMillan <kmacmillan@mentalrootkit.com>
|
|
|
|
#
|
|
|
|
# Copyright (C) 2007 - 2009 Red Hat
|
|
|
|
# see file 'COPYING' for use and warranty information
|
|
|
|
#
|
2010-12-09 06:59:11 -06:00
|
|
|
# This program is free software; you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU General Public License as published by
|
|
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
|
|
# (at your option) any later version.
|
2009-11-23 02:26:50 -06:00
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU General Public License
|
2010-12-09 06:59:11 -06:00
|
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2009-11-23 02:26:50 -06:00
|
|
|
#
|
|
|
|
|
2013-01-30 08:51:08 -06:00
|
|
|
from optparse import OptionGroup, SUPPRESS_HELP
|
|
|
|
|
|
|
|
import krbV
|
|
|
|
|
2012-03-06 06:26:45 -06:00
|
|
|
from ipaserver.install import service, bindinstance, ntpinstance, httpinstance
|
2009-11-23 02:26:50 -06:00
|
|
|
from ipaserver.install.installutils import *
|
2011-07-18 02:33:57 -05:00
|
|
|
from ipaserver.install import installutils
|
2009-11-23 02:26:50 -06:00
|
|
|
from ipapython import version
|
|
|
|
from ipapython import ipautil, sysrestore
|
2010-03-24 09:51:31 -05:00
|
|
|
from ipalib import api, errors, util
|
2014-06-17 04:45:43 -05:00
|
|
|
from ipaplatform.paths import paths
|
2010-10-29 13:24:31 -05:00
|
|
|
from ipapython.config import IPAOptionParser
|
2013-01-30 08:51:08 -06:00
|
|
|
from ipapython.ipa_log_manager import standard_logging_setup, root_logger
|
2014-03-18 10:23:30 -05:00
|
|
|
from ipapython.ipautil import DN
|
2009-11-23 02:26:50 -06:00
|
|
|
|
2014-06-17 04:45:43 -05:00
|
|
|
log_file_name = paths.IPASERVER_INSTALL_LOG
|
2012-05-31 07:34:09 -05:00
|
|
|
|
2009-11-23 02:26:50 -06:00
|
|
|
def parse_options():
|
2010-10-29 13:24:31 -05:00
|
|
|
parser = IPAOptionParser(version=version.VERSION)
|
2009-11-23 02:26:50 -06:00
|
|
|
parser.add_option("-p", "--ds-password", dest="dm_password",
|
2010-10-29 13:24:31 -05:00
|
|
|
sensitive=True, help="admin password")
|
2009-11-23 02:26:50 -06:00
|
|
|
parser.add_option("-d", "--debug", dest="debug", action="store_true",
|
|
|
|
default=False, help="print debugging information")
|
2014-08-27 06:50:21 -05:00
|
|
|
parser.add_option("--ip-address", dest="ip_addresses",
|
|
|
|
default=[], action="append",
|
2011-07-11 03:14:53 -05:00
|
|
|
type="ip", ip_local=True, help="Master Server IP Address")
|
2009-11-23 02:26:50 -06:00
|
|
|
parser.add_option("--forwarder", dest="forwarders", action="append",
|
2011-06-16 03:47:11 -05:00
|
|
|
type="ip", help="Add a DNS forwarder")
|
2009-11-23 02:26:50 -06:00
|
|
|
parser.add_option("--no-forwarders", dest="no_forwarders", action="store_true",
|
|
|
|
default=False, help="Do not add any DNS forwarders, use root servers instead")
|
2014-08-27 06:50:21 -05:00
|
|
|
parser.add_option("--reverse-zone", dest="reverse_zones",
|
|
|
|
default=[], action="append",
|
|
|
|
help="The reverse DNS zone to use")
|
2011-07-11 03:14:53 -05:00
|
|
|
parser.add_option("--no-reverse", dest="no_reverse", action="store_true",
|
2012-01-31 08:16:56 -06:00
|
|
|
default=False, help="Do not create new reverse DNS zone")
|
2011-10-24 11:35:48 -05:00
|
|
|
parser.add_option("--zonemgr", action="callback", callback=bindinstance.zonemgr_callback,
|
|
|
|
type="string",
|
2012-02-20 06:40:13 -06:00
|
|
|
help="DNS zone manager e-mail address. Defaults to hostmaster@DOMAIN")
|
2009-11-23 02:26:50 -06:00
|
|
|
parser.add_option("-U", "--unattended", dest="unattended", action="store_true",
|
|
|
|
default=False, help="unattended installation never prompts the user")
|
|
|
|
|
|
|
|
options, args = parser.parse_args()
|
2010-10-29 13:24:31 -05:00
|
|
|
safe_options = parser.get_safe_opts(options)
|
2009-11-23 02:26:50 -06:00
|
|
|
|
|
|
|
if options.forwarders and options.no_forwarders:
|
|
|
|
parser.error("You cannot specify a --forwarder option together with --no-forwarders")
|
2014-08-27 06:50:21 -05:00
|
|
|
elif options.reverse_zones and options.no_reverse:
|
2011-07-11 03:14:53 -05:00
|
|
|
parser.error("You cannot specify a --reverse-zone option together with --no-reverse")
|
2009-11-23 02:26:50 -06:00
|
|
|
|
|
|
|
if options.unattended:
|
|
|
|
if not options.forwarders and not options.no_forwarders:
|
|
|
|
parser.error("You must specify at least one --forwarder option or --no-forwarders option")
|
|
|
|
|
2010-10-29 13:24:31 -05:00
|
|
|
return safe_options, options
|
2009-11-23 02:26:50 -06:00
|
|
|
|
|
|
|
def main():
|
2010-10-29 13:24:31 -05:00
|
|
|
safe_options, options = parse_options()
|
2009-11-23 02:26:50 -06:00
|
|
|
|
|
|
|
if os.getegid() != 0:
|
2010-11-08 16:13:48 -06:00
|
|
|
sys.exit("Must be root to setup server")
|
2009-11-23 02:26:50 -06:00
|
|
|
|
2012-05-31 07:34:09 -05:00
|
|
|
standard_logging_setup(log_file_name, debug=options.debug, filemode='a')
|
|
|
|
print "\nThe log file for this installation can be found in %s" % log_file_name
|
2009-11-23 02:26:50 -06:00
|
|
|
|
2011-11-15 13:39:31 -06:00
|
|
|
root_logger.debug('%s was invoked with options: %s' % (sys.argv[0], safe_options))
|
|
|
|
root_logger.debug("missing options might be asked for interactively later\n")
|
2014-03-19 07:54:20 -05:00
|
|
|
root_logger.debug('IPA version %s' % version.VENDOR_VERSION)
|
2010-10-29 13:24:31 -05:00
|
|
|
|
2011-09-13 05:37:47 -05:00
|
|
|
installutils.check_server_configuration()
|
|
|
|
|
2009-11-23 02:26:50 -06:00
|
|
|
global fstore
|
2014-06-17 04:45:43 -05:00
|
|
|
fstore = sysrestore.FileStore(paths.SYSRESTORE)
|
2009-11-23 02:26:50 -06:00
|
|
|
|
|
|
|
print "=============================================================================="
|
|
|
|
print "This program will setup DNS for the FreeIPA Server."
|
|
|
|
print ""
|
|
|
|
print "This includes:"
|
|
|
|
print " * Configure DNS (bind)"
|
|
|
|
print ""
|
|
|
|
print "To accept the default shown in brackets, press the Enter key."
|
|
|
|
print ""
|
|
|
|
|
|
|
|
# Check bind packages are installed
|
|
|
|
if not bindinstance.check_inst(options.unattended):
|
2011-02-10 07:18:57 -06:00
|
|
|
sys.exit("Aborting installation.")
|
2009-11-23 02:26:50 -06:00
|
|
|
|
|
|
|
# Initialize the ipalib api
|
|
|
|
cfg = dict(
|
|
|
|
in_server=True,
|
|
|
|
debug=options.debug,
|
|
|
|
)
|
|
|
|
api.bootstrap(**cfg)
|
|
|
|
api.finalize()
|
|
|
|
|
2011-01-03 07:48:29 -06:00
|
|
|
if bindinstance.named_conf_exists():
|
2010-09-29 13:51:35 -05:00
|
|
|
sys.exit("\nDNS is already configured in this IPA server.")
|
|
|
|
|
2011-07-26 07:53:19 -05:00
|
|
|
# Create a BIND instance
|
|
|
|
if options.unattended and not options.dm_password:
|
|
|
|
sys.exit("\nIn unattended mode you need to provide at least the -p option")
|
|
|
|
|
|
|
|
dm_password = options.dm_password or read_password("Directory Manager",
|
|
|
|
confirm=False, validate=False)
|
2011-10-06 01:22:08 -05:00
|
|
|
if dm_password is None:
|
2013-07-09 05:29:21 -05:00
|
|
|
sys.exit("Directory Manager password required")
|
2011-07-26 07:53:19 -05:00
|
|
|
bind = bindinstance.BindInstance(fstore, dm_password)
|
|
|
|
|
|
|
|
# try the connection
|
|
|
|
try:
|
|
|
|
bind.ldap_connect()
|
|
|
|
bind.ldap_disconnect()
|
2013-01-30 08:51:08 -06:00
|
|
|
except errors.ACIError:
|
2011-07-26 07:53:19 -05:00
|
|
|
sys.exit("Password is not valid!")
|
|
|
|
|
2014-08-27 06:50:21 -05:00
|
|
|
ip_addresses = get_server_ip_address(api.env.host, fstore,
|
|
|
|
options.unattended, True, options.ip_addresses)
|
2011-07-11 03:14:53 -05:00
|
|
|
|
2009-11-23 02:26:50 -06:00
|
|
|
if options.no_forwarders:
|
|
|
|
dns_forwarders = ()
|
|
|
|
elif options.forwarders:
|
|
|
|
dns_forwarders = options.forwarders
|
|
|
|
else:
|
|
|
|
dns_forwarders = read_dns_forwarders()
|
2011-11-15 13:39:31 -06:00
|
|
|
root_logger.debug("will use dns_forwarders: %s\n", str(dns_forwarders))
|
2009-11-23 02:26:50 -06:00
|
|
|
|
2011-01-05 06:46:30 -06:00
|
|
|
if bind.dm_password:
|
Use DN objects instead of strings
* Convert every string specifying a DN into a DN object
* Every place a dn was manipulated in some fashion it was replaced by
the use of DN operators
* Add new DNParam parameter type for parameters which are DN's
* DN objects are used 100% of the time throughout the entire data
pipeline whenever something is logically a dn.
* Many classes now enforce DN usage for their attributes which are
dn's. This is implmented via ipautil.dn_attribute_property(). The
only permitted types for a class attribute specified to be a DN are
either None or a DN object.
* Require that every place a dn is used it must be a DN object.
This translates into lot of::
assert isinstance(dn, DN)
sprinkled through out the code. Maintaining these asserts is
valuable to preserve DN type enforcement. The asserts can be
disabled in production.
The goal of 100% DN usage 100% of the time has been realized, these
asserts are meant to preserve that.
The asserts also proved valuable in detecting functions which did
not obey their function signatures, such as the baseldap pre and
post callbacks.
* Moved ipalib.dn to ipapython.dn because DN class is shared with all
components, not just the server which uses ipalib.
* All API's now accept DN's natively, no need to convert to str (or
unicode).
* Removed ipalib.encoder and encode/decode decorators. Type conversion
is now explicitly performed in each IPASimpleLDAPObject method which
emulates a ldap.SimpleLDAPObject method.
* Entity & Entry classes now utilize DN's
* Removed __getattr__ in Entity & Entity clases. There were two
problems with it. It presented synthetic Python object attributes
based on the current LDAP data it contained. There is no way to
validate synthetic attributes using code checkers, you can't search
the code to find LDAP attribute accesses (because synthetic
attriutes look like Python attributes instead of LDAP data) and
error handling is circumscribed. Secondly __getattr__ was hiding
Python internal methods which broke class semantics.
* Replace use of methods inherited from ldap.SimpleLDAPObject via
IPAdmin class with IPAdmin methods. Directly using inherited methods
was causing us to bypass IPA logic. Mostly this meant replacing the
use of search_s() with getEntry() or getList(). Similarly direct
access of the LDAP data in classes using IPAdmin were replaced with
calls to getValue() or getValues().
* Objects returned by ldap2.find_entries() are now compatible with
either the python-ldap access methodology or the Entity/Entry access
methodology.
* All ldap operations now funnel through the common
IPASimpleLDAPObject giving us a single location where we interface
to python-ldap and perform conversions.
* The above 4 modifications means we've greatly reduced the
proliferation of multiple inconsistent ways to perform LDAP
operations. We are well on the way to having a single API in IPA for
doing LDAP (a long range goal).
* All certificate subject bases are now DN's
* DN objects were enhanced thusly:
- find, rfind, index, rindex, replace and insert methods were added
- AVA, RDN and DN classes were refactored in immutable and mutable
variants, the mutable variants are EditableAVA, EditableRDN and
EditableDN. By default we use the immutable variants preserving
important semantics. To edit a DN cast it to an EditableDN and
cast it back to DN when done editing. These issues are fully
described in other documentation.
- first_key_match was removed
- DN equalty comparison permits comparison to a basestring
* Fixed ldapupdate to work with DN's. This work included:
- Enhance test_updates.py to do more checking after applying
update. Add test for update_from_dict(). Convert code to use
unittest classes.
- Consolidated duplicate code.
- Moved code which should have been in the class into the class.
- Fix the handling of the 'deleteentry' update action. It's no longer
necessary to supply fake attributes to make it work. Detect case
where subsequent update applies a change to entry previously marked
for deletetion. General clean-up and simplification of the
'deleteentry' logic.
- Rewrote a couple of functions to be clearer and more Pythonic.
- Added documentation on the data structure being used.
- Simplfy the use of update_from_dict()
* Removed all usage of get_schema() which was being called prior to
accessing the .schema attribute of an object. If a class is using
internal lazy loading as an optimization it's not right to require
users of the interface to be aware of internal
optimization's. schema is now a property and when the schema
property is accessed it calls a private internal method to perform
the lazy loading.
* Added SchemaCache class to cache the schema's from individual
servers. This was done because of the observation we talk to
different LDAP servers, each of which may have it's own
schema. Previously we globally cached the schema from the first
server we connected to and returned that schema in all contexts. The
cache includes controls to invalidate it thus forcing a schema
refresh.
* Schema caching is now senstive to the run time context. During
install and upgrade the schema can change leading to errors due to
out-of-date cached schema. The schema cache is refreshed in these
contexts.
* We are aware of the LDAP syntax of all LDAP attributes. Every
attribute returned from an LDAP operation is passed through a
central table look-up based on it's LDAP syntax. The table key is
the LDAP syntax it's value is a Python callable that returns a
Python object matching the LDAP syntax. There are a handful of LDAP
attributes whose syntax is historically incorrect
(e.g. DistguishedNames that are defined as DirectoryStrings). The
table driven conversion mechanism is augmented with a table of
hard coded exceptions.
Currently only the following conversions occur via the table:
- dn's are converted to DN objects
- binary objects are converted to Python str objects (IPA
convention).
- everything else is converted to unicode using UTF-8 decoding (IPA
convention).
However, now that the table driven conversion mechanism is in place
it would be trivial to do things such as converting attributes
which have LDAP integer syntax into a Python integer, etc.
* Expected values in the unit tests which are a DN no longer need to
use lambda expressions to promote the returned value to a DN for
equality comparison. The return value is automatically promoted to
a DN. The lambda expressions have been removed making the code much
simpler and easier to read.
* Add class level logging to a number of classes which did not support
logging, less need for use of root_logger.
* Remove ipaserver/conn.py, it was unused.
* Consolidated duplicate code wherever it was found.
* Fixed many places that used string concatenation to form a new
string rather than string formatting operators. This is necessary
because string formatting converts it's arguments to a string prior
to building the result string. You can't concatenate a string and a
non-string.
* Simplify logic in rename_managed plugin. Use DN operators to edit
dn's.
* The live version of ipa-ldap-updater did not generate a log file.
The offline version did, now both do.
https://fedorahosted.org/freeipa/ticket/1670
https://fedorahosted.org/freeipa/ticket/1671
https://fedorahosted.org/freeipa/ticket/1672
https://fedorahosted.org/freeipa/ticket/1673
https://fedorahosted.org/freeipa/ticket/1674
https://fedorahosted.org/freeipa/ticket/1392
https://fedorahosted.org/freeipa/ticket/2872
2012-05-13 06:36:35 -05:00
|
|
|
api.Backend.ldap2.connect(bind_dn=DN(('cn', 'Directory Manager')), bind_pw=bind.dm_password)
|
2011-01-05 06:46:30 -06:00
|
|
|
else:
|
|
|
|
# See if our LDAP server is up and we can talk to it over GSSAPI
|
2013-01-31 10:18:35 -06:00
|
|
|
ccache = krbV.default_context().default_ccache()
|
2011-01-05 06:46:30 -06:00
|
|
|
api.Backend.ldap2.connect(ccache)
|
|
|
|
|
2014-08-27 06:50:21 -05:00
|
|
|
reverse_zones = bindinstance.check_reverse_zones(ip_addresses,
|
|
|
|
options.reverse_zones, options, options.unattended, True)
|
2011-07-11 03:14:53 -05:00
|
|
|
|
2014-08-27 06:50:21 -05:00
|
|
|
if reverse_zones is not None:
|
|
|
|
print "Using reverse zone %s" % ', '.join(reverse_zones)
|
2011-07-11 03:14:53 -05:00
|
|
|
|
2011-07-26 07:53:19 -05:00
|
|
|
conf_ntp = ntpinstance.NTPInstance(fstore).is_enabled()
|
|
|
|
|
|
|
|
if not options.unattended:
|
|
|
|
print ""
|
|
|
|
print "The following operations may take some minutes to complete."
|
|
|
|
print "Please wait until the prompt is returned."
|
|
|
|
print ""
|
|
|
|
|
2014-08-27 06:50:21 -05:00
|
|
|
bind.setup(api.env.host, ip_addresses, api.env.realm, api.env.domain,
|
|
|
|
dns_forwarders, conf_ntp, reverse_zones, zonemgr=options.zonemgr)
|
2009-11-23 02:26:50 -06:00
|
|
|
bind.create_instance()
|
|
|
|
|
2012-05-11 07:38:09 -05:00
|
|
|
# Restart http instance to make sure that python-dns has the right resolver
|
2012-03-06 06:26:45 -06:00
|
|
|
# https://bugzilla.redhat.com/show_bug.cgi?id=800368
|
|
|
|
http = httpinstance.HTTPInstance(fstore)
|
|
|
|
service.print_msg("Restarting the web server")
|
|
|
|
http.restart()
|
2011-01-05 06:46:30 -06:00
|
|
|
|
2009-11-23 02:26:50 -06:00
|
|
|
print "=============================================================================="
|
|
|
|
print "Setup complete"
|
|
|
|
print ""
|
2012-03-15 07:51:59 -05:00
|
|
|
bind.check_global_configuration()
|
|
|
|
print ""
|
|
|
|
print ""
|
2009-11-23 02:26:50 -06:00
|
|
|
print "\tYou must make sure these network ports are open:"
|
|
|
|
print "\t\tTCP Ports:"
|
|
|
|
print "\t\t * 53: bind"
|
|
|
|
print "\t\tUDP Ports:"
|
|
|
|
print "\t\t * 53: bind"
|
|
|
|
|
|
|
|
return 0
|
|
|
|
|
2012-05-31 07:34:09 -05:00
|
|
|
if __name__ == '__main__':
|
2013-06-03 05:06:06 -05:00
|
|
|
with private_ccache():
|
|
|
|
installutils.run_script(main, log_file_name=log_file_name,
|
|
|
|
operation_name='ipa-dns-install')
|