source/include/rpc_reg.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell                 1992-1997.
   5    Copyright (C) Luke Kenneth Casson Leighton    1996-1997.
   6    Copyright (C) Paul Ashton                          1997.
   7    Copyright (C) Gerald Carter                        2002.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #ifndef _RPC_REG_H /* _RPC_REG_H */
  25 #define _RPC_REG_H
  26
  27
  28 /* winreg pipe defines
  29    NOT IMPLEMENTED !!
  30 #define _REG_UNK_01             0x01
  31 #define _REG_UNK_03             0x03
  32 #define REG_CREATE_KEY          0x06
  33 #define REG_DELETE_KEY          0x07
  34 #define REG_DELETE_VALUE        0x08
  35 #define REG_FLUSH_KEY           0x0b
  36 #define REG_GET_KEY_SEC         0x0c
  37 #define _REG_UNK_0D             0x0d
  38 #define _REG_UNK_0E             0x0e
  39 #define _REG_UNK_12             0x12
  40 #define _REG_UNK_13             0x13
  41 #define REG_SET_KEY_SEC         0x15
  42 #define REG_CREATE_VALUE        0x16
  43 #define _REG_UNK_17             0x17
  44 */
  45
  46 /* Implemented */
  47 #define REG_OPEN_HKCR           0x00
  48 #define REG_OPEN_HKLM           0x02
  49 #define REG_OPEN_HKU            0x04
  50 #define REG_CLOSE               0x05
  51 #define REG_ENUM_KEY            0x09
  52 #define REG_ENUM_VALUE          0x0a
  53 #define REG_OPEN_ENTRY          0x0f
  54 #define REG_QUERY_KEY           0x10
  55 #define REG_INFO                0x11
  56 #define REG_SHUTDOWN            0x18
  57 #define REG_ABORT_SHUTDOWN      0x19
  58 #define REG_SAVE_KEY            0x14    /* no idea what the real name is */
  59 #define REG_UNKNOWN_1A          0x1a
  60
  61
  62 #define HKEY_CLASSES_ROOT       0x80000000
  63 #define HKEY_CURRENT_USER       0x80000001
  64 #define HKEY_LOCAL_MACHINE      0x80000002
  65 #define HKEY_USERS              0x80000003
  66
  67 #define KEY_HKLM        "HKLM"
  68 #define KEY_HKU         "HKU"
  69 #define KEY_HKCR        "HKCR"
  70 #define KEY_PRINTING    "HKLM\\SYSTEM\\CurrentControlSet\\Control\\Print"
  71 #define KEY_TREE_ROOT   ""
  72
  73 /* Registry data types */
  74
  75 #define REG_NONE                       0
  76 #define REG_SZ                         1
  77 #define REG_EXPAND_SZ                  2
  78 #define REG_BINARY                     3
  79 #define REG_DWORD                      4
  80 #define REG_DWORD_LE                   4        /* DWORD, little endian */
  81 #define REG_DWORD_BE                   5        /* DWORD, big endian */
  82 #define REG_LINK                       6
  83 #define REG_MULTI_SZ                   7
  84 #define REG_RESOURCE_LIST              8
  85 #define REG_FULL_RESOURCE_DESCRIPTOR   9
  86 #define REG_RESOURCE_REQUIREMENTS_LIST 10
  87
  88 /* Shutdown options */
  89 #define REG_FORCE_SHUTDOWN 0x001
  90 #define REG_REBOOT_ON_SHUTDOWN 0x100
  91
  92 /* structure to contain registry values */
  93
  94 typedef struct {
  95         fstring         valuename;
  96         uint16          type;
  97         uint32          size;   /* in bytes */
  98         uint8           *data_p;
  99 } REGISTRY_VALUE;
 100
 101 /* container for regostry values */
 102
 103 typedef struct {
 104         TALLOC_CTX      *ctx;
 105         uint32          num_values;
 106         REGISTRY_VALUE  **values;
 107 } REGVAL_CTR;
 108
 109 /* container for registry subkey names */
 110
 111 typedef struct {
 112         TALLOC_CTX      *ctx;
 113         uint32          num_subkeys;
 114         char            **subkeys;
 115 } REGSUBKEY_CTR;
 116
 117
 118 /*
 119  * container for function pointers to enumeration routines
 120  * for vitural registry view
 121  */
 122
 123 typedef struct {
 124         /* functions for enumerating subkeys and values */
 125         int     (*subkey_fn)( char *key, REGSUBKEY_CTR *subkeys);
 126         int     (*value_fn) ( char *key, REGVAL_CTR *val );
 127         BOOL    (*store_subkeys_fn)( char *key, REGSUBKEY_CTR *subkeys );
 128         BOOL    (*store_values_fn)( char *key, REGVAL_CTR *val );
 129 } REGISTRY_OPS;
 130
 131 typedef struct {
 132         char            *keyname;       /* full path to name of key */
 133         REGISTRY_OPS    *ops;           /* registry function hooks */
 134 } REGISTRY_HOOK;
 135
 136
 137
 138 /* structure to store the registry handles */
 139
 140 typedef struct _RegistryKey {
 141
 142         struct _RegistryKey *prev, *next;
 143
 144         POLICY_HND      hnd;
 145         pstring         name;   /* full name of registry key */
 146         REGISTRY_HOOK   *hook;
 147
 148 } REGISTRY_KEY;
 149
 150
 151 /* REG_Q_OPEN_HKCR   */
 152 typedef struct q_reg_open_hkcr_info
 153 {
 154         uint32 ptr;
 155         uint16 unknown_0; /* 0x5428      - 16 bit unknown */
 156         uint16 unknown_1; /* random.  changes */
 157         uint32 level;     /* 0x0000 0002 - 32 bit unknown */
 158
 159 } REG_Q_OPEN_HKCR  ;
 160
 161 /* REG_R_OPEN_HKCR   */
 162 typedef struct r_reg_open_hkcr_info
 163 {
 164         POLICY_HND pol;       /* policy handle */
 165         NTSTATUS status;         /* return status */
 166
 167 } REG_R_OPEN_HKCR;
 168
 169
 170 /* REG_Q_OPEN_HKLM   */
 171 typedef struct q_reg_open_hklm_info
 172 {
 173         uint32 ptr;
 174         uint16 unknown_0;       /* 0xE084      - 16 bit unknown */
 175         uint16 unknown_1;       /* random.  changes */
 176         uint32 access_mask;
 177
 178 }
 179 REG_Q_OPEN_HKLM;
 180
 181 /* REG_R_OPEN_HKLM   */
 182 typedef struct r_reg_open_hklm_info
 183 {
 184         POLICY_HND pol;         /* policy handle */
 185         NTSTATUS status;                /* return status */
 186
 187 }
 188 REG_R_OPEN_HKLM;
 189
 190
 191 /* REG_Q_OPEN_HKU */
 192 typedef struct q_reg_open_hku_info
 193 {
 194         uint32 ptr;
 195         uint16 unknown_0;
 196         uint16 unknown_1;
 197         uint32 access_mask;
 198
 199 } REG_Q_OPEN_HKU;
 200
 201 /* REG_R_OPEN_HKU */
 202 typedef struct r_reg_open_hku_info
 203 {
 204         POLICY_HND pol;      /* policy handle */
 205         NTSTATUS status;     /* return status */
 206
 207 } REG_R_OPEN_HKU;
 208
 209
 210 /* REG_Q_FLUSH_KEY */
 211 typedef struct q_reg_open_flush_key_info
 212 {
 213         POLICY_HND pol;       /* policy handle */
 214
 215 } REG_Q_FLUSH_KEY;
 216
 217 /* REG_R_FLUSH_KEY */
 218 typedef struct r_reg_open_flush_key_info
 219 {
 220         NTSTATUS status;         /* return status */
 221
 222 } REG_R_FLUSH_KEY;
 223
 224
 225 /* REG_Q_SET_KEY_SEC */
 226 typedef struct q_reg_set_key_sec_info
 227 {
 228         POLICY_HND pol;         /* policy handle */
 229
 230         uint32 sec_info;       /* xxxx_SECURITY_INFORMATION */
 231
 232         uint32 ptr;       /* pointer */
 233         BUFHDR hdr_sec;    /* header for security data */
 234         SEC_DESC_BUF *data;    /* security data */
 235
 236 } REG_Q_SET_KEY_SEC;
 237
 238 /* REG_R_SET_KEY_SEC */
 239 typedef struct r_reg_set_key_sec_info
 240 {
 241         NTSTATUS status;
 242
 243 } REG_R_SET_KEY_SEC;
 244
 245
 246 /* REG_Q_GET_KEY_SEC */
 247 typedef struct q_reg_get_key_sec_info
 248 {
 249         POLICY_HND pol;         /* policy handle */
 250
 251         uint32 sec_info;       /* xxxx_SECURITY_INFORMATION */
 252
 253         uint32 ptr;       /* pointer */
 254         BUFHDR hdr_sec;    /* header for security data */
 255         SEC_DESC_BUF *data;    /* security data */
 256
 257 } REG_Q_GET_KEY_SEC;
 258
 259 /* REG_R_GET_KEY_SEC */
 260 typedef struct r_reg_get_key_sec_info
 261 {
 262         uint32 sec_info;       /* xxxx_SECURITY_INFORMATION */
 263
 264         uint32 ptr;       /* pointer */
 265         BUFHDR hdr_sec;    /* header for security data */
 266         SEC_DESC_BUF *data;    /* security data */
 267
 268         NTSTATUS status;
 269
 270 } REG_R_GET_KEY_SEC;
 271
 272 /* REG_Q_CREATE_VALUE */
 273 typedef struct q_reg_create_value_info
 274 {
 275         POLICY_HND pol;    /* policy handle */
 276
 277         UNIHDR hdr_name;   /* name of value */
 278         UNISTR2 uni_name;
 279
 280         uint32 type;       /* 1 = UNISTR, 3 = BYTES, 4 = DWORD, 7 = MULTI_UNISTR */
 281
 282         BUFFER3 *buf_value; /* value, in byte buffer */
 283
 284 } REG_Q_CREATE_VALUE;
 285
 286 /* REG_R_CREATE_VALUE */
 287 typedef struct r_reg_create_value_info
 288 {
 289         NTSTATUS status;         /* return status */
 290
 291 } REG_R_CREATE_VALUE;
 292
 293 /* REG_Q_ENUM_VALUE */
 294 typedef struct q_reg_query_value_info
 295 {
 296         POLICY_HND pol;    /* policy handle */
 297
 298         uint32 val_index;  /* index */
 299
 300         UNIHDR hdr_name;   /* name of value */
 301         UNISTR2 uni_name;
 302
 303         uint32 ptr_type;   /* pointer */
 304         uint32 type;       /* 1 = UNISTR, 3 = BYTES, 4 = DWORD, 7 = MULTI_UNISTR */
 305
 306         uint32 ptr_value;  /* pointer */
 307         BUFFER2 buf_value; /* value, in byte buffer */
 308
 309         uint32 ptr1;       /* pointer */
 310         uint32 len_value1; /* */
 311
 312         uint32 ptr2;       /* pointer */
 313         uint32 len_value2; /* */
 314
 315
 316 } REG_Q_ENUM_VALUE;
 317
 318 /* REG_R_ENUM_VALUE */
 319 typedef struct r_reg_enum_value_info
 320 {
 321         UNIHDR hdr_name;        /* name of value */
 322         UNISTR2 uni_name;
 323
 324         uint32 ptr_type;            /* pointer */
 325         uint32 type;        /* 1 = UNISTR, 3 = BYTES, 4 = DWORD, 7 = MULTI_UNISTR */
 326
 327         uint32 ptr_value;       /* pointer */
 328         BUFFER2 buf_value;    /* value, in byte buffer */
 329
 330         uint32 ptr1;            /* pointer */
 331         uint32 len_value1;       /* */
 332
 333         uint32 ptr2;            /* pointer */
 334         uint32 len_value2;       /* */
 335
 336         NTSTATUS status;         /* return status */
 337
 338 } REG_R_ENUM_VALUE;
 339
 340 /* REG_Q_CREATE_KEY */
 341 typedef struct q_reg_create_key_info
 342 {
 343         POLICY_HND pnt_pol;       /* parent key policy handle */
 344
 345         UNIHDR hdr_name;
 346         UNISTR2 uni_name;
 347
 348         UNIHDR hdr_class;
 349         UNISTR2 uni_class;
 350
 351         uint32 reserved; /* 0x0000 0000 */
 352         SEC_ACCESS sam_access; /* access rights flags, see rpc_secdes.h */
 353
 354         uint32 ptr1;
 355         uint32 sec_info; /* xxxx_SECURITY_INFORMATION */
 356
 357         uint32 ptr2;       /* pointer */
 358         BUFHDR hdr_sec;    /* header for security data */
 359         uint32 ptr3;       /* pointer */
 360         SEC_DESC_BUF *data;
 361
 362         uint32 unknown_2; /* 0x0000 0000 */
 363
 364 } REG_Q_CREATE_KEY;
 365
 366 /* REG_R_CREATE_KEY */
 367 typedef struct r_reg_create_key_info
 368 {
 369         POLICY_HND key_pol;       /* policy handle */
 370         uint32 unknown; /* 0x0000 0000 */
 371
 372         NTSTATUS status;         /* return status */
 373
 374 } REG_R_CREATE_KEY;
 375
 376 /* REG_Q_DELETE_KEY */
 377 typedef struct q_reg_delete_key_info
 378 {
 379         POLICY_HND pnt_pol;       /* parent key policy handle */
 380
 381         UNIHDR hdr_name;
 382         UNISTR2 uni_name;
 383 } REG_Q_DELETE_KEY;
 384
 385 /* REG_R_DELETE_KEY */
 386 typedef struct r_reg_delete_key_info
 387 {
 388         POLICY_HND key_pol;       /* policy handle */
 389
 390         NTSTATUS status;         /* return status */
 391
 392 } REG_R_DELETE_KEY;
 393
 394 /* REG_Q_DELETE_VALUE */
 395 typedef struct q_reg_delete_val_info
 396 {
 397         POLICY_HND pnt_pol;       /* parent key policy handle */
 398
 399         UNIHDR hdr_name;
 400         UNISTR2 uni_name;
 401
 402 } REG_Q_DELETE_VALUE;
 403
 404 /* REG_R_DELETE_VALUE */
 405 typedef struct r_reg_delete_val_info
 406 {
 407         POLICY_HND key_pol;       /* policy handle */
 408
 409         NTSTATUS status;         /* return status */
 410
 411 } REG_R_DELETE_VALUE;
 412
 413 /* REG_Q_QUERY_KEY */
 414 typedef struct q_reg_query_info
 415 {
 416         POLICY_HND pol;       /* policy handle */
 417         UNIHDR hdr_class;
 418         UNISTR2 uni_class;
 419
 420 } REG_Q_QUERY_KEY;
 421
 422 /* REG_R_QUERY_KEY */
 423 typedef struct r_reg_query_key_info
 424 {
 425         UNIHDR hdr_class;
 426         UNISTR2 uni_class;
 427
 428         uint32 num_subkeys;
 429         uint32 max_subkeylen;
 430         uint32 reserved; /* 0x0000 0000 - according to MSDN (max_subkeysize?) */
 431         uint32 num_values;
 432         uint32 max_valnamelen;
 433         uint32 max_valbufsize;
 434         uint32 sec_desc; /* 0x0000 0078 */
 435         NTTIME mod_time;  /* modified time */
 436
 437         NTSTATUS status;         /* return status */
 438
 439 } REG_R_QUERY_KEY;
 440
 441
 442 /* REG_Q_UNKNOWN_1A */
 443 typedef struct q_reg_unk_1a_info
 444 {
 445         POLICY_HND pol;       /* policy handle */
 446
 447 } REG_Q_UNKNOWN_1A;
 448
 449 /* REG_R_UNKNOWN_1A */
 450 typedef struct r_reg_unk_1a_info
 451 {
 452         uint32 unknown;         /* 0x0500 0000 */
 453         NTSTATUS status;         /* return status */
 454
 455 } REG_R_UNKNOWN_1A;
 456
 457
 458 /* REG_Q_UNKNOWN_1A */
 459 typedef struct q_reg_unknown_14
 460 {
 461         POLICY_HND pol;       /* policy handle */
 462
 463         UNIHDR  hdr_file;       /* unicode product type header */
 464         UNISTR2 uni_file;       /* local filename to save key as from regedt32.exe */
 465                                 /* e.g. "c:\temp\test.dat" */
 466
 467         uint32 unknown;         /* 0x0000 0000 */
 468
 469 } REG_Q_SAVE_KEY;
 470
 471
 472 /* REG_R_UNKNOWN_1A */
 473 typedef struct r_reg_unknown_14
 474 {
 475         NTSTATUS status;         /* return status */
 476
 477 } REG_R_SAVE_KEY;
 478
 479
 480
 481 /* REG_Q_CLOSE */
 482 typedef struct reg_q_close_info
 483 {
 484         POLICY_HND pol; /* policy handle */
 485
 486 } REG_Q_CLOSE;
 487
 488 /* REG_R_CLOSE */
 489 typedef struct reg_r_close_info
 490 {
 491         POLICY_HND pol; /* policy handle.  should be all zeros. */
 492
 493         NTSTATUS status; /* return code */
 494
 495 } REG_R_CLOSE;
 496
 497
 498 /* REG_Q_ENUM_KEY */
 499 typedef struct q_reg_enum_value_info
 500 {
 501         POLICY_HND pol;         /* policy handle */
 502
 503         uint32 key_index;
 504
 505         uint16 key_name_len;    /* 0x0000 */
 506         uint16 unknown_1;       /* 0x0414 */
 507
 508         uint32 ptr1;            /* pointer */
 509         uint32 unknown_2;       /* 0x0000 020A */
 510         uint8  pad1[8];         /* padding - zeros */
 511
 512         uint32 ptr2;            /* pointer */
 513         uint8  pad2[8];         /* padding - zeros */
 514
 515         uint32 ptr3;            /* pointer */
 516         NTTIME time;            /* current time? */
 517
 518 } REG_Q_ENUM_KEY;
 519
 520 /* REG_R_ENUM_KEY */
 521 typedef struct r_reg_enum_key_info
 522 {
 523         uint16 key_name_len;    /* number of bytes in key name */
 524         uint16 unknown_1;       /* 0x0414 - matches with query unknown_1 */
 525
 526         uint32 ptr1;            /* pointer */
 527         uint32 unknown_2;       /* 0x0000 020A */
 528         uint32 unknown_3;       /* 0x0000 0000 */
 529
 530         UNISTR3 key_name;
 531
 532         uint32 ptr2;            /* pointer */
 533         uint8  pad2[8];         /* padding - zeros */
 534
 535         uint32 ptr3;            /* pointer */
 536         NTTIME time;            /* current time? */
 537
 538         NTSTATUS status;         /* return status */
 539
 540 } REG_R_ENUM_KEY;
 541
 542
 543 /* REG_Q_INFO */
 544 typedef struct q_reg_info_info
 545 {
 546         POLICY_HND pol;         /* policy handle */
 547
 548         UNIHDR  hdr_type;       /* unicode product type header */
 549         UNISTR2 uni_type;       /* unicode product type - "ProductType" */
 550
 551         uint32 ptr_reserved;    /* pointer */
 552
 553         uint32 ptr_buf;         /* the next three fields follow if ptr_buf != 0 */
 554         uint32 ptr_bufsize;
 555         uint32 bufsize;
 556         uint32 buf_unk;
 557
 558         uint32 unk1;
 559         uint32 ptr_buflen;
 560         uint32 buflen;
 561
 562         uint32 ptr_buflen2;
 563         uint32 buflen2;
 564
 565 } REG_Q_INFO;
 566
 567 /* REG_R_INFO */
 568 typedef struct r_reg_info_info
 569 {
 570         uint32 ptr_type;        /* key type pointer */
 571         uint32 type;            /* key datatype  */
 572
 573         uint32 ptr_uni_val;     /* key value pointer */
 574         BUFFER2 uni_val;        /* key value */
 575
 576         uint32 ptr_max_len;
 577         uint32 buf_max_len;
 578
 579         uint32 ptr_len;
 580         uint32 buf_len;
 581
 582         NTSTATUS status;        /* return status */
 583
 584 } REG_R_INFO;
 585
 586
 587 /* REG_Q_OPEN_ENTRY */
 588 typedef struct q_reg_open_entry_info
 589 {
 590         POLICY_HND pol;        /* policy handle */
 591
 592         UNIHDR  hdr_name;       /* unicode registry string header */
 593         UNISTR2 uni_name;       /* unicode registry string name */
 594
 595         uint32 unknown_0;       /* 32 bit unknown - 0x0000 0000 */
 596         uint32 access_desired;
 597
 598 } REG_Q_OPEN_ENTRY;
 599
 600
 601
 602 /* REG_R_OPEN_ENTRY */
 603 typedef struct r_reg_open_entry_info
 604 {
 605         POLICY_HND pol;       /* policy handle */
 606         NTSTATUS status;         /* return status */
 607
 608 } REG_R_OPEN_ENTRY;
 609
 610 /* REG_Q_SHUTDOWN */
 611 typedef struct q_reg_shutdown_info
 612 {
 613         uint32 ptr_0;
 614         uint32 ptr_1;
 615         uint32 ptr_2;
 616         UNIHDR hdr_msg;         /* shutdown message */
 617         UNISTR2 uni_msg;        /* seconds */
 618         uint32 timeout;         /* seconds */
 619         uint16 flags;
 620
 621 } REG_Q_SHUTDOWN;
 622
 623 /* REG_R_SHUTDOWN */
 624 typedef struct r_reg_shutdown_info
 625 {
 626         NTSTATUS status;                /* return status */
 627
 628 } REG_R_SHUTDOWN;
 629
 630 /* REG_Q_ABORT_SHUTDOWN */
 631 typedef struct q_reg_abort_shutdown_info
 632 {
 633         uint32 ptr_server;
 634         uint16 server;
 635
 636 } REG_Q_ABORT_SHUTDOWN;
 637
 638 /* REG_R_ABORT_SHUTDOWN */
 639 typedef struct r_reg_abort_shutdown_info
 640 {
 641         NTSTATUS status; /* return status */
 642
 643 } REG_R_ABORT_SHUTDOWN;
 644
 645
 646 #endif /* _RPC_REG_H */
 647