mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-26 17:01:14 -06:00
4295df17a4
When ipa host-add --random is unable to add a reverse record (for instance because the server does not manage any reverse zone), the command adds the host but exits (return code=1) with an error without actually outputing the random password generated. With this fix, the behavior is modified. The commands succeeds (return code=0) but prints a warning. This commit also adds a unit test. https://pagure.io/freeipa/issue/7374 Reviewed-By: Christian Heimes <cheimes@redhat.com>
510 lines
14 KiB
Python
510 lines
14 KiB
Python
# Authors:
|
|
# Petr Viktorin <pviktori@redhat.com>
|
|
#
|
|
# Copyright (C) 2012 Red Hat
|
|
# see file 'COPYING' for use and warranty inmsgion
|
|
#
|
|
# 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.
|
|
#
|
|
# 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
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
"""
|
|
Custom message (debug, info, wraning) classes passed through RPC.
|
|
|
|
These are added to the "messages" entry in a RPC response, and printed to the
|
|
user as log messages.
|
|
|
|
Each message class has a unique numeric "errno" attribute from the 10000-10999
|
|
range, so that it does not clash with PublicError numbers.
|
|
|
|
Messages also have the 'type' argument, set to one of 'debug', 'info',
|
|
'warning', 'error'. This determines the severity of themessage.
|
|
"""
|
|
from __future__ import print_function
|
|
|
|
from inspect import isclass
|
|
|
|
import six
|
|
|
|
from ipalib.constants import TYPE_ERROR
|
|
from ipalib.text import _ as ugettext
|
|
from ipalib.text import Gettext, NGettext
|
|
from ipalib.capabilities import client_has_capability
|
|
|
|
if six.PY3:
|
|
unicode = str
|
|
|
|
def add_message(version, result, message):
|
|
if client_has_capability(version, 'messages'):
|
|
result.setdefault('messages', []).append(message.to_dict())
|
|
|
|
|
|
def process_message_arguments(obj, format=None, message=None, **kw):
|
|
for key, value in kw.items():
|
|
if not isinstance(value, six.integer_types):
|
|
try:
|
|
kw[key] = unicode(value)
|
|
except UnicodeError:
|
|
pass
|
|
obj.kw = kw
|
|
name = obj.__class__.__name__
|
|
if obj.format is not None and format is not None:
|
|
raise ValueError(
|
|
'non-generic %r needs format=None; got format=%r' % (
|
|
name, format)
|
|
)
|
|
if message is None:
|
|
if obj.format is None:
|
|
if format is None:
|
|
raise ValueError(
|
|
'%s.format is None yet format=None, message=None' % name
|
|
)
|
|
obj.format = format
|
|
obj.forwarded = False
|
|
obj.msg = obj.format % kw
|
|
if isinstance(obj.format, six.string_types):
|
|
obj.strerror = ugettext(obj.format) % kw
|
|
else:
|
|
obj.strerror = obj.format % kw
|
|
if 'instructions' in kw:
|
|
def convert_instructions(value):
|
|
if isinstance(value, list):
|
|
result = u'\n'.join(unicode(line) for line in value)
|
|
return result
|
|
return value
|
|
instructions = u'\n'.join((unicode(_('Additional instructions:')),
|
|
convert_instructions(kw['instructions'])))
|
|
obj.strerror = u'\n'.join((obj.strerror, instructions))
|
|
else:
|
|
if isinstance(message, (Gettext, NGettext)):
|
|
message = unicode(message)
|
|
elif type(message) is not unicode:
|
|
raise TypeError(
|
|
TYPE_ERROR % ('message', unicode, message, type(message))
|
|
)
|
|
obj.forwarded = True
|
|
obj.msg = message
|
|
obj.strerror = message
|
|
for (key, value) in kw.items():
|
|
assert not hasattr(obj, key), 'conflicting kwarg %s.%s = %r' % (
|
|
name, key, value,
|
|
)
|
|
setattr(obj, key, value)
|
|
|
|
|
|
_texts = []
|
|
|
|
def _(message):
|
|
_texts.append(message)
|
|
return message
|
|
|
|
|
|
class PublicMessage(UserWarning):
|
|
"""
|
|
**10000** Base class for messages that can be forwarded in an RPC response.
|
|
"""
|
|
def __init__(self, format=None, message=None, **kw):
|
|
process_message_arguments(self, format, message, **kw)
|
|
super(PublicMessage, self).__init__(self.msg)
|
|
|
|
errno = 10000
|
|
format = None
|
|
|
|
def to_dict(self):
|
|
"""Export this message to a dict that can be sent through RPC"""
|
|
return dict(
|
|
type=unicode(self.type),
|
|
name=unicode(type(self).__name__),
|
|
message=self.strerror,
|
|
code=self.errno,
|
|
data=self.kw,
|
|
)
|
|
|
|
|
|
class VersionMissing(PublicMessage):
|
|
"""
|
|
**13001** Used when client did not send the API version.
|
|
|
|
For example:
|
|
|
|
>>> VersionMissing(server_version='2.123').strerror
|
|
u"API Version number was not sent, forward compatibility not guaranteed. Assuming server's API version, 2.123"
|
|
|
|
"""
|
|
|
|
errno = 13001
|
|
type = 'warning'
|
|
format = _("API Version number was not sent, forward compatibility not "
|
|
"guaranteed. Assuming server's API version, %(server_version)s")
|
|
|
|
|
|
class ForwardersWarning(PublicMessage):
|
|
"""
|
|
**13002** Used when (master) zone contains forwarders
|
|
"""
|
|
|
|
errno = 13002
|
|
type = 'warning'
|
|
format = _(
|
|
u"DNS forwarder semantics changed since IPA 4.0.\n"
|
|
u"You may want to use forward zones (dnsforwardzone-*) instead.\n"
|
|
u"For more details read the docs.")
|
|
|
|
|
|
class DNSSECWarning(PublicMessage):
|
|
"""
|
|
**13003** Used when user change DNSSEC settings
|
|
"""
|
|
|
|
errno = 13003
|
|
type = "warning"
|
|
format = _("DNSSEC support is experimental.\n%(additional_info)s")
|
|
|
|
|
|
class OptionDeprecatedWarning(PublicMessage):
|
|
"""
|
|
**13004** Used when user uses a deprecated option
|
|
"""
|
|
|
|
errno = 13004
|
|
type = "warning"
|
|
format = _(u"'%(option)s' option is deprecated. %(additional_info)s")
|
|
|
|
|
|
class OptionSemanticChangedWarning(PublicMessage):
|
|
"""
|
|
**13005** Used when option which recently changes its semantic is used
|
|
"""
|
|
|
|
errno = 13005
|
|
type = "warning"
|
|
format = _(u"Semantic of %(label)s was changed. %(current_behavior)s\n"
|
|
u"%(hint)s")
|
|
|
|
|
|
class DNSServerValidationWarning(PublicMessage):
|
|
"""
|
|
**13006** Used when a DNS server is not to able to resolve query
|
|
"""
|
|
|
|
errno = 13006
|
|
type = "warning"
|
|
format = _(u"DNS server %(server)s: %(error)s.")
|
|
|
|
|
|
class DNSServerDoesNotSupportDNSSECWarning(PublicMessage):
|
|
"""
|
|
**13007** Used when a DNS server does not support DNSSEC validation
|
|
"""
|
|
|
|
errno = 13007
|
|
type = "warning"
|
|
format = _(u"DNS server %(server)s does not support DNSSEC: %(error)s.\n"
|
|
u"If DNSSEC validation is enabled on IPA server(s), "
|
|
u"please disable it.")
|
|
|
|
|
|
class ForwardzoneIsNotEffectiveWarning(PublicMessage):
|
|
"""
|
|
**13008** Forwardzone is not effective, forwarding will not work because
|
|
there is authoritative parent zone, without proper NS delegation
|
|
"""
|
|
|
|
errno = 13008
|
|
type = "warning"
|
|
format = _(u"forward zone \"%(fwzone)s\" is not effective because of "
|
|
u"missing proper NS delegation in authoritative zone "
|
|
u"\"%(authzone)s\". Please add NS record "
|
|
u"\"%(ns_rec)s\" to parent zone \"%(authzone)s\".")
|
|
|
|
|
|
class DNSServerDoesNotSupportEDNS0Warning(PublicMessage):
|
|
"""
|
|
**13009** Used when a DNS server does not support EDNS0, required for
|
|
DNSSEC support
|
|
"""
|
|
|
|
errno = 13009
|
|
type = "warning"
|
|
format = _(u"DNS server %(server)s does not support EDNS0 (RFC 6891): "
|
|
u"%(error)s.\n"
|
|
u"If DNSSEC validation is enabled on IPA server(s), "
|
|
u"please disable it.")
|
|
|
|
|
|
class DNSSECValidationFailingWarning(PublicMessage):
|
|
"""
|
|
**13010** Used when a DNSSEC validation failed on IPA DNS server
|
|
"""
|
|
|
|
errno = 13010
|
|
type = "warning"
|
|
format = _(u"DNSSEC validation failed: %(error)s.\n"
|
|
u"Please verify your DNSSEC configuration or disable DNSSEC "
|
|
u"validation on all IPA servers.")
|
|
|
|
|
|
class KerberosTXTRecordCreationFailure(PublicMessage):
|
|
"""
|
|
**13011** Used when a _kerberos TXT record could not be added to
|
|
a DNS zone.
|
|
"""
|
|
|
|
errno = 13011
|
|
type = "warning"
|
|
format = _(
|
|
"The _kerberos TXT record from domain %(domain)s could not be created "
|
|
"(%(error)s).\nThis can happen if the zone is not managed by IPA. "
|
|
"Please create the record manually, containing the following "
|
|
"value: '%(realm)s'"
|
|
)
|
|
|
|
|
|
class KerberosTXTRecordDeletionFailure(PublicMessage):
|
|
"""
|
|
**13012** Used when a _kerberos TXT record could not be removed from
|
|
a DNS zone.
|
|
"""
|
|
|
|
errno = 13012
|
|
type = "warning"
|
|
format = _(
|
|
"The _kerberos TXT record from domain %(domain)s could not be removed "
|
|
"(%(error)s).\nThis can happen if the zone is not managed by IPA. "
|
|
"Please remove the record manually."
|
|
)
|
|
|
|
class DNSSECMasterNotInstalled(PublicMessage):
|
|
"""
|
|
**13013** Used when a DNSSEC is not installed on system (no DNSSEC
|
|
master server is installed).
|
|
"""
|
|
|
|
errno = 13013
|
|
type = "warning"
|
|
format = _(
|
|
"No DNSSEC key master is installed. DNSSEC zone signing will not work "
|
|
"until the DNSSEC key master is installed."
|
|
)
|
|
|
|
|
|
class DNSSuspiciousRelativeName(PublicMessage):
|
|
"""
|
|
**13014** Relative name "record.zone" is being added into zone "zone.",
|
|
which is probably a mistake. User probably wanted to either specify
|
|
relative name "record" or use FQDN "record.zone.".
|
|
"""
|
|
|
|
errno = 13014
|
|
type = "warning"
|
|
format = _(
|
|
"Relative record name '%(record)s' contains the zone name '%(zone)s' "
|
|
"as a suffix, which results in FQDN '%(fqdn)s'. This is usually a "
|
|
"mistake caused by a missing dot at the end of the name specification."
|
|
)
|
|
|
|
|
|
class CommandDeprecatedWarning(PublicMessage):
|
|
"""
|
|
**13015** Used when user uses a deprecated option
|
|
"""
|
|
|
|
errno = 13015
|
|
type = "warning"
|
|
format = _(u"'%(command)s' is deprecated. %(additional_info)s")
|
|
|
|
|
|
class ExternalCommandOutput(PublicMessage):
|
|
"""
|
|
**13016** Line of output from an external command.
|
|
"""
|
|
|
|
errno = 13016
|
|
type = "info"
|
|
format = _("%(line)s")
|
|
|
|
|
|
class SearchResultTruncated(PublicMessage):
|
|
"""
|
|
**13017** Results of LDAP search has been truncated
|
|
"""
|
|
|
|
errno = 13017
|
|
type = "warning"
|
|
format = _("Search result has been truncated: %(reason)s")
|
|
|
|
|
|
class BrokenTrust(PublicMessage):
|
|
"""
|
|
**13018** Trust for a specified domain is broken
|
|
"""
|
|
|
|
errno = 13018
|
|
type = "warning"
|
|
format = _("Your trust to %(domain)s is broken. Please re-create it by "
|
|
"running 'ipa trust-add' again.")
|
|
|
|
|
|
class ResultFormattingError(PublicMessage):
|
|
"""
|
|
**13019** Unable to correctly format some part of the result
|
|
"""
|
|
type = "warning"
|
|
errno = 13019
|
|
|
|
|
|
class FailedToRemoveHostDNSRecords(PublicMessage):
|
|
"""
|
|
**13020** Failed to remove host DNS records
|
|
"""
|
|
|
|
errno = 13020
|
|
type = "warning"
|
|
format = _("DNS record(s) of host %(host)s could not be removed. "
|
|
"(%(reason)s)")
|
|
|
|
|
|
class DNSForwardPolicyConflictWithEmptyZone(PublicMessage):
|
|
"""
|
|
**13021** Forward zone 1.10.in-addr.arpa with policy "first"
|
|
will not forward anything because BIND automatically prefers
|
|
empty zone "10.in-addr.arpa.".
|
|
"""
|
|
|
|
errno = 13021
|
|
type = "warning"
|
|
format = _(
|
|
"Forwarding policy conflicts with some automatic empty zones. "
|
|
"Queries for zones specified by RFC 6303 will ignore "
|
|
"forwarding and recursion and always result in NXDOMAIN answers. "
|
|
"To override this behavior use forward policy 'only'."
|
|
)
|
|
|
|
|
|
class DNSUpdateOfSystemRecordFailed(PublicMessage):
|
|
"""
|
|
**13022** Update of a DNS system record failed
|
|
"""
|
|
errno = 13022
|
|
type = "warning"
|
|
format = _(
|
|
"Update of system record '%(record)s' failed with error: %(error)s"
|
|
)
|
|
|
|
|
|
class DNSUpdateNotIPAManagedZone(PublicMessage):
|
|
"""
|
|
**13023** Zone for system records is not managed by IPA
|
|
"""
|
|
errno = 13023
|
|
type = "warning"
|
|
format = _(
|
|
"IPA does not manage the zone %(zone)s, please add records "
|
|
"to your DNS server manually"
|
|
)
|
|
|
|
|
|
class AutomaticDNSRecordsUpdateFailed(PublicMessage):
|
|
"""
|
|
**13024** Automatic update of DNS records failed
|
|
"""
|
|
errno = 13024
|
|
type = "warning"
|
|
format = _(
|
|
"Automatic update of DNS system records failed. "
|
|
"Please re-run update of system records manually to get list of "
|
|
"missing records."
|
|
)
|
|
|
|
|
|
class ServiceRestartRequired(PublicMessage):
|
|
"""
|
|
**13025** Service restart is required
|
|
"""
|
|
errno = 13025
|
|
type = "warning"
|
|
format = _(
|
|
"Service %(service)s requires restart on IPA server %(server)s to "
|
|
"apply configuration changes."
|
|
)
|
|
|
|
|
|
class LocationWithoutDNSServer(PublicMessage):
|
|
"""
|
|
**13026** Location without DNS server
|
|
"""
|
|
errno = 13026
|
|
type = "warning"
|
|
format = _(
|
|
"No DNS servers in IPA location %(location)s. Without DNS servers "
|
|
"location is not working as expected."
|
|
)
|
|
|
|
|
|
class ServerRemovalInfo(PublicMessage):
|
|
"""
|
|
**13027** Informative message printed during removal of IPA server
|
|
"""
|
|
errno = 13027
|
|
type = "info"
|
|
|
|
|
|
class ServerRemovalWarning(PublicMessage):
|
|
"""
|
|
**13028** Warning raised during removal of IPA server
|
|
"""
|
|
errno = 13028
|
|
type = "warning"
|
|
|
|
|
|
class CertificateInvalid(PublicMessage):
|
|
"""
|
|
**13029** Failed to parse a certificate
|
|
"""
|
|
errno = 13029
|
|
type = "error"
|
|
format = _("%(subject)s: Malformed certificate. "
|
|
"%(reason)s")
|
|
|
|
|
|
class FailedToAddHostDNSRecords(PublicMessage):
|
|
"""
|
|
**13030** Failed to add host DNS records
|
|
"""
|
|
|
|
errno = 13030
|
|
type = "warning"
|
|
format = _("The host was added but the DNS update failed with: "
|
|
"%(reason)s")
|
|
|
|
|
|
def iter_messages(variables, base):
|
|
"""Return a tuple with all subclasses
|
|
"""
|
|
for (key, value) in variables.items():
|
|
if key.startswith('_') or not isclass(value):
|
|
continue
|
|
if issubclass(value, base):
|
|
yield value
|
|
|
|
|
|
public_messages = tuple(sorted(
|
|
iter_messages(globals(), PublicMessage), key=lambda E: E.errno))
|
|
|
|
def print_report(label, classes):
|
|
for cls in classes:
|
|
print('%d\t%s' % (cls.errno, cls.__name__))
|
|
print('(%d %s)' % (len(classes), label))
|
|
|
|
if __name__ == '__main__':
|
|
print_report('public messages', public_messages)
|