From: Joachim Durchholz <jo@durchholz.org>
To: Git Mailing List <git@vger.kernel.org>
Subject: Re: Detect invalid submodule names from script?
Date: Mon, 17 Jul 2017 20:31:21 +0200 [thread overview]
Message-ID: <3109accd-5e7b-fdab-4d2e-734c42abf939@durchholz.org> (raw)
In-Reply-To: <CAGZ79kYvup5yOqsgbphwvQe-2sKfXO3a8E1S548WLOXRp4SB_g@mail.gmail.com>
Am 17.07.2017 um 19:49 schrieb Stefan Beller:
> On Mon, Jul 17, 2017 at 4:17 AM, Joachim Durchholz <jo@durchholz.org> wrote:
>> Hi all
>>
>> I'm hacking some script that calls into git, and I need to detect whether a
>> repository was configured with a submodule name that will work on "git
>> submodule init" and friends.
>
> There is no such a thing as "git submodule valid-name" unfortunately.
> Looking through "git submodule add", I think it is safe to assume
> that any string valid as a subsection in git-config is a valid submodule name.
That's what I have been thinking myself.
> Our man page says:
>
> Subsection names are case sensitive and can contain any characters
> except newline (doublequote " and backslash can be included by escaping
> them as \" and \\, respectively).
>
> I am not sure about the quality of submodule shell code to handle the quotations
> for double quote and backslash correctly, so I would suggest not using them,
> either.
The quality is pretty dubious for path names (where I have torture tests
in place).
I haven't done these tests for module names yet. I doubt it's going to
look prettier though.
>> I *can* run a git init and see whether it works, but I need to be 100% sure
>> that the error was due to an invalid submodule name and not something else.
>> Bonus points for every version of git for which it works.
>
> I do not think Git offers a universal solution across versions except actually
> running "submodule init" and then making an educated guess if the error
> comes from bad naming or something else.
Yeah, I think that's the way to go - clone into a local temp directory,
set up the submodule to a sane module and subdirectory name, and if that
works, test what happens with the original configuration.
I'd have preferred something less elaborate though.
E.g. SVN has a --xml option that will output everything in XML format.
(Not useful for shell scripting but easy for almost any other scripting
language.)
> This sounds like you're taking user input or otherwise untrustworthy data
> as submodule names?
I'm auto-downloading submodules as configured in 3rd-party repositories.
Which means untrusted data is copied to the user's home directory, so I
definitely need to make sure that nothing nasty can happen.
My current code is a /bin/sh script.
Given the security/reliability/robustness problems I keep encountering,
the temptation to rewrite this in Python has been steadily growing,
though I'm not quite there yet.
Regards,
Jo
prev parent reply other threads:[~2017-07-17 18:31 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-17 11:17 Detect invalid submodule names from script? Joachim Durchholz
2017-07-17 17:49 ` Stefan Beller
2017-07-17 18:31 ` Joachim Durchholz [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3109accd-5e7b-fdab-4d2e-734c42abf939@durchholz.org \
--to=jo@durchholz.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).