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