You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metron.apache.org by ni...@apache.org on 2016/04/15 20:07:00 UTC
incubator-metron git commit: METRON-110 Lightweight packet capture
tool (nickwallen) closes apache/incubator-metron#76
Repository: incubator-metron
Updated Branches:
refs/heads/master 61ee80c2d -> 4edffdedc
METRON-110 Lightweight packet capture tool (nickwallen) closes apache/incubator-metron#76
Project: http://git-wip-us.apache.org/repos/asf/incubator-metron/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metron/commit/4edffded
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metron/tree/4edffded
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metron/diff/4edffded
Branch: refs/heads/master
Commit: 4edffdedc11fc2703cf90bdf1bb35752d6051ad2
Parents: 61ee80c
Author: nickwallen <ni...@nickallen.org>
Authored: Fri Apr 15 14:05:32 2016 -0400
Committer: Nick Allen <ni...@nickallen.org>
Committed: Fri Apr 15 14:05:32 2016 -0400
----------------------------------------------------------------------
metron-sensors/pycapa/.gitignore | 4 +
metron-sensors/pycapa/LICENSE | 202 ++++++++++++++++++++++++
metron-sensors/pycapa/README.md | 74 +++++++++
metron-sensors/pycapa/VERSION | 1 +
metron-sensors/pycapa/pycapa/__init__.py | 16 ++
metron-sensors/pycapa/pycapa/common.py | 36 +++++
metron-sensors/pycapa/pycapa/consumer.py | 64 ++++++++
metron-sensors/pycapa/pycapa/producer.py | 58 +++++++
metron-sensors/pycapa/pycapa/pycapa_cli.py | 85 ++++++++++
metron-sensors/pycapa/requirements.txt | 19 +++
metron-sensors/pycapa/setup.py | 40 +++++
11 files changed, 599 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/.gitignore
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/.gitignore b/metron-sensors/pycapa/.gitignore
new file mode 100644
index 0000000..15d248c
--- /dev/null
+++ b/metron-sensors/pycapa/.gitignore
@@ -0,0 +1,4 @@
+*.pyc
+pycapa.egg-info
+dist
+build
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/LICENSE
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/LICENSE b/metron-sensors/pycapa/LICENSE
new file mode 100644
index 0000000..e06d208
--- /dev/null
+++ b/metron-sensors/pycapa/LICENSE
@@ -0,0 +1,202 @@
+Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/README.md
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/README.md b/metron-sensors/pycapa/README.md
new file mode 100644
index 0000000..33e9d0a
--- /dev/null
+++ b/metron-sensors/pycapa/README.md
@@ -0,0 +1,74 @@
+# Pycapa
+
+## Overview
+
+Pycapa performs network packet capture, both off-the-wire and from Kafka, which is useful for the testing and development of [Apache Metron](https://github.com/apache/incubator-metron). It is not intended for production use. The tool will capture packets from a specified interface and push them into a Kafka Topic.
+
+## Installation
+
+```
+pip install -r requirements.txt
+python setup.py install
+```
+
+## Usage
+
+```
+$ pycapa --help
+usage: pycapa [-h] [-p] [-c] [-k KAFKA_BROKERS] [-t TOPIC] [-n PACKET_COUNT]
+ [-d DEBUG] [-i INTERFACE]
+
+optional arguments:
+ -h, --help show this help message and exit
+ -p, --producer sniff packets and send to kafka
+ -c, --consumer read packets from kafka
+ -k KAFKA_BROKERS, --kafka KAFKA_BROKERS
+ kafka broker(s)
+ -t TOPIC, --topic TOPIC
+ kafka topic
+ -n PACKET_COUNT, --number PACKET_COUNT
+ number of packets to consume
+ -d DEBUG, --debug DEBUG
+ debug every X packets
+ -i INTERFACE, --interface INTERFACE
+ interface to listen on
+```
+
+Pycapa has two primary runtime modes.
+
+### Producer Mode
+
+Pycapa can be configured to capture packets from a network interface and then forward those packets to a Kafka topic. The following example will capture packets from the `eth0` network interface and forward those to a Kafka topic called `pcap` running on `localhost`.
+
+```
+pycapa --producer --kafka localhost:9092 --topic pcap -i eth0
+```
+
+To output debug messages every 100 captured packets, run the following.
+
+```
+pycapa --producer --kafka localhost:9092 --topic pcap -i eth0 --debug 100
+```
+
+### Consumer Mode
+
+Pycapa can be configured to consume packets from a Kafka topic and then write those packets to a [libpcap-compliant file](https://wiki.wireshark.org/Development/LibpcapFileFormat). To read 100 packets from a kafka topic and then write those to a [libpcap-compliant file](https://wiki.wireshark.org/Development/LibpcapFileFormat), run the following command. The file `out.pcap` can then be opened with a tool such as Wireshark for further validation.
+
+```
+pycapa --consumer --kafka localhost:9092 --topic pcap --n 100 > out.pcap
+```
+
+To consume packets from Kafka continuously and print debug messages every 10 packets, run the following command.
+
+```
+pycapa --consumer --kafka localhost:9092 --topic pcap --debug 10
+```
+
+## Dependencies
+
+* [kafka-python](https://github.com/dpkp/kafka-python)
+* [pcapy](https://github.com/CoreSecurity/pcapy)
+
+## Implementation
+
+When run in Producer Mode, Pycapa embeds the raw network packet data in the Kafka message. The message key contains the timestamp indicating when the packet was captured in microseconds from the epoch. This value is in network byte order.
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/VERSION
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/VERSION b/metron-sensors/pycapa/VERSION
new file mode 100644
index 0000000..ceab6e1
--- /dev/null
+++ b/metron-sensors/pycapa/VERSION
@@ -0,0 +1 @@
+0.1
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/pycapa/__init__.py
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/pycapa/__init__.py b/metron-sensors/pycapa/pycapa/__init__.py
new file mode 100644
index 0000000..d9e26de
--- /dev/null
+++ b/metron-sensors/pycapa/pycapa/__init__.py
@@ -0,0 +1,16 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/pycapa/common.py
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/pycapa/common.py b/metron-sensors/pycapa/pycapa/common.py
new file mode 100644
index 0000000..3fb78fd
--- /dev/null
+++ b/metron-sensors/pycapa/pycapa/common.py
@@ -0,0 +1,36 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+from datetime import datetime
+import struct
+
+
+def to_hex(s):
+ hex_str = ' '.join("{0:02x}".format(ord(c)) for c in s)
+ return '\n'.join([hex_str[i:i+48] for i in range(0, len(hex_str), 48)])
+
+
+def to_date(epoch_micros):
+ epoch_secs = epoch_micros / 1000000.0
+ return datetime.fromtimestamp(epoch_secs).strftime('%Y-%m-%d %H:%M:%S.%f')
+
+
+def pack_ts(ts):
+ return struct.pack(">Q", ts)
+
+
+def unpack_ts(packed_ts):
+ return struct.unpack_from(">Q", bytes(packed_ts), 0)[0]
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/pycapa/consumer.py
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/pycapa/consumer.py b/metron-sensors/pycapa/pycapa/consumer.py
new file mode 100644
index 0000000..950dc83
--- /dev/null
+++ b/metron-sensors/pycapa/pycapa/consumer.py
@@ -0,0 +1,64 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import sys
+import time
+import kafka
+import struct
+from common import to_date, to_hex, unpack_ts
+
+
+def global_header(magic=0xa1b2c3d4L, version_major=2, version_minor=4, zone=0,
+ sigfigs=0, snaplen=65535, network=1):
+ return struct.pack("IHHIIII", magic, version_major, version_minor, zone,
+ sigfigs, snaplen, network)
+
+
+def packet_header(pkt_raw, msg_key):
+ epoch_micros = struct.unpack_from(">Q", bytes(msg_key), 0)[0]
+ secs = epoch_micros / 1000000
+ usec = epoch_micros % 1000000
+ caplen = wirelen = len(pkt_raw)
+ hdr = struct.pack('IIII', secs, usec, caplen, wirelen)
+ return hdr
+
+
+def consumer(args):
+ # connect to kafka
+ brokers = args.kafka_brokers.split(",")
+ kafka_consumer = kafka.KafkaConsumer(args.topic, bootstrap_servers=brokers)
+
+ # if debug not set, write libpcap global header
+ if args.debug == 0:
+ sys.stdout.write(global_header())
+
+ # start packet capture
+ packet_count = 0
+ for msg in kafka_consumer:
+
+ # if debug not set, write the packet header and packet
+ if args.debug == 0:
+ sys.stdout.write(packet_header(msg.value, msg.key))
+ sys.stdout.write(msg.value)
+
+ elif packet_count % args.debug == 0:
+ print 'Packet: count=%s dt=%s topic=%s' % (
+ packet_count, to_date(unpack_ts(msg.key)), args.topic)
+ print to_hex(msg.value)
+
+ packet_count += 1
+ if args.packet_count > 0 and packet_count >= args.packet_count:
+ break
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/pycapa/producer.py
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/pycapa/producer.py b/metron-sensors/pycapa/pycapa/producer.py
new file mode 100644
index 0000000..8910b9b
--- /dev/null
+++ b/metron-sensors/pycapa/pycapa/producer.py
@@ -0,0 +1,58 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import pcapy
+import argparse
+import kafka
+import random
+from common import to_date, to_hex, pack_ts
+
+
+def partitioner(key_bytes, all_parts, avail_parts):
+ return random.choice(avail_parts)
+
+
+def timestamp(pkt_hdr):
+ (epoch_secs, delta_micros) = pkt_hdr.getts()
+ epoch_micros = (epoch_secs * 1000000.0) + delta_micros
+ return epoch_micros
+
+
+def producer(args):
+ # connect to kafka
+ producer = kafka.KafkaProducer(
+ bootstrap_servers=args.kafka_brokers.split(","),
+ partitioner=partitioner)
+
+ # initialize packet capture
+ capture = pcapy.open_live(args.interface, 65535, True, 3000)
+ packet_count = 0
+
+ # start packet capture
+ while True:
+ (pkt_hdr, pkt_raw) = capture.next()
+ if pkt_hdr is not None:
+
+ # send packet to kafka
+ pkt_ts = timestamp(pkt_hdr)
+ producer.send(args.topic, key=pack_ts(pkt_ts), value=pkt_raw)
+
+ # debug messages, if needed
+ packet_count += 1
+ if args.debug > 0 and packet_count % args.debug == 0:
+ print 'Sent Packet: count=%s dt=%s topic=%s' % (
+ packet_count, to_date(pkt_ts), args.topic)
+ print to_hex(pkt_raw)
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/pycapa/pycapa_cli.py
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/pycapa/pycapa_cli.py b/metron-sensors/pycapa/pycapa/pycapa_cli.py
new file mode 100644
index 0000000..33b2df6
--- /dev/null
+++ b/metron-sensors/pycapa/pycapa/pycapa_cli.py
@@ -0,0 +1,85 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import argparse
+from producer import producer
+from consumer import consumer
+
+
+def make_parser():
+ parser = argparse.ArgumentParser()
+ parser.add_argument('-p',
+ '--producer',
+ help='sniff packets and send to kafka',
+ dest='producer',
+ action='store_true',
+ default=False)
+ parser.add_argument('-c',
+ '--consumer',
+ help='read packets from kafka',
+ dest='consumer',
+ action='store_true',
+ default=False)
+ parser.add_argument('-k',
+ '--kafka',
+ help='kafka broker(s)',
+ dest='kafka_brokers')
+ parser.add_argument('-t',
+ '--topic',
+ help='kafka topic',
+ dest='topic')
+ parser.add_argument('-n',
+ '--number',
+ help='number of packets to consume',
+ dest='packet_count',
+ type=int)
+ parser.add_argument('-d',
+ '--debug',
+ help='debug every X packets',
+ dest='debug',
+ type=int,
+ default=0)
+ parser.add_argument('-i',
+ '--interface',
+ help='interface to listen on',
+ dest='interface')
+ return parser
+
+
+def valid_args(args):
+ if args.producer and args.kafka_brokers and args.topic and args.interface:
+ return True
+ elif args.consumer and args.kafka_brokers and args.topic:
+ return True
+ else:
+ return False
+
+
+def main():
+ parser = make_parser()
+ args = parser.parse_args()
+
+ if not valid_args(args):
+ parser.print_help()
+ elif args.consumer:
+ consumer(args)
+ elif args.producer:
+ producer(args)
+ else:
+ parser.print_help()
+
+if __name__ == '__main__':
+ main()
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/requirements.txt
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/requirements.txt b/metron-sensors/pycapa/requirements.txt
new file mode 100644
index 0000000..b2dcb05
--- /dev/null
+++ b/metron-sensors/pycapa/requirements.txt
@@ -0,0 +1,19 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+kafka-python
+pcapy
+argparse
http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/4edffded/metron-sensors/pycapa/setup.py
----------------------------------------------------------------------
diff --git a/metron-sensors/pycapa/setup.py b/metron-sensors/pycapa/setup.py
new file mode 100644
index 0000000..3905028
--- /dev/null
+++ b/metron-sensors/pycapa/setup.py
@@ -0,0 +1,40 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import os
+from setuptools import setup
+
+
+def fread(filename):
+ return open(os.path.join(os.path.dirname(__file__), filename)).read()
+
+
+def get_version():
+ return fread('VERSION')
+
+
+setup(
+ name='pycapa',
+ version=get_version(),
+ author='Apache Metron Team',
+ author_email='user@metron.incubator.apache.org',
+ description='Pycapa performs network packet capture as part of Apache Metron',
+ long_description=fread('README.md'),
+ entry_points = {
+ "console_scripts" : [ 'pycapa = pycapa.pycapa_cli:main' ],
+ },
+ packages = [ 'pycapa' ]
+)