Nested includes cause ConfigParseError

Config structure:

.
├── config
└── subdir
    ├── foo
    │   ├── config
    └── includes

config:

Include subdir/includes

subdir/includes:

Include subdir/foo/config

expected result

no error. ssh at the command line works ssh_config man page states:

Files without absolute paths are assumed to be in ~/.ssh if included in a user configuration file

actual result

asyncssh.config.ConfigParseError: No match to pattern

Stack trace

Traceback (most recent call last):
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/bin/ocl", line 33, in <module>
    sys.exit(load_entry_point('OneDevEx', 'console_scripts', 'ocl')())
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/click/core.py", line 1128, in __call__
    return self.main(*args, **kwargs)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/click/core.py", line 1053, in main
    rv = self.invoke(ctx)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/click/core.py", line 1659, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/click/core.py", line 1395, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/click/core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "/private/home/calebh/projects/OneDevEx/onedevex/aioutil.py", line 17, in wrapper
    loop.run_until_complete(root_task)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/asyncio/base_events.py", line 641, in run_until_complete
    return future.result()
  File "/private/home/calebh/projects/OneDevEx/onedevex/cli/commands/submit.py", line 29, in submit
    async with asyncssh.connect(cluster_host, known_hosts=None) as c, bootstrap(
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/misc.py", line 274, in __aenter__
    self._coro_result = await self._coro
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/connection.py", line 7682, in connect
    new_options = SSHClientConnectionOptions(options, config=config, host=host,
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/connection.py", line 6181, in __init__
    super().__init__(options=options, last_config=last_config, **kwargs)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/misc.py", line 350, in __init__
    self.prepare(**self.kwargs)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/connection.py", line 6881, in prepare
    config = SSHClientConfig.load(last_config, config, reload,
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/config.py", line 375, in load
    config.parse(Path(path))
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/config.py", line 335, in parse
    handler(self, option, args)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/config.py", line 137, in _include
    self.parse(path)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/config.py", line 335, in parse
    handler(self, option, args)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/config.py", line 134, in _include
    self._error('No match to pattern "%s"', pattern)
  File "/private/home/calebh/miniconda3/envs/onedevex-dev/lib/python3.10/site-packages/asyncssh/config.py", line 71, in _error
    raise ConfigParseError('%s line %s: %s' % (self._path, self._line_no,
asyncssh.config.ConfigParseError: /private/home/calebh/.ssh/fair_ssh/includes line 1: No match to pattern "fair_ssh/calebh/config"

[ronf]

This fix is now available in the AsyncSSH 2.10.1 release.

[ronf]

Thanks for the report!

I actually considered it a feature that includes to be relative to a parent include. However, after looking more closely at the OpenSSH behavior, I see that it appears to always treat paths as relative to ~/.ssh when parsing includes initiated from ~/.ssh/config.

Also, I noticed that a missing include file is not a fatal error in OpenSSH, so I’ve changed that to be just a debug message.

I believe the following patch will fix the problem:

diff --git a/asyncssh/config.py b/asyncssh/config.py
index 74927e4..49ea444 100644
--- a/asyncssh/config.py
+++ b/asyncssh/config.py
@@ -57,6 +57,7 @@ class SSHConfig:
         else:
             self._last_options = {}

+        self._default_path = Path('~', '.ssh').expanduser()
         self._path = Path()
         self._line_no = 0
         self._matching = True
@@ -126,12 +127,12 @@ class SSHConfig:
                 pattern = str(Path(*path.parts[1:]))
                 path = Path(path.anchor)
             else:
-                path = Path(self._path).parent
+                path = self._default_path

             paths = list(path.glob(pattern))

             if not paths:
-                self._error('No match to pattern "%s"', pattern)
+                logger.debug1('Config pattern "%s" matched no files', pattern)

             for path in paths:
                 self.parse(path)

If this works for you, let me know and I’ll check this into the “develop” branch.