Specification URIs:

This Version:

http://docs.oasis-open.org/ws-dd/dpws/1.1/cs-01/wsdd-dpws-1.1-spec-cs-01.html

http://docs.oasis-open.org/ws-dd/dpws/1.1/cs-01/wsdd-dpws-1.1-spec-cs-01.docx (Authoritative Format)

http://docs.oasis-open.org/ws-dd/dpws/1.1/cs-01/wsdd-dpws-1.1-spec-cs-01.pdf

Previous Version:

http://docs.oasis-open.org/ws-dd/dpws/1.1/cd-04/wsdd-dpws-1.1-spec-cd-04.html

http://docs.oasis-open.org/ws-dd/dpws/1.1/cd-04/wsdd-dpws-1.1-spec-cd-04.docx

http://docs.oasis-open.org/ws-dd/dpws/1.1/cd-04/wsdd-dpws-1.1-spec-cd-04.pdf

Latest Version:

http://docs.oasis-open.org/ws-dd/dpws/wsdd-dpws-1.1-spec.html

http://docs.oasis-open.org/ws-dd/dpws/wsdd-dpws-1.1-spec.docx

http://docs.oasis-open.org/ws-dd/dpws/wsdd-dpws-1.1-spec.pdf

Technical Committee:

OASIS Web Services Discovery and Web Services Devices Profile (WS-DD) TC

Chair(s):

Toby Nixon (Microsoft Corporation)

Alain Regnier (Ricoh Company Limited)

Editor(s):

Dan Driscoll (Microsoft Corporation)

Antoine Mensch

Declared XML Namespace(s):

http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01

Abstract:

This profile defines a minimal set of implementation constraints to enable secure Web service messaging, discovery, description, and eventing on resource-constrained endpoints.

Status:

This document was last revised or approved by the OASIS Web Services Discovery and Web Services Devices Profile (WS-DD) TC on the above date. The level of approval is also listed above. Check the “Latest Version” or “Latest Approved Version” location noted above for possible later revisions of this document.

Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at http://www.oasis-open.org/committees/ws-dd/.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/ws-dd/ipr.php.

The non-normative errata page for this specification is located at http://www.oasis-open.org/committees/ws-dd/.

Copyright © OASIS® 2009. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.

 

1        Introduction. 5

1.1 Requirements. 5

1.2 Terminology. 5

1.3 XML Namespaces. 7

1.4 XSD File. 7

1.5 Normative References. 7

1.6 Non-Normative References. 9

2        Messaging. 10

2.1 URI 10

2.2 UDP. 10

2.3 HTTP. 10

2.4 SOAP Envelope. 11

2.5 WS-Addressing. 11

2.6 Attachments. 12

3        Discovery. 13

4        Description. 15

4.1 Characteristics. 15

4.2 Hosting. 18

4.3 WSDL. 21

4.4 WS-Policy. 23

5        Eventing. 25

5.1 Subscription. 25

5.2 Subscription Duration and Renewal 27

6        Security. 28

6.1 Terminology. 28

6.2 Model 28

6.3 Endpoint Reference and xAddrs. 29

6.4 Credentials. 29

6.5 Discovery. 30

6.6 Secure Channel 30

6.7 Authentication. 32

6.8 Integrity. 33

6.9 Confidentiality. 33

7        Conformance. 34

Appendix A.       Acknowledgements. 35

Appendix B.       Constants. 37

Appendix C.       Declaring Discovery Types in WSDL. 38

Appendix D.       Example x.509.v3 Certificate. 39

Appendix E.       Revision History. 40

 

The Web services architecture includes a suite of specifications that define rich functions and that may be composed to meet varied service requirements. To promote both interoperability between resource-constrained Web service implementations and interoperability with more flexible client implementations, this profile identifies a core set of Web service specifications in the following areas:

• Sending secure messages to and from a Web service
• Dynamically discovering a Web service
• Describing a Web service
• Subscribing to, and receiving events from, a Web service

In each of these areas of scope, this profile defines minimal implementation requirements for compliant Web service implementations.

1.1 Requirements

This profile intends to meet the following requirements:

• Identify a minimal set of Web service specifications needed to enable secure messaging, dynamic discovery, description, and eventing.
• Constrain Web services protocols and formats so Web services can be implemented on peripheral-class and consumer electronics-class hardware.
• Define minimum requirements for compliance without constraining richer implementations.

1.2 Terminology

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC2119].

1.2.1 Notational Conventions

This specification uses the following syntax to define normative outlines for messages:

• The syntax appears as an XML instance, but values in italics indicate data types instead of literal values.
• Characters are appended to elements and attributes to indicate cardinality:
• "?" (0 or 1)
• "*" (0 or more)
• "+" (1 or more)
• The character "|" is used to indicate a choice between alternatives.
• The characters "(" and ")" are used to indicate that contained items are to be treated as a group with respect to cardinality or choice.
• The characters "[" and "]" are used to call out references and property names.
• Ellipses (i.e., "...") indicate points of extensibility. Additional children and/or attributes MAY be added at the indicated extension points but MUST NOT contradict the semantics of the parent and/or owner, respectively. By default, if a receiver does not recognize an extension, the receiver SHOULD ignore the extension; exceptions to this processing rule, if any, are clearly indicated below.
• XML namespace prefixes (see Table 1) are used to indicate the namespace of the element being defined.

This specification uses the [action] and Fault properties [WS-Addressing] to define faults.

Normative statements in this profile are called out explicitly as follows:

where "nnnn" is replaced by the statement number. Each statement contains exactly one requirement level keyword (e.g., "MUST") and one conformance target keyword (e.g., "MESSAGE").

1.2.2 Terms and Definitions

Figure 1: Arrangement of clients and devices

MESSAGE

Protocol elements that are exchanged, usually over a network, to affect a Web service. Always includes a SOAP ENVELOPE. Typically also includes transport framing information such as HTTP headers, TCP headers, and IP headers.

SOAP ENVELOPE

An XML Infoset that consists of a document information item [XML Infoset] with exactly one member in its [children] property, which MUST be the SOAP Envelope [SOAP 1.2] element information item.

MIME SOAP ENVELOPE

A SOAP ENVELOPE serialized using MIME Multipart Serialization [MTOM].

TEXT SOAP ENVELOPE

A SOAP ENVELOPE serialized as application/soap+xml.

CLIENT

A network endpoint that sends MESSAGEs to and/or receives MESSAGEs from a SERVICE.

SERVICE

A software system that exposes its capabilities by receiving and/or sending MESSAGEs on one or several network endpoints.

DEVICE

A distinguished type of SERVICE that hosts other SERVICEs and sends and/or receives one or more specific types of MESSAGEs.

HOSTED SERVICE

A distinguished type of SERVICE that is hosted by another SERVICE. The lifetime of the HOSTED SERVICE is a subset of the lifetime of its host. The HOSTED SERVICE is visible (not encapsulated) and is addressed separately from its host. Each HOSTED SERVICE has exactly one host. (The relationship is not transitive.)

SENDER

A CLIENT or SERVICE that sends a MESSAGE.

RECEIVER

A CLIENT or SERVICE that receives a MESSAGE.

1.3 XML Namespaces

The XML namespace URI that MUST be used be implementations of this specification is:

http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01

Table 1 lists XML namespaces that are used in this specification. The choice of any namespace prefix is arbitrary and not semantically significant.

Table 1: Prefixes and XML namespaces used in this specification.

Prefix	XML Namespace	Specification(s)
soap	http://www.w3.org/2003/05/soap-evelope	[SOAP 1.2]
wsa	http://www.w3.org/2005/08/addressing	[WS-Addressing]
wsd	http://docs.oasis-open.org/ws-dd/ns/discovery/2009/01	[WS-Discovery]
dpws	http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01	This profile
wsdl	http://schemas.xmlsoap.org/wsdl/	[WSDL 1.1]
wse	http://schemas.xmlsoap.org/ws/2004/08/eventing	[WS-Eventing]
wsp	http://www.w3.org/ns/ws-policy	[WS-Policy, WS-PolicyAttachment]
wsx	http://schemas.xmlsoap.org/ws/2004/09/mex	[WS-MetadataExchange]

1.4 XSD File

Dereferencing the XML namespace defined in Section 01.3

