source3/include/rpc_svcctl.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell              1992-1997,
   5    Copyright (C) Gerald (Jerry) Carter        2005
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _RPC_SVCCTL_H /* _RPC_SVCCTL_H */
  22 #define _RPC_SVCCTL_H
  23
  24 /* svcctl pipe */
  25
  26 #define SVCCTL_CLOSE_SERVICE                    0x00
  27 #define SVCCTL_CONTROL_SERVICE                  0x01
  28 #define SVCCTL_LOCK_SERVICE_DB                  0x03
  29 #define SVCCTL_QUERY_SERVICE_SEC                0x04
  30 #define SVCCTL_SET_SERVICE_SEC                  0x05
  31 #define SVCCTL_QUERY_STATUS                     0x06
  32 #define SVCCTL_UNLOCK_SERVICE_DB                0x08
  33 #define SVCCTL_ENUM_DEPENDENT_SERVICES_W        0x0d
  34 #define SVCCTL_ENUM_SERVICES_STATUS_W           0x0e
  35 #define SVCCTL_OPEN_SCMANAGER_W                 0x0f
  36 #define SVCCTL_OPEN_SERVICE_W                   0x10
  37 #define SVCCTL_QUERY_SERVICE_CONFIG_W           0x11
  38 #define SVCCTL_START_SERVICE_W                  0x13
  39 #define SVCCTL_GET_DISPLAY_NAME                 0x14
  40 #define SVCCTL_QUERY_SERVICE_CONFIG2_W          0x27
  41 #define SVCCTL_QUERY_SERVICE_STATUSEX_W         0x28
  42
  43 /* ANSI versions not implemented currently
  44 #define SVCCTL_ENUM_SERVICES_STATUS_A           0x0e
  45 #define SVCCTL_OPEN_SCMANAGER_A                 0x1b
  46 */
  47
  48 /* SERVER_STATUS - type */
  49
  50 #define SVCCTL_TYPE_WIN32               0x00000030
  51 #define SVCCTL_TYPE_DRIVER              0x0000000f
  52
  53 /* SERVER_STATUS - state */
  54 #define SVCCTL_STATE_ACTIVE             0x00000001
  55 #define SVCCTL_STATE_INACTIVE           0x00000002
  56 #define SVCCTL_STATE_ALL                ( SVCCTL_STATE_ACTIVE | SVCCTL_STATE_INACTIVE )
  57
  58 /* SERVER_STATUS - CurrentState */
  59
  60 #define SVCCTL_STATE_UNKNOWN            0x00000000      /* only used internally to smbd */
  61 #define SVCCTL_STOPPED                  0x00000001
  62 #define SVCCTL_START_PENDING            0x00000002
  63 #define SVCCTL_STOP_PENDING             0x00000003
  64 #define SVCCTL_RUNNING                  0x00000004
  65 #define SVCCTL_CONTINUE_PENDING         0x00000005
  66 #define SVCCTL_PAUSE_PENDING            0x00000006
  67 #define SVCCTL_PAUSED                   0x00000007
  68
  69 /* SERVER_STATUS - ControlAccepted */
  70
  71 #define SVCCTL_ACCEPT_NONE                      0x00000000
  72 #define SVCCTL_ACCEPT_STOP                      0x00000001
  73 #define SVCCTL_ACCEPT_PAUSE_CONTINUE            0x00000002
  74 #define SVCCTL_ACCEPT_SHUTDOWN                  0x00000004
  75 #define SVCCTL_ACCEPT_PARAMCHANGE               0x00000008
  76 #define SVCCTL_ACCEPT_NETBINDCHANGE             0x00000010
  77 #define SVCCTL_ACCEPT_HARDWAREPROFILECHANGE     0x00000020
  78 #define SVCCTL_ACCEPT_POWEREVENT                0x00000040
  79
  80 /* SERVER_STATUS - ControlAccepted */
  81 #define SVCCTL_SVC_ERROR_IGNORE                 0x00000000
  82 #define SVCCTL_SVC_ERROR_NORMAL                 0x00000001
  83 #define SVCCTL_SVC_ERROR_CRITICAL               0x00000002
  84 #define SVCCTL_SVC_ERROR_SEVERE                 0x00000003
  85
  86 /* QueryServiceConfig2 options */
  87 #define SERVICE_CONFIG_DESCRIPTION              0x00000001
  88 #define SERVICE_CONFIG_FAILURE_ACTIONS          0x00000002
  89
  90
  91 /* Service Config - values for ServiceType field*/
  92
  93 #define SVCCTL_KERNEL_DRVR                         0x00000001  /* doubtful we'll have these */
  94 #define SVCCTL_FILE_SYSTEM_DRVR                    0x00000002
  95 #define SVCCTL_WIN32_OWN_PROC                      0x00000010
  96 #define SVCCTL_WIN32_SHARED_PROC                   0x00000020
  97 #define SVCCTL_WIN32_INTERACTIVE                   0x00000100
  98
  99 /* Service Config - values for StartType field */
 100 #define SVCCTL_BOOT_START                          0x00000000
 101 #define SVCCTL_SYSTEM_START                        0x00000001
 102 #define SVCCTL_AUTO_START                          0x00000002
 103 #define SVCCTL_DEMAND_START                        0x00000003
 104 #define SVCCTL_DISABLED                            0x00000004
 105
 106 /* Service Controls */
 107
 108 #define SVCCTL_CONTROL_STOP                     0x00000001
 109 #define SVCCTL_CONTROL_PAUSE                    0x00000002
 110 #define SVCCTL_CONTROL_CONTINUE                 0x00000003
 111 #define SVCCTL_CONTROL_INTERROGATE              0x00000004
 112 #define SVCCTL_CONTROL_SHUTDOWN                 0x00000005
 113
 114 #define SVC_HANDLE_IS_SCM                       0x0000001
 115 #define SVC_HANDLE_IS_SERVICE                   0x0000002
 116 #define SVC_HANDLE_IS_DBLOCK                    0x0000003
 117
 118 #define SVC_STATUS_PROCESS_INFO                 0x00000000
 119
 120 /* where we assume the location of the service control scripts */
 121 #define SVCCTL_SCRIPT_DIR  "svcctl"
 122
 123 /* utility structures for RPCs */
 124
 125 typedef struct {
 126         uint32 type;
 127         uint32 state;
 128         uint32 controls_accepted;
 129         WERROR win32_exit_code;
 130         uint32 service_exit_code;
 131         uint32 check_point;
 132         uint32 wait_hint;
 133 } SERVICE_STATUS;
 134
 135 typedef struct {
 136         SERVICE_STATUS status;
 137         uint32 process_id;
 138         uint32 service_flags;
 139 } SERVICE_STATUS_PROCESS;
 140
 141
 142 typedef struct {
 143         UNISTR servicename;
 144         UNISTR displayname;
 145         SERVICE_STATUS status;
 146 } ENUM_SERVICES_STATUS;
 147
 148 typedef struct {
 149         uint32 service_type;
 150         uint32 start_type;
 151         uint32 error_control;
 152         UNISTR2 *executablepath;
 153         UNISTR2 *loadordergroup;
 154         uint32 tag_id;
 155         UNISTR2 *dependencies;
 156         UNISTR2 *startname;
 157         UNISTR2 *displayname;
 158 } SERVICE_CONFIG;
 159
 160 typedef struct {
 161         uint32 unknown;
 162         UNISTR description;
 163 } SERVICE_DESCRIPTION;
 164
 165 typedef struct {
 166         uint32 type;
 167         uint32 delay;
 168 } SC_ACTION;
 169
 170 typedef struct {
 171         uint32 reset_period;
 172         UNISTR2 *rebootmsg;     /* i have no idea if these are UNISTR2's.  I can't get a good trace */
 173         UNISTR2 *command;
 174         uint32  num_actions;
 175         SC_ACTION *actions;
 176 } SERVICE_FAILURE_ACTIONS;
 177
 178 /*
 179  * dispatch table of functions to handle the =ServiceControl API
 180  */
 181
 182 typedef struct {
 183         /* functions for enumerating subkeys and values */
 184         WERROR  (*stop_service)( const char *service, SERVICE_STATUS *status );
 185         WERROR  (*start_service) ( const char *service );
 186         WERROR  (*service_status)( const char *service, SERVICE_STATUS *status );
 187 } SERVICE_CONTROL_OPS;
 188
 189 /* structure to store the service handle information  */
 190
 191 typedef struct _ServiceInfo {
 192         uint8                   type;
 193         char                    *name;
 194         uint32                  access_granted;
 195         SERVICE_CONTROL_OPS     *ops;
 196 } SERVICE_INFO;
 197
 198
 199 /* rpc structures */
 200
 201 /**************************/
 202
 203 typedef struct {
 204         UNISTR2 *servername;
 205         UNISTR2 *database;
 206         uint32 access;
 207 } SVCCTL_Q_OPEN_SCMANAGER;
 208
 209 typedef struct {
 210         POLICY_HND handle;
 211         WERROR status;
 212 } SVCCTL_R_OPEN_SCMANAGER;
 213
 214 /**************************/
 215
 216 typedef struct {
 217         POLICY_HND handle;
 218         UNISTR2 servicename;
 219         uint32  display_name_len;
 220 } SVCCTL_Q_GET_DISPLAY_NAME;
 221
 222 typedef struct {
 223         UNISTR2 displayname;
 224         uint32 display_name_len;
 225         WERROR status;
 226 } SVCCTL_R_GET_DISPLAY_NAME;
 227
 228 /**************************/
 229
 230 typedef struct {
 231         POLICY_HND handle;
 232         UNISTR2 servicename;
 233         uint32 access;
 234 } SVCCTL_Q_OPEN_SERVICE;
 235
 236 typedef struct {
 237         POLICY_HND handle;
 238         WERROR status;
 239 } SVCCTL_R_OPEN_SERVICE;
 240
 241 /**************************/
 242
 243 typedef struct {
 244         POLICY_HND handle;
 245         uint32 parmcount;
 246         UNISTR4_ARRAY *parameters;
 247 } SVCCTL_Q_START_SERVICE;
 248
 249 typedef struct {
 250         WERROR status;
 251 } SVCCTL_R_START_SERVICE;
 252
 253 /**************************/
 254
 255 typedef struct {
 256         POLICY_HND handle;
 257         uint32 control;
 258 } SVCCTL_Q_CONTROL_SERVICE;
 259
 260 typedef struct {
 261         SERVICE_STATUS svc_status;
 262         WERROR status;
 263 } SVCCTL_R_CONTROL_SERVICE;
 264
 265 /**************************/
 266
 267 typedef struct {
 268         POLICY_HND handle;
 269 } SVCCTL_Q_QUERY_STATUS;
 270
 271 typedef struct {
 272         SERVICE_STATUS svc_status;
 273         WERROR status;
 274 } SVCCTL_R_QUERY_STATUS;
 275
 276 /**************************/
 277
 278 typedef struct {
 279         POLICY_HND handle;
 280         uint32 type;
 281         uint32 state;
 282         uint32 buffer_size;
 283         uint32 *resume;
 284 } SVCCTL_Q_ENUM_SERVICES_STATUS;
 285
 286 typedef struct {
 287         RPC_BUFFER buffer;
 288         uint32 needed;
 289         uint32 returned;
 290         uint32 *resume;
 291         WERROR status;
 292 } SVCCTL_R_ENUM_SERVICES_STATUS;
 293
 294 /**************************/
 295
 296 typedef struct {
 297         POLICY_HND handle;
 298         uint32 state;
 299         uint32 buffer_size;
 300 } SVCCTL_Q_ENUM_DEPENDENT_SERVICES;
 301
 302 typedef struct {
 303         RPC_BUFFER buffer;
 304         uint32 needed;
 305         uint32 returned;
 306         WERROR status;
 307 } SVCCTL_R_ENUM_DEPENDENT_SERVICES;
 308
 309
 310 /**************************/
 311
 312 typedef struct {
 313         POLICY_HND handle;
 314         uint32 buffer_size;
 315 } SVCCTL_Q_QUERY_SERVICE_CONFIG;
 316
 317 typedef struct {
 318         SERVICE_CONFIG config;
 319         uint32 needed;
 320         WERROR status;
 321 } SVCCTL_R_QUERY_SERVICE_CONFIG;
 322
 323
 324 /**************************/
 325
 326 typedef struct {
 327         POLICY_HND handle;
 328         uint32 level;
 329         uint32 buffer_size;
 330 } SVCCTL_Q_QUERY_SERVICE_CONFIG2;
 331
 332 typedef struct {
 333         RPC_BUFFER buffer;
 334         uint32 needed;
 335         WERROR status;
 336 } SVCCTL_R_QUERY_SERVICE_CONFIG2;
 337
 338
 339 /**************************/
 340
 341 typedef struct {
 342         POLICY_HND handle;
 343         uint32 level;
 344         uint32 buffer_size;
 345 } SVCCTL_Q_QUERY_SERVICE_STATUSEX;
 346
 347 typedef struct {
 348         RPC_BUFFER buffer;
 349         uint32 needed;
 350         WERROR status;
 351 } SVCCTL_R_QUERY_SERVICE_STATUSEX;
 352
 353
 354 /**************************/
 355
 356 typedef struct {
 357         POLICY_HND handle;
 358 } SVCCTL_Q_LOCK_SERVICE_DB;
 359
 360 typedef struct {
 361         POLICY_HND h_lock;
 362         WERROR status;
 363 } SVCCTL_R_LOCK_SERVICE_DB;
 364
 365
 366 /**************************/
 367
 368 typedef struct {
 369         POLICY_HND h_lock;
 370 } SVCCTL_Q_UNLOCK_SERVICE_DB;
 371
 372 typedef struct {
 373         WERROR status;
 374 } SVCCTL_R_UNLOCK_SERVICE_DB;
 375
 376
 377 /**************************/
 378
 379 typedef struct {
 380         POLICY_HND handle;
 381         uint32 security_flags;
 382         uint32 buffer_size;
 383 } SVCCTL_Q_QUERY_SERVICE_SEC;
 384
 385 typedef struct {
 386         RPC_BUFFER buffer;
 387         uint32 needed;
 388         WERROR status;
 389 } SVCCTL_R_QUERY_SERVICE_SEC;
 390
 391 /**************************/
 392
 393 typedef struct {
 394         POLICY_HND handle;
 395         uint32 security_flags;
 396         RPC_BUFFER buffer;
 397         uint32 buffer_size;
 398 } SVCCTL_Q_SET_SERVICE_SEC;
 399
 400 typedef struct {
 401         WERROR status;
 402 } SVCCTL_R_SET_SERVICE_SEC;
 403
 404
 405 #endif /* _RPC_SVCCTL_H */
 406