libgit2

git_credential_acquire_cb

Version:

Credential acquisition callback.

This callback is usually involved any time another system might need authentication. As such, you are expected to provide a valid git_credential object back, depending on allowed_types (a git_credential_t bitmask).

Note that most authentication details are your responsibility - this callback will be called until the authentication succeeds, or you report an error. As such, it's easy to get in a loop if you fail to stop providing the same incorrect credentials.

Signature

GitHub
typedef int git_credential_acquire_cb(git_credential **out, const char *url, const char *username_from_url, unsigned int allowed_types, void *payload);

Parameters

git_credential **
Out
out

The newly created credential object.

const char *
In
url

The resource for which we are demanding a credential.

const char *
In
username_from_url

The username that was embedded in a "user@host" remote url, or NULL if not included.

unsigned int
In
allowed_types

A bitmask stating which credential types are OK to return.

void *
In
payload

The payload provided when specifying this callback.

Returns

int

0 for success, < 0 to indicate an error, > 0 to indicate no credential was acquired

Versions