XML NamespacesXML Namespaces will produce the Resource Directory Description Language (RDDL) [RDDL] document that describes this namespace, including the XML Schema [XML Schema Part 1, 2] declarations associated with this specification.

1.5 Normative References

[RFC 2119]

S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.

[AES/TLS]

P.Chown, Advanced Encryption Standard (AES) Ciphersuites for Transport Layer Security (TLS), http://www.ietf.org/rfc/rfc3268.txt, IETF RFC 3268, June 2004.

[BP 1.1, Section 4]

K. Ballinger, et al, Basic Profile Version 1.1, Section 4: Service Description, http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html#description, August 2004.

[HTTP/1.1]

R.Fielding, et al, Hypertext Transfer Protocol -- HTTP/1.1, http://www.ietf.org/rfc/rfc2616.txt, IETF RFC 2616, June 1999.

[HTTP Authentication]

J. Franks, et al, HTTP Authentication: Basic and Digest Access Authentication, http://www.ietf.org/rfc/rfc2617.txt, IETF RFC 2617, June 1999.

[MIME]

N. Freed, et al, Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies, http://www.ietf.org/rfc/rfc2045.txt, IETF RFC 2045, November 1996.

[MTOM]

N. Mendelsohn, et al, SOAP Message Transmission Optimization Mechanism, http://www.w3.org/TR/2005/REC-soap12-mtom-20050125/, January 2005.

[RDDL]

Jonathan Borden, et al, Resource Directory Description Language (RDDL) 2.0, http://www.openhealth.org/RDDL/20040118/rddl-20040118.html, 18 January 2004.

[RFC 4122]       

P. Leach, et al, A Universally Unique IDentifier (UUID) URN Namespace, http://www.ietf.org/rfc/rfc4122.txt, IETF RFC 4122, July 2005.

[SHA]

Secure Hash Standard, http://csrc.nist.gov/publications/fips/fips180-3/fips180-3_final.pdf, October 2008.

[SOAP 1.2, Part 1]

M. Gudgin, et al, SOAP Version 1.2 Part 1: Messaging Framework, http://www.w3.org/TR/2007/REC-soap12-part1-20070427/, April 2007.  

[SOAP 1.2, Part 2]

M. Gudgin, et al, SOAP Version 1.2 Part 2: Adjuncts, Section 7: SOAP HTTP Binding, http://www.w3.org/TR/2007/REC-soap12-part2-20070427/#soapinhttp, April 2007.

[SOAP-over-UDP]

OASIS Public Review Draft 01, SOAP-over-UDP, http://docs.oasis-open.org/ws-dd/soapoverudp/1.1/pr-01/wsdd-soapoverudp-1.1-spec-pr-01.docx, 30 January 2009.

[TLS]

T. Dierks, et al, The TLS Protocol, Version 1.0, http://www.ietf.org/rfc/rfc2246.txt, IETF RFC 2246, January 1999.

[WS-Addressing]

W3C Recommendation, Web Services Addressing 1.0 - Core, http://www.w3.org/TR/2006/REC-ws-addr-core-20060509, 9 May 2006.

[WS-Addressing SOAP Binding]

W3C Recommendation, Web Services Addressing 1.0 - SOAP Binding, http://www.w3.org/TR/2006/REC-ws-addr-soap-20060509, 9 May 2006.

[WS-Discovery]

OASIS Public Review Draft 01, Web Services Dynamic Discovery (WS-Discovery), http://docs.oasis-open.org/ws-dd/discovery/1.1/pr-01/wsdd-discovery-1.1-spec-pr-01.docx, 30 January 2009.

[WSDL 1.1]

E. Christensen, et al, Web Services Description Language (WSDL) 1.1, http://www.w3.org/TR/2001/NOTE-wsdl-20010315, March 2001.

[WSDL Binding for SOAP 1.2]

K. Ballinger, et al, WSDL 1.1 Binding Extension for SOAP 1.2, http://www.w3.org/Submission/2006/SUBM-wsdl11soap12-20060405/, 5 April 2006.

[WS-Eventing]

D. Box, et al, Web Services Eventing (WS-Eventing), http://www.w3.org/Submission/2006/SUBM-WS-Eventing-20060315/, 15 March 2006.

[WS-MetadataExchange]

K. Ballinger, et al, Web Services Metadata Exchange 1.1 (WS-MetadataExchange), http://www.w3.org/Submission/2008/SUBM-WS-MetadataExchange-20080813/, 13 August 2008.  

[WS-Policy]

W3C Recommendation, Web Services Policy 1.5 - Framework, http://www.w3.org/TR/2007/REC-ws-policy-20070904/, 4 September 2007.

[WS-PolicyAttachment]

W3C Recommendation, Web Services Policy 1.5 - Attachment, http://www.w3.org/TR/2007/REC-ws-policy-attach-20070904/, 4 September 2007.

[WS-Transfer]

J. Alexander, et al, Web Service Transfer (WS-Transfer), http://www.w3.org/Submission/2006/SUBM-WS-Transfer-20060927/, 27 September 2006.

[X.509.v3]

ITU-T X.509.v3 Information technology - Open Systems Interconnection - The Directory: Public-key and attribute certificate frameworks (ISO/IEC/ITU 9594-8)

[XML Schema, Part 1]

W3C Recommendation, XML Schema Part 1: Structures Second Edition, http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/, 28 October 2004.

[XML Schema, Part 2]

W3C Recommendation, XML Schema Part 2: Datatypes Second Edition, http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/, 28 October 2004.

1.6 Non-Normative References

[IPv6 Autoconfig]

S. Thomson, et al, IPv6 Stateless Address Autoconfiguration, http://www.ietf.org/rfc/2462.txt, IETF RFC 2462, December 1998.

[DHCP]

R. Droms, et al, Dynamic Host Configuration Protocol, http://www.ietf.org/rfc/2131.txt, IETF RFC 2131, March 1997.

[XML Infoset]

J. Cowan, et al, XML Information Set (Second Edition), http://www.w3.org/TR/2004/REC-xml-infoset/20040204/, February 2004.

[WS-Security]

OASIS Standard Specification, Web Services Security: SOAP Message Security 1.1 (WS-Security 2004), http://docs.oasis-open.org/wss/v1.1/wss-v1.1-spec-os-SOAPMessageSecurity.pdf, 1 February 2006.

The scope of this section is the following set of Web services specifications. All of the requirements in these specifications are included by reference except where superseded by normative statements herein:

• [SOAP 1.2, Part 1]
• [SOAP 1.2, Part 2]
• [SOAP-over-UDP]
• [HTTP/1.1]
• [WS-Addressing]
• [RFC 4122]
• [MTOM]

It is assumed that a DEVICE has obtained valid IPv4 and/or IPv6 addresses that do not conflict with other addresses on the network. Mechanisms for obtaining IP addresses are out of the scope of this profile. For more information, see [DHCP] and [IPv6 Autoconfig].

2.1 URI

The constant MAX_URI_SIZE is defined in Appendix B -- Constants.

2.2 UDP

To improve reliability, a SERVICE should minimize the size of SOAP ENVELOPEs sent over UDP. However, some SOAP ENVELOPEs are larger than an MTU; for example, a signed Hello SOAP ENVELOPE. If a SOAP ENVELOPE is larger than an MTU, the underlying IP network stacks fragment and reassemble the UDP packet.

Unlike TCP or HTTP messages, UDP datagrams are received in one chunk, which may lead to excessive resource requirements when receiving large datagrams on small embedded systems. The constant MAX_UDP_ENVELOPE_SIZE is defined in Appendix B -- Constants.

2.3 HTTP

R0014 and R0015 relax requirements in [SOAP 1.2].

2.4 SOAP Envelope

Large SOAP ENVELOPEs are expected to be serialized using attachments.

2.5 WS-Addressing

Some underlying specifications (e.g., WS-Transfer [WS-Transfer]) explicitly allow other versions of WS-Addressing.  DPWS applications should rely solely on WS-Addressing 1.0.

Because the [address] property of an Endpoint Reference [WS-Addressing] is a SOAP-layer address, there is no requirement to use anything other than a UUID for the [address] property.

Use of other possible values of [address] by a HOSTED SERVICE is out of scope of this profile.

R0031 and R0041 ensure that messages with non-anonymous address in both the [reply endpoint] and the [fault endpoint] do not result in a fault being sent.

