mirror/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-09-22 05:31:42 +02:00
Code

read_raw_ref(): improve docstring

Browse Source 
Among other things, document the (important!) requirement that input
refname be checked for safety before calling this function.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
This commit is contained in:
Michael Haggerty 2016-04-24 08:10:30 +02:00
parent 92b380931e
commit bb462b0028
1 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
refs/files-backend.c
View File

@ -1389,33 +1389,40 @@ static int resolve_missing_loose_ref(const char *refname,
} }
/* /*
* Read a raw ref from the filesystem or packed refs file. * Read the specified reference from the filesystem or packed refs
* file, non-recursively. Set type to describe the reference, and:
* *
* If the ref is a sha1, fill in sha1 and return 0. * - If refname is the name of a normal reference, fill in sha1
* (leaving referent unchanged).
* *
* If the ref is symbolic, fill in *referent with the name of the * - If refname is the name of a symbolic reference, write the full
* branch to which it refers (e.g. "refs/heads/master") and return 0. * name of the reference to which it refers (e.g.
* The caller is responsible for validating the referent. Set * "refs/heads/master") to referent and set the REF_ISSYMREF bit in
* REF_ISSYMREF in type. * type (leaving sha1 unchanged). The caller is responsible for
* validating that referent is a valid reference name.
* *
* If the ref doesn't exist, set errno to ENOENT and return -1. * WARNING: refname might be used as part of a filename, so it is
* important from a security standpoint that it be safe in the sense
* of refname_is_safe(). Moreover, for symrefs this function sets
* referent to whatever the repository says, which might not be a
* properly-formatted or even safe reference name. NEITHER INPUT NOR
* OUTPUT REFERENCE NAMES ARE VALIDATED WITHIN THIS FUNCTION.
* *
* If the ref exists but is neither a symbolic ref nor a sha1, it is * Return 0 on success. If the ref doesn't exist, set errno to ENOENT
* broken. Set REF_ISBROKEN in type, set errno to EINVAL, and return * and return -1. If the ref exists but is neither a symbolic ref nor
* -1. * a sha1, it is broken; set REF_ISBROKEN in type, set errno to
* * EINVAL, and return -1. If there is another error reading the ref,
* If there is another error reading the ref, set errno appropriately and * set errno appropriately and return -1.
* return -1.
* *
* Backend-specific flags might be set in type as well, regardless of * Backend-specific flags might be set in type as well, regardless of
* outcome. * outcome.
* *
* sb_path is workspace: the caller should allocate and free it. * It is OK for refname to point into referent. If so:
* *
* It is OK for refname to point into referent. In this case:
* - if the function succeeds with REF_ISSYMREF, referent will be * - if the function succeeds with REF_ISSYMREF, referent will be
* overwritten and the memory pointed to by refname might be changed * overwritten and the memory formerly pointed to by it might be
* or even freed. * changed or even freed.
*
* - in all other cases, referent will be untouched, and therefore * - in all other cases, referent will be untouched, and therefore
* refname will still be valid and unchanged. * refname will still be valid and unchanged.
*/ */