Open Interfaces
for e-Government

Error Codes of the Security Layer

Document information

Designation	Error codes of the Security Layer application interface of the Austrian Citizen Card
Short name	Error codes of the Security Layer
Version	1.2.0
Date	2005-05-14
Document class	Convention
Document status	Recommendation
Short Name	A variety of errors with different causes can occur when processing Security Layer commands in the Citizen Card Environment. This document classifies these errors and defines codes for the various errors. These codes are used in the error response that the Citizen Card Environment transmits to the application.
Authors	Arno Hollosi Gregor Karlinger
Work group	Federal Chancellery, Federal Staff Unit for ICT Strategy, Technology and Standards
©	This specification is supplied by A-SIT and the Federal Chancellery. It may be used without modification provided that reference is made to this copyright notice. The specification may be expanded, however any additional material must be clearly identified and the expanded specification must be made freely available.

General information
1. Naming conventions
2. Keywords
Scheme for error codes
1. Origin
2. Identifier
Standardised error codes
References
History

1 General information

A variety of errors with different causes can occur when processing commands from the Security Layer interface in the Citizen Card Environment. In this case, the Citizen Card Environment returns an sl:ErrorResponse (cf. Security Layer application interface, section 10) to the calling application. The sl:ErrorResponse contains an error code on the one hand and a text describing the cause of the error on the other.

This document classifies these errors and defines codes for the various errors.

1.1 Naming conventions

For better readability, this document dispenses with non-gender-specific formulations. However, the formulations expressly relate to both sexes.

The following name space prefixes are used in this specification to identify the name spaces of XML elements:

Prefix	Name space	Explanation
`sl`	`http://www.buergerkarte.at/namespaces/securitylayer/1.2#`	Elements of the interface specification

1.2 Keywords

This document uses the following keywords to categorise requirements: must, must not, required, should, should not, recommended, may, and optional. The interpretation of these keywords is set down in [Keywords].

2 Scheme for error codes

The error specified in the error message of the Citizen Card Environment (sl:ErrorResponse/sl:Errorcode) must satisfy the following two-part format: The first part, consisting of up to two decimal places, identifies the origin of the error, while the second part, consisting of precisely three decimal places, is the unique identifier for the error itself within the original area. When arranged in succession, both parts form a four or five digit decimal number.

2.1 Origin

In terms of the origin of an error, a distinction is made between the following areas:

Code	Origin
`1`	unclassified
`2`	Error in the binding to the transport protocol
`3`	Error in the XML structure of the command request
`4`	Error in command processing
`5`	Error in the viewer component
`6`	Cancelled by the citizen

2.2 Identifier

The second part of the error code is an error indicator that is unique within the area of origin. In addition to the identifiers defined in section 3 which a Citizen Card Environment must use to identify the relevant errors, a Citizen Card Environment may use other identifiers defined by the developer for errors not explicitly listed in section 3.

3 Standardised error codes

The following table contains standardised error codes that must be used by a Citizen Card Environment to identify the relevant errors.

Error code	Meaning
`1000`	Unclassified error.
`2000`	Unclassified error in the transport binding.
`2001`	HTTP/HTTPS binding: `DataURL` cannot be resolved.
`2002`	HTTP/HTTPS binding: `StylesheetURL` cannot be resolved.
`2003`	HTTP/HTTPS binding: `RedirectURL` cannot be resolved.
`2004`	HTTP/HTTPS binding: `XMLRequest` parameter missing.
`2005`	HTTP/HTTPS binding: Unknown parameter encoding.
`2006`	HTTP/HTTPS binding: Incorrect parameter encoding.
`2007`	HTTP/HTTPS binding: `DataURL` server transmits error or unexpected response.
`2008`	HTTP/HTTPS binding: Error in stylesheet obtained from the `StylesheetURL`.
`2009`	HTTP/HTTPS binding: HTTP request to local CCE directed to unauthorised URL.
`2010`	HTTPS binding: Error while establishing the TLS connection.
`3000`	Unclassified error in the XML structure of the command request.
`3001`	XML structure of the command request is not well formed.
`3002`	XML structure of the command request does not comply with the Security Layer schema.
`3003`	XML structure of the command request contains an invalid combination of optional elements or attributes.
`3004`	XML structure contains an element or attribute whose syntax does not match the Security Layer specification.
`3005`	Protocol version of Security Layer not supported.
`4000`	Unclassified error while processing command.
`4001`	Unknown key box identifier.
`4002`	Unknown info box identifier.
`4003`	Date to be signed cannot be resolved.
`4004`	Supplementary object cannot be resolved.
`4005`	Date to be encrypted cannot be resolved.
`4006`	Algorithm (signature, encryption, digest, canonicalisation, transformation) not supported.
`4007`	Error while executing algorithm (signature, encryption, digest, canonicalisation, transformation).
`4008`	Error while parsing CMS message
`4009`	No matching decryption key.
`4010`	Info box command parameters do not match info box type.
`4011`	Command not implemented.
`4100`	XML document in which the signature is to be integrated cannot be resolved.
`4101`	XML document in which the signature is to be integrated cannot be parsed.
`4102`	Signature cannot be integrated in the existing XML document at the specified location.
`4103`	Signature certificate not contained in the CMS signature.
`4104`	Signed data not contained in the CMS signature or XML request.
`4105`	XML document containing the signature to be verified cannot be resolved.
`4106`	XML document containing the signature to be verified cannot be parsed.
`4107`	There is no XML signature at the specified location within the XML document.
`4108`	Encrypted date cannot be inserted in the existing XML document at the specified location.
`4109`	Existing XML document is required but missing.
`4110`	Existing XML document cannot be resolved.
`4111`	Existing XML document cannot be parsed.
`4112`	Encrypted data encryption keys cannot be inserted in the existing XML document at the specified location.
`4113`	Data to be decrypted not contained in either the CMS message or XML request.
`4114`	XML document to be decrypted cannot be resolved.
`4115`	XML document to be decrypted cannot be parsed.
`4116`	At least one specified encryption element cannot be found in the XML document to be decrypted.
`4117`	No encryption element for binary response.
`4118`	Date to be hashed cannot be resolved.
`4119`	Date for which the hash value is to be verified cannot be resolved.
`4120`	Selected info box identifier already allocated.
`4121`	Info box with specified identifier does not exist.
`4122`	Contents of the selected info box cannot be displayed as XML.
`4123`	Associative array: No entry for the specified key.
`5000`	Unclassified error in the viewer component.
`5001`	Display of data of the mime type specified in the command request not supported.
`5002`	Character encoding of the data to be displayed is invalid or not supported.
`5003`	Data to be displayed contains unsupported characters.
`5004`	Standard display format: HTML does not conform to specification.
`5005`	Standard display format: CSS does not conform to specification.
`5006`	Standard display format: Format of an embedded image does not conform to specification.
`5007`	Standard display format: Signature for embedded images missing or does not conform to specification.
`6000`	Unclassified cancelling by the citizen.
`6001`	Cancelled by the citizen via the user interface.
`6002`	Cancelled because of insufficient rights to execute command.

4 References

KEYWORDS: Bradner, S.: RFC 2119: Key words for use in RFCs to Indicate Requirement Levels. IETF Request For Comment, March 1997. Downloaded from the World Wide Web on 14 May 2004 under http://www.ietf.org/rfc/rfc2119.txt.

5 History

Date	Version	Changes
2004-05-14	1.2.0	Complete revision
2002-02-25	1.0.0	Created

Table of contents