1
0
Fork 0

Added documentation about HTTP Bearer Auth (#10780)

Bearer Auth has been added here:

- 548505f103
- f964b83018
- #8671
- #8642

but it was not documented in this file.
pull/10828/head
Carsten Brandt 2022-06-07 14:04:04 +02:00 committed by GitHub
parent ab1de96fcb
commit 7cf3b01631
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 60 additions and 4 deletions

View File

@ -18,6 +18,7 @@ for credentials and save them (or a token if Composer is able to retrieve one).
|---|---| |---|---|
|[http-basic](#http-basic)|yes| |[http-basic](#http-basic)|yes|
|[Inline http-basic](#inline-http-basic)|no| |[Inline http-basic](#inline-http-basic)|no|
|[HTTP Bearer](#http-bearer)|no|
|[Custom header](#custom-token-authentication)|no| |[Custom header](#custom-token-authentication)|no|
|[gitlab-oauth](#gitlab-oauth)|yes| |[gitlab-oauth](#gitlab-oauth)|yes|
|[gitlab-token](#gitlab-token)|yes| |[gitlab-token](#gitlab-token)|yes|
@ -50,6 +51,7 @@ Composer home directory.
For all authentication methods it is possible to edit them using the command line; For all authentication methods it is possible to edit them using the command line;
- [http-basic](#command-line-http-basic) - [http-basic](#command-line-http-basic)
- [Inline http-basic](#command-line-inline-http-basic) - [Inline http-basic](#command-line-inline-http-basic)
- [HTTP Bearer](#http-bearer)
- [gitlab-oauth](#command-line-gitlab-oauth) - [gitlab-oauth](#command-line-gitlab-oauth)
- [gitlab-token](#command-line-gitlab-token) - [gitlab-token](#command-line-gitlab-token)
- [github-oauth](#command-line-github-oauth) - [github-oauth](#command-line-github-oauth)
@ -69,6 +71,7 @@ php composer.phar config --global --editor [--auth]
For specific authentication implementations, see their sections; For specific authentication implementations, see their sections;
- [http-basic](#manual-http-basic) - [http-basic](#manual-http-basic)
- [Inline http-basic](#manual-inline-http-basic) - [Inline http-basic](#manual-inline-http-basic)
- [HTTP Bearer](#http-bearer)
- [custom header](#manual-custom-token-authentication) - [custom header](#manual-custom-token-authentication)
- [gitlab-oauth](#manual-gitlab-oauth) - [gitlab-oauth](#manual-gitlab-oauth)
- [gitlab-token](#manual-gitlab-token) - [gitlab-token](#manual-gitlab-token)
@ -101,7 +104,7 @@ section or directly in the repository definition.
> **Note:** Using the command line environment variable method also has security implications. > **Note:** Using the command line environment variable method also has security implications.
> These credentials will most likely be stored in memory, > These credentials will most likely be stored in memory,
> and on be persisted to a file like `~/.bash_history`(linux) or `ConsoleHost_history.txt` > and may be persisted to a file like `~/.bash_history` (linux) or `ConsoleHost_history.txt`
> (PowerShell on Windows) when closing a session. > (PowerShell on Windows) when closing a session.
The final option to supply Composer with credentials is to use the `COMPOSER_AUTH` environment variable. The final option to supply Composer with credentials is to use the `COMPOSER_AUTH` environment variable.
@ -115,9 +118,14 @@ Read more about the usage of this environment variable [here](../03-cli.md#compo
### Command line http-basic ### Command line http-basic
```sh ```sh
php composer.phar config [--global] http-basic.example.org username password php composer.phar config [--global] http-basic.repo.example.org username password
``` ```
In the above command, the config key `http-basic.repo.example.org` consists of two parts:
- `http-basic` is the authentication method.
- `repo.example.org` is the repository host name, you should replace it with the host name of your repository.
### Manual http-basic ### Manual http-basic
```sh ```sh
@ -167,6 +175,34 @@ php composer.phar config [--global] --editor
} }
``` ```
## HTTP Bearer
### Command line HTTP Bearer authentication
```sh
php composer.phar config [--global] bearer.repo.example.org token
```
In the above command, the config key `bearer.repo.example.org` consists of two parts:
- `bearer` is the authentication method.
- `repo.example.org` is the repository host name, you should replace it with the host name of your repository.
### Manual HTTP Bearer authentication
```sh
php composer.phar config [--global] --editor --auth
```
```json
{
"bearer": {
"example.org": "TOKEN"
}
}
```
## Custom token authentication ## Custom token authentication
### Manual custom token authentication ### Manual custom token authentication
@ -201,9 +237,14 @@ php composer.phar config [--global] --editor
### Command line gitlab-oauth ### Command line gitlab-oauth
```sh ```sh
php composer.phar config [--global] gitlab-oauth.example.org token php composer.phar config [--global] gitlab-oauth.gitlab.example.org token
``` ```
In the above command, the config key `gitlab-oauth.gitlab.example.org` consists of two parts:
- `gitlab-oauth` is the authentication method.
- `gitlab.example.org` is the host name of your GitLab instance, you should replace it with the host name of your GitLab instance or use `gitlab.com` if you don't have a self-hosted GitLab instance.
### Manual gitlab-oauth ### Manual gitlab-oauth
```sh ```sh
@ -231,9 +272,14 @@ When creating a gitlab token manually, make sure it has either the `read_api` or
### Command line gitlab-token ### Command line gitlab-token
```sh ```sh
php composer.phar config [--global] gitlab-token.example.org token php composer.phar config [--global] gitlab-token.gitlab.example.org token
``` ```
In the above command, the config key `gitlab-token.gitlab.example.org` consists of two parts:
- `gitlab-token` is the authentication method.
- `gitlab.example.org` is the host name of your GitLab instance, you should replace it with the host name of your GitLab instance or use `gitlab.com` if you don't have a self-hosted GitLab instance.
### Manual gitlab-token ### Manual gitlab-token
```sh ```sh
@ -264,6 +310,11 @@ Read more about [Personal Access Tokens](https://docs.github.com/en/authenticati
php composer.phar config [--global] github-oauth.github.com token php composer.phar config [--global] github-oauth.github.com token
``` ```
In the above command, the config key `github-oauth.github.com` consists of two parts:
- `github-oauth` is the authentication method.
- `github.com` is the host name for which this token applies. For GitHub you most likely do not need to change this.
### Manual github-oauth ### Manual github-oauth
```sh ```sh
@ -288,6 +339,11 @@ The BitBucket driver uses OAuth to access your private repositories via the BitB
php composer.phar config [--global] bitbucket-oauth.bitbucket.org consumer-key consumer-secret php composer.phar config [--global] bitbucket-oauth.bitbucket.org consumer-key consumer-secret
``` ```
In the above command, the config key `bitbucket-oauth.bitbucket.org` consists of two parts:
- `bitbucket-oauth` is the authentication method.
- `bitbucket.org` is the host name for which this token applies. Unless you have a private instance you don't need to change this.
### Manual bitbucket-oauth ### Manual bitbucket-oauth
```sh ```sh