Coverage for ipalib/errors : 99%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
|
# Authors: # Jason Gerard DeRose <jderose@redhat.com> # # Copyright (C) 2008 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 exception classes (some which are RPC transparent).
`PrivateError` and its subclasses are custom IPA excetions that will *never* be forwarded in a Remote Procedure Call (RPC) response.
On the other hand, `PublicError` and its subclasses can be forwarded in an RPC response. These public errors each carry a unique integer error code as well as a gettext translated error message (translated at the time the exception is raised). The purpose of the public errors is to relay information about *expected* user errors, service availability errors, and so on. They should *never* be used for *unexpected* programmatic or run-time errors.
For security reasons it is *extremely* important that arbitrary exceptions *not* be forwarded in an RPC response. Unexpected exceptions can easily contain compromising information in their error messages. Any time the server catches any exception that isn't a `PublicError` subclass, it should raise an `InternalError`, which itself always has the same, static error message (and therefore cannot be populated with information about the true exception).
The public errors are arranging into five main blocks of error code ranges:
============= ======================================== Error codes Exceptions ============= ======================================== 1000 - 1999 `AuthenticationError` and its subclasses 2000 - 2999 `AuthorizationError` and its subclasses 3000 - 3999 `InvocationError` and its subclasses 4000 - 4999 `ExecutionError` and its subclasses 5000 - 5999 `GenericError` and its subclasses ============= ========================================
Within these five blocks some sub-ranges are already allocated for certain types of error messages, while others are reserved for future use. Here are the current block assignments:
- **900-5999** `PublicError` and its subclasses
- **901 - 907** Assigned to special top-level public errors
- **908 - 999** *Reserved for future use*
- **1000 - 1999** `AuthenticationError` and its subclasses
- **1001 - 1099** Open for general authentication errors
- **1100 - 1199** `KerberosError` and its subclasses
- **1200 - 1299** `SessionError` and its subclasses
- **1300 - 1999** *Reserved for future use*
- **2000 - 2999** `AuthorizationError` and its subclasses
- **2001 - 2099** Open for general authorization errors
- **2100 - 2199** `ACIError` and its subclasses
- **2200 - 2999** *Reserved for future use*
- **3000 - 3999** `InvocationError` and its subclasses
- **3001 - 3099** Open for general invocation errors
- **3100 - 3199** *Reserved for future use*
- **4000 - 4999** `ExecutionError` and its subclasses
- **4001 - 4099** Open for general execution errors
- **4100 - 4199** `BuiltinError` and its subclasses
- **4200 - 4299** `LDAPError` and its subclasses
- **4300 - 4399** `CertificateError` and its subclasses
- **4400 - 4999** *Reserved for future use*
- **5000 - 5999** `GenericError` and its subclasses
- **5001 - 5099** Open for generic errors
- **5100 - 5999** *Reserved for future use* """
""" Base class for exceptions that are *never* forwarded in an RPC response. """
self.__class__.__name__, key, value, )
""" Raised when ``subprocess.call()`` returns a non-zero exit status.
This custom exception is needed because Python 2.4 doesn't have the ``subprocess.CalledProcessError`` exception (which was added in Python 2.5).
For example:
>>> raise SubprocessError(returncode=2, argv=('ls', '-lh', '/no-foo/')) Traceback (most recent call last): ... SubprocessError: return code 2 from ('ls', '-lh', '/no-foo/')
The exit code of the sub-process is available via the ``returncode`` instance attribute. For example:
>>> e = SubprocessError(returncode=1, argv=('/bin/false',)) >>> e.returncode 1 >>> e.argv # argv is also available ('/bin/false',) """
""" Raised when a plugin doesn't subclass from an allowed base.
For example:
>>> raise PluginSubclassError(plugin='bad', bases=('base1', 'base2')) Traceback (most recent call last): ... PluginSubclassError: 'bad' not subclass of any base in ('base1', 'base2')
"""
""" Raised when the same plugin class is registered more than once.
For example:
>>> raise PluginDuplicateError(plugin='my_plugin') Traceback (most recent call last): ... PluginDuplicateError: 'my_plugin' was already registered """
""" Raised when a plugin overrides another without using ``override=True``.
For example:
>>> raise PluginOverrideError(base='Command', name='env', plugin='my_env') Traceback (most recent call last): ... PluginOverrideError: unexpected override of Command.env with 'my_env' """
""" Raised when a plugin overrides another that has not been registered.
For example:
>>> raise PluginMissingOverrideError(base='Command', name='env', plugin='my_env') Traceback (most recent call last): ... PluginMissingOverrideError: Command.env not registered, cannot override with 'my_env' """
""" Raised to abort the loading of a plugin module. """
""" Raised when ``package.plugins`` is a module instead of a sub-package. """
############################################################################## # Public errors:
""" **900** Base class for exceptions that can be forwarded in an RPC response. """
'non-generic %r needs format=None; got format=%r' % ( name, format) ) '%s.format is None yet format=None, message=None' % name ) else: else: message = unicode(message) TYPE_ERROR % ('message', unicode, message, type(message)) ) name, key, value, )
""" **901** Raised when client and server versions are incompatible.
For example:
>>> raise VersionError(cver='2.0', sver='2.1', server='https://localhost') Traceback (most recent call last): ... VersionError: 2.0 client incompatible with 2.1 server at 'https://localhost'
"""
""" **902** Raised when client does not know error it caught from server.
For example:
>>> raise UnknownError(code=57, server='localhost', error=u'a new error') ... Traceback (most recent call last): ... UnknownError: unknown error 57 from localhost: a new error
"""
""" **903** Raised to conceal a non-public exception.
For example:
>>> raise InternalError() Traceback (most recent call last): ... InternalError: an internal error has occurred """
""" Security issue: ignore any information given to constructor. """
""" **904** Raised when client catches an `InternalError` from server.
For example:
>>> raise ServerInternalError(server='https://localhost') Traceback (most recent call last): ... ServerInternalError: an internal error has occurred on server at 'https://localhost' """
""" **905** Raised when an unknown command is called.
For example:
>>> raise CommandError(name='foobar') Traceback (most recent call last): ... CommandError: unknown command 'foobar' """
""" **906** Raised when client catches a `CommandError` from server.
For example:
>>> e = CommandError(name='foobar') >>> raise ServerCommandError(error=e.message, server='https://localhost') Traceback (most recent call last): ... ServerCommandError: error on server 'https://localhost': unknown command 'foobar' """
""" **907** Raised when a network connection cannot be created.
For example:
>>> raise NetworkError(uri='ldap://localhost:389', error=u'Connection refused') Traceback (most recent call last): ... NetworkError: cannot connect to 'ldap://localhost:389': Connection refused """
""" **908** Raised when client catches a `NetworkError` from server. """
""" **909** Raised when server recieved a malformed JSON-RPC request. """
""" **910** Raised when the XML-RPC lib cannot marshall the request
For example:
>>> raise XMLRPCMarshallError(error='int exceeds XML-RPC limits') Traceback (most recent call last): ... XMLRPCMarshallError: error marshalling data for XML-RPC transport: int exceeds XML-RPC limits """
""" **911** Raised when the the request does not contain an HTTP referer
For example:
>>> raise RefererError(referer='referer') Traceback (most recent call last): ... RefererError: Missing or invalid HTTP Referer, referer """
############################################################################## # 1000 - 1999: Authentication errors """ **1000** Base class for authentication errors (*1000 - 1999*). """
""" **1100** Base class for Kerberos authentication errors (*1100 - 1199*).
For example:
>>> raise KerberosError(major='Unspecified GSS failure. Minor code may provide more information', minor='No credentials cache found') Traceback (most recent call last): ... KerberosError: Kerberos error: Unspecified GSS failure. Minor code may provide more information/No credentials cache found
"""
""" **1101** Raised when sever does not recieve Kerberose credentials.
For example:
>>> raise CCacheError() Traceback (most recent call last): ... CCacheError: did not receive Kerberos credentials
"""
""" **1102** Raised when service is not found in Kerberos DB.
For example:
>>> raise ServiceError(service='HTTP@localhost') Traceback (most recent call last): ... ServiceError: Service 'HTTP@localhost' not found in Kerberos database """
""" **1103** Raised when a client attempts to use Kerberos without a ccache.
For example:
>>> raise NoCCacheError() Traceback (most recent call last): ... NoCCacheError: No credentials cache found """
""" **1104** Raised when a client attempts to use an expired ticket
For example:
>>> raise TicketExpired() Traceback (most recent call last): ... TicketExpired: Ticket expired """
""" **1105** Raised when a client has bad permissions on their ccache
For example:
>>> raise BadCCachePerms() Traceback (most recent call last): ... BadCCachePerms: Credentials cache permissions incorrect """
""" **1106** Raised when a client has a misformated ccache
For example:
>>> raise BadCCacheFormat() Traceback (most recent call last): ... BadCCacheFormat: Bad format in credentials cache """
""" **1107** Raised when the KDC can't be resolved
For example:
>>> raise CannotResolveKDC() Traceback (most recent call last): ... CannotResolveKDC: Cannot resolve KDC for requested realm """
""" **1200** Base class for Session errors (*1200 - 1299*).
For example:
"""
""" **1201** Raised when we cannot obtain a TGT for a principal. """
############################################################################## # 2000 - 2999: Authorization errors """ **2000** Base class for authorization errors (*2000 - 2999*). """
""" **2100** Base class for ACI authorization errors (*2100 - 2199*). """
############################################################################## # 3000 - 3999: Invocation errors
""" **3000** Base class for command invocation errors (*3000 - 3999*). """
""" **3001** Raised when received text is incorrectly encoded. """
""" **3002** Raised when received binary data is incorrectly encoded. """
""" **3003** Raised when a command is called with arguments but takes none.
For example:
>>> raise ZeroArgumentError(name='ping') Traceback (most recent call last): ... ZeroArgumentError: command 'ping' takes no arguments """
""" **3004** Raised when a command is called with too many arguments.
For example:
>>> raise MaxArgumentError(name='user_add', count=2) Traceback (most recent call last): ... MaxArgumentError: command 'user_add' takes at most 2 arguments """
'command %(name)r takes at most %(count)d argument', 'command %(name)r takes at most %(count)d arguments', kw['count'] ) else: format = None
""" **3005** Raised when a command is called with unknown options. """
""" **3006** Raised when arguments and options overlap.
For example:
>>> raise OverlapError(names=['givenname', 'login']) Traceback (most recent call last): ... OverlapError: overlapping arguments and options: ['givenname', 'login'] """
""" **3007** Raised when a required parameter is not provided.
For example:
>>> raise RequirementError(name='givenname') Traceback (most recent call last): ... RequirementError: 'givenname' is required """
""" **3008** Raised when parameter value can't be converted to correct type.
For example:
>>> raise ConversionError(name='age', error=u'must be an integer') Traceback (most recent call last): ... ConversionError: invalid 'age': must be an integer """
""" **3009** Raised when a parameter value fails a validation rule.
For example:
>>> raise ValidationError(name='sn', error=u'can be at most 128 characters') Traceback (most recent call last): ... ValidationError: invalid 'sn': can be at most 128 characters """
""" **3010** Raised when an unknown namespace is requested.
For example:
>>> raise NoSuchNamespaceError(name='Plugins') Traceback (most recent call last): ... NoSuchNamespaceError: api has no such namespace: 'Plugins' """
""" **3011** Raise when password and password confirmation don't match. """
""" **3012** Raise when a function hasn't been implemented. """
""" **3013** Raise when there is no configuration """
""" **3014** Raise when an interactive prompt failed. """
############################################################################## # 4000 - 4999: Execution errors
""" **4000** Base class for execution errors (*4000 - 4999*). """
""" **4001** Raised when an entry is not found.
For example:
>>> raise NotFound(reason='no such user') Traceback (most recent call last): ... NotFound: no such user
"""
""" **4002** Raised when an entry already exists.
For example:
>>> raise DuplicateEntry Traceback (most recent call last): ... DuplicateEntry: This entry already exists
"""
""" **4003** Raised when a host service principal is requested
For example:
>>> raise HostService Traceback (most recent call last): ... HostService: You must enroll a host in order to create a host service
"""
""" **4004** Raised when a service principal is not of the form: service/fully-qualified host name
For example:
>>> raise MalformedServicePrincipal(reason='missing service') Traceback (most recent call last): ... MalformedServicePrincipal: Service principal is not of the form: service/fully-qualified host name: missing service
"""
""" **4005** Raised when the requested realm does not match the IPA realm
For example:
>>> raise RealmMismatch Traceback (most recent call last): ... RealmMismatch: The realm for the principal does not match the realm for this IPA server
"""
""" **4006** Raised when a command requires the unix super-user to run
For example:
>>> raise RequiresRoot Traceback (most recent call last): ... RequiresRoot: This command requires root access
"""
""" **4007** Raised when a group is already a posix group
For example:
>>> raise AlreadyPosixGroup Traceback (most recent call last): ... AlreadyPosixGroup: This is already a posix group
"""
""" **4008** Raised when a user principal is not of the form: user@REALM
For example:
>>> raise MalformedUserPrincipal(principal='jsmith@@EXAMPLE.COM') Traceback (most recent call last): ... MalformedUserPrincipal: Principal is not of the form user@REALM: 'jsmith@@EXAMPLE.COM'
"""
""" **4009** Raised when an entry is made active that is already active
For example:
>>> raise AlreadyActive() Traceback (most recent call last): ... AlreadyActive: This entry is already enabled
"""
""" **4010** Raised when an entry is made inactive that is already inactive
For example:
>>> raise AlreadyInactive() Traceback (most recent call last): ... AlreadyInactive: This entry is already disabled
"""
""" **4011** Raised when an entry has the nsAccountLock attribute set
For example:
>>> raise HasNSAccountLock() Traceback (most recent call last): ... HasNSAccountLock: This entry cannot be enabled or disabled
"""
""" **4012** Raised when a non-member is attempted to be removed from a group
For example:
>>> raise NotGroupMember() Traceback (most recent call last): ... NotGroupMember: This entry is not a member
"""
""" **4013** Raised when a group is added as a member of itself
For example:
>>> raise RecursiveGroup() Traceback (most recent call last): ... RecursiveGroup: A group may not be a member of itself
"""
""" **4014** Raised when a member is attempted to be re-added to a group
For example:
>>> raise AlreadyGroupMember() Traceback (most recent call last): ... AlreadyGroupMember: This entry is already a member
"""
""" **4015** Raised when a base64-encoded blob cannot decoded
For example:
>>> raise Base64DecodeError(reason='Incorrect padding') Traceback (most recent call last): ... Base64DecodeError: Base64 decoding failed: Incorrect padding
"""
""" **4016** Raised when retrieving data from a remote server fails
For example:
>>> raise RemoteRetrieveError(reason="Error: Failed to get certificate chain.") Traceback (most recent call last): ... RemoteRetrieveError: Error: Failed to get certificate chain.
"""
""" **4017** Raised when adding a group as a member of itself
For example:
>>> raise SameGroupError() Traceback (most recent call last): ... SameGroupError: A group may not be added as a member of itself
"""
""" **4018** Raised when removing the default user group
For example:
>>> raise DefaultGroupError() Traceback (most recent call last): ... DefaultGroupError: The default users group cannot be removed
"""
""" **4019** Raised when a hostname is not a DNS A record
For example:
>>> raise DNSNotARecordError() Traceback (most recent call last): ... DNSNotARecordError: Host does not have corresponding DNS A record
"""
""" **4020** Raised when a managed group is deleted
For example:
>>> raise ManagedGroupError() Traceback (most recent call last): ... ManagedGroupError: Deleting a managed group is not allowed. It must be detached first. """
""" **4021** Raised when password policy is assigned to a managed group
For example:
>>> raise ManagedPolicyError() Traceback (most recent call last): ... ManagedPolicyError: A managed group cannot have a password policy. """
""" **4022** Errors when dealing with files
For example:
>>> raise FileError(reason="cannot write file \'test\'") Traceback (most recent call last): ... FileError: cannot write file 'test' """
""" **4023** Raised when trying to retrieve a certificate that doesn't exist.
For example:
>>> raise NoCertificateError(entry='ipa.example.com') Traceback (most recent call last): ... NoCertificateError: 'ipa.example.com' doesn't have a certificate. """
""" **4024** Raised when adding a user and its managed group exists
For example:
>>> raise ManagedGroupExistsError(group=u'engineering') Traceback (most recent call last): ... ManagedGroupExistsError: Unable to create private group. A group 'engineering' already exists. """
""" **4025** Raised when verifying that all reverse members have been added or removed.
For example:
>>> raise ReverseMemberError(verb='added', exc="Group 'foo' not found.") Traceback (most recent call last): ... ReverseMemberError: A problem was encountered when verifying that all members were added: Group 'foo' not found. """
""" **4026** Raised when an Attribute/Value pair is not found.
For example:
>>> raise AttrValueNotFound(attr='ipasudoopt', value='authenticate') Traceback (most recent call last): ... AttrValueNotFound: ipasudoopt does not contain 'authenticate'
"""
""" **4027** Raised when a search should return a single match
For example:
>>> raise SingleMatchExpected(found=9) Traceback (most recent call last): ... SingleMatchExpected: The search criteria was not specific enough. Expected 1 and found 9. """
""" **4100** Base class for builtin execution errors (*4100 - 4199*). """
""" **4101** Raised when requesting help for an unknown topic.
For example:
>>> raise HelpError(topic='newfeature') Traceback (most recent call last): ... HelpError: no command nor help topic 'newfeature' """
""" **4200** Base class for LDAP execution errors (*4200 - 4299*). """
""" **4201** Raised when a change collides with another change
For example:
>>> raise MidairCollision() Traceback (most recent call last): ... MidairCollision: change collided with another change """
""" **4202** Raised when an LDAP update makes no changes
For example:
>>> raise EmptyModlist() Traceback (most recent call last): ... EmptyModlist: no modifications to be performed """
""" **4203** Raised when an LDAP error is not otherwise handled
For example:
>>> raise DatabaseError(desc="Can't contact LDAP server", info='Info goes here') Traceback (most recent call last): ... DatabaseError: Can't contact LDAP server: Info goes here """
""" **4204** Raised when search limits are exceeded.
For example:
>>> raise LimitsExceeded() Traceback (most recent call last): ... LimitsExceeded: limits exceeded for this query """
""" **4205** Raised when an entry is missing a required attribute or objectclass
For example:
>>> raise ObjectclassViolation(info='attribute "krbPrincipalName" not allowed') Traceback (most recent call last): ... ObjectclassViolation: attribute "krbPrincipalName" not allowed """
""" **4206** Raised when an RDN value is modified.
For example:
>>> raise NotAllowedOnRDN() Traceback (most recent call last): ... NotAllowedOnRDN: modifying primary key is not allowed """
""" **4207** Raised when trying to set more than one value to single-value attributes
For example:
>> raise OnlyOneValueAllowed(attr='ipasearchtimelimit') Traceback (most recent call last): ... OnlyOneValueAllowed: ipasearchtimelimit: Only one value allowed. """
""" **4208** Raised when an value does not match the required syntax
For example:
>> raise InvalidSyntax(attr='ipahomesrootdir') Traceback (most recent call last): ... InvalidSyntax: ipahomesrootdir: Invalid syntax """
""" **4209** Raised when an invalid LDAP search filter is used
For example:
>>> raise BadSearchFilter(info='invalid syntax') Traceback (most recent call last): ... BadSearchFilter: Bad search filter invalid syntax """
""" **4300** Base class for Certificate execution errors (*4300 - 4399*). """
""" **4301** Raised when a certificate operation cannot be completed
For example:
>>> raise CertificateOperationError(error=u'bad serial number') Traceback (most recent call last): ... CertificateOperationError: Certificate operation cannot be completed: bad serial number
"""
""" **4302** Raised when a certificate is badly formatted
For example:
>>> raise CertificateFormatError(error=u'improperly formated DER-encoded certificate') Traceback (most recent call last): ... CertificateFormatError: Certificate format error: improperly formated DER-encoded certificate
"""
""" **4303** Raised when an operation would result in setting two attributes which are mutually exlusive.
For example:
>>> raise MutuallyExclusiveError(reason=u'hosts may not be added when hostcategory=all') Traceback (most recent call last): ... MutuallyExclusiveError: hosts may not be added when hostcategory=all
"""
""" **4304** Raised when part of an operation succeeds and the part that failed isn't critical.
For example:
>>> raise NonFatalError(reason=u'The host was added but the DNS update failed') Traceback (most recent call last): ... NonFatalError: The host was added but the DNS update failed
"""
""" **4305** Raised when registering a user that is already registered.
For example:
>>> raise AlreadyRegisteredError() Traceback (most recent call last): ... AlreadyRegisteredError: Already registered
"""
""" **4306** Raised when not registered and a registration is required
For example: >>> raise NotRegisteredError() Traceback (most recent call last): ... NotRegisteredError: Not registered yet
"""
""" **4307** Raised when an entry being deleted has dependencies
For example: >>> raise DependentEntry(label=u'SELinux User Map', key=u'test', dependent=u'test1') Traceback (most recent call last): ... DependentEntry: test cannot be deleted because SELinux User Map test1 requires it
"""
############################################################################## # 5000 - 5999: Generic errors
""" **5000** Base class for errors that don't fit elsewhere (*5000 - 5999*). """
""" Iterate through all the `PublicError` subclasses. """
sorted(__errors_iter(), key=lambda E: E.errno) )
for klass in public_errors: print '%d\t%s' % (klass.errno, klass.__name__) print '(%d public errors)' % len(public_errors) |