Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hickford/git-credential-azure
A Git credential helper for Azure Repos
https://github.com/hickford/git-credential-azure
git git-credential-helper usable-security
Last synced: 10 days ago
JSON representation
A Git credential helper for Azure Repos
- Host: GitHub
- URL: https://github.com/hickford/git-credential-azure
- Owner: hickford
- License: apache-2.0
- Created: 2023-08-01T16:40:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T19:44:07.000Z (6 months ago)
- Last Synced: 2024-10-11T21:57:21.993Z (27 days ago)
- Topics: git, git-credential-helper, usable-security
- Language: Go
- Homepage:
- Size: 34.2 KB
- Stars: 9
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
git-credential-azure
====================
git-credential-azure is a Git credential helper that authenticates to [Azure Repos](https://azure.microsoft.com/en-us/products/devops/repos) (dev.azure.com). Azure Repos is part of Azure DevOps.
The first time you authenticate, the helper opens a browser window to Microsoft login. Subsequent authentication is non interactive.
## Installation
### All platforms
**Download** binary from https://github.com/hickford/git-credential-azure/releases.
Then test that Git can find the application:
git credential-azure
If you have problems, make sure that the binary is [located in the path](https://superuser.com/a/284351/62691) and [is executable](https://askubuntu.com/a/229592/18504).
### Linux
[Several Linux distributions](https://repology.org/project/git-credential-azure/versions) include a git-credential-azure package:
[](https://repology.org/project/git-credential-azure/versions)
### Windows
Install with [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/):
winget install hickford.git-credential-azure
### Go users
Go users can install the latest release to `~/go/bin` with:
go install github.com/hickford/git-credential-azure@latest
## Configuration
### How it works
Git is cleverly designed to [support multiple credential helpers](https://git-scm.com/docs/gitcredentials#_custom_helpers). To fill credentials, Git calls each helper in turn until it has the information it needs. git-credential-azure is a read-only credential-generating helper, designed to be configured in combination with a storage helper.
To configure together with [git-credential-cache](https://git-scm.com/docs/git-credential-cache):
```sh
git config --global --unset-all credential.helper
git config --global --add credential.helper "cache --timeout 21600" # six hours
git config --global --add credential.helper azure
# to also use git-credential-oauth
git config --global --add credential.helper oauth
```
You may choose a different storage helper such as `osxkeychain`, `wincred` or `libsecret`, but git-credential-azure must be configured last. This ensures Git checks for *stored* credentials before generating *new* credentials.
**Windows users** are recommended to use storage helper `wincred`.
### Manual config
Edit your [global git config](https://git-scm.com/docs/git-config#FILES) `~/.gitconfig` to include the following lines:
```ini
[credential]
helper = cache --timeout 21600 # six hours
helper = azure
```
### Browserless systems
On systems without a web browser, set the `-device` flag to authenticate on another device using [OAuth device flow](https://www.rfc-editor.org/rfc/rfc8628).
```ini
[credential]
helper = cache --timeout 21600 # six hours
helper = azure -device
```
### Subtleties with multiple users or organizations
If you use more than one user or organization across Azure Repos, make sure that the remote URLs include usernames. This is the default if you copied the URLs from the Azure Repos web interface.
Alternatively, you can set [credential.useHttpPath](https://git-scm.com/docs/gitcredentials#Documentation/gitcredentials.txt-useHttpPath) to store separate credentials for each repo:
```sh
git config --global credential.https://dev.azure.com.useHttpPath true
```
### Unconfiguration
Run:
git config --global --unset-all credential.helper azure
## Development
Install locally with `go install .`.
### Debugging
Use the `-verbose` flag to print more details:
```sh
git config --global --unset-all credential.helper azure
git config --global --add credential.helper "azure -verbose"
```
## See also
* [Git Credential Manager](https://github.com/git-ecosystem/git-credential-manager): a Git credential helper that authenticates to Azure Repos (and other hosts)
* Caveats: no support for Linux arm64
* [git-credential-oauth](https://github.com/hickford/git-credential-oauth) (sister project): a Git credential helper that authenticates to GitHub, GitLab, BitBucket and other hosts using OAuth