[MS-RSP]:
Remote Shutdown Protocol
Intellectual 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 .
§ 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.
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 .
Revision Summary
Date / Revision History / Revision Class / Comments /4/3/2007 / 0.1 / New / Version 0.1 release
6/1/2007 / 0.1.1 / Editorial / Changed language and formatting in the technical content.
7/3/2007 / 1.0 / Major / MLonghorn+90
7/20/2007 / 1.0.1 / Editorial / Changed language and formatting in the technical content.
8/10/2007 / 1.0.2 / Editorial / Changed language and formatting in the technical content.
9/28/2007 / 1.0.3 / Editorial / Changed language and formatting in the technical content.
10/23/2007 / 1.0.4 / Editorial / Changed language and formatting in the technical content.
11/30/2007 / 1.0.5 / Editorial / Changed language and formatting in the technical content.
1/25/2008 / 1.0.6 / Editorial / Changed language and formatting in the technical content.
3/14/2008 / 1.0.7 / Editorial / Changed language and formatting in the technical content.
5/16/2008 / 1.0.8 / Editorial / Changed language and formatting in the technical content.
6/20/2008 / 1.0.9 / Editorial / Changed language and formatting in the technical content.
7/25/2008 / 1.0.10 / Editorial / Changed language and formatting in the technical content.
8/29/2008 / 1.0.11 / Editorial / Changed language and formatting in the technical content.
10/24/2008 / 1.0.12 / Editorial / Changed language and formatting in the technical content.
12/5/2008 / 2.0 / Major / Updated and revised the technical content.
1/16/2009 / 2.0.1 / Editorial / Changed language and formatting in the technical content.
2/27/2009 / 2.0.2 / Editorial / Changed language and formatting in the technical content.
4/10/2009 / 2.0.3 / Editorial / Changed language and formatting in the technical content.
5/22/2009 / 2.1 / Minor / Clarified the meaning of the technical content.
7/2/2009 / 2.1.1 / Editorial / Changed language and formatting in the technical content.
8/14/2009 / 2.1.2 / Editorial / Changed language and formatting in the technical content.
9/25/2009 / 2.2 / Minor / Clarified the meaning of the technical content.
11/6/2009 / 2.2.1 / Editorial / Changed language and formatting in the technical content.
12/18/2009 / 2.2.2 / Editorial / Changed language and formatting in the technical content.
1/29/2010 / 2.3 / Minor / Clarified the meaning of the technical content.
3/12/2010 / 2.3.1 / Editorial / Changed language and formatting in the technical content.
4/23/2010 / 3.0 / Major / Updated and revised the technical content.
6/4/2010 / 3.0.1 / Editorial / Changed language and formatting in the technical content.
7/16/2010 / 4.0 / Major / Updated and revised the technical content.
8/27/2010 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
10/8/2010 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
11/19/2010 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
1/7/2011 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
2/11/2011 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
3/25/2011 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
5/6/2011 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/17/2011 / 4.1 / Minor / Clarified the meaning of the technical content.
9/23/2011 / 4.1 / None / No changes to the meaning, language, or formatting of the technical content.
12/16/2011 / 5.0 / Major / Updated and revised the technical content.
3/30/2012 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/12/2012 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
10/25/2012 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
1/31/2013 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
8/8/2013 / 6.0 / Major / Updated and revised the technical content.
11/14/2013 / 6.0 / None / No changes to the meaning, language, or formatting of the technical content.
2/13/2014 / 6.0 / None / No changes to the meaning, language, or formatting of the technical content.
5/15/2014 / 6.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/30/2015 / 7.0 / Major / Significantly changed the technical content.
10/16/2015 / 7.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/14/2016 / 7.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/1/2017 / 7.0 / None / No changes to the meaning, language, or formatting of the technical content.
Table of Contents
1 Introduction 6
1.1 Glossary 6
1.2 References 7
1.2.1 Normative References 7
1.2.2 Informative References 7
1.3 Overview 7
1.4 Relationship to Other Protocols 8
1.5 Prerequisites/Preconditions 8
1.6 Applicability Statement 8
1.7 Versioning and Capability Negotiation 8
1.8 Vendor-Extensible Fields 8
1.9 Standards Assignments 8
2 Messages 9
2.1 Transport 9
2.2 Common Data Types 9
2.2.1 RPC Binding Handles for Remote Shutdown Methods 9
2.2.2 REG_UNICODE_STRING 10
2.3 Shutdown Reasons 10
3 Protocol Details 13
3.1 WinReg Server Details 13
3.1.1 Abstract Data Model 13
3.1.2 Timers 13
3.1.3 Initialization 13
3.1.4 Message Processing Events and Sequencing Rules 13
3.1.4.1 BaseInitiateSystemShutdown (Opnum 24) 15
3.1.4.2 BaseAbortSystemShutdown (Opnum 25) 16
3.1.4.3 BaseInitiateSystemShutdownEx (Opnum 30) 16
3.1.5 Timer Events 17
3.1.6 Other Local Events 17
3.2 InitShutdown Server Details 17
3.2.1 Abstract Data Model 17
3.2.2 Timers 17
3.2.3 Initialization 18
3.2.4 Message Processing Events and Sequencing Rules 18
3.2.4.1 BaseInitiateShutdown (Opnum 0) 18
3.2.4.2 BaseAbortShutdown (Opnum 1) 19
3.2.4.3 BaseInitiateShutdownEx (Opnum 2) 19
3.2.5 Timer Events 20
3.2.6 Other Local Events 20
3.3 WindowsShutdown Server Details 20
3.3.1 Abstract Data Model 20
3.3.2 Timers 20
3.3.3 Initialization 20
3.3.4 Message Processing Events and Sequencing Rules 20
3.3.4.1 WsdrInitiateShutdown (Opnum 0) 21
3.3.4.2 WsdrAbortShutdown (Opnum 1) 22
3.3.5 Timer Events 22
3.3.6 Other Local Events 22
4 Protocol Examples 23
5 Security 24
5.1 Security Considerations for Implementers 24
5.2 Index of Security Parameters 24
6 Appendix A: Full IDL 25
6.1 Appendix A.1: initshutdown.idl 25
6.2 Appendix A.2: windowsshutdown.idl 26
6.3 Appendix A.3: winreg.idl 26
7 Appendix B: Product Behavior 29
8 Change Tracking 31
9 Index 32
1 Introduction
This document specifies the Remote Shutdown Protocol. The Remote Shutdown Protocol is a remote procedure call (RPC)-based protocol used to shut down or terminate shutdown on a remote computer.
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:
client: A computer on which the remote procedure call (RPC) client is executing.
endpoint: A network-specific address of a remote procedure call (RPC) server process for remote procedure calls. The actual name and type of the endpoint depends on the RPC protocol sequence that is being used. For example, for RPC over TCP (RPC Protocol Sequence ncacn_ip_tcp), an endpoint might be TCP port 1025. For RPC over Server Message Block (RPC Protocol Sequence ncacn_np), an endpoint might be the name of a named pipe. For more information, see [C706].
handle: Any token that can be used to identify and access an object such as a device, file, or a window.
Interface Definition Language (IDL): The International Standards Organization (ISO) standard language for specifying the interface for remote procedure calls. For more information, see [C706] section 4.
named pipe: A named, one-way, or duplex pipe for communication between a pipe server and one or more pipe clients.
opnum: An operation number or numeric identifier that is used to identify a specific remote procedure call (RPC) method or a method in an interface. For more information, see [C706] section 12.5.2.12 or [MS-RPCE].
remote procedure call (RPC): A context-dependent term commonly overloaded with three meanings. Note that much of the industry literature concerning RPC technologies uses this term interchangeably for any of the three meanings. Following are the three definitions: (*) The runtime environment providing remote procedure call facilities. The preferred usage for this meaning is "RPC runtime". (*) The pattern of request and response message exchange between two parties (typically, a client and a server). The preferred usage for this meaning is "RPC exchange". (*) A single message from an exchange as defined in the previous definition. The preferred usage for this term is "RPC message". For more information about RPC, see [C706].
RPC protocol sequence: A character string that represents a valid combination of a remote procedure call (RPC) protocol, a network layer protocol, and a transport layer protocol, as described in [C706] and [MS-RPCE].
server: A computer on which the remote procedure call (RPC) server is executing.
Server Message Block (SMB): A protocol that is used to request file and print services from server systems over a network. The SMB protocol extends the CIFS protocol with additional security, file, and disk management support. For more information, see [CIFS] and [MS-SMB].
universally unique identifier (UUID): A 128-bit value. UUIDs can be used for multiple purposes, from tagging objects with an extremely short lifetime, to reliably identifying very persistent objects in cross-process communication such as client and server interfaces, manager entry-point vectors, and RPC objects. UUIDs are highly likely to be unique. UUIDs are also known as globally unique identifiers (GUIDs) and these terms are used interchangeably in the Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the UUID. Specifically, the use of this term does not imply or require that the algorithms described in [RFC4122] or [C706] must be used for generating the UUID.
well-known endpoint: A preassigned, network-specific, stable address for a particular client/server instance. For more information, see [C706].
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 . We will assist you in finding the relevant information.
[C706] The Open Group, "DCE 1.1: Remote Procedure Call", C706, August 1997, https://www2.opengroup.org/ogsys/catalog/c706
[MS-ERREF] Microsoft Corporation, "Windows Error Codes".
[MS-RPCE] Microsoft Corporation, "Remote Procedure Call Protocol Extensions".
[MS-RRP] Microsoft Corporation, "Windows Remote Registry Protocol".