Google Git
Sign in
chromium / external / gitster / git-htmldocs / 2ef0ba3d29e4b0c3a24887c2cf8d02ee62c852d1 / . / technical / api-credentials.html
blob: 37cbe7bed082f20606785b5a7d7401b1b052547a [file] [log] [blame]
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]7<title>credentials API</title>
8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
37
38em {
39 font-style: italic;
40 color: navy;
41}
42
43strong {
44 font-weight: bold;
45 color: #083194;
46}
47
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
55h1, h2, h3 {
56 border-bottom: 2px solid silver;
57}
58h2 {
59 padding-top: 0.5em;
60}
61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]70
71div.sectionbody {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]102 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]103 font-weight: bold;
104 font-size: 1.1em;
105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
133 margin-top: 1.0em;
134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
149 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]180 padding: 0.5em;
181}
182
183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]189}
190
191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
193 text-align: right;
194}
195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
205div.verseblock + div.attribution {
206 text-align: left;
207}
208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
219 border-left: 3px solid #dddddd;
220}
221
222div.exampleblock > div.content {
223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
225}
226
227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]229a.image:visited { color: white; }
230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
238 font-style: normal;
239 color: navy;
240}
241dd > *:first-child {
242 margin-top: 0.1em;
243}
244
245ul, ol {
246 list-style-position: outside;
247}
248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
252 list-style-type: lower-alpha;
253}
254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
270
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]271tfoot {
272 font-weight: bold;
273}
274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]277
278div.hdlist {
279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
282div.hdlist tr {
283 padding-bottom: 15px;
284}
285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
289 vertical-align: top;
290 font-style: normal;
291 padding-right: 0.8em;
292 color: navy;
293}
294td.hdlist2 {
295 vertical-align: top;
296}
297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
305
306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]340}
341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]351 color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]374
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]427}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]432 font-weight: bold;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]449}
450
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]480}
481
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]501 text-align: right;
502}
503
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]506}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]512}
513
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
526body.manpage h2 {
527 border-style: none;
528}
529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]531}
532
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]533@media print {
534 body.manpage div#toc { display: none; }
535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]538</style>
539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]731/*]]>*/
732</script>
733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="article">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]735<div id="header">
736<h1>credentials API</h1>
737</div>
738<div id="content">
739<div id="preamble">
740<div class="sectionbody">
741<div class="paragraph"><p>The credentials API provides an abstracted way of gathering username and
742password credentials from the user (even though credentials in the wider
743world can take many forms, in this document the word "credential" always
744refers to a username and password pair).</p></div>
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]745<div class="paragraph"><p>This document describes two interfaces: the C API that the credential
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]746subsystem provides to the rest of Git, and the protocol that Git uses to
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]747communicate with system-specific "credential helpers". If you are
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]748writing Git code that wants to look up or prompt for credentials, see
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]749the section "C API" below. If you want to write your own helper, see
750the section on "Credential Helpers" below.</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]751</div>
752</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]753<div class="sect1">
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]754<h2 id="_typical_setup">Typical setup</h2>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]755<div class="sectionbody">
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]756<div class="listingblock">
757<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]758<pre><code>+-----------------------+
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]759| Git code (C) |--- to server requiring ---&gt;
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]760| | authentication
761|.......................|
762| C credential API |--- prompt ---&gt; User
763+-----------------------+
764 ^ |
765 | pipe |
766 | v
767+-----------------------+
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]768| Git credential helper |
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]769+-----------------------+</code></pre>
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]770</div></div>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]771<div class="paragraph"><p>The Git code (typically a remote-helper) will call the C API to obtain
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]772credential data like a login/password pair (credential_fill). The
773API will itself call a remote helper (e.g. "git credential-cache" or
774"git credential-store") that may retrieve credential data from a
775store. If the credential helper cannot find the information, the C API
776will prompt the user. Then, the caller of the API takes care of
777contacting the server, and does the actual authentication.</p></div>
778</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]779</div>
780<div class="sect1">
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]781<h2 id="_c_api">C API</h2>
782<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]783<div class="paragraph"><p>The credential C API is meant to be called by Git code which needs to
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]784acquire or store a credential. It is centered around an object
785representing a single credential and provides three basic operations:
786fill (acquire credentials by calling helpers and/or prompting the user),
787approve (mark a credential as successfully used so that it can be stored
788for later use), and reject (mark a credential as unsuccessful so that it
789can be erased from any persistent storage).</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]790<div class="sect2">
791<h3 id="_data_structures">Data Structures</h3>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]792<div class="dlist"><dl>
793<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]794<code>struct credential</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]795</dt>
796<dd>
797<p>
798 This struct represents a single username/password combination
799 along with any associated context. All string fields should be
800 heap-allocated (or NULL if they are not known or not applicable).
801 The meaning of the individual context fields is the same as
802 their counterparts in the helper protocol; see the section below
803 for a description of each field.
804</p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]805<div class="paragraph"><p>The <code>helpers</code> member of the struct is a <code>string_list</code> of helpers. Each
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]806string specifies an external helper which will be run, in order, to
807either acquire or store credentials. See the section on credential
Junio C Hamano9f9ed8b2012-06-13 07:21:43[diff] [blame]808helpers below. This list is filled-in by the API functions
809according to the corresponding configuration variables before
810consulting helpers, so there usually is no need for a caller to
811modify the helpers field at all.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]812<div class="paragraph"><p>This struct should always be initialized with <code>CREDENTIAL_INIT</code> or
813<code>credential_init</code>.</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]814</dd>
815</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]816</div>
817<div class="sect2">
818<h3 id="_functions">Functions</h3>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]819<div class="dlist"><dl>
820<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]821<code>credential_init</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]822</dt>
823<dd>
824<p>
825 Initialize a credential structure, setting all fields to empty.
826</p>
827</dd>
828<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]829<code>credential_clear</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]830</dt>
831<dd>
832<p>
833 Free any resources associated with the credential structure,
834 returning it to a pristine initialized state.
835</p>
836</dd>
837<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]838<code>credential_fill</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]839</dt>
840<dd>
841<p>
842 Instruct the credential subsystem to fill the username and
843 password fields of the passed credential struct by first
844 consulting helpers, then asking the user. After this function
845 returns, the username and password fields of the credential are
846 guaranteed to be non-NULL. If an error occurs, the function will
847 die().
848</p>
849</dd>
850<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]851<code>credential_reject</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]852</dt>
853<dd>
854<p>
855 Inform the credential subsystem that the provided credentials
856 have been rejected. This will cause the credential subsystem to
857 notify any helpers of the rejection (which allows them, for
858 example, to purge the invalid credentials from storage). It
859 will also free() the username and password fields of the
860 credential and set them to NULL (readying the credential for
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]861 another call to <code>credential_fill</code>). Any errors from helpers are
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]862 ignored.
863</p>
864</dd>
865<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]866<code>credential_approve</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]867</dt>
868<dd>
869<p>
870 Inform the credential subsystem that the provided credentials
871 were successfully used for authentication. This will cause the
872 credential subsystem to notify any helpers of the approval, so
873 that they may store the result to be used again. Any errors
874 from helpers are ignored.
875</p>
876</dd>
877<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]878<code>credential_from_url</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]879</dt>
880<dd>
881<p>
882 Parse a URL into broken-down credential fields.
883</p>
884</dd>
885</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]886</div>
887<div class="sect2">
888<h3 id="_example">Example</h3>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]889<div class="paragraph"><p>The example below shows how the functions of the credential API could be
890used to login to a fictitious "foo" service on a remote host:</p></div>
891<div class="listingblock">
892<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]893<pre><code>int foo_login(struct foo_connection *f)
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]894{
895 int status;
896 /*
897 * Create a credential with some context; we don't yet know the
898 * username or password.
899 */
900
901 struct credential c = CREDENTIAL_INIT;
902 c.protocol = xstrdup("foo");
903 c.host = xstrdup(f-&gt;hostname);
904
905 /*
906 * Fill in the username and password fields by contacting
907 * helpers and/or asking the user. The function will die if it
908 * fails.
909 */
910 credential_fill(&amp;c);
911
912 /*
913 * Otherwise, we have a username and password. Try to use it.
914 */
915 status = send_foo_login(f, c.username, c.password);
916 switch (status) {
917 case FOO_OK:
918 /* It worked. Store the credential for later use. */
919 credential_accept(&amp;c);
920 break;
921 case FOO_BAD_LOGIN:
922 /* Erase the credential from storage so we don't try it
923 * again. */
924 credential_reject(&amp;c);
925 break;
926 default:
927 /*
Junio C Hamanoa080bc32013-04-12 21:33:01[diff] [blame]928 * Some other error occurred. We don't know if the
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]929 * credential is good or bad, so report nothing to the
930 * credential subsystem.
931 */
932 }
933
934 /* Free any associated resources. */
935 credential_clear(&amp;c);
936
937 return status;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]938}</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]939</div></div>
940</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]941</div>
942</div>
943<div class="sect1">
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]944<h2 id="_credential_helpers">Credential Helpers</h2>
945<div class="sectionbody">
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]946<div class="paragraph"><p>Credential helpers are programs executed by Git to fetch or save
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]947credentials from and to long-term storage (where "long-term" is simply
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]948longer than a single Git process; e.g., credentials may be stored
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]949in-memory for a few minutes, or indefinitely on disk).</p></div>
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]950<div class="paragraph"><p>Each helper is specified by a single string in the configuration
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]951variable <code>credential.helper</code> (and others, see <a href="../git-config.html">git-config(1)</a>).
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]952The string is transformed by Git into a command to be executed using
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]953these rules:</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]954<div class="olist arabic"><ol class="arabic">
955<li>
956<p>
957If the helper string begins with "!", it is considered a shell
958 snippet, and everything after the "!" becomes the command.
959</p>
960</li>
961<li>
962<p>
963Otherwise, if the helper string begins with an absolute path, the
964 verbatim helper string becomes the command.
965</p>
966</li>
967<li>
968<p>
969Otherwise, the string "git credential-" is prepended to the helper
970 string, and the result becomes the command.
971</p>
972</li>
973</ol></div>
974<div class="paragraph"><p>The resulting command then has an "operation" argument appended to it
975(see below for details), and the result is executed by the shell.</p></div>
976<div class="paragraph"><p>Here are some example specifications:</p></div>
977<div class="listingblock">
978<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]979<pre><code># run "git credential-foo"
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]980foo
981
982# same as above, but pass an argument to the helper
983foo --bar=baz
984
985# the arguments are parsed by the shell, so use shell
986# quoting if necessary
987foo --bar="whitespace arg"
988
989# you can also use an absolute path, which will not use the git wrapper
990/path/to/my/helper --with-arguments
991
992# or you can specify your own shell snippet
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]993!f() { echo "password=`cat $HOME/.secret`"; }; f</code></pre>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]994</div></div>
995<div class="paragraph"><p>Generally speaking, rule (3) above is the simplest for users to specify.
996Authors of credential helpers should make an effort to assist their
997users by naming their program "git-credential-$NAME", and putting it in
998the $PATH or $GIT_EXEC_PATH during installation, which will allow a user
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]999to enable it with <code>git config credential.helper $NAME</code>.</p></div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1000<div class="paragraph"><p>When a helper is executed, it will have one "operation" argument
1001appended to its command line, which is one of:</p></div>
1002<div class="dlist"><dl>
1003<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1004<code>get</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1005</dt>
1006<dd>
1007<p>
1008 Return a matching credential, if any exists.
1009</p>
1010</dd>
1011<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1012<code>store</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1013</dt>
1014<dd>
1015<p>
1016 Store the credential, if applicable to the helper.
1017</p>
1018</dd>
1019<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1020<code>erase</code>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1021</dt>
1022<dd>
1023<p>
1024 Remove a matching credential, if any, from the helper&#8217;s storage.
1025</p>
1026</dd>
1027</dl></div>
1028<div class="paragraph"><p>The details of the credential will be provided on the helper&#8217;s stdin
Junio C Hamano8edb4c72012-07-09 20:33:55[diff] [blame]1029stream. The exact format is the same as the input/output format of the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1030<code>git credential</code> plumbing command (see the section <code>INPUT/OUTPUT
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]1031FORMAT</code> in <a href="../git-credential.html">git-credential(1)</a> for a detailed specification).</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1032<div class="paragraph"><p>For a <code>get</code> operation, the helper should produce a list of attributes
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1033on stdout in the same format. A helper is free to produce a subset, or
1034even no values at all if it has nothing useful to provide. Any provided
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]1035attributes will overwrite those already known about by Git. If a helper
1036outputs a <code>quit</code> attribute with a value of <code>true</code> or <code>1</code>, no further
1037helpers will be consulted, nor will the user be prompted (if no
1038credential has been provided, the operation will then fail).</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1039<div class="paragraph"><p>For a <code>store</code> or <code>erase</code> operation, the helper&#8217;s output is ignored.
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1040If it fails to perform the requested operation, it may complain to
1041stderr to inform the user. If it does not support the requested
1042operation (e.g., a read-only store), it should silently ignore the
1043request.</p></div>
1044<div class="paragraph"><p>If a helper receives any other operation, it should silently ignore the
1045request. This leaves room for future operations to be added (older
1046helpers will just ignore the new requests).</p></div>
1047</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1048</div>
1049<div class="sect1">
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]1050<h2 id="_see_also">See also</h2>
1051<div class="sectionbody">
Junio C Hamano719b8a32012-06-08 18:40:53[diff] [blame]1052<div class="paragraph"><p><a href="../gitcredentials.html">gitcredentials(7)</a></p></div>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]1053<div class="paragraph"><p><a href="../git-config.html">git-config(1)</a> (See configuration variables <code>credential.*</code>)</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1054</div>
Junio C Hamano022bd342012-06-07 20:15:35[diff] [blame]1055</div>
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1056</div>
1057<div id="footnotes"><hr /></div>
1058<div id="footer">
1059<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame^]1060Last updated
1061 2018-01-26 15:11:04 PST
Junio C Hamano0df92712011-12-21 22:30:44[diff] [blame]1062</div>
1063</div>
1064</body>
1065</html>