The SOAP HTTP Binding requires the Response Message SOAP ENVELOPE to be transmitted as the HTTP Response of the corresponding Request Message SOAP ENVELOPE.

Per WS-Addressing [WS-Addressing], a response SOAP ENVELOPE must include a wsa:RelatesTo SOAP ENVELOPE header block. Since “http://www.w3.org/2005/08/addressing/reply” is the default value for the [relationship] property, the RelationshipType attribute should be omitted from the wsa:RelatesTo SOAP ENVELOPE header block.

2.6 Attachments

The HTTP Transmission Optimization Feature implies support for the Optimized MIME Multipart Serialization and Abstract Transmission Optimization features.

Even for the SOAP Envelope, the "binary" Content-Transfer-Encoding mechanism is more appropriate than the "8bit" mechanism which is suitable only for data that may be represented as relatively short lines of at most 998 octets [MIME].

While DPWS-compliant services are required to support binary encoded MIME parts at a minimum, R0036 allows for them to support others (non-DPWS compliant clients) if they choose.  While a service might choose to support more than what is required in DPWS, a DPWS-compliant client cannot assume that the service it is interacting with supports anything beyond binary MIME parts.

Per MTOM, the root part of the MIME SOAP ENVELOPE contains an XML representation of the modified SOAP Envelope, with additional parts that contain binary representations of each attachment. This root part must be the first part so a RECEIVER does not have to buffer attachments.

The scope of this section is the following set of Web services specifications. All of the requirements in these specifications are included by reference except where superseded by normative statements herein:

• [WS-Discovery]

If a CLIENT and a SERVICE are not on the same subnet, the CLIENT may not be able to discover the SERVICE. However, if a CLIENT has an Endpoint Reference and transport address for a SERVICE through some other means, the CLIENT and SERVICE should be able to communicate within the scope of this profile.

If each SERVICE were to participate in WS-Discovery, the network traffic generated by a relatively small number of DEVICEs hosting a relatively small number of HOSTED SERVICEs could overwhelm a bandwidth-limited network. Therefore, only DEVICEs act as Target Services.

Including the dpws:Device Type indicates a DEVICE supports the Devices Profile, and indicates a CLIENT may retrieve metadata about the DEVICE and its relationship to any HOSTED SERVICEs using Get [WS-Transfer].

WS-Discovery acknowledges that a CLIENT may include reply information in UDP Probe and Resolve SOAP ENVELOPEs to specify a transport other than SOAP over UDP. However, to establish a baseline for interoperability, DEVICEs are required only to support UDP responses.

To support the scenario where a DEVICE has a known HTTP transport address, a CLIENT may send an ad-hoc Probe over HTTP to that address and expect to receive a ProbeMatches response, using the same message pattern as defined by the ProbeOp operation of the DiscoveryProxy portType in [WS-Discovery].  This requirement does not imply that the DEVICE must perform as a Discovery Proxy.

How the client obtains the DEVICE HTTP address is not defined in this specification, and this HTTP address does not necessarily relate to HOSTED SERVICE addresses.

A DEVICE MAY also listen for Directed Probes at http://<host address>:3702/.

DEVICEs MAY omit their Types and Scopes in their UDP WS-Discovery messages to reduce message size and prevent fragmentation.  However, they are obligated to return all Types and Scopes in their HTTP ProbeMatches messages as increased risk of packet loss due to fragmentation is not a consideration.

The scope of this section is the following set of Web services specifications. All of the requirements in these specifications are included by reference except where superseded by normative statements herein:

• [XML Schema Part 1, Part 2]
• [WSDL 1.1]
• [BP 1.1, Section 4]
• [WSDL Binding for SOAP 1.2]
• [WS-MetadataExchange]
• [WS-Policy]
• [WS-PolicyAttachment]
• [WS-Transfer]

A DEVICE acts primarily as a metadata resource for device-wide data, and for the HOSTED SERVICES on the device.  A CLIENT retrieves the XML representation of these characteristics by sending a WS-Transfer Get SOAP ENVELOPE to the DEVICE.  The resulting metadata contains characteristics of the device and topology information relating the DEVICE to its HOSTED SERVICEs.  WS-Transfer Get is used here because the device-wide metadata is the XML representation of the DEVICE.

CLIENTs may also retrieve metadata for individual HOSTED SERVICEs by sending a WS-MetadataExchange GetMetadata SOAP ENVELOPE to the HOSTED SERVICE.  The resulting metadata contains limited topology information about the HOSTED SERVICE, its hosting DEVICE, its WSDL, and any additional sections specific to the type of service.  GetMetadata is used here because the XML representation of the HOSTED SERVICE (possibly accessible with WS-Transfer Get) is not defined.

Through WSDL, this description also conveys the MESSAGEs a HOSTED SERVICE is capable of receiving and sending. Through WS-Policy, description conveys the capabilities and requirements of a HOSTED SERVICE, particularly the transports over which it may be reached and its security capabilities.

All metadata from the device should be contained in the wsx:Metadata element in the Get Response.

A DEVICE is not required to support all of the operations defined in [WS-Transfer].

4.1 Characteristics

To express DEVICE characteristics that are typically fixed across all DEVICEs of the same model by their manufacturer, this profile defines extensible ThisModel metadata as follows:

<dpws:ThisModel ...>

    <dpws:Manufacturer xml:lang="..."? >xs:string</dpws:Manufacturer>+

    <dpws:ManufacturerUrl>xs:anyURI</dpws:ManufacturerUrl>?

    <dpws:ModelName xml:lang="..."? >xs:string</dpws:ModelName>+

    <dpws:ModelNumber>xs:string</dpws:ModelNumber>?

    <dpws:ModelUrl>xs:anyURI</dpws:ModelUrl>?

    <dpws:PresentationUrl>xs:anyURI</dpws:PresentationUrl>?

    ...

</dpws:ThisModel>

The following describes additional, normative constraints on the outline above:

dpws:ThisModel/ dpws:Manufacturer

Name of the manufacturer of the DEVICE. It MUST have fewer than MAX_FIELD_SIZE Unicode characters, SHOULD be localized, and SHOULD be repeated for each supported locale.

dpws:ThisModel/ dpws:ManufacturerUrl

URL to a Web site for the manufacturer of the DEVICE. It MUST have fewer than MAX_URI_SIZE octets.

dpws:ThisModel/ dpws:ModelName

User-friendly name for this model of device chosen by the manufacturer. It MUST have fewer than MAX_FIELD_SIZE Unicode characters, SHOULD be localized, and SHOULD be repeated for each supported locale.

dpws:ThisModel/ dpws:ModelNumber

Model number for this model of DEVICE. It MUST have fewer than MAX_FIELD_SIZE Unicode characters.

dpws:ThisModel/ dpws:ModelUrl

URL to a Web site for this model of DEVICE. It MUST have fewer than MAX_URI_SIZE octets.

dpws:ThisModel/ dpws:PresentationUrl

URL to a presentation resource for this DEVICE. It MAY be relative to the HTTP transport address over which metadata was retrieved, and MUST have fewer than MAX_URI_SIZE octets.  If PresentationUrl is specified, the DEVICE MAY provide the resource in multiple formats, but MUST at least provide an HTML page.  CLIENTs and DEVICEs MAY use HTTP content negotiation [HTTP/1.1] to determine the format and content of the presentation resource.

DEVICEs that use a relative URL MAY use HTTP Redirection 3xx codes [HTTP/1.1] to direct CLIENTs to a dedicated web server running on another port.

CORRECT:

<dpws:ThisModel

      xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01" >

    <dpws:Manufacturer>ACME Manufacturing</dpws:Manufacturer>

    <dpws:ModelName xml:lang="en-GB" >ColourBeam 9</dpws:ModelName>

    <dpws:ModelName xml:lang="en-US" >ColorBeam 9</dpws:ModelName>

</dpws:ThisModel>

A Dialect [WS-MetadataExchange] equal to "http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/ThisModel" indicates an instance of the ThisModel metadata format.

No Identifier [WS-MetadataExchange] is defined for instances of the ThisModel metadata format.

Get [WS-Transfer] is the interoperable means for a CLIENT to retrieve the resource representation data for a DEVICE – which includes the ThisModel metadata for a DEVICE. A DEVICE MAY also provide other means for a CLIENT to retrieve its ThisModel metadata.

