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