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