138 lines
5.1 KiB
Python
138 lines
5.1 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright 2013 The Plaso Project Authors.
|
|
# Please see the AUTHORS file for details on individual authors.
|
|
#
|
|
# 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.
|
|
"""This file contains a bencode plugin for uTorrent data."""
|
|
|
|
from plaso.events import time_events
|
|
from plaso.lib import errors
|
|
from plaso.lib import eventdata
|
|
from plaso.parsers import bencode_parser
|
|
from plaso.parsers.bencode_plugins import interface
|
|
|
|
|
|
class UTorrentEvent(time_events.PosixTimeEvent):
|
|
"""Convenience class for a uTorrent active torrents history entries."""
|
|
|
|
DATA_TYPE = 'p2p:bittorrent:utorrent'
|
|
|
|
def __init__(
|
|
self, timestamp, timestamp_description, path, caption, seedtime):
|
|
"""Initialize the event.
|
|
|
|
Args:
|
|
path: Torrent download location
|
|
caption: Official name of package
|
|
seedtime: Number of seconds client seeded torrent
|
|
"""
|
|
super(UTorrentEvent, self).__init__(timestamp, timestamp_description)
|
|
self.path = path
|
|
self.caption = caption
|
|
self.seedtime = seedtime // 60 # Convert seconds to minutes.
|
|
|
|
|
|
class UTorrentPlugin(interface.BencodePlugin):
|
|
"""Plugin to extract uTorrent active torrent events."""
|
|
|
|
NAME = 'bencode_utorrent'
|
|
DESCRIPTION = u'Parser for uTorrent bencoded files.'
|
|
|
|
# The following set is used to determine if the bencoded data is appropriate
|
|
# for this plugin. If there's a match, the entire bencoded data block is
|
|
# returned for analysis.
|
|
BENCODE_KEYS = frozenset(['.fileguard'])
|
|
|
|
def GetEntries(
|
|
self, parser_context, file_entry=None, parser_chain=None, data=None,
|
|
**unused_kwargs):
|
|
"""Extracts uTorrent active torrents.
|
|
|
|
This is the main parsing engine for the plugin. It determines if
|
|
the selected file is the proper file to parse and extracts current
|
|
running torrents.
|
|
|
|
interface.Process() checks for the given BENCODE_KEYS set, ensures
|
|
that it matches, and then passes the bencoded data to this function for
|
|
parsing. This plugin then parses the entire set of bencoded data to extract
|
|
the variable file-name keys to retrieve their values.
|
|
|
|
uTorrent creates a file, resume.dat, and a backup, resume.dat.old, to
|
|
for all active torrents. This is typically stored in the user's
|
|
application data folder.
|
|
|
|
These files, at a minimum, contain a '.fileguard' key and a dictionary
|
|
with a key name for a particular download with a '.torrent' file
|
|
extension.
|
|
|
|
Args:
|
|
parser_context: A parser context object (instance of ParserContext).
|
|
file_entry: Optional file entry object (instance of dfvfs.FileEntry).
|
|
The default is None.
|
|
parser_chain: Optional string containing the parsing chain up to this
|
|
point. The default is None.
|
|
data: Optional bencode data in dictionary form. The default is None.
|
|
"""
|
|
# Walk through one of the torrent keys to ensure it's from a valid file.
|
|
for key, value in data.iteritems():
|
|
if not u'.torrent' in key:
|
|
continue
|
|
|
|
caption = value.get('caption')
|
|
path = value.get('path')
|
|
seedtime = value.get('seedtime')
|
|
if not caption or not path or seedtime < 0:
|
|
raise errors.WrongBencodePlugin(self.NAME)
|
|
|
|
for torrent, value in data.iteritems():
|
|
if not u'.torrent' in torrent:
|
|
continue
|
|
|
|
path = value.get('path', None)
|
|
caption = value.get('caption', None)
|
|
seedtime = value.get('seedtime', None)
|
|
|
|
# Create timeline events based on extracted values.
|
|
for event_key, event_value in value.iteritems():
|
|
if event_key == 'added_on':
|
|
event_object = UTorrentEvent(
|
|
event_value, eventdata.EventTimestamp.ADDED_TIME,
|
|
path, caption, seedtime)
|
|
parser_context.ProduceEvent(
|
|
event_object, parser_chain=parser_chain, file_entry=file_entry)
|
|
|
|
elif event_key == 'completed_on':
|
|
event_object = UTorrentEvent(
|
|
event_value, eventdata.EventTimestamp.FILE_DOWNLOADED,
|
|
path, caption, seedtime)
|
|
parser_context.ProduceEvent(
|
|
event_object, parser_chain=parser_chain, file_entry=file_entry)
|
|
|
|
elif event_key == 'modtimes':
|
|
for modtime in event_value:
|
|
# Some values are stored as 0, skip those.
|
|
if not modtime:
|
|
continue
|
|
|
|
event_object = UTorrentEvent(
|
|
modtime, eventdata.EventTimestamp.MODIFICATION_TIME,
|
|
path, caption, seedtime)
|
|
parser_context.ProduceEvent(
|
|
event_object, parser_chain=parser_chain,
|
|
file_entry=file_entry)
|
|
|
|
|
|
bencode_parser.BencodeParser.RegisterPlugin(UTorrentPlugin)
|