openssh unix dev - Mar 2017 - [Doc] Extension of Included configuration files

Hello,

I'm really happy that the 7.3 release of OpenSSH introduced the
Include directive.

However, since there is absolutely no restriction or advice neither on
the name nor on the location of the included files, it makes it harder
for external tools to recognize them; I'm mainly thinking about text
editors that would like to enable syntax coloration for it (
https://github.com/vim/vim/pull/1452 ).
Until now it wasn't a problem since the file was either `ssh_config`
or `~/.ssh/config` in most cases - maybe all ? no idea if this is
configurable.

I would like to include a SHOULD part to the man section of the
Include directive in an effort to make those included files
recognizable.
I'm sure you'll have a better suggestion for the wording than me;
however you'll find a patch attached for the sentence "Configuration
file(s) referenced by this Include directive should use the .sshconfig
extension to be detected as such by external tools." but it could also
be something simpler like "If you want external tools to detect your
configuration files, they should use the .sshconfig extension".

Let me know what you think about it,

Regards,

-- 
Alexis 'Horgix' Chotard
-------------- next part --------------
A non-text attachment was scrubbed...
Name: include-extension.patch
Type: text/x-diff
Size: 743 bytes
Desc: not available
URL:
<http://lists.mindrot.org/pipermail/openssh-unix-dev/attachments/20170207/94855ba2/attachment.bin>

Hello,

2017-02-07 22:55 GMT+01:00 Alexis Horgix Chotard
<alexis.horgix.chotard at gmail.com>:
> I would like to include a SHOULD part to the man section of the
> Include directive in an effort to make those included files
> recognizable.
> I'm sure you'll have a better suggestion for the wording than me;
> however you'll find a patch attached [...]
>
> Let me know what you think about it,
Any opinion on that ? See my precedent email for details.

Regards,

-- 
Alexis 'Horgix' Chotard

On 02/07/2017 10:55 PM, Alexis Horgix Chotard wrote:
> Hello,
>
> I'm really happy that the 7.3 release of OpenSSH introduced the
> Include directive.
>
> However, since there is absolutely no restriction or advice neither on
> the name nor on the location of the included files, it makes it harder
> for external tools to recognize them; I'm mainly thinking about text
> editors that would like to enable syntax coloration for it (
> https://github.com/vim/vim/pull/1452 ).
> Until now it wasn't a problem since the file was either `ssh_config`
> or `~/.ssh/config` in most cases - maybe all ? no idea if this is
> configurable.
>
> I would like to include a SHOULD part to the man section of the
> Include directive in an effort to make those included files
> recognizable.
> I'm sure you'll have a better suggestion for the wording than me;
> however you'll find a patch attached for the sentence
"Configuration
> file(s) referenced by this Include directive should use the .sshconfig
> extension to be detected as such by external tools." but it could also
> be something simpler like "If you want external tools to detect your
> configuration files, they should use the .sshconfig extension".
>
> Let me know what you think about it,
This is very strict condition. For the tools, I would rather have a look 
at the full path (if it is possible), because in most of the cases, the 
files should come under /etc/ssh/ssh_config.d/*

Having this path automatically included by default in shipped 
configuration files from OpenSSH upstream would be nice.

Regards,
-- 
Jakub Jelen
Software Engineer
Security Technologies
Red Hat

Hello,

2017-02-15 9:50 GMT+01:00 Jakub Jelen <jjelen at
redhat.com>:
> This is very strict condition. For the tools, I would rather have a look at
> the full path (if it is possible), because in most of the cases, the files
> should come under /etc/ssh/ssh_config.d/*
Well, if it's not  strict enough it will make it hard to differenciate
different kind of ssh configurations.
And this would only covers configuration in /etc, not the ones in
~/.ssh, so it would be necessary to add ~/.ssh/ssh_config.d/ to the
list.
> Having this path automatically included by default in shipped configuration
> files from OpenSSH upstream would be nice.
That's actually a good idea imho. Does anyone have something for/against
that ?
It would simplify configurations inclusion, and it will set a base
"standard" so ~/.ssh/ssh_config.d would make sense too and could be
indicated in the man page.

I'm willing to write the patch for it if it were to be accepted, and
then submit it, but I'm not sure where I could submit this since there
was so little answer to my current proposal.

Regards,

-- 
Alexis 'Horgix' Chotard