librpc/idl/dcerpc.idl

   1 #include "idl_types.h"
   2
   3 /*
   4   the base dcerpc packet definitions - not traditionally coded as IDL,
   5   but given that pidl can handle it nicely it simplifies things a lot
   6   to do it this way
   7
   8   See [C706 - DCE 1.1: Remote Procedure Call] for the OpenGroup
   9   DCERPC specification:
  10   http://pubs.opengroup.org/onlinepubs/9629399/toc.htm
  11
  12   See C706 - Chapter 12: RPC PDU Encodings for packet layouts:
  13   http://www.opengroup.org/onlinepubs/9629399/chap12.htm
  14
  15   See also [MS-RPCE] for the Microsoft
  16   "Remote Procedure Call Protocol Extensions".
  17   http://msdn.microsoft.com/en-us/library/cc243560.aspx
  18
  19 */
  20 import "misc.idl";
  21
  22 cpp_quote("extern const uint8_t DCERPC_SEC_VT_MAGIC[8];")
  23
  24 [
  25   helper("../librpc/ndr/ndr_dcerpc.h")
  26 ]
  27 interface dcerpc
  28 {
  29         typedef struct {
  30                 uint16 context_id;
  31                 uint8 num_transfer_syntaxes;
  32                 ndr_syntax_id abstract_syntax;
  33                 ndr_syntax_id transfer_syntaxes[num_transfer_syntaxes];
  34         } dcerpc_ctx_list;
  35
  36         typedef [public] struct {
  37                 uint16 max_xmit_frag;
  38                 uint16 max_recv_frag;
  39                 uint32 assoc_group_id;
  40                 uint8  num_contexts;
  41                 dcerpc_ctx_list ctx_list[num_contexts];
  42                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
  43         } dcerpc_bind;
  44
  45         const uint8 DCERPC_REQUEST_LENGTH = 24;
  46
  47         typedef struct {
  48         } dcerpc_empty;
  49
  50         typedef [nodiscriminant] union {
  51                 [case(LIBNDR_FLAG_OBJECT_PRESENT)] GUID object;
  52                 [default] dcerpc_empty empty;
  53         } dcerpc_object;
  54
  55         typedef struct {
  56                 uint32 alloc_hint;
  57                 uint16 context_id;
  58                 uint16 opnum;
  59                 /*
  60                  * NDR_DCERPC_REQUEST_OBJECT_PRESENT
  61                  * is defined differently for ndr_dcerpc.c and py_dcerpc.c
  62                  */
  63                 [switch_is(NDR_DCERPC_REQUEST_OBJECT_PRESENT)] dcerpc_object object;
  64                 [flag(NDR_ALIGN8)]    DATA_BLOB _pad;
  65                 [flag(NDR_REMAINING)] DATA_BLOB stub_and_verifier;
  66         } dcerpc_request;
  67
  68         typedef [enum16bit] enum {
  69                 DCERPC_BIND_ACK_RESULT_ACCEPTANCE          = 0,
  70                 DCERPC_BIND_ACK_RESULT_USER_REJECTION      = 1,
  71                 DCERPC_BIND_ACK_RESULT_PROVIDER_REJECTION  = 2,
  72                 DCERPC_BIND_ACK_RESULT_NEGOTIATE_ACK       = 3
  73         } dcerpc_bind_ack_result;
  74
  75         const int DCERPC_BIND_PROVIDER_REJECT =
  76                 DCERPC_BIND_ACK_RESULT_PROVIDER_REJECTION;
  77
  78         typedef [enum16bit] enum {
  79                 DCERPC_BIND_ACK_REASON_NOT_SPECIFIED                   = 0,
  80                 DCERPC_BIND_ACK_REASON_ABSTRACT_SYNTAX_NOT_SUPPORTED   = 1,
  81                 DCERPC_BIND_ACK_REASON_TRANSFER_SYNTAXES_NOT_SUPPORTED = 2,
  82                 DCERPC_BIND_ACK_REASON_LOCAL_LIMIT_EXCEEDED            = 3
  83         } dcerpc_bind_ack_reason_values;
  84
  85         const int DCERPC_BIND_REASON_ASYNTAX =
  86                 DCERPC_BIND_ACK_REASON_ABSTRACT_SYNTAX_NOT_SUPPORTED;
  87
  88         typedef [bitmap16bit] bitmap {
  89                 DCERPC_BIND_TIME_SECURITY_CONTEXT_MULTIPLEXING = 0x0001,
  90                 DCERPC_BIND_TIME_KEEP_CONNECTION_ON_ORPHAN     = 0x0002
  91         } dcerpc_bind_time_features;
  92
  93         typedef [nodiscriminant] union {
  94                 [case(DCERPC_BIND_ACK_RESULT_NEGOTIATE_ACK)]
  95                         dcerpc_bind_time_features negotiate;
  96                 [default] dcerpc_bind_ack_reason_values value;
  97         } dcerpc_bind_ack_reason;
  98
  99         typedef struct {
 100                 dcerpc_bind_ack_result result;
 101                 [switch_is(result)] dcerpc_bind_ack_reason reason;
 102                 ndr_syntax_id syntax;
 103         } dcerpc_ack_ctx;
 104
 105         typedef struct {
 106                 uint16 max_xmit_frag;
 107                 uint16 max_recv_frag;
 108                 uint32 assoc_group_id;
 109                 [value(strlen_m_term_null(secondary_address))] uint16 secondary_address_size;
 110                 [charset(DOS)] uint8 secondary_address[secondary_address_size];
 111                 [flag(NDR_ALIGN4)]    DATA_BLOB _pad1;
 112                 uint8 num_results;
 113                 dcerpc_ack_ctx ctx_list[num_results];
 114                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
 115         } dcerpc_bind_ack;
 116
 117         typedef [public,enum16bit] enum {
 118                 DCERPC_BIND_NAK_REASON_NOT_SPECIFIED                  = 0,
 119                 DCERPC_BIND_NAK_REASON_TEMPORARY_CONGESTION           = 1,
 120                 DCERPC_BIND_NAK_REASON_LOCAL_LIMIT_EXCEEDED           = 2,
 121                 DCERPC_BIND_NAK_REASON_PROTOCOL_VERSION_NOT_SUPPORTED = 4,
 122                 DCERPC_BIND_NAK_REASON_INVALID_AUTH_TYPE              = 8,
 123                 DCERPC_BIND_NAK_REASON_INVALID_CHECKSUM               = 9
 124         } dcerpc_bind_nak_reason;
 125
 126         const int DECRPC_BIND_PROTOCOL_VERSION_NOT_SUPPORTED =
 127                 DCERPC_BIND_NAK_REASON_PROTOCOL_VERSION_NOT_SUPPORTED;
 128         const int DCERPC_BIND_REASON_INVALID_AUTH_TYPE =
 129                 DCERPC_BIND_NAK_REASON_INVALID_AUTH_TYPE;
 130
 131         typedef [public] struct {
 132                 uint8 rpc_vers;         /* RPC version */
 133                 uint8 rpc_vers_minor;   /* Minor version */
 134         } dcerpc_bind_nak_version;
 135
 136         typedef [public,nopull] struct {
 137                 dcerpc_bind_nak_reason reject_reason;
 138                 uint8 num_versions;
 139                 dcerpc_bind_nak_version versions[num_versions];
 140                 [flag(NDR_REMAINING)] DATA_BLOB _pad;
 141         } dcerpc_bind_nak;
 142
 143         const uint8 DCERPC_RESPONSE_LENGTH = 24;
 144
 145         typedef struct {
 146                 uint32 alloc_hint;
 147                 uint16 context_id;
 148                 uint8 cancel_count;
 149                 [flag(NDR_ALIGN8)]    DATA_BLOB _pad;
 150                 [flag(NDR_REMAINING)] DATA_BLOB stub_and_verifier;
 151         } dcerpc_response;
 152
 153         typedef [v1_enum] enum {
 154                 DCERPC_NCA_S_COMM_FAILURE               = 0x1C010001,
 155                 DCERPC_NCA_S_OP_RNG_ERROR               = 0x1C010002,
 156                 DCERPC_NCA_S_UNKNOWN_IF                 = 0x1C010003,
 157                 DCERPC_NCA_S_WRONG_BOOT_TIME            = 0x1C010006,
 158                 DCERPC_NCA_S_YOU_CRASHED                = 0x1C010009,
 159                 DCERPC_NCA_S_PROTO_ERROR                = 0x1C01000B,
 160                 DCERPC_NCA_S_OUT_ARGS_TOO_BIG           = 0x1C010013,
 161                 DCERPC_NCA_S_SERVER_TOO_BUSY            = 0x1C010014,
 162                 DCERPC_NCA_S_FAULT_STRING_TOO_LARGE     = 0x1C010015,
 163                 DCERPC_NCA_S_UNSUPPORTED_TYPE           = 0x1C010017,
 164                 DCERPC_NCA_S_FAULT_INT_DIV_BY_ZERO      = 0x1C000001,
 165                 DCERPC_NCA_S_FAULT_ADDR_ERROR           = 0x1C000002,
 166                 DCERPC_NCA_S_FAULT_FP_DIV_BY_ZERO       = 0x1C000003,
 167                 DCERPC_NCA_S_FAULT_FP_UNDERFLOW         = 0x1C000004,
 168                 DCERPC_NCA_S_FAULT_FP_OVERRFLOW         = 0x1C000005,
 169                 DCERPC_NCA_S_FAULT_INVALID_TAG          = 0x1C000006,
 170                 DCERPC_NCA_S_FAULT_INVALID_BOUND        = 0x1C000007,
 171                 DCERPC_NCA_S_FAULT_RPC_VERSION_MISMATCH = 0x1C000008,
 172                 DCERPC_NCA_S_FAULT_UNSPEC_REJECT        = 0x1C000009,
 173                 DCERPC_NCA_S_FAULT_BAD_ACTID            = 0x1C00000A,
 174                 DCERPC_NCA_S_FAULT_WHO_ARE_YOU_FAILED   = 0x1C00000B,
 175                 DCERPC_NCA_S_FAULT_MANAGER_NOT_ENTERED  = 0x1C00000C,
 176                 DCERPC_NCA_S_FAULT_CANCEL               = 0x1C00000D,
 177                 DCERPC_NCA_S_FAULT_ILL_INST             = 0x1C00000E,
 178                 DCERPC_NCA_S_FAULT_FP_ERROR             = 0x1C00000F,
 179                 DCERPC_NCA_S_FAULT_INT_OVERFLOW         = 0x1C000010,
 180                 DCERPC_NCA_S_UNUSED_1C000011            = 0x1C000011,
 181                 DCERPC_NCA_S_FAULT_UNSPEC               = 0x1C000012,
 182                 DCERPC_NCA_S_FAULT_REMOTE_COMM_FAILURE  = 0x1C000013,
 183                 DCERPC_NCA_S_FAULT_PIPE_EMPTY           = 0x1C000014,
 184                 DCERPC_NCA_S_FAULT_PIPE_CLOSED          = 0x1C000015,
 185                 DCERPC_NCA_S_FAULT_PIPE_ORDER           = 0x1C000016,
 186                 DCERPC_NCA_S_FAULT_PIPE_DISCIPLINE      = 0x1C000017,
 187                 DCERPC_NCA_S_FAULT_PIPE_COMM_ERROR      = 0x1C000018,
 188                 DCERPC_NCA_S_FAULT_PIPE_MEMORY          = 0x1C000019,
 189                 DCERPC_NCA_S_FAULT_CONTEXT_MISMATCH     = 0x1C00001A,
 190                 DCERPC_NCA_S_FAULT_REMOTE_NO_MEMORY     = 0x1C00001B,
 191                 DCERPC_NCA_S_INVALID_PRES_CONTEXT_ID    = 0x1C00001C,
 192                 DCERPC_NCA_S_UNSUPPORTED_AUTHN_LEVEL    = 0x1C00001D,
 193                 DCERPC_NCA_S_UNUSED_1C00001E            = 0x1C00001E,
 194                 DCERPC_NCA_S_INVALID_CHECKSUM           = 0x1C00001F,
 195                 DCERPC_NCA_S_INVALID_CRC                = 0x1C000020,
 196                 DCERPC_NCA_S_FAULT_USER_DEFINED         = 0x1C000021,
 197                 DCERPC_NCA_S_FAULT_TX_OPEN_FAILED       = 0x1C000022,
 198                 DCERPC_NCA_S_FAULT_CODESET_CONV_ERROR   = 0x1C000023,
 199                 DCERPC_NCA_S_FAULT_OBJECT_NOT_FOUND     = 0x1C000024,
 200                 DCERPC_NCA_S_FAULT_NO_CLIENT_STUB       = 0x1C000025,
 201                 DCERPC_FAULT_ACCESS_DENIED              = 0x00000005,
 202                 DCERPC_FAULT_NO_CALL_ACTIVE             = 0x000006bd,
 203                 DCERPC_FAULT_CANT_PERFORM               = 0x000006d8,
 204                 DCERPC_FAULT_OUT_OF_RESOURCES           = 0x000006d9,
 205                 DCERPC_FAULT_BAD_STUB_DATA              = 0x000006f7,
 206                 DCERPC_FAULT_SEC_PKG_ERROR              = 0x00000721
 207         } dcerpc_nca_status;
 208
 209         const int DCERPC_FAULT_OP_RNG_ERROR       = DCERPC_NCA_S_OP_RNG_ERROR;
 210         const int DCERPC_FAULT_UNK_IF             = DCERPC_NCA_S_UNKNOWN_IF;
 211         const int DCERPC_FAULT_NDR                = DCERPC_FAULT_BAD_STUB_DATA;
 212         const int DCERPC_FAULT_INVALID_TAG        = DCERPC_NCA_S_FAULT_INVALID_TAG;
 213         const int DCERPC_FAULT_CONTEXT_MISMATCH   = DCERPC_NCA_S_FAULT_CONTEXT_MISMATCH;
 214         const int DCERPC_FAULT_OTHER              = 0x00000001;
 215
 216         /* we return this fault when we haven't yet run the test
 217            to see what fault w2k3 returns in this case */
 218         const int DCERPC_FAULT_TODO         = 0x00000042;
 219
 220         typedef struct {
 221                 uint32 alloc_hint;
 222                 uint16 context_id;
 223                 uint8 cancel_count;
 224                 dcerpc_nca_status status;
 225                 [flag(NDR_REMAINING)] DATA_BLOB _pad;
 226         } dcerpc_fault;
 227
 228         /* the auth types we know about */
 229         typedef [enum8bit] enum {
 230                 DCERPC_AUTH_TYPE_NONE     = 0,
 231                 /* this seems to be not krb5! */
 232                 DCERPC_AUTH_TYPE_KRB5_1   = 1,
 233                 DCERPC_AUTH_TYPE_SPNEGO   = 9,
 234                 DCERPC_AUTH_TYPE_NTLMSSP  = 10,
 235                 DCERPC_AUTH_TYPE_KRB5     = 16,
 236                 DCERPC_AUTH_TYPE_DPA      = 17,
 237                 DCERPC_AUTH_TYPE_MSN      = 18,
 238                 DCERPC_AUTH_TYPE_DIGEST   = 21,
 239                 DCERPC_AUTH_TYPE_SCHANNEL = 68,
 240                 DCERPC_AUTH_TYPE_MSMQ     = 100,
 241                 DCERPC_AUTH_TYPE_NCALRPC_AS_SYSTEM = 200
 242         } dcerpc_AuthType;
 243
 244         typedef [enum8bit] enum {
 245                 DCERPC_AUTH_LEVEL_NONE      = 1,
 246                 DCERPC_AUTH_LEVEL_CONNECT   = 2,
 247                 DCERPC_AUTH_LEVEL_CALL      = 3,
 248                 DCERPC_AUTH_LEVEL_PACKET    = 4,
 249                 DCERPC_AUTH_LEVEL_INTEGRITY = 5,
 250                 DCERPC_AUTH_LEVEL_PRIVACY   = 6
 251         } dcerpc_AuthLevel;
 252
 253         const uint8 DCERPC_AUTH_LEVEL_DEFAULT   = DCERPC_AUTH_LEVEL_CONNECT;
 254
 255         typedef [public] struct {
 256                 dcerpc_AuthType auth_type;
 257                 dcerpc_AuthLevel auth_level;
 258                 uint8  auth_pad_length;
 259                 uint8  auth_reserved;
 260                 uint32 auth_context_id;
 261                 [flag(NDR_REMAINING)] DATA_BLOB credentials;
 262         } dcerpc_auth;
 263
 264         const uint8 DCERPC_AUTH_TRAILER_LENGTH = 8;
 265         const uint8 DCERPC_AUTH_PAD_ALIGNMENT = 16;
 266
 267         typedef [public] struct {
 268                 [value(0)]            uint32    _pad;
 269                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
 270         } dcerpc_auth3;
 271
 272         typedef [public] struct {
 273                 [value(0)]            uint32    _pad;
 274                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
 275         } dcerpc_orphaned;
 276
 277         typedef [public] struct {
 278                 [value(0)]            uint32    _pad;
 279                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
 280         } dcerpc_co_cancel;
 281
 282         typedef [public] struct {
 283                 uint32 version;
 284                 uint32 id;
 285         } dcerpc_cl_cancel;
 286
 287         typedef [public] struct {
 288                 uint32 version;
 289                 uint32 id;
 290                 boolean32 server_is_accepting;
 291         } dcerpc_cancel_ack;
 292
 293         typedef [public] struct {
 294                 uint32 version;
 295                 uint8 _pad1;
 296                 uint16 window_size;
 297                 uint32 max_tdsu;
 298                 uint32 max_frag_size;
 299                 uint16 serial_no;
 300                 uint16 selack_size;
 301                 uint32 selack[selack_size];
 302         } dcerpc_fack;
 303
 304         typedef [public] struct {
 305         } dcerpc_ack;
 306
 307         typedef [public] struct {
 308         } dcerpc_ping;
 309
 310         typedef [public] struct {
 311         } dcerpc_shutdown;
 312
 313         typedef [public] struct {
 314         } dcerpc_working;
 315
 316         /* RTS data structures */
 317         typedef [public] struct {
 318                 GUID            Cookie;
 319         } RTSCookie;
 320
 321         typedef [v1_enum,public] enum {
 322                 RTS_IPV4        = 0,
 323                 RTS_IPV6        = 1
 324         } AddressType;
 325
 326         typedef [nodiscriminant] union {
 327                 [case(RTS_IPV4)] ipv4address    ClientAddressIPV4;
 328                 [case(RTS_IPV6)] ipv6address    ClientAddressIPV6;
 329         } ClientAddressType;
 330
 331         typedef [public] struct {
 332                 AddressType                                     AddressType;
 333                 [switch_is(AddressType)] ClientAddressType      ClientAddress;
 334                 uint8                                           Padding[12];
 335         } ClientAddress;
 336
 337         typedef [v1_enum, public] enum {
 338                 FDClient        = 0,
 339                 FDInProxy       = 1,
 340                 FDServer        = 2,
 341                 FDOutProxy      = 3
 342         } ForwardDestination;
 343
 344         typedef [public] struct {
 345                 uint32          BytesReceived;
 346                 uint32          AvailableWindow;
 347                 RTSCookie       ChannelCookie;
 348         } FlowControlAcknowledgment;
 349
 350         /* RTS commands */
 351
 352         /* RTS command: 0x0 */
 353         typedef [public] struct {
 354                 [range(0x2000,0x40000)] uint32  ReceiveWindowSize;
 355         } dcerpc_rts_cmd_ReceiveWindowSize;
 356
 357         /* RTS command: 0x1 */
 358         typedef [public] struct {
 359                 FlowControlAcknowledgment       Ack;
 360         } dcerpc_rts_cmd_FlowControlAck;
 361
 362         /* RTS command: 0x2 */
 363         typedef [public] struct {
 364                 [range(0x1D4C0,0xDBBA00)] uint32        ConnectionTimeout;
 365         } dcerpc_rts_cmd_ConnectionTimeout;
 366
 367         /* RTS command: 0x3 */
 368         typedef [public] struct {
 369                 RTSCookie       Cookie;
 370         } dcerpc_rts_cmd_Cookie;
 371
 372         /* RTS command: 0x4 */
 373         typedef [public] struct {
 374                 [range(0x20000,0x80000000)] uint32      ChannelLifetime;
 375         } dcerpc_rts_cmd_ChannelLifetime;
 376
 377         /* RTS command: 0x5 */
 378         typedef [public] struct {
 379                 uint32          ClientKeepalive;
 380         } dcerpc_rts_cmd_ClientKeepalive;
 381
 382         /* RTS command: 0x6 */
 383         typedef [public] struct {
 384                 uint32          Version;
 385         } dcerpc_rts_cmd_Version;
 386
 387         /* RTS command: 0x7 */
 388         typedef [public] struct {
 389         } dcerpc_rts_cmd_Empty;
 390
 391         /* RTS command: 0x8 */
 392         typedef [public] struct {
 393                 [range(0x0,0xFFFF)] uint32      ConformanceCount;
 394                 uint8                           Padding[ConformanceCount];
 395         } dcerpc_rts_cmd_Padding;
 396
 397         /* RTS command: 0x9 */
 398         typedef [public] struct {
 399         } dcerpc_rts_cmd_NegativeANCE;
 400
 401         /* RTS Command: 0xA */
 402         typedef [public] struct {
 403         } dcerpc_rts_cmd_ANCE;
 404
 405         /* RTS command: 0xB */
 406         typedef [public] struct {
 407                 ClientAddress   ClientAddress;
 408         } dcerpc_rts_cmd_ClientAddress;
 409
 410         /* RTS command: 0xC */
 411         typedef [public] struct {
 412                 RTSCookie       AssociationGroupId;
 413         } dcerpc_rts_cmd_AssociationGroupId;
 414
 415         /* RTS command: 0xD */
 416         typedef [public] struct {
 417                 ForwardDestination      ForwardDestination;
 418         } dcerpc_rts_cmd_Destination;
 419
 420         /* RTS command: 0xE */
 421         typedef [public] struct {
 422                 uint32  PingTrafficSent;
 423         } dcerpc_rts_cmd_PingTrafficSentNotify;
 424
 425         typedef [nodiscriminant] union {
 426                 [case(0x0)] dcerpc_rts_cmd_ReceiveWindowSize            ReceiveWindowSize;
 427                 [case(0x1)] dcerpc_rts_cmd_FlowControlAck               FlowControlAck;
 428                 [case(0x2)] dcerpc_rts_cmd_ConnectionTimeout            ConnectionTimeout;
 429                 [case(0x3)] dcerpc_rts_cmd_Cookie                       Cookie;
 430                 [case(0x4)] dcerpc_rts_cmd_ChannelLifetime              ChannelLifetime;
 431                 [case(0x5)] dcerpc_rts_cmd_ClientKeepalive              ClientKeepalive;
 432                 [case(0x6)] dcerpc_rts_cmd_Version                      Version;
 433                 [case(0x7)] dcerpc_rts_cmd_Empty                        Empty;
 434                 [case(0x8)] dcerpc_rts_cmd_Padding                      Padding;
 435                 [case(0x9)] dcerpc_rts_cmd_NegativeANCE                 NegativeANCE;
 436                 [case(0xA)] dcerpc_rts_cmd_ANCE                         ANCE;
 437                 [case(0xB)] dcerpc_rts_cmd_ClientAddress                ClientAddress;
 438                 [case(0xC)] dcerpc_rts_cmd_AssociationGroupId           AssociationGroupId;
 439                 [case(0xD)] dcerpc_rts_cmd_Destination                  Destination;
 440                 [case(0xE)] dcerpc_rts_cmd_PingTrafficSentNotify        PingTrafficSentNotify;
 441         } dcerpc_rts_cmds;
 442
 443         typedef [public] struct {
 444                 uint32                                          CommandType;
 445                 [switch_is(CommandType)] dcerpc_rts_cmds        Command;
 446         } dcerpc_rts_cmd;
 447
 448         /* The RTS flags */
 449         typedef [public, bitmap16bit] bitmap {
 450                 RTS_FLAG_NONE                   =       0x0000,
 451                 RTS_FLAG_PING                   =       0x0001,
 452                 RTS_FLAG_OTHER_CMD              =       0x0002,
 453                 RTS_FLAG_RECYCLE_CHANNEL        =       0x0004,
 454                 RTS_FLAG_IN_CHANNEL             =       0x0008,
 455                 RTS_FLAG_OUT_CHANNEL            =       0x0010,
 456                 RTS_FLAG_EOF                    =       0x0020,
 457                 RTS_FLAG_ECHO                   =       0x0040
 458         } dcerpc_rts_flags;
 459
 460         typedef [public] struct {
 461                 dcerpc_rts_flags        Flags;
 462                 uint16                  NumberOfCommands;
 463                 dcerpc_rts_cmd          Commands[NumberOfCommands];
 464         } dcerpc_rts;
 465
 466         typedef [enum8bit] enum {
 467                 DCERPC_PKT_REQUEST     =  0,    /* Ordinary request. */
 468                 DCERPC_PKT_PING        =  1,    /* Connectionless is server alive ? */
 469                 DCERPC_PKT_RESPONSE    =  2,    /* Ordinary reply. */
 470                 DCERPC_PKT_FAULT       =  3,    /* Fault in processing of call. */
 471                 DCERPC_PKT_WORKING     =  4,    /* Connectionless reply to a ping when server busy. */
 472                 DCERPC_PKT_NOCALL      =  5,    /* Connectionless reply to a ping when server has lost part of clients call. */
 473                 DCERPC_PKT_REJECT      =  6,    /* Refuse a request with a code. */
 474                 DCERPC_PKT_ACK         =  7,    /* Connectionless client to server code. */
 475                 DCERPC_PKT_CL_CANCEL   =  8,    /* Connectionless cancel. */
 476                 DCERPC_PKT_FACK        =  9,    /* Connectionless fragment ack. Both client and server send. */
 477                 DCERPC_PKT_CANCEL_ACK  = 10,    /* Server ACK to client cancel request. */
 478                 DCERPC_PKT_BIND        = 11,    /* Bind to interface. */
 479                 DCERPC_PKT_BIND_ACK    = 12,    /* Server ack of bind. */
 480                 DCERPC_PKT_BIND_NAK    = 13,    /* Server nack of bind. */
 481                 DCERPC_PKT_ALTER       = 14,    /* Alter auth. */
 482                 DCERPC_PKT_ALTER_RESP  = 15,    /* Reply to alter auth. */
 483                 DCERPC_PKT_AUTH3       = 16,    /* not the real name!  this is undocumented! */
 484                 DCERPC_PKT_SHUTDOWN    = 17,    /* Server to client request to shutdown. */
 485                 DCERPC_PKT_CO_CANCEL   = 18,    /* Connection-oriented cancel request. */
 486                 DCERPC_PKT_ORPHANED    = 19,    /* Client telling server it's aborting a partially sent request or telling server to stop sending replies. */
 487                 DCERPC_PKT_RTS         = 20     /* RTS packets used in ncacn_http */
 488         } dcerpc_pkt_type;
 489
 490         typedef [nodiscriminant] union {
 491                 [case(DCERPC_PKT_REQUEST)]    dcerpc_request  request;
 492                 [case(DCERPC_PKT_PING)]           dcerpc_ping ping;
 493                 [case(DCERPC_PKT_RESPONSE)]   dcerpc_response response;
 494                 [case(DCERPC_PKT_FAULT)]          dcerpc_fault fault;
 495                 [case(DCERPC_PKT_WORKING)]        dcerpc_working working;
 496                 [case(DCERPC_PKT_NOCALL)]     dcerpc_fack nocall;
 497                 [case(DCERPC_PKT_REJECT)]     dcerpc_fault reject;
 498                 [case(DCERPC_PKT_ACK)]        dcerpc_ack ack;
 499                 [case(DCERPC_PKT_CL_CANCEL)]  dcerpc_cl_cancel cl_cancel;
 500                 [case(DCERPC_PKT_FACK)]       dcerpc_fack fack;
 501                 [case(DCERPC_PKT_CANCEL_ACK)] dcerpc_cancel_ack cancel_ack;
 502                 [case(DCERPC_PKT_BIND)]       dcerpc_bind     bind;
 503                 [case(DCERPC_PKT_BIND_ACK)]   dcerpc_bind_ack bind_ack;
 504                 [case(DCERPC_PKT_BIND_NAK)]   dcerpc_bind_nak bind_nak;
 505                 [case(DCERPC_PKT_ALTER)]      dcerpc_bind     alter;
 506                 [case(DCERPC_PKT_ALTER_RESP)] dcerpc_bind_ack alter_resp;
 507                 [case(DCERPC_PKT_SHUTDOWN)]   dcerpc_shutdown shutdown;
 508                 [case(DCERPC_PKT_CO_CANCEL)]  dcerpc_co_cancel co_cancel;
 509                 [case(DCERPC_PKT_ORPHANED)]   dcerpc_orphaned orphaned;
 510                 [case(DCERPC_PKT_AUTH3)]      dcerpc_auth3    auth3;
 511                 [case(DCERPC_PKT_RTS)]        dcerpc_rts      rts;
 512         } dcerpc_payload;
 513
 514         /* pfc_flags values */
 515         typedef [bitmap8bit] bitmap {
 516                 DCERPC_PFC_FLAG_FIRST           = 0x01, /* First fragment */
 517                 DCERPC_PFC_FLAG_LAST            = 0x02, /* Last fragment */
 518                 DCERPC_PFC_FLAG_PENDING_CANCEL_OR_HDR_SIGNING = 0x04, /* depends on the pdu type */
 519                 DCERPC_PFC_FLAG_CONC_MPX        = 0x10, /* supports concurrent multiplexing of a single connection. */
 520                 DCERPC_PFC_FLAG_DID_NOT_EXECUTE = 0x20, /* on a fault it means the server hasn't done anything */
 521                 DCERPC_PFC_FLAG_MAYBE           = 0x40, /* `maybe' call semantics requested */
 522                 DCERPC_PFC_FLAG_OBJECT_UUID     = 0x80 /* on valid guid is in the optional object field */
 523         } dcerpc_pfc_flags;
 524
 525         /* Cancel was pending at sender */
 526         const int DCERPC_PFC_FLAG_PENDING_CANCEL =
 527                 DCERPC_PFC_FLAG_PENDING_CANCEL_OR_HDR_SIGNING;
 528         const int DCERPC_PFC_FLAG_SUPPORT_HEADER_SIGN =
 529                 DCERPC_PFC_FLAG_PENDING_CANCEL_OR_HDR_SIGNING;
 530
 531         /* these offsets are needed by the signing code */
 532         const uint8 DCERPC_PFC_OFFSET      =  3;
 533         const uint8 DCERPC_DREP_OFFSET     =  4;
 534         const uint8 DCERPC_FRAG_LEN_OFFSET =  8;
 535         const uint32 DCERPC_FRAG_MAX_SIZE  = 5840;
 536         const uint8 DCERPC_AUTH_LEN_OFFSET = 10;
 537         const uint8 DCERPC_NCACN_PAYLOAD_OFFSET = 16;
 538         const uint32 DCERPC_NCACN_PAYLOAD_MAX_SIZE = 0x400000; /* 4 MByte */
 539
 540         /* little-endian flag */
 541         const uint8 DCERPC_DREP_LE  = 0x10;
 542
 543         typedef [public] struct {
 544                 uint8 rpc_vers;         /* RPC version */
 545                 uint8 rpc_vers_minor;   /* Minor version */
 546                 dcerpc_pkt_type ptype;  /* Packet type */
 547                 dcerpc_pfc_flags pfc_flags; /* Fragmentation flags */
 548                 uint8 drep[4];          /* NDR data representation */
 549                 uint16 frag_length;     /* Total length of fragment */
 550                 uint16 auth_length;     /* authenticator length */
 551                 uint32 call_id;         /* Call identifier */
 552                 [switch_is(ptype)] dcerpc_payload u;
 553         } ncacn_packet;
 554
 555         typedef [public] struct {
 556                 uint8 rpc_vers;         /* RPC version (4) */
 557                 uint8 ptype;
 558                 uint8 pfc_flags;
 559                 uint8 ncadg_flags;
 560                 uint8 drep[3];
 561                 uint8 serial_high;
 562                 GUID object;
 563                 GUID iface;
 564                 GUID activity;
 565                 uint32 server_boot; /* Server boot time */
 566                 uint32 iface_version;
 567                 uint32 seq_num;
 568                 uint16 opnum;
 569                 uint16 ihint;
 570                 uint16 ahint;
 571                 uint16 len;
 572                 uint16 fragnum;
 573                 uint8 auth_proto;
 574                 uint8 serial_low;
 575                 [switch_is(ptype)] dcerpc_payload u;
 576         } ncadg_packet;
 577
 578         typedef [bitmap16bit] bitmap {
 579                 DCERPC_SEC_VT_COMMAND_ENUM  = 0x3FFF,
 580                 DCERPC_SEC_VT_COMMAND_END   = 0x4000,
 581                 DCERPC_SEC_VT_MUST_PROCESS  = 0x8000
 582         } dcerpc_sec_vt_command;
 583
 584         typedef [enum16bit] enum {
 585                 DCERPC_SEC_VT_COMMAND_BITMASK1  = 0x0001,
 586                 DCERPC_SEC_VT_COMMAND_PCONTEXT  = 0x0002,
 587                 DCERPC_SEC_VT_COMMAND_HEADER2   = 0x0003
 588         } dcerpc_sec_vt_command_enum;
 589
 590         typedef [bitmap32bit] bitmap {
 591                 DCERPC_SEC_VT_CLIENT_SUPPORTS_HEADER_SIGNING = 0x00000001
 592         } dcerpc_sec_vt_bitmask1;
 593
 594         typedef struct {
 595                 ndr_syntax_id abstract_syntax;
 596                 ndr_syntax_id transfer_syntax;
 597         } dcerpc_sec_vt_pcontext;
 598
 599         typedef struct {
 600                 dcerpc_pkt_type ptype;  /* Packet type */
 601                 [value(0)] uint8 reserved1;
 602                 [value(0)] uint16 reserved2;
 603                 uint8 drep[4];          /* NDR data representation */
 604                 uint32 call_id;         /* Call identifier */
 605                 uint16 context_id;
 606                 uint16 opnum;
 607         } dcerpc_sec_vt_header2;
 608
 609         typedef [switch_type(dcerpc_sec_vt_command_enum),nodiscriminant] union {
 610         [case(DCERPC_SEC_VT_COMMAND_BITMASK1)] dcerpc_sec_vt_bitmask1 bitmask1;
 611         [case(DCERPC_SEC_VT_COMMAND_PCONTEXT)] dcerpc_sec_vt_pcontext pcontext;
 612         [case(DCERPC_SEC_VT_COMMAND_HEADER2)] dcerpc_sec_vt_header2 header2;
 613         [default,flag(NDR_REMAINING)] DATA_BLOB _unknown;
 614         } dcerpc_sec_vt_union;
 615
 616         typedef struct {
 617                 dcerpc_sec_vt_command command;
 618                 [switch_is(command & DCERPC_SEC_VT_COMMAND_ENUM)]
 619                         [subcontext(2),flag(NDR_SUBCONTEXT_NO_UNREAD_BYTES)]
 620                         dcerpc_sec_vt_union u;
 621         } dcerpc_sec_vt;
 622
 623         typedef [public,nopush,nopull] struct {
 624                 uint16 count;
 625         } dcerpc_sec_vt_count;
 626
 627         /*
 628          * We assume that the whole verification trailer fits into
 629          * the last 1024 bytes after the stub data.
 630          *
 631          * There're currently only 3 commands defined and each should
 632          * only be used once.
 633          */
 634         const uint16 DCERPC_SEC_VT_MAX_SIZE = 1024;
 635
 636         typedef [public,flag(NDR_PAHEX)] struct {
 637                 [flag(NDR_ALIGN4)] DATA_BLOB _pad;
 638                 [value(DCERPC_SEC_VT_MAGIC)] uint8 magic[8];
 639                 dcerpc_sec_vt_count count;
 640                 dcerpc_sec_vt commands[count.count];
 641         } dcerpc_sec_verification_trailer;
 642 }