Caching for the ThisModel metadata is controlled by the wsd:MetadataVersion construct [WS-Discovery].

To express DEVICE characteristics that typically vary from one DEVICE to another of the same kind, this profile defines extensible ThisDevice metadata as follows:

<dpws:ThisDevice ...>

    <dpws:FriendlyName xml:lang="..."? >xs:string</dpws:FriendlyName>+

    <dpws:FirmwareVersion>xs:string</dpws:FirmwareVersion>?

    <dpws:SerialNumber>xs:string</dpws:SerialNumber>?

    ...

</dpws:ThisDevice>

The following describes additional, normative constraints on the outline above:

dpws:ThisDevice/dpws:FriendlyName

User-friendly name for this DEVICE. It MUST have fewer than MAX_FIELD_SIZE Unicode characters, SHOULD be localized, and SHOULD be repeated for each supported locale.

dpws:ThisDevice/dpws:FirmwareVersion

Firmware version for this DEVICE. It MUST have fewer than MAX_FIELD_SIZE Unicode characters.

dpws:ThisDevice/dpws:SerialNumber

Manufacturer-assigned serial number for this DEVICE. It MUST have fewer than MAX_FIELD_SIZE Unicode characters.

CORRECT:

<dpws:ThisDevice

      xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01" >

    <dpws:FriendlyName xml:lang="en-GB" >

      ACME ColourBeam Printer

    </dpws:FriendlyName>

    <dpws:FriendlyName xml:lang="en-US" >

      ACME ColorBeam Printer

    </dpws:FriendlyName>

</dpws:ThisDevice>

A Dialect [WS-MetadataExchange] equal to "http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/ThisDevice" indicates an instance of the ThisDevice metadata format.

No Identifier [WS-MetadataExchange] is defined for instances of the ThisDevice metadata format.

CORRECT:

<soap:Envelope

    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

    xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01"

    xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"

    xmlns:wsa="http://www.w3.org/2005/08/addressing" >

 <soap:Header>

  <wsa:Action>

    http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse

  </wsa:Action>

  <wsa:RelatesTo>

    urn:uuid:82204a83-52f6-475c-9708-174fa27659ec

  </wsa:RelatesTo>

  <wsa:To>

    http://www.w3.org/2005/08/addressing/anonymous

  </wsa:To>

 </soap:Header>

 <soap:Body>

  <wsx:Metadata>

   <wsx:MetadataSection

Dialect="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/ThisModel"

   >

    <dpws:ThisModel>

     <dpws:Manufacturer>ACME Manufacturing</dpws:Manufacturer>

     <dpws:ModelName xml:lang="en-GB" >

       ColourBeam 9

     </dpws:ModelName>

     <dpws:ModelName xml:lang="en-US" >

       ColorBeam 9

     </dpws:ModelName>

    </dpws:ThisModel>

   </wsx:MetadataSection>

   <wsx:MetadataSection

Dialect="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/ThisDevice"

   >

    <dpws:ThisDevice>

     <dpws:FriendlyName xml:lang="en-GB" >

       ACME ColourBeam Printer

     </dpws:FriendlyName>

     <dpws:FriendlyName xml:lang="en-US" >

       ACME ColorBeam Printer

     </dpws:FriendlyName>

    </dpws:ThisDevice>

   </wsx:MetadataSection>

 

   <!-- Other Metadata Sections omitted for brevity. -->

 

  </wsx:Metadata>

 </soap:Body>

</soap:Envelope>

Get [WS-Transfer] is the interoperable means for a CLIENT to retrieve the resource representation data for a DEVICE – which includes the ThisDevice metadata for a DEVICE. A DEVICE MAY also provide other means for a CLIENT to retrieve its ThisDevice metadata.

Caching for the ThisDevice metadata is controlled by the wsd:MetadataVersion construct [WS-Discovery].

4.2 Hosting

To express the relationship between a HOSTED SERVICE and its hosting DEVICE, this profile defines relationship metadata as follows:

<dpws:Relationship Type="xs:anyURI" ... >

 (<dpws:Host>

    <wsa:EndpointReference>endpoint-reference</wsa:EndpointReference>

    <dpws:Types>list of xs:QName</dpws:Types>?

    ...

  </dpws:Host>)?

 (<dpws:Hosted>

    <wsa:EndpointReference>endpoint-reference</wsa:EndpointReference>+

    <dpws:Types>list of xs:QName</dpws:Types>

    <dpws:ServiceId>xs:anyURI</dpws:ServiceId>

    ...

  </dpws:Hosted>)*

  ...

</dpws:Relationship>

The following describes additional, normative constraints on the outline above:

dpws:Relationship

This is a general mechanism for defining a relationship between two or more SERVICEs.

dpws:Relationship/@Type

The type of the relationship. The nature of the relationship and the content of the dpws:Relationship element are determined by this value. This value should be compared directly, as a case-sensitive string, with no attempt to make a relative URI into an absolute URI, to unescape, or to otherwise canonicalize it.

dpws:Relationship/@Type = "http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/host"

This is a specific, hosting relationship type to indicate the relationship between a HOSTED SERVICE and its hosting DEVICE. This relationship type defines the following additional content:

dpws:Relationship/dpws:Host

            This is a section describing a hosting DEVICE. At least one of ./dpws:Host or ./dpws:Hosted MUST be included.

dpws:Relationship/dpws:Host/wsa:EndpointReference

Endpoint Reference for the host, which includes the stable identifier for the host which MUST be persisted across re-initialization (see also R0005 and R0006). If ./dpws:Host is omitted, implied value is the Endpoint Reference of the DEVICE that returned this metadata in a Get Response SOAP ENVELOPE.

dpws:Relationship/dpws:Host/dpws:Types

Unordered set of Types implemented by the host. (See [WS-Discovery].) If omitted or ./dpws:Host is omitted, no implied value.

dpws:Relationship/dpws:Hosted

This is a section describing a HOSTED SERVICE. . It MUST be included by a DEVICE for each of its HOSTED SERVICEs. It MUST be included by a HOSTED SERVICE for itself. For the hosting relationship type, if a host has more than one HOSTED SERVICE, including one relationship that lists all HOSTED SERVICEs is equivalent to including multiple relationships that each list some subset of the HOSTED SERVICEs.

dpws:Relationship/dpws:Hosted/wsa:EndpointReference

Endpoint References for a HOSTED SERVICE.

dpws:Relationship/dpws:Hosted/dpws:Types

Unordered set of Types implemented by a HOSTED SERVICE.  All implemented Types SHOULD be included.

dpws:Relationship/dpws:Hosted/dpws:ServiceId

Identifier for a HOSTED SERVICE which MUST be persisted across re-initialization and MUST NOT be shared across multiple Hosted elements. ServiceId MUST be unique within a DEVICE. This value should be compared directly, as a case-sensitive string, with no attempt to make a relative URI into an absolute URI, to unescape, or to otherwise canonicalize it.

CORRECT:

<dpws:Relationship

    Type="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/host"

    xmlns:img="http://printer.example.org/imaging"

    xmlns:wsa="http://www.w3.org/2005/08/addressing"

    xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01" >

  <dpws:Hosted>

    <wsa:EndpointReference>

      <wsa:Address>http://172.30.184.244/print</wsa:Address>

    </wsa:EndpointReference>

    <dpws:Types>

      img:PrintBasicPortType img:PrintAdvancedPortType

    </dpws:Types>

    <dpws:ServiceId>

      http://printer.example.org/imaging/PrintService

    </dpws:ServiceId>

  </dpws:Hosted>

</dpws:Relationship>

A Dialect [WS-MetadataExchange] equal to "http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/Relationship" indicates an instance of the Relationship metadata format.

No Identifier [WS-MetadataExchange] is defined for instances of the Relationship metadata format.

Get [WS-Transfer] is the interoperable means for a CLIENT to retrieve the resource representation data for a DEVICE – which includes the relationship metadata for itself and HOSTED SERVICEs.

GetMetadata [WS-MetadataExchange] is the interoperable means for a CLIENT to retrieve metadata for a HOSTED SERVICE – which includes the relationship metadata for itself and its hosting DEVICE.

A DEVICE or HOSTED SERVICE MAY provide other means for a CLIENT to retrieve its relationship metadata.

CORRECT:

