From f9ed9663dd5bc7657bf2c2725df609c672263a23 Mon Sep 17 00:00:00 2001 From: Henning Poettker Date: Wed, 1 Jan 2025 18:50:31 +0100 Subject: [PATCH] Add empty data to SSH_MSG_IGNORE messages As required by RFC 4253 Section 11.2, and RFC 4251 Section 5 --- .../transport/kex/StrictKeyExchangeTest.java | 2 +- .../net/schmizz/keepalive/Heartbeater.java | 2 +- .../schmizz/keepalive/HeartbeaterTest.java | 51 +++++++++++++++++++ 3 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 src/test/java/net/schmizz/keepalive/HeartbeaterTest.java diff --git a/src/itest/java/com/hierynomus/sshj/transport/kex/StrictKeyExchangeTest.java b/src/itest/java/com/hierynomus/sshj/transport/kex/StrictKeyExchangeTest.java index 9d207c0ec..229f1b3dd 100644 --- a/src/itest/java/com/hierynomus/sshj/transport/kex/StrictKeyExchangeTest.java +++ b/src/itest/java/com/hierynomus/sshj/transport/kex/StrictKeyExchangeTest.java @@ -145,7 +145,7 @@ public boolean isEnabled() { @Override protected void doKeepAlive() throws TransportException { - conn.getTransport().write(new SSHPacket(Message.IGNORE)); + conn.getTransport().write(new SSHPacket(Message.IGNORE).putString("")); } } diff --git a/src/main/java/net/schmizz/keepalive/Heartbeater.java b/src/main/java/net/schmizz/keepalive/Heartbeater.java index e18ea9971..e6dbb5357 100644 --- a/src/main/java/net/schmizz/keepalive/Heartbeater.java +++ b/src/main/java/net/schmizz/keepalive/Heartbeater.java @@ -29,6 +29,6 @@ final class Heartbeater @Override protected void doKeepAlive() throws TransportException { - conn.getTransport().write(new SSHPacket(Message.IGNORE)); + conn.getTransport().write(new SSHPacket(Message.IGNORE).putString("")); } } diff --git a/src/test/java/net/schmizz/keepalive/HeartbeaterTest.java b/src/test/java/net/schmizz/keepalive/HeartbeaterTest.java new file mode 100644 index 000000000..38eadc652 --- /dev/null +++ b/src/test/java/net/schmizz/keepalive/HeartbeaterTest.java @@ -0,0 +1,51 @@ +/* + * Copyright (C)2009 - SSHJ Contributors + * + * 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. + */ +package net.schmizz.keepalive; + +import net.schmizz.sshj.DefaultConfig; +import net.schmizz.sshj.common.Message; +import net.schmizz.sshj.common.SSHPacket; +import net.schmizz.sshj.connection.ConnectionImpl; +import net.schmizz.sshj.transport.Transport; + +import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +class HeartbeaterTest { + + @Test + void ignoreMessageContainsData() throws Exception { + Transport transport = mock(Transport.class); + when(transport.getConfig()).thenReturn(new DefaultConfig()); + ArgumentCaptor sshPacketCaptor = ArgumentCaptor.forClass(SSHPacket.class); + when(transport.write(sshPacketCaptor.capture())).thenReturn(0L); + ConnectionImpl connection = new ConnectionImpl(transport, KeepAliveProvider.HEARTBEAT); + + KeepAlive heartbeater = connection.getKeepAlive(); + assertThat(heartbeater).isInstanceOf(Heartbeater.class); + + heartbeater.doKeepAlive(); + + SSHPacket sshPacket = sshPacketCaptor.getValue(); + assertThat(sshPacket.readMessageID()).isEqualTo(Message.IGNORE); + assertThat(sshPacket.readBytes()).isNotNull(); + } + +}