XML Encryption Draft Requirements
Draft 2001-March-07
- This version:
- http://www.w3.org/Encryption/2001/03/07-xml-encryption-req.html
- Latest version:
- ...
- Previous version:
- http://www.w3.org/Encryption/2001/01/23-xml-encryption-req.html
- Editor:
- Joseph Reagle <reagle@w3.org>
Copyright © 2001
W3C (MIT,
INRIA, Keio), All Rights Reserved. W3C liability,
trademark,
document
use and software
licensing rules apply.
Status of this Document
This is draft intended to capture the consensus at the 01 March 2001
face-to-face meeting {FTF1}.
This document has no formal status or standing yet, but it is hoped it will be
issued as a Working Draft by the Working Group (WG) soon. Consequently, this
document does not necessarily represent consensus. It's roughly based on the
authors understanding of {prop1},
{prop2},
{prop3},
{C2000},
{WS},
{FTF1}
and other discussion and proposals. Positions which are potentially in conflict
are specified as a list of lettered points. For example:
- Extensibility
-
- Position
- Alternative/Contrary Position
Citation of a source (e.g., {source}) in no way indicates the originator or
sole supporter of that requirement. Instead, it helps track at least one
source/motivation of the requirement or comment.
Please send comments to the editor <reagle@w3.org> and cc: the list xml-encryption@w3.org (archives)
Publication of this document does not imply endorsement by the W3C membership.
This is a draft document and may be updated, replaced or obsoleted by other
documents at any time.
Abstract
This document lists the design principles, scope, and requirements for the
XML Encryption. It includes requirements as they relate to the encryption
syntax, data model, format, cryptographic processing, and external requirements
and coordination.
The XML 1.0 Recommendation [XML]
describes the syntax of a class of data objects called XML documents. There is
interest in a specification of XML syntax and processing for encrypting digital
content, including portions of XML documents and protocol messages. This
documents provides requirements for such a specification.
This section describes requirements over intended result, how these
motivations are realized are addressed in subsequent sections.
- The XML Encryption specification must describe how to use XML to represent
a digitally encrypted Web resource (including XML itself). {prop1,prop2}.
The XML representation of the encrypted resource must
be a first class object that can be readily distinguished from other types
of information in a given XML document.
- The specification must provide for the encryption of
a part or totality of an XML document
- Granularity of encryption is limited to an element (including
start/end tags) or element content (between the start/end tags). {prop2,
WS}
Otherwise, Sensitive attribute values may be
are secured without encyrpting
their parent element by transforming the
original document into a element only version. {List: Hallam-Baker}
(However, requiring applications to do this in a "non-standard" way is
costly, {List: Simon}
and can make the data useless to intermediate processors which is counter
to the purpose of partial encryption. {List: Reagle}).
But, it
is also recognized that encrypting attribute values always transforms the original
document.
In general, this transformation will make the resulting document
invalid against an existing, non-encryption aware, schema, for the original
document. Hence, intermediate processors may error when attempting to process
the encryption transformed document. The XML Encryption specification
should not encourage this potentially brittle application behavior. {Dillaway}
- The specification must provide for the separation of
encryption information from encrypted data, and support reference mechanisms
for addressing encryption information from encrypted data sections and
vice-versa. {HP:
R3.7, prop2}
- The specification must allow super-encryption of
data
provide for recursive encryption (i.e,,
capable of encrypting XML in which
some elements are with portions already encrypted). {prop1,prop2}
The result of super-encrypting elements must result
in valid XML with respect to the XML Encryption specification.
-
The specification must define mechanisms for conveying
encryption key information to a recipient in an XML compatible manner. The
XML key information structure must
be a first class object that can be readily distinguished from other types
of information in a given XML document. The structure must be
flexible to meet a variety of application requirements including:
It shall be possible to include key information as part
of an XML encrypted data representation. In addition, is shall be possible to
specify key information along with references to all of the data encrypted with
that key.
- The mechanisms of encryption must be simple: describe how to
encrypt/decrypt digital content, XML documents, and portions thereof. {Reagle}
- Only
enough information necessary for decryption need be
provided. {Reagle}.
The specification must allow efficient encoding of encrypted
data and related information when parties have pre-agreed upon the
encryption approach and keying material. Hence,
the specification must not mandate the presence of any attributes
describing how the data is encrypted.
- The specification will not address the confidence or trust applications
place in the provision of a key
- The specification will not address authentication. {List:
Reagle,
WS}
- The specification will not address authorization and access control. {List:
Reagle,
Simon,
Kudoh,
WS}
- The Working Group (WG) must use pre-existing specifications unless it can
explicitly justify the need for a new one. {Reagle}For example, its should use
Information Set as a data model for XML instances and Canonical XML for
canonicalization.
- The specification must define a minimal set of algorithms and key
structures necessary for interoperability purposes. {Reagle}
- The specification should strive to limit optionality and maximize
extensibility such that all of the specification can be quickly implemented
- Whenever possible, any encryption resource or algorithm is a first class
object (which can also be encrypted or signed), and identified by a URI. {prop1,prop2}
1. Encryption Data Model and Syntax
- The XML data model used by XML Encryption in
identifying or representing data that has been processed must be predicated
on:
- a simple enumerated subset of InfoSet items (e.g., element, attribute,
etc.) and properties {e.g., child, parent, localname, prefix, etc.) {WS}
- XML Encryption can be applied to any Web resource -- including non-XML
content. {prop1,prop2}
Also, see Requirements:
Objects.
- XML Encryption should be able to work with streaming media. {List:
Simon} However,
it is outside the scope of this specification to define
approaches to content buffering, incremental delivery, and related issues.
These are application specific.
A non-XML object when encrypted is encoded in an instance of XML; when
decrypted it must revert to its original media type. {TimBL}
I don't find the above statement adequate.
I would suggest the following:
When a non-XML object (i.e., external data) is
encrypted, the information necessary to aid the recipient in decrypting the
object is encoded in an instance of XML.
It is an application decision whether to include the encrypted object
cipher data with this XML, as a base64 encoded CDATA, or to simply reference
the external cipher data octet sequence. In either case, the decrypted
data must revert to the media type of the original object.
Each encrypted data object should be independent
with no required linkage or dependencies with other encrypted data.
It should be possible to express key information
objects as valid independent XML, or as part of an encrypted data object.
It must be possible to indicate the original type
(i.e., XML CData, image/gif) of the encrypted data to aid the decryptor in processing it.
For non-XML data, existing MIME type definitions [MIME] should be used.
- Binary data must be encoded as Base64 when represented in XML. {FTF1}
- The specification must not define packaging representations of non XML
data (e.g., MIME-objects) other than the encrypted and encoded information
appearing within the XML Encryption defined syntax
defined by thisthe EncryptedData
element.
Note: We shouldn't
reference an element who definition depends on the requirements in this
document.
- The specification must not define a packaging format that describes the
relationships between encrypted objects. For instance, the specification will
not specify how an application can designate that a set of encrypted objects
are actually encryptions over different representations (encodings,
compression, etc.) of the same object. {prop3:
open issue 2, resolved at FTF1}
- Parsing {WS}
- XML Encryption applications must be XML-namespaces [XML-namespaces]
aware.
- XML Encryption applications must be XML Schema [XML-schema]
aware in that they create XML encryption instances conforming to the schema
definition. {Reagle}
- Implementation of the specification should work
with existing XML parser and schema implementations.
have a minimal affect upon
XML parser and schema implementations. While {WS:Simon}
demonstrated that XML-encryption functionality did not necessarily require
any changes to particular DOM and XML parser implementations, it may be
necessary for implementors to tweak their parsers as needed.
We
should just state the requirement and delete the text indicating we've
'demonstrated' something. I
don’t believe this is a difficult requirement to meet as shown by Ed’s
code as well as some I’ve written. However, sample code using
non-final syntax and processing rules don't provide proof that the
specification will meet this requirement. The text below captures the
last issue above and makes it clear this is out of scope.
However, alterations
to particular DOM and/or XML parser implementations may prove beneficial in
terms of simplifying application development or improving runtime
efficiency. These
considerations are outside the scope of the XML Encryption
specification.
- XML Instance Validity {WS}
- Encrypted instances must be well-formed but need not be valid against
the schema associated with the original XML(i.e.
applications that encrypt the element structure are purposefully hiding that
structure.)
- Instance authors that want to validate encrypted instances must do one
of the follow:
- Write the original schema so as to validate resulting instances given
the change in its structure and inclusion of element types from the XML
Encryption namespace.
- Provide a post-encryption schema for validating encrypted instances.
- Only encrypt PCDATA text of element content and place its decryption
and key information in an external document. (This requires granular
detached/external
encryption.)
- The processing model must be described
using Information Set terminology and implementations can be based on
application specific logic (e.g., XPath and DOM are not required). {List:
Ferguson,
FTF1}
- The referencing model must be based on
XML Signature's Reference
Processing Model [XMLDSIG]
with the following two qualifications:
- As recommended by [XMLDSIG],
where a referencing mechanism supports transforms (
e.g.,
KeyRetreivalMethod
and Ciphertext URI
) any
fragment processing should be specified as part of the transform.
- Where a referencing mechanism (
e.g., DataReference
and
KeyReference
) does not support Transforms, applications
should support same-document XPointers '#xpointer(/)' and
'#xpointer(id("ID"))'.
This document defines the requirements for XML
Encryption, so it shouldn't include info from the specification meeting
these requirements.
- Transforms {WS}
- Encryption Transforms: The specification must not enable the
specification of additional transforms as part of encrypting and
decrypting data; transforms on data being encrypted/decrypted must be done
by the application. For example, compression could be done by compressing
the content and wrapping that data in an XML compression syntax and then
encrypted. {FTF1}
- Encryption and Signatures
- The specification must address recommended
approaches for use of
how to use XML Signature with XML
Encryption such that multiple parties may selectively encrypt and sign
portions of documents that might already be signed and encrypted. Without
this it may be extremely difficult for recipients to determine whether or
not to decrypt data prior to signature validation.
The interaction of encryption and signing is an application issue and
out of scope of the specification. {List:
Ashwood,
Hirsch, FTF1}
At this point
we should either remove the above or else remove all the other discussion about
combining encryption and signature. My vote is for removing the
above text.
- Applications have the following options:
- When data is encrypted, so is its Signature; consequently those
Signature you can see can be validated. (However, this
is not always easily accomplished with detached Signatures.){List:
Finney}
- Employ the "decrypt-except" signature transform, being developed as
a separate specification. It works as follows: during signature
transform processing, if you encounter a decrypt transform, decrypt all
encrypted content in the document except for those excepted by an
enumerated set of references. {List:
Maruyama,
FTF1}
- The encryption and XML processing should be
- Fast {List:
Ferguson}
- Memory efficient {List:
Ferguson}
- Work with tree and event based parsers {List:
Ferguson}
- The solution must work with arbitrary encryption algorithms, including
symmetric and asymmetric keys schemes as well as dynamic negotiation of keying
material. {prop1,prop2}
- The specification must specify or reference one mandatory to implement
algorithm for only the most common application scenarios.
- Stream Encryption Algorithms {FTF1}
- none
- Block Encryption Algorithms {FTF1}
- AES with CMS keylength is required to implement
- 3DES is required to implement -- this may be relaxed when AES as
matures.
- AES at other keylengths is optional to implement.
- Chaining Modes {FTF1}
- CBC (Cipher Block Chaining) with PKCS#5 padding is optional to
implement.
- Key Transport {FTF1}
- RSA-OEAP used with AES is required to implement.
- RSA-v1.5 used with 3DES is required to implement -- this may be
relaxed as AES matures.
- Key Agreement {FTF1}
- Diffie-Hellman is optional to implement
- Symmetric Key Wrap {FTF1}
- AES KeyWrap is mandatory -- when it's completely specified.
- CMS-KeyWrap Triple-DES and RC2 is required.
- Message Authentication {FTF1}
- AES/3DES with SHA1 is optional to implement.
- XML Signature [XMLDSIG]
is optional to implement.
- Canonicalization {FTF1}
- Canonical XML is required to implement.
- Compression {FTF1}
- none
Initialization Vector {FTF1}
?
I suggest we remove this section. Initialization vector requirements are algorithm
specific and they be discussed in that context, if necessary at all.
- Key Structures
- Scope: the only defined key structures must be those required by the
mandatory and recommended algorithms. {Reagle}
- The specification will not address how to specify the intended recipient
of keying information beyond an optional "hint" attribute. {prop3:
open issue 1, FTF1}
EnryptedKey
element should be a child of a
KeyInfo
element. {prop3,
FTF1}
The specification should leverage the XML Signature
specification's syntax for keying information (dsig:KeyInfo
element) to the maximum extent possible.
- Definitions:
The XML Encryption specification must include a discussion
of potential vulnerabilities and recommended practices when using the defined
processing model in a larger application context. While it is impossible
to predict all the ways an XML Encryption standard may be used, the discussion
should alert users to ways in which potentially subtle weaknesses might be
introduced.
At a minimum, the following types of vulnerabilities
shall be discussed.
The specification must address Security issues arising
from known plain-text and data length informationwhere the following
occur: {prop3:
issue 5} in software and hardware implementations {List:
Lambert
- An attacker may know the original structure of the plain-text via its
schema. {List:
Wiley}
- An attacker may know the length and redundancy of the plain-text data.
{List:
Finney}
- Processing of invalid decrypted data if an integrity
checking mechanism is not used in conjunction with encryption.
As already stated, the specification should provide for the optional
creation of a checksum over the data encrypted in the ciphertext. (This
enables an application to verify the success of the decryption process instead
of continuing to process data with the wrong key.) {List:
Lambert,
FTF1}
As already stated, The specification shall warn users about
Potential weaknesses
resulting from combining the order of signing and encryption operations.
- sign before you encrypt:{List:
Finney}
Weaknesses if a plaintext Hash (inside an XML
Signature) is provided along with the encrypted data. T
his can be problematic as, "the only way to achieve secure channels is to
encrypt first, then MAC. Though signature is different from MAC, but we
should keep in mind that digital signature is an extension of MAC."
{List:
Wang}
- encrypt before you sign: {List:
Wang}
Potential for fraud if one is induced to digitally
sign encrypted data that may not be what the user expected.
I
removed the “already
stated” language since I can't seem to find where it was discussed.
- The specification should warn application designers and users about
revealing information about the encrypted data
- in a signature over that data prior to encrypted.
- via any semantics inferred from a URI.
Signature order: The specification's Security
Considerations should address weaknesses resulting from:
Merged this item into #3 above.
sign before you encrypt:{List:
Finney}
This can be problematic as, "the only way to achieve secure channels is to
encrypt first, then MAC. Though signature is different from MAC, but we
should keep in mind that digital signature is an extension of MAC."
{List:
Wang}
I think I understand the above statement, but
isn't the issue the need for an integrity
mechanism combined with encryption? It certainly doesn't seem to be a
statement about vulnerabilities from signing before encryption
- encrypt before you sign: {List:
Wang}
This can be problematic as, "it was shown that by choosing your RSA key
pair, and keeping the factors of N, you could create many different
statements easily, with very real possibilities for fraud. {List:
Ashwood}
I’m not sure exactly what
the last sentence is saying.. If I
remember the relevant discussion thread, this was an issue related
to signing information without full knowledge of what is being
signed. I reworded to state this above. If I've misunderstood,
someone should rewrite to better explain the issue.
The XML Encryption specification should meet the requirements of (so as to
support) or work with the following applications:
To ensure the above requirements are adequately addressed, the XML Encryption
specification must be reviewed by a designated member of the following
communities:
- The specification should be free of encumbering technologies: requiring no
licensing fees for implementation and use. {List:
Ferguson}
"Members of the XML Encryption Working Group and any other Working Group
constituted within the XML Encryption Activity are expected to disclose any
intellectual property they have in this area. Any intellectual property
essential to implement specifications produced by this Activity must be at
least available for licensing on a royalty-free basis. At the suggestion of
the Working Group, and at the discretion of the Director of W3C, technologies
may be accepted if they are licensed on reasonable, non-discriminatory terms."
XML
Encryption Charter.
- C2000
- Crypto
2000 XML Encryption BoF. Santa Barbara, CA. August 24 .
- DOM
- Document Object Model Core, Level 3. Arnaud Le Hors. W3C Working
Draft.
http://www.w3.org/TR/DOM-Level-3-Core/core.html
- FTF1
- XML
Encryption Face-to-Face. Boston, MA. March 2000
- HP
- Requirements
and Goals for the Design of an 'XML Encryption Standard'. Gerald Huck and Arne Priewe. November 2000.
- InfoSet
- XML Information Set, W3C Working Draft. John Cowan.
http://www.w3.org/TR/xml-infoset.
- List
- XML
Encryption List (an unmoderated and unchartered public list).
- MyProof
- MyProof
Position Paper On XML Encryption
- prop1
- XML
Encryption strawman proposal. Ed Simon and Brian LaMacchia. Aug 09
2000.
- prop2
- Another
proposal of XML Encryption. Takeshi Imamura. Aug 14 2000.
- prop3
- XML
Encryption Syntax and Processing. Dillaway, Fox, Imamura, LaMacchia,
Maruyama, Schaad, Simon. December 2000.
- WS
- W3C XML
Encryption Workshop [minutes].
SanFrancisco. November 2, 2000.
- XML
- Extensible Markup Language (XML) 1.0 Recommendation. T. Bray, J. Paoli, C.
M. Sperberg-McQueen. February 1998.
- http://www.w3.org/TR/1998/REC-xml-19980210
- XML-C14N
- Canonical XML. Working Draft. J. Boyer. January 2001.
- http://www.w3.org/TR/2001/PR-xml-c14n-20010119
- XML-ns
- Namespaces in XML Recommendation. T. Bray, D. Hollander, A. Layman.
January 1999.
- http://www.w3.org/TR/1999/REC-xml-names-19990114/
- XML-schema
- XML Schema Part 1: Structures Working Draft. D. Beech, M. Maloney, N.
Mendelshohn. October 2000.
- http://www.w3.org/TR/2000/CR-xmlschema-1-20001024/
XML Schema Part 2: Datatypes Working Draft. P. Biron, A. Malhotra. October
2000.
- http://www.w3.org/TR/2000/CR-xmlschema-2-20001024/
- XMLDSIG
- XML-Signature Syntax and Processing. Working Draft. D. Eastlake, J.
Reagle, and D. Solo.
http://www.w3.org/TR/2000/CR-xmldsig-core-20001031/
- XSet
- Full Fidelity Information Set Representation. Jonathan Borden. XML-Dev
- http://lists.xml.org/archives/xml-dev/200008/msg00239.html
- URI
- RFC2396. Uniform Resource Identifiers (URI): Generic Syntax. T.
Berners-Lee, R. Fielding, L. Masinter. August 1998
http://www.ietf.org/rfc/rfc2396.txt
- MIME
- RFC2046. MIME Part Two: Media Types November
1996.
- http://rfc.net/rfc2046.html