/
generate_initial_policies.py
197 lines (177 loc) · 8.16 KB
/
generate_initial_policies.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
"""
This script is used to generate the initial policies for the agent
and server. It parses the techniques/system folder and read the metadata
to render all templates, techniques and bundlesequences.
When adding a system technique, promises.st need to have a new variable TECHNIQUE_NAME_SEQUENCE
in bundle va to list all the included files for this directive
Note that the rudder_common_system_directive is not modified by this script
"""
import subprocess
import tempfile
import json
import shutil
import os
import xml.etree.ElementTree as ET
from distutils.dir_util import copy_tree
DESTINATION_FOLDER = './initial-promises/node-server'
JAR_FILE = './rudder-templates-cli.jar'
SYSTEM_FOLDER = './techniques/system'
system_rules = { # rule : [directives]
"hasPolicyServer-root": ["common-hasPolicyServer-root"],
"inventory-all": ["inventory-all"],
"policy-server-root": [
"rudder-service-apache-root",
"rudder-service-postgresql-root",
"rudder-service-relayd-root",
"rudder-service-slapd-root",
"rudder-service-webapp-root",
"server-common-root"
],
}
system_directives = { # technique : directive
"Make an inventory of the node" : "inventory-all",
"Common policies" : "common-hasPolicyServer-root",
"Rudder apache" : "rudder-service-apache-root",
"Rudder Postgresql" : "rudder-service-postgresql-root",
"Rudder relay" : "rudder-service-relayd-root",
"Rudder slapd" : "rudder-service-slapd-root",
"Rudder Webapp" : "rudder-service-webapp-root",
"Server Common" : "server-common-root"
}
def merge_dicts(src_data, override_data):
"""
Merge src_data and override_data in a new dict
"""
result = src_data.copy()
result.update(override_data)
return result
class Technique:
"""
Describe a rudder technique as described by its source.
It assumes that the only version available is 1.0 atm, the folder
input must not include the version folder but its parent.
"""
def __init__(self, folder):
self.root = folder
self.technique_path_name = os.path.basename(folder)
self._parse_metadata()
def _parse_metadata(self):
metadata_path = self.root + '/1.0/metadata.xml'
tree = ET.parse(metadata_path)
root = tree.getroot()
# find technique name
self.technique_name = root.attrib['name']
# find string templates
# add .st extension to the file name
templates = []
for template in root.findall('.//TMLS/TML'):
template_data = template.attrib
template_data['name'] = template_data['name'] + '.st'
for out in template.iter():
if out.tag == 'OUTPATH':
template_data['outpath'] = out.text
if out.tag == 'INCLUDED':
template_data['included'] = out.text
templates.append(template_data)
# find included files
files = []
for file in root.findall('.//FILES/FILE'):
file_data = file.attrib
for out in file.iter():
if out.tag == 'OUTPATH':
file_data['outpath'] = out.text
if out.tag == 'INCLUDED':
file_data['included'] = out.text
files.append(file_data)
self.templates = templates
self.files = files
def compute_bundle_files(self):
"""
Compute the bundle files of the technique from its metadata
Some files must be excluded from the initial policies since they can not
properly be applied.
"""
blacklist = ["common/1.0/reporting-http.cf", "rudder-system-directives.cf", "common/1.0/rudder-parameters.cf"]
bundle_files = []
for file in self.files + self.templates:
bundle_file = "{technique_name}/1.0/{file_path}".format(
technique_name = self.technique_path_name,
file_path = os.path.splitext(file['name'])[0]+'.cf'
)
if 'outpath' in file:
bundle_file = file['outpath']
if ('included' in file and file['included'] == 'true') or 'included' not in file:
if bundle_file not in blacklist:
bundle_files.append(bundle_file)
return { self.technique_path_name.upper().replace("-", "_") + "_SEQUENCE" : bundle_files }
def generate_initial_policies(self, extra_data={}):
"""
create the variables to replace in the templates
"""
print("Generate initial policies for technique " + self.technique_name)
directive_name = system_directives[self.technique_name]
rule_name = next(k for k,v in system_rules.items() if directive_name in v)
data = {
"TRACKINGKEY": "{rule_name}@@{directive_name}@@00".format(
rule_name = rule_name,
directive_name = directive_name
)
}
data = merge_dicts(data, extra_data)
# create a temp folder, generate a temporary variables.json file
with tempfile.TemporaryDirectory() as tmpdirname:
with open('./variables.json') as json_file:
src_data = json.load(json_file)
data = merge_dicts(src_data, data)
with open(tmpdirname + '/variables.json', 'w') as variables_file:
json.dump(data, variables_file)
# generate the things
build_path = tmpdirname + '/' + self.technique_path_name
os.mkdir(build_path)
# copy files as needed
for file in self.files:
source = self.root + '/1.0/' + file['name']
destination = build_path + '/1.0/' + file['name']
if 'outpath' in file:
destination = tmpdirname + '/' + file['outpath']
os.makedirs(os.path.dirname(destination), exist_ok=True)
shutil.copy(source, destination)
# render templates as needed
for file in self.templates:
source = self.root + '/1.0/' + file['name']
destination_folder = os.path.dirname(build_path + '/1.0/' + file['name'])
if 'outpath' in file:
destination = tmpdirname + '/' + file['outpath']
destination_folder = os.path.dirname(destination)
os.makedirs(destination_folder, exist_ok=True)
subprocess.run([
"java", "-jar", JAR_FILE,
"--outext", ".cf",
"--outdir", destination_folder,
"-p", tmpdirname + '/variables.json',
source
], check=True)
# Rename the file afterward since the jar can not modify the file name...
# the extension is automatically changed to .cf by the jar, we need to modify it in
# the source path.
if 'outpath' in file:
src = "{build_path}/{template}".format(
build_path = destination_folder,
template = os.path.splitext(os.path.basename(file['name']))[0]+'.cf'
)
shutil.move(src, destination)
# Remove the variable.json as it is not needed
os.remove(tmpdirname + '/variables.json')
copy_tree(tmpdirname, DESTINATION_FOLDER)
techniques = []
compute_bundle_files = {}
# Compute techniques and their bundle sequence
with os.scandir(SYSTEM_FOLDER) as f:
for entry in f:
if entry.is_dir():
t = Technique(os.path.join(SYSTEM_FOLDER, entry.name))
techniques.append(t)
compute_bundle_files = merge_dicts(compute_bundle_files, t.compute_bundle_files())
# Generate the promises
for t in techniques:
t.generate_initial_policies(extra_data = compute_bundle_files)