<soap:Envelope

    xmlns:gen="http://example.org/general"

    xmlns:img="http://printer.example.org/imaging"

    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

    xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01"

    xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"

    xmlns:wsa="http://www.w3.org/2005/08/addressing" >

  <soap:Header>

    <wsa:Action>

      http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse

    </wsa:Action>

    <wsa:RelatesTo>

      urn:uuid:82204a83-52f6-475c-9708-174fa27659ec

    </wsa:RelatesTo>

    <wsa:To>

      http://www.w3.org/2005/08/addressing/anonymous

    </wsa:To>

  </soap:Header>

  <soap:Body>

    <wsx:Metadata>

      <wsx:MetadataSection

        Dialect

      ="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/Relationship"

      >

        <dpws:Relationship

          Type="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/host" >

          <dpws:Hosted>

            <wsa:EndpointReference>

              <wsa:Address>http://172.30.184.244/print</wsa:Address>

            </wsa:EndpointReference>

            <wsa:EndpointReference>

              <wsa:Address>http://[fdaa:23]/print1</wsa:Address>

            </wsa:EndpointReference>

            <dpws:Types>

              img:PrintBasicPortType img:PrintAdvancedPortType

            </dpws:Types>

            <dpws:ServiceId>

              http://printer.example.org/imaging/PrintService

            </dpws:ServiceId>

          </dpws:Hosted>

          <dpws:Hosted>

            <wsa:EndpointReference>

              <wsa:Address>http://172.30.184.244/scan</wsa:Address>

            </wsa:EndpointReference>

            <wsa:EndpointReference>

              <wsa:Address>http://[fdaa:24]/scan</wsa:Address>

            </wsa:EndpointReference>

            <dpws:Types>img:ScanBasicPortType</dpws:Types>

            <dpws:ServiceId>

              http://printer.example.org/imaging/ScanService

            </dpws:ServiceId>

          </dpws:Hosted>

        </dpws:Relationship>

      </wsx:MetadataSection>

 

      <!-- Other Metadata Sections omitted for brevity. -->

 

    </wsx:Metadata>

  </soap:Body>

</soap:Envelope>

Caching for relationship metadata is controlled by the wsd:MetadataVersion construct [WS-Discovery].

Relationship metadata is intended to model fairly static relationships and should not change if a SERVICE becomes temporarily unavailable. As in the general case, any CLIENT attempting to contact such a SERVICE will need to deal with an Endpoint Unavailable Fault [WS-Addressing], connection refusal, or other network indication that the SERVICE is unavailable.

4.3 WSDL

R2004 relaxes R2303 in [BP 1.1, Section 4].

Because the document-literal SOAP Binding is more general than an rpc-literal SOAP Binding, there is no requirement to use anything other than the document-literal Binding.

Since this profile brings SOAP 1.2 into scope, it is sufficient to bind to that version of SOAP. There is no requirement to bind to other SOAP versions and thus R2028 updates R2401 in [BP 1.1, Section 4] to SOAP 1.2.

Addressing information for a HOSTED SERVICE is included in relationship metadata. For the mandatory SOAP 1.2 binding (R2019), there is no requirement to re-express this information in a WSDL Service and Port, since the endpoint reference used in the relationship metadata refers to this binding by default. The use of WSDL Services and Ports may still be necessary for other bindings not covered by this profile.

Statements R2023 and R2024 update R2724 and R2725 [BP 1.1, Section 4] to SOAP 1.2.

For clarity, separation of levels of abstraction, and/or reuse of standardized components, WSDL may be authored in a style that separates different elements of a Service Definition into separate documents which may be imported or included as needed. Each separate document may be available at the URL in the xs:include/@schemaLocation, xs:import/@schemaLocation, or wsdl:import/@location or may be included in a separate XML Schema or WSDL Metadata Section.

GetMetadata [WS-MetadataExchange] is the interoperable means for a CLIENT to retrieve metadata for a HOSTED SERVICE – which includes the WSDL for a HOSTED SERVICE. A HOSTED SERVICE MAY provide other means for a CLIENT to retrieve its WSDL.

There is no requirement for a HOSTED SERVICE to store its WSDL and include it in-line in a Get Response SOAP ENVELOPE. The WSDL may be stored at a different location, and the HOSTED SERVICE may include a reference to it in a Get Response SOAP ENVELOPE.

CORRECT:

<soap:Envelope

    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

    xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"

    xmlns:wsa="http://www.w3.org/2005/08/addressing" >

  <soap:Header>

    <wsa:Action>

      http://schemas.xmlsoap.org/ws/2004/09/mex/GetMetadata/Response   

    </wsa:Action>

    <wsa:RelatesTo>

      urn:uuid:82204a83-52f6-475c-9708-174fa27659ec

    </wsa:RelatesTo>

    <wsa:To>

      http://www.w3.org/2005/08/addressing/anonymous

    </wsa:To>

  </soap:Header>

  <soap:Body>

    <wsx:Metadata>

      <wsx:MetadataSection

          Dialect="http://schemas.xmlsoap.org/wsdl" >

        <wsx:MetadataReference>

          <wsa:Address>http://172.30.184.244/print</wsa:Address>

          <wsa:ReferenceParameters>

            <x:Acme xmlns:x="urn:acme.com:webservices">

              WSDL

            </x:Acme>

          </wsa:ReferenceParameters>

        </wsx:MetadataReference>

      </wsx:MetadataSection>

 

      <!-- Other Metadata Sections omitted for brevity. -->

 

    </wsx:Metadata>

  </soap:Body>

</soap:Envelope>

4.4 WS-Policy

To indicate that a SERVICE is compliant with this profile, this profile defines the following WS-Policy [WS-Policy] assertion:

<dpws:Profile wsp:Optional="true"? ... />

The following describes additional, normative constraints on the outline above:

dpws:Profile

Assertion indicating compliance with this profile is required. This assertion has Endpoint Policy Subject [WS-PolicyAttachment]: a policy expression containing this assertion MAY be attached to a wsdl:port, SHOULD be attached to a wsdl:binding, but MUST NOT be attached to a wsdl:portType; the latter is prohibited because the assertion specifies a concrete behavior whereas the wsdl:portType is an abstract construct.

dpws:Profile/@wsp:Optional="true"

Per WS-Policy [WS-Policy], this is compact notation for two policy alternatives, one with and one without the assertion. The intuition is that the behavior indicated by the assertion is optional, or in this case, that the SERVICE supports but does not require compliance with this profile.

CORRECT:

<wsp:Policy

    xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01"

    xmlns:wsp="http://www.w3.org/ns/ws-policy" >

  <dpws:Profile />

</wsp:Policy>

This assertion has Endpoint Policy Subject: a policy expression containing this assertion MAY be attached to a wsdl:port, SHOULD be attached to a wsdl:binding, but MUST NOT be attached to a wsdl:portType; the latter is prohibited because this assertion specifies concrete behavior whereas the wsdl:portType is an abstract construct.

Because all components in WSDL are extensible via elements [BP 1.1, Section 4], attachment using wsp:PolicyReference/@URI is sufficient.

Get [WS-Transfer] is the interoperable means for a CLIENT to retrieve attached policy.

CORRECT:

<soap:Envelope

  xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

  xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01"

  xmlns:wsp="http://www.w3.org/ns/ws-policy"

  xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"

  xmlns:wsa="http://www.w3.org/2005/08/addressing" >

 <soap:Header>

  <wsa:Action>

    http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse

  </wsa:Action>

  <wsa:RelatesTo>

    urn:uuid:82204a83-52f6-475c-9708-174fa27659ec

  </wsa:RelatesTo>

  <wsa:To>

    http://www.w3.org/2005/08/addressing/anonymous

  </wsa:To>

 </soap:Header>

 <soap:Body>

  <wsx:Metadata>

   <wsx:MetadataSection

     Dialect="http://schemas.xmlsoap.org/wsdl/" >

    <wsdl:definitions

      targetNamespace="http://acme.example.com/colorbeam"

      xmlns:image="http://printer.example.org/imaging" >

     <wsp:Policy wsu:Id="DpPolicy" >

      <dpws:Profile />

     </wsp:Policy>

 

     <!-- Other WSDL components omitted for brevity. -->

 

     <wsdl:binding name="PrintBinding" type="image:PrintPortType" >

       <wsp:PolicyReference URI="#DpPolicy"

           wsdl:required="true" />

       <!-- Other WSDL components omitted for brevity. -->

     </wsdl:binding>

    </wsdl:definitions>

   </wsx:MetadataSection>

 

   <!-- Other Metadata Sections omitted for brevity. -->

 

  </wsx:Metadata>

 </soap:Body>

