Skip to content

Commit 97b18ba

Browse files
authored
Update readme (#39)
1 parent f0386ed commit 97b18ba

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,33 @@
55
[![release](https://img.shields.io/github/release-pre/cloudentity/oauth2c.svg)](https://github.com/cloudentity/oauth2c/releases)
66
[![downloads](https://img.shields.io/github/downloads/cloudentity/oauth2c/total)](https://github.com/cloudentity/oauth2c/releases)
77

8-
`oauth2c` is a command-line OAuth2 client. Its goal is to make it easy for users to try out different aspects of the OAuth2 protocol and understand how it works. This tool is designed for testing, debugging, and generally interacting with OAuth2 authorization servers. With `oauth2c`, users can easily learn about and experiment with OAuth2 without the need for complex setup or detailed knowledge of the protocol.
8+
`oauth2c` is a command-line tool for interacting with OAuth 2.0 authorization servers. Its goal is to make it easy to fetch access tokens
9+
using any grant type or client authentication method. It is compliant with almost all basic and advanced OAuth 2.0, OIDC, OIDF FAPI and JWT profiles.
910

1011
![demo](https://user-images.githubusercontent.com/909896/176916616-36d803ef-832a-4bd8-ba8d-f6689e31ed22.gif)
1112

1213
## Features
1314

14-
* A simple and intuitive command-line interface for quickly trying out different OAuth 2.0 grant types and client authentication methods
15-
* Supports all modern OAuth 2.0 grant types: authorization code, implicit, password, client credentials, refresh token, JWT bearer, token exchange
16-
* Supports all client authentication methods: client secret basic, client secret post, client secret JWT, private key JWT, TLS client auth
17-
* Supports the following extensions: PKCE, JARM, PAR
15+
* support for **authorization code**, **hybrid**, **implicit**, **password**, **client credentials**, **refresh token**, **JWT bearer**, **token exchange**, **device** grant flows
16+
* support for **client secret basic**, **client secret post**, **client secret JWT**, **private key JWT**, **TLS client auth** client authentication methods
17+
* passing request parameters as plaintext, signed, and/or encrypted JWT
18+
* support for **Proof Key for Code Exchange** (**PKCE**)
19+
* support for **JWT Secured Authorization Response Mode** (**JARM**)
20+
* support for **Pushed Authorization Requests** (**PAR**)
1821

1922
## Installation
2023

2124
To install `oauth2c`, you have several options depending on your operating system.
2225

23-
**Install on Mac**
26+
### Install on Mac
2427

2528
On Mac, you can install `oauth2c` using `brew` by running the following command:
2629

2730
``` sh
2831
brew install cloudentity/tap/oauth2c
2932
```
3033

31-
**Install on Linux**
34+
### Install on Linux
3235

3336
On linux, you can install `oauth2c` using the installation script by running the following command:
3437

@@ -37,7 +40,7 @@ curl -sSfL https://raw.githubusercontent.com/cloudentity/oauth2c/master/install.
3740
sudo sh -s -- -b /usr/local/bin latest
3841
```
3942

40-
**Compile from source**
43+
### Compile from source
4144

4245
You can also compile `oauth2c` from source using `go`. To do this run the following command:
4346

@@ -88,13 +91,13 @@ The available flags are:
8891
--username string resource owner password credentials grant flow username
8992
```
9093

91-
You will be asked to provide the necessary information, such as the grant type, client authentication method, and any other relevant details (if not already provided).
92-
9394
`oauth2c` opens a browser for flows such as authorization code and starts an HTTP server which acts as a client application and waits for a callback.
9495

9596
> **Note**: To make browser flows work add `http://localhost:9876/callback` as a redirect URL to your client.
9697
97-
For more information on the available options and arguments for each grant type, run `oauth2c --help`.
98+
`oauth2c` prints all the requests it made to obtain an access token. If you want to integrate it with CI/CD pipeline use the `--silent` flag.
99+
100+
For more information on the available options and arguments run `oauth2c --help`.
98101

99102
## Example
100103

0 commit comments

Comments
 (0)