Code

Merge branch 'ms/help-unknown'
[git.git] / Documentation / technical / pack-protocol.txt
1 Packfile transfer protocols
2 ===========================
4 Git supports transferring data in packfiles over the ssh://, git:// and
5 file:// transports.  There exist two sets of protocols, one for pushing
6 data from a client to a server and another for fetching data from a
7 server to a client.  All three transports (ssh, git, file) use the same
8 protocol to transfer data.
10 The processes invoked in the canonical Git implementation are 'upload-pack'
11 on the server side and 'fetch-pack' on the client side for fetching data;
12 then 'receive-pack' on the server and 'send-pack' on the client for pushing
13 data.  The protocol functions to have a server tell a client what is
14 currently on the server, then for the two to negotiate the smallest amount
15 of data to send in order to fully update one or the other.
17 Transports
18 ----------
19 There are three transports over which the packfile protocol is
20 initiated.  The Git transport is a simple, unauthenticated server that
21 takes the command (almost always 'upload-pack', though Git
22 servers can be configured to be globally writable, in which 'receive-
23 pack' initiation is also allowed) with which the client wishes to
24 communicate and executes it and connects it to the requesting
25 process.
27 In the SSH transport, the client just runs the 'upload-pack'
28 or 'receive-pack' process on the server over the SSH protocol and then
29 communicates with that invoked process over the SSH connection.
31 The file:// transport runs the 'upload-pack' or 'receive-pack'
32 process locally and communicates with it over a pipe.
34 Git Transport
35 -------------
37 The Git transport starts off by sending the command and repository
38 on the wire using the pkt-line format, followed by a NUL byte and a
39 hostname parameter, terminated by a NUL byte.
41    0032git-upload-pack /project.git\0host=myserver.com\0
43 --
44    git-proto-request = request-command SP pathname NUL [ host-parameter NUL ]
45    request-command   = "git-upload-pack" / "git-receive-pack" /
46                        "git-upload-archive"   ; case sensitive
47    pathname          = *( %x01-ff ) ; exclude NUL
48    host-parameter    = "host=" hostname [ ":" port ]
49 --
51 Only host-parameter is allowed in the git-proto-request. Clients
52 MUST NOT attempt to send additional parameters. It is used for the
53 git-daemon name based virtual hosting.  See --interpolated-path
54 option to git daemon, with the %H/%CH format characters.
56 Basically what the Git client is doing to connect to an 'upload-pack'
57 process on the server side over the Git protocol is this:
59    $ echo -e -n \
60      "0039git-upload-pack /schacon/gitbook.git\0host=example.com\0" |
61      nc -v example.com 9418
64 SSH Transport
65 -------------
67 Initiating the upload-pack or receive-pack processes over SSH is
68 executing the binary on the server via SSH remote execution.
69 It is basically equivalent to running this:
71    $ ssh git.example.com "git-upload-pack '/project.git'"
73 For a server to support Git pushing and pulling for a given user over
74 SSH, that user needs to be able to execute one or both of those
75 commands via the SSH shell that they are provided on login.  On some
76 systems, that shell access is limited to only being able to run those
77 two commands, or even just one of them.
79 In an ssh:// format URI, it's absolute in the URI, so the '/' after
80 the host name (or port number) is sent as an argument, which is then
81 read by the remote git-upload-pack exactly as is, so it's effectively
82 an absolute path in the remote filesystem.
84        git clone ssh://user@example.com/project.git
85                     |
86                     v
87     ssh user@example.com "git-upload-pack '/project.git'"
89 In a "user@host:path" format URI, its relative to the user's home
90 directory, because the Git client will run:
92      git clone user@example.com:project.git
93                     |
94                     v
95   ssh user@example.com "git-upload-pack 'project.git'"
97 The exception is if a '~' is used, in which case
98 we execute it without the leading '/'.
100       ssh://user@example.com/~alice/project.git,
101                      |
102                      v
103    ssh user@example.com "git-upload-pack '~alice/project.git'"
105 A few things to remember here:
107 - The "command name" is spelled with dash (e.g. git-upload-pack), but
108   this can be overridden by the client;
110 - The repository path is always quoted with single quotes.
112 Fetching Data From a Server
113 ===========================
115 When one Git repository wants to get data that a second repository
116 has, the first can 'fetch' from the second.  This operation determines
117 what data the server has that the client does not then streams that
118 data down to the client in packfile format.
121 Reference Discovery
122 -------------------
124 When the client initially connects the server will immediately respond
125 with a listing of each reference it has (all branches and tags) along
126 with the object name that each reference currently points to.
128    $ echo -e -n "0039git-upload-pack /schacon/gitbook.git\0host=example.com\0" |
129       nc -v example.com 9418
130    00887217a7c7e582c46cec22a130adf4b9d7d950fba0 HEAD\0multi_ack thin-pack side-band side-band-64k ofs-delta shallow no-progress include-tag
131    00441d3fcd5ced445d1abc402225c0b8a1299641f497 refs/heads/integration
132    003f7217a7c7e582c46cec22a130adf4b9d7d950fba0 refs/heads/master
133    003cb88d2441cac0977faf98efc80305012112238d9d refs/tags/v0.9
134    003c525128480b96c89e6418b1e40909bf6c5b2d580f refs/tags/v1.0
135    003fe92df48743b7bc7d26bcaabfddde0a1e20cae47c refs/tags/v1.0^{}
136    0000
138 Server SHOULD terminate each non-flush line using LF ("\n") terminator;
139 client MUST NOT complain if there is no terminator.
141 The returned response is a pkt-line stream describing each ref and
142 its current value.  The stream MUST be sorted by name according to
143 the C locale ordering.
145 If HEAD is a valid ref, HEAD MUST appear as the first advertised
146 ref.  If HEAD is not a valid ref, HEAD MUST NOT appear in the
147 advertisement list at all, but other refs may still appear.
149 The stream MUST include capability declarations behind a NUL on the
150 first ref. The peeled value of a ref (that is "ref^{}") MUST be
151 immediately after the ref itself, if presented. A conforming server
152 MUST peel the ref if it's an annotated tag.
154 ----
155   advertised-refs  =  (no-refs / list-of-refs)
156                       flush-pkt
158   no-refs          =  PKT-LINE(zero-id SP "capabilities^{}"
159                       NUL capability-list LF)
161   list-of-refs     =  first-ref *other-ref
162   first-ref        =  PKT-LINE(obj-id SP refname
163                       NUL capability-list LF)
165   other-ref        =  PKT-LINE(other-tip / other-peeled)
166   other-tip        =  obj-id SP refname LF
167   other-peeled     =  obj-id SP refname "^{}" LF
169   capability-list  =  capability *(SP capability)
170   capability       =  1*(LC_ALPHA / DIGIT / "-" / "_")
171   LC_ALPHA         =  %x61-7A
172 ----
174 Server and client MUST use lowercase for obj-id, both MUST treat obj-id
175 as case-insensitive.
177 See protocol-capabilities.txt for a list of allowed server capabilities
178 and descriptions.
180 Packfile Negotiation
181 --------------------
182 After reference and capabilities discovery, the client can decide to
183 terminate the connection by sending a flush-pkt, telling the server it can
184 now gracefully terminate, and disconnect, when it does not need any pack
185 data. This can happen with the ls-remote command, and also can happen when
186 the client already is up-to-date.
188 Otherwise, it enters the negotiation phase, where the client and
189 server determine what the minimal packfile necessary for transport is,
190 by telling the server what objects it wants, its shallow objects
191 (if any), and the maximum commit depth it wants (if any).  The client
192 will also send a list of the capabilities it wants to be in effect,
193 out of what the server said it could do with the first 'want' line.
195 ----
196   upload-request    =  want-list
197                        *shallow-line
198                        *1depth-request
199                        flush-pkt
201   want-list         =  first-want
202                        *additional-want
204   shallow-line      =  PKT_LINE("shallow" SP obj-id)
206   depth-request     =  PKT_LINE("deepen" SP depth)
208   first-want        =  PKT-LINE("want" SP obj-id SP capability-list LF)
209   additional-want   =  PKT-LINE("want" SP obj-id LF)
211   depth             =  1*DIGIT
212 ----
214 Clients MUST send all the obj-ids it wants from the reference
215 discovery phase as 'want' lines. Clients MUST send at least one
216 'want' command in the request body. Clients MUST NOT mention an
217 obj-id in a 'want' command which did not appear in the response
218 obtained through ref discovery.
220 The client MUST write all obj-ids which it only has shallow copies
221 of (meaning that it does not have the parents of a commit) as
222 'shallow' lines so that the server is aware of the limitations of
223 the client's history. Clients MUST NOT mention an obj-id which
224 it does not know exists on the server.
226 The client now sends the maximum commit history depth it wants for
227 this transaction, which is the number of commits it wants from the
228 tip of the history, if any, as a 'deepen' line.  A depth of 0 is the
229 same as not making a depth request. The client does not want to receive
230 any commits beyond this depth, nor objects needed only to complete
231 those commits. Commits whose parents are not received as a result are
232 defined as shallow and marked as such in the server. This information
233 is sent back to the client in the next step.
235 Once all the 'want's and 'shallow's (and optional 'deepen') are
236 transferred, clients MUST send a flush-pkt, to tell the server side
237 that it is done sending the list.
239 Otherwise, if the client sent a positive depth request, the server
240 will determine which commits will and will not be shallow and
241 send this information to the client. If the client did not request
242 a positive depth, this step is skipped.
244 ----
245   shallow-update   =  *shallow-line
246                       *unshallow-line
247                       flush-pkt
249   shallow-line     =  PKT-LINE("shallow" SP obj-id)
251   unshallow-line   =  PKT-LINE("unshallow" SP obj-id)
252 ----
254 If the client has requested a positive depth, the server will compute
255 the set of commits which are no deeper than the desired depth, starting
256 at the client's wants. The server writes 'shallow' lines for each
257 commit whose parents will not be sent as a result. The server writes
258 an 'unshallow' line for each commit which the client has indicated is
259 shallow, but is no longer shallow at the currently requested depth
260 (that is, its parents will now be sent). The server MUST NOT mark
261 as unshallow anything which the client has not indicated was shallow.
263 Now the client will send a list of the obj-ids it has using 'have'
264 lines, so the server can make a packfile that only contains the objects
265 that the client needs. In multi_ack mode, the canonical implementation
266 will send up to 32 of these at a time, then will send a flush-pkt. The
267 canonical implementation will skip ahead and send the next 32 immediately,
268 so that there is always a block of 32 "in-flight on the wire" at a time.
270 ----
271   upload-haves      =  have-list
272                        compute-end
274   have-list         =  *have-line
275   have-line         =  PKT-LINE("have" SP obj-id LF)
276   compute-end       =  flush-pkt / PKT-LINE("done")
277 ----
279 If the server reads 'have' lines, it then will respond by ACKing any
280 of the obj-ids the client said it had that the server also has. The
281 server will ACK obj-ids differently depending on which ack mode is
282 chosen by the client.
284 In multi_ack mode:
286   * the server will respond with 'ACK obj-id continue' for any common
287     commits.
289   * once the server has found an acceptable common base commit and is
290     ready to make a packfile, it will blindly ACK all 'have' obj-ids
291     back to the client.
293   * the server will then send a 'NACK' and then wait for another response
294     from the client - either a 'done' or another list of 'have' lines.
296 In multi_ack_detailed mode:
298   * the server will differentiate the ACKs where it is signaling
299     that it is ready to send data with 'ACK obj-id ready' lines, and
300     signals the identified common commits with 'ACK obj-id common' lines.
302 Without either multi_ack or multi_ack_detailed:
304  * upload-pack sends "ACK obj-id" on the first common object it finds.
305    After that it says nothing until the client gives it a "done".
307  * upload-pack sends "NAK" on a flush-pkt if no common object
308    has been found yet.  If one has been found, and thus an ACK
309    was already sent, it's silent on the flush-pkt.
311 After the client has gotten enough ACK responses that it can determine
312 that the server has enough information to send an efficient packfile
313 (in the canonical implementation, this is determined when it has received
314 enough ACKs that it can color everything left in the --date-order queue
315 as common with the server, or the --date-order queue is empty), or the
316 client determines that it wants to give up (in the canonical implementation,
317 this is determined when the client sends 256 'have' lines without getting
318 any of them ACKed by the server - meaning there is nothing in common and
319 the server should just send all of its objects), then the client will send
320 a 'done' command.  The 'done' command signals to the server that the client
321 is ready to receive its packfile data.
323 However, the 256 limit *only* turns on in the canonical client
324 implementation if we have received at least one "ACK %s continue"
325 during a prior round.  This helps to ensure that at least one common
326 ancestor is found before we give up entirely.
328 Once the 'done' line is read from the client, the server will either
329 send a final 'ACK obj-id' or it will send a 'NAK'. The server only sends
330 ACK after 'done' if there is at least one common base and multi_ack or
331 multi_ack_detailed is enabled. The server always sends NAK after 'done'
332 if there is no common base found.
334 Then the server will start sending its packfile data.
336 ----
337   server-response = *ack_multi ack / nak
338   ack_multi       = PKT-LINE("ACK" SP obj-id ack_status LF)
339   ack_status      = "continue" / "common" / "ready"
340   ack             = PKT-LINE("ACK SP obj-id LF)
341   nak             = PKT-LINE("NAK" LF)
342 ----
344 A simple clone may look like this (with no 'have' lines):
346 ----
347    C: 0054want 74730d410fcb6603ace96f1dc55ea6196122532d\0multi_ack \
348      side-band-64k ofs-delta\n
349    C: 0032want 7d1665144a3a975c05f1f43902ddaf084e784dbe\n
350    C: 0032want 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a\n
351    C: 0032want 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01\n
352    C: 0032want 74730d410fcb6603ace96f1dc55ea6196122532d\n
353    C: 0000
354    C: 0009done\n
356    S: 0008NAK\n
357    S: [PACKFILE]
358 ----
360 An incremental update (fetch) response might look like this:
362 ----
363    C: 0054want 74730d410fcb6603ace96f1dc55ea6196122532d\0multi_ack \
364      side-band-64k ofs-delta\n
365    C: 0032want 7d1665144a3a975c05f1f43902ddaf084e784dbe\n
366    C: 0032want 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a\n
367    C: 0000
368    C: 0032have 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01\n
369    C: [30 more have lines]
370    C: 0032have 74730d410fcb6603ace96f1dc55ea6196122532d\n
371    C: 0000
373    S: 003aACK 7e47fe2bd8d01d481f44d7af0531bd93d3b21c01 continue\n
374    S: 003aACK 74730d410fcb6603ace96f1dc55ea6196122532d continue\n
375    S: 0008NAK\n
377    C: 0009done\n
379    S: 0031ACK 74730d410fcb6603ace96f1dc55ea6196122532d\n
380    S: [PACKFILE]
381 ----
384 Packfile Data
385 -------------
387 Now that the client and server have finished negotiation about what
388 the minimal amount of data that needs to be sent to the client is, the server
389 will construct and send the required data in packfile format.
391 See pack-format.txt for what the packfile itself actually looks like.
393 If 'side-band' or 'side-band-64k' capabilities have been specified by
394 the client, the server will send the packfile data multiplexed.
396 Each packet starting with the packet-line length of the amount of data
397 that follows, followed by a single byte specifying the sideband the
398 following data is coming in on.
400 In 'side-band' mode, it will send up to 999 data bytes plus 1 control
401 code, for a total of up to 1000 bytes in a pkt-line.  In 'side-band-64k'
402 mode it will send up to 65519 data bytes plus 1 control code, for a
403 total of up to 65520 bytes in a pkt-line.
405 The sideband byte will be a '1', '2' or a '3'. Sideband '1' will contain
406 packfile data, sideband '2' will be used for progress information that the
407 client will generally print to stderr and sideband '3' is used for error
408 information.
410 If no 'side-band' capability was specified, the server will stream the
411 entire packfile without multiplexing.
414 Pushing Data To a Server
415 ========================
417 Pushing data to a server will invoke the 'receive-pack' process on the
418 server, which will allow the client to tell it which references it should
419 update and then send all the data the server will need for those new
420 references to be complete.  Once all the data is received and validated,
421 the server will then update its references to what the client specified.
423 Authentication
424 --------------
426 The protocol itself contains no authentication mechanisms.  That is to be
427 handled by the transport, such as SSH, before the 'receive-pack' process is
428 invoked.  If 'receive-pack' is configured over the Git transport, those
429 repositories will be writable by anyone who can access that port (9418) as
430 that transport is unauthenticated.
432 Reference Discovery
433 -------------------
435 The reference discovery phase is done nearly the same way as it is in the
436 fetching protocol. Each reference obj-id and name on the server is sent
437 in packet-line format to the client, followed by a flush-pkt.  The only
438 real difference is that the capability listing is different - the only
439 possible values are 'report-status', 'delete-refs' and 'ofs-delta'.
441 Reference Update Request and Packfile Transfer
442 ----------------------------------------------
444 Once the client knows what references the server is at, it can send a
445 list of reference update requests.  For each reference on the server
446 that it wants to update, it sends a line listing the obj-id currently on
447 the server, the obj-id the client would like to update it to and the name
448 of the reference.
450 This list is followed by a flush-pkt and then the packfile that should
451 contain all the objects that the server will need to complete the new
452 references.
454 ----
455   update-request    =  command-list [pack-file]
457   command-list      =  PKT-LINE(command NUL capability-list LF)
458                        *PKT-LINE(command LF)
459                        flush-pkt
461   command           =  create / delete / update
462   create            =  zero-id SP new-id  SP name
463   delete            =  old-id  SP zero-id SP name
464   update            =  old-id  SP new-id  SP name
466   old-id            =  obj-id
467   new-id            =  obj-id
469   pack-file         = "PACK" 28*(OCTET)
470 ----
472 If the receiving end does not support delete-refs, the sending end MUST
473 NOT ask for delete command.
475 The pack-file MUST NOT be sent if the only command used is 'delete'.
477 A pack-file MUST be sent if either create or update command is used,
478 even if the server already has all the necessary objects.  In this
479 case the client MUST send an empty pack-file.   The only time this
480 is likely to happen is if the client is creating
481 a new branch or a tag that points to an existing obj-id.
483 The server will receive the packfile, unpack it, then validate each
484 reference that is being updated that it hasn't changed while the request
485 was being processed (the obj-id is still the same as the old-id), and
486 it will run any update hooks to make sure that the update is acceptable.
487 If all of that is fine, the server will then update the references.
489 Report Status
490 -------------
492 After receiving the pack data from the sender, the receiver sends a
493 report if 'report-status' capability is in effect.
494 It is a short listing of what happened in that update.  It will first
495 list the status of the packfile unpacking as either 'unpack ok' or
496 'unpack [error]'.  Then it will list the status for each of the references
497 that it tried to update.  Each line is either 'ok [refname]' if the
498 update was successful, or 'ng [refname] [error]' if the update was not.
500 ----
501   report-status     = unpack-status
502                       1*(command-status)
503                       flush-pkt
505   unpack-status     = PKT-LINE("unpack" SP unpack-result LF)
506   unpack-result     = "ok" / error-msg
508   command-status    = command-ok / command-fail
509   command-ok        = PKT-LINE("ok" SP refname LF)
510   command-fail      = PKT-LINE("ng" SP refname SP error-msg LF)
512   error-msg         = 1*(OCTECT) ; where not "ok"
513 ----
515 Updates can be unsuccessful for a number of reasons.  The reference can have
516 changed since the reference discovery phase was originally sent, meaning
517 someone pushed in the meantime.  The reference being pushed could be a
518 non-fast-forward reference and the update hooks or configuration could be
519 set to not allow that, etc.  Also, some references can be updated while others
520 can be rejected.
522 An example client/server communication might look like this:
524 ----
525    S: 007c74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/local\0report-status delete-refs ofs-delta\n
526    S: 003e7d1665144a3a975c05f1f43902ddaf084e784dbe refs/heads/debug\n
527    S: 003f74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/master\n
528    S: 003f74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/team\n
529    S: 0000
531    C: 003e7d1665144a3a975c05f1f43902ddaf084e784dbe 74730d410fcb6603ace96f1dc55ea6196122532d refs/heads/debug\n
532    C: 003e74730d410fcb6603ace96f1dc55ea6196122532d 5a3f6be755bbb7deae50065988cbfa1ffa9ab68a refs/heads/master\n
533    C: 0000
534    C: [PACKDATA]
536    S: 000eunpack ok\n
537    S: 0018ok refs/heads/debug\n
538    S: 002ang refs/heads/master non-fast-forward\n
539 ----