</soap:Envelope>

The scope of this section is the following set of Web services specifications. All of the requirements in these specifications are included by reference except where superseded by normative statements herein:

• [WS-Eventing]

5.1 Subscription

The Push Delivery Mode [WS-Eventing] is the default Delivery Mode and indicates the Event Source (HOSTED SERVICE) will push Notifications to the Event Sink (CLIENT).

R3017 and R3018 do not ensure that a HOSTED SERVICE can contact an event sink, but they do provide a mechanism for the event source to fault on unsupported URI schemes or addresses it knows it cannot contact.

R5003 allows a client to distinguish between a SOAP Fault generated due to an unreachable [destination] information header in the Subscribe message, and a SOAP Fault generated due to an unreachable NotifyTo or EndTo address.

5.1.1 Filtering

To enable subscribing to one or more Notifications exposed by a HOSTED SERVICE, this profile defines a Filter Dialect designated "http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/Action".

• A Filter in this Dialect contains a white space-delimited list of URIs that indicate the [action] property of desired Notifications.
• The content of a Filter in this Dialect is defined as xs:list/@itemType="xs:anyURI" [XML Schema Part 2].
• A Filter in this Dialect evaluates to true for an Output Message of a Notification or Solicit-Response operation if and only if a URI in the Filter matches the [action] property of the Message using the "http://docs.oasis-open.org/ws-dd/ns/discovery/2009/01/rfc3986" matching rule [WS-Discovery].
• A Filter in this Dialect with no URIs specified will always evaluate to false for all messages.

The Action Dialect uses the RFC 3986 prefix matching rule so CLIENTs can subscribe to a related set of Notifications by including the common prefix of the [action] property of those Notifications. Typically, the Notifications within a WSDL portType [WSDL 1.1] will share a common [action] property prefix, and specifying that prefix with the Action Dialect will be a convenient means to subscribe to all Notifications defined by a portType.

CORRECT:

<soap:Envelope

  xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

  xmlns:wsa="http://www.w3.org/2005/08/addressing"

  xmlns:wse="http://schemas.xmlsoap.org/ws/2004/08/eventing" >

 <soap:Header>

  <wsa:Action>

    http://schemas.xmlsoap.org/ws/2004/08/eventing/Subscribe

  </wsa:Action>

  <wsa:MessageID>

    urn:uuid:314bea3b-03af-47a1-8284-f495497f1e33

  </wsa:MessageID>

  <wsa:ReplyTo>

   <wsa:Address>

     http://www.w3.org/2005/08/addressing/anonymous

   </wsa:Address>

  </wsa:ReplyTo>

  <wsa:To>http://172.30.184.244/print</wsa:To>

 </soap:Header>

 <soap:Body>

  <wse:Subscribe>

   <wse:Delivery>

    <wse:NotifyTo>

     <wsa:Address>

       urn:uuid:3726983d-02de-4d41-8207-d028ae92ce3d

     </wsa:Address>

    </wse:NotifyTo>

   </wse:Delivery>

   <wse:Expires>PT10M</wse:Expires>

   <wse:Filter

Dialect="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/Action"

   >

http://printer.example.org/imaging/PrintBasicPortType/JobEndState

http://printer.example.org/imaging/PrintBasicPortType/PrinterState

   </wse:Filter>

  </wse:Subscribe>

 </soap:Body>

</soap:Envelope>

A HOSTED SERVICE is required to support filtering, at least by [action], so the Filtering Not Supported SOAP Fault is not appropriate.

To indicate that a HOSTED SERVICE does not expose any Notifications that would match the contents of a Filter with the Action Dialect, this profile defines the following SOAP Fault:

[action]	http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01/fault
[Code]	Soap:Sender
[Subcode]	dpws:FilterActionNotSupported
[Reason]	E.g., “no notifications match the supplied filter”
[Detail]	(None defined.)

5.2 Subscription Duration and Renewal

Event Sources are required to have an internal clock, but there is no requirement that the clock be synchronized with clients or other HOSTED SERVICEs. Event Sources are only required to support Expirations expressed in duration, but they should attempt to match the type of the Subscription Expiration when possible.  If the value or type of the Expiration is unacceptable, the Event Source MAY select an appropriate Expiration and return it in the Subscribe Response or Renew Response.

Event Sources are not required to support retrieving subscription status.

This section defines a RECOMMENDED baseline for interoperable security between a DEVICE and a CLIENT. A DEVICE (or CLIENT) is free to support other security mechanisms, and alternate profiles may be developed to accommodate different deployment requirements.  The use of alternate profiles may be indicated by WSDL [WSDL 1.1], policies [WS-Policy], or by other means.

In the absence of an explicit indication stating that a different security mechanism is to be used, the default security mechanism is determined by the transport addresses of the DEVICE: HTTP transport addresses (URLs) indicate the device supports no security, and HTTPS transport addresses indicate the device supports the security profile defined in this section.

A DEVICE may support more than one security profile, but security technologies do not always compose in a way that results in interoperability.  Implementers of multiple security profiles should take care to preserve interoperability with each profile individually.

All requirements and recommendations in this section are conditional on the SERVICE or CLIENT implementing this security profile.  If a SERVICE or CLIENT does not implement the profile defined in this section, it is not obligated to follow any of the requirements defined herein.

This scope of this section is the following set of Web services specifications. All of the requirements in these specifications are included by reference except where superseded by normative statements herein:

• [AES/TLS]
• [HTTP Authentication]
• [SHA]
• [TLS]
• [RFC 4122]
• [X.509.v3]
• [WS-Discovery]

6.1 Terminology

Compact Signature

A WS-Discovery Compact Signature [WS-Discovery] is evidence of authenticity of the unencrypted contents of a WS-Discovery message.  The Compact Signature is included inside the unencrypted message.

Secure Channel

A Secure Channel is a point-to-point transport-level TLS/SSL connection established between a CLIENT and a SERVICE.  Messages transmitted through a Secure Channel receive some security protection, but that protection does not extend beyond the CLIENT and SERVICE that established the channel.

Certificate

An x.509.v3 Certificate [x.509.v3] is a cryptographic credential that a SERVICE or a CLIENT use for authentication.  When a SERVICE or a CLIENT receives a Certificate from another entity, it may inspect the contents to ensure they are valid credentials.

6.2 Model

The security profile defined in this section has two parts: optional message-level signatures for UDP WS-Discovery traffic, and transport-level encryption.  Transport-level encryption is mandatory for metadata and is optional for control traffic.

WS-Discovery Compact Signatures allow a CLIENT to verify the integrity of multicast or unicast WS-Discovery messages, and to identify WS-Discovery traffic that was signed by a DEVICE with a specific cryptographic credential.

TLS/SSL is used to establish a point-to-point Secure Channel between a CLIENT and a DEVICE, and provides a mechanism for each participant to authenticate the identity of the other, and to verify the integrity of the exchanged messages.  It also provides confidentiality for all messages sent in the Secure Channel established between the CLIENT and the DEVICE.

A DEVICE uses an x.509.v3 certificate as its credential, and it uses this credential to sign WS-Discovery messages and to establish TLS/SSL connections.  A DEVICE may require CLIENT authentication in the form of x.509.v3 certificates negotiated in the TLS/SSL connection, or username/password credentials communicated through HTTP Authentication after the TLS/SSL connection is established.

A DEVICE uses TLS/SSL to secure its HTTP traffic, and HOSTED SERVICES may also use TLS/SSL to secure their HTTP traffic.  A DEVICE may use a physical HTTPS address, or a logical address and HTTPS xAddrs.  If a DEVICE and its HOSTED SERVICEs are all reachable at the same address and port, a CLIENT and DEVICE may reuse a TLS/SSL connection for multiple operations.

 

Figure 2: Communication mechanisms for authentication information and for encrypted messages

The organization of CLIENT and DEVICE credentials, mechanism for provisioning them, and criteria for distinguishing valid and invalid credentials is out of scope of this profile.

6.3 Endpoint Reference and xAddrs

