source4/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 http://www.opengroup.org/onlinepubs/9629399/chap12.htm for packet
   9   layouts
  10 */
  11 []
  12 interface dcerpc
  13 {
  14         typedef [public] struct {
  15                 GUID uuid;
  16                 uint16 major_version;
  17                 uint16 minor_version;
  18         } dcerpc_syntax_id;
  19
  20         typedef struct {
  21                 uint16 context_id;
  22                 uint8 num_transfer_syntaxes;
  23                 dcerpc_syntax_id abstract_syntax;
  24                 dcerpc_syntax_id transfer_syntaxes[num_transfer_syntaxes];
  25         } dcerpc_ctx_list;
  26
  27         typedef struct {
  28                 uint16 max_xmit_frag;
  29                 uint16 max_recv_frag;
  30                 uint32 assoc_group_id;
  31                 uint8 num_contexts;
  32                 dcerpc_ctx_list ctx_list[num_contexts];
  33                 [flag(NDR_ALIGN8)]    DATA_BLOB _pad;
  34                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
  35         } dcerpc_bind;
  36
  37
  38         const uint8 DCERPC_REQUEST_LENGTH = 24;
  39         const uint8 DCERPC_MAX_SIGN_SIZE  = 32;
  40
  41         typedef struct {
  42                 uint32 alloc_hint;
  43                 uint16 context_id;
  44                 uint16 opnum;
  45                 [flag(NDR_ALIGN8)]    DATA_BLOB _pad;
  46                 [flag(NDR_REMAINING)] DATA_BLOB stub_and_verifier;
  47         } dcerpc_request;
  48
  49         const int DCERPC_BIND_PROVIDER_REJECT = 2;
  50         const int DCERPC_BIND_REASON_ASYNTAX  = 1;
  51
  52         typedef struct {
  53                 uint16 result;
  54                 uint16 reason;
  55                 dcerpc_syntax_id syntax;
  56         } dcerpc_ack_ctx;
  57
  58         typedef struct {
  59                 uint16 max_xmit_frag;
  60                 uint16 max_recv_frag;
  61                 uint32 assoc_group_id;
  62                 ascstr3 secondary_address;
  63                 [flag(NDR_ALIGN4)]    DATA_BLOB _pad1;
  64                 uint8 num_results;
  65                 dcerpc_ack_ctx ctx_list[num_results];
  66                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
  67         } dcerpc_bind_ack;
  68
  69         typedef struct {
  70                 uint16 reject_reason;
  71                 uint32 num_versions;
  72                 uint32 versions[num_versions];
  73         } dcerpc_bind_nak;
  74
  75         const uint8 DCERPC_RESPONSE_LENGTH = 24;
  76
  77         typedef struct {
  78                 uint32 alloc_hint;
  79                 uint16 context_id;
  80                 uint8 cancel_count;
  81                 [flag(NDR_ALIGN8)]    DATA_BLOB _pad;
  82                 [flag(NDR_REMAINING)] DATA_BLOB stub_and_verifier;
  83         } dcerpc_response;
  84
  85
  86         const int DCERPC_FAULT_OP_RNG_ERROR       = 0x1c010002;
  87         const int DCERPC_FAULT_NDR                = 0x000006f7;
  88         const int DCERPC_FAULT_CONTEXT_MISMATCH   = 0x1c00001a;
  89         const int DCERPC_FAULT_OTHER              = 0x00000001;
  90
  91         /* we return this fault when we haven't yet run the test
  92            to see what fault w2k3 returns in this case */
  93         const int DCERPC_FAULT_TODO         = 0x00000042;
  94
  95         typedef struct {
  96                 uint32 alloc_hint;
  97                 uint16 context_id;
  98                 uint8 cancel_count;
  99                 uint32 status;
 100         } dcerpc_fault;
 101
 102
 103         const uint8 DCERPC_AUTH_TYPE_NONE    = 0;
 104         const uint8 DCERPC_AUTH_TYPE_KRB5    = 1;
 105         const uint8 DCERPC_AUTH_TYPE_NTLMSSP = 10;
 106
 107         const uint8 DCERPC_AUTH_LEVEL_NONE      = 1;
 108         const uint8 DCERPC_AUTH_LEVEL_CONNECT   = 2;
 109         const uint8 DCERPC_AUTH_LEVEL_CALL      = 3;
 110         const uint8 DCERPC_AUTH_LEVEL_PACKET    = 4;
 111         const uint8 DCERPC_AUTH_LEVEL_INTEGRITY = 5;
 112         const uint8 DCERPC_AUTH_LEVEL_PRIVACY   = 6;
 113
 114         typedef [public] struct {
 115                 uint8  auth_type;
 116                 uint8  auth_level;
 117                 uint8  auth_pad_length;
 118                 uint8  auth_reserved;
 119                 uint32 auth_context_id;
 120                 [flag(NDR_REMAINING)] DATA_BLOB credentials;
 121         } dcerpc_auth;
 122
 123         typedef [public] struct {
 124                 uint32 _pad;
 125                 [flag(NDR_REMAINING)] DATA_BLOB auth_info;
 126         } dcerpc_auth3;
 127
 128         typedef enum {
 129                 DCERPC_PKT_REQUEST     =  0,
 130                 DCERPC_PKT_PING        =  1,
 131                 DCERPC_PKT_RESPONSE    =  2,
 132                 DCERPC_PKT_FAULT       =  3,
 133                 DCERPC_PKT_WORKING     =  4,
 134                 DCERPC_PKT_NOCALL      =  5,
 135                 DCERPC_PKT_REJECT      =  6,
 136                 DCERPC_PKT_ACK         =  7,
 137                 DCERPC_PKT_CL_CANCEL   =  8,
 138                 DCERPC_PKT_FACK        =  9,
 139                 DCERPC_PKT_CANCEL_ACK  = 10,
 140                 DCERPC_PKT_BIND        = 11,
 141                 DCERPC_PKT_BIND_ACK    = 12,
 142                 DCERPC_PKT_BIND_NAK    = 13,
 143                 DCERPC_PKT_ALTER       = 14,
 144                 DCERPC_PKT_ALTER_ACK   = 15,
 145                 DCERPC_PKT_AUTH3       = 16,
 146                 DCERPC_PKT_SHUTDOWN    = 17,
 147                 DCERPC_PKT_CO_CANCEL   = 18,
 148                 DCERPC_PKT_ORPHANED    = 19
 149         } dcerpc_pkt_type;
 150
 151         typedef [nodiscriminant] union {
 152                 [case(DCERPC_PKT_REQUEST)]   dcerpc_request  request;
 153                 [case(DCERPC_PKT_RESPONSE)]  dcerpc_response response;
 154                 [case(DCERPC_PKT_BIND)]      dcerpc_bind     bind;
 155                 [case(DCERPC_PKT_BIND_ACK)]  dcerpc_bind_ack bind_ack;
 156                 [case(DCERPC_PKT_ALTER)]     dcerpc_bind     alter;
 157                 [case(DCERPC_PKT_ALTER_ACK)] dcerpc_bind_ack alter_ack;
 158                 [case(DCERPC_PKT_FAULT)]     dcerpc_fault    fault;
 159                 [case(DCERPC_PKT_AUTH3)]     dcerpc_auth3    auth;
 160                 [case(DCERPC_PKT_BIND_NAK)]  dcerpc_bind_nak bind_nak;
 161         } dcerpc_payload;
 162
 163
 164         /* pfc_flags values */
 165         const uint8 DCERPC_PFC_FLAG_FIRST  = 0x01;
 166         const uint8 DCERPC_PFC_FLAG_LAST   = 0x02;
 167         const uint8 DCERPC_PFC_FLAG_NOCALL = 0x20;
 168
 169         /* these offsets are needed by the signing code */
 170         const uint8 DCERPC_FRAG_LEN_OFFSET =  8;
 171         const uint8 DCERPC_AUTH_LEN_OFFSET = 10;
 172
 173         typedef [public] struct {
 174                 uint8 rpc_vers;         /* RPC version */
 175                 uint8 rpc_vers_minor;   /* Minor version */
 176                 uint8 ptype;            /* Packet type */
 177                 uint8 pfc_flags;        /* Fragmentation flags */
 178                 uint8 drep[4];          /* NDR data representation */
 179                 uint16 frag_length;     /* Total length of fragment */
 180                 uint16 auth_length;     /* authenticator length */
 181                 uint32 call_id;         /* Call identifier */
 182
 183                 [switch_is(ptype)] dcerpc_payload u;
 184         } dcerpc_packet;
 185 }