1110 lines
32 KiB
HTML
1110 lines
32 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
|
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
|
|
<meta name="generator" content="AsciiDoc 10.2.0" />
|
|
<title>git-credential(1)</title>
|
|
<style type="text/css">
|
|
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
|
|
|
|
/* Default font. */
|
|
body {
|
|
font-family: Georgia,serif;
|
|
}
|
|
|
|
/* Title font. */
|
|
h1, h2, h3, h4, h5, h6,
|
|
div.title, caption.title,
|
|
thead, p.table.header,
|
|
#toctitle,
|
|
#author, #revnumber, #revdate, #revremark,
|
|
#footer {
|
|
font-family: Arial,Helvetica,sans-serif;
|
|
}
|
|
|
|
body {
|
|
margin: 1em 5% 1em 5%;
|
|
}
|
|
|
|
a {
|
|
color: blue;
|
|
text-decoration: underline;
|
|
}
|
|
a:visited {
|
|
color: fuchsia;
|
|
}
|
|
|
|
em {
|
|
font-style: italic;
|
|
color: navy;
|
|
}
|
|
|
|
strong {
|
|
font-weight: bold;
|
|
color: #083194;
|
|
}
|
|
|
|
h1, h2, h3, h4, h5, h6 {
|
|
color: #527bbd;
|
|
margin-top: 1.2em;
|
|
margin-bottom: 0.5em;
|
|
line-height: 1.3;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
h2 {
|
|
padding-top: 0.5em;
|
|
}
|
|
h3 {
|
|
float: left;
|
|
}
|
|
h3 + * {
|
|
clear: left;
|
|
}
|
|
h5 {
|
|
font-size: 1.0em;
|
|
}
|
|
|
|
div.sectionbody {
|
|
margin-left: 0;
|
|
}
|
|
|
|
hr {
|
|
border: 1px solid silver;
|
|
}
|
|
|
|
p {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
ul, ol, li > p {
|
|
margin-top: 0;
|
|
}
|
|
ul > li { color: #aaa; }
|
|
ul > li > * { color: black; }
|
|
|
|
.monospaced, code, pre {
|
|
font-family: "Courier New", Courier, monospace;
|
|
font-size: inherit;
|
|
color: navy;
|
|
padding: 0;
|
|
margin: 0;
|
|
}
|
|
pre {
|
|
white-space: pre-wrap;
|
|
}
|
|
|
|
#author {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
font-size: 1.1em;
|
|
}
|
|
#email {
|
|
}
|
|
#revnumber, #revdate, #revremark {
|
|
}
|
|
|
|
#footer {
|
|
font-size: small;
|
|
border-top: 2px solid silver;
|
|
padding-top: 0.5em;
|
|
margin-top: 4.0em;
|
|
}
|
|
#footer-text {
|
|
float: left;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
#footer-badges {
|
|
float: right;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
|
|
#preamble {
|
|
margin-top: 1.5em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.imageblock, div.exampleblock, div.verseblock,
|
|
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
|
div.admonitionblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.admonitionblock {
|
|
margin-top: 2.0em;
|
|
margin-bottom: 2.0em;
|
|
margin-right: 10%;
|
|
color: #606060;
|
|
}
|
|
|
|
div.content { /* Block element content. */
|
|
padding: 0;
|
|
}
|
|
|
|
/* Block element titles. */
|
|
div.title, caption.title {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
text-align: left;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
div.title + * {
|
|
margin-top: 0;
|
|
}
|
|
|
|
td div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content + div.title {
|
|
margin-top: 0.0em;
|
|
}
|
|
|
|
div.sidebarblock > div.content {
|
|
background: #ffffee;
|
|
border: 1px solid #dddddd;
|
|
border-left: 4px solid #f0f0f0;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.listingblock > div.content {
|
|
border: 1px solid #dddddd;
|
|
border-left: 5px solid #f0f0f0;
|
|
background: #f8f8f8;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.quoteblock, div.verseblock {
|
|
padding-left: 1.0em;
|
|
margin-left: 1.0em;
|
|
margin-right: 10%;
|
|
border-left: 5px solid #f0f0f0;
|
|
color: #888;
|
|
}
|
|
|
|
div.quoteblock > div.attribution {
|
|
padding-top: 0.5em;
|
|
text-align: right;
|
|
}
|
|
|
|
div.verseblock > pre.content {
|
|
font-family: inherit;
|
|
font-size: inherit;
|
|
}
|
|
div.verseblock > div.attribution {
|
|
padding-top: 0.75em;
|
|
text-align: left;
|
|
}
|
|
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
|
div.verseblock + div.attribution {
|
|
text-align: left;
|
|
}
|
|
|
|
div.admonitionblock .icon {
|
|
vertical-align: top;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
text-decoration: underline;
|
|
color: #527bbd;
|
|
padding-right: 0.5em;
|
|
}
|
|
div.admonitionblock td.content {
|
|
padding-left: 0.5em;
|
|
border-left: 3px solid #dddddd;
|
|
}
|
|
|
|
div.exampleblock > div.content {
|
|
border-left: 3px solid #dddddd;
|
|
padding-left: 0.5em;
|
|
}
|
|
|
|
div.imageblock div.content { padding-left: 0; }
|
|
span.image img { border-style: none; vertical-align: text-bottom; }
|
|
a.image:visited { color: white; }
|
|
|
|
dl {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
dt {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0;
|
|
font-style: normal;
|
|
color: navy;
|
|
}
|
|
dd > *:first-child {
|
|
margin-top: 0.1em;
|
|
}
|
|
|
|
ul, ol {
|
|
list-style-position: outside;
|
|
}
|
|
ol.arabic {
|
|
list-style-type: decimal;
|
|
}
|
|
ol.loweralpha {
|
|
list-style-type: lower-alpha;
|
|
}
|
|
ol.upperalpha {
|
|
list-style-type: upper-alpha;
|
|
}
|
|
ol.lowerroman {
|
|
list-style-type: lower-roman;
|
|
}
|
|
ol.upperroman {
|
|
list-style-type: upper-roman;
|
|
}
|
|
|
|
div.compact ul, div.compact ol,
|
|
div.compact p, div.compact p,
|
|
div.compact div, div.compact div {
|
|
margin-top: 0.1em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
tfoot {
|
|
font-weight: bold;
|
|
}
|
|
td > div.verse {
|
|
white-space: pre;
|
|
}
|
|
|
|
div.hdlist {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
div.hdlist tr {
|
|
padding-bottom: 15px;
|
|
}
|
|
dt.hdlist1.strong, td.hdlist1.strong {
|
|
font-weight: bold;
|
|
}
|
|
td.hdlist1 {
|
|
vertical-align: top;
|
|
font-style: normal;
|
|
padding-right: 0.8em;
|
|
color: navy;
|
|
}
|
|
td.hdlist2 {
|
|
vertical-align: top;
|
|
}
|
|
div.hdlist.compact tr {
|
|
margin: 0;
|
|
padding-bottom: 0;
|
|
}
|
|
|
|
.comment {
|
|
background: yellow;
|
|
}
|
|
|
|
.footnote, .footnoteref {
|
|
font-size: 0.8em;
|
|
}
|
|
|
|
span.footnote, span.footnoteref {
|
|
vertical-align: super;
|
|
}
|
|
|
|
#footnotes {
|
|
margin: 20px 0 20px 0;
|
|
padding: 7px 0 0 0;
|
|
}
|
|
|
|
#footnotes div.footnote {
|
|
margin: 0 0 5px 0;
|
|
}
|
|
|
|
#footnotes hr {
|
|
border: none;
|
|
border-top: 1px solid silver;
|
|
height: 1px;
|
|
text-align: left;
|
|
margin-left: 0;
|
|
width: 20%;
|
|
min-width: 100px;
|
|
}
|
|
|
|
div.colist td {
|
|
padding-right: 0.5em;
|
|
padding-bottom: 0.3em;
|
|
vertical-align: top;
|
|
}
|
|
div.colist td img {
|
|
margin-top: 0.3em;
|
|
}
|
|
|
|
@media print {
|
|
#footer-badges { display: none; }
|
|
}
|
|
|
|
#toc {
|
|
margin-bottom: 2.5em;
|
|
}
|
|
|
|
#toctitle {
|
|
color: #527bbd;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
}
|
|
div.toclevel2 {
|
|
margin-left: 2em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel3 {
|
|
margin-left: 4em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel4 {
|
|
margin-left: 6em;
|
|
font-size: 0.9em;
|
|
}
|
|
|
|
span.aqua { color: aqua; }
|
|
span.black { color: black; }
|
|
span.blue { color: blue; }
|
|
span.fuchsia { color: fuchsia; }
|
|
span.gray { color: gray; }
|
|
span.green { color: green; }
|
|
span.lime { color: lime; }
|
|
span.maroon { color: maroon; }
|
|
span.navy { color: navy; }
|
|
span.olive { color: olive; }
|
|
span.purple { color: purple; }
|
|
span.red { color: red; }
|
|
span.silver { color: silver; }
|
|
span.teal { color: teal; }
|
|
span.white { color: white; }
|
|
span.yellow { color: yellow; }
|
|
|
|
span.aqua-background { background: aqua; }
|
|
span.black-background { background: black; }
|
|
span.blue-background { background: blue; }
|
|
span.fuchsia-background { background: fuchsia; }
|
|
span.gray-background { background: gray; }
|
|
span.green-background { background: green; }
|
|
span.lime-background { background: lime; }
|
|
span.maroon-background { background: maroon; }
|
|
span.navy-background { background: navy; }
|
|
span.olive-background { background: olive; }
|
|
span.purple-background { background: purple; }
|
|
span.red-background { background: red; }
|
|
span.silver-background { background: silver; }
|
|
span.teal-background { background: teal; }
|
|
span.white-background { background: white; }
|
|
span.yellow-background { background: yellow; }
|
|
|
|
span.big { font-size: 2em; }
|
|
span.small { font-size: 0.6em; }
|
|
|
|
span.underline { text-decoration: underline; }
|
|
span.overline { text-decoration: overline; }
|
|
span.line-through { text-decoration: line-through; }
|
|
|
|
div.unbreakable { page-break-inside: avoid; }
|
|
|
|
|
|
/*
|
|
* xhtml11 specific
|
|
*
|
|
* */
|
|
|
|
div.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.tableblock > table {
|
|
border: 3px solid #527bbd;
|
|
}
|
|
thead, p.table.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.table {
|
|
margin-top: 0;
|
|
}
|
|
/* Because the table frame attribute is overridden by CSS in most browsers. */
|
|
div.tableblock > table[frame="void"] {
|
|
border-style: none;
|
|
}
|
|
div.tableblock > table[frame="hsides"] {
|
|
border-left-style: none;
|
|
border-right-style: none;
|
|
}
|
|
div.tableblock > table[frame="vsides"] {
|
|
border-top-style: none;
|
|
border-bottom-style: none;
|
|
}
|
|
|
|
|
|
/*
|
|
* html5 specific
|
|
*
|
|
* */
|
|
|
|
table.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
thead, p.tableblock.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.tableblock {
|
|
margin-top: 0;
|
|
}
|
|
table.tableblock {
|
|
border-width: 3px;
|
|
border-spacing: 0px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
border-collapse: collapse;
|
|
}
|
|
th.tableblock, td.tableblock {
|
|
border-width: 1px;
|
|
padding: 4px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
}
|
|
|
|
table.tableblock.frame-topbot {
|
|
border-left-style: hidden;
|
|
border-right-style: hidden;
|
|
}
|
|
table.tableblock.frame-sides {
|
|
border-top-style: hidden;
|
|
border-bottom-style: hidden;
|
|
}
|
|
table.tableblock.frame-none {
|
|
border-style: hidden;
|
|
}
|
|
|
|
th.tableblock.halign-left, td.tableblock.halign-left {
|
|
text-align: left;
|
|
}
|
|
th.tableblock.halign-center, td.tableblock.halign-center {
|
|
text-align: center;
|
|
}
|
|
th.tableblock.halign-right, td.tableblock.halign-right {
|
|
text-align: right;
|
|
}
|
|
|
|
th.tableblock.valign-top, td.tableblock.valign-top {
|
|
vertical-align: top;
|
|
}
|
|
th.tableblock.valign-middle, td.tableblock.valign-middle {
|
|
vertical-align: middle;
|
|
}
|
|
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
|
|
vertical-align: bottom;
|
|
}
|
|
|
|
|
|
/*
|
|
* manpage specific
|
|
*
|
|
* */
|
|
|
|
body.manpage h1 {
|
|
padding-top: 0.5em;
|
|
padding-bottom: 0.5em;
|
|
border-top: 2px solid silver;
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
body.manpage h2 {
|
|
border-style: none;
|
|
}
|
|
body.manpage div.sectionbody {
|
|
margin-left: 3em;
|
|
}
|
|
|
|
@media print {
|
|
body.manpage div#toc { display: none; }
|
|
}
|
|
|
|
|
|
</style>
|
|
<script type="text/javascript">
|
|
/*<+'])');
|
|
// Function that scans the DOM tree for header elements (the DOM2
|
|
// nodeIterator API would be a better technique but not supported by all
|
|
// browsers).
|
|
var iterate = function (el) {
|
|
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
|
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
|
var mo = re.exec(i.tagName);
|
|
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
|
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
|
}
|
|
iterate(i);
|
|
}
|
|
}
|
|
}
|
|
iterate(el);
|
|
return result;
|
|
}
|
|
|
|
var toc = document.getElementById("toc");
|
|
if (!toc) {
|
|
return;
|
|
}
|
|
|
|
// Delete existing TOC entries in case we're reloading the TOC.
|
|
var tocEntriesToRemove = [];
|
|
var i;
|
|
for (i = 0; i < toc.childNodes.length; i++) {
|
|
var entry = toc.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div'
|
|
&& entry.getAttribute("class")
|
|
&& entry.getAttribute("class").match(/^toclevel/))
|
|
tocEntriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < tocEntriesToRemove.length; i++) {
|
|
toc.removeChild(tocEntriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild TOC entries.
|
|
var entries = tocEntries(document.getElementById("content"), toclevels);
|
|
for (var i = 0; i < entries.length; ++i) {
|
|
var entry = entries[i];
|
|
if (entry.element.id == "")
|
|
entry.element.id = "_toc_" + i;
|
|
var a = document.createElement("a");
|
|
a.href = "#" + entry.element.id;
|
|
a.appendChild(document.createTextNode(entry.text));
|
|
var div = document.createElement("div");
|
|
div.appendChild(a);
|
|
div.className = "toclevel" + entry.toclevel;
|
|
toc.appendChild(div);
|
|
}
|
|
if (entries.length == 0)
|
|
toc.parentNode.removeChild(toc);
|
|
},
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
// Footnotes generator
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
/* Based on footnote generation code from:
|
|
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
|
*/
|
|
|
|
footnotes: function () {
|
|
// Delete existing footnote entries in case we're reloading the footnodes.
|
|
var i;
|
|
var noteholder = document.getElementById("footnotes");
|
|
if (!noteholder) {
|
|
return;
|
|
}
|
|
var entriesToRemove = [];
|
|
for (i = 0; i < noteholder.childNodes.length; i++) {
|
|
var entry = noteholder.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
|
|
entriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < entriesToRemove.length; i++) {
|
|
noteholder.removeChild(entriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild footnote entries.
|
|
var cont = document.getElementById("content");
|
|
var spans = cont.getElementsByTagName("span");
|
|
var refs = {};
|
|
var n = 0;
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnote") {
|
|
n++;
|
|
var note = spans[i].getAttribute("data-note");
|
|
if (!note) {
|
|
// Use [\s\S] in place of . so multi-line matches work.
|
|
// Because JavaScript has no s (dotall) regex flag.
|
|
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
|
spans[i].innerHTML =
|
|
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
spans[i].setAttribute("data-note", note);
|
|
}
|
|
noteholder.innerHTML +=
|
|
"<div class='footnote' id='_footnote_" + n + "'>" +
|
|
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
|
n + "</a>. " + note + "</div>";
|
|
var id =spans[i].getAttribute("id");
|
|
if (id != null) refs["#"+id] = n;
|
|
}
|
|
}
|
|
if (n == 0)
|
|
noteholder.parentNode.removeChild(noteholder);
|
|
else {
|
|
// Process footnoterefs.
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnoteref") {
|
|
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
|
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
|
n = refs[href];
|
|
spans[i].innerHTML =
|
|
"[<a href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
install: function(toclevels) {
|
|
var timerId;
|
|
|
|
function reinstall() {
|
|
asciidoc.footnotes();
|
|
if (toclevels) {
|
|
asciidoc.toc(toclevels);
|
|
}
|
|
}
|
|
|
|
function reinstallAndRemoveTimer() {
|
|
clearInterval(timerId);
|
|
reinstall();
|
|
}
|
|
|
|
timerId = setInterval(reinstall, 500);
|
|
if (document.addEventListener)
|
|
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
|
|
else
|
|
window.onload = reinstallAndRemoveTimer;
|
|
}
|
|
|
|
}
|
|
asciidoc.install();
|
|
/*]]>*/
|
|
</script>
|
|
</head>
|
|
<body class="manpage">
|
|
<div id="header">
|
|
<h1>
|
|
git-credential(1) Manual Page
|
|
</h1>
|
|
<h2>NAME</h2>
|
|
<div class="sectionbody">
|
|
<p>git-credential -
|
|
Retrieve and store user credentials
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="_synopsis">SYNOPSIS</h2>
|
|
<div class="sectionbody">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>'git credential' (fill|approve|reject|capability)</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_description">DESCRIPTION</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Git has an internal interface for storing and retrieving credentials
|
|
from system-specific helpers, as well as prompting the user for
|
|
usernames and passwords. The git-credential command exposes this
|
|
interface to scripts which may want to retrieve, store, or prompt for
|
|
credentials in the same manner as Git. The design of this scriptable
|
|
interface models the internal C API; see credential.h for more
|
|
background on the concepts.</p></div>
|
|
<div class="paragraph"><p>git-credential takes an "action" option on the command-line (one of
|
|
<code>fill</code>, <code>approve</code>, or <code>reject</code>) and reads a credential description
|
|
on stdin (see <a href="#IOFMT">INPUT/OUTPUT FORMAT</a>).</p></div>
|
|
<div class="paragraph"><p>If the action is <code>fill</code>, git-credential will attempt to add "username"
|
|
and "password" attributes to the description by reading config files,
|
|
by contacting any configured credential helpers, or by prompting the
|
|
user. The username and password attributes of the credential
|
|
description are then printed to stdout together with the attributes
|
|
already provided.</p></div>
|
|
<div class="paragraph"><p>If the action is <code>approve</code>, git-credential will send the description
|
|
to any configured credential helpers, which may store the credential
|
|
for later use.</p></div>
|
|
<div class="paragraph"><p>If the action is <code>reject</code>, git-credential will send the description to
|
|
any configured credential helpers, which may erase any stored
|
|
credentials matching the description.</p></div>
|
|
<div class="paragraph"><p>If the action is <code>capability</code>, git-credential will announce any capabilities
|
|
it supports to standard output.</p></div>
|
|
<div class="paragraph"><p>If the action is <code>approve</code> or <code>reject</code>, no output should be emitted.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_typical_use_of_git_credential">TYPICAL USE OF GIT CREDENTIAL</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>An application using git-credential will typically use <code>git</code>
|
|
<code>credential</code> following these steps:</p></div>
|
|
<div class="olist arabic"><ol class="arabic">
|
|
<li>
|
|
<p>
|
|
Generate a credential description based on the context.
|
|
</p>
|
|
<div class="paragraph"><p>For example, if we want a password for
|
|
<code>https://example.com/foo.git</code>, we might generate the following
|
|
credential description (don’t forget the blank line at the end; it
|
|
tells <code>git</code> <code>credential</code> that the application finished feeding all the
|
|
information it has):</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>protocol=https
|
|
host=example.com
|
|
path=foo.git</code></pre>
|
|
</div></div>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Ask git-credential to give us a username and password for this
|
|
description. This is done by running <code>git</code> <code>credential</code> <code>fill</code>,
|
|
feeding the description from step (1) to its standard input. The complete
|
|
credential description (including the credential per se, i.e. the
|
|
login and password) will be produced on standard output, like:
|
|
</p>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>protocol=https
|
|
host=example.com
|
|
username=bob
|
|
password=secr3t</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>In most cases, this means the attributes given in the input will be
|
|
repeated in the output, but Git may also modify the credential
|
|
description, for example by removing the <code>path</code> attribute when the
|
|
protocol is HTTP(s) and <code>credential.useHttpPath</code> is false.</p></div>
|
|
<div class="paragraph"><p>If the <code>git</code> <code>credential</code> knew about the password, this step may
|
|
not have involved the user actually typing this password (the
|
|
user may have typed a password to unlock the keychain instead,
|
|
or no user interaction was done if the keychain was already
|
|
unlocked) before it returned <code>password=secr3t</code>.</p></div>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Use the credential (e.g., access the URL with the username and
|
|
password from step (2)), and see if it’s accepted.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Report on the success or failure of the password. If the
|
|
credential allowed the operation to complete successfully, then
|
|
it can be marked with an "approve" action to tell <code>git</code>
|
|
<code>credential</code> to reuse it in its next invocation. If the credential
|
|
was rejected during the operation, use the "reject" action so
|
|
that <code>git</code> <code>credential</code> will ask for a new password in its next
|
|
invocation. In either case, <code>git</code> <code>credential</code> should be fed with
|
|
the credential description obtained from step (2) (which also
|
|
contains the fields provided in step (1)).
|
|
</p>
|
|
</li>
|
|
</ol></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p><code>git</code> <code>credential</code> reads and/or writes (depending on the action used)
|
|
credential information in its standard input/output. This information
|
|
can correspond either to keys for which <code>git</code> <code>credential</code> will obtain
|
|
the login information (e.g. host, protocol, path), or to the actual
|
|
credential data to be obtained (username/password).</p></div>
|
|
<div class="paragraph"><p>The credential is split into a set of named attributes, with one
|
|
attribute per line. Each attribute is specified by a key-value pair,
|
|
separated by an <code>=</code> (equals) sign, followed by a newline.</p></div>
|
|
<div class="paragraph"><p>The key may contain any bytes except <code>=</code>, newline, or NUL. The value may
|
|
contain any bytes except newline or NUL. A line, including the trailing
|
|
newline, may not exceed 65535 bytes in order to allow implementations to
|
|
parse efficiently.</p></div>
|
|
<div class="paragraph"><p>Attributes with keys that end with C-style array brackets [] can have
|
|
multiple values. Each instance of a multi-valued attribute forms an
|
|
ordered list of values - the order of the repeated attributes defines
|
|
the order of the values. An empty multi-valued attribute (<code>key</code>[]<code>=\n</code>)
|
|
acts to clear any previous entries and reset the list.</p></div>
|
|
<div class="paragraph"><p>In all cases, all bytes are treated as-is (i.e., there is no quoting,
|
|
and one cannot transmit a value with newline or NUL in it). The list of
|
|
attributes is terminated by a blank line or end-of-file.</p></div>
|
|
<div class="paragraph"><p>Git understands the following attributes:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
<code>protocol</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The protocol over which the credential will be used (e.g.,
|
|
<code>https</code>).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>host</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The remote hostname for a network credential. This includes
|
|
the port number if one was specified (e.g., "example.com:8088").
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>path</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The path with which the credential will be used. E.g., for
|
|
accessing a remote https repository, this will be the
|
|
repository’s path on the server.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>username</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The credential’s username, if we already have one (e.g., from a
|
|
URL, the configuration, the user, or from a previously run helper).
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>password</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The credential’s password, if we are asking it to be stored.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>password_expiry_utc</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Generated passwords such as an OAuth access token may have an expiry date.
|
|
When reading credentials from helpers, <code>git</code> <code>credential</code> <code>fill</code> ignores expired
|
|
passwords. Represented as Unix time UTC, seconds since 1970.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>oauth_refresh_token</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
An OAuth refresh token may accompany a password that is an OAuth access
|
|
token. Helpers must treat this attribute as confidential like the password
|
|
attribute. Git itself has no special behaviour for this attribute.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>url</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
When this special attribute is read by <code>git</code> <code>credential</code>, the
|
|
value is parsed as a URL and treated as if its constituent parts
|
|
were read (e.g., <code>url=https://example.com</code> would behave as if
|
|
<code>protocol=https</code> and <code>host=example.com</code> had been provided). This
|
|
can help callers avoid parsing URLs themselves.
|
|
</p>
|
|
<div class="paragraph"><p>Note that specifying a protocol is mandatory and if the URL
|
|
doesn’t specify a hostname (e.g., "cert:///path/to/file") the
|
|
credential will contain a hostname attribute whose value is an
|
|
empty string.</p></div>
|
|
<div class="paragraph"><p>Components which are missing from the URL (e.g., there is no
|
|
username in the example above) will be left unset.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>authtype</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
This indicates that the authentication scheme in question should be used.
|
|
Common values for HTTP and HTTPS include <code>basic</code>, <code>bearer</code>, and <code>digest</code>,
|
|
although the latter is insecure and should not be used. If <code>credential</code>
|
|
is used, this may be set to an arbitrary string suitable for the protocol in
|
|
question (usually HTTP).
|
|
</p>
|
|
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
|
|
provided on input.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>credential</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The pre-encoded credential, suitable for the protocol in question (usually
|
|
HTTP). If this key is sent, <code>authtype</code> is mandatory, and <code>username</code> and
|
|
<code>password</code> are not used. For HTTP, Git concatenates the <code>authtype</code> value and
|
|
this value with a single space to determine the <code>Authorization</code> header.
|
|
</p>
|
|
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
|
|
provided on input.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>ephemeral</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
This boolean value indicates, if true, that the value in the <code>credential</code>
|
|
field should not be saved by the credential helper because its usefulness is
|
|
limited in time. For example, an HTTP Digest <code>credential</code> value is computed
|
|
using a nonce and reusing it will not result in successful authentication.
|
|
This may also be used for situations with short duration (e.g., 24-hour)
|
|
credentials. The default value is false.
|
|
</p>
|
|
<div class="paragraph"><p>The credential helper will still be invoked with <code>store</code> or <code>erase</code> so that it
|
|
can determine whether the operation was successful.</p></div>
|
|
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
|
|
provided on input.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>state</code>[]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
This value provides an opaque state that will be passed back to this helper
|
|
if it is called again. Each different credential helper may specify this
|
|
once. The value should include a prefix unique to the credential helper and
|
|
should ignore values that don’t match its prefix.
|
|
</p>
|
|
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
|
|
provided on input.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>continue</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
This is a boolean value, which, if enabled, indicates that this
|
|
authentication is a non-final part of a multistage authentication step. This
|
|
is common in protocols such as NTLM and Kerberos, where two rounds of client
|
|
authentication are required, and setting this flag allows the credential
|
|
helper to implement the multistage authentication step. This flag should
|
|
only be sent if a further stage is required; that is, if another round of
|
|
authentication is expected.
|
|
</p>
|
|
<div class="paragraph"><p>This value should not be sent unless the appropriate capability (see below) is
|
|
provided on input. This attribute is <em>one-way</em> from a credential helper to
|
|
pass information to Git (or other programs invoking <code>git</code> <code>credential</code>).</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>wwwauth</code>[]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
When an HTTP response is received by Git that includes one or more
|
|
<em>WWW-Authenticate</em> authentication headers, these will be passed by Git
|
|
to credential helpers.
|
|
</p>
|
|
<div class="paragraph"><p>Each <em>WWW-Authenticate</em> header value is passed as a multi-valued
|
|
attribute <em>wwwauth[]</em>, where the order of the attributes is the same as
|
|
they appear in the HTTP response. This attribute is <em>one-way</em> from Git
|
|
to pass additional information to credential helpers.</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>capability</code>[]
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
This signals that Git, or the helper, as appropriate, supports the capability
|
|
in question. This can be used to provide better, more specific data as part
|
|
of the protocol. A <code>capability</code>[] directive must precede any value depending
|
|
on it and these directives <em>should</em> be the first item announced in the
|
|
protocol.
|
|
</p>
|
|
<div class="paragraph"><p>There are two currently supported capabilities. The first is <code>authtype</code>, which
|
|
indicates that the <code>authtype</code>, <code>credential</code>, and <code>ephemeral</code> values are
|
|
understood. The second is <code>state</code>, which indicates that the <code>state</code>[] and
|
|
<code>continue</code> values are understood.</p></div>
|
|
<div class="paragraph"><p>It is not obligatory to use the additional features just because the capability
|
|
is supported, but they should not be provided without the capability.</p></div>
|
|
</dd>
|
|
</dl></div>
|
|
<div class="paragraph"><p>Unrecognised attributes and capabilities are silently discarded.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="CAPA-IOFMT">CAPABILITY INPUT/OUTPUT FORMAT</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>For <code>git</code> <code>credential</code> <code>capability</code>, the format is slightly different. First, a
|
|
<code>version</code> <code>0</code> announcement is made to indicate the current version of the
|
|
protocol, and then each capability is announced with a line like <code>capability</code>
|
|
<code>authtype</code>. Credential helpers may also implement this format, again with the
|
|
<code>capability</code> argument. Additional lines may be added in the future; callers
|
|
should ignore lines which they don’t understand.</p></div>
|
|
<div class="paragraph"><p>Because this is a new part of the credential helper protocol, older versions of
|
|
Git, as well as some credential helpers, may not support it. If a non-zero
|
|
exit status is received, or if the first line doesn’t start with the word
|
|
<code>version</code> and a space, callers should assume that no capabilities are supported.</p></div>
|
|
<div class="paragraph"><p>The intention of this format is to differentiate it from the credential output
|
|
in an unambiguous way. It is possible to use very simple credential helpers
|
|
(e.g., inline shell scripts) which always produce identical output. Using a
|
|
distinct format allows users to continue to use this syntax without having to
|
|
worry about correctly implementing capability advertisements or accidentally
|
|
confusing callers querying for capabilities.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_git">GIT</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footnotes"><hr /></div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated
|
|
2025-08-18 02:18:23 CEST
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|