git-credential.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   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>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-credential(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.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 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.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
 311 span.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
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.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 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var 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.
 562 toc: 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;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 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");
 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];
 612     if (entry.nodeName.toLowerCase() == 'div'
 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.
 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
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 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");
 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++;
 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       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 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   }
 706 },
 707
 708 install: 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;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-credential(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-credential -
 743    Retrieve and store user credentials
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="listingblock">
 752 <div class="content">
 753 <pre><code>'git credential' (fill|approve|reject|capability)</code></pre>
 754 </div></div>
 755 </div>
 756 </div>
 757 <div class="sect1">
 758 <h2 id="_description">DESCRIPTION</h2>
 759 <div class="sectionbody">
 760 <div class="paragraph"><p>Git has an internal interface for storing and retrieving credentials
 761 from system-specific helpers, as well as prompting the user for
 762 usernames and passwords. The git-credential command exposes this
 763 interface to scripts which may want to retrieve, store, or prompt for
 764 credentials in the same manner as Git. The design of this scriptable
 765 interface models the internal C API; see credential.h for more
 766 background on the concepts.</p></div>
 767 <div class="paragraph"><p>git-credential takes an "action" option on the command-line (one of
 768 <code>fill</code>, <code>approve</code>, or <code>reject</code>) and reads a credential description
 769 on stdin (see <a href="#IOFMT">INPUT/OUTPUT FORMAT</a>).</p></div>
 770 <div class="paragraph"><p>If the action is <code>fill</code>, git-credential will attempt to add "username"
 771 and "password" attributes to the description by reading config files,
 772 by contacting any configured credential helpers, or by prompting the
 773 user. The username and password attributes of the credential
 774 description are then printed to stdout together with the attributes
 775 already provided.</p></div>
 776 <div class="paragraph"><p>If the action is <code>approve</code>, git-credential will send the description
 777 to any configured credential helpers, which may store the credential
 778 for later use.</p></div>
 779 <div class="paragraph"><p>If the action is <code>reject</code>, git-credential will send the description to
 780 any configured credential helpers, which may erase any stored
 781 credentials matching the description.</p></div>
 782 <div class="paragraph"><p>If the action is <code>capability</code>, git-credential will announce any capabilities
 783 it supports to standard output.</p></div>
 784 <div class="paragraph"><p>If the action is <code>approve</code> or <code>reject</code>, no output should be emitted.</p></div>
 785 </div>
 786 </div>
 787 <div class="sect1">
 788 <h2 id="_typical_use_of_git_credential">TYPICAL USE OF GIT CREDENTIAL</h2>
 789 <div class="sectionbody">
 790 <div class="paragraph"><p>An application using git-credential will typically use <code>git
 791 credential</code> following these steps:</p></div>
 792 <div class="olist arabic"><ol class="arabic">
 793 <li>
 794 <p>
 795 Generate a credential description based on the context.
 796 </p>
 797 <div class="paragraph"><p>For example, if we want a password for
 798 <code>https://example.com/foo.git</code>, we might generate the following
 799 credential description (don&#8217;t forget the blank line at the end; it
 800 tells <code>git credential</code> that the application finished feeding all the
 801 information it has):</p></div>
 802 <div class="literalblock">
 803 <div class="content">
 804 <pre><code>protocol=https
 805 host=example.com
 806 path=foo.git</code></pre>
 807 </div></div>
 808 </li>
 809 <li>
 810 <p>
 811 Ask git-credential to give us a username and password for this
 812      description. This is done by running <code>git credential fill</code>,
 813      feeding the description from step (1) to its standard input. The complete
 814      credential description (including the credential per se, i.e. the
 815      login and password) will be produced on standard output, like:
 816 </p>
 817 <div class="literalblock">
 818 <div class="content">
 819 <pre><code>protocol=https
 820 host=example.com
 821 username=bob
 822 password=secr3t</code></pre>
 823 </div></div>
 824 <div class="paragraph"><p>In most cases, this means the attributes given in the input will be
 825 repeated in the output, but Git may also modify the credential
 826 description, for example by removing the <code>path</code> attribute when the
 827 protocol is HTTP(s) and <code>credential.useHttpPath</code> is false.</p></div>
 828 <div class="paragraph"><p>If the <code>git credential</code> knew about the password, this step may
 829 not have involved the user actually typing this password (the
 830 user may have typed a password to unlock the keychain instead,
 831 or no user interaction was done if the keychain was already
 832 unlocked) before it returned <code>password=secr3t</code>.</p></div>
 833 </li>
 834 <li>
 835 <p>
 836 Use the credential (e.g., access the URL with the username and
 837      password from step (2)), and see if it&#8217;s accepted.
 838 </p>
 839 </li>
 840 <li>
 841 <p>
 842 Report on the success or failure of the password. If the
 843      credential allowed the operation to complete successfully, then
 844      it can be marked with an "approve" action to tell <code>git
 845      credential</code> to reuse it in its next invocation. If the credential
 846      was rejected during the operation, use the "reject" action so
 847      that <code>git credential</code> will ask for a new password in its next
 848      invocation. In either case, <code>git credential</code> should be fed with
 849      the credential description obtained from step (2) (which also
 850      contains the fields provided in step (1)).
 851 </p>
 852 </li>
 853 </ol></div>
 854 </div>
 855 </div>
 856 <div class="sect1">
 857 <h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
 858 <div class="sectionbody">
 859 <div class="paragraph"><p><code>git credential</code> reads and/or writes (depending on the action used)
 860 credential information in its standard input/output. This information
 861 can correspond either to keys for which <code>git credential</code> will obtain
 862 the login information (e.g. host, protocol, path), or to the actual
 863 credential data to be obtained (username/password).</p></div>
 864 <div class="paragraph"><p>The credential is split into a set of named attributes, with one
 865 attribute per line. Each attribute is specified by a key-value pair,
 866 separated by an <code>=</code> (equals) sign, followed by a newline.</p></div>
 867 <div class="paragraph"><p>The key may contain any bytes except <code>=</code>, newline, or NUL. The value may
 868 contain any bytes except newline or NUL.  A line, including the trailing
 869 newline, may not exceed 65535 bytes in order to allow implementations to
 870 parse efficiently.</p></div>
 871 <div class="paragraph"><p>Attributes with keys that end with C-style array brackets <code>[]</code> can have
 872 multiple values. Each instance of a multi-valued attribute forms an
 873 ordered list of values - the order of the repeated attributes defines
 874 the order of the values. An empty multi-valued attribute (<code>key[]=\n</code>)
 875 acts to clear any previous entries and reset the list.</p></div>
 876 <div class="paragraph"><p>In all cases, all bytes are treated as-is (i.e., there is no quoting,
 877 and one cannot transmit a value with newline or NUL in it). The list of
 878 attributes is terminated by a blank line or end-of-file.</p></div>
 879 <div class="paragraph"><p>Git understands the following attributes:</p></div>
 880 <div class="dlist"><dl>
 881 <dt class="hdlist1">
 882 <code>protocol</code>
 883 </dt>
 884 <dd>
 885 <p>
 886         The protocol over which the credential will be used (e.g.,
 887         <code>https</code>).
 888 </p>
 889 </dd>
 890 <dt class="hdlist1">
 891 <code>host</code>
 892 </dt>
 893 <dd>
 894 <p>
 895         The remote hostname for a network credential.  This includes
 896         the port number if one was specified (e.g., "example.com:8088").
 897 </p>
 898 </dd>
 899 <dt class="hdlist1">
 900 <code>path</code>
 901 </dt>
 902 <dd>
 903 <p>
 904         The path with which the credential will be used. E.g., for
 905         accessing a remote https repository, this will be the
 906         repository&#8217;s path on the server.
 907 </p>
 908 </dd>
 909 <dt class="hdlist1">
 910 <code>username</code>
 911 </dt>
 912 <dd>
 913 <p>
 914         The credential&#8217;s username, if we already have one (e.g., from a
 915         URL, the configuration, the user, or from a previously run helper).
 916 </p>
 917 </dd>
 918 <dt class="hdlist1">
 919 <code>password</code>
 920 </dt>
 921 <dd>
 922 <p>
 923         The credential&#8217;s password, if we are asking it to be stored.
 924 </p>
 925 </dd>
 926 <dt class="hdlist1">
 927 <code>password_expiry_utc</code>
 928 </dt>
 929 <dd>
 930 <p>
 931         Generated passwords such as an OAuth access token may have an expiry date.
 932         When reading credentials from helpers, <code>git credential fill</code> ignores expired
 933         passwords. Represented as Unix time UTC, seconds since 1970.
 934 </p>
 935 </dd>
 936 <dt class="hdlist1">
 937 <code>oauth_refresh_token</code>
 938 </dt>
 939 <dd>
 940 <p>
 941         An OAuth refresh token may accompany a password that is an OAuth access
 942         token. Helpers must treat this attribute as confidential like the password
 943         attribute. Git itself has no special behaviour for this attribute.
 944 </p>
 945 </dd>
 946 <dt class="hdlist1">
 947 <code>url</code>
 948 </dt>
 949 <dd>
 950 <p>
 951         When this special attribute is read by <code>git credential</code>, the
 952         value is parsed as a URL and treated as if its constituent parts
 953         were read (e.g., <code>url=https://example.com</code> would behave as if
 954         <code>protocol=https</code> and <code>host=example.com</code> had been provided). This
 955         can help callers avoid parsing URLs themselves.
 956 </p>
 957 <div class="paragraph"><p>Note that specifying a protocol is mandatory and if the URL
 958 doesn&#8217;t specify a hostname (e.g., "cert:///path/to/file") the
 959 credential will contain a hostname attribute whose value is an
 960 empty string.</p></div>
 961 <div class="paragraph"><p>Components which are missing from the URL (e.g., there is no
 962 username in the example above) will be left unset.</p></div>
 963 </dd>
 964 <dt class="hdlist1">
 965 <code>authtype</code>
 966 </dt>
 967 <dd>
 968 <p>
 969         This indicates that the authentication scheme in question should be used.
 970         Common values for HTTP and HTTPS include <code>basic</code>, <code>bearer</code>, and <code>digest</code>,
 971         although the latter is insecure and should not be used.  If <code>credential</code>
 972         is used, this may be set to an arbitrary string suitable for the protocol in
 973         question (usually HTTP).
 974 </p>
 975 <div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
 976 provided on input.</p></div>
 977 </dd>
 978 <dt class="hdlist1">
 979 <code>credential</code>
 980 </dt>
 981 <dd>
 982 <p>
 983         The pre-encoded credential, suitable for the protocol in question (usually
 984         HTTP).  If this key is sent, <code>authtype</code> is mandatory, and <code>username</code> and
 985         <code>password</code> are not used.  For HTTP, Git concatenates the <code>authtype</code> value and
 986         this value with a single space to determine the <code>Authorization</code> header.
 987 </p>
 988 <div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
 989 provided on input.</p></div>
 990 </dd>
 991 <dt class="hdlist1">
 992 <code>ephemeral</code>
 993 </dt>
 994 <dd>
 995 <p>
 996         This boolean value indicates, if true, that the value in the <code>credential</code>
 997         field should not be saved by the credential helper because its usefulness is
 998         limited in time.  For example, an HTTP Digest <code>credential</code> value is computed
 999         using a nonce and reusing it will not result in successful authentication.
