WIP handshake mechanism rewrite

This commit is contained in:
Adrian Bergqvist 2024-01-22 19:32:28 +01:00
parent 3fa30b7362
commit 222b22eb3c
No known key found for this signature in database
GPG Key ID: FAE7D8EDE225E686
9 changed files with 199 additions and 149 deletions

@ -1 +1 @@
Subproject commit eb594fc799281ff418dc2c161c2d8a8eb0c89a19
Subproject commit c3583e182ca6585e40d1eef0da8c18547c0b1bc1

View File

@ -0,0 +1,70 @@
package org.adde0109.ambassador.forge;
import com.velocitypowered.proxy.connection.client.ConnectedPlayer;
import org.adde0109.ambassador.forge.packet.*;
import java.util.HashMap;
import java.util.Map;
import java.util.zip.Adler32;
import java.util.zip.Checksum;
public class ShadowHandshakeReceiver {
private final ConnectedPlayer player;
private final ModListReplyPacket modListReplyPacket;
private final Map<String, Long> registries;
private ShadowHandshakeReceiver(ConnectedPlayer player, ModListReplyPacket modListReplyPacket,
Map<String, Long> registries) {
this.player = player;
this.modListReplyPacket = modListReplyPacket;
this.registries = registries;
}
void handle(IForgeLoginWrapperPacket packet) throws IncompatibleHandshake {
}
void handle(ModListPacket packet) throws IncompatibleHandshake {
//player.getConnection().write();
}
void handle(RegistryPacket packet) throws IncompatibleHandshake {
player.getConnection().write(new ACKPacket(Context.fromContext(packet.getContext(), true)));
}
void handle(ConfigDataPacket packet) throws IncompatibleHandshake {
player.getConnection().write(new ACKPacket(Context.fromContext(packet.getContext(), true)));
}
static class Builder {
ConnectedPlayer player;
ModListReplyPacket modListReplyPacket;
Map<String, Long> registries = new HashMap<>();
void addModListPacket(ModListPacket packet) {
}
void setModListReplyPacket(ModListReplyPacket packet) {
this.modListReplyPacket = packet;
}
void addRegistryPacket(RegistryPacket packet) {
Checksum registryChecksum = new Adler32();
registryChecksum.update(packet.getSnapshot());
registries.put(packet.getRegistryName(), registryChecksum.getValue());
}
ShadowHandshakeReceiver build() {
return new ShadowHandshakeReceiver(player, modListReplyPacket, registries);
}
}
class IncompatibleHandshake extends Throwable {
}
}

View File

