Remote Experience Advertisement Protocol

[MS-RXAD]: Remote Experience Advertisement ProtocolIntellectual Property Rights Notice for Open Specifications Documentation § Technical Documentation. Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. § Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. § No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation. § Patents. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting [email protected]. § License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map. § Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit www.microsoft.com/trademarks. § Fictitious Names. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.1 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. Support. For questions and support, please contact [email protected]. 2 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Revision Summary Revision Revision Date History Class Comments11/6/2009 0.1 Major First Release.12/18/2009 0.1.1 Editorial Changed language and formatting in the technical content.1/29/2010 0.2 Minor Clarified the meaning of the technical content.3/12/2010 0.2.1 Editorial Changed language and formatting in the technical content.4/23/2010 0.2.2 Editorial Changed language and formatting in the technical content.6/4/2010 0.2.3 Editorial Changed language and formatting in the technical content.No changes to the meaning, language, or formatting of the 7/16/2010 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 8/27/2010 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 10/8/2010 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 11/19/2010 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 1/7/2011 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 2/11/2011 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 3/25/2011 0.2.3 None technical content.No changes to the meaning, language, or formatting of the 5/6/2011 0.2.3 None technical content.6/17/2011 0.3 Minor Clarified the meaning of the technical content.No changes to the meaning, language, or formatting of the 9/23/2011 0.3 None technical content.12/16/2011 1.0 Major Updated and revised the technical content.No changes to the meaning, language, or formatting of the 3/30/2012 1.0 None technical content.No changes to the meaning, language, or formatting of the 7/12/2012 1.0 None technical content.No changes to the meaning, language, or formatting of the 10/25/2012 1.0 None technical content.No changes to the meaning, language, or formatting of the 1/31/2013 1.0 None technical content.8/8/2013 2.0 Major Updated and revised the technical content.11/14/2013 3.0 Major Updated and revised the technical content.No changes to the meaning, language, or formatting of the 2/13/2014 3.0 None technical content.No changes to the meaning, language, or formatting of the 5/15/2014 3.0 None technical content.No changes to the meaning, language, or formatting of the 6/30/2015 3.0 None technical content.No changes to the meaning, language, or formatting of the 10/16/2015 3.0 None technical content.7/14/2016 3.0 None No changes to the meaning, language, or formatting of the 3 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Revision Revision Date History Class Comments technical content.No changes to the meaning, language, or formatting of the 6/1/2017 3.0 None technical content.4 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Table of Contents5 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 1 Introduction This document specifies the Remote Experience Advertisement Protocol. The Remote Experience Advertisement Protocol enables a Universal Plug and Play (UPnP) service implemented by a device to be used by the client to advertise available remote experience information to that device. This information specifies the type of experience, how to initiate the connection, and provides a host ID and host certificate along with other information. This protocol is compliant with UPnP architecture and is implemented as an UPnP service [UPNPARCH1]. Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative.1.1 Glossary This document uses the following terms: certificate: A certificate is a collection of attributes and extensions that can be stored persistently. The set of attributes in a certificate can vary depending on the intended usage of the certificate. A certificate securely binds a public key to the entity that holds the corresponding private key. A certificate is commonly used for authentication and secure exchange of information on open networks, such as the Internet, extranets, and intranets. Certificates are digitally signed by the issuing certification authority (CA) and can be issued for a user, a computer, or a service. The most widely accepted format for certificates is defined by the ITU-T X.509 version 3 international standards. For more information about attributes and extensions, see [RFC3280] and [X509] sections 7 and 8. control point: A control point retrieves device and service descriptions, sends actions to services, polls for service state variables, and receives events from services. service description: The UPnP description for a service defines actions and their arguments, and state variables and their data type, range, and event characteristics. service ID: The service ID suffix defined by an UPnP Forum working committee or specified by an UPnP vendor must be less than 64 characters. This should be a Single URI. service or UPnP service: A set of rules that is required to be published by the device and advertised when the device is turned on all the available control points. service type: Service type refers to the name of a particular service that is implemented on the device. SOAP action: The HTTP request header field used to indicate the intent of the SOAP request, using a URI value. See [SOAP1.1] section 6.1.1 for more information.6 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 SOAP body: A container for the payload data being delivered by a SOAP message to its recipient. See [SOAP1.2-1/2007] section 5.3 for more information. SOAP message: An XML document consisting of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. See [SOAP1.2-1/2007] section 5 for more information. XML: The Extensible Markup Language, as described in [XML1.0]. XML namespace: A collection of names that is used to identify elements, types, and attributes in XML documents identified in a URI reference [RFC3986]. A combination of XML namespace and local name allows XML documents to use elements, types, and attributes that have the same names but come from different sources. For more information, see [XMLNS-2ED]. XML schema: A description of a type of XML document that is typically expressed in terms of constraints on the structure and content of documents of that type, in addition to the basic syntax constraints that are imposed by XML itself. An XML schema provides a view of a document type at a relatively high level of abstraction. MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.1.2 References Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata. 1.2.1 Normative References We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact [email protected]. We will assist you in finding the relevant information. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, http://www.rfc- editor.org/rfc/rfc2119.txt[SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., et al., "Simple Object Access Protocol (SOAP) 1.1", W3C Note, May 2000, http://www.w3.org/TR/2000/NOTE-SOAP-20000508/[UPNPARCH1] UPnP Forum, "UPnP Device Architecture 1.0", October 2008, http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0.pdf7 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 [XMLNS] Bray, T., Hollander, D., Layman, A., et al., Eds., "Namespaces in XML 1.0 (Third Edition)", W3C Recommendation, December 2009, http://www.w3.org/TR/2009/REC-xml-names-20091208/[XMLSCHEMA1] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema Part 1: Structures", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/1.2.2 Informative References None.1.3 Overview The Remote Experience Advertisement Protocol is used for advertising experiences available at a host PC to a specific UPnP device. It is used for providing data required by the UPnP device to connect to the advertised experience. In addition to advertising, it can also revoke a previously advertised experience by announcing that an experience is currently unavailable. This protocol is a SOAP-based protocol that uses HTTP 1.1 as its transport. The Remote Experience Advertisement Protocol provides for three actions: AcquireNonce, Advertise, and Inhibit. The AcquireNonce action provides the Nonce and signing information; this information is later used by the Advertise and Inhibit actions. As specified in [UPNPARCH1] section 3.1.1, each action of the protocol results in a pair of SOAP request and response messages in the network. The following diagram illustrates a flow of Remote Experience Advertisement Protocol messages exchanged between the device and the control point, when the Advertise action is achieved successfully.8 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Figure 1: Protocol message sequence diagram (Advertise action)The following diagram illustrates a flow of Remote Experience Advertisement Protocol messages exchanged between the device and the control point, when the previously advertised action is canceled successfully.9 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Figure 2: Protocol message sequence diagram (Inhibit action)1.4 Relationship to Other Protocols The Remote Experience Advertisement Protocol uses SOAP over HTTP as shown in the following layering diagram:10 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 Figure 3: Protocol layering diagram1.5 Prerequisites/Preconditions The Remote Experience Advertisement Protocol requires the support of an UPnP stack [UPNPARCH1] on the device and the control point. Therefore, before the protocol is put into action, the device performs all of the prior UPnP steps, including the discovery of the device, device description, and the publication of the service description as specified in [UPNPARCH1]. Appendix B shows the UPnP service information of the protocol to be included in the device description. The service type of the protocol is "msremotedexperience", the version number is as specified in section 1.7 of this document, and the service ID is "MSRX". Appendix C shows the full UPnP service description of this protocol. The protocol server endpoint is formed by appending "/_vti_bin/pptws.asmx".1.6 Applicability Statement The Remote Experience Advertisement Protocol is used to describe the available experience to the device from the PC which can also include information such as how to initiate a connection and provide a host ID and host certificate along with other useful information.1.7 Versioning and Capability Negotiation This document specifies Remote Experience Advertisement Protocol version 1. The version number is included where Remote Experience Advertisement Protocol service information is presented in the device description as specified in [UPNPARCH1] section 2.3. See section 1.5 for more details.1.8 Vendor-Extensible Fields There are no vendor-extensible fields other than what is specified in [UPNPARCH1].11 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 1.9 Standards Assignments There are no standards assignments other than what is specified in [UPNPARCH1].12 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 2 Messages2.1 Transport The Remote Experience Advertisement Protocol does not specify a transport protocol beyond what is specified by [UPNPARCH1].2.2 Common Message Syntax This section contains common definitions used by this protocol. The syntax of the definitions uses XML schema as defined in [XMLSCHEMA1] and [XMLSCHEMA2].2.2.1 Namespaces This specification defines and references various XML namespaces using the mechanisms specified in [XMLNS]. Although this specification associates a specific XML namespace prefix for each XML namespace that is used, the choice of any particular XML namespace prefix is implementation-specific and not significant for interoperability. Prefix Namespace URI Reference msrx urn:schemas-microsoft-com:service:msremotedexperience:1 [MS-RXAD] dt urn:schemas-microsoft-com:datatypes [MS-RXAD] soapenv http://schemas.xmlsoap.org/soap/envelope/ [SOAP1.1] encodingStyle http://schemas.xmlsoap.org/soap/encoding/ [SOAP1.1] xsd http://www.w3.org/2001/XMLSchema [XMLSCHEMA1]2.2.2 Messages The Remote Experience Advertisement Protocol provides three actions: the AcquireNonce, Advertise, and Inhibit actions. The request and response messages for each Remote Experience Advertisement Protocol action MUST be expressed in XML using the SOAP 1.1 UPnP profile as specified in [UPNPARCH1] section 3.1.1. The details of each action can be found in section 3.1.4 of this document.2.2.3 ElementsElement DescriptionHostID A GUID used to identify a control point that provides remote experiences on the network.Nonce A Nonce is generated by the UPnP device, and returned to the control point.2.2.4 Complex Types None.2.2.5 Simple Types None.13 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 2.2.6 Attributes None.2.2.7 Groups None.2.2.8 Attribute Groups None.14 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 3 Protocol Details3.1 Server Details3.1.1 Abstract Data Model Upon each action, the control point sends the request message to the device, and the device returns a response or error message to the control point [UPNPARCH1]. There are five states in the Remote Experience Advertisement Protocol: 1. Initial state 2. Host Nonce not set and Host not Advertised 3. Host Nonce set and Host not Advertised 4. Host Nonce not set and Host Advertised 5. Final state In its Initial state, the control point is in the Host Nonce not set and Host not Advertised state. The AcquireNonce action transitions the control point into the Host Nonce set and Host not Advertised state. At this point the host PC is ready to send an Advertise action if the remoted experience is available. In case the remote experience is not available, the host PC can send an Inhibit action, by informing the device when such an experience will be available. Upon an Advertise action, the device enters the Host Nonce not set and Host Advertised state. If the control point is required to cancel the advertisement, then it can send an Inhibit action changing the state to Host Nonce set and Host not Advertised. The same Inhibit action can change the state to the Final state. The following diagram provides an overview of the state machine.Figure 4: Host State Machine15 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 3.1.2 Timers The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].3.1.3 Initialization The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].3.1.4 Message Processing Events and Sequencing Rules3.1.4.1 AcquireNonce Action A control point MUST attach an <AcquireNonce> body to a Remote Experience Advertisement Protocol SOAP message that contains <HostId> element in order to instruct the device to send the Nonce and signing information in response.3.1.4.1.1 Messages3.1.4.1.1.1 AcquireNonce Message The HTTP header MUST specify SOAPACTION as follows for an AcquireNonce message: SOAPACTION: "urn:schemas-microsoft- com:service:msremotedexperience:1#AcquireNonce" "urn:schemas-microsoft-com:service:msremotedexperience:1" is the service type as specified in device description in Appendix B. "AcquireNonce" is the SOAP action. The following XML session shows an <AcquireNonce> and <HostId> in a SOAP message.4 <soapenv:Envelope 5 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 6 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">78 <soapenv:Body>9 <msrx:AcquireNonce xmlns:msrx ="urn:schemas-microsoft-com:service:msremotedexperience:1">10 <HostId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">11 A GUID used to identify a control point that provides remote experiences on the network12 </HostId>13 </m:AcquireNonce>14 </soapenv:Body>16 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 1516 </ soapenv:Envelope>1717.1.1.1.1.1 AcquireNonce Response Message The server MUST reply with a SOAP response message named <AcquireNonceResponse> that contains <Nonce>, <SupportedSignatureAlgorithms> and <AttachCertificate>. The following XML session shows a <AcquireNonceResponse>, <Nonce>, <SupportedSignatureAlgorithms> and <AttachCertificate> in a SOAP message. [SOAP]18 <soapenv:Envelope19 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"20 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">21 <soapenv:Body>22 <msrx:AcquireNonceResponse xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">23 <Nonce>Nonce payload</Nonce>24 <SupportedSignatureAlgorithms> SignatureAlgorithms payload</SupportedSignatureAlgorithms>25 <AttachCertificate>Boolean value indicating if certificate is attached in Advertised/Inhibit action</AttachCertificate>26 </msrx:AcquireNonceResponse>27 </soapenv:Body>28 </soapenv:Envelope>28.1.1.1.1 Elements28.1.1.1.1.1 AttachCertificate The <AttachCertificate> is the element of type Boolean under an <AcquireNonceResponse> SOAP body that is used to determine if the control point MUST send its full certificate in <Advertise> and <Inhibit> SOAP body. If the UPnP device cannot store the control point's certificate, it can instead store a hash of the certificate and request that the control point send the full certificate with each <Advertise> and <Inhibit> SOAP body by setting this value to TRUE. If the certificate is not required in those actions, then this value is set to FALSE.2917 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 30 <xs:element name="AttachCertificate" type="xs:boolean"/>30.1.1.1.1.1 HostID The <HostID> is an element of type string under an <AcquireNonceResponse>, <Advertise>, and <Inhibit> SOAP body. It is a GUID used to identify a control point that provides remote experiences on the network. The <HostID> can be used by the UPnP device to group <ApplicationID> element in local user interface.3132 <xs:element name="HostID" type="xs:string" />32.1.1.1.1.1 Nonce The <Nonce> is an element that contains a 4-byte unsigned integer under <AcquireNonceResponse>, <Advertise>, and <Inhibit> messages generated by the UPnP Device. The <AcquireNonce> MUST be called prior to invoking an <Advertise> and <Inhibit> action.3334 <xs:element name="Nonce" type="xs:unsignedInt"/>34.1.1.1.1.1 SupportedSignatureAlgorithms The <SupportedSignatureAlgorithms> is a string element under <AcquireNonceResponse> messages generated by the UPnP Device. The element contains a list of algorithm descriptors that the control point can use to create a <Signature> element in Advertise and Inhibit messages. Individual algorithm descriptors in the list are separated by space characters.3536 <xs:element name="SupportedSignatureAlgorithms" type="xs:string"/>36.1.1.1.1 Complex Types None.36.1.1.1.2 Simple Types None.36.1.1.1.3 Attributes None.36.1.1.1.4 Groups None.36.1.1.1.5 Attribute Groups None.18 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 36.1.1.1.6 Timer Events The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].36.1.1.1.7 Other Local Events The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].36.1.1.2 Advertise Action A client MUST attach an <Advertise> body to the Remote Experience Advertisement Protocol SOAP message that contains <Nonce>, <HostId>, <ApplicationId>, <ApplicationVersion>, <ApplicationData>, <HostFriendlyName>, <ExperienceFriendlyName>, <ExperienceIconUri>, < ExperienceEndpointData>, <SignatureAlgorithm>, <Signature> and <HostCertificate> in order to advertise an available remote experience to a UPnP device.36.1.1.2.1 Messages36.1.1.2.1.1 Advertise Message The HTTP header MUST specify the SOAPACTION header, as specified in [UPNPARCH1], as follows for the Advertise message: SOAPACTION: "urn:schemas-microsoft- com:service:msremotedexperience:1#Advertise" "urn:schemas-microsoft-com:service:msremotedexperience:1" is service type which comes from the device description as specified in Appendix B. "Advertise" is the soap action. The following XML shows an <Advertise> action sent by the client in a SOAP message. [SOAP]37 <soapenv:Envelope 38 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 39 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">4041 <soapenv:Body>4243 <msrx:Advertise xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">44 <Nonce xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="ui4">45 Nonce ID46 </Nonce>19 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 47 <HostId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">48 HostId49 </HostId>50 <ApplicationId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">51 ApplicationId52 </ApplicationId>53 <ApplicationVersion xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">54 ApplicationVersion number55 </ApplicationVersion>56 <ApplicationData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">57 ApplicationData payload58 </ApplicationData>59 <HostFriendlyName xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">60 HostFriendlyName payload61 </HostFriendlyName>62 <ExperienceFriendlyName xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">63 ExperienceFriendlyName payload64 </ExperienceFriendlyName>65 <ExperienceIconUri xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">66 ExperienceIconUri payload67 </ExperienceIconUri>68 <ExperienceEndpointUri xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">69 ExperienceEndpointUri70 </ExperienceEndpointUri>71 <ExperienceEndpointData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">72 ExperienceEndPointData payload73 </ExperienceEndpointData>20 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 74 <SignatureAlgorithm xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">75 SignatureAlgorithm payload76 </SignatureAlgorithm>77 <Signature xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">78 Signature payload79 </Signature>80 <HostCertificate xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">81 HostCertificate payload82 </HostCertificate>83 </msrx:Advertise>8485 </soapenv:Body>86 </soapenv:Envelope>86.1.1.1.1.1 Advertise Response Message The server MUST reply with a SOAP response message named <AdvertiseResponse>. The "urn:schemas-microsoft-com:service:msremotedexperience:1" XML namespace SHOULD be specified in the <AdvertiseResponse> message. The following XML session shows an <AdvertiseResponse> in a SOAP message. [SOAP]87 <soapenv:Envelope88 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"89 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">90 <soapenv:Body>91 <msrx:AdvertiseResponse xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">92 </msrx:AdvertiseResponse>93 </soapenv:Body>94 </soapenv:Envelope>94.1.1.1.1 Elements94.1.1.1.1.1 ApplicationData21 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 ApplicationData is the element of type string under an <Advertise> and <Inhibit> SOAP body that contains additional data specific to a remote application. This data SHOULD contain further information about why the application is offline as well when it is expected to be online again.9596 <xs:element name="ApplicationData" type="xs:string"/> 96.1.1.1.1.1 ApplicationID ApplicationID is a GUID element of type string under an <Advertise> and <Inhibit> SOAP body that is used to identify an application that will present remote experience endpoints. This ApplicationID can be used to group <ExperienceEndpointFriendlyName> element in the local user interface.9798 <xs:element name="ApplicationId" type="xs:string"/> 98.1.1.1.1.1 ApplicationVersion ApplicationVersion is an element of type string under an <Advertise> and <Inhibit> SOAP body that contains version information specific to a remote application.99100 <xs:element name="ApplicationVersion" type="xs:string"/> 100.1.1.1.1.1ExperienceEndpointData ExperienceEndpointData is an element of type string under an <Advertise> SOAP body that contains any information specific to connecting to the remote experience. For example, this MAY contain credentials used by the UPnP device when connecting to the remote experience.101102 <xs:element name="ExperienceEndpointData" type="xs:string"/> 102.1.1.1.1.1ExperienceEndpointUri ExperienceEndpointUri is an element of type string under an <Advertise> SOAP body that contains a given path to where the UPnP device SHOULD connect to the remote experience.103104 <xs:element name=" ExperienceEndpointUri" type="xs:string"/>104.1.1.1.1.1ExperienceFriendlyName22 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 ExperienceFriendlyName is an element of type string under an <Advertise> SOAP body that represents a specific remote experience inside of the application.105106 <xs:element name=" ExperienceFriendlyName" type="xs:string"/>106.1.1.1.1.1ExperienceIconUri ExperienceIconUri is an element of type string under an <Advertise> SOAP body that gives a path to an image to be used in local user interface to represent the remote experience available on the control point.107108 <xs:element name="ExperienceIconUri" type="xs:string"/>108.1.1.1.1.1HostCertificate HostCertificate is an element of type string under an <Advertise> and <Inhibit> SOAP body. It is provided by the control point when the UPnP device returns TRUE for the <AttachCertificate> parameter in <AcquireNonce>.109110 <xs:element name="HostCertificate" type="xs:string"/>110.1.1.1.1.1HostID HostID is an element of type string under an <AcquireNonce>, <Advertise> and <Inhibit> SOAP body. It is a GUID used to identify a control point that provides remote experiences on the network. The HostID can be used by the UPnP device to group the <ApplicationID> element in the local user interface.111112 <xs:element name="HostId" type="xs:string"/>112.1.1.1.1.1Nonce Nonce is an element that contains a 4-byte unsigned integer under an <AcquireNonceResponse>, <Advertise> and <Inhibit> messages generated by the UPnP Device. The Nonce is single use, therefore <AcquireNonce> MUST be called prior to invoking an <Advertise> and <Inhibit> action.113114 <xs:element name="Nonce" type="xs:unsignedInt"/>114.1.1.1.1.1Signature Signature allows the UPnP device to authenticate an <Advertise> action. To create the signature, the control point concatenates the action with all parameters in a UTF-8 encoded string, with the exception of the Signature and 23 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 the HostCertificate parameters. The algorithm used MUST be the same algorithm supplied in the SignatureAlgorithm parameter.115116 <xs:element name="Signature" type="xs:string"/>116.1.1.1.1.1SignatureAlgorithm SignatureAlgorithm is an element of type string under an <Advertise> and <Inhibit> SOAP body that contains the algorithm descriptor that the control point used to create a <Signature> selected from the list of SupportedSignatureAlgorithms retrieved in <AcquireNonce>.117118 <xs:element name="SupportedSignatureAlgorithm" type="xs:string"/>118.1.1.1.1 Complex Types None.118.1.1.1.2 Simple Types None.118.1.1.1.3 Attributes None.118.1.1.1.4 Groups None.118.1.1.1.5 Attribute Groups None.118.1.1.1.6 Timer Events The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].118.1.1.1.7 Other Local Events The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].118.1.1.2 Inhibit Action A control point attaches an <Inhibit> body to the Remote Experience Advertisement Protocol SOAP message that contains <Nonce>, <HostId>, <ApplicationId>, <ApplicationVersion>, <ApplicationData>, <ReasonCode>, <ReasonMessage>, <SignatureAlgorithm>, <Signature> and <HostCertificate> in order to inform a UPnP device that a remote experience is unavailable.24 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 118.1.1.2.1 Messages118.1.1.2.1.1Inhibit Message The HTTP header MUST specify SOAPACTION as follows for an Inhibit message: SOAPACTION: "urn:schemas-microsoft- com:service:msremotedexperience:1#Inhibit" "urn:schemas-microsoft-com:service:msremotedexperience:1" is the service type as specified in device description in <Appendix 7>. "Inhibit" is the SOAP action. The following XML shows the <Inhibit> action sent by the client in a SOAP message.119 <soapenv:Envelope 120 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 121 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">122123 <soapenv:Body>124125 <msrx:Inhibit xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">126 <Nonce xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="ui4">127 Nonce ID </Nonce>128 <HostId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">129 HostId payload130 </HostId>131 <ApplicationId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">132 ApplicationId payload </ApplicationId>133 <ApplicationVersion xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">134 ApplicationVersion number135 </ApplicationVersion>136 <ApplicationData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">137 ApplicationData payload138 </ApplicationData>139 <ReasonCode xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="ui4">25 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 140 ReasonCode for Inhibit141 </ReasonCode>142 <ReasonMessage xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">143 ReasonMessage for Inhibit144 </ReasonMessage>145 <SignatureAlgorithm xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">146 SignatureAlgorithm payload147 </SignatureAlgorithm>148 <Signature xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">149 Signature payload150 </Signature>151 <HostCertificate xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">152 HostCertificate payload153 </HostCertificate>154 </msrx:Inhibit>155156 </soapenv:Body>157 </soapenv:Envelope>157.1.1.1.1.1Inhibit Response Message The server MUST reply with a SOAP response message named <InhibitResponse>. The "urn:schemas-microsoft-com:service:msremotedexperience:1" XML namespace SHOULD be specified in the <InhibitResponse>. The following XML session shows an <InhibitResponse> in a SOAP message. [SOAP]158 <soapenv:Envelope159 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"160 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">161 <soapenv:Body>162 <msrx:InhibitResponse xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">163 </msrx:InhibitResponse>26 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 164 </soapenv:Body>165 </soapenv:Envelope>165.1.1.1.1 Elements165.1.1.1.1.1ApplicationData ApplicationData is the element of type string under an <Advertise> and <Inhibit> SOAP body that contains any additional data specific to a remote application. This data could contain further information about why the application is offline as well when it is expected to be online again.166167 <xs:element name="ApplicationData" type="xs:string"/>167.1.1.1.1.1ApplicationID ApplicationID is a GUID element of type string under an <Advertise> and <Inhibit> SOAP body that is used to identify an application that will present remoted experience endpoints. This ApplicationID can be used to group <ExperienceEndpointFriendlyName> element in the local UI.168169 <xs:element name="ApplicationId" type="xs:string"/>169.1.1.1.1.1ApplicationVersion ApplicationVersion is an element of type string under an <Advertise> and <Inhibit> SOAP body that contains version information specific to a remote application.170171 <xs:element name="ApplicationVersion" type="xs:string"/>171.1.1.1.1.1HostCertificate HostCertificate is an element of type string under an <Advertise> and <Inhibit> SOAP body. It is provided by the control point when the UPnP device returns TRUE for the <AttachCertificate> parameter in <AcquireNonce>.172173 <xs:element name="HostCertificate" type="xs:string"/> 173.1.1.1.1.1HostID HostID is an element of type string under an <AcquireNonce>, <Advertise> and <Inhibit> SOAP body. It is a GUID used to identify a control point that provides remoted experiences on the network. The HostID can be used by the UPnP device to group <ApplicationID> element in the local UI.27 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 174175 <xs:element name="HostId" type="xs:string"/>175.1.1.1.1.1Nonce The Nonce element contains a 4-byte unsigned integer under <AcquireNonceResponse>, <Advertise> and <Inhibit> messages generated by the UPnP device. Nonce is single use, and therefore <AcquireNonce> MUST be called prior to invoking an <Advertise> and <Inhibit> action.176177 <xs:element name="Nonce" type="xs:unsignedInt"/>177.1.1.1.1.1ReasonCode ReasonCode is an element of type 4-byte unsigned integer under an <Inhibit> SOAP body. This code can be used by the UPnP device to take a resultant action, (for example, reconnect or show an error screen). ReasonCode is <ApplicationId> element specific.178179 <xs:element name="ReasonCode" type="xs:unsignedInt"/>179.1.1.1.1.1ReasonMessage ReasonMessage is an element of type string under an <Inhibit> SOAP body that contains human readable data as to why the Inhibit action was called. ReasonMessage is <ApplicationId> specific.180181 <xs:element name="ReasonMessage" type="xs:string"/>181.1.1.1.1.1Signature The Signature element allows the UPnP device to authenticate an <Advertise> action. To create the signature, the control point concatenates the action with all parameters in a UTF-8 encoded string, with the exception of the Signature and the HostCertificate. The algorithm used is the same algorithm supplied in the SignatureAlgorithm parameter.182183 <xs:element name="Signature" type="xs:string"/>183.1.1.1.1.1SignatureAlgorithm SignatureAlgorithm is an element of type string under an <Advertise> and <Inhibit> SOAP body that contains the algorithm descriptor that the control point used to create a <Signature> selected from the list of SupportedSignatureAlgorithms retrieved in <AcquireNonce>.28 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 184185 <xs:element name="SignatureAlgorithm" type="xs:string"/>185.1.1.1.1 Complex Types None.185.1.1.1.2 Simple Types None.185.1.1.1.3 Attributes None.185.1.1.1.4 Groups None.185.1.1.1.5 Attribute Groups185.1.1.1.6 Timer Events The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].185.1.1.1.7 Other Local Events The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].185.2 Client Details The device returns a response or error message to the control point. The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].29 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 186 Protocol Examples In this section a complete message exchange is shown between the server and client consisting of following messages.186.1 AcquireNonce Message The control point sends a POST method in the following format to the device to invoke <AcquireNonce> action on control point service.187 <soapenv:Envelope 188 xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 189 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">190 < soapenv:Body>191 <msrx:AcquireNonce xmlns:msrx ="urn:schemas-microsoft com:service:msremotedexperience:1">192 <HostId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">193 uuid:0b8f6d8f-a1a0-4be2-b5b0-d7b49de0cf6c194 </HostId>195 </m:AcquireNonce>196 </ soapenv:Body>197 </ soapenv:Envelope>197.1 AcquireNonce Response Message The service invokes the action and responds within 30 seconds in the form of a <AcquireNonceResponse>.198 <soapenv:Envelope199 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"200 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">201202 <soapenv:Body>203 <msrx:AcquireNonceResponse xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">204 <Nonce>1288959994</Nonce>205 <SupportedSignatureAlgorithms>rSASSA-PSS-Default- Identifier</SupportedSignatureAlgorithms>206 <AttachCertificate>0</AttachCertificate>30 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 207 </msrx:AcquireNonceResponse>208 </soapenv:Body>209 </soapenv:Envelope>209.1 Advertise Message The control point gets information from the <AcquireNonceResponse> SOAP envelope and invokes the <Advertise> action informing the UPnP device that a remote experience is available for use along with all the necessary information required for connecting to a remote experience.210 <soapenv:Envelope 211 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 212 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">213 <soapenv:Body>214 <msrx:Advertise xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">215 <Nonce xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="ui4">216 1391218849217 </Nonce>218 <HostId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">219 uuid:0b8f6d8f-a1a0-4be2-b5b0-d7b49de0cf6c220 </HostId>221 <ApplicationId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">222 uuid:f1c65f7a-c321-413d-9801-4194ebf29308223 </ApplicationId>224 <ApplicationVersion xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">225 pc3.0.0226 </ApplicationVersion>227 <ApplicationData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">228 version=dv1.5.0,dv2.0.0;wolmac=001FC65F88DD;229 </ApplicationData>31 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 230 <HostFriendlyName xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">231 </HostFriendlyName>232 <ExperienceFriendlyName xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">233 Windows® 7234 </ExperienceFriendlyName>235 <ExperienceIconUri xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">236 </ExperienceIconUri>237 <ExperienceEndpointUri xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">238 xsp://192.168.0.140:3390/239 </ExperienceEndpointUri>240 <ExperienceEndpointData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">241 user=Mcx2-PPATHAN-TEST;passwordlength=20;encryptedpassword=Y0F7Mczi…242 </ExperienceEndpointData>243 <SignatureAlgorithm xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">244 rSASSA-PSS-Default-Identifier245 </SignatureAlgorithm>246 <Signature xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">247 KegL+aHl+SyVUZgCrTPJZ28FfhB/iS8XVi6ji2rVkr6WGv2U5hyxgmkB+rdVLEe1pNWD…248 </Signature>249 <HostCertificate xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">250 AAABAANiMIIDXjCCAkagAwIBAgIQE5KP0u8h/J9KFqxEKBZLNjANBgkqhkiG9w0BAQU…251 </HostCertificate>252 </msrx:Advertise>253 </soapenv:Body>254 </soapenv:Envelope>254.1 Advertise Response Message The device returns an HTTP:response for the <Advertise> action in the form of an <AdvertiseResponse>.32 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 255 <soapenv:Envelope256 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"257 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">258 <soapenv:Body>259 <msrx:AdvertiseResponse xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">260 </msrx:AdvertiseResponse>261 </soapenv:Body>262 </soapenv:Envelope>262.1 Inhibit Message The following Inhibit message informs the UPnP device that a remote experience is unavailable.263 <soapenv:Envelope 264 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 265 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">266 <soapenv:Body>267 <msrx:Inhibit xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">268 <Nonce xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="ui4">269 1391218849270 </Nonce>271 <HostId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">272 uuid:0b8f6d8f-a1a0-4be2-b5b0-d7b49de0cf6c273 </HostId>274 <ApplicationId xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">275 uuid:f1c65f7a-c321-413d-9801-4194ebf29308276 </ApplicationId>277 <ApplicationVersion xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">278 pc3.0.0279 </ApplicationVersion>33 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 280 <ApplicationData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">281 version=dv1.5.0,dv2.0.0;wolmac=001FC65F88DD;282 </ApplicationData>283 <ReasonCode xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="ui4">284 </ReasonCode>285 <ReasonMessage xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">286 </ReasonMessage>287 <SignatureAlgorithm xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">288 rSASSA-PSS-Default-Identifier289 </SignatureAlgorithm>290 <Signature xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">291 KegL+aHl+SyVUZgCrTPJZ28FfhB/iS8XVi6ji2rVkr6WGv2U5hyxgmkB+rdVLEe1pNWD…292 </Signature>293 <HostCertificate xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="string">294 AAABAANiMIIDXjCCAkagAwIBAgIQE5KP0u8h/J9KFqxEKBZLNjANBgkqhkiG9w0BAQU…295 </HostCertificate>296 </msrx:Inhibit>297 </soapenv:Body>298 </soapenv:Envelope>298.1 Inhibit Response Message The response to inhibit message is as follows.299 <soapenv:Envelope300 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"301 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">302 <soapenv:Body>303 <msrx:InhibitResponse xmlns:msrx="urn:schemas-microsoft- com:service:msremotedexperience:1">304 </msrx:InhibitResponse>305 </soapenv:Body>34 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 306 </soapenv:Envelope>35 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 307 Security307.1 Security Considerations for Implementers The Remote Experience Advertisement Protocol does not specify anything beyond what is specified by [UPNPARCH1].307.2 Index of Security Parameters None.36 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 308 Appendix A: Full WSDL There is no WSDL for this protocol. For UPnP the equivalent to WSDL is the UPnP device and service descriptions as detailed in Appendix B and C respectively.37 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 309 Appendix B: UPnP Device Description The following is a sample service information of the Remote Experience Advertisement Protocol that a device description should include as a part of the device's service list. The default namespace "urn:schemas-upnp-org:device-1-0" is as specified in [UPNPARCH1] sections 2.1 and 2.6.310311 <?xml version='1.0'?>312 <root xmlns="urn:schemas-upnp-org:device-1-0"313 xmlns:pnpx="http://schemas.microsoft.com/windows/pnpx/2005/11">314 <specVersion>315 <major>1</major>316 <minor>0</minor>317 </specVersion>318 <device> 319 <pnpx:X_deviceCategory>MediaDevices</pnpx:X_deviceCategory>320 <deviceType>urn:schemas-microsoft-com:device:MediaCenterExtenderMFD:1</deviceType>321 <friendlyName>Xbox 360 Media Center Extender</friendlyName>322 <manufacturer>Microsoft Corporation</manufacturer>323 <manufacturerURL>http://www.xbox.com/</manufacturerURL>324 <modelDescription>Xbox 360 Media Center Extender</modelDescription>325 <modelName>Xbox 360</modelName>326 <modelNumber></modelNumber>327 <modelURL>http://go.microsoft.com/fwlink/?LinkID=53081</modelURL>328 <serialNumber></serialNumber>329 <UDN>uuid:10000000-0000-0000-0200-00125A702E78</UDN>330 <UPC></UPC>331 <iconList>332 <icon>333 <mimetype>image/jpeg</mimetype>334 <width>48</width>38 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 335 <height>48</height>336 <depth>24</depth>337 <url>/IconSM.jpg</url>338 </icon>339 <icon>340 <mimetype>image/jpeg</mimetype>341 <width>120</width>342 <height>120</height>343 <depth>24</depth>344 <url>/IconLRG.jpg</url>345 </icon>346 <icon>347 <mimetype>image/png</mimetype>348 <width>48</width>349 <height>48</height>350 <depth>24</depth>351 <url>/IconSM.png</url>352 </icon>353 <icon>354 <mimetype>image/png</mimetype>355 <width>120</width>356 <height>120</height>357 <depth>24</depth>358 <url>/IconLRG.png</url>359 </icon>360 <icon>361 <mimetype>image/png</mimetype>362 <width>152</width>363 <height>152</height>39 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 364 <depth>24</depth>365 <url>/IconMCE.png</url>366 </icon>367 </iconList>368 <serviceList>369 <service>370 <serviceType>urn:schemas-microsoft-com:service:NULL:1</serviceType>371 <serviceId>urn:microsoft-com:serviceId:NULL</serviceId>372 <SCPDURL>/XD/NULL.xml</SCPDURL>373 <controlURL>/UD/?0</controlURL>374 <eventSubURL/>375 </service>376 </serviceList>377 <deviceList>378 <device xmlns:mcx="http://schemas.microsoft.com/windows/mcx/2007/06" xmlns:nss="urn:schemas-microsoft-com:WMPNSS-1-0">379 <pnpx:X_compatibleId>MICROSOFT_MCX_0001</pnpx:X_compatibleId>380 <pnpx:X_deviceCategory>MediaDevices</pnpx:X_deviceCategory>381 <mcx:pakVersion>dv2.0.0</mcx:pakVersion>382 <mcx:supportedHostVersions>pc2.0.0</mcx:supportedHostVersions>383 <nss:X_magicPacketSendSupported>1</nss:X_magicPacketSendSupported>384 <deviceType>urn:schemas-microsoft-com:device:MediaCenterExtender:1</deviceType>385 <friendlyName>Xbox 360 Media Center Extender</friendlyName>386 <manufacturer>Microsoft Corporation</manufacturer>387 <manufacturerURL>http://www.microsoft.com/</manufacturerURL>388 <modelDescription>Xbox 360 Media Center Extender</modelDescription>389 <modelName>Xbox 360</modelName>390 <modelNumber></modelNumber>391 <modelURL>http://go.microsoft.com/fwlink/?LinkID=53081</modelURL>392 <serialNumber></serialNumber>40 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 393 <UDN>uuid:20000000-0000-0000-0200-00125A702E78</UDN>394 <UPC></UPC>395 <iconList>396 <icon>397 <mimetype>image/jpeg</mimetype>398 <width>48</width>399 <height>48</height>400 <depth>24</depth>401 <url>/IconSM.jpg</url>402 </icon>403 <icon>404 <mimetype>image/jpeg</mimetype>405 <width>120</width>406 <height>120</height>407 <depth>24</depth>408 <url>/IconLRG.jpg</url>409 </icon>410 <icon>411 <mimetype>image/png</mimetype>412 <width>48</width>413 <height>48</height>414 <depth>24</depth>415 <url>/IconSM.png</url>416 </icon>417 <icon>418 <mimetype>image/png</mimetype>419 <width>120</width>420 <height>120</height>421 <depth>24</depth>41 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 422 <url>/IconLRG.png</url>423 </icon>424 <icon>425 <mimetype>image/png</mimetype>426 <width>152</width>427 <height>152</height>428 <depth>24</depth>429 <url>/IconMCE.png</url>430 </icon>431 </iconList>432 <serviceList> 433 <service>434 <serviceType>urn:schemas-microsoft- com:service:msremotedexperience:1</serviceType>435 <serviceId>urn:schemas-microsoft-com:serviceId:MSRX</serviceId>436 <SCPDURL>/XD/msremotedexperience.xml</SCPDURL>437 <controlURL>/UD/?2</controlURL>438 <eventSubURL/>439 </service>440 </serviceList>441 </device>442 </deviceList>443 </device>444 </root>42 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 445 Appendix C: A Full UPnP Service Description The following is a sample service description of the Remote Experience Advertisement Protocol that the device is required to publish before the protocol takes action as a part of the prerequisite, as specified in section 1.5. The default namespace "urn:schemas-upnp-org:service-1-0" is as specified in [UPNPARCH1] sections 2.3 and 2.7.446447 <?xml version='1.0'?>448 <scpd xmlns="urn:schemas-upnp-org:service-1-0">449 <specVersion>450 <major>1</major>451 <minor>0</minor>452 </specVersion>453 <actionList>454 <action>455 <name>AcquireNonce</name>456 <argumentList>457 <argument>458 <name>HostId</name>459 <direction>in</direction>460 <relatedStateVariable>A_ARG_TYPE_EndpointID</relatedStateVariable>461 </argument>462 <argument>463 <name>Nonce</name>464 <direction>out</direction>465 <relatedStateVariable>A_ARG_TYPE_Nonce</relatedStateVariable>466 </argument>467 <argument>468 <name>SupportedSignatureAlgorithms</name>469 <direction>out</direction>470 <relatedStateVariable>A_ARG_TYPE_SignAlgorithmList</relatedStateVariable>43 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 471 </argument>472 <argument>473 <name>AttachCertificate</name>474 <direction>out</direction>475 <relatedStateVariable>A_ARG_TYPE_Bool</relatedStateVariable>476 </argument>477 </argumentList>478 </action>479 <action>480 <name>Advertise</name>481 <argumentList>482 <argument>483 <name>Nonce</name>484 <direction>in</direction>485 <relatedStateVariable>A_ARG_TYPE_Nonce</relatedStateVariable>486 </argument>487 <argument>488 <name>HostId</name>489 <direction>in</direction>490 <relatedStateVariable>A_ARG_TYPE_EndpointID</relatedStateVariable>491 </argument>492 <argument>493 <name>ApplicationId</name>494 <direction>in</direction>495 <relatedStateVariable>A_ARG_TYPE_EndpointID</relatedStateVariable>496 </argument>497 <argument>498 <name>ApplicationVersion</name>499 <direction>in</direction>44 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 500 <relatedStateVariable>A_ARG_TYPE_Version</relatedStateVariable>501 </argument>502 <argument>503 <name>ApplicationData</name>504 <direction>in</direction>505 <relatedStateVariable>A_ARG_TYPE_AnyString</relatedStateVariable>506 </argument>507 <argument>508 <name>HostFriendlyName</name>509 <direction>in</direction>510 <relatedStateVariable>A_ARG_TYPE_Name</relatedStateVariable>511 </argument>512 <argument>513 <name>ExperienceFriendlyName</name>514 <direction>in</direction>515 <relatedStateVariable>A_ARG_TYPE_Name</relatedStateVariable>516 </argument>517 <argument>518 <name>ExperienceIconUri</name>519 <direction>in</direction>520 <relatedStateVariable>A_ARG_TYPE_Uri</relatedStateVariable>521 </argument>522 <argument>523 <name>ExperienceEndpointUri</name>524 <direction>in</direction>525 <relatedStateVariable>A_ARG_TYPE_Uri</relatedStateVariable>526 </argument>527 <argument>528 <name>ExperienceEndpointData</name>45 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 529 <direction>in</direction>530 <relatedStateVariable>A_ARG_TYPE_AnyString</relatedStateVariable>531 </argument>532 <argument>533 <name>SignatureAlgorithm</name>534 <direction>in</direction>535 <relatedStateVariable>A_ARG_TYPE_SignAlgorithm</relatedStateVariable>536 </argument>537 <argument>538 <name>Signature</name>539 <direction>in</direction>540 <relatedStateVariable>A_ARG_TYPE_Signature</relatedStateVariable>541 </argument>542 <argument>543 <name>HostCertificate</name>544 <direction>in</direction>545 <relatedStateVariable>A_ARG_TYPE_Certificate</relatedStateVariable>546 </argument>547 </argumentList>548 </action>549 <action>550 <name>Inhibit</name>551 <argumentList>552 <argument>553 <name>Nonce</name>554 <direction>in</direction>555 <relatedStateVariable>A_ARG_TYPE_Nonce</relatedStateVariable>556 </argument>557 <argument>46 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 558 <name>HostId</name>559 <direction>in</direction>560 <relatedStateVariable>A_ARG_TYPE_EndpointID</relatedStateVariable>561 </argument>562 <argument>563 <name>ApplicationId</name>564 <direction>in</direction>565 <relatedStateVariable>A_ARG_TYPE_EndpointID</relatedStateVariable>566 </argument>567 <argument>568 <name>ApplicationVersion</name>569 <direction>in</direction>570 <relatedStateVariable>A_ARG_TYPE_Version</relatedStateVariable>571 </argument>572 <argument>573 <name>ApplicationData</name>574 <direction>in</direction>575 <relatedStateVariable>A_ARG_TYPE_AnyString</relatedStateVariable>576 </argument>577 <argument>578 <name>ReasonCode</name>579 <direction>in</direction>580 <relatedStateVariable>A_ARG_TYPE_ReasonCode</relatedStateVariable>581 </argument>582 <argument>583 <name>ReasonMessage</name>584 <direction>in</direction>585 <relatedStateVariable>A_ARG_TYPE_AnyString</relatedStateVariable>586 </argument>47 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 587 <argument>588 <name>SignatureAlgorithm</name>589 <direction>in</direction>590 <relatedStateVariable>A_ARG_TYPE_SignAlgorithm</relatedStateVariable>591 </argument>592 <argument>593 <name>Signature</name>594 <direction>in</direction>595 <relatedStateVariable>A_ARG_TYPE_Signature</relatedStateVariable>596 </argument>597 <argument>598 <name>HostCertificate</name>599 <direction>in</direction>600 <relatedStateVariable>A_ARG_TYPE_Certificate</relatedStateVariable>601 </argument>602 </argumentList>603 </action>604 </actionList>605 <serviceStateTable>606 <stateVariable sendEvents='no'>607 <name>A_ARG_TYPE_EndpointID</name>608 <dataType>string</dataType>609 </stateVariable>610 <stateVariable sendEvents='no'>611 <name>A_ARG_TYPE_Nonce</name>612 <dataType>ui4</dataType>613 </stateVariable>614 <stateVariable sendEvents='no'>615 <name>A_ARG_TYPE_SignAlgorithmList</name>48 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 616 <dataType>string</dataType>617 </stateVariable>618 <stateVariable sendEvents='no'>619 <name>A_ARG_TYPE_Bool</name>620 <dataType>boolean</dataType>621 </stateVariable>622 <stateVariable sendEvents='no'>623 <name>A_ARG_TYPE_Version</name>624 <dataType>string</dataType>625 </stateVariable>626 <stateVariable sendEvents='no'>627 <name>A_ARG_TYPE_AnyString</name>628 <dataType>string</dataType>629 </stateVariable>630 <stateVariable sendEvents='no'>631 <name>A_ARG_TYPE_Name</name>632 <dataType>string</dataType>633 </stateVariable>634 <stateVariable sendEvents='no'>635 <name>A_ARG_TYPE_Uri</name>636 <dataType>string</dataType>637 </stateVariable>638 <stateVariable sendEvents='no'>639 <name>A_ARG_TYPE_SignAlgorithm</name>640 <dataType>string</dataType>641 </stateVariable>642 <stateVariable sendEvents='no'>643 <name>A_ARG_TYPE_Signature</name>644 <dataType>string</dataType>49 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 645 </stateVariable>646 <stateVariable sendEvents='no'>647 <name>A_ARG_TYPE_Certificate</name>648 <dataType>string</dataType>649 </stateVariable>650 <stateVariable sendEvents='no'>651 <name>A_ARG_TYPE_ReasonCode</name>652 <dataType>ui4</dataType>653 </stateVariable>654 </serviceStateTable>655 </scpd>50 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 656 Appendix D: Product Behavior The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include released service packs. § Windows Vista operating system § Windows 7 operating system § Windows 8 operating system § Windows 8.1 operating system Exceptions, if any, are noted below. If a service pack or Quick Fix Engineering (QFE) number appears with the product version, behavior changed in that service pack or QFE. The new behavior also applies to subsequent service packs of the product unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription.51 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 657 Change Tracking No table of changes is available. The document is either new or has had no changes since its last release. Index A server 15 Introduction 7 Abstract data model 14 server 14 AcquireNonce M action 15 example 26 Messages AcquireNonceResponse example 26 AcquireNonce action 15 Advertise Advertise action 17 action 17 attribute groups 13 example 26 attributes 13 AdvertiseResponse example 27 complex types 12 Applicability 11 elements 12 Attribute groups 13 enumerated 12 Attributes 13 groups 13 Inhibit action 21 C namespaces 12 simple types 12 syntax 12 Capability negotiation 11 transport 12 Change tracking 39 Complex types 12 N D Namespaces 12 Normative references 8 Data model - abstract 14 server 14 O E Operations AcquireNonce Action 15 Examples Advertise Action 17 AcquireNonce 26 Inhibit Action 21 AcquireNonceResponse 26 Overview (synopsis) 8 Advertise 26 AdvertiseResponse 27 Inhibit 27 P InhibitResponse 28 overview 26 Parameters - security index 29 Preconditions 11 F Prerequisites 11 Product behavior 38 Fields - vendor-extensible 11 Full WSDL 30 RG References 8 informative 8 normative 8 Glossary 7 Relationship to other protocols 10 Groups 13I S Security Implementer - security considerations 29 implementer considerations 29 Index of security parameters 29 parameter index 29 Informative references 8 Server Inhibit abstract data model 14 action 21 AcquireNonce Action operation 15 example 27 Advertise Action operation 17 InhibitResponse example 28 Inhibit Action operation 21 Initialization 1552 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017 initialization 15 timers 15 U Simple types 12 Standards assignments 11 UPnP Syntax device description 31 messages - overview 12 service description 34 Syntax - messages - overview 12T V Vendor-extensible fields 11 Timers 15 Versioning 11 server 15 Tracking changes 39 Transport 12 W Types complex 12 WSDL 30 simple 1253 / 53 [MS-RXAD] - v20170601 Remote Experience Advertisement Protocol Copyright © 2017 Microsoft Corporation Release: June 1, 2017

Remote Experience Advertisement Protocol

Details

Download

Copyright

We respect the copyrights and intellectual property rights of all users. All uploaded documents are either original works of the uploader or authorized works of the rightful owners.

Support