# [PATCH] Docs: describe how a credential-generating helper works 4 messages from 2022-11-12 to 2022-11-17. Participants: M Hickford via GitGitGadget, Taylor Blau, Matthew John Cheetham. Thread: https://gitlist.dev/t/58793 ## M Hickford via GitGitGadget, 2022-11-12 01:44 Subject: [PATCH] Docs: describe how a credential-generating helper works Message-ID: URL: https://gitlist.dev/e/pull.1379.git.git.1668217470500.gitgitgadget%40gmail.com ``` From: M Hickford Previously the docs only described storage helpers. A concrete example: Git Credential Manager can generate credentials for GitHub and GitLab via OAuth. https://github.com/GitCredentialManager/git-credential-manager Signed-off-by: M Hickford --- Docs: describe how a credential-generating helper works Previously the docs only described storage helpers. A concrete example: Git Credential Manager can generate credentials for GitHub and GitLab via OAuth. https://github.com/GitCredentialManager/git-credential-manager Signed-off-by: M Hickford mirth.hickford@gmail.com Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1379%2Fhickford%2Fcredential-generator-v1 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1379/hickford/credential-generator-v1 Pull-Request: https://github.com/git/git/pull/1379 Documentation/gitcredentials.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt index 80517b4eb2c..72888402e73 100644 --- a/Documentation/gitcredentials.txt +++ b/Documentation/gitcredentials.txt @@ -61,7 +61,9 @@ for a password. It is generally configured by adding this to your config: Credential helpers, on the other hand, are external programs from which Git can request both usernames and passwords; they typically interface with secure -storage provided by the OS or other programs. +storage provided by the OS or other programs. Alternatively, a +credential-generating helper might generate credentials for certain servers via +some API. To use a helper, you must first select one to use. Git currently includes the following helpers: @@ -286,8 +288,8 @@ For a `store` or `erase` operation, the helper's output is ignored. If a helper fails to perform the requested operation or needs to notify the user of a potential issue, it may write to stderr. -If it does not support the requested operation (e.g., a read-only store), -it should silently ignore the request. +If it does not support the requested operation (e.g., a read-only store +or generator), it should silently ignore the request. If a helper receives any other operation, it should silently ignore the request. This leaves room for future operations to be added (older base-commit: 319605f8f00e402f3ea758a02c63534ff800a711 -- gitgitgadget ``` ## Taylor Blau, 2022-11-14 23:18 Subject: Re: [PATCH] Docs: describe how a credential-generating helper works Message-ID: URL: https://gitlist.dev/e/Y3LMybivz12lj9Gu%40nand.local In-Reply-To: ``` On Sat, Nov 12, 2022 at 01:44:30AM +0000, M Hickford via GitGitGadget wrote: > From: M Hickford > > Previously the docs only described storage helpers. > > A concrete example: Git Credential Manager can generate credentials > for GitHub and GitLab via OAuth. > https://github.com/GitCredentialManager/git-credential-manager Thanks. I'm tagging Matthew Cheetham (cc'd) as a potential reviewer. Thanks, Taylor ``` ## Matthew John Cheetham, 2022-11-17 17:28 Subject: Re: [PATCH] Docs: describe how a credential-generating helper works Message-ID: URL: https://gitlist.dev/e/AS2PR03MB9815DCB5C310C4AC7B82D3A6C0069%40AS2PR03MB9815.eurprd03.prod.outlook.com In-Reply-To: ``` On 2022-11-11 17:44, M Hickford via GitGitGadget wrote: > From: M Hickford > > Previously the docs only described storage helpers. > > A concrete example: Git Credential Manager can generate credentials > for GitHub and GitLab via OAuth. > https://github.com/GitCredentialManager/git-credential-manager > > Signed-off-by: M Hickford > --- > Docs: describe how a credential-generating helper works > > Previously the docs only described storage helpers. > > A concrete example: Git Credential Manager can generate credentials for > GitHub and GitLab via OAuth. > https://github.com/GitCredentialManager/git-credential-manager > > Signed-off-by: M Hickford mirth.hickford@gmail.com > > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1379%2Fhickford%2Fcredential-generator-v1 > Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1379/hickford/credential-generator-v1 > Pull-Request: https://github.com/git/git/pull/1379 > > Documentation/gitcredentials.txt | 8 +++++--- > 1 file changed, 5 insertions(+), 3 deletions(-) > > diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt > index 80517b4eb2c..72888402e73 100644 > --- a/Documentation/gitcredentials.txt > +++ b/Documentation/gitcredentials.txt > @@ -61,7 +61,9 @@ for a password. It is generally configured by adding this to your config: > > Credential helpers, on the other hand, are external programs from which Git can > request both usernames and passwords; they typically interface with secure > -storage provided by the OS or other programs. > +storage provided by the OS or other programs. Alternatively, a > +credential-generating helper might generate credentials for certain servers via > +some API. > > To use a helper, you must first select one to use. Git currently > includes the following helpers: > @@ -286,8 +288,8 @@ For a `store` or `erase` operation, the helper's output is ignored. > If a helper fails to perform the requested operation or needs to notify > the user of a potential issue, it may write to stderr. > > -If it does not support the requested operation (e.g., a read-only store), > -it should silently ignore the request. > +If it does not support the requested operation (e.g., a read-only store > +or generator), it should silently ignore the request. > > If a helper receives any other operation, it should silently ignore the > request. This leaves room for future operations to be added (older > > base-commit: 319605f8f00e402f3ea758a02c63534ff800a711 This looks like a good, clarifying addition to the docs! Thanks, Matthew ``` ## Taylor Blau, 2022-11-17 21:55 Subject: Re: [PATCH] Docs: describe how a credential-generating helper works Message-ID: URL: https://gitlist.dev/e/Y3at2UY6OzFiMlNZ%40nand.local In-Reply-To: ``` On Thu, Nov 17, 2022 at 09:28:53AM -0800, Matthew John Cheetham wrote: > This looks like a good, clarifying addition to the docs! Thanks, both. Will queue. Thanks, Taylor ```