573 lines
18 KiB
Java
573 lines
18 KiB
Java
/*
|
|
* ProtocolLib - Bukkit server library that allows access to the Minecraft protocol.
|
|
* Copyright (C) 2012 Kristian S. Stangeland
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
package com.comphenix.protocol.injector;
|
|
|
|
import java.io.DataInputStream;
|
|
import java.lang.reflect.InvocationTargetException;
|
|
import java.lang.reflect.Method;
|
|
import java.util.Collections;
|
|
import java.util.HashMap;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.Set;
|
|
import java.util.concurrent.ConcurrentHashMap;
|
|
import java.util.logging.Level;
|
|
import java.util.logging.Logger;
|
|
|
|
import net.minecraft.server.Packet;
|
|
import net.sf.cglib.proxy.Enhancer;
|
|
import net.sf.cglib.proxy.MethodInterceptor;
|
|
import net.sf.cglib.proxy.MethodProxy;
|
|
|
|
import org.bukkit.entity.Player;
|
|
import org.bukkit.event.EventHandler;
|
|
import org.bukkit.event.EventPriority;
|
|
import org.bukkit.event.Listener;
|
|
import org.bukkit.event.player.PlayerJoinEvent;
|
|
import org.bukkit.event.player.PlayerQuitEvent;
|
|
import org.bukkit.event.server.PluginDisableEvent;
|
|
import org.bukkit.plugin.Plugin;
|
|
import org.bukkit.plugin.PluginManager;
|
|
|
|
import com.comphenix.protocol.ProtocolManager;
|
|
import com.comphenix.protocol.events.*;
|
|
import com.comphenix.protocol.reflect.FieldAccessException;
|
|
import com.comphenix.protocol.reflect.FuzzyReflection;
|
|
import com.google.common.base.Objects;
|
|
import com.google.common.collect.ImmutableSet;
|
|
|
|
public final class PacketFilterManager implements ProtocolManager {
|
|
|
|
/**
|
|
* Sets the inject hook type. Different types allow for maximum compatibility.
|
|
* @author Kristian
|
|
*/
|
|
public enum PlayerInjectHooks {
|
|
/**
|
|
* Override the packet queue lists in NetworkHandler.
|
|
*/
|
|
NETWORK_HANDLER_FIELDS,
|
|
|
|
}
|
|
|
|
// Create a concurrent set
|
|
private Set<PacketListener> packetListeners =
|
|
Collections.newSetFromMap(new ConcurrentHashMap<PacketListener, Boolean>());
|
|
|
|
// Player injection
|
|
private Map<DataInputStream, Player> connectionLookup = new ConcurrentHashMap<DataInputStream, Player>();
|
|
private Map<Player, PlayerInjector> playerInjection = new HashMap<Player, PlayerInjector>();
|
|
|
|
// Player injection type
|
|
private PlayerInjectHooks playerHook = PlayerInjectHooks.NETWORK_HANDLER_FIELDS;
|
|
|
|
// Packet injection
|
|
private PacketInjector packetInjector;
|
|
|
|
// Enabled packet filters
|
|
private Set<Integer> sendingFilters = Collections.newSetFromMap(new ConcurrentHashMap<Integer, Boolean>());
|
|
|
|
// The two listener containers
|
|
private ConcurrentListenerMultimap recievedListeners = new ConcurrentListenerMultimap();
|
|
private ConcurrentListenerMultimap sendingListeners = new ConcurrentListenerMultimap();
|
|
|
|
// Whether or not this class has been closed
|
|
private boolean hasClosed;
|
|
|
|
// The default class loader
|
|
private ClassLoader classLoader;
|
|
|
|
// Error logger
|
|
private Logger logger;
|
|
|
|
/**
|
|
* Only create instances of this class if protocol lib is disabled.
|
|
*/
|
|
public PacketFilterManager(ClassLoader classLoader, Logger logger) {
|
|
if (logger == null)
|
|
throw new IllegalArgumentException("logger cannot be NULL.");
|
|
if (classLoader == null)
|
|
throw new IllegalArgumentException("classLoader cannot be NULL.");
|
|
|
|
try {
|
|
// Initialize values
|
|
this.classLoader = classLoader;
|
|
this.logger = logger;
|
|
this.packetInjector = new PacketInjector(classLoader, this, connectionLookup);
|
|
} catch (IllegalAccessException e) {
|
|
logger.log(Level.SEVERE, "Unable to initialize packet injector.", e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieves how the server packets are read.
|
|
* @return Injection method for reading server packets.
|
|
*/
|
|
public PlayerInjectHooks getPlayerHook() {
|
|
return playerHook;
|
|
}
|
|
|
|
/**
|
|
* Sets how the server packets are read.
|
|
* @param playerHook - the new injection method for reading server packets.
|
|
*/
|
|
public void setPlayerHook(PlayerInjectHooks playerHook) {
|
|
this.playerHook = playerHook;
|
|
}
|
|
|
|
public Logger getLogger() {
|
|
return logger;
|
|
}
|
|
|
|
@Override
|
|
public ImmutableSet<PacketListener> getPacketListeners() {
|
|
return ImmutableSet.copyOf(packetListeners);
|
|
}
|
|
|
|
@Override
|
|
public void addPacketListener(PacketListener listener) {
|
|
if (listener == null)
|
|
throw new IllegalArgumentException("listener cannot be NULL.");
|
|
|
|
// A listener can only be added once
|
|
if (packetListeners.contains(listener))
|
|
return;
|
|
|
|
ListeningWhitelist sending = listener.getSendingWhitelist();
|
|
ListeningWhitelist receiving = listener.getReceivingWhitelist();
|
|
boolean hasSending = sending != null && sending.isEnabled();
|
|
boolean hasReceiving = receiving != null && receiving.isEnabled();
|
|
|
|
if (hasSending || hasReceiving) {
|
|
// Add listeners and hooks
|
|
if (hasSending) {
|
|
sendingListeners.addListener(listener, sending);
|
|
enablePacketFilters(ConnectionSide.SERVER_SIDE, sending.getWhitelist());
|
|
}
|
|
if (hasReceiving) {
|
|
recievedListeners.addListener(listener, receiving);
|
|
enablePacketFilters(ConnectionSide.CLIENT_SIDE, receiving.getWhitelist());
|
|
}
|
|
|
|
// Inform our injected hooks
|
|
packetListeners.add(listener);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void removePacketListener(PacketListener listener) {
|
|
if (listener == null)
|
|
throw new IllegalArgumentException("listener cannot be NULL");
|
|
|
|
List<Integer> sendingRemoved = null;
|
|
List<Integer> receivingRemoved = null;
|
|
|
|
ListeningWhitelist sending = listener.getSendingWhitelist();
|
|
ListeningWhitelist receiving = listener.getReceivingWhitelist();
|
|
|
|
// Remove from the overal list of listeners
|
|
if (!packetListeners.remove(listener))
|
|
return;
|
|
|
|
// Add listeners
|
|
if (sending != null && sending.isEnabled())
|
|
sendingRemoved = sendingListeners.removeListener(listener, sending);
|
|
if (receiving != null && receiving.isEnabled())
|
|
receivingRemoved = recievedListeners.removeListener(listener, receiving);
|
|
|
|
// Remove hooks, if needed
|
|
if (sendingRemoved != null && sendingRemoved.size() > 0)
|
|
disablePacketFilters(ConnectionSide.SERVER_SIDE, sendingRemoved);
|
|
if (receivingRemoved != null && receivingRemoved.size() > 0)
|
|
disablePacketFilters(ConnectionSide.CLIENT_SIDE, receivingRemoved);
|
|
}
|
|
|
|
@Override
|
|
public void removePacketListeners(Plugin plugin) {
|
|
|
|
// Iterate through every packet listener
|
|
for (PacketListener listener : packetListeners) {
|
|
// Remove the listener
|
|
if (Objects.equal(listener.getPlugin(), plugin)) {
|
|
removePacketListener(listener);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Invokes the given packet event for every registered listener.
|
|
* @param event - the packet event to invoke.
|
|
*/
|
|
public void invokePacketRecieving(PacketEvent event) {
|
|
recievedListeners.invokePacketRecieving(logger, event);
|
|
}
|
|
|
|
/**
|
|
* Invokes the given packet event for every registered listener.
|
|
* @param event - the packet event to invoke.
|
|
*/
|
|
public void invokePacketSending(PacketEvent event) {
|
|
sendingListeners.invokePacketSending(logger, event);
|
|
}
|
|
|
|
/**
|
|
* Enables packet events for a given packet ID.
|
|
* <p>
|
|
* Note that all packets are disabled by default.
|
|
*
|
|
* @param side - which side the event will arrive from.
|
|
* @param packets - the packet id(s).
|
|
*/
|
|
private void enablePacketFilters(ConnectionSide side, Iterable<Integer> packets) {
|
|
if (side == null)
|
|
throw new IllegalArgumentException("side cannot be NULL.");
|
|
|
|
for (int packetID : packets) {
|
|
if (side.isForServer())
|
|
sendingFilters.add(packetID);
|
|
if (side.isForClient() && packetInjector != null)
|
|
packetInjector.addPacketHandler(packetID);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Disables packet events from a given packet ID.
|
|
* @param packets - the packet id(s).
|
|
* @param side - which side the event no longer should arrive from.
|
|
*/
|
|
private void disablePacketFilters(ConnectionSide side, Iterable<Integer> packets) {
|
|
if (side == null)
|
|
throw new IllegalArgumentException("side cannot be NULL.");
|
|
|
|
for (int packetID : packets) {
|
|
if (side.isForServer())
|
|
sendingFilters.remove(packetID);
|
|
if (side.isForClient() && packetInjector != null)
|
|
packetInjector.removePacketHandler(packetID);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public void sendServerPacket(Player reciever, PacketContainer packet) throws InvocationTargetException {
|
|
sendServerPacket(reciever, packet, true);
|
|
}
|
|
|
|
@Override
|
|
public void sendServerPacket(Player reciever, PacketContainer packet, boolean filters) throws InvocationTargetException {
|
|
if (reciever == null)
|
|
throw new IllegalArgumentException("reciever cannot be NULL.");
|
|
if (packet == null)
|
|
throw new IllegalArgumentException("packet cannot be NULL.");
|
|
|
|
getInjector(reciever).sendServerPacket(packet.getHandle(), filters);
|
|
}
|
|
|
|
@Override
|
|
public void recieveClientPacket(Player sender, PacketContainer packet) throws IllegalAccessException, InvocationTargetException {
|
|
recieveClientPacket(sender, packet, true);
|
|
}
|
|
|
|
@Override
|
|
public void recieveClientPacket(Player sender, PacketContainer packet, boolean filters) throws IllegalAccessException, InvocationTargetException {
|
|
|
|
if (sender == null)
|
|
throw new IllegalArgumentException("sender cannot be NULL.");
|
|
if (packet == null)
|
|
throw new IllegalArgumentException("packet cannot be NULL.");
|
|
|
|
PlayerInjector injector = getInjector(sender);
|
|
Packet mcPacket = packet.getHandle();
|
|
|
|
if (filters) {
|
|
mcPacket = injector.handlePacketRecieved(mcPacket);
|
|
}
|
|
|
|
injector.processPacket(mcPacket);
|
|
}
|
|
|
|
@Override
|
|
public PacketContainer createPacket(int id) {
|
|
return createPacket(id, true);
|
|
}
|
|
|
|
@Override
|
|
public PacketContainer createPacket(int id, boolean forceDefaults) {
|
|
PacketContainer packet = new PacketContainer(id);
|
|
|
|
// Use any default values if possible
|
|
if (forceDefaults) {
|
|
try {
|
|
packet.getModifier().writeDefaults();
|
|
} catch (FieldAccessException e) {
|
|
throw new RuntimeException("Security exception.", e);
|
|
}
|
|
}
|
|
|
|
return packet;
|
|
}
|
|
|
|
@Override
|
|
public Set<Integer> getSendingFilters() {
|
|
return ImmutableSet.copyOf(sendingFilters);
|
|
}
|
|
|
|
@Override
|
|
public Set<Integer> getReceivingFilters() {
|
|
return ImmutableSet.copyOf(packetInjector.getPacketHandlers());
|
|
}
|
|
|
|
/**
|
|
* Initialize the packet injection for every player.
|
|
* @param players - list of players to inject.
|
|
*/
|
|
public void initializePlayers(Player[] players) {
|
|
for (Player player : players)
|
|
injectPlayer(player);
|
|
}
|
|
|
|
/**
|
|
* Used to construct a player hook.
|
|
* @param player - the player to hook.
|
|
* @return A new player hoook
|
|
* @throws IllegalAccessException Unable to do our reflection magic.
|
|
*/
|
|
protected PlayerInjector getPlayerHookInstance(Player player) throws IllegalAccessException {
|
|
|
|
// Construct the correct player hook
|
|
switch (playerHook) {
|
|
case NETWORK_HANDLER_FIELDS:
|
|
return new NetworkFieldInjector(player, this, sendingFilters);
|
|
}
|
|
|
|
throw new IllegalArgumentException("Cannot construct a player injector.");
|
|
}
|
|
|
|
/**
|
|
* Initialize a player hook, allowing us to read server packets.
|
|
* @param player - player to hook.
|
|
*/
|
|
protected void injectPlayer(Player player) {
|
|
// Don't inject if the class has closed
|
|
if (!hasClosed && player != null && !playerInjection.containsKey(player)) {
|
|
try {
|
|
PlayerInjector injector = getPlayerHookInstance(player);
|
|
|
|
injector.injectManager();
|
|
playerInjection.put(player, injector);
|
|
connectionLookup.put(injector.getInputStream(false), player);
|
|
|
|
} catch (IllegalAccessException e) {
|
|
// Mark this injection attempt as a failure
|
|
playerInjection.put(player, null);
|
|
logger.log(Level.SEVERE, "Unable to access fields.", e);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register this protocol manager on Bukkit.
|
|
* @param manager - Bukkit plugin manager that provides player join/leave events.
|
|
* @param plugin - the parent plugin.
|
|
*/
|
|
public void registerEvents(PluginManager manager, final Plugin plugin) {
|
|
|
|
try {
|
|
manager.registerEvents(new Listener() {
|
|
|
|
@EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
|
|
public void onPlayerJoin(PlayerJoinEvent event) {
|
|
injectPlayer(event.getPlayer());
|
|
}
|
|
|
|
@EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
|
|
public void onPlayerQuit(PlayerQuitEvent event) {
|
|
uninjectPlayer(event.getPlayer());
|
|
}
|
|
|
|
@EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true)
|
|
public void onPluginDisabled(PluginDisableEvent event) {
|
|
// Clean up in case the plugin forgets
|
|
if (event.getPlugin() != plugin) {
|
|
removePacketListeners(event.getPlugin());
|
|
}
|
|
}
|
|
|
|
}, plugin);
|
|
|
|
} catch (NoSuchMethodError e) {
|
|
// Oh wow! We're running on 1.0.0 or older.
|
|
registerOld(manager, plugin);
|
|
}
|
|
}
|
|
|
|
// Yes, this is crazy.
|
|
@SuppressWarnings({ "unchecked", "rawtypes" })
|
|
private void registerOld(PluginManager manager, Plugin plugin) {
|
|
|
|
try {
|
|
ClassLoader loader = manager.getClass().getClassLoader();
|
|
|
|
// The different enums we are going to need
|
|
Class eventTypes = loader.loadClass("org.bukkit.event.Event$Type");
|
|
Class eventPriority = loader.loadClass("org.bukkit.event.Event$Priority");
|
|
|
|
// Get the priority
|
|
Object priorityNormal = Enum.valueOf(eventPriority, "Normal");
|
|
|
|
// Get event types
|
|
Object playerJoinType = Enum.valueOf(eventTypes, "PLAYER_JOIN");
|
|
Object playerQuitType = Enum.valueOf(eventTypes, "PLAYER_QUIT");
|
|
Object pluginDisabledType = Enum.valueOf(eventTypes, "PLUGIN_DISABLE");
|
|
|
|
// The player listener! Good times.
|
|
Class<?> playerListener = loader.loadClass("org.bukkit.event.player.PlayerListener");
|
|
Class<?> serverListener = loader.loadClass("org.bukkit.event.server.ServerListener");
|
|
|
|
// Find the register event method
|
|
Method registerEvent = FuzzyReflection.fromObject(manager).getMethodByParameters("registerEvent",
|
|
eventTypes, Listener.class, eventPriority, Plugin.class);
|
|
|
|
Enhancer playerEx = new Enhancer();
|
|
Enhancer serverEx = new Enhancer();
|
|
|
|
playerEx.setSuperclass(playerListener);
|
|
playerEx.setClassLoader(classLoader);
|
|
playerEx.setCallback(new MethodInterceptor() {
|
|
@Override
|
|
public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
|
|
// Must have a parameter
|
|
if (args.length == 1) {
|
|
Object event = args[0];
|
|
|
|
// Check for the correct event
|
|
if (event instanceof PlayerJoinEvent)
|
|
injectPlayer(((PlayerJoinEvent) event).getPlayer());
|
|
else if (event instanceof PlayerQuitEvent)
|
|
injectPlayer(((PlayerQuitEvent) event).getPlayer());
|
|
}
|
|
return null;
|
|
}
|
|
});
|
|
|
|
serverEx.setSuperclass(serverListener);
|
|
serverEx.setClassLoader(classLoader);
|
|
serverEx.setCallback(new MethodInterceptor() {
|
|
@Override
|
|
public Object intercept(Object obj, Method method, Object[] args,
|
|
MethodProxy proxy) throws Throwable {
|
|
// Must have a parameter
|
|
if (args.length == 1) {
|
|
Object event = args[0];
|
|
|
|
if (event instanceof PluginDisableEvent)
|
|
removePacketListeners(((PluginDisableEvent) event).getPlugin());
|
|
}
|
|
return null;
|
|
}
|
|
});
|
|
|
|
// Create our listener
|
|
Object playerProxy = playerEx.create();
|
|
Object serverProxy = serverEx.create();
|
|
|
|
registerEvent.invoke(manager, playerJoinType, playerProxy, priorityNormal, plugin);
|
|
registerEvent.invoke(manager, playerQuitType, playerProxy, priorityNormal, plugin);
|
|
registerEvent.invoke(manager, pluginDisabledType, serverProxy, priorityNormal, plugin);
|
|
|
|
// A lot can go wrong
|
|
} catch (ClassNotFoundException e1) {
|
|
e1.printStackTrace();
|
|
} catch (IllegalArgumentException e) {
|
|
e.printStackTrace();
|
|
} catch (IllegalAccessException e) {
|
|
e.printStackTrace();
|
|
} catch (InvocationTargetException e) {
|
|
e.printStackTrace();
|
|
}
|
|
}
|
|
|
|
private void uninjectPlayer(Player player) {
|
|
if (!hasClosed && player != null) {
|
|
|
|
PlayerInjector injector = playerInjection.get(player);
|
|
DataInputStream input = injector.getInputStream(true);
|
|
|
|
if (injector != null) {
|
|
injector.cleanupAll();
|
|
|
|
playerInjection.remove(injector);
|
|
connectionLookup.remove(input);
|
|
}
|
|
}
|
|
}
|
|
|
|
private PlayerInjector getInjector(Player player) {
|
|
if (!playerInjection.containsKey(player)) {
|
|
// What? Try to inject again.
|
|
injectPlayer(player);
|
|
}
|
|
|
|
PlayerInjector injector = playerInjection.get(player);
|
|
|
|
// Check that the injector was sucessfully added
|
|
if (injector != null)
|
|
return injector;
|
|
else
|
|
throw new IllegalArgumentException("Player has no injected handler.");
|
|
}
|
|
|
|
/**
|
|
* Retrieves the current plugin class loader.
|
|
* @return Class loader.
|
|
*/
|
|
public ClassLoader getClassLoader() {
|
|
return classLoader;
|
|
}
|
|
|
|
@Override
|
|
public boolean isClosed() {
|
|
return hasClosed;
|
|
}
|
|
|
|
public void close() {
|
|
// Guard
|
|
if (hasClosed)
|
|
return;
|
|
|
|
// Remove everything
|
|
for (PlayerInjector injection : playerInjection.values()) {
|
|
injection.cleanupAll();
|
|
}
|
|
|
|
// Remove packet handlers
|
|
if (packetInjector != null)
|
|
packetInjector.cleanupAll();
|
|
|
|
// Remove listeners
|
|
packetListeners.clear();
|
|
playerInjection.clear();
|
|
connectionLookup.clear();
|
|
hasClosed = true;
|
|
}
|
|
|
|
@Override
|
|
protected void finalize() throws Throwable {
|
|
close();
|
|
}
|
|
}
|