A DEVICE is prohibited from advertising non-secure HTTP transport addresses.  It may advertise a logical Endpoint Reference Address and HTTPS xAddrs, or a physical HTTPS transport address for its Enpoint Reference Address.

A DEVICE may have secure HOSTED SERVICEs, non-secure HOSTED SERVICEs, neither, or both.  Secure HOSTED SERVICEs must comply with the requirements for secure SERVICEs in this section.

6.4 Credentials

Restrictions in further subsections require that a DEVICE have an x.509.v3 certificate.  R4043 recommends that this certificate is unique.

The Certificate contains information pertinent to the specific device including its public key. Typically, certificates are issued by a trusted authority or a delegate (2nd tier) or a delegate of the delegate.

See Appendix D for an example x.509.v3 certificate.

Provisioning of credentials, definition of valid credentials, and certificate management are out of the scope of this profile.

For example, a SERVICE may only allow CLIENTs whose IP address exists in a preconfigured list.

6.5 Discovery

6.5.1 WS-Discovery Compact Signatures

WS-Discovery Compact Signatures use WS-Security [WS-Security] to generate a cryptographic signature that can be used by a CLIENT to verify the validity of the unencrypted message.

In cases where CLIENTs persist enough information about the credentials and presence of security on a DEVICE to protect against impersonation, the DEVICE may not sign its discovery messages.

Messages signed with WS-Discovery Compact Signatures must also meet the requirements in sections 6.7 Authentication and 6.8 Integrity.

6.6 Secure Channel

A TLS/SSL Secure Channel at the transport level is used to secure traffic between CLIENT and SERVICE.

As described in R1015, a CLIENT MAY send a Probe over HTTP; this Probe and ProbeMatches are sent using the Secure Channel.

Secure Channels must also meet the minimum requirements in sections 6.7 Authentication, 6.8 Integrity, and 6.9 Confidentiality.

6.6.1 TLS/SSL Ciphersuites

Where appropriate, DEVICEs are encouraged to support additional Ciphersuites that rely on more robust security technology, such as the SHA-2 [SHA] family of hashing standards.

6.6.2 SERVICE Authentication in a Secure Channel

X.509.v3 certificates are the only mechanism for a CLIENT to authenticate a DEVICE or a HOSTED SERVICE (if TLS/SSL is supported on that HOSTED SERVICE).

6.6.3 CLIENT Authentication in a Secure Channel

A DEVICE may authenticate a CLIENT by negotiating and x.509.v3 certificate, or by requesting a username and password communicated over HTTP Authentication inside the Secure Channel.

X.509.v3 certificates are the preferred mechanism for authenticating a CLIENT.

6.6.3.1 CLIENT Authentication with x.509.v3 certificates

6.6.3.2 CLIENT Authentication with HTTP Authentication

In cases where x.509.v3 client certificates are unavailable or where validation is infeasible, the DEVICE may use HTTP Authentication [HTTP/1.1] to request client credentials.

HTTP authentication requires credentials in the form of username and password. It is assumed that how the CLIENT and SERVICE share knowledge of the username and password is out-of-band and beyond the scope of this profile.

Because the authentication is performed over the Secure Channel established during TLS/SSL handshake and after the CLIENT has authenticated the SERVICE, HTTP Basic authentication may be used safely.

R4048 avoids the need for HTTP authentication for subsequent connections.

The username is supplied to the SERVICE during HTTP authentication and MAY be used for establishing multiple access control classes, such as administrators, users, and guests. The naming and use of username is implementation-dependent and out of the scope of this profile.

The purpose of the PIN / password is to authenticate the CLIENT to the DEVICE during the HTTP authentication.

6.7 Authentication

Authentication is the process by which the identity of the sender is determined by the recipient. Authentication MUST adhere to the following requirements:

In this profile, authentication is done using certificates or a combination of certificates and HTTP authentication. If multicast messages are secured, the following additional requirements apply:

Credentials MAY be cached on the DEVICE and/or CLIENT to simplify subsequent authentications.

6.8 Integrity

Integrity is the process that protects MESSAGEs against tampering while in transit. Integrity MUST adhere to the following requirements:

In this profile, the integrity of UDP discovery SOAP ENVELOPEs is protected using message-level signatures, while the integrity of other MESSAGEs is protected using a Secure Channel.

6.9 Confidentiality

Confidentiality is the process by which sensitive information is protected against unauthorized disclosure while in transit. Confidentiality MUST adhere to the following requirements:

In this profile, UDP WS-Discovery MESSAGEs are not treated as confidential.  Confidential MESSAGEs are encrypted using a Secure Channel.

An endpoint is expected to implement at least one of the roles defined herein (DEVICE, CLIENT, or HOSTED SERVICE) and MAY implement more than one of the roles.  An endpoint is not compliant with this specification if it fails to satisfy one or more of the MUST or REQUIRED level requirements defined herein for the roles it implements.

Normative text within this specification takes precedence over normative outlines, which in turn take precedence over the XML Schema [XML Schema Part 1, Part 2] descriptions, which in turn take precedence over examples.

The following individuals have participated in the creation of this specification and are gratefully acknowledged:

Participants:

Geoff Bullen, Microsoft Corporation

Steve Carter, Novell

Dan Conti, Microsoft Corporation

Doug Davis, IBM

Scott deDeugd, IBM

Oliver Dohndorf, Technische Universitat Dortmund
Dan Driscoll, Microsoft Corporation
Colleen Evans, Microsoft Corporation
Max Feingold, Microsoft Corporation
Travis Grigsby, IBM
Francois Jammes, Schneider Electric
Ram Jeyaraman, Microsoft Corporation
Mike Kaiser, IBM
Supun Kamburugamuva, WSO2
Devon Kemp, Canon Inc.
Akira Kishida, Canon Inc.
Jan Krueger, Technische Universitaet Dortmund
Mark Little, Red Hat
Dr. Ingo Lueck, Technische Universitaet Dortmund
Jonathan Marsh, WSO2
Carl Mattocks
Antoine Mensch
Jaime Meritt, Progress Software
Vipul Modi, Microsoft Corporation
Anthony Nadalin, IBM
Tadahiro Nakamura, Canon Inc.
Masahiro Nishio, Canon Inc.
Toby Nixon, Microsoft Corporation
Shin Ohtake, Fuji Xerox Co., Ltd.
Venkat Reddy, CA

Alain Regnier, Ricoh Company, Ltd.
Hitoshi Sekine, Ricoh Company, Ltd.
Yasuji Takeuchi, Konica Minolta Business Technologies
Hiroshi Tamura, Ricoh Company, Ltd.
Minoru Torii, Canon Inc.
Asir S Vedamuthu, Microsoft Corporation
David Whitehead, Lexmark International Inc.
Don Wright, Lexmark International Inc.
Prasad Yendluri, Software AG, Inc.
Elmar Zeeb, University of Rostock
Gottfried Zimmermann

 

Co-developers of the initial contributions:

This document is based on initial contributions to the OASIS WS-DD Technical Committee by the follow co-developers:

Shannon Chan, Microsoft Corporation

Dan Conti, Microsoft Corporation

Chris Kaler, Microsoft Corporation

Thomas Kuehnel, Microsoft Corporation

Alain Regnier, Ricoh Company Limited

Bryan Roe, Intel Corporation

Dale Sather, Microsoft Corporation

Jeffrey Schlimmer, Microsoft Corporation (Editor)

Hitoshi Sekine, Ricoh Company Limited

Jorgen Thelin, Microsoft Corporation (Editor)

Doug Walter, Microsoft Corporation

Jack Weast, Intel Corporation

Dave Whitehead, Lexmark International Inc.

Don Wright, Lexmark International Inc.

Yevgeniy Yarmosh, Intel Corporation

The following constants are used throughout this profile. The values listed below supersede other values defined in other specifications listed below.

