# *-* coding: utf-8 *-*
# This file is part of butterfly
#
# butterfly Copyright(C) 2015-2017 Florian Mounier
# 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 3 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, see .
import os
import pwd
import re
import struct
import subprocess
import sys
import time
from collections import namedtuple
from logging import getLogger
log = getLogger('butterfly')
def get_hex_ip_port(remote):
ip, port = remote
if ip.startswith('::ffff:'):
ip = ip[len('::ffff:'):]
splits = ip.split('.')
if ':' not in ip and len(splits) == 4:
# Must be an ipv4
return '%02X%02X%02X%02X:%04X' % (
int(splits[3]),
int(splits[2]),
int(splits[1]),
int(splits[0]),
int(port)
)
try:
import ipaddress
except ImportError:
print('Please install ipaddress backport for ipv6 user detection')
return ''
# Endian reverse:
ipv6_parts = ipaddress.IPv6Address(ip).exploded.split(':')
for i in range(0, 8, 2):
ipv6_parts[i], ipv6_parts[i + 1] = (
ipv6_parts[i + 1][2:] + ipv6_parts[i + 1][:2],
ipv6_parts[i][2:] + ipv6_parts[i][:2])
return ''.join(ipv6_parts) + ':%04X' % port
def parse_cert(cert):
user = None
for elt in cert['subject']:
user = dict(elt).get('commonName', None)
if user:
break
return user
class User(object):
def __init__(self, uid=None, name=None):
if uid is None and not name:
uid = os.getuid()
if uid is not None:
self.pw = pwd.getpwuid(uid)
else:
self.pw = pwd.getpwnam(name)
if self.pw is None:
raise LookupError('Unknown user')
@property
def uid(self):
return self.pw.pw_uid
@property
def gid(self):
return self.pw.pw_gid
@property
def name(self):
return self.pw.pw_name
@property
def dir(self):
return self.pw.pw_dir
@property
def shell(self):
return self.pw.pw_shell
@property
def root(self):
return self.uid == 0
def __eq__(self, other):
if other is None:
return False
return self.uid == other.uid
def __repr__(self):
return "%s [%r]" % (self.name, self.uid)
class Socket(object):
def __init__(self, socket):
sn = socket.getsockname()
self.local_addr = sn[0]
self.local_port = sn[1]
try:
pn = socket.getpeername()
self.remote_addr = pn[0]
self.remote_port = pn[1]
except Exception:
log.debug("Can't get peer name", exc_info=True)
self.remote_addr = '???'
self.remote_port = 0
self.user = None
self.env = {}
if not self.local:
return
# If there is procfs, get as much info as we can
if os.path.exists('/proc/net'):
try:
line = get_procfs_socket_line(get_hex_ip_port(pn[:2]))
self.user = User(uid=int(line[7]))
self.env = get_socket_env(line[9], self.user)
except Exception:
log.debug('procfs was no good, aight', exc_info=True)
if self.user is None:
# Try with lsof
try:
self.user = User(name=get_lsof_socket_line(
self.remote_addr, self.remote_port)[1])
except Exception:
log.debug('lsof was no good', exc_info=True)
@property
def local(self):
return (self.remote_addr in ['127.0.0.1', '::1', '::ffff:127.0.0.1'] or
self.local_addr == self.remote_addr)
def __repr__(self):
return '' % (
self.local_addr, self.local_port,
self.remote_addr, self.remote_port,
self.user)
# Portable way to get the user, if lsof is installed
def get_lsof_socket_line(addr, port):
# May want to make this into a dictionary in the future...
regex = "\w+\s+(?P\d+)\s+(?P\w+).*\s" \
"(?P.*?):(?P\d+)->(?P.*?):(?P\d+)"
output = subprocess.check_output(['lsof', '-Pni']).decode('utf-8')
lines = output.split('\n')
for line in lines:
# Look for local address with peer port
match = re.findall(regex, line)
if len(match):
match = match[0]
if int(match[5]) == port:
return match
raise Exception("Couldn't find a match!")
# Linux only socket line get
def get_procfs_socket_line(hex_ip_port):
fn = None
if len(hex_ip_port) == 13: # ipv4
fn = '/proc/net/tcp'
elif len(hex_ip_port) == 37: # ipv6
fn = '/proc/net/tcp6'
if not fn:
return
try:
with open(fn) as k:
lines = k.readlines()
for line in lines:
# Look for local address with peer port
if line.split()[1] == hex_ip_port:
# We got the socket
return line.split()
except Exception:
log.debug('getting socket %s line fail' % fn, exc_info=True)
# Linux only browser environment far fetch
def get_socket_env(inode, user):
for pid in os.listdir("/proc/"):
if not pid.isdigit():
continue
try:
with open('/proc/%s/cmdline' % pid) as c:
command = c.read().split('\x00')
executable = command[0].split('/')[-1]
if executable in ('sh', 'bash', 'zsh'):
executable = command[1].split('/')[-1]
if executable in [
'gnome-session',
'gnome-session-binary',
'startkde',
'startdde',
'xfce4-session']:
with open('/proc/%s/status' % pid) as e:
uid = None
for line in e.read().splitlines():
parts = line.split('\t')
if parts[0] == 'Uid:':
uid = int(parts[1])
break
if not uid or uid != user.uid:
continue
with open('/proc/%s/environ' % pid) as e:
keyvals = e.read().split('\x00')
env = {}
for keyval in keyvals:
if '=' in keyval:
key, val = keyval.split('=', 1)
env[key] = val
return env
except Exception:
continue
for pid in os.listdir("/proc/"):
if not pid.isdigit():
continue
for fd in os.listdir("/proc/%s/fd/" % pid):
lnk = "/proc/%s/fd/%s" % (pid, fd)
if not os.path.islink(lnk):
continue
if 'socket:[%s]' % inode == os.readlink(lnk):
with open('/proc/%s/status' % pid) as s:
for line in s.readlines():
if line.startswith('PPid:'):
with open('/proc/%s/environ' %
line[len('PPid:'):].strip()) as e:
keyvals = e.read().split('\x00')
env = {}
for keyval in keyvals:
if '=' in keyval:
key, val = keyval.split('=', 1)
env[key] = val
return env
utmp_struct = struct.Struct('hi32s4s32s256shhiii4i20s')
if sys.version_info[0] == 2:
b = lambda x: x
else:
def b(x):
if isinstance(x, str):
return x.encode('utf-8')
return x
def get_utmp_file():
for file in (
'/var/run/utmp',
'/var/adm/utmp',
'/var/adm/utmpx',
'/etc/utmp',
'/etc/utmpx',
'/var/run/utx.active'):
if os.path.exists(file):
return file
def get_wtmp_file():
for file in (
'/var/log/wtmp',
'/var/adm/wtmp',
'/var/adm/wtmpx',
'/var/run/utx.log'):
if os.path.exists(file):
return file
UTmp = namedtuple(
'UTmp',
['type', 'pid', 'line', 'id', 'user', 'host',
'exit0', 'exit1', 'session',
'sec', 'usec', 'addr0', 'addr1', 'addr2', 'addr3', 'unused'])
def utmp_line(id, type, pid, fd, user, host, ts):
return UTmp(
type, # Type, 7 : user process
pid, # pid
b(fd), # line
b(id), # id
b(user), # user
b(host), # host
0, # exit 0
0, # exit 1
0, # session
int(ts), # sec
int(10 ** 6 * (ts - int(ts))), # usec
0, # addr 0
0, # addr 1
0, # addr 2
0, # addr 3
b('') # unused
)
def add_user_info(id, fd, pid, user, host):
# Freebsd format is not yet supported.
# Please submit PR
if sys.platform != 'linux':
return
utmp = utmp_line(id, 7, pid, fd, user, host, time.time())
for kind, file in {
'utmp': get_utmp_file(),
'wtmp': get_wtmp_file()}.items():
if not file:
continue
try:
with open(file, 'rb+') as f:
s = f.read(utmp_struct.size)
while s:
entry = UTmp(*utmp_struct.unpack(s))
if kind == 'utmp' and entry.id == utmp.id:
# Same id recycling
f.seek(f.tell() - utmp_struct.size)
f.write(utmp_struct.pack(*utmp))
break
s = f.read(utmp_struct.size)
else:
f.write(utmp_struct.pack(*utmp))
except Exception:
log.debug('Unable to write utmp info to ' + file, exc_info=True)
def rm_user_info(id, pid):
if sys.platform != 'linux':
return
utmp = utmp_line(id, 8, pid, '', '', '', time.time())
for kind, file in {
'utmp': get_utmp_file(),
'wtmp': get_wtmp_file()}.items():
if not file:
continue
try:
with open(file, 'rb+') as f:
s = f.read(utmp_struct.size)
while s:
entry = UTmp(*utmp_struct.unpack(s))
if entry.id == utmp.id:
if kind == 'utmp':
# Same id closing
f.seek(f.tell() - utmp_struct.size)
f.write(utmp_struct.pack(*utmp))
break
else:
utmp = utmp_line(
id, 8, pid, entry.line, entry.user, '',
time.time())
s = f.read(utmp_struct.size)
else:
f.write(utmp_struct.pack(*utmp))
except Exception:
log.debug('Unable to update utmp info to ' + file, exc_info=True)
class AnsiColors(object):
colors = {
'black': 30,
'red': 31,
'green': 32,
'yellow': 33,
'blue': 34,
'magenta': 35,
'cyan': 36,
'white': 37
}
def __getattr__(self, key):
bold = True
if key.startswith('light_'):
bold = False
key = key[len('light_'):]
if key in self.colors:
return '\x1b[%d%sm' % (
self.colors[key],
';1' if bold else '')
if key == 'reset':
return '\x1b[0m'
return ''
ansi_colors = AnsiColors()