@ -6,6 +6,7 @@ import com.velocitypowered.proxy.connection.backend.VelocityServerConnection;
import com.velocitypowered.proxy.connection.client.ConnectedPlayer;
import com.velocitypowered.proxy.network.Connections;
import com.velocitypowered.proxy.protocol.ProtocolUtils;
import com.velocitypowered.proxy.protocol.StateRegistry;
import com.velocitypowered.proxy.protocol.packet.AvailableCommands;
import com.velocitypowered.proxy.protocol.packet.PluginMessage;
import net.kyori.adventure.identity.Identity;
@ -18,10 +19,10 @@ import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CountDownLatch;
public enum VelocityForgeBackendConnectionPhase implements BackendConnectionPhase {
NOT_STARTED() {
NOT_STARTED {
@Override
VelocityForgeBackendConnectionPhase nextPhase() {
return WAITING_FOR_ACK;
return IN_PROGRESS;
}
@Override
@ -30,7 +31,7 @@ public enum VelocityForgeBackendConnectionPhase implements BackendConnectionPhas
return true;
}
},
WAITING_FOR_ACK() {
IN_PROGRESS {
@Override
public void onLoginSuccess(VelocityServerConnection serverCon, ConnectedPlayer player) {
serverCon.setConnectionPhase(VelocityForgeBackendConnectionPhase.COMPLETE);
@ -50,7 +51,7 @@ public enum VelocityForgeBackendConnectionPhase implements BackendConnectionPhas
}
},
COMPLETE() {
COMPLETE {
@Override
public boolean consideredComplete() {
return true;
@ -68,15 +69,29 @@ public enum VelocityForgeBackendConnectionPhase implements BackendConnectionPhas
server.setConnectionPhase(newPhase);
if (player.getPhase() == VelocityForgeClientConnectionPhase.NOT_STARTED ||
player.getPhase() == VelocityForgeClientConnectionPhase.IN_PROGRESS) {
//Initial Forge
player.getConnection().write(message);
return;
}
//Forge -> Forge
//Reset client if not ready to receive new handshake
VelocityForgeClientConnectionPhase clientPhase = (VelocityForgeClientConnectionPhase) player.getPhase();
if (clientPhase == VelocityForgeClientConnectionPhase.RESETTABLE) {
//Initial Forge
//Forge -> Forge
if (clientPhase.getResetType() == VelocityForgeClientConnectionPhase.clientResetType.CRP ||
clientPhase.getResetType() == VelocityForgeClientConnectionPhase.clientResetType.SR) {
clientPhase.resetConnectionPhase(player);
}
if (clientPhase != VelocityForgeClientConnectionPhase.COMPLETE) {
//STILL WIP
if (!Ambassador.getInstance().config.isDebugMode()) {
return;
}
if (clientPhase.getResetType() == VelocityForgeClientConnectionPhase.clientResetType.NONE) {
if (message instanceof ModListPacket modListPacket) {
clientPhase.forgeHandshake = new ForgeHandshake();
}
@ -118,15 +133,15 @@ public enum VelocityForgeBackendConnectionPhase implements BackendConnectionPhas
}
}, server.ensureConnected().eventLoop());
} else if (message instanceof RegistryPacket registryPacket) {
server.getConnection().write(new ACKPacket(Context.createContext(message.getContext().getResponseID(), true)));
server.getConnection().write(new ACKPacket(Context.fromContext(message.getContext(), true)));
handshake.addRegistry(registryPacket);
remainingRegistries.countDown();
} else if (message instanceof ConfigDataPacket) {
server.getConnection().write(new ACKPacket(Context.createContext(message.getContext().getResponseID(), true)));
server.getConnection().write(new ACKPacket(Context.fromContext(message.getContext(), true)));
} else if (message instanceof GenericForgeLoginWrapperPacket<?> packet
&& ForgeHandshakeUtils.SilentGearUtils.isSilentGearPacket(packet.getContent())) {
server.getConnection().write(new ForgeHandshakeUtils.SilentGearUtils.ACKPacket(
Context.createContext(message.getContext().getResponseID(), true)));
Context.fromContext(message.getContext(), true)));
}
}
//Forge server

View File

@ -10,7 +10,7 @@ import com.velocitypowered.proxy.connection.client.ConnectedPlayer;
import com.velocitypowered.proxy.network.Connections;
import com.velocitypowered.proxy.protocol.ProtocolUtils;
import com.velocitypowered.proxy.protocol.StateRegistry;
import com.velocitypowered.proxy.protocol.packet.LoginPluginMessage;
import com.velocitypowered.proxy.protocol.packet.LoginPluginMessagePacket;
import com.velocitypowered.proxy.protocol.packet.PluginMessage;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
@ -23,9 +23,7 @@ import org.adde0109.ambassador.velocity.client.FML2CRPMResetCompleteDecoder;
import org.adde0109.ambassador.velocity.client.OutboundSuccessHolder;
import org.adde0109.ambassador.velocity.client.ClientPacketQueue;
import javax.swing.*;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.TimeUnit;
public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase {
@ -36,8 +34,10 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
}
@Override
public void resetConnectionPhase(ConnectedPlayer player) {
RESETTABLE.resetConnectionPhase(player);
public void complete(ConnectedPlayer player) {
//When no handshake has taken place.
//Test if the client supports CRP.
clientResetType.CRP.doReset(player);
}
@Override
@ -47,47 +47,6 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
},
IN_PROGRESS {
},
RESETTABLE {
@Override
void onTransitionToNewPhase(ConnectedPlayer player) {
//Plugins may now send packets to client
player.getConnection().getChannel().pipeline().remove(ForgeConstants.PLUGIN_PACKET_QUEUE);
((VelocityServer) Ambassador.getInstance().server).registerConnection(player);
}
@Override
public void resetConnectionPhase(ConnectedPlayer player) {
MinecraftConnection connection = player.getConnection();
//There is no going back even if the handshake fails. No reason to still be connected.
if (player.getConnectedServer() != null) {
player.getConnectedServer().disconnect();
player.setConnectedServer(null);
}
//Don't handle anything from the server until the reset has completed.
//player.getConnectionInFlight().getConnection().getChannel().config().setAutoRead(false);
if (connection.getState() == StateRegistry.PLAY || connection.getState() == StateRegistry.CONFIG) {
connection.write(new PluginMessage("fml:handshake", Unpooled.wrappedBuffer(ForgeHandshakeUtils.generatePluginResetPacket())));
connection.setState(StateRegistry.LOGIN);
} else {
connection.write(new LoginPluginMessage(98,"fml:loginwrapper", Unpooled.wrappedBuffer(ForgeHandshakeUtils.generateResetPacket())));
}
//Prepare to receive reset ACK
connection.getChannel().pipeline().addBefore(Connections.MINECRAFT_DECODER,
ForgeConstants.RESET_LISTENER, new FML2CRPMResetCompleteDecoder());
//Transition
player.setPhase(WAITING_RESET);
WAITING_RESET.onTransitionToNewPhase(player);
}
@Override
public boolean consideredComplete() {
return true;
}
},
WAITING_RESET {
@Override
void onTransitionToNewPhase(ConnectedPlayer player) {
@ -103,6 +62,7 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
@Override
public boolean handle(ConnectedPlayer player, IForgeLoginWrapperPacket msg, VelocityServerConnection server) {
if (msg.getContext().getResponseID() == 98) {
//Reset complete
player.getConnection().getChannel().pipeline().remove(ForgeConstants.RESET_LISTENER);
player.setPhase(NOT_STARTED);
@ -110,7 +70,10 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
if (!(server.getConnection().getType() instanceof ForgeFMLConnectionType)) {
// -> vanilla
complete(player, ((Context.ClientContext) msg.getContext()).success());
complete(player, ((Context.ClientContext) msg.getContext()).success() ? clientResetType.CRP : clientResetType.UNKNOWN);
}
if (player.getConnectionInFlight() != null) {
player.getConnectionInFlight().getConnection().getChannel().config().setAutoRead(true);
}
@ -130,19 +93,7 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
@Override
public void resetConnectionPhase(ConnectedPlayer player) {
Ambassador.getTemporaryForced().put(player.getUsername(), player.getConnectionInFlight().getServer(),
Ambassador.getInstance().config.getServerSwitchCancellationTime(), TimeUnit.SECONDS);
//Disconnect - Reset
if(player.getModInfo().isPresent()
&& player.getModInfo().get().getMods().stream().anyMatch((mod -> mod.getId().equals("serverredirect")
|| mod.getId().equals("srvredirect:red")))
&& player.getVirtualHost().isPresent()) {
ByteBuf buf = Unpooled.buffer();
ProtocolUtils.writeVarInt(buf, 0);
buf.writeBytes((player.getVirtualHost().get().getHostName() + ":"
+ player.getVirtualHost().get().getPort()).getBytes(StandardCharsets.UTF_8));
player.getConnection().write(new PluginMessage("srvredirect:red", buf));
}
getResetType().doReset(player);
}
@Override
@ -154,8 +105,11 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
};
//TODO: Make a new class that's linked to each player with these fields instead of having them in this phase class
public ForgeHandshake forgeHandshake = new ForgeHandshake();
private clientResetType resetType = clientResetType.UNKNOWN;
public boolean handle(ConnectedPlayer player, IForgeLoginWrapperPacket<Context.ClientContext> msg, VelocityServerConnection server) {
if (msg instanceof ModListReplyPacket replyPacket) {
@ -180,39 +134,43 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
}
public void complete(ConnectedPlayer player) {
complete(player, isResettable(player));
complete(player, getResetType(player));
}
public void complete(ConnectedPlayer player, boolean resettable) {
public void complete(ConnectedPlayer player, clientResetType resetType) {
MinecraftConnection connection = player.getConnection();
//Send Login Success to client
((OutboundSuccessHolder) connection.getChannel().pipeline().get(ForgeConstants.SERVER_SUCCESS_LISTENER))
.sendPacket();
connection.setState(StateRegistry.PLAY);
if (resettable) {
player.setPhase(RESETTABLE);
RESETTABLE.onTransitionToNewPhase(player);
RESETTABLE.forgeHandshake = forgeHandshake;
} else {
player.setPhase(COMPLETE);
COMPLETE.onTransitionToNewPhase(player);
COMPLETE.forgeHandshake = forgeHandshake;
}
//Change phase to COMPLETE
player.setPhase(COMPLETE);
COMPLETE.resetType = resetType;
COMPLETE.onTransitionToNewPhase(player);
COMPLETE.forgeHandshake = forgeHandshake;
if (Ambassador.getInstance().config.isDebugMode()) {
player.sendMessage(Component.text("Forge handshake complete"));
player.sendMessage(Component.text(resettable ? "Resettable" : "Non-resettable"));
player.sendMessage(Component.text("Reset type: " + resetType.toString()));
}
}
private boolean isResettable(ConnectedPlayer player) {
private clientResetType getResetType(ConnectedPlayer player) {
if (Ambassador.getInstance().config.isDebugMode()) {
player.sendMessage(Component.text("Scanning modlist for client reset mods"));
}
if (player.getModInfo().isPresent()) {
return player.getModInfo().get().getMods().stream().anyMatch((mod -> mod.getId().equals("clientresetpacket")));
if (player.getModInfo().get().getMods().stream().anyMatch((mod -> mod.getId().equals("clientresetpacket")))) {
return clientResetType.CRP;
} else if (Ambassador.getInstance().config.getServerSwitchCancellationTime() >= 0 &&
player.getModInfo().get().getMods().stream().anyMatch((mod -> mod.getId().equals("serverredirect")
|| mod.getId().equals("srvredirect:red")))
&& player.getVirtualHost().isPresent()) {
return clientResetType.SR;
}
}
return false;
return clientResetType.NONE;
}
void onTransitionToNewPhase(ConnectedPlayer player) {
@ -228,5 +186,55 @@ public enum VelocityForgeClientConnectionPhase implements ClientConnectionPhase
return false;
}
public clientResetType getResetType() {
return resetType;
}
enum clientResetType {
UNKNOWN,
NONE,
CRP {
@Override
void doReset(ConnectedPlayer player) {
MinecraftConnection connection = player.getConnection();
//There is no going back even if the handshake fails. No reason to still be connected.
if (player.getConnectedServer() != null) {
player.getConnectedServer().disconnect();
player.setConnectedServer(null);
}
//Don't handle anything from the server until the reset has completed.
if (player.getConnectionInFlight() != null) {
player.getConnectionInFlight().getConnection().getChannel().config().setAutoRead(false);
}
if (connection.getState() == StateRegistry.PLAY || connection.getState() == StateRegistry.CONFIG) {
connection.write(new PluginMessage("fml:handshake", Unpooled.wrappedBuffer(ForgeHandshakeUtils.generatePluginResetPacket())));
connection.setState(StateRegistry.LOGIN);
} else {
connection.write(new LoginPluginMessagePacket(98,"fml:loginwrapper", Unpooled.wrappedBuffer(ForgeHandshakeUtils.generateResetPacket())));
}
//Prepare to receive reset ACK
connection.getChannel().pipeline().addBefore(Connections.MINECRAFT_DECODER,
ForgeConstants.RESET_LISTENER, new FML2CRPMResetCompleteDecoder());
//Transition
player.setPhase(WAITING_RESET);
WAITING_RESET.onTransitionToNewPhase(player);
}
},
SR {
@Override
void doReset(ConnectedPlayer player) {
ByteBuf buf = Unpooled.buffer();
ProtocolUtils.writeVarInt(buf, 0);
buf.writeBytes((player.getVirtualHost().get().getHostName() + ":"
+ player.getVirtualHost().get().getPort()).getBytes(StandardCharsets.UTF_8));
player.getConnection().write(new PluginMessage("srvredirect:red", buf));
}
};
void doReset(ConnectedPlayer player) {
}
}
}

View File

@ -12,10 +12,14 @@ public class Context {
return new Context(responseID);
}
public static ClientContext createContext(int responseID, boolean clientSuccess) {
public static ClientContext createClientContext(int responseID, boolean clientSuccess) {
return new ClientContext(responseID,clientSuccess);
}
public static ClientContext fromContext(Context context, boolean clientSuccess) {
return new ClientContext(context.responseID,clientSuccess);
}
public int getResponseID() {
return responseID;
}

View File

@ -1,7 +1,7 @@
package org.adde0109.ambassador.forge.pipeline;
import com.velocitypowered.proxy.protocol.ProtocolUtils;
import com.velocitypowered.proxy.protocol.packet.LoginPluginMessage;
import com.velocitypowered.proxy.protocol.packet.LoginPluginMessagePacket;
import com.velocitypowered.proxy.protocol.packet.LoginPluginResponse;
import com.velocitypowered.proxy.protocol.util.DeferredByteBufHolder;
import io.netty.buffer.ByteBuf;
@ -29,10 +29,10 @@ public class ForgeLoginWrapperCodec extends MessageToMessageCodec<DeferredByteBu
ByteBuf buf = in.content();
Context context;
if (in instanceof LoginPluginMessage msg && msg.getChannel().equals("fml:loginwrapper")) {
if (in instanceof LoginPluginMessagePacket msg && msg.getChannel().equals("fml:loginwrapper")) {
context = Context.createContext(msg.getId());
} else if (in instanceof LoginPluginResponse msg && loginWrapperIDs.remove(Integer.valueOf(msg.getId()))) {
context = Context.createContext(msg.getId(), msg.isSuccess());
context = Context.createClientContext(msg.getId(), msg.isSuccess());
} else {
ctx.fireChannelRead(in.retain());
return;
@ -106,7 +106,7 @@ public class ForgeLoginWrapperCodec extends MessageToMessageCodec<DeferredByteBu
if (msg.getContext() instanceof Context.ClientContext clientContext) {
out.add(new LoginPluginResponse(clientContext.getResponseID(), clientContext.success(), wrapped));
} else {
out.add(new LoginPluginMessage(msg.getContext().getResponseID(), "fml:loginwrapper", wrapped));
out.add(new LoginPluginMessagePacket(msg.getContext().getResponseID(), "fml:loginwrapper", wrapped));
if (!(msg instanceof ModDataPacket)) {
this.loginWrapperIDs.add(msg.getContext().getResponseID());
}

View File

@ -7,7 +7,7 @@ import com.velocitypowered.proxy.connection.backend.*;
import com.velocitypowered.proxy.connection.client.ConnectedPlayer;
import com.velocitypowered.proxy.protocol.MinecraftPacket;
import com.velocitypowered.proxy.protocol.packet.Disconnect;
import com.velocitypowered.proxy.protocol.packet.LoginPluginMessage;
import com.velocitypowered.proxy.protocol.packet.LoginPluginMessagePacket;
import com.velocitypowered.proxy.protocol.packet.ServerLoginSuccess;
import com.velocitypowered.proxy.util.except.QuietRuntimeException;
import io.netty.buffer.Unpooled;
@ -30,22 +30,16 @@ public class ForgeLoginSessionHandler implements MinecraftSessionHandler {
if ((serverConnection.getPhase() instanceof VelocityForgeBackendConnectionPhase phase)) {
phase.onLoginSuccess(serverConnection,serverConnection.getPlayer());
}
original.handle(packet);
if (serverConnection.getConnection() == null) {
return true;
}
ConnectedPlayer player = serverConnection.getPlayer();
if (!(serverConnection.getConnection().getType() instanceof ForgeFMLConnectionType)) {
if (player.getConnectedServer() == null ||
player.getConnectedServer().getConnection().getType() instanceof ForgeFMLConnectionType) {
//Initial Vanilla - test if the client can be reset
//Forge -> vanilla
player.getPhase().resetConnectionPhase(player);
player.getConnectionInFlight().getConnection().getChannel().config().setAutoRead(false);
}
} else {
original.handle(packet); //Can lead to disconnect.
//If we are still connected after handling that package.
if (serverConnection.getConnection() != null) {
ConnectedPlayer player = serverConnection.getPlayer();
((VelocityForgeClientConnectionPhase) player.getPhase()).complete(player);
}
return true;
}

View File

@ -1,41 +0,0 @@
package org.adde0109.ambassador.velocity.backend;
import com.velocitypowered.proxy.connection.MinecraftSessionHandler;
import com.velocitypowered.proxy.connection.backend.TransitionSessionHandler;
import com.velocitypowered.proxy.connection.backend.VelocityServerConnection;
import com.velocitypowered.proxy.protocol.MinecraftPacket;
import com.velocitypowered.proxy.protocol.packet.JoinGame;
import org.adde0109.ambassador.forge.VelocityForgeClientConnectionPhase;
public class ForgePlaySessionHandler implements MinecraftSessionHandler {
private final TransitionSessionHandler original;
private final VelocityServerConnection serverConnection;
public ForgePlaySessionHandler(TransitionSessionHandler original, VelocityServerConnection serverConnection) {
this.original = original;
this.serverConnection = serverConnection;
}
@Override
public boolean handle(JoinGame packet) {
if (serverConnection.getPlayer().getPhase() instanceof VelocityForgeClientConnectionPhase clientPhase) {
serverConnection.getPlayer().setPhase(VelocityForgeClientConnectionPhase.RESETTABLE);
}
return MinecraftSessionHandler.super.handle(packet);
}
@Override
public void disconnected() {
original.disconnected();
}
public void handleGeneric(MinecraftPacket packet) {
if (!packet.handle(original))
original.handleGeneric(packet);
}
public MinecraftSessionHandler getOriginal() {
return this.original;
}
}

View File

@ -28,7 +28,7 @@ public class FML2CRPMResetCompleteDecoder extends ChannelInboundHandlerAdapter {
if (id == 98) {
try {
ctx.fireChannelRead(GenericForgeLoginWrapperPacket.read(
Unpooled.EMPTY_BUFFER, Context.createContext(id, success)));
Unpooled.EMPTY_BUFFER, Context.createClientContext(id, success)));
} finally {
buf.release();
}