-
Notifications
You must be signed in to change notification settings - Fork 366
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GH-434: skip unknown public keys from external sources
Change Buffer.getPublicKey() to set the read position to after the key even if reading the key fails. This enables us to continue reading keys from a list of keys in a buffer even when a particular key cannot be decoded. Change the two places where we receive lists of public keys from external sources: from an SSH agent or via the "hostkeys-00@openssh.com" extension. Skip and log keys that cannot be decoded.
- Loading branch information
Showing
5 changed files
with
158 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
sshd-core/src/test/java/org/apache/sshd/common/global/OpenSshHostKeysHandlerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 org.apache.sshd.common.global; | ||
|
|
||
| import java.security.GeneralSecurityException; | ||
| import java.security.KeyPairGenerator; | ||
| import java.security.PublicKey; | ||
| import java.util.Collection; | ||
|
|
||
| import org.apache.sshd.common.SshException; | ||
| import org.apache.sshd.common.config.keys.KeyUtils; | ||
| import org.apache.sshd.common.session.ConnectionService; | ||
| import org.apache.sshd.common.session.Session; | ||
| import org.apache.sshd.common.util.buffer.Buffer; | ||
| import org.apache.sshd.common.util.buffer.ByteArrayBuffer; | ||
| import org.apache.sshd.util.test.BaseTestSupport; | ||
| import org.apache.sshd.util.test.NoIoTestCase; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.experimental.categories.Category; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
|
|
||
| /** | ||
| * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a> | ||
| */ | ||
| @Category(NoIoTestCase.class) | ||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class OpenSshHostKeysHandlerTest extends BaseTestSupport { | ||
|
|
||
| @Mock | ||
| private ConnectionService connectionService; | ||
|
|
||
| private PublicKey key; | ||
| private Buffer buffer; | ||
|
|
||
| public OpenSshHostKeysHandlerTest() { | ||
| super(); | ||
| } | ||
|
|
||
| @Before | ||
| public void prepareBuffer() throws Exception { | ||
| // Create an RSA key | ||
| key = KeyPairGenerator.getInstance("RSA").generateKeyPair().getPublic(); | ||
| // Serialize it twice to a buffer, but insert a fake item in between | ||
| buffer = new ByteArrayBuffer(); | ||
| buffer.putPublicKey(key); | ||
| buffer.putUInt(34); | ||
| buffer.putString("unknown"); // Fake key type; 7 + 4 bytes length | ||
| buffer.putString("followed by garbage"); // 19 + 4 | ||
| buffer.putPublicKey(key); | ||
| } | ||
|
|
||
| @Test | ||
| public void clientIgnoresUnknownKeys() throws Exception { | ||
| boolean[] handlerCalled = { false }; | ||
| org.apache.sshd.client.global.OpenSshHostKeysHandler handler | ||
| = new org.apache.sshd.client.global.OpenSshHostKeysHandler() { | ||
| @Override | ||
| protected Result handleHostKeys( | ||
| Session session, Collection<? extends PublicKey> keys, boolean wantReply, | ||
| Buffer buffer) throws Exception { | ||
| handlerCalled[0] = true; | ||
| assertEquals("Unexpected number of keys", 2, keys.size()); | ||
| for (PublicKey k : keys) { | ||
| assertTrue("Unexpected public key", KeyUtils.compareKeys(key, k)); | ||
| } | ||
| return Result.Replied; | ||
| } | ||
| }; | ||
| handler.process(connectionService, org.apache.sshd.client.global.OpenSshHostKeysHandler.REQUEST, false, buffer); | ||
| assertTrue("Handler should have been called", handlerCalled[0]); | ||
| } | ||
|
|
||
| @Test | ||
| public void serverThrowsOnUnknownKeys() throws Exception { | ||
| boolean[] handlerCalled = { false }; | ||
| org.apache.sshd.server.global.OpenSshHostKeysHandler handler | ||
| = new org.apache.sshd.server.global.OpenSshHostKeysHandler() { | ||
| @Override | ||
| protected Result handleHostKeys( | ||
| Session session, Collection<? extends PublicKey> keys, boolean wantReply, | ||
| Buffer buffer) throws Exception { | ||
| handlerCalled[0] = true; | ||
| return Result.Replied; | ||
| } | ||
| }; | ||
| SshException e = assertThrows(SshException.class, () -> handler.process(connectionService, | ||
| org.apache.sshd.server.global.OpenSshHostKeysHandler.REQUEST, false, buffer)); | ||
| assertFalse("Handler should not have been called", handlerCalled[0]); | ||
| assertTrue("Expected exception cause", e.getCause() instanceof GeneralSecurityException); | ||
| } | ||
| } |