Commit Graph
849 Commits
Author SHA1 Message Date
Rob Hague caac95c836 Check host key algorithms before continuing key exchange (#1642)
The library currently does not check for matching host key algorithms until needed
at the end of the key exchange, in contrast to other algorithm types which are checked
beforehand. This leads to confusing or uninformative errors, normally from the server
(correctly) closing the connection.

This change moves that check alongside the rest of them, and also improves the error
messages that arise from no matching algorithms.
2025-06-06 07:34:06 +02:00
William DeckerandWilliam Decker 9cf282731a Added GetAttributesAsync to SftpClient (#1648)
* Added GetAttributesAsync to SftpClient

* Adding integration tests + unit test

* Address warnings in test classes.

---------

Co-authored-by: William Decker <william.decker@syndigo.com>
2025-06-05 23:20:13 +02:00
mus65 03e28219ba Drop netstandard2.1 target (#1647) 2025-05-29 20:33:02 +02:00
Rob Hague a024b83def Fix hang in SftpClient.UploadFile upon error (#1643)
* Fix deadlock in SftpClient.UploadFile upon error

* Make RequestWrite deterministic wrt. exception handling

* add regression test; fix race

* x
2025-05-27 09:26:36 +02:00
4fcf6048f8 Re-introduce ChangeWindow method on ShellStream (#1646)
* Re-introduce ChangeWindow method on ShellStream

* Fix pipeline build

* Fix pipeline build

* tweaks

Co-authored-by: Glen Kleidon <glenk@galkam.com.au>
Co-authored-by: oheiheiheiheihei <294797392@qq.com>

---------

Co-authored-by: Ivan Zaitsev <crackbargains@gmail.com>
Co-authored-by: Robert Hague <rh@johnstreetcapital.com>
Co-authored-by: Glen Kleidon <glenk@galkam.com.au>
Co-authored-by: oheiheiheiheihei <294797392@qq.com>
2025-05-25 20:09:03 +02:00
Noah Dela RosaandRob Hague d08c4aaa8a Add UploadFileAsync and DownloadFileAsync methods (#1634)
* add interface methods

* add internal file methods

* impl interface methods

* tweak buffer size usage

* swap tests with async upload

* swap more upload file references

* add async download tests

* add upload/download integration async test

* check if net48

* silence not await warning

* try tweaking test init

* remove request close from upload

* dispose already closes, remove dup call

* remove extra upload overload

* inherit doc

* configure await

* remove excess util functions

* add cancel throws

* add cancellation tests

* missed one configure await

* use default buffer size

* private ctor

* docs

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-05-05 23:03:10 +02:00
Rob Hague 7c07b10e4a Read the underlying buffer in SshDataStream (#1638)
SshDataStream is a MemoryStream, so we can access the buffer directly.
Also simplify some usage in PrivateKeyFile.
2025-05-04 12:39:01 +02:00
Rob Hague 6039e121a8 Override more methods in PipeStream, ShellStream (#1637)
Where beneficial, add additional overrides from the base Stream class. Namely the Span
variants and for PipeStream, the WriteAsync variants (see comments).

The change also adds an internal type borrowed from the runtime repo for easier buffer
management, which could also be used elsewhere.
2025-05-04 11:40:37 +02:00
Rob Hague 98982a931e Update docs and remove a leftover DSA certificate algorithm (#1632)
* Update docs and remove a leftover DSA certificate algorithm

* more cleanup
2025-05-04 11:39:54 +02:00
Rob Hague 85905082db Add a debug helper for reading traffic with Wireshark (#1627)
Wireshark can already helpfully dissect the initial SSH handshake. When given the
session keys, it can also dissect the encrypted traffic for inspection/debugging.
This adds a helper in Debug mode to write out that information in the format
Wireshark requires.

Usage is to set `SshNetLoggingConfiguration.WiresharkKeyLogFilePath` before connecting, and supply the same value to Wireshark in Edit -> Preferences -> Protocols
-> SSH -> "Key log filename".

The description of the format is at https://wiki.wireshark.org/SSH#key-log-format
2025-05-04 11:38:55 +02:00
1cc527e205 Added ExistsAsync and GetAsync to ISftpClient (#1628)
Co-authored-by: Martin Solarik <martin.solarik@rws.com>
Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-04-10 13:00:07 +02:00
dependabot[bot]andRob Hague 58eaeec226 Bump the dependencies (#1625)
* Bump the dependencies group with 5 updates

* use MEL 8.0.3

* use MSTest meta package

* revert Meziantou due to NRE

* add a more useful global.json and pin third party action

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-04-10 09:13:36 +02:00
mus65 ad174829cc remove unused bcrypt code (#1626) 2025-04-05 15:50:00 +02:00
mus65 c318e39d2c lock SendData to fix random connection failures (#1623) 2025-03-29 17:16:42 +01:00
Rob Hague 153b47d976 Add an OrderedDictionary implementation for algorithm priorities (#1611)
* Add an OrderedDictionary implementation for algorithm priorities

During the key exchange, the algorithms to be used are chosen based on the order that
the client sends: first algorithm is most desirable. Currently, the algorithm
collections in ConnectionInfo are defined as IDictionary<,> and backed by
Dictionary<,>, which does not have any guarantees on the order of enumeration
(in practice, when only adding and not removing items it does enumerate in the order
that items were added as an implementation detail, but it's not great to rely on it).

This change adds IOrderedDictionary<,> and uses it in ConnectionInfo. On .NET 9,
this is backed by System.Collections.Generic.OrderedDictionary<,> and on lower
targets, it uses a relatively simple implementation backed by a List and a
Dictionary.

* use ThrowIfNegative
2025-03-25 14:27:19 +01:00
Rob Hague 484afbdf9d Add a Stream buffer validation helper (#1605)
* Add a Stream buffer validation helper

* add ThrowHelper.ThrowIfNegative
2025-03-25 12:45:18 +01:00
Rob Hague bb3beeb6c5 Fix API break on KeyExchange (#1609)
This type is public and a `private protected` ctor breaks subclassing outside the assembly
2025-03-25 09:57:46 +01:00
mus65 d1213cf751 remove Reverse extension to avoid source-breaking change with .NET 10 (#1606)
* remove Reverse extension to avoid source-breaking change with .NET 10

* revert to ifdef in some places

to avoid extra array copy on lower targets
2025-03-01 17:01:23 +01:00
86dc811458 Drop net6.0 target (#1580)
* Drop net6.0 target

* Update src/Renci.SshNet/Common/TaskToAsyncResult.cs

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

* remove redundant #if

for some reason this made the compiler suddenly
realize that the plain text variables are unused.

* use TargetFrameworkIdentifier

this doesn't work in Directory.Build.props, moved it to Directory.Build.targets.

* fix null reference warnings in Benchmarks

seems like the warnings were (somehow) disabled here
before and were fixed by the previous TargetFrameworkIdentifier
change.

* fix unused plainTextOffset in AesGcmCipher.BclImpl

* CI retry

* more cosmetics

* more

* update README

* Revert "use TargetFrameworkIdentifier"

This reverts commit 076ede161d.

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
Co-authored-by: Robert Hague <rh@johnstreetcapital.com>
2025-02-19 13:37:38 +01:00
Rob Hague 99ef23cd87 Don't dispose channel when completing SshCommand (#1596)
The new(-ish) implementation of SshCommand has a race condition for short-lived
commands where SSH_MSG_CHANNEL_CLOSE may be processed on the message loop thread
before SSH_MSG_CHANNEL_SUCCESS is waited upon on the Execute (main) thread. This
manifests in an ArgumentNull/NullReference exception on the wait handle because
the channel has already been closed and disposed.

Fix this by only delaying the channel dispose until the command dispose.
2025-02-19 13:16:12 +01:00
Rob Hague a0c6bac3a7 Reply to global requests when want_reply is true (#1600)
We currently don't recognise any global requests from the server, but if one is
sent, then per RFC 4253 section 4 we still need to reply when the server expects
one. So send SSH_MSG_REQUEST_FAILURE in this case.
2025-02-19 13:15:45 +01:00
16d84d0395 Bump test dependencies (#1583)
* Bump coverlet.collector from 6.0.2 to 6.0.4

Bumps [coverlet.collector](https://github.com/coverlet-coverage/coverlet) from 6.0.2 to 6.0.4.
- [Release notes](https://github.com/coverlet-coverage/coverlet/releases)
- [Commits](https://github.com/coverlet-coverage/coverlet/compare/v6.0.2...v6.0.4)

---
updated-dependencies:
- dependency-name: coverlet.collector
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

* update test deps

* update test deps

* some fixes

* group dependencies

* analyzer fixes

* just group them all together

* more cleanup

* silent analyzers -> suggestion

* restore constant

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Robert Hague <rh@johnstreetcapital.com>
Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-02-04 21:58:59 +01:00
Vyacheslav BrevnovandRob Hague 7a599e21c4 fix: UnhandledException: System.ObjectDisposedException. (#1590)
* fix: UnhandledException: System.ObjectDisposedException.
Error on thread pool

#1588

* tweak message

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-02-04 21:40:06 +01:00
timyhac 9c454ba978 Update bound port on ForwardedPortDynamic after connection (in case original was passed as zero) (#1577)
* update bound port (in case original was passed as zero)

* Needed to allow private set for BoundPort
2025-01-20 09:19:44 +01:00
5c29394688 Move AuthenticationMethod IDisposable implementation declaration from inheritees to parent (#746)
* Move IDisposable implementation declaration from inheritees to parent AuthenticationMethod

* Move common Dispose code to AuthenticationMethod class

* Remove unnecessary finalizers

* just move the definition

---------

Co-authored-by: Michał Drzymała <michalxdrzymala@gmail.com>
Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-01-18 13:45:09 +01:00
Scott XuandRob Hague 7e71bb4192 Add support for mlkem768x25519-sha256 key exchange method (#1563)
Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2025-01-11 15:46:22 +01:00
Rob Hague 6d94e97ac0 Fix hang/unhandled exception in SshCommand upon disconnect (#1565) 2025-01-03 11:13:45 +01:00
Rob Hague 60f3cd803e Drop DSA (#1558)
DSA is removed at compile time from OpenSSH 9.8 and higher.
That means we can no longer test it in our integration tests. It seems like a
good time to remove it. From the OpenSSH release notes:

    DSA, as specified in the SSHv2 protocol, is inherently weak - being
    limited to a 160 bit private key and use of the SHA1 digest. Its
    estimated security level is only 80 bits symmetric equivalent.

    OpenSSH has disabled DSA keys by default since 2015 but has retained
    run-time optional support for them. DSA was the only mandatory-to-
    implement algorithm in the SSHv2 RFCs, mostly because alternative
    algorithms were encumbered by patents when the SSHv2 protocol was
    specified.

    This has not been the case for decades at this point and better
    algorithms are well supported by all actively-maintained SSH
    implementations. We do not consider the costs of maintaining DSA
    in OpenSSH to be justified and hope that removing it from OpenSSH
    can accelerate its wider deprecation in supporting cryptography
    libraries.
2025-01-03 11:12:21 +01:00
Scott Xu 2e68828f61 Add support for sntrup761x25519Sha512 key exchange method (#1562) 2025-01-02 13:20:28 +01:00
Scott Xu 14c652cb45 Use System.Security.Cryptography for TripleDesCipher (#1546)
* Use System.Security.Cryptography in DesCipher and TripleDesCipher; Fall back to use BouncyCastle if BCL doesn't support

* Drop DesCipher; Replace PKCS7Padding with BouncyCastle's implementation.

* Restore `CbcCipherMode`

* Restore AesCipherMode; Use BlockImpl instead of BouncyCastleImpl for 3DES-CFB on lower targets.

* Restore the xml doc comment
2024-12-27 13:37:02 +01:00
29997aebe1 Add padding when encrypt and remove padding when decrypt (#1545)
* Tighten private key checking to reveal padding issue

* `Encrypt` should take into account padding for length of `inputBuffer` passed to `EncryptBlock` if padding is specified, no matter input is divisible or not.

* `Decrypt` should take into account unpadding for the final output if padding is specified.

* `Decrypt` should take into account *manual* padding for length of `inputBuffer` passed to `DecryptBlock` and unpadding for the final output if padding is not specified and mode is CFB or OFB.

* `Encrypt` should take into account *manual* padding for length of `inputBuffer` passed to `EncryptBlock` and unpadding for the final output if padding is not specified and mode is CFB or OFB.

* Rectify DES cipher tests. There's no padding in the data.

* Borrow `PadCount` method from BouncyCastle

* Manually pad input in CTR mode as well. Update AesCipherTest.

Co-Authored-By: Rob Hague <5132141+Rob-Hague@users.noreply.github.com>

* Manually pad/unpad for Aes CFB/OFB mode

* Update test/Renci.SshNet.Tests/Classes/Security/Cryptography/Ciphers/AesCipherTest.Gen.cs.txt

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

* Re-generate AES cipher tests

---------

Co-authored-by: Rob Hague <5132141+Rob-Hague@users.noreply.github.com>
Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-12-22 16:21:02 +01:00
Rob HagueandWojciech Nagórski 42d75bc3d1 Drop net7.0 target (#1468)
* Drop net7.0 target

.NET 7 is EOL since May. The only .NET 7 features we use are
`ObjectDisposedException.ThrowIf` (moved to a throw helper) and
some newer regex features.

This feels a bit weird, but I suppose it is the expected course of action.

* fix build warning-as-error which is suddenly appearing on net6.0

IsAotCompatible not supported on net6.0

---------

Co-authored-by: Wojciech Nagórski <wojtpl2@gmail.com>
2024-12-18 17:35:03 +00:00
Rob Hague d96b9ebc32 Fix consumption of NBGV version properties in build (#1544)
The last release was originally missing the tag in the release notes link
2024-12-18 17:34:23 +00:00
Varorbc ee054f4d31 fix newline characters in PuTTY key file comment (#1550) 2024-12-04 09:49:40 +01:00
Scott XuandRob Hague 3b4f2cfc1c [Private Key] Add support for PuTTY private key file format (V3 and V2) (#1543)
* [Private Key] Add support for PuTTY private key

* add negative test for mac

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-12-02 23:44:44 +01:00
mus65andRob Hague 70c12467dd Replace DiagnosticAbstration with Microsoft.Extensions.Logging.Abstractions (#1509)
* Replace DiagnosticAbstrations with Microsoft.Extensions.Logging.Abstractions

* add documentation

* reduce allocations by SessionId hex conversion

generate the hex string once instead of every log
call and optimize ToHex().

* Update docfx/logging.md

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

* reduce log levels

* hook up testcontainers logging

* drop packet logs further down to trace

* add kex traces

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-12-02 23:15:48 +01:00
mus65andRob Hague 752b1db8f0 Add .NET 9 target (#1480)
* Add .NET 9 target

* Disable SonarSource S3236

This following change in the runtime now causes this analyzer
to complain about some Debug.Assert calls which doesn't make sense.

https://github.com/dotnet/core/blob/main/release-notes/9.0/preview/preview7/libraries.md#debugassert-now-reports-assert-condition-by-default
https://rules.sonarsource.com/csharp/RSPEC-3236/

* make use of .NET 9 Lock type

see https://github.com/dotnet/runtime/issues/34812

* Define own Lock type to avoid ifdefs

* revert irrelevant style changes

* update global.json

* Keep net8.0 target in IntegrationTests

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

* fix Package Downgrade Warning

for some reason this happens starting with .NET 9.0 RC2:

/home/mus/git/SSH.NET/test/Renci.SshNet.IntegrationTests/Renci.SshNet.IntegrationTests.csproj : error NU1605:
      Warning As Error: Detected package downgrade: BouncyCastle.Cryptography from 2.4.0 to 2.3.1. Reference the package directly from the project to select a different version.
       Renci.SshNet.IntegrationTests -> SSH.NET 1.0.0 -> BouncyCastle.Cryptography (>= 2.4.0)
       Renci.SshNet.IntegrationTests -> Testcontainers 3.10.0 -> BouncyCastle.Cryptography (>= 2.3.1)

* update global.json to RC2

* update global.json to .NET 9 GA

* update GitHub Actions for .NET 9

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-11-23 17:51:59 +01:00
Scott XuandRob Hague 3ec45e1af3 Split PrivateKeyFile into different implementations. (#1542)
* Split PrivateKeyFile into different implementations.

* Remove duplicate keyName check. Get cipherName and salt only if the key is PKCS1 format.

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-11-20 13:42:08 +01:00
Rikard JohanssonandRobert Hague bdaa16463a Handle lower-case hex in private key's salt field (#179)
* Handle lower-case hex in private key's salt field

I'm using BouncyCastle (http://bouncycastle.org/) to produce public/private key pairs. In later versions of SSH.NET an exception is thrown (SshException: "Invalid private key file.") while establishing connection using the private keys previously generated.

It seems to be an issue with the regex matching the private key file data which this commit handles properly.

* add test

---------

Co-authored-by: Robert Hague <rh@johnstreetcapital.com>
2024-11-19 09:20:46 +01:00
Scott Xu 239fe31123 Update PrivateKeyFile.cs (#1541) 2024-11-18 22:32:13 +01:00
Rob Hague c28f02301f Swallow ObjectDisposed on SFTP wait handle when receiving late response (#1531) 2024-11-11 21:09:54 +01:00
Rob HagueandcedricMicrovision 3e12c96317 Add support for OpenSSH certificates (#1498)
Co-authored-by: cedricMicrovision <cedric.legoff@microvision.fr>
2024-10-19 14:36:41 +02:00
Rob Hague fbedaabb9c Fix sftp async methods not observing error conditions (#1510)
* Fix sftp async methods not observing error conditions

* Update ISftpClient
2024-10-08 08:48:57 +02:00
Ryan EstevesandRob Hague 1a8839ec3e Added support for deleting directories asynchronously (#1503)
* Added support for deleting directories asynchronously

* Clarify that the task represents the asynchronous delete operation

Co-authored-by: Rob Hague <rob.hague00@gmail.com>

* Added DeleteAsync and DeleteDirectoryAsync to ISftpClient

* Inherit docs from interface

* Added additional tests for new async delete functions

* Update list directory test to use async delete methods

* x

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-09-26 08:55:51 +02:00
Ryan EstevesandRob Hague ce867d6640 Added CreateDirectoryAsync to SftpClient (#1505)
* Added CreateDirectoryAsync to SftpClient

* Use CreateDirectoryAsync for async test

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-09-25 21:50:27 +02:00
Ryan Esteves 737c3e5f9d Added ChangeDirectoryAsync to SftpClient (#1504)
* Add ChangeDirectoryAsync

* Added async tests for ChangeDirectoryAsync
2024-09-24 21:19:26 +02:00
mus65 28e674228f fix ConnectAsync not respecting the connection timeout (#1502) 2024-09-22 13:05:32 +02:00
Ryan EstevesandRob Hague 4c5d0c075e Added ExistsAsync and GetAsync to SftpClient (#1501)
* Added ExistsAsync to SftpClient

* Added GetAsync to SftpClient

---------

Co-authored-by: Rob Hague <rob.hague00@gmail.com>
2024-09-21 18:07:37 +02:00
Eugen Cowie 82246e3cc9 Add interface to SshClient (#1499) 2024-09-21 16:24:22 +02:00
Scott Xu 548ef23e12 Add support for OpenSSL PKCS#8 private key format (#1496)
* Add support for OpenSSL PKCS#8 private key format

* Update comments

* Convert public key to ssh format

* Convert existing keys instead of generate new keys; Use DataRow for testing

* Minimize the change

* Minimize the change

* Fix build
2024-09-21 16:07:59 +02:00