Constant	Value	Specification
APP_MAX_DELAY	2,500 milliseconds	[WS-Discovery]
DISCOVERY_PORT	3702	[WS-Discovery]
MATCH_TIMEOUT	10 seconds	[WS-Discovery]
MAX_ENVELOPE_SIZE	32,767 octets	This profile
MAX_UDP_ENVELOPE_SIZE	4,096 octets	This profile
MAX_FIELD_SIZE	256 Unicode characters	This profile
MAX_URI_SIZE	2,048 octets	This profile
MULTICAST_UDP_REPEAT	1	[SOAP-over-UDP]
UDP_MAX_DELAY	250 milliseconds	[SOAP-over-UDP]
UDP_MIN_DELAY	50 milliseconds	[SOAP-over-UDP]
UDP_UPPER_DELAY	450 milliseconds	[SOAP-over-UDP]
UNICAST_UDP_REPEAT	1	[SOAP-over-UDP]

Solutions built on DPWS often define portTypes implemented by Hosted Services, and a discovery-layer portType implemented by the Host Service so the presence of these functional services can be determined at the discovery layer.  The binding between a service-layer type and its discovery-layer type can be defined purely in descriptive text, but this appendix provides an optional mechanism to declare a discovery-layer type inside WSDL that can be consumed and understood by tools.

This appendix defines an @dpws:DiscoveryType attribute to annotate the WSDL 1.1 portType [WSDL 1.1] for the service-layer type.  The normative outline for @dpws:DiscoveryType is:

<wsdl:definitions …>

    [<wsdl:portType [dpws:DiscoveryType="xs:QName"]? >

        …

    </wsdl:portType>]*

</wsdl:definitions>

The following describes additional, normative constraints to the outline listed above:

/wsdl:definitions/wsdl:portType/@dpws:DiscoveryType

The name of the portType to be advertised by the Host Service to indicate that this device supports the annotated Hosted Service portType.

If omitted, no implied value

This mechanism is only suitable in cases where a functional service type is bound to a single discovery-layer type, and authors of more complex type topologies may express the relationship between service and discovery types through normative text or through other means.

Example usage follows.  PrintDeviceType is the discovery-layer type for PrintPortType.

<wsdl:definitions

    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

    xmlns:dpws="http://docs.oasis-open.org/ws-dd/ns/dpws/2009/01"

    targetNamespace="http://printer.example.com/imaging"

    xmlns:tns="http://printer.example.com/imaging">

 

    <wsdl:portType name="PrintPortType"

        dpws:DiscoveryType="tns:PrintDeviceType">

 

        <!-- Contents omitted for brevity -->

 

    </wsdl:portType>

 

    <!-- Define PrintDeviceType to be empty -->

    <wsdl:portType name="PrintDeviceType" />

 

</wsdl:definitions>

An example of a self-signed X.509 certificate is shown below.  In this case, the Subject field contains the UUID in string representation format (i.e., not represented numerically).

Type	Element	Usage	Example
Basic Elements	Version	TLS	3
	Certificate Serial Number		1234567
	Certificate Algorithm Identifier		RSA
	Issuer		a7731471-4b54-4a64-942c-7d481dcb9614
	Validity Period		11/09/2001 - 01/07/2015
	Subject		a7731471-4b54-4a64-942c-7d481dcb9614
	Subject Public Key Information		rsaEncryption 1024 10888232e76740bd873462ea2c64ca1d a6f9112656a34b949d32cede0e476547 84ba0f7e62e143429d3217ee45ce5304 308e65a6eee6474cb4d9a3c0295c8267 761661ccba7546a09d5f03a8ea3b1160 dac9fb6e6ba94e54b6c8ee892e492f4c e3a96bbd9d7b4c4bb98b7c052ff361ba cee01718122c4f0d826efc123bb1b03d
Extensions	Extended Key Usage	Server Authentication	1.3.6.1.5.5.7.3.1
		Client Authentication	1.3.6.1.5.5.7.3.2
Signature	Certificate Authority’s Digital Signature		5938f9908916cca32321916a184a6e75 2becb14fb99c4f33a03b03c3c752117c 91b8fb163d3541fca78bca235908ba69 1f7e36004a2d499a8e23951bd8af961d 36be05307ec34467a7c66fbb7fb5e49c 25e8dbdae4084ca9ba244b5bc1a377e5 262b9ef543ce47ad8a6b1d28c9138d0a dc8f5e3b469e42a5842221f9cf0a50d1

 

 

Revision	Date	Editor	Changes Made
wd-01	09/16/2008	Dan Driscoll	Converted input specification to OASIS template.
wd-02	10/08/2008	Dan Driscoll	Resolved the following issues: 001: Clarify R4032 and R4036 w.r.t. other multicast bindings 002: Define matching for empty Action filter 003: Fault Action should use lowercase ‘f’ 004: Faulting to non-anonymous endpoints 005: SOAP Binding should apply to clients 013: Restrict encoding of SOAP messages to UTF-8 016: Edit R0042 028: Review constants 045: EndpointReference subelement 061: Assign an OASIS namespace for the specifications
wd-02	10/14/2008	Dan Driscoll	Changed document format from doc to docx Fixed “authoritative reference”
wd-02	10/14/2008	Dan Driscoll	Changed version number to 1.1 Removed “related work” section
wd-02	10/14/2008	Dan Driscoll	Changed copyrights from 2007 to 2008
wd-03	12/12/2008	Dan Driscoll	Changed draft from cd-01 to wd-03 Updated dates to 2008/12/12 Updated namespace to 2009/01 Issue 098: Update namespace Editorial: Changed ‘wsdp’ prefix to ‘dpws’
wd-03	12/12/2008	Dan Driscoll Antoine Mensch	011: Fix SERVICE terminology 015: Remove R0007 024: Fix Directed Discovery 029: Fix SERVICE/DEVICE for WS-Policy 038: Contents of Host EPR 039: Recursive hosting 055: WS-Addressing 1.0 070: HTTP content negotiation for PresentationUrl 071: Update to WS-Policy 1.5 073: Clarify “stable” identifier 074: Clarify R0036/R0037 075: Clarify “Target Service” 077: Remove R3010 as redundant 080: Secure all WS-A headers 084: Faulting behavior on Subscribe 085: Get/GetMetadata 092: Split R3019 093: Remove R3012 094: Clean up expiration type/value switching 095: Clarify expiration value switching 109: Update references
wd-03	1/2/2009	Dan Driscoll	032: Describe security composability 051: Generalize security 112: Remove WS-Security reference 113: Cleanup Network Model 114: Remove security negotiation 115: Replace R4070 with switches on HTTPS ID/xAddrs 138: Create introduction and concrete description of security profile 139: Remove protocol negotiation 140: Clean up HTTP Authentication
wd-03	1/21/2009	Antoine Mensch	Issue 012 Issue 040 Issue 046 Issue 117 Issue 127 Issue 128 Issue 135 Issue 143
cd-02 Candidate	1/21/2009	Dan Driscoll	Changed draft from wd-03 to cd-02 Updated date, copyrights Updated WS-Discovery and SOAP-over-UDP references to CD-02 072: Fix HOSTEDSERVICE 083: Fix R0031 and wsa:ReplyTo 130: Make FilterActionNotSupported recommended, not mandatory 132: Define relative PresentationUrl 134: Make Types/Scopes mandatory in directed ProbeMatches 137: Add Appendix C More security edits (see Section 7)
cd-02 Candidate	1/26/2009	Dan Driscoll	Fixed WS-DD committee site links Added TC participants to Appendix A; remove company names to meet OASIS rules Removed “Last Approved Version”
cd-02	1/27/2009	Dan Driscoll	Updated to reflect CD-02 status
pr-01	1/30/2009	Dan Driscoll	Updated to reflect PR-01 status
wd-04	2/10/2009	Dan Driscoll	Changed draft from PR-01 to WD-04 Updated references to WS-Discovery and SOAP-over-UDP
wd-04	2/11/2009	Dan Driscoll	150: Add pointer to RDDL and XSD 151: Reorder terminology section Reformat references section Reformat appendix headers Add missed internal hyperlinks
wd-04	2/20/2009	Dan Driscoll	147: Add URL for Directed Probe 154: Fix R0031 155: Update XML schema references
wd-05	2/25/2009	Dan Driscoll	148: Reorganize security section
wd-06	4/9/2009	Dan Driscoll	Updated draft from WD-05 to WD-06 Update list of TC participants Pr007.1: review non-normative RFC2119 keywords Pr007.2: cross-reference roles to terms/definitions Pr007.4: Update conformance section
cd-03	4/14/2009	Dan Driscoll	Updated to reflect CD-03 status
cd-04	4/28/2009	Dan Driscoll	Updated to reflect CD-04 status