def _CreateHuntFromHunt(self):
flow_args = rdf_file_finder.FileFinderArgs(
paths=["a/*", "b/*"],
action=rdf_file_finder.FileFinderAction(action_type="STAT"))
flow_runner_args = rdf_flows.FlowRunnerArgs(
flow_name=file_finder.FileFinder.__name__)
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
source_h = self.CreateHunt(flow_args=flow_args,
flow_runner_args=flow_runner_args,
description="foo-description",
client_rule_set=client_rule_set)
ref = rdf_hunts.FlowLikeObjectReference.FromHuntId(
source_h.urn.Basename())
# Modify flow_args so that there are differences.
flow_args.paths = ["b/*", "c/*"]
client_rule_set.rules[0].regex.attribute_name = "Something else"
output_plugins = [
output_plugin.OutputPluginDescriptor(
plugin_name="TestOutputPlugin")
]
new_h = self.CreateHunt(flow_args=flow_args,
flow_runner_args=flow_runner_args,
description="bar-description",
client_rule_set=client_rule_set,
output_plugins=output_plugins,
original_object=ref)
return new_h, source_h
def _CreateForemanClientRuleSet(self):
return rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
field="CLIENT_NAME", attribute_regex="GRR"))
])
def testEvaluatesTheWholeAttributeToTrue(self):
r = rdf_foreman.ForemanRegexClientRule(field="SYSTEM",
attribute_regex="^Linux$")
client_id = self.SetupClient(0, system="Linux")
self.assertTrue(
r.Evaluate(aff4.FACTORY.Open(client_id, token=self.token)))
def testUnsetFieldRaises(self):
client = self.SetupTestClientObject(0, system="Linux")
info = data_store.REL_DB.ReadClientFullInfo(client.client_id)
r = rdf_foreman.ForemanRegexClientRule(attribute_regex="foo")
with self.assertRaises(ValueError):
r.Evaluate(info)
def testEvaluatesTheWholeAttributeToTrue(self):
r = rdf_foreman.ForemanRegexClientRule(field="SYSTEM",
attribute_regex="^Linux$")
client = self.SetupTestClientObject(0, system="Linux")
info = data_store.REL_DB.ReadClientFullInfo(client.client_id)
self.assertTrue(r.Evaluate(info))
def CreateGenericHuntWithCollection(self, values=None):
self.client_ids = self.SetupClients(10)
if values is None:
values = [
rdfvalue.RDFURN("aff4:/sample/1"),
rdfvalue.RDFURN("aff4:/C.0000000000000001/fs/os/c/bin/bash"),
rdfvalue.RDFURN("aff4:/sample/3")
]
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
with implementation.GRRHunt.StartHunt(
hunt_name=standard.GenericHunt.__name__,
client_rule_set=client_rule_set,
output_plugins=[],
token=self.token) as hunt:
runner = hunt.GetRunner()
runner.Start()
collection = hunt.ResultCollection()
for value in values:
collection.Add(
rdf_flows.GrrMessage(payload=value,
source=self.client_ids[0]))
return hunt.urn
def CreateGenericHuntWithCollection(self, values=None):
self.client_ids = self.SetupClients(10)
if values is None:
values = [
rdfvalue.RDFURN("aff4:/sample/1"),
rdfvalue.RDFURN("aff4:/C.0000000000000001/fs/os/c/bin/bash"),
rdfvalue.RDFURN("aff4:/sample/3")
]
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
with hunts.GRRHunt.StartHunt(hunt_name="GenericHunt",
client_rule_set=client_rule_set,
output_plugins=[],
token=self.token) as hunt:
runner = hunt.GetRunner()
runner.Start()
with aff4.FACTORY.Open(
hunt.results_collection_urn,
aff4_type=hunts_results.HuntResultCollection,
mode="w",
token=self.token) as collection:
for value in values:
collection.Add(rdf_flows.GrrMessage(payload=value))
return hunt.urn
def testUnsetFieldRaises(self):
client_id = self.SetupClient(0, system="Linux")
client = aff4.FACTORY.Open(client_id, token=self.token)
r = rdf_foreman.ForemanRegexClientRule(attribute_regex="foo")
with self.assertRaises(ValueError):
r.Evaluate(client)
def SetUpCrashedFlowInHunt(self):
client_ids = [
rdf_client.ClientURN("C.%016X" % i) for i in range(0, 10)
]
client_mocks = dict([(client_id,
test_lib.CrashClientMock(client_id, self.token))
for client_id in client_ids])
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex=""))
])
with hunts.GRRHunt.StartHunt(hunt_name="SampleHunt",
client_rule_set=client_rule_set,
client_rate=0,
token=self.token) as hunt:
hunt.Run()
foreman = aff4.FACTORY.Open("aff4:/foreman",
mode="rw",
token=self.token)
for client_id in client_ids:
self.assertTrue(foreman.AssignTasksToClient(client_id))
test_lib.TestHuntHelperWithMultipleMocks(client_mocks, False,
self.token)
return client_ids
def testCallback(self, client_limit=None):
"""Checks that the foreman uses the callback specified in the action."""
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
with implementation.GRRHunt.StartHunt(
hunt_name=standard.SampleHunt.__name__,
client_rule_set=client_rule_set,
client_limit=client_limit,
client_rate=0,
token=self.token) as hunt:
hunt.GetRunner().Start()
# Create a client that matches our regex.
client = aff4.FACTORY.Open(self.client_id, mode="rw", token=self.token)
info = client.Schema.CLIENT_INFO()
info.client_name = "GRR Monitor"
client.Set(client.Schema.CLIENT_INFO, info)
client.Close()
foreman = aff4.FACTORY.Open("aff4:/foreman", mode="rw", token=self.token)
with utils.Stubber(standard.SampleHunt, "StartClients", self.Callback):
self.called = []
foreman.AssignTasksToClient(client.urn)
self.assertEqual(len(self.called), 1)
self.assertEqual(self.called[0][1], [client.urn])
def Start(self):
self.state.hunt_id = None
self.state.client_ids = set()
self.state.client_ids_failures = set()
self.state.client_ids_result_reported = set()
self.state.client_ids = list(
base.GetClientTestTargets(token=self.token))
if not self.state.client_ids:
self.Log("No clients to test on, define them in "
"Test.end_to_end_client_ids")
return
# SetUID is required to run a hunt on the configured end-to-end client
# targets without an approval.
token = access_control.ACLToken(
username="******", reason="Running endtoend tests.").SetUID()
runner_args = rdf_flows.FlowRunnerArgs(flow_name="EndToEndTestFlow")
flow_request = hunts_standard.FlowRequest(
client_ids=self.state.client_ids,
args=flows_endtoend.EndToEndTestFlowArgs(),
runner_args=runner_args)
bogus_rule = rdf_foreman.ForemanRegexClientRule(
attribute_name="System", attribute_regex="Does not match anything")
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=bogus_rule)
])
hunt_args = hunts_standard.VariableGenericHuntArgs(
flows=[flow_request])
hunt_args.output_plugins = self.GetOutputPlugins()
with hunts.GRRHunt.StartHunt(hunt_name="VariableGenericHunt",
args=hunt_args,
client_rule_set=client_rule_set,
client_rate=0,
expiry_time="1d",
token=token) as hunt:
self.state.hunt_id = hunt.session_id
hunt.SetDescription("EndToEnd tests run by cron")
hunt.Run()
hunt.ManuallyScheduleClients(token=token)
# Set a callback to check the results after 50 minutes. This should be
# plenty of time for the clients to receive the hunt and run the tests, but
# not so long that the flow lease will expire.
wait_duration = rdfvalue.Duration(
config_lib.CONFIG.Get("Test.end_to_end_result_check_wait"))
completed_time = rdfvalue.RDFDatetime.Now() + wait_duration
self.CallState(next_state="CheckResults", start_time=completed_time)
def testHuntNotifications(self):
"""This tests the Hunt notification event."""
TestHuntListener.received_events = []
# Set up 10 clients.
client_ids = self.SetupClients(10)
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
with implementation.GRRHunt.StartHunt(
hunt_name=BrokenSampleHunt.__name__,
client_rule_set=client_rule_set,
client_rate=0,
notification_event="TestHuntDone",
token=self.token) as hunt:
hunt.GetRunner().Start()
foreman = aff4.FACTORY.Open("aff4:/foreman", mode="rw", token=self.token)
for client_id in client_ids:
foreman.AssignTasksToClient(client_id)
# Run the hunt.
client_mock = hunt_test_lib.SampleHuntMock()
hunt_test_lib.TestHuntHelper(
client_mock, client_ids, check_flow_errors=False, token=self.token)
self.assertEqual(len(TestHuntListener.received_events), 5)
def testEvaluatesAttributesSubstringToTrue(self):
r = rdf_foreman.ForemanRegexClientRule(
field="SYSTEM", attribute_regex="inu")
client_id = self.SetupClient(0, system="Linux")
# The system contains the substring inu
self.assertTrue(r.Evaluate(aff4.FACTORY.Open(client_id, token=self.token)))
def testEvaluatesNonSubstringToFalse(self):
r = rdf_foreman.ForemanRegexClientRule(
field="SYSTEM", attribute_regex="foo")
client_id = self.SetupClient(0, system="Linux")
# The system doesn't contain foo
self.assertFalse(r.Evaluate(aff4.FACTORY.Open(client_id, token=self.token)))
def testRuleAdding(self):
foreman = aff4.FACTORY.Open("aff4:/foreman",
mode="rw",
token=self.token)
rules = foreman.Get(foreman.Schema.RULES)
# Make sure there are no rules yet in the foreman.
self.assertEqual(len(rules), 0)
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
field="CLIENT_NAME", attribute_regex="HUNT")),
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.INTEGER,
integer=rdf_foreman.ForemanIntegerClientRule(
field="CLIENT_CLOCK",
operator=rdf_foreman.ForemanIntegerClientRule.Operator.
GREATER_THAN,
value=1336650631137737))
])
hunt = implementation.GRRHunt.StartHunt(
hunt_name=standard.SampleHunt.__name__,
client_rule_set=client_rule_set,
client_rate=0,
token=self.token)
# Push the rules to the foreman.
with hunt:
hunt.GetRunner().Start()
foreman = aff4.FACTORY.Open("aff4:/foreman",
mode="rw",
token=self.token)
rules = foreman.Get(foreman.Schema.RULES)
# Make sure they were written correctly.
self.assertEqual(len(rules), 1)
rule = rules[0]
self.assertEqual(rule.client_rule_set, client_rule_set)
self.assertEqual(len(rule.actions), 1)
self.assertEqual(rule.actions[0].hunt_name, "SampleHunt")
# Running a second time should not change the rules any more.
with hunt:
hunt.GetRunner().Start()
foreman = aff4.FACTORY.Open("aff4:/foreman",
mode="rw",
token=self.token)
rules = foreman.Get(foreman.Schema.RULES)
# Still just one rule.
self.assertEqual(len(rules), 1)
def testEvaluatesNonSubstringToFalse(self):
r = rdf_foreman.ForemanRegexClientRule(field="SYSTEM",
attribute_regex="foo")
client = self.SetupTestClientObject(0, system="Linux")
info = data_store.REL_DB.ReadClientFullInfo(client.client_id)
# The system doesn't contain foo
self.assertFalse(r.Evaluate(info))
def testEvaluatesAttributesSubstringToTrue(self):
r = rdf_foreman.ForemanRegexClientRule(field="SYSTEM",
attribute_regex="inu")
client = self.SetupTestClientObject(0, system="Linux")
info = data_store.REL_DB.ReadClientFullInfo(client.client_id)
# The system contains the substring inu
self.assertTrue(r.Evaluate(info))
def testEvaluatesNonSubstringToFalse(self):
# Instantiate a regex rule
r = rdf_foreman.ForemanRegexClientRule(attribute_name="type",
attribute_regex="foo")
client_id = self.SetupClient(0)
# The type doesn't contain foo
self.assertFalse(
r.Evaluate(aff4.FACTORY.Open(client_id, token=self.token)))
def testEvaluatesTheWholeAttributeToTrue(self):
# Instantiate a regex rule
r = rdf_foreman.ForemanRegexClientRule(
attribute_name="type", attribute_regex="^VFSGRRClient$")
client_id = self.SetupClient(0)
# Aff4 object type is VFSGRRClient
self.assertTrue(
r.Evaluate(aff4.FACTORY.Open(client_id, token=self.token)))
def testEvaluatesAttributesSubstringToTrue(self):
# Instantiate a regex rule
r = rdf_foreman.ForemanRegexClientRule(attribute_name="type",
attribute_regex="GRR")
client_id = self.SetupClient(0)
# The type contains the substring GRR
self.assertTrue(
r.Evaluate(aff4.FACTORY.Open(client_id, token=self.token)))
def testLabels(self):
r = rdf_foreman.ForemanRegexClientRule(field="CLIENT_LABELS",
attribute_regex="ell")
client_id = self.SetupClient(0, system="Linux")
client = aff4.FACTORY.Open(client_id, mode="rw", token=self.token)
self.assertFalse(r.Evaluate(client))
client.SetLabels(["hello", "world"], owner="GRR")
self.assertTrue(r.Evaluate(client))
def testEvaluatesAttributesSubstringToTrue(self):
# Instantiate a regex rule
r = rdf_foreman.ForemanRegexClientRule(attribute_name="type",
attribute_regex="GRR")
client_id, = self.SetupClients(nr_clients=1)
# The type contains the substring GRR
self.assertTrue(r.Evaluate(CollectAff4Objects(r.GetPathsToCheck(),
client_id, self.token),
client_id))
def testEvaluatesNonSubstringToFalse(self):
# Instantiate a regex rule
r = rdf_foreman.ForemanRegexClientRule(attribute_name="type",
attribute_regex="foo")
client_id, = self.SetupClients(nr_clients=1)
# The type doesn't contain foo
self.assertFalse(r.Evaluate(CollectAff4Objects(r.GetPathsToCheck(),
client_id, self.token),
client_id))
def testEvaluatesTheWholeAttributeToTrue(self):
# Instantiate a regex rule
r = rdf_foreman.ForemanRegexClientRule(attribute_name="type",
attribute_regex="^VFSGRRClient$")
client_id, = self.SetupClients(nr_clients=1)
# Aff4 object type is VFSGRRClient
self.assertTrue(r.Evaluate(CollectAff4Objects(r.GetPathsToCheck(),
client_id, self.token),
client_id))
def testEvaluation(self):
now = rdfvalue.RDFDatetime().Now()
client = self.SetupTestClientObject(0, last_boot_time=now)
info = data_store.REL_DB.ReadClientFullInfo(client.client_id)
for f in rdf_foreman.ForemanRegexClientRule.ForemanStringField.enum_dict:
if f == "UNSET":
continue
r = rdf_foreman.ForemanRegexClientRule(field=f, attribute_regex=".")
r.Evaluate(info)
def CreateSampleHunt(self, token=None):
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
with hunts.GRRHunt.StartHunt(hunt_name="SampleHunt",
client_rule_set=client_rule_set,
token=token or self.token) as hunt:
return hunt.session_id
def testLabels(self):
client = self.SetupTestClientObject(0, system="Linux")
data_store.REL_DB.AddClientLabels(client.client_id, "GRR",
["hello", "world"])
info = data_store.REL_DB.ReadClientFullInfo(client.client_id)
# Match a system label.
r = rdf_foreman.ForemanRegexClientRule(field="CLIENT_LABELS",
attribute_regex="label1")
self.assertTrue(r.Evaluate(info))
# Match a user label.
r = rdf_foreman.ForemanRegexClientRule(field="CLIENT_LABELS",
attribute_regex="ell")
self.assertTrue(r.Evaluate(info))
# This rule doesn't match any label.
r = rdf_foreman.ForemanRegexClientRule(
field="CLIENT_LABELS", attribute_regex="NonExistentLabel")
self.assertFalse(r.Evaluate(info))
def testPausingAndRestartingDoesNotStartHuntTwiceOnTheSameClient(self):
"""This tests if the hunt completes when some clients hang or raise."""
client_ids = self.SetupClients(10)
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
field="CLIENT_NAME", attribute_regex="GRR"))
])
with implementation.GRRHunt.StartHunt(
hunt_name=standard.SampleHunt.__name__,
client_rule_set=client_rule_set,
client_rate=0,
token=self.token) as hunt:
hunt.GetRunner().Start()
hunt_id = hunt.urn
foreman = aff4.FACTORY.Open("aff4:/foreman",
mode="rw",
token=self.token)
for client_id in client_ids:
num_tasks = foreman.AssignTasksToClient(client_id.Basename())
self.assertEqual(num_tasks, 1)
client_mock = hunt_test_lib.SampleHuntMock()
hunt_test_lib.TestHuntHelper(client_mock, client_ids, False,
self.token)
# Pausing and running hunt: this leads to the fresh rules being written
# to Foreman.RULES.
with aff4.FACTORY.Open(hunt_id, mode="rw", token=self.token) as hunt:
runner = hunt.GetRunner()
runner.Pause()
runner.Start()
# Recreating the foreman so that it updates list of rules.
foreman = aff4.FACTORY.Open("aff4:/foreman",
mode="rw",
token=self.token)
for client_id in client_ids:
num_tasks = foreman.AssignTasksToClient(client_id.Basename())
# No tasks should be assigned as this hunt ran on all the clients
# before.
self.assertEqual(num_tasks, 0)
def CreateSampleHunt(self, token=None):
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="GRR client", attribute_regex="GRR"))
])
with implementation.GRRHunt.StartHunt(
hunt_name=standard.SampleHunt.__name__,
client_rate=100,
filename="TestFilename",
client_rule_set=client_rule_set,
token=token or self.token) as hunt:
return hunt.session_id
def testInvalidRules(self):
"""Tests the behavior when a wrong attribute name is passed in a rule."""
client_rule_set = rdf_foreman.ForemanClientRuleSet(rules=[
rdf_foreman.ForemanClientRule(
rule_type=rdf_foreman.ForemanClientRule.Type.REGEX,
regex=rdf_foreman.ForemanRegexClientRule(
attribute_name="no such attribute", attribute_regex="HUNT"))
])
with implementation.GRRHunt.StartHunt(
hunt_name=BrokenSampleHunt.__name__,
client_rule_set=client_rule_set,
client_rate=0,
token=self.token) as hunt:
runner = hunt.GetRunner()
self.assertRaises(ValueError, runner.Start)