1000         This may also be used for situations with short duration (e.g., 24-hour)
1001         credentials.  The default value is false.
1002 </p>
1003 <div class="paragraph"><p>The credential helper will still be invoked with <code>store</code> or <code>erase</code> so that it
1004 can determine whether the operation was successful.</p></div>
1005 <div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
1006 provided on input.</p></div>
1007 </dd>
1008 <dt class="hdlist1">
1009 <code>state[]</code>
1010 </dt>
1011 <dd>
1012 <p>
1013         This value provides an opaque state that will be passed back to this helper
1014         if it is called again.  Each different credential helper may specify this
1015         once.  The value should include a prefix unique to the credential helper and
1016         should ignore values that don&#8217;t match its prefix.
1017 </p>
1018 <div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
1019 provided on input.</p></div>
1020 </dd>
1021 <dt class="hdlist1">
1022 <code>continue</code>
1023 </dt>
1024 <dd>
1025 <p>
1026         This is a boolean value, which, if enabled, indicates that this
1027         authentication is a non-final part of a multistage authentication step. This
1028         is common in protocols such as NTLM and Kerberos, where two rounds of client
1029         authentication are required, and setting this flag allows the credential
1030         helper to implement the multistage authentication step.  This flag should
1031         only be sent if a further stage is required; that is, if another round of
1032         authentication is expected.
1033 </p>
1034 <div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
1035 provided on input.  This attribute is <em>one-way</em> from a credential helper to
1036 pass information to Git (or other programs invoking <code>git credential</code>).</p></div>
1037 </dd>
1038 <dt class="hdlist1">
1039 <code>wwwauth[]</code>
1040 </dt>
1041 <dd>
1042 <p>
1043         When an HTTP response is received by Git that includes one or more
1044         <em>WWW-Authenticate</em> authentication headers, these will be passed by Git
1045         to credential helpers.
1046 </p>
1047 <div class="paragraph"><p>Each <em>WWW-Authenticate</em> header value is passed as a multi-valued
1048 attribute <em>wwwauth[]</em>, where the order of the attributes is the same as
1049 they appear in the HTTP response. This attribute is <em>one-way</em> from Git
1050 to pass additional information to credential helpers.</p></div>
1051 </dd>
1052 <dt class="hdlist1">
1053 <code>capability[]</code>
1054 </dt>
1055 <dd>
1056 <p>
1057         This signals that Git, or the helper, as appropriate, supports the capability
1058         in question.  This can be used to provide better, more specific data as part
1059         of the protocol.  A <code>capability[]</code> directive must precede any value depending
1060         on it and these directives <em>should</em> be the first item announced in the
1061         protocol.
1062 </p>
1063 <div class="paragraph"><p>There are two currently supported capabilities.  The first is <code>authtype</code>, which
1064 indicates that the <code>authtype</code>, <code>credential</code>, and <code>ephemeral</code> values are
1065 understood.  The second is <code>state</code>, which indicates that the <code>state[]</code> and
1066 <code>continue</code> values are understood.</p></div>
1067 <div class="paragraph"><p>It is not obligatory to use the additional features just because the capability
1068 is supported, but they should not be provided without the capability.</p></div>
1069 </dd>
1070 </dl></div>
1071 <div class="paragraph"><p>Unrecognised attributes and capabilities are silently discarded.</p></div>
1072 </div>
1073 </div>
1074 <div class="sect1">
1075 <h2 id="CAPA-IOFMT">CAPABILITY INPUT/OUTPUT FORMAT</h2>
1076 <div class="sectionbody">
1077 <div class="paragraph"><p>For <code>git credential capability</code>, the format is slightly different. First, a
1078 <code>version 0</code> announcement is made to indicate the current version of the
1079 protocol, and then each capability is announced with a line like <code>capability
1080 authtype</code>. Credential helpers may also implement this format, again with the
1081 <code>capability</code> argument. Additional lines may be added in the future; callers
1082 should ignore lines which they don&#8217;t understand.</p></div>
1083 <div class="paragraph"><p>Because this is a new part of the credential helper protocol, older versions of
1084 Git, as well as some credential helpers, may not support it.  If a non-zero
1085 exit status is received, or if the first line doesn&#8217;t start with the word
1086 <code>version</code> and a space, callers should assume that no capabilities are supported.</p></div>
1087 <div class="paragraph"><p>The intention of this format is to differentiate it from the credential output
1088 in an unambiguous way.  It is possible to use very simple credential helpers
1089 (e.g., inline shell scripts) which always produce identical output.  Using a
1090 distinct format allows users to continue to use this syntax without having to
1091 worry about correctly implementing capability advertisements or accidentally
1092 confusing callers querying for capabilities.</p></div>
1093 </div>
1094 </div>
1095 <div class="sect1">
1096 <h2 id="_git">GIT</h2>
1097 <div class="sectionbody">
1098 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1099 </div>
1100 </div>
1101 </div>
1102 <div id="footnotes"><hr /></div>
1103 <div id="footer">
1104 <div id="footer-text">
1105 Last updated
1106  2024-05-13 12:26:56 PDT
1107 </div>
1108 </div>
1109 </body>
1110 </html>