Revert "Fix broken channel icon in chrome://help on CrOS" and try again
[chromium-blink-merge.git] / sandbox / win / src / policy_low_level.h
blob6a62631311730d3585c59cd75267034a86e6655c
1 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef SANDBOX_SRC_POLICY_LOW_LEVEL_H__
6 #define SANDBOX_SRC_POLICY_LOW_LEVEL_H__
8 #include <list>
10 #include "base/basictypes.h"
11 #include "base/strings/string16.h"
12 #include "sandbox/win/src/ipc_tags.h"
13 #include "sandbox/win/src/policy_engine_params.h"
14 #include "sandbox/win/src/policy_engine_opcodes.h"
16 // Low level policy classes.
17 // Built on top of the PolicyOpcode and OpcodeFatory, the low level policy
18 // provides a way to define rules on strings and numbers but it is unaware
19 // of Windows specific details or how the Interceptions must be set up.
20 // To use these classes you construct one or more rules and add them to the
21 // LowLevelPolicy object like this:
23 // PolicyRule rule1(ASK_BROKER);
24 // rule1.AddStringMatch(IF, 0, L"\\\\/?/?\\c:\\*Microsoft*\\*.exe", true);
25 // rule1.AddNumberMatch(IF_NOT, 1, CREATE_ALWAYS, EQUAL);
26 // rule1.AddNumberMatch(IF, 2, FILE_ATTRIBUTE_NORMAL, EQUAL);
28 // PolicyRule rule2(FAKE_SUCCESS);
29 // rule2.AddStringMatch(IF, 0, L"\\\\/?/?\\Pipe\\Chrome.*", false));
30 // rule2.AddNumberMatch(IF, 1, OPEN_EXISTING, EQUAL));
32 // LowLevelPolicy policyGen(*policy_memory);
33 // policyGen.AddRule(kNtCreateFileSvc, &rule1);
34 // policyGen.AddRule(kNtCreateFileSvc, &rule2);
35 // policyGen.Done();
37 // At this point (error checking omitted) the policy_memory can be copied
38 // to the target process where it can be evaluated.
40 namespace sandbox {
42 // TODO(cpu): Move this constant to crosscall_client.h.
43 const size_t kMaxServiceCount = 32;
44 static_assert(IPC_LAST_TAG <= kMaxServiceCount,
45 "kMaxServiceCount is too low");
47 // Defines the memory layout of the policy. This memory is filled by
48 // LowLevelPolicy object.
49 // For example:
51 // [Service 0] --points to---\
52 // [Service 1] --------------|-----\
53 // ...... | |
54 // [Service N] | |
55 // [data_size] | |
56 // [Policy Buffer 0] <-------/ |
57 // [opcodes of] |
58 // ....... |
59 // [Policy Buffer 1] <-------------/
60 // [opcodes]
61 // .......
62 // .......
63 // [Policy Buffer N]
64 // [opcodes]
65 // .......
66 // <possibly unused space here>
67 // .......
68 // [opcode string ]
69 // [opcode string ]
70 // .......
71 // [opcode string ]
72 struct PolicyGlobal {
73 PolicyBuffer* entry[kMaxServiceCount];
74 size_t data_size;
75 PolicyBuffer data[1];
78 class PolicyRule;
80 // Provides the means to collect rules into a policy store (memory)
81 class LowLevelPolicy {
82 public:
83 // policy_store: must contain allocated memory and the internal
84 // size fields set to correct values.
85 explicit LowLevelPolicy(PolicyGlobal* policy_store);
87 // Destroys all the policy rules.
88 ~LowLevelPolicy();
90 // Adds a rule to be generated when Done() is called.
91 // service: The id of the service that this rule is associated with,
92 // for example the 'Open Thread' service or the "Create File" service.
93 // returns false on error.
94 bool AddRule(int service, PolicyRule* rule);
96 // Generates all the rules added with AddRule() into the memory area
97 // passed on the constructor. Returns false on error.
98 bool Done();
100 private:
101 struct RuleNode {
102 const PolicyRule* rule;
103 int service;
105 std::list<RuleNode> rules_;
106 PolicyGlobal* policy_store_;
107 DISALLOW_IMPLICIT_CONSTRUCTORS(LowLevelPolicy);
110 // There are 'if' rules and 'if not' comparisons
111 enum RuleType {
112 IF = 0,
113 IF_NOT = 1,
116 // Possible comparisons for numbers
117 enum RuleOp {
118 EQUAL,
119 AND,
120 RANGE // TODO(cpu): Implement this option.
123 // Provides the means to collect a set of comparisons into a single
124 // rule and its associated action.
125 class PolicyRule {
126 friend class LowLevelPolicy;
128 public:
129 explicit PolicyRule(EvalResult action);
130 PolicyRule(const PolicyRule& other);
131 ~PolicyRule();
133 // Adds a string comparison to the rule.
134 // rule_type: possible values are IF and IF_NOT.
135 // parameter: the expected index of the argument for this rule. For example
136 // in a 'create file' service the file name argument can be at index 0.
137 // string: is the desired matching pattern.
138 // match_opts: if the pattern matching is case sensitive or not.
139 bool AddStringMatch(RuleType rule_type, int16 parameter,
140 const wchar_t* string, StringMatchOptions match_opts);
142 // Adds a number match comparison to the rule.
143 // rule_type: possible values are IF and IF_NOT.
144 // parameter: the expected index of the argument for this rule.
145 // number: the value to compare the input to.
146 // comparison_op: the comparison kind (equal, logical and, etc).
147 bool AddNumberMatch(RuleType rule_type,
148 int16 parameter,
149 uint32 number,
150 RuleOp comparison_op);
152 // Returns the number of opcodes generated so far.
153 size_t GetOpcodeCount() const {
154 return buffer_->opcode_count;
157 // Called when there is no more comparisons to add. Internally it generates
158 // the last opcode (the action opcode). Returns false if this operation fails.
159 bool Done();
161 private:
162 void operator=(const PolicyRule&);
163 // Called in a loop from AddStringMatch to generate the required string
164 // match opcodes. rule_type, match_opts and parameter are the same as
165 // in AddStringMatch.
166 bool GenStringOpcode(RuleType rule_type, StringMatchOptions match_opts,
167 uint16 parameter, int state, bool last_call,
168 int* skip_count, base::string16* fragment);
170 // Loop over all generated opcodes and copy them to increasing memory
171 // addresses from opcode_start and copy the extra data (strings usually) into
172 // decreasing addresses from data_start. Extra data is only present in the
173 // string evaluation opcodes.
174 bool RebindCopy(PolicyOpcode* opcode_start, size_t opcode_size,
175 char* data_start, size_t* data_size) const;
176 PolicyBuffer* buffer_;
177 OpcodeFactory* opcode_factory_;
178 EvalResult action_;
179 bool done_;
182 } // namespace sandbox
184 #endif // SANDBOX_SRC_POLICY_LOW_LEVEL_H__