networkservice
IExecutor.h
Go to the documentation of this file.
1 //\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\//
2 // //
3 // MIT License //
4 // //
5 // Copyright (c) 2020 Boubacar DIENE //
6 // //
7 // This file is part of NetworkService project //
8 // //
9 // Permission is hereby granted, free of charge, to any person obtaining a copy //
10 // of this software and associated documentation files (the "Software"), to deal //
11 // in the Software without restriction, including without limitation the rights //
12 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell //
13 // copies of the Software, and to permit persons to whom the Software is //
14 // furnished to do so, subject to the following conditions: //
15 // //
16 // The above copyright notice and this permission notice shall be included in all //
17 // copies or substantial portions of the Software. //
18 // //
19 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR //
20 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, //
21 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE //
22 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER //
23 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, //
24 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE //
25 // SOFTWARE. //
26 // //
27 //\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\//
28 
29 #ifndef __UTILS_COMMAND_IEXECUTOR_H__
30 #define __UTILS_COMMAND_IEXECUTOR_H__
31 
32 namespace utils::command {
33 
51 class IExecutor {
52 
53 public:
60  enum Flags : unsigned int {
61  WAIT_COMMAND = (1u << 0u),
62  RESEED_PRNG = (1u << 1u),
64  SANITIZE_FILES = (1u << 2u),
65  DROP_PRIVILEGES = (1u << 3u),
67  };
68 
79  struct ProgramParams {
82  const char* const pathname;
83 
87  char* const* const argv;
88 
91  char* const* const envp;
92  };
93 
99  explicit IExecutor(Flags flags) : m_flags(flags) {}
100 
102  virtual ~IExecutor() = default;
103 
105  IExecutor(const IExecutor&) = delete;
106 
108  IExecutor& operator=(const IExecutor&) = delete;
109 
111  IExecutor(IExecutor&&) = delete;
112 
114  IExecutor& operator=(IExecutor&&) = delete;
115 
128  virtual void executeProgram(const ProgramParams& params) const = 0;
129 
130 protected:
132 };
133 
134 }
135 
136 #endif
Definition: Executor.h:37
Definition: IExecutor.h:61
A data structure containing all input parameters expected by execProgram() method.
Definition: IExecutor.h:79
IExecutor & operator=(const IExecutor &)=delete
Definition: IExecutor.h:62
char *const *const envp
Definition: IExecutor.h:91
IExecutor(Flags flags)
Definition: IExecutor.h:99
Definition: IExecutor.h:66
A helper class to execute shell commands securely. This class is a high level interface added to ease...
Definition: IExecutor.h:51
virtual void executeProgram(const ProgramParams &params) const =0
Execute the program pointed to by pathname.
Flags
Bitmasks to give control on how this class is handling requests.
Definition: IExecutor.h:60
Flags m_flags
Definition: IExecutor.h:131
virtual ~IExecutor()=default
const char *const pathname
Definition: IExecutor.h:82
char *const *const argv
Definition: IExecutor.h:87