git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] notes: Use get_sha1_committish instead of read_ref in init_notes()

From
Mike Hommey <mh@glandium.org>
Date
Jun 17, 2015, 09:40 UTC
Message-ID
<20150617094036.GA536@glandium.org>
In-Reply-To
<xmqq1thb58i8.fsf@gitster.dls.corp.google.com>
On Tue, Jun 16, 2015 at 08:17:03PM -0700, Junio C Hamano wrote:
Show 27 quoted lines
> Mike Hommey <mh@glandium.org> writes:
> 
> > init_notes() is essentially the only point of entry to the notes API.
> > It is an arbitrary restriction that all it allows as input is a strict
> > ref name, when callers may want to give an arbitrary committish.
> 
> While it may be a good idea to allow reading from any note-shaped
> tree-ish, not just what is at the tip of a ref, I suspect that the
> use of read_ref() is not an arbitrary restriction, but is an
> effective way to achieve safety against callers that update notes.
> 
> That is, you can feed refs/notes/commit@{4.days.ago} to the
> machinery and show you notes from 4 days ago, but you cannot update
> that as if it were a ref.
> 
> Hence, if you are loosening the safety at init_notes() site, you
> would at least need to add a similar safety in the write codepath, I
> would think.  
> 
> One thing you would need to be careful about is that you would give
> users a crappy experience, if an operation reads notes, does its own
> thing, and then tries to write updated notes (think: rebase that
> transplants notes from original to rewritten commits), and you fail
> the operation only at the very last phase of updating.  In order to
> prevent that, "in the write codepath" above has to be "reject any
> non-ref note, e.g. --notes=refs/notes/commit@{4.days.ago} upfront,
> if the operation will write updated notes".

Looking around in the code, I'm not sure how to address this. Considering the APIs, it would seem logical to have individual callers care about filtering the refs themselves, on the other hand, there's room for shooting oneself in the foot when adding new code paths needing writes.

I'm tempted to make init_notes itself do the check, based on the value it is given for a "read_only" argument. On the other hand, some commands do their ref resolving themselves already. For example, notes_merge uses read_ref_full and check_refname_format itself (not necessarily in the right order, btw). OTOH, I'm not even sure it ends up using init_notes at all.

Mike
Previous: Junio C HamanoNext: Junio C Hamano
Message 3 of 22 in “notes: Use get_sha1_committish instead of read_ref in init_notes()”
  1. notes: Use get_sha1_committish instead of read_ref in init_notes()Mike Hommey, Jun 17, 2015
  2. Junio C HamanoJun 17, 2015
  3. Mike HommeyJun 17, 2015
  4. Junio C HamanoJun 17, 2015
  5. Johan HerlandJun 17, 2015
  6. notes: Allow committish expressions as notes refMike Hommey, Jul 8, 2015
  7. notes: Allow committish expressions as notes refMike Hommey, Jul 9, 2015
  8. Johan HerlandJul 10, 2015
  9. notes: Allow treeish expressions as notes refMike Hommey, Jul 10, 2015
  10. Johan HerlandJul 10, 2015
  11. Mike HommeyJul 10, 2015
  12. notes: Allow treeish expressions as notes refMike Hommey, Jul 10, 2015
  13. Junio C HamanoJul 13, 2015
  14. Mike HommeyJul 13, 2015
  15. Junio C HamanoJul 13, 2015
  16. Mike HommeyOct 8, 2015
  17. notes: allow treeish expressions as notes refMike Hommey, Oct 8, 2015
  18. Junio C HamanoOct 8, 2015
  19. Junio C HamanoJul 13, 2015
  20. Jeff KingJun 17, 2015
  21. Mike HommeyJun 17, 2015
  22. Jeff KingJun 17, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.