/usr/lib/python2.7/dist-packages/rekall/plugins/tools/repository_manager.py is in python-rekall-core 1.6.0+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 | # Rekall Memory Forensics
# Copyright 2015 Google Inc. All Rights Reserved.
#
# Author: Michael Cohen scudette@google.com
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or (at
# your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
This plugin manages the profile repository.
"""
import fnmatch
import json
import os
import multiprocessing
import subprocess
import sys
import yaml
from rekall import io_manager
from rekall import plugin
from rekall import registry
from rekall import threadpool
from rekall import testlib
from rekall import utils
NUMBER_OF_CORES = multiprocessing.cpu_count()
class BuilderError(Exception):
"""Raised when the builder failed."""
class RepositoryManager(io_manager.DirectoryIOManager):
"""We manage the repository using YAML.
YAML is more user friendly than JSON.
"""
# Do not include src files in the inventory.
EXCLUDED_PATH_PREFIX = ["src"]
def Encoder(self, data, **options):
if options.get("raw"):
return utils.SmartStr(data)
# If the user specifically wants to encode in yaml, then do so.
if options.get("yaml"):
return yaml.safe_dump(data, default_flow_style=False)
return utils.PPrint(data)
def Decoder(self, raw):
try:
# First try to load it with json because it is way faster.
return super(RepositoryManager, self).Decoder(raw)
except ValueError:
# If that does not work, try to load it with yaml.
return yaml.safe_load(raw)
def _StoreData(self, name, to_write, **options):
# The user wants to store a yaml file, we make it uncompressed.
if options.get("yaml"):
options["uncompressed"] = True
return super(RepositoryManager, self)._StoreData(
name, to_write, **options)
class RepositoryPlugin(object):
"""A plugin to manage a type of profile in the repository."""
__metaclass__ = registry.MetaclassRegistry
def __init__(self, session=None, **kwargs):
"""Instantiate the plugin with the provided kwargs."""
self.args = utils.AttributeDict(kwargs)
self.session = session
self.pool = threadpool.ThreadPool(self.args.processes)
def TransformProfile(self, profile):
"""Transform the profile according to the specified transforms."""
transforms = self.args.transforms or {}
for transform, args in transforms.items():
if transform == "merge":
profile["$MERGE"] = args
else:
raise RuntimeError("Unknown transform %s" % transform)
return profile
def BuildIndex(self):
repository = self.args.repository
for index in self.args.index:
spec = repository.GetData(index["src"])
built_index = self.session.plugins.build_index(
manager=repository).build_index(spec)
repository.StoreData(index["dest"], built_index)
def LaunchPlugin(self, plugin_name, *pos, **kwargs):
"""Runs a plugin in another process."""
subprocess.check_call(
[sys.executable, plugin_name] + pos +
["--%s='%s'" % (k, v) for k, v in kwargs.iteritems()])
def LaunchBuilder(self, *args):
"""Relaunch this builder with the provided parameters."""
executable = self.args.executable
if executable is None:
executable = sys.argv[0]
cmdline = [executable]
# We are launched with the python executable.
if "python" in executable:
cmdline.append(sys.argv[1])
cmdline.extend(["manage_repo", "--path_to_repository",
self.args.repository.location])
cmdline.append(self.args.profile_name)
cmdline.extend(args)
pipe = subprocess.Popen(cmdline, stderr=subprocess.PIPE)
_, stderr_text = pipe.communicate()
if pipe.returncode != 0:
error_message = stderr_text.strip().splitlines()[-1]
raise BuilderError(error_message)
def Build(self, renderer):
"""Implementation of the build routine."""
class WindowsGUIDProfile(RepositoryPlugin):
"""Manage a Windows profile from the symbol server."""
def FetchPDB(self, guid, pdb_filename):
repository = self.args.repository
fetch_pdb = self.session.plugins.fetch_pdb(
pdb_filename=pdb_filename, guid=guid)
data = fetch_pdb.FetchPDBFile()
repository.StoreData("src/pdb/%s.pdb" % guid, data, raw=True)
def ParsePDB(self, guid, original_pdb_filename):
repository = self.args.repository
data = repository.GetData("src/pdb/%s.pdb" % guid, raw=True)
profile_class = (self.args.profile_class or
original_pdb_filename.capitalize())
with utils.TempDirectory() as temp_dir:
pdb_filename = os.path.join(temp_dir, guid + ".pdb")
with open(pdb_filename, "wb") as fd:
fd.write(data)
parse_pdb = self.session.plugins.parse_pdb(
pdb_filename=pdb_filename,
profile_class=profile_class)
profile_data = json.loads(str(parse_pdb))
profile_data = self.TransformProfile(profile_data)
repository.StoreData("%s/%s" % (self.args.profile_name, guid),
profile_data)
def ProcessPdb(self, guid, pdb_filename):
self.session.logging.info(
"Building profile %s/%s\n", self.args.profile_name, guid)
# Do we need to fetch the pdb file?
repository = self.args.repository
if not repository.Metadata("src/pdb/%s.pdb" % guid):
self.FetchPDB(guid, pdb_filename)
self.ParsePDB(guid, pdb_filename)
def Build(self, renderer, *args):
self.guid_file = self.args.repository.GetData(self.args.guids)
if not args:
command = "build_all"
else:
command = args[0]
args = args[1:]
self.ParseCommand(renderer, command, args)
def _FindPDBFilename(self, guid):
possible_guids = self.args.possible_guid_filenames
if not possible_guids:
possible_guids = [self.args.profile_name + ".pdb"]
for guid_file in possible_guids:
try:
self.FetchPDB(guid, guid_file)
return guid_file
except Exception:
continue
raise ValueError("Unknown pdb filename for guid %s" % guid)
def _DecodeGUIDFromArg(self, arg):
if "/" in arg:
pdb_filename, guid = arg.split("/")
else:
guid = arg
pdb_filename = self._FindPDBFilename(arg)
if not pdb_filename.endswith("pdb") or len(guid) != 33:
raise ValueError("Invalid GUID or pdb filename - e.g. "
"ntkrnlmp.pdb/00625D7D36754CBEBA4533BA9A0F3FE22.")
return pdb_filename, guid
def _AddGUIDs(self, args):
repository = self.args.repository
guid_file = self.args.repository.GetData(self.args.guids)
existing_guids = dict((x, set(y)) for x, y in guid_file.iteritems())
for arg in args:
pdb_filename, guid = self._DecodeGUIDFromArg(arg)
self.session.logging.info(
"Adding GUID %s %s" % (pdb_filename, guid))
existing_guids.setdefault(pdb_filename, set()).add(guid)
new_guids = dict((k, sorted(v)) for k, v in existing_guids.iteritems())
repository.StoreData(self.args.guids, new_guids, yaml=True)
def ParseCommand(self, renderer, command, args):
if command == "build":
for arg in args:
pdb_filename, guid = self._DecodeGUIDFromArg(arg)
self.ProcessPdb(guid, pdb_filename)
elif command == "build_all":
self.BuildAll(renderer)
elif command == "add_guid":
self._AddGUIDs(args)
self.BuildAll(renderer)
else:
raise RuntimeError(
"Unknown command for %s" % self.__class__.__name__)
def BuildAll(self, renderer):
repository = self.args.repository
guid_file = self.args.repository.GetData(self.args.guids)
rejects_filename = self.args.guids + ".rejects"
rejects = self.args.repository.GetData(rejects_filename, default={})
reject_len = len(rejects)
try:
changed_files = set()
for pdb_filename, guids in guid_file.iteritems():
for guid in guids:
if guid in rejects:
continue
# If the profile exists in the repository continue.
if repository.Metadata(
"%s/%s" % (self.args.profile_name, guid)):
continue
def Reject(e, guid=guid, changed_files=changed_files):
print "GUID %s rejected: %s" % (guid, e)
rejects[guid] = str(e)
changed_files.remove(guid)
# Otherwise build it.
changed_files.add(guid)
self.pool.AddTask(
self.LaunchBuilder,
("build", "%s/%s" % (pdb_filename, guid)),
on_error=Reject)
self.pool.Stop()
if changed_files and self.args.index or self.args.force_build_index:
renderer.format("Building index for profile {0} from {1}\n",
self.args.profile_name, self.args.index)
self.BuildIndex()
finally:
if len(rejects) != reject_len:
repository.StoreData(
rejects_filename, utils.PPrint(rejects), raw=True)
renderer.format("Updating inventory.\n")
repository.StoreData("inventory", repository.RebuildInventory())
class CopyAndTransform(RepositoryPlugin):
"""A profile processor which copies and transforms."""
def Build(self, renderer):
repository = self.args.repository
profile_metadata = repository.Metadata(self.args.profile_name)
source_metadata = repository.Metadata(self.args.source)
if not profile_metadata or (
source_metadata["LastModified"] >
profile_metadata["LastModified"]):
data = repository.GetData(self.args.source)
# Transform the data as required.
data = self.TransformProfile(data)
repository.StoreData(self.args.profile_name, utils.PPrint(data),
raw=True)
renderer.format("Building profile {0} from {1}\n",
self.args.profile_name, self.args.source)
class OSXProfile(RepositoryPlugin):
"""Build OSX Profiles."""
def Build(self, renderer):
repository = self.args.repository
changed_files = False
for source in self.args.sources:
profile_name = "OSX/%s" % source.split("/")[-1]
profile_metadata = repository.Metadata(profile_name)
# Profile does not exist - rebuild it.
if not profile_metadata:
data = repository.GetData(source)
# Transform the data as required.
data = self.TransformProfile(data)
repository.StoreData(profile_name, utils.PPrint(data),
raw=True)
renderer.format("Building profile {0} from {1}\n",
profile_name, source)
changed_files = True
if changed_files and self.args.index or self.args.force_build_index:
renderer.format("Building index for profile {0} from {1}\n",
self.args.profile_name, self.args.index)
self.BuildIndex()
class LinuxProfile(RepositoryPlugin):
"""Build Linux profiles."""
def Build(self, renderer):
"""Linux profile location"""
convert_profile = self.session.plugins.convert_profile(
session=self.session,
source="/dev/null",
out_file="dummy file") # We don't really output the profile.
changed_files = False
total_profiles = 0
new_profiles = 0
for source_profile in self.args.repository.ListFiles():
# Find all source profiles.
if (source_profile.startswith("src/Linux") and
source_profile.endswith(".zip")):
total_profiles += 1
profile_id = source_profile.lstrip("src/").rstrip(".zip")
# Skip already built profiles.
if self.args.repository.Metadata(profile_id):
continue
# Convert the profile
self.session.report_progress(
"Found new raw Linux profile %s. Converting...", profile_id)
self.session.logging.info(
"Found new raw Linux profile %s", profile_id)
profile_fullpath = self.args.repository.GetAbsolutePathName(
source_profile)
profile = convert_profile.ConvertProfile(
io_manager.Factory(
profile_fullpath, session=self.session, mode="r"))
if not profile:
self.session.logging.info(
"Skipped %s, Unable to convert to a Rekall profile.",
profile_fullpath)
continue
# Add profile to the repository and the inventory
self.args.repository.StoreData(profile_id, profile)
new_profiles += 1
changed_files = True
self.session.logging.info("Found %d profiles. %d are new.",
total_profiles, new_profiles)
# Now rebuild the index
if changed_files and self.args.index or self.args.force_build_index:
self.BuildIndex()
class ArtifactProfile(RepositoryPlugin):
"""Build the Artifacts profile.
This is needed when the artifacts are updated. Rekall loads all the
artifacts from the profile repository which allows us to update artifacts
easily for deployed Rekall clients.
"""
def Build(self, renderer):
repository = self.args.repository
profile_metadata = repository.Metadata(self.args.profile_name)
sources = []
for pattern in self.args.patterns:
sources.extend(fnmatch.filter(repository.ListFiles(), pattern))
# Find the latest modified source
last_modified = 0
for source in sources:
source_metadata = repository.Metadata(source)
last_modified = max(
last_modified, source_metadata["LastModified"])
if not profile_metadata or (
last_modified > profile_metadata["LastModified"]):
definitions = []
for source in sources:
definitions.extend(yaml.safe_load_all(
repository.GetData(source, raw=True)))
# Transform the data as required.
data = {
"$ARTIFACTS": definitions,
"$METADATA": dict(
ProfileClass="ArtifactProfile",
)
}
repository.StoreData(self.args.profile_name, utils.PPrint(data),
raw=True)
renderer.format("Building artifact profile {0}\n",
self.args.profile_name)
class ManageRepository(plugin.TypedProfileCommand, plugin.Command):
"""Manages the profile repository."""
name = "manage_repo"
__args = [
dict(name="executable", default=None,
help="The path to the rekall binary. This is used for "
"spawning multiple processes."),
dict(name="processes", default=NUMBER_OF_CORES, type="IntParser",
help="Number of concurrent workers."),
dict(name="path_to_repository", default=".",
help="The path to the profile repository"),
dict(name="force_build_index", type="Boolean", default=False,
help="Forces building the index."),
dict(name="build_target", type="StringParser", required=False,
positional=True, help="A single target to build."),
dict(name="builder_args", type="ArrayStringParser", required=False,
positional=True, help="Optional args for the builder.")
]
def render(self, renderer):
# Check if we can load the repository config file.
self.repository = RepositoryManager(
self.plugin_args.path_to_repository, session=self.session)
self.config_file = self.repository.GetData("config.yaml")
for profile_name, kwargs in self.config_file.iteritems():
if (self.plugin_args.build_target and
profile_name != self.plugin_args.build_target):
continue
self.session.logging.info("Building profiles for %s", profile_name)
handler_type = kwargs.pop("type", None)
if not handler_type:
raise RuntimeError(
"Unspecified repository handler for profile %s" %
profile_name)
handler_cls = RepositoryPlugin.classes.get(handler_type)
if handler_cls is None:
raise RuntimeError(
"Unknown repository handler %s" % handler_type)
handler = handler_cls(
session=self.session, repository=self.repository,
profile_name=profile_name,
force_build_index=self.plugin_args.force_build_index,
executable=self.plugin_args.executable,
processes=self.plugin_args.processes,
**kwargs)
handler.Build(renderer, *self.plugin_args.builder_args)
class TestManageRepository(testlib.DisabledTest):
"""Dont run automated tests